Skip to content

Commit 8641c18

Browse files
donjorrsi-pr-agent
authored andcommitted
refactor(multi-window): per-window preview runs on upstream's environment-server browser
Upstream `ac8e9453ca0` moved preview automation onto the environment server, so the fork's desktop automation IPC, per-window installers, and their tests retire; per-window preview keeps zoom, annotation send, and forwarded shortcuts on upstream's `DesktopBrowserHost`. Squashes: - f921464 refactor(multi-window): per-window preview runs on upstream's environment-server browser - 4a9d99a fixup! refactor(multi-window): per-window preview runs on upstream's environment-server browser Fork-Domain: multi-window Fork-Tier: core Fork-Upstreamable: no
1 parent de7bc48 commit 8641c18

8 files changed

Lines changed: 210 additions & 170 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
import * as Effect from "effect/Effect";
2+
import * as Layer from "effect/Layer";
3+
import { BrowserWindow, webContents } from "electron";
4+
import type * as Electron from "electron";
5+
6+
import * as ElectronWindow from "../../electron/ElectronWindow.ts";
7+
import * as PreviewManager from "../../preview/Manager.ts";
8+
import { testWindowId } from "../../window/testWindowIds.fork.ts";
9+
10+
// Fork preview handlers resolve the IPC sender's window before any preview call.
11+
// This registers an upstream case's fake sender as one window, so the case
12+
// reaches its manager unchanged. Requires the caller's `electron` mock.
13+
export const previewSenderWindowFork = (
14+
manager: Partial<PreviewManager.PreviewManager["Service"]>,
15+
) =>
16+
Layer.mergeAll(
17+
Layer.effectDiscard(
18+
Effect.acquireRelease(
19+
Effect.sync(() => {
20+
const window = {} as Electron.BrowserWindow;
21+
const restore = {
22+
fromId: webContents.fromId,
23+
fromWebContents: BrowserWindow.fromWebContents,
24+
};
25+
webContents.fromId = () => ({}) as Electron.WebContents;
26+
BrowserWindow.fromWebContents = () => window;
27+
return restore;
28+
}),
29+
(restore) =>
30+
Effect.sync(() => {
31+
webContents.fromId = restore.fromId;
32+
BrowserWindow.fromWebContents = restore.fromWebContents;
33+
}),
34+
),
35+
),
36+
Layer.mock(ElectronWindow.ElectronWindow)({
37+
windowIdFor: () => Effect.succeedSome(testWindowId(1)),
38+
}),
39+
Layer.succeed(PreviewManager.PreviewManager, {
40+
...manager,
41+
forWindow: () => Effect.succeed(manager),
42+
} as PreviewManager.PreviewManager["Service"]),
43+
);

‎apps/desktop/src/ipc/methods/preview.test.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { beforeEach, describe, expect, it, vi } from "vite-plus/test";
1111

1212
import * as PreviewManager from "../../preview/Manager.ts";
1313
import * as PreviewIpc from "./preview.ts";
14+
import { previewSenderWindowFork } from "./preview.fork-test-harness.ts"; // fork-hook: multi-window/preview-capture-sender-import
1415
import * as DesktopIpc from "../DesktopIpc.ts";
1516
import * as DesktopClientSettings from "../../settings/DesktopClientSettings.ts";
1617

