Open History to see the last commit
1import type {
2 DesktopPreviewTabState,
3 PreviewReportStatusInput,
4 ScopedThreadRef,
5 ThreadId,
6} from "@t3tools/contracts";
7import { useEffect, useEffectEvent, useRef } from "react";
8
9import { recordFaviconForThread } from "~/browserFaviconStore";
10import { useBrowserPointerStore } from "~/browser/browserPointerStore";
11import { acquireBrowserSurfaceActivity } from "~/browser/browserSurfaceStore";
12import { applyPreviewDesktopState, type DesktopPreviewOverlay } from "~/previewStateStore";
13import { previewEnvironment } from "~/state/preview";
14import { useAtomCommand } from "~/state/use-atom-command";
15
16import { previewBridge } from "./previewBridge";
17
18function originOf(url: string): string | null {
19 try {
20 return new URL(url).origin;
21 } catch {
22 return null;
23 }
24}
25
26/**
27 * Keeps a hidden guest painting behind the app while the desktop host captures it; Electron
28 * composites no offscreen guest, so its screenshot or stream would otherwise never finish.
29 */
30export function createCaptureActivity(tabId: string) {
31 let release: (() => void) | null = null;
32 const update = (capturing: boolean) => {
33 if (capturing && !release) release = acquireBrowserSurfaceActivity(tabId);
34 else if (!capturing && release) {
35 release();
36 release = null;
37 }
38 };
39 return { update, release: () => update(false) };
40}
41
42/** ElectronBrowserHost owns webview lifetime. */
43export function usePreviewBridge(input: {
44 threadRef: ScopedThreadRef;
45 tabId: string;
46 runtimeTabId: string;
47 serverDriven?: boolean;
48}): void {
49 const { threadRef, tabId, runtimeTabId, serverDriven = false } = input;
50 const clearBrowserPointer = useBrowserPointerStore((state) => state.clear);
51 const reportStatus = useAtomCommand(previewEnvironment.reportStatus, "preview status report");
52 const { environmentId, threadId } = threadRef;
53 const stableThreadRef: ScopedThreadRef = { environmentId, threadId };
54
55 const lastReportedUrl = useRef<string | null>(null);
56 const lastReportedKind = useRef<DesktopPreviewTabState["navStatus"]["kind"] | null>(null);
57 const lastReportedTitle = useRef<string | null>(null);
58 const lastDesktopNavStatus = useRef<DesktopPreviewTabState["navStatus"] | null>(null);
59 const captureActivity = useRef<ReturnType<typeof createCaptureActivity> | null>(null);
60 const handleStateChange = useEffectEvent(
61 (changedTabId: string, state: DesktopPreviewTabState): void => {
62 if (changedTabId !== runtimeTabId) return;
63 if (shouldClearBrowserPointer(lastDesktopNavStatus.current, state.navStatus)) {
64 clearBrowserPointer(runtimeTabId);
65 }
66 lastDesktopNavStatus.current = state.navStatus;
67 captureActivity.current?.update(state.capturing);
68 applyPreviewDesktopState(stableThreadRef, tabId, projectDesktopState(state));
69 if (state.favicon) {
70 recordFaviconForThread(stableThreadRef, state.favicon);
71 }
72 const reported = buildReportInput({
73 threadId: stableThreadRef.threadId,
74 tabId,
75 state,
76 lastReportedUrl: lastReportedUrl.current,
77 lastReportedKind: lastReportedKind.current,
78 lastReportedTitle: lastReportedTitle.current,
79 });
80 if (!reported || serverDriven) return;
81 lastReportedUrl.current = reported.lastReportedUrl;
82 lastReportedKind.current = reported.lastReportedKind;
83 lastReportedTitle.current = reported.lastReportedTitle;
84 void reportStatus({
85 environmentId: stableThreadRef.environmentId,
86 input: reported.input,
87 });
88 },
89 );
90 // oxlint-disable-next-line t3code/no-unreasoned-state-sync -- subscribes to preview bridge state changes and capture activity for the current tab
91 useEffect(() => {
92 if (!previewBridge || typeof window === "undefined") return;
93 lastReportedUrl.current = null;
94 lastReportedKind.current = null;
95 lastReportedTitle.current = null;
96 lastDesktopNavStatus.current = null;
97 const activity = createCaptureActivity(runtimeTabId);
98 captureActivity.current = activity;
99 const unsubscribe = previewBridge.onStateChange(handleStateChange);
100 return () => {
101 unsubscribe();
102 activity.release();
103 if (captureActivity.current === activity) captureActivity.current = null;
104 };
105 }, [
106 runtimeTabId,
107 // oxlint-disable-next-line react/exhaustive-effect-dependencies -- A different tab or thread starts its status reports and pointer tracking from scratch.
108 environmentId,
109 threadId,
110 tabId,
111 ]);
112}
113
114function shouldClearBrowserPointer(
115 previous: DesktopPreviewTabState["navStatus"] | null,
116 current: DesktopPreviewTabState["navStatus"],
117): boolean {
118 if (!previous) return false;
119 if (current.kind === "Loading" && previous.kind !== "Loading") return true;
120 if (current.kind === "Idle" || previous.kind === "Idle") return false;
121 return current.url !== previous.url;
122}
123
124export function projectDesktopState(state: DesktopPreviewTabState): DesktopPreviewOverlay {
125 const navOrigin = state.navStatus.kind === "Idle" ? null : originOf(state.navStatus.url);
126 return {
127 hasWebContents: state.webContentsId !== null,
128 canGoBack: state.canGoBack,
129 canGoForward: state.canGoForward,
130 loading: state.navStatus.kind === "Loading",
131 zoomFactor: state.zoomFactor,
132 pictureInPicture: state.pictureInPicture,
133 colorScheme: state.colorScheme,
134 audioMuted: state.audioMuted,
135 audible: state.audible,
136 controller: state.controller,
137 favicon: state.favicon && originOf(state.favicon.pageUrl) === navOrigin ? state.favicon : null,
138 };
139}
140
141export function buildReportInput(args: {
142 readonly threadId: ThreadId;
143 readonly tabId: string;
144 readonly state: DesktopPreviewTabState;
145 readonly lastReportedUrl: string | null;
146 readonly lastReportedKind: DesktopPreviewTabState["navStatus"]["kind"] | null;
147 readonly lastReportedTitle: string | null;
148}): {
149 readonly input: PreviewReportStatusInput;
150 readonly lastReportedUrl: string;
151 readonly lastReportedKind: DesktopPreviewTabState["navStatus"]["kind"];
152 readonly lastReportedTitle: string;
153} | null {
154 const { threadId, tabId, state, lastReportedUrl, lastReportedKind, lastReportedTitle } = args;
155 const status = state.navStatus;
156 if (status.kind === "Idle") return null;
157
158 const sameAsLast =
159 status.kind !== "LoadFailed" &&
160 status.kind === lastReportedKind &&
161 status.url === lastReportedUrl &&
162 status.title === lastReportedTitle;
163 if (sameAsLast) return null;
164
165 const base = {
166 threadId,
167 tabId,
168 canGoBack: state.canGoBack,
169 canGoForward: state.canGoForward,
170 };
171 if (status.kind === "LoadFailed") {
172 return {
173 input: {
174 ...base,
175 navStatus: {
176 _tag: "LoadFailed",
177 url: status.url,
178 title: status.title,
179 code: status.code,
180 description: status.description,
181 },
182 },
183 lastReportedUrl: status.url,
184 lastReportedKind: "LoadFailed",
185 lastReportedTitle: status.title,
186 };
187 }
188 return {
189 input: {
190 ...base,
191 navStatus: { _tag: status.kind, url: status.url, title: status.title },
192 },
193 lastReportedUrl: status.url,
194 lastReportedKind: status.kind,
195 lastReportedTitle: status.title,
196 };
197}