Deployment and privacy
Set up HTTPS and a Content Security Policy for the hosted importer. See which requests leave the browser.
The npm package opens https://runtime.demuddler.com/version/<version> in a
sandboxed frame. The frame holds the interface and the engine that reads the
file. Your page holds the configuration and receives the finished rows.
Versions and upgrades explains the version in the
URL.
Network requests and data
Section titled “Network requests and data”| Action | What crosses the network |
|---|---|
| Start the importer | The frame loads the runtime files. Then it sends a licence check to https://demuddler.com/api/v1/runtime/licence. |
| Reach a plan row limit | The frame sends a limit report to https://demuddler.com/api/v1/runtime/limit-hits. |
| Open, map, check or correct a file | Nothing. The file stays in the browser. Your page passes the File to the frame through a private message channel. |
| Read the finished rows | The rows go to your page through the same channel. Your code decides where they go next. |
The licence check and the limit report contain only the licence key and the parent hostname, with no cookie. The licence check also contains a random value that the frame makes for that check. They contain no file bytes, file names, column names, cell values, sheet names or row counts. Usage information lists the counts that the service keeps. See also Privacy.
Importer events can contain customer data. For example, open contains file
names, and validation results can contain example values. Do not send event
payloads to general analytics or to session replay.
Parent Content Security Policy
Section titled “Parent Content Security Policy”Add this source to the policy of the page that embeds the importer:
frame-src https://runtime.demuddler.com;Your page sends no request to Demuddler, so it needs no connect-src entry for
Demuddler. The frame has its own policy. If more than one CSP header applies to
your page, each one must permit the frame.
If a proxy or a corporate network filters traffic, it must permit
https://runtime.demuddler.com and the two API addresses in
Network requests and data.
If your product puts the importer inside another frame, test the full chain of frames. The frame policy permits only HTTPS and HTTP pages at each level of the chain, not only your page. Do not change the sandbox or the message channel that the loader sets up.
Styling and external assets
Section titled “Styling and external assets”The CSS of your page does not reach inside the frame. The frame loads fonts only
from the runtime origin and from data URLs. A font that your page loads is not
available inside the frame. Add a system fallback font to fontFamily.
Component reference lists the appearance settings.
Treat appearance settings as trusted product configuration. Do not build CSS or logo URLs from customer cell values.
HTTPS and browsers
Section titled “HTTPS and browsers”Use HTTPS in production. A paid plan applies only on an HTTPS page or on a local
host. See
The licence check and access changes.
A file:// page cannot embed the importer.
The importer needs WebAssembly, Web Workers, custom elements, MessageChannel
and the File API. Test each browser that your product supports with a typical
file. Clipboard buttons and downloads depend on the permissions of the browser
and of your page. If the browser blocks a clipboard button, keyboard paste and
file selection still work. Performance gives file sizes and
memory use.
Availability, storage and lifecycle
Section titled “Availability, storage and lifecycle”Each new frame needs the network to load the runtime and to check the licence. A frame that is already open can process a local file without the network.
The frame keeps confirmed column mappings, without cell values, in browser storage on the runtime origin. See Remembered mappings.
While the frame reads a gzip-compressed Excel file, it also keeps a temporary copy of the unpacked file. The copy is in the private file storage of the runtime origin. The frame removes the copy after it reads the workbook. If the tab closes first, a later frame removes it.
Neither leaves the device. If the browser blocks the storage, the frame keeps nothing and the importer still works.
A refresh, a closed tab or a removed importer loses the open file and its edits. Each importer on a page has its own engine and uses its own memory.
Before release
Section titled “Before release”- Make sure that the licence works on each production and preview hostname.
- Make sure that the production CSP permits the frame.
- Make sure that
importer.licencereports the expected plan. - Import a valid file, and a file with missing, invalid and duplicate values.
- If your plan has a row limit, test a file that is larger than the limit.
- Make sure that your analytics, logs and session replay do not capture file data.
- Test each browser and screen size that your product supports.
Deliver rows explains how to test failed and repeated deliveries.