@@ -55,6 +56,7 @@ describe("preview IPC methods", () => {
5556
structuredClone(await listener!({ sender: { id: 7 } }, { tabId: "capture-tab" })),
5657
);
5758
}).pipe(
59+
Effect.provide(previewSenderWindowFork(manager)), // fork-hook: multi-window/preview-capture-sender
5860
Effect.provideService(
5961
PreviewManager.PreviewManager,
6062
manager as PreviewManager.PreviewManager["Service"],

‎apps/desktop/src/ipc/methods/preview.ts‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export class PreviewIpcSenderNotAuthorizedError extends Schema.TaggedError<Previ
4949
}
5050

5151
const previewForSender = Effect.fn("desktop.ipc.preview.resolveSender")(function* (
52-
event: DesktopIpc.DesktopIpcInvokeEvent | undefined,
52+
event?: DesktopIpc.DesktopIpcInvokeEvent, // fork-hook: multi-window/preview-window-requester
5353
) {
5454
return yield* PreviewWindowPolicy.resolvePreviewForSender(
5555
event,
@@ -70,19 +70,17 @@ export const installPreviewEventForwarding = Effect.fn(
7070
recordingFrame: IpcChannels.PREVIEW_RECORDING_FRAME_CHANNEL,
7171
recordingInput: IpcChannels.PREVIEW_RECORDING_INPUT_CHANNEL,
7272
pointerEvent: IpcChannels.PREVIEW_POINTER_EVENT_CHANNEL,
73+
openLink: IpcChannels.PREVIEW_OPEN_LINK_CHANNEL, // fork-hook: multi-window/preview-open-link-forwarding
7374
},
7475
);
75-
yield* manager.subscribeOpenLinks((event) =>
76-
electronWindow.sendAll(IpcChannels.PREVIEW_OPEN_LINK_CHANNEL, event),
77-
);
7876
});
7977

8078
const setForwardedShortcuts = DesktopIpc.makeIpcMethod({
8179
channel: IpcChannels.PREVIEW_SET_FORWARDED_SHORTCUTS_CHANNEL,
8280
payload: Schema.Array(PreviewForwardedShortcut).check(Schema.isMaxLength(MAX_KEYBINDINGS_COUNT)),
8381
result: Schema.Void,
8482
handler: Effect.fn("desktop.ipc.preview.setForwardedShortcuts")(function* (shortcuts) {
85-
const manager = yield* PreviewManager.PreviewManager;
83+
const { windowManager: manager } = yield* previewForSender(); // fork-hook: multi-window/preview-window-requester
8684
yield* manager.setForwardedShortcuts(shortcuts);
8785
}),
8886
});
@@ -188,7 +186,7 @@ const setZoomFactor = DesktopIpc.makeIpcMethod({
188186
payload: DesktopPreviewSetZoomFactorInputSchema,
189187
result: Schema.Void,
190188
handler: Effect.fn("desktop.ipc.preview.setZoomFactor")(function* ({ tabId, zoomFactor }) {
191-
const manager = yield* PreviewManager.PreviewManager;
189+
const { windowManager: manager } = yield* previewForSender(); // fork-hook: multi-window/preview-window-requester
192190
yield* manager.setZoomFactor(tabId, zoomFactor);
193191
}),
194192
});
@@ -386,7 +384,7 @@ const setAnnotationSendEnabled = DesktopIpc.makeIpcMethod({
386384
tabId,
387385
enabled,
388386
}) {
389-
const manager = yield* PreviewManager.PreviewManager;
387+
const { windowManager: manager } = yield* previewForSender(); // fork-hook: multi-window/preview-window-requester
390388
yield* manager.setAnnotationSendEnabled(tabId, enabled);
391389
}),
392390
});

‎apps/desktop/src/preview/Manager.fork-test-harness.ts‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
import { HostProcessPlatform } from "@t3tools/shared/hostProcess";
1+
// @effect-diagnostics effectFnOpportunity:off - Test doubles, like upstream testkits.
2+
import * as HostProcess from "@t3tools/shared/HostProcess";
3+
import * as NodeCrypto from "@effect/platform-node/NodeCrypto";
24
import * as Effect from "effect/Effect";
35
import * as FileSystem from "effect/FileSystem";
46
import * as Layer from "effect/Layer";
57
import * as Path from "effect/Path";
68
import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
79
import * as DesktopRendererHistory from "../telemetry/DesktopRendererHistory.ts";
810
import * as BrowserSession from "./BrowserSession.ts";
11+
import * as DesktopBrowserHost from "./DesktopBrowserHost.ts";
912
import * as PreviewManager from "./Manager.ts";
13+
import * as PreviewPasskeys from "./Passkeys.ts";
1014

1115
const noBrowserSessions = Layer.succeed(
1216
BrowserSession.BrowserSession,
@@ -45,5 +49,14 @@ export const previewManagerFixtureLayer = (
4549
),
4650
Layer.provideMerge(FileSystem.layerNoop({})),
4751
Layer.provideMerge(Path.layer),
48-
Layer.provideMerge(Layer.succeed(HostProcessPlatform, "darwin")),
52+
Layer.provideMerge(Layer.succeed(HostProcess.Platform, "darwin")),
53+
Layer.provideMerge(DesktopBrowserHost.layer),
54+
Layer.provideMerge(NodeCrypto.layer),
55+
Layer.provideMerge(
56+
Layer.mock(PreviewPasskeys.PreviewPasskeys)({
57+
bridgeEnabled: false,
58+
attachGuest: () => () => {},
59+
installSessionHandlers: () => {},
60+
}),
61+
),
4962
);

