Skip to content

Commit f9740a8

Browse files
committed
feat(desktop): support system tray and persist on close on Windows
1 parent ed597df commit f9740a8

8 files changed

Lines changed: 446 additions & 14 deletions

File tree

‎apps/desktop/src/app/DesktopApp.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
2828
import * as DesktopShellEnvironment from "../shell/DesktopShellEnvironment.ts";
2929
import * as DesktopState from "./DesktopState.ts";
3030
import * as DesktopRemoteUpdates from "../updates/DesktopRemoteUpdates.ts";
31+
import * as DesktopTray from "./DesktopTray.ts";
3132
import * as DesktopUpdates from "../updates/DesktopUpdates.ts";
3233
import * as DesktopWslBackend from "../wsl/DesktopWslBackend.ts";
3334

@@ -236,6 +237,7 @@ const startup = Effect.gen(function* () {
236237
const desktopSettings = yield* DesktopAppSettings.DesktopAppSettings;
237238
const preReadyElectronOptions = yield* DesktopPreReadyPlatform.DesktopPreReadyElectronOptions;
238239
const safeStorage = yield* ElectronSafeStorage.ElectronSafeStorage;
240+
const tray = yield* DesktopTray.DesktopTray;
239241
const updates = yield* DesktopUpdates.DesktopUpdates;
240242
const environment = yield* DesktopEnvironment.DesktopEnvironment;
241243

@@ -292,6 +294,7 @@ const startup = Effect.gen(function* () {
292294
}
293295
yield* appIdentity.configure;
294296
yield* applicationMenu.configure;
297+
yield* tray.configure;
295298
yield* updates.configure;
296299
yield* DesktopRemoteUpdates.listen;
297300
yield* linuxUrlHandler.register;

‎apps/desktop/src/app/DesktopLifecycle.test.ts‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,17 @@ import * as DesktopEnvironment from "./DesktopEnvironment.ts";
1313
import * as DesktopLifecycle from "./DesktopLifecycle.ts";
1414
import * as DesktopShutdown from "./DesktopShutdown.ts";
1515
import * as DesktopState from "./DesktopState.ts";
16+
import * as DesktopTray from "./DesktopTray.ts";
1617
import * as DesktopWindow from "../window/DesktopWindow.ts";
1718

19+
function makeDesktopTrayLayer(isAvailable = true) {
20+
return Layer.succeed(DesktopTray.DesktopTray, {
21+
configure: Effect.void,
22+
isAvailable: Effect.succeed(isAvailable),
23+
destroy: Effect.void,
24+
} satisfies DesktopTray.DesktopTray["Service"]);
25+
}
26+
1827
function makeElectronAppLayer(
1928
appListeners: Map<string, (...args: readonly unknown[]) => void>,
2029
quit: Effect.Effect<void> = Effect.void,
@@ -119,6 +128,7 @@ describe("DesktopLifecycle", () => {
119128
),
120129
),
121130
Layer.provideMerge(makeDesktopWindowLayer()),
131+
Layer.provideMerge(makeDesktopTrayLayer()),
122132
Layer.provideMerge(environmentLayer),
123133
Layer.provideMerge(DesktopShutdown.layer),
124134
Layer.provideMerge(DesktopState.layer),
@@ -153,6 +163,122 @@ describe("DesktopLifecycle", () => {
153163
});
154164
}
155165

166+
it.effect("does not quit on window-all-closed on win32 (with tray) or darwin", () =>
167+
Effect.gen(function* () {
168+
for (const platform of ["win32", "darwin"] as const) {
169+
const appListeners = new Map<string, (...args: readonly unknown[]) => void>();
170+
let quitCalled = false;
171+
const quit = Effect.sync(() => {
172+
quitCalled = true;
173+
});
174+
175+
const environmentLayer = Layer.succeed(DesktopEnvironment.DesktopEnvironment, {
176+
platform,
177+
isDevelopment: false,
178+
} as DesktopEnvironment.DesktopEnvironment["Service"]);
179+
180+
const layer = DesktopLifecycle.layer.pipe(
181+
Layer.provideMerge(makeElectronAppLayer(appListeners, quit)),
182+
Layer.provideMerge(electronThemeLayer),
183+
Layer.provideMerge(makeElectronWindowLayer()),
184+
Layer.provideMerge(makeDesktopWindowLayer()),
185+
Layer.provideMerge(makeDesktopTrayLayer(true)),
186+
Layer.provideMerge(environmentLayer),
187+
Layer.provideMerge(DesktopShutdown.layer),
188+
Layer.provideMerge(DesktopState.layer),
189+
);
190+
191+
yield* Effect.scoped(
192+
Effect.gen(function* () {
193+
const lifecycle = yield* DesktopLifecycle.DesktopLifecycle;
194+
yield* lifecycle.register;
195+
196+
appListeners.get("window-all-closed")?.();
197+
yield* Effect.yieldNow;
198+
199+
assert.isFalse(quitCalled, `expected quit not to be called on ${platform}`);
200+
}),
201+
).pipe(Effect.provide(layer));
202+
}
203+
}),
204+
);
205+
206+
it.effect("quits on window-all-closed on win32 when tray is unavailable", () =>
207+
Effect.gen(function* () {
208+
const appListeners = new Map<string, (...args: readonly unknown[]) => void>();
209+
let quitCalled = false;
210+
const quit = Effect.sync(() => {
211+
quitCalled = true;
212+
});
213+
214+
const environmentLayer = Layer.succeed(DesktopEnvironment.DesktopEnvironment, {
215+
platform: "win32",
216+
isDevelopment: false,
217+
} as DesktopEnvironment.DesktopEnvironment["Service"]);
218+
219+
const layer = DesktopLifecycle.layer.pipe(
220+
Layer.provideMerge(makeElectronAppLayer(appListeners, quit)),
221+
Layer.provideMerge(electronThemeLayer),
222+
Layer.provideMerge(makeElectronWindowLayer()),
223+
Layer.provideMerge(makeDesktopWindowLayer()),
224+
Layer.provideMerge(makeDesktopTrayLayer(false)),
225+
Layer.provideMerge(environmentLayer),
226+
Layer.provideMerge(DesktopShutdown.layer),
227+
Layer.provideMerge(DesktopState.layer),
228+
);
229+
230+
yield* Effect.scoped(
231+
Effect.gen(function* () {
232+
const lifecycle = yield* DesktopLifecycle.DesktopLifecycle;
233+
yield* lifecycle.register;
234+
235+
appListeners.get("window-all-closed")?.();
236+
yield* Effect.yieldNow;
237+
238+
assert.isTrue(quitCalled, "expected quit to be called on win32 when tray unavailable");
239+
}),
240+
).pipe(Effect.provide(layer));
241+
}),
242+
);
243+
244+
it.effect("quits on window-all-closed on linux", () =>
245+
Effect.gen(function* () {
246+
const appListeners = new Map<string, (...args: readonly unknown[]) => void>();
247+
let quitCalled = false;
248+
const quit = Effect.sync(() => {
249+
quitCalled = true;
250+
});
251+
252+
const environmentLayer = Layer.succeed(DesktopEnvironment.DesktopEnvironment, {
253+
platform: "linux",
254+
isDevelopment: false,
255+
} as DesktopEnvironment.DesktopEnvironment["Service"]);
256+
257+
const layer = DesktopLifecycle.layer.pipe(
258+
Layer.provideMerge(makeElectronAppLayer(appListeners, quit)),
259+
Layer.provideMerge(electronThemeLayer),
260+
Layer.provideMerge(makeElectronWindowLayer()),
261+
Layer.provideMerge(makeDesktopWindowLayer()),
262+
Layer.provideMerge(makeDesktopTrayLayer()),
263+
Layer.provideMerge(environmentLayer),
264+
Layer.provideMerge(DesktopShutdown.layer),
265+
Layer.provideMerge(DesktopState.layer),
266+
);
267+
268+
yield* Effect.scoped(
269+
Effect.gen(function* () {
270+
const lifecycle = yield* DesktopLifecycle.DesktopLifecycle;
271+
yield* lifecycle.register;
272+
273+
appListeners.get("window-all-closed")?.();
274+
yield* Effect.yieldNow;
275+
276+
assert.isTrue(quitCalled, "expected quit to be called on linux");
277+
}),
278+
).pipe(Effect.provide(layer));
279+
}),
280+
);
281+
156282
it.effect("destroys windows before waiting for backend shutdown", () =>
157283
Effect.gen(function* () {
158284
const appListeners = new Map<string, (...args: readonly unknown[]) => void>();
@@ -191,6 +317,7 @@ describe("DesktopLifecycle", () => {
191317
Layer.provideMerge(electronThemeLayer),
192318
Layer.provideMerge(makeElectronWindowLayer(destroyAll)),
193319
Layer.provideMerge(makeDesktopWindowLayer({ flushMainWindowBounds })),
320+
Layer.provideMerge(makeDesktopTrayLayer()),
194321
Layer.provideMerge(environmentLayer),
195322
Layer.provideMerge(desktopShutdownLayer),
196323
Layer.provideMerge(DesktopState.layer),
@@ -232,6 +359,7 @@ describe("DesktopLifecycle", () => {
232359
Layer.provideMerge(electronThemeLayer),
233360
Layer.provideMerge(makeElectronWindowLayer()),
234361
Layer.provideMerge(makeDesktopWindowLayer({ activate })),
362+
Layer.provideMerge(makeDesktopTrayLayer()),
235363
Layer.provideMerge(environmentLayer),
236364
Layer.provideMerge(DesktopShutdown.layer),
237365
Layer.provideMerge(DesktopState.layer),

‎apps/desktop/src/app/DesktopLifecycle.ts‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import type * as Electron from "electron";
1010
import * as DesktopEnvironment from "./DesktopEnvironment.ts";
1111
import { makeComponentLogger } from "./DesktopObservability.ts";
1212
import * as DesktopShutdown from "./DesktopShutdown.ts";
13+
import * as DesktopTray from "./DesktopTray.ts";
1314
import * as ElectronApp from "../electron/ElectronApp.ts";
1415
import * as ElectronTheme from "../electron/ElectronTheme.ts";
1516
import * as ElectronWindow from "../electron/ElectronWindow.ts";
@@ -32,6 +33,7 @@ export type DesktopLifecycleRuntimeServices =
3233
| DesktopEnvironment.DesktopEnvironment
3334
| DesktopShutdown.DesktopShutdown
3435
| DesktopState.DesktopState
36+
| DesktopTray.DesktopTray
3537
| DesktopWindow.DesktopWindow
3638
| ElectronApp.ElectronApp
3739
| ElectronTheme.ElectronTheme;
@@ -41,7 +43,7 @@ type DesktopLifecycleRegistrationServices =
4143
| ElectronWindow.ElectronWindow;
4244

4345
/**
44-
* @effect-expect-leaking DesktopEnvironment | DesktopShutdown | DesktopState | DesktopWindow | ElectronApp | ElectronTheme | ElectronWindow
46+
* @effect-expect-leaking DesktopEnvironment | DesktopShutdown | DesktopState | DesktopTray | DesktopWindow | ElectronApp | ElectronTheme | ElectronWindow
4547
*/
4648
export class DesktopLifecycle extends Context.Service<
4749
DesktopLifecycle,
@@ -189,6 +191,7 @@ export const make = DesktopLifecycle.of({
189191
}),
190192
register: Effect.gen(function* () {
191193
const desktopWindow = yield* DesktopWindow.DesktopWindow;
194+
const desktopTray = yield* DesktopTray.DesktopTray;
192195
const electronWindow = yield* ElectronWindow.ElectronWindow;
193196
const electronApp = yield* ElectronApp.ElectronApp;
194197
const electronTheme = yield* ElectronTheme.ElectronTheme;
@@ -245,9 +248,22 @@ export const make = DesktopLifecycle.of({
245248
Effect.gen(function* () {
246249
const app = yield* ElectronApp.ElectronApp;
247250
const state = yield* DesktopState.DesktopState;
248-
if (environment.platform !== "darwin" && !(yield* Ref.get(state.quitting))) {
249-
yield* app.quit;
251+
if (yield* Ref.get(state.quitting)) {
252+
return;
250253
}
254+
255+
if (environment.platform === "darwin") {
256+
return;
257+
}
258+
259+
if (environment.platform === "win32") {
260+
const hasTray = yield* desktopTray.isAvailable;
261+
if (hasTray) {
262+
return;
263+
}
264+
}
265+
266+
yield* app.quit;
251267
}).pipe(Effect.withSpan("desktop.lifecycle.windowAllClosed")),
252268
);
253269
});
Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
import * as NodeServices from "@effect/platform-node/NodeServices";
2+
import { assert, describe, it } from "@effect/vitest";
3+
import * as Deferred from "effect/Deferred";
4+
import * as Effect from "effect/Effect";
5+
import * as Layer from "effect/Layer";
6+
import * as Option from "effect/Option";
7+
8+
import * as ElectronApp from "../electron/ElectronApp.ts";
9+
import * as ElectronTray from "../electron/ElectronTray.ts";
10+
import * as DesktopAssets from "./DesktopAssets.ts";
11+
import * as DesktopEnvironment from "./DesktopEnvironment.ts";
12+
import * as DesktopTray from "./DesktopTray.ts";
13+
import * as DesktopWindow from "../window/DesktopWindow.ts";
14+
15+
const makeEnvironmentLayer = (platform: "win32" | "darwin" | "linux") =>
16+
Layer.succeed(DesktopEnvironment.DesktopEnvironment, {
17+
dirname: "/repo/apps/desktop/dist-electron",
18+
homeDirectory: "/Users/alice",
19+
platform,
20+
processArch: "x64",
21+
appVersion: "1.2.3",
22+
appPath: "/repo",
23+
isPackaged: false,
24+
resourcesPath: "/repo/resources",
25+
runningUnderArm64Translation: false,
26+
displayName: "T3 Code",
27+
} as unknown as DesktopEnvironment.DesktopEnvironment["Service"]);
28+
29+
const desktopAssetsLayer = Layer.succeed(DesktopAssets.DesktopAssets, {
30+
iconPaths: Effect.succeed({
31+
ico: Option.some("C:/path/to/icon.ico"),
32+
icns: Option.none(),
33+
png: Option.some("C:/path/to/icon.png"),
34+
}),
35+
resolveResourcePath: () => Effect.succeed(Option.none()),
36+
} satisfies DesktopAssets.DesktopAssets["Service"]);
37+
38+
const makeElectronTrayLayer = (
39+
createdOptions: Deferred.Deferred<ElectronTray.ElectronTrayCreateOptions>,
40+
) =>
41+
Layer.succeed(ElectronTray.ElectronTray, {
42+
create: (options) =>
43+
Deferred.succeed(createdOptions, options).pipe(Effect.andThen(Effect.succeed({} as any))),
44+
destroy: Effect.void,
45+
} satisfies ElectronTray.ElectronTray["Service"]);
46+
47+
const electronAppLayer = Layer.succeed(ElectronApp.ElectronApp, {
48+
metadata: Effect.die("unexpected metadata read"),
49+
name: Effect.succeed("T3 Code"),
50+
systemLocale: Effect.succeed("en-US"),
51+
whenReady: Effect.void,
52+
quit: Effect.void,
53+
exit: () => Effect.void,
54+
relaunch: () => Effect.void,
55+
setPath: () => Effect.void,
56+
setName: () => Effect.void,
57+
setAboutPanelOptions: () => Effect.void,
58+
setAppUserModelId: () => Effect.void,
59+
getAppMetrics: Effect.succeed([]),
60+
isDefaultProtocolClient: () => Effect.succeed(false),
61+
setAsDefaultProtocolClient: () => Effect.succeed(true),
62+
setDesktopName: () => Effect.void,
63+
setDockIcon: () => Effect.void,
64+
appendCommandLineSwitch: () => Effect.void,
65+
onBeforeQuitForUpdate: () => Effect.void,
66+
removeCommandLineSwitch: () => Effect.void,
67+
on: () => Effect.void,
68+
} satisfies ElectronApp.ElectronApp["Service"]);
69+
70+
const desktopWindowLayer = Layer.succeed(DesktopWindow.DesktopWindow, {
71+
createMain: Effect.die("unexpected createMain"),
72+
ensureMain: Effect.die("unexpected ensureMain"),
73+
revealOrCreateMain: Effect.die("unexpected revealOrCreateMain"),
74+
activate: Effect.void,
75+
createMainIfBackendReady: Effect.void,
76+
showConnectingSplash: Effect.void,
77+
handleBackendReady: () => Effect.void,
78+
handleBackendNotReady: Effect.void,
79+
flushMainWindowBounds: Effect.void,
80+
dispatchMenuAction: () => Effect.void,
81+
zoomMain: () => Effect.void,
82+
syncAppearance: Effect.void,
83+
} satisfies DesktopWindow.DesktopWindow["Service"]);
84+
85+
describe("DesktopTray", () => {
86+
it.effect("configures tray icon and menu on win32", () =>
87+
Effect.gen(function* () {
88+
const createdOptions = yield* Deferred.make<ElectronTray.ElectronTrayCreateOptions>();
89+
const testLayer = DesktopTray.layer.pipe(
90+
Layer.provideMerge(makeElectronTrayLayer(createdOptions)),
91+
Layer.provideMerge(desktopAssetsLayer),
92+
Layer.provideMerge(makeEnvironmentLayer("win32")),
93+
Layer.provideMerge(electronAppLayer),
94+
Layer.provideMerge(desktopWindowLayer),
95+
Layer.provideMerge(NodeServices.layer),
96+
);
97+
98+
yield* Effect.scoped(
99+
Effect.gen(function* () {
100+
const tray = yield* DesktopTray.DesktopTray;
101+
assert.isFalse(yield* tray.isAvailable);
102+
103+
yield* tray.configure;
104+
105+
const options = yield* Deferred.await(createdOptions);
106+
assert.equal(options.iconPath, "C:/path/to/icon.ico");
107+
assert.equal(options.tooltip, "T3 Code");
108+
assert.isDefined(options.menuItems);
109+
const menuItems = options.menuItems ?? [];
110+
assert.equal(menuItems.length, 3);
111+
assert.equal(menuItems[0]?.label, "Open T3 Code");
112+
assert.equal(menuItems[2]?.label, "Quit T3 Code");
113+
assert.isTrue(yield* tray.isAvailable);
114+
}),
115+
).pipe(Effect.provide(testLayer));
116+
}),
117+
);
118+
119+
it.effect("skips configuring tray on darwin", () =>
120+
Effect.gen(function* () {
121+
const createdOptions = yield* Deferred.make<ElectronTray.ElectronTrayCreateOptions>();
122+
const testLayer = DesktopTray.layer.pipe(
123+
Layer.provideMerge(makeElectronTrayLayer(createdOptions)),
124+
Layer.provideMerge(desktopAssetsLayer),
125+
Layer.provideMerge(makeEnvironmentLayer("darwin")),
126+
Layer.provideMerge(electronAppLayer),
127+
Layer.provideMerge(desktopWindowLayer),
128+
Layer.provideMerge(NodeServices.layer),
129+
);
130+
131+
yield* Effect.scoped(
132+
Effect.gen(function* () {
133+
const tray = yield* DesktopTray.DesktopTray;
134+
yield* tray.configure;
135+
136+
assert.isFalse(yield* Deferred.isDone(createdOptions));
137+
assert.isFalse(yield* tray.isAvailable);
138+
}),
139+
).pipe(Effect.provide(testLayer));
140+
}),
141+
);
142+
});

0 commit comments

Comments
 (0)