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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { handleVetos } from 'vs/platform/lifecycle/common/lifecycle';
import { ShutdownReason, ILifecycleService, IWillShutdownEventJoiner } from 'vs/workbench/services/lifecycle/common/lifecycle';
import { IStorageService } from 'vs/platform/storage/common/storage';
import { ipcRenderer } from 'vs/base/parts/sandbox/electron-sandbox/globals';
import { ILogService } from 'vs/platform/log/common/log';
import { AbstractLifecycleService } from 'vs/workbench/services/lifecycle/common/lifecycleService';
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { INativeHostService } from 'vs/platform/native/electron-sandbox/native';
import { Promises, disposableTimeout, raceCancellation } from 'vs/base/common/async';
import { toErrorMessage } from 'vs/base/common/errorMessage';
import { CancellationTokenSource } from 'vs/base/common/cancellation';
export class NativeLifecycleService extends AbstractLifecycleService {
private static readonly BEFORE_SHUTDOWN_WARNING_DELAY = 5000;
private static readonly WILL_SHUTDOWN_WARNING_DELAY = 800;
constructor(
@INativeHostService private readonly nativeHostService: INativeHostService,
@IStorageService storageService: IStorageService,
@ILogService logService: ILogService
) {
super(logService, storageService);
this.registerListeners();
}
private registerListeners(): void {
const windowId = this.nativeHostService.windowId;
// Main side indicates that window is about to unload, check for vetos
ipcRenderer.on('vscode:onBeforeUnload', async (event: unknown, reply: { okChannel: string; cancelChannel: string; reason: ShutdownReason }) => {
this.logService.trace(`[lifecycle] onBeforeUnload (reason: ${reply.reason})`);
// trigger onBeforeShutdown events and veto collecting
const veto = await this.handleBeforeShutdown(reply.reason);
// veto: cancel unload
if (veto) {
this.logService.trace('[lifecycle] onBeforeUnload prevented via veto');
// Indicate as event
this._onShutdownVeto.fire();
ipcRenderer.send(reply.cancelChannel, windowId);
}
// no veto: allow unload
else {
this.logService.trace('[lifecycle] onBeforeUnload continues without veto');
this.shutdownReason = reply.reason;
ipcRenderer.send(reply.okChannel, windowId);
}
});
// Main side indicates that we will indeed shutdown
ipcRenderer.on('vscode:onWillUnload', async (event: unknown, reply: { replyChannel: string; reason: ShutdownReason }) => {
this.logService.trace(`[lifecycle] onWillUnload (reason: ${reply.reason})`);
// trigger onWillShutdown events and joining
await this.handleWillShutdown(reply.reason);
// trigger onDidShutdown event now that we know we will quit
this._onDidShutdown.fire();
// acknowledge to main side
ipcRenderer.send(reply.replyChannel, windowId);
});
}
protected async handleBeforeShutdown(reason: ShutdownReason): Promise<boolean> {
const logService = this.logService;
const vetos: (boolean | Promise<boolean>)[] = [];
const pendingVetos = new Set<string>();
let finalVeto: (() => boolean | Promise<boolean>) | undefined = undefined;
let finalVetoId: string | undefined = undefined;
// before-shutdown event with veto support
this._onBeforeShutdown.fire({
reason,
veto(value, id) {
vetos.push(value);
// Log any veto instantly
if (value === true) {
logService.info(`[lifecycle]: Shutdown was prevented (id: ${id})`);
}
// Track promise completion
else if (value instanceof Promise) {
pendingVetos.add(id);
value.then(veto => {
if (veto === true) {
logService.info(`[lifecycle]: Shutdown was prevented (id: ${id})`);
}
}).finally(() => pendingVetos.delete(id));
}
},
finalVeto(value, id) {
if (!finalVeto) {
finalVeto = value;
finalVetoId = id;
} else {
throw new Error(`[lifecycle]: Final veto is already defined (id: ${id})`);
}
}
});
const longRunningBeforeShutdownWarning = disposableTimeout(() => {
logService.warn(`[lifecycle] onBeforeShutdown is taking a long time, pending operations: ${Array.from(pendingVetos).join(', ')}`);
}, NativeLifecycleService.BEFORE_SHUTDOWN_WARNING_DELAY);
try {
// First: run list of vetos in parallel
let veto = await handleVetos(vetos, error => this.handleBeforeShutdownError(error, reason));
if (veto) {
return veto;
}
// Second: run the final veto if defined
if (finalVeto) {
try {
pendingVetos.add(finalVetoId as unknown as string);
veto = await (finalVeto as () => Promise<boolean>)();
if (veto) {
logService.info(`[lifecycle]: Shutdown was prevented by final veto (id: ${finalVetoId})`);
}
} catch (error) {
veto = true; // treat error as veto
this.handleBeforeShutdownError(error, reason);
}
}
return veto;
} finally {
longRunningBeforeShutdownWarning.dispose();
}
}
private handleBeforeShutdownError(error: Error, reason: ShutdownReason): void {
this.logService.error(`[lifecycle]: Error during before-shutdown phase (error: ${toErrorMessage(error)})`);
this._onBeforeShutdownError.fire({ reason, error });
}
protected async handleWillShutdown(reason: ShutdownReason): Promise<void> {
const joiners: Promise<void>[] = [];
const pendingJoiners = new Set<IWillShutdownEventJoiner>();
const cts = new CancellationTokenSource();
this._onWillShutdown.fire({
reason,
token: cts.token,
joiners: () => Array.from(pendingJoiners.values()),
join(promise, joiner) {
joiners.push(promise);
// Track promise completion
pendingJoiners.add(joiner);
promise.finally(() => pendingJoiners.delete(joiner));
},
force: () => {
cts.dispose(true);
}
});
const longRunningWillShutdownWarning = disposableTimeout(() => {
this.logService.warn(`[lifecycle] onWillShutdown is taking a long time, pending operations: ${Array.from(pendingJoiners).map(joiner => joiner.id).join(', ')}`);
}, NativeLifecycleService.WILL_SHUTDOWN_WARNING_DELAY);
try {
await raceCancellation(Promises.settled(joiners), cts.token);
} catch (error) {
this.logService.error(`[lifecycle]: Error during will-shutdown phase (error: ${toErrorMessage(error)})`); // this error will not prevent the shutdown
} finally {
longRunningWillShutdownWarning.dispose();
}
}
shutdown(): Promise<void> {
return this.nativeHostService.closeWindow();
}
}
registerSingleton(ILifecycleService, NativeLifecycleService);
|