‎apps/desktop/src/preview/Manager.fork.test.ts‎

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ const makeTestPreviewWebContents = (
135135
getType: () => "webview",
136136
getURL: () => "https://example.com",
137137
getTitle: () => "Example",
138-
isLoading: () => false,
138+
isLoadingMainFrame: () => false,
139139
getZoomFactor: () => 1,
140140
setZoomFactor: vi.fn(),
141141
setAudioMuted: vi.fn(),
@@ -250,7 +250,7 @@ describe("fork preview manager zoom and window close", () => {
250250
getType: () => "webview",
251251
getURL: () => "https://example.com",
252252
getTitle: () => "Example",
253-
isLoading: () => false,
253+
isLoadingMainFrame: () => false,
254254
getZoomFactor: () => 1,
255255
setZoomFactor,
256256
setAudioMuted: vi.fn(),
@@ -293,15 +293,7 @@ describe("fork preview manager zoom and window close", () => {
293293
),
294294
);
295295

296-
// Fork tabs belong to a window, so its close disposes them (commit `70240ecf8e5`).
297-
forkSupersedes({
298-
upstream:
299-
"apps/desktop/src/preview/Manager.test.ts > releases frame capture when the main window closes",
300-
reason:
301-
"fork disposes the closing window's preview tabs, so a raced start finds no tab instead of PreviewMainWindowClosedError, and other windows' tabs stay live",
302-
commit: "70240ecf8e5",
303-
});
304-
effectIt.effect("disposes preview tabs when their owning window closes", () =>
296+
effectIt.effect("releases app recording without disposing other windows' tabs", () =>
305297
withManager((manager) =>
306298
Effect.gen(function* () {
307299
let closeMainWindow: (() => void) | undefined;
@@ -320,9 +312,10 @@ describe("fork preview manager zoom and window close", () => {
320312
id === undefined ? null : (webContentsById.get(id) ?? null),
321313
);
322314

323-
const otherWindow = yield* manager.forWindow(
324-
"00000000-0000-4000-8000-00000000000c" as WindowId,
325-
);
315+
const otherWindowId = "00000000-0000-4000-8000-00000000000c" as WindowId;
316+
const otherWindow = yield* manager.forWindow(otherWindowId);
317+
// The other window keeps its creation zoom across the app window's close.
318+
yield* otherWindow.createTab("tab_other_window", { zoomFactor: 1.25 });
326319
yield* otherWindow.navigate("tab_other_window", "https://other.example");
327320
yield* manager.createTab("tab_window_close_recording");
328321
yield* manager.createTab("tab_window_close_race");
@@ -339,20 +332,28 @@ describe("fork preview manager zoom and window close", () => {
339332
expect(firstWindowThrottling.mock.calls).toEqual([[false]]);
340333

341334
closeMainWindow?.();
335+
const otherWindowState: PreviewManager.PreviewTabState[] = [];
336+
yield* manager.subscribeOwnedStateChanges((owner, _tabId, state) =>
337+
Effect.sync(() => {
338+
if (owner === otherWindowId) otherWindowState.push(state);
339+
}),
340+
);
342341
const racedStart = yield* Effect.exit(manager.startRecording("tab_window_close_race"));
343342
expect(Exit.isFailure(racedStart)).toBe(true);
344343
if (Exit.isFailure(racedStart)) {
345344
expect(Option.getOrThrow(Cause.findErrorOption(racedStart.cause))).toMatchObject({
346-
_tag: "PreviewTabNotFoundError",
347-
tabId: "tab_window_close_race",
345+
_tag: "PreviewMainWindowClosedError",
348346
});
349347
}
350348
yield* Effect.yieldNow;
351349
yield* Effect.yieldNow;
352-
expect(yield* otherWindow.automationStatus("tab_other_window")).toMatchObject({
350+
yield* otherWindow.navigate("tab_other_window", "https://other.example/after");
351+
// The other window's tab outlived the main window's close: the post-close
352+
// navigation still drives the tab created before it, creation zoom intact.
353+
expect(otherWindowState.at(-1)).toMatchObject({
353354
tabId: "tab_other_window",
354-
url: "https://other.example/",
355-
loading: true,
355+
navStatus: { kind: "Loading", url: "https://other.example/after" },
356+
zoomFactor: 1.25,
356357
});
357358

358359
const grants: Array<{ video?: unknown }> = [];
@@ -369,14 +370,6 @@ describe("fork preview manager zoom and window close", () => {
369370
),
370371
);
371372

372-
// Fork registers a closed listener per owner (commit `70240ecf8e5`).
373-
forkSupersedes({
374-
upstream:
375-
"apps/desktop/src/preview/Manager.test.ts > does not arm recording after the main window closes during warmup",
376-
reason:
377-
"fork registers more than one closed listener on the main window, and the upstream case keeps only the last one it was handed",
378-
commit: "70240ecf8e5",
379-
});
380373
effectIt.effect("does not arm recording when every close listener runs during warmup", () =>
381374
withManager((manager) =>
382375
Effect.gen(function* () {

0 commit comments

Comments
 (0)