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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { ShutdownReason, ILifecycleService } from 'vs/workbench/services/lifecycle/common/lifecycle';
import { ILogService } from 'vs/platform/log/common/log';
import { AbstractLifecycleService } from 'vs/workbench/services/lifecycle/common/lifecycleService';
import { localize } from 'vs/nls';
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { IDisposable } from 'vs/base/common/lifecycle';
import { addDisposableListener, EventType } from 'vs/base/browser/dom';
import { IStorageService, WillSaveStateReason } from 'vs/platform/storage/common/storage';
import { CancellationToken } from 'vs/base/common/cancellation';
export class BrowserLifecycleService extends AbstractLifecycleService {
private beforeUnloadListener: IDisposable | undefined = undefined;
private unloadListener: IDisposable | undefined = undefined;
private ignoreBeforeUnload = false;
private didUnload = false;
constructor(
@ILogService logService: ILogService,
@IStorageService storageService: IStorageService
) {
super(logService, storageService);
this.registerListeners();
}
private registerListeners(): void {
// Listen to `beforeUnload` to support to veto
this.beforeUnloadListener = addDisposableListener(window, EventType.BEFORE_UNLOAD, (e: BeforeUnloadEvent) => this.onBeforeUnload(e));
// Listen to `pagehide` to support orderly shutdown
// We explicitly do not listen to `unload` event
// which would disable certain browser caching.
// We currently do not handle the `persisted` property
// (https://github.com/microsoft/vscode/issues/136216)
this.unloadListener = addDisposableListener(window, EventType.PAGE_HIDE, () => this.onUnload());
}
private onBeforeUnload(event: BeforeUnloadEvent): void {
// Before unload ignored (once)
if (this.ignoreBeforeUnload) {
this.logService.info('[lifecycle] onBeforeUnload triggered but ignored once');
this.ignoreBeforeUnload = false;
}
// Before unload with veto support
else {
this.logService.info('[lifecycle] onBeforeUnload triggered and handled with veto support');
this.doShutdown(() => this.vetoBeforeUnload(event));
}
}
private vetoBeforeUnload(event: BeforeUnloadEvent): void {
event.preventDefault();
event.returnValue = localize('lifecycleVeto', "Changes that you made may not be saved. Please check press 'Cancel' and try again.");
}
withExpectedShutdown(reason: ShutdownReason): Promise<void>;
withExpectedShutdown(reason: { disableShutdownHandling: true }, callback: Function): void;
withExpectedShutdown(reason: ShutdownReason | { disableShutdownHandling: true }, callback?: Function): Promise<void> | void {
// Standard shutdown
if (typeof reason === 'number') {
this.shutdownReason = reason;
// Ensure UI state is persisted
return this.storageService.flush(WillSaveStateReason.SHUTDOWN);
}
// Before unload handling ignored for duration of callback
else {
this.ignoreBeforeUnload = true;
try {
callback?.();
} finally {
this.ignoreBeforeUnload = false;
}
}
}
async shutdown(): Promise<void> {
this.logService.info('[lifecycle] shutdown triggered');
// An explicit shutdown renders our unload
// event handlers disabled, so dispose them.
this.beforeUnloadListener?.dispose();
this.unloadListener?.dispose();
// Ensure UI state is persisted
await this.storageService.flush(WillSaveStateReason.SHUTDOWN);
// Handle shutdown without veto support
this.doShutdown();
}
private doShutdown(vetoShutdown?: () => void): void {
const logService = this.logService;
// Optimistically trigger a UI state flush
// without waiting for it. The browser does
// not guarantee that this is being executed
// but if a dialog opens, we have a chance
// to succeed.
this.storageService.flush(WillSaveStateReason.SHUTDOWN);
let veto = false;
function handleVeto(vetoResult: boolean | Promise<boolean>, id: string) {
if (typeof vetoShutdown !== 'function') {
return; // veto handling disabled
}
if (vetoResult instanceof Promise) {
logService.error(`[lifecycle] Long running operations before shutdown are unsupported in the web (id: ${id})`);
veto = true; // implicitly vetos since we cannot handle promises in web
}
if (vetoResult === true) {
logService.info(`[lifecycle]: Unload was prevented (id: ${id})`);
veto = true;
}
}
// Before Shutdown
this._onBeforeShutdown.fire({
reason: ShutdownReason.QUIT,
veto(value, id) {
handleVeto(value, id);
},
finalVeto(valueFn, id) {
handleVeto(valueFn(), id); // in browser, trigger instantly because we do not support async anyway
}
});
// Veto: handle if provided
if (veto && typeof vetoShutdown === 'function') {
return vetoShutdown();
}
// No veto, continue to shutdown
return this.onUnload();
}
private onUnload(): void {
if (this.didUnload) {
return; // only once
}
this.didUnload = true;
// Register a late `pageshow` listener specifically on unload
this._register(addDisposableListener(window, EventType.PAGE_SHOW, (e: PageTransitionEvent) => this.onLoadAfterUnload(e)));
// First indicate will-shutdown
const logService = this.logService;
this._onWillShutdown.fire({
reason: ShutdownReason.QUIT,
joiners: () => [], // Unsupported in web
token: CancellationToken.None, // Unsupported in web
join(promise, joiner) {
logService.error(`[lifecycle] Long running operations during shutdown are unsupported in the web (id: ${joiner.id})`);
},
force: () => { /* No-Op in web */ },
});
// Finally end with did-shutdown
this._onDidShutdown.fire();
}
private onLoadAfterUnload(event: PageTransitionEvent): void {
// We only really care about page-show events
// where the browser indicates to us that the
// page was restored from cache and not freshly
// loaded.
const wasRestoredFromCache = event.persisted;
if (!wasRestoredFromCache) {
return;
}
// At this point, we know that the page was restored from
// cache even though it was unloaded before,
// so in order to get back to a functional workbench, we
// currently can only reload the window
// Docs: https://web.dev/bfcache/#optimize-your-pages-for-bfcache
// Refs: https://github.com/microsoft/vscode/issues/136035
this.withExpectedShutdown({ disableShutdownHandling: true }, () => window.location.reload());
}
}
registerSingleton(ILifecycleService, BrowserLifecycleService);
|