1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*
* SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
*
* SPDX-License-Identifier: EPL-2.0
*/
import { makeAutoObservable, observable } from 'mobx';
import ms from 'ms';
// eslint-disable-next-line import/no-unresolved -- Importing virtual module.
import { registerSW } from 'virtual:pwa-register';
import getLogger from './utils/getLogger';
const log = getLogger('PWAStore');
const UPDATE_INTERVAL = ms('30m');
export default class PWAStore {
needsUpdate = false;
updateError = false;
private readonly updateSW: (
reloadPage?: boolean | undefined,
) => Promise<void>;
private registration: ServiceWorkerRegistration | undefined;
constructor() {
if (window.location.host === 'localhost') {
// Do not register service worker during local development.
this.updateSW = () => Promise.resolve();
} else {
this.updateSW = registerSW({
onNeedRefresh: () => this.requestUpdate(),
onOfflineReady() {
log.debug('Service worker is ready for offline use');
},
onRegistered: (registration) => {
log.debug('Registered service worker');
this.setRegistration(registration);
},
onRegisterError(error) {
log.error('Failed to register service worker', error);
},
});
setInterval(() => this.checkForUpdates(), UPDATE_INTERVAL);
}
makeAutoObservable<PWAStore, 'updateSW' | 'registration'>(this, {
updateSW: false,
registration: observable.ref,
});
}
private requestUpdate(): void {
this.needsUpdate = true;
}
private setRegistration(
registration: ServiceWorkerRegistration | undefined,
): void {
this.registration = registration;
}
private signalError(): void {
this.updateError = true;
}
private update(reloadPage?: boolean | undefined): void {
this.updateSW(reloadPage).catch((error) => {
log.error('Error while reloading page with updates', error);
this.signalError();
});
}
checkForUpdates(): void {
this.dismissError();
// In development mode, the service worker deactives itself,
// so we must watch out for a deactivated service worker before updating.
if (this.registration !== undefined && this.registration.active) {
this.registration.update().catch((error) => {
log.error('Error while updating service worker', error);
this.signalError();
});
}
}
reloadWithUpdate(): void {
this.dismissUpdate();
this.update(true);
}
dismissUpdate(): void {
this.needsUpdate = false;
}
dismissError(): void {
this.updateError = false;
}
}
|
