Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Improve table saver to always use the correct service worker #1515

Merged
merged 3 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/code-studio/public/download/serviceWorker.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ self.onmessage = event => {
`service worker setting ${encodedFileName} download stream on service worker`
);
const rs = createReadableStream(ports[0]);
const downloadUrl = `${self.registration.scope}${encodedFileName}`;
const downloadUrl = new URL(encodedFileName, self.registration.scope).href;
tableExportMap.set(downloadUrl, {
readableStream: rs,
port: ports[0],
encodedFileName,
});
ports[0].postMessage({ download: encodedFileName });
ports[0].postMessage({ download: downloadUrl });
}
};
46 changes: 23 additions & 23 deletions packages/code-studio/src/DownloadServiceWorkerUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ import Log from '@deephaven/log';
const log = Log.module('DownloadServiceWorkerUtils');

class DownloadServiceWorkerUtils {
static DOWNLOAD_PATH = '/download/';
static SERVICE_WORKER_URL = new URL(
`./download/serviceWorker.js`,
document.baseURI
);

static serviceWorkerRegistration: ServiceWorkerRegistration | null = null;

static registerOnLoaded(): void {
const publicUrl = new URL(import.meta.env.BASE_URL, window.location.href);
Expand All @@ -15,33 +20,28 @@ class DownloadServiceWorkerUtils {
}

if ('serviceWorker' in navigator) {
window.addEventListener('load', () => {
const swUrl = new URL(
`${import.meta.env.BASE_URL ?? ''}download/serviceWorker.js`,
window.location.href
);

navigator.serviceWorker
.register(swUrl)
.then(reg => {
reg.update();
log.info('Registering service worker on ', swUrl, reg);
})
.catch(err => {
log.error('Failed to register service worker', err);
});
});
navigator.serviceWorker
.register(DownloadServiceWorkerUtils.SERVICE_WORKER_URL)
.then(reg => {
reg.update();
DownloadServiceWorkerUtils.serviceWorkerRegistration = reg;
log.info(
'Registering service worker on ',
DownloadServiceWorkerUtils.SERVICE_WORKER_URL,
reg
);
})
.catch(err => {
log.error('Failed to register service worker', err);
});
} else {
log.info('Service worker is not supported.');
}
}

static async getServiceWorker(): Promise<ServiceWorker> {
if ('serviceWorker' in navigator) {
const regs = await navigator.serviceWorker.getRegistrations();
const swReg = regs.find(reg =>
reg.scope.endsWith(DownloadServiceWorkerUtils.DOWNLOAD_PATH)
);
const swReg = DownloadServiceWorkerUtils.serviceWorkerRegistration;
if (swReg && swReg.active) {
log.info('Download service worker is active.');
return swReg.active;
Expand All @@ -51,8 +51,8 @@ class DownloadServiceWorkerUtils {
throw new Error('Download service worker is not available.');
}

static unregisterSW(): undefined {
return undefined;
static unregisterSW(): void {
DownloadServiceWorkerUtils.serviceWorkerRegistration?.unregister();
}
}
export default DownloadServiceWorkerUtils;
32 changes: 13 additions & 19 deletions packages/iris-grid/src/sidebar/TableSaver.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,6 @@ export default class TableSaver extends PureComponent<
// If the stream doesn't pull for long enough time, chances are the stream is already canceled, so we stop the stream.
// Issue ticket on Chromium: https://bugs.chromium.org/p/chromium/issues/detail?id=638494

this.iframes = [];

this.useBlobFallback = false;
}

Expand All @@ -123,11 +121,7 @@ export default class TableSaver extends PureComponent<
}

componentWillUnmount(): void {
if (this.iframes.length > 0) {
this.iframes.forEach(iframe => {
iframe.remove();
});
}
this.removeIframe();
if (this.streamTimeout) clearTimeout(this.streamTimeout);
if (this.snapshotHandlerTimeout) clearTimeout(this.snapshotHandlerTimeout);
}
Expand Down Expand Up @@ -182,7 +176,7 @@ export default class TableSaver extends PureComponent<

downloadStartTime?: number;

iframes: HTMLIFrameElement[];
iframe?: HTMLIFrameElement;

useBlobFallback: boolean;

Expand Down Expand Up @@ -325,15 +319,9 @@ export default class TableSaver extends PureComponent<
}

cancelDownload(): void {
if (this.table) {
this.table.close();
}
if (this.tableSubscription) {
this.tableSubscription.close();
}
if (this.fileWriter) {
this.fileWriter.abort();
}
this.table?.close();
this.tableSubscription?.close();
this.fileWriter?.abort();

this.cancelableSnapshots.forEach(cancelable => {
if (cancelable) {
Expand All @@ -351,6 +339,7 @@ export default class TableSaver extends PureComponent<
this.tableSubscription = undefined;
this.columns = undefined;
this.chunkRows = undefined;
this.removeIframe();

this.gridRanges = [];
this.gridRangeCounter = 0;
Expand Down Expand Up @@ -687,10 +676,15 @@ export default class TableSaver extends PureComponent<
// make a return value and make it static method
const iframe = document.createElement('iframe');
iframe.hidden = true;
iframe.src = `download/${src}`;
iframe.src = src;
iframe.name = 'iframe';
document.body.appendChild(iframe);
this.iframes.push(iframe);
this.iframe = iframe;
}

removeIframe(): void {
this.iframe?.remove();
this.iframe = undefined;
}

render(): null {
Expand Down