Skip to content

Commit ce2707b

Browse files
ronak-gulianironakguljuliusmarminge
authored
perf(desktop): show connecting splash while the local backend starts (#19706)
Co-authored-by: Ronak Guliani <[email protected]> Co-authored-by: Julius Marminge <[email protected]>
1 parent 0c9717b commit ce2707b

3 files changed

Lines changed: 207 additions & 14 deletions

File tree

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,7 @@ const bootstrap = Effect.gen(function* () {
239239
}
240240

241241
if (!(yield* Ref.get(state.quitting))) {
242-
if (settings.wslOnly === true && settings.wslBackendEnabled === true) {
243-
yield* desktopWindow.showConnectingSplash;
244-
}
242+
yield* desktopWindow.showConnectingSplash;
245243
yield* primaryBackend.start;
246244
yield* logBootstrapInfo("bootstrap backend start requested");
247245
yield* appActivation.start.pipe(

‎apps/desktop/src/window/DesktopWindow.test.ts‎

Lines changed: 197 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ vi.mock("electron", async (importOriginal) => ({
2727
setUserAgent: vi.fn(),
2828
})),
2929
},
30+
BrowserWindow: { getAllWindows: () => [], getFocusedWindow: () => null },
31+
app: { setBadgeCount: vi.fn() },
3032
screen: {
3133
getAllDisplays: vi.fn(() => [
3234
{
@@ -36,6 +38,42 @@ vi.mock("electron", async (importOriginal) => ({
3638
},
3739
}));
3840

41+
import * as NetService from "@t3tools/shared/Net";
42+
import { HttpClient } from "effect/http";
43+
import * as BrowserImport from "../preview/BrowserImport/BrowserImport.ts";
44+
import * as DesktopBackendConfiguration from "../backend/DesktopBackendConfiguration.ts";
45+
import * as DesktopLocalEnvironmentAuth from "../backend/DesktopLocalEnvironmentAuth.ts";
46+
import * as DesktopCliCommand from "../app/DesktopCliCommand.ts";
47+
import * as DesktopConnectionCatalogStore from "../app/DesktopConnectionCatalogStore.ts";
48+
import * as DesktopWebLinks from "../app/DesktopWebLinks.ts";
49+
import * as DesktopSshEnvironment from "../ssh/DesktopSshEnvironment.ts";
50+
import * as DesktopSshPasswordPrompts from "../ssh/DesktopSshPasswordPrompts.ts";
51+
import * as DesktopWslEnvironment from "../wsl/DesktopWslEnvironment.ts";
52+
import * as MacPermissions from "../permissions/MacPermissions.ts";
53+
54+
import * as HostProcess from "@t3tools/shared/HostProcess";
55+
import * as Stream from "effect/Stream";
56+
import * as DesktopApp from "../app/DesktopApp.ts";
57+
import * as DesktopAppActivation from "../app/DesktopAppActivation.ts";
58+
import * as DesktopAppIdentity from "../app/DesktopAppIdentity.ts";
59+
import * as DesktopClerk from "../app/DesktopClerk.ts";
60+
import * as DesktopLegacyLocalStorage from "../app/DesktopLegacyLocalStorage.ts";
61+
import * as DesktopLifecycle from "../app/DesktopLifecycle.ts";
62+
import * as DesktopLinuxUrlHandler from "../app/DesktopLinuxUrlHandler.ts";
63+
import * as DesktopPreReadyPlatform from "../app/DesktopPreReadyPlatform.ts";
64+
import * as DesktopShutdown from "../app/DesktopShutdown.ts";
65+
import * as DesktopBackendPool from "../backend/DesktopBackendPool.ts";
66+
import * as ElectronDialog from "../electron/ElectronDialog.ts";
67+
import * as ElectronProtocol from "../electron/ElectronProtocol.ts";
68+
import * as ElectronSafeStorage from "../electron/ElectronSafeStorage.ts";
69+
import * as DesktopIpc from "../ipc/DesktopIpc.ts";
70+
import * as DesktopSnapShot from "../snapShot/DesktopSnapShot.ts";
71+
import * as DesktopShellEnvironment from "../shell/DesktopShellEnvironment.ts";
72+
import * as DesktopTelemetryPublisher from "../telemetry/DesktopTelemetryPublisher.ts";
73+
import * as DesktopUpdates from "../updates/DesktopUpdates.ts";
74+
import * as DesktopApplicationMenu from "./DesktopApplicationMenu.ts";
75+
import * as DesktopWslBackend from "../wsl/DesktopWslBackend.ts";
76+
3977
import * as DesktopAssets from "../app/DesktopAssets.ts";
4078
import * as DesktopConfig from "../app/DesktopConfig.ts";
4179
import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
@@ -132,6 +170,7 @@ function makeFakeBrowserWindow() {
132170

133171
return {
134172
window: window as unknown as Electron.BrowserWindow,
173+
close: window.close,
135174
getBounds: window.getBounds,
136175
getNormalBounds: window.getNormalBounds,
137176
isDestroyed: window.isDestroyed,
@@ -353,7 +392,10 @@ function layerTest(input: {
353392
);
354393
}
355394

356-
const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | null)[]) =>
395+
const makeSplashScenario = (
396+
createOutcomes: readonly (Electron.BrowserWindow | null)[],
397+
settings = DesktopAppSettings.DEFAULT_DESKTOP_SETTINGS,
398+
) =>
357399
Effect.gen(function* () {
358400
const createdWindows = yield* Ref.make<Electron.BrowserWindow[]>([]);
359401
const createCalls = yield* Ref.make(0);
@@ -419,7 +461,7 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
419461
} satisfies ElectronWindow.ElectronWindow["Service"];
420462

421463
const layer = DesktopWindow.layer.pipe(
422-
Layer.provide(
464+
Layer.provideMerge(
423465
Layer.mergeAll(
424466
layerDesktopAssets,
425467
Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
@@ -428,7 +470,7 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
428470
shutdown: Effect.void,
429471
}),
430472
layerDesktopEnvironment,
431-
DesktopAppSettings.layerTest(),
473+
DesktopAppSettings.layerTest(settings),
432474
layerDesktopClientSettings,
433475
layerDesktopServerExposure,
434476
DesktopState.layer,
@@ -442,11 +484,17 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
442484
layerElectronTheme,
443485
Layer.succeed(ElectronWindow.ElectronWindow, electronWindowShape),
444486
Layer.mock(PreviewPasskeys.PreviewPasskeys)({
487+
configure: Effect.void,
445488
bridgeEnabled: false,
446489
installSessionHandlers: () => {},
447490
attachGuest: () => () => {},
448491
}),
449492
Layer.mock(PreviewManager.PreviewManager)({
493+
subscribeStateChanges: () => Effect.void,
494+
subscribeRecordingFrames: () => Effect.void,
495+
subscribeRecordingInputs: () => Effect.void,
496+
subscribePointerEvents: () => Effect.void,
497+
subscribeOpenLinks: () => Effect.void,
450498
getBrowserSession: () => Effect.succeed({} as Electron.Session),
451499
setMainWindow: () => Effect.void,
452500
isBrowserPartition: (partition) => partition.startsWith("persist:t3code-preview-"),
@@ -463,6 +511,152 @@ const captureOne = DesktopSnapShotId.make("11111111-1111-4111-8111-111111111111"
463511
const captureTwo = DesktopSnapShotId.make("22222222-2222-4222-8222-222222222222");
464512

465513
describe("DesktopWindow", () => {
514+
it.effect.each([
515+
{ mode: "native", localEnvironmentEnabled: true, wslBackendEnabled: false, wslOnly: false },
516+
{ mode: "WSL-only", localEnvironmentEnabled: true, wslBackendEnabled: true, wslOnly: true },
517+
{ mode: "dual", localEnvironmentEnabled: true, wslBackendEnabled: true, wslOnly: false },
518+
{ mode: "disabled", localEnvironmentEnabled: false, wslBackendEnabled: false, wslOnly: false },
519+
])("hands startup from the splash to the main window in $mode mode", (settings) =>
520+
Effect.gen(function* () {
521+
const splash = makeFakeBrowserWindow();
522+
const main = makeFakeBrowserWindow();
523+
const scenario = yield* makeSplashScenario(
524+
settings.localEnvironmentEnabled ? [splash.window, main.window] : [main.window],
525+
{ ...DesktopAppSettings.DEFAULT_DESKTOP_SETTINGS, ...settings },
526+
);
527+
const bootstrapped = yield* Deferred.make<void>();
528+
const windowsAtBackendStart: number[] = [];
529+
const primary = {
530+
id: DesktopBackendPool.PRIMARY_INSTANCE_ID,
531+
label: Effect.succeed("Primary"),
532+
start: Ref.get(scenario.createCalls).pipe(
533+
Effect.tap((count) => Effect.sync(() => windowsAtBackendStart.push(count))),
534+
Effect.asVoid,
535+
),
536+
stop: () => Effect.void,
537+
currentConfig: Effect.succeedNone,
538+
snapshot: Effect.never,
539+
waitForReady: () => Effect.succeed(false),
540+
} satisfies DesktopBackendPool.DesktopBackendInstance;
541+
const startupLayer = Layer.mergeAll(
542+
// IPC registration captures these services but startup does not invoke their handlers.
543+
Layer.mock(BrowserImport.BrowserImport)({}),
544+
Layer.mock(DesktopBackendConfiguration.DesktopBackendConfiguration)({}),
545+
Layer.mock(DesktopLocalEnvironmentAuth.DesktopLocalEnvironmentAuth)({}),
546+
Layer.mock(DesktopCliCommand.DesktopCliCommand)({}),
547+
Layer.mock(DesktopConnectionCatalogStore.DesktopConnectionCatalogStore)({}),
548+
Layer.mock(DesktopWebLinks.DesktopWebLinks)({}),
549+
Layer.mock(DesktopSshEnvironment.DesktopSshEnvironment)({}),
550+
Layer.mock(DesktopSshPasswordPrompts.DesktopSshPasswordPrompts)({}),
551+
Layer.mock(DesktopWslEnvironment.DesktopWslEnvironment)({}),
552+
Layer.mock(MacPermissions.MacPermissions)({}),
553+
Layer.succeed(
554+
HttpClient.HttpClient,
555+
HttpClient.make(() => Effect.die("unexpected HTTP request")),
556+
),
557+
Layer.mock(NetService.NetService)({}),
558+
Layer.mock(ElectronApp.ElectronApp)({
559+
whenReady: Effect.void,
560+
setPath: () => Effect.void,
561+
on: () => Effect.void,
562+
}),
563+
Layer.mock(DesktopAppIdentity.DesktopAppIdentity)({
564+
resolveUserDataPath: Effect.succeed("/unused"),
565+
configure: Effect.void,
566+
}),
567+
Layer.mock(DesktopLifecycle.DesktopLifecycle)({ register: Effect.void }),
568+
Layer.mock(DesktopClerk.DesktopClerk)({ configure: Effect.void }),
569+
Layer.mock(DesktopApplicationMenu.DesktopApplicationMenu)({ configure: Effect.void }),
570+
Layer.mock(DesktopLinuxUrlHandler.DesktopLinuxUrlHandler)({ register: Effect.void }),
571+
Layer.mock(DesktopShellEnvironment.DesktopShellEnvironment)({
572+
installIntoProcess: Effect.succeed(true),
573+
}),
574+
Layer.succeed(DesktopPreReadyPlatform.DesktopPreReadyElectronOptions, {
575+
linux: null,
576+
linuxPasswordStoreCommandLine: null,
577+
}),
578+
Layer.mock(ElectronSafeStorage.ElectronSafeStorage)({}),
579+
Layer.mock(ElectronProtocol.ElectronProtocol)({
580+
registerDesktopProtocol: () => Effect.void,
581+
}),
582+
Layer.mock(ElectronDialog.ElectronDialog)({}),
583+
Layer.mock(DesktopIpc.DesktopIpc)({
584+
handle: () => Effect.void,
585+
handleSync: () => Effect.void,
586+
}),
587+
Layer.mock(DesktopLegacyLocalStorage.DesktopLegacyLocalStorage)({
588+
load: () => Effect.void,
589+
}),
590+
Layer.mock(DesktopSnapShot.DesktopSnapShot)({ initialize: Effect.void }),
591+
Layer.mock(DesktopAppActivation.DesktopAppActivation)({ start: Effect.void }),
592+
Layer.mock(DesktopWslBackend.DesktopWslBackend)({ reconcile: Effect.void }),
593+
Layer.mock(DesktopBackendPool.DesktopBackendPool)({
594+
primary: Effect.succeed(primary),
595+
list: Effect.succeed([]),
596+
}),
597+
Layer.mock(DesktopServerExposure.DesktopServerExposure)({
598+
configureFromSettings: () =>
599+
Effect.succeed({
600+
mode: "local-only",
601+
advertisedHost: null,
602+
endpointUrl: null,
603+
tailscaleServeEnabled: false,
604+
tailscaleServePort: 443,
605+
}),
606+
backendConfig: Effect.succeed({
607+
port: 3773,
608+
bindHost: "127.0.0.1",
609+
httpBaseUrl: new URL("http://127.0.0.1:3773"),
610+
tailscaleServeEnabled: false,
611+
tailscaleServePort: 443,
612+
}),
613+
}),
614+
Layer.mock(DesktopUpdates.DesktopUpdates)({
615+
configure: Effect.void,
616+
subscribe: Effect.never,
617+
}),
618+
Layer.mock(DesktopTelemetryPublisher.DesktopTelemetryPublisher)({
619+
updateRequests: Stream.empty,
620+
updateCancellations: Stream.empty,
621+
updateCommits: Stream.empty,
622+
}),
623+
Layer.mock(DesktopShutdown.DesktopShutdown)({
624+
awaitRequest: Deferred.succeed(bootstrapped, undefined).pipe(
625+
Effect.andThen(Effect.never),
626+
),
627+
markComplete: Effect.void,
628+
}),
629+
Layer.succeed(HostProcess.Platform, "darwin"),
630+
NodeServices.layer,
631+
);
632+
yield* Effect.gen(function* () {
633+
const desktopWindow = yield* DesktopWindow.DesktopWindow;
634+
const app = yield* DesktopApp.program.pipe(Effect.forkScoped);
635+
yield* Effect.raceFirst(Deferred.await(bootstrapped), Fiber.join(app));
636+
637+
assert.deepEqual(windowsAtBackendStart, settings.localEnvironmentEnabled ? [1] : []);
638+
assert.equal(yield* Ref.get(scenario.createCalls), 1);
639+
if (settings.localEnvironmentEnabled) {
640+
assert.isTrue(Option.isNone(yield* Ref.get(scenario.mainWindow)));
641+
yield* desktopWindow.handleBackendReady(new URL("http://127.0.0.1:3773"));
642+
assert.equal(yield* Ref.get(scenario.createCalls), 2);
643+
}
644+
assert.deepEqual(yield* Ref.get(scenario.mainWindow), Option.some(main.window));
645+
assert.equal(splash.close.mock.calls.length, 0);
646+
const readyToShow = main.windowListeners.get("ready-to-show");
647+
assert.isDefined(readyToShow);
648+
readyToShow();
649+
assert.deepEqual(yield* Ref.get(scenario.revealedWindows), [main.window]);
650+
assert.equal(splash.close.mock.calls.length, settings.localEnvironmentEnabled ? 1 : 0);
651+
readyToShow();
652+
assert.equal(splash.close.mock.calls.length, settings.localEnvironmentEnabled ? 1 : 0);
653+
}).pipe(
654+
Effect.scoped,
655+
Effect.provide(Layer.mergeAll(scenario.layer, startupLayer, DesktopState.layer)),
656+
);
657+
}),
658+
);
659+
466660
it.effect("shows native context menus for browser guests and sign-in popups", () =>
467661
Effect.gen(function* () {
468662
const host = makeFakeBrowserWindow();

‎apps/desktop/src/window/DesktopWindow.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -176,12 +176,12 @@ export function resolveInitialMainWindowBounds(
176176
return DesktopAppSettings.DEFAULT_MAIN_WINDOW_SIZE;
177177
}
178178

179-
function buildConnectingSplashDataUrl(shouldUseDarkColors: boolean): string {
179+
function buildConnectingSplashDataUrl(shouldUseDarkColors: boolean, text: string): string {
180180
const background = getInitialWindowBackgroundColor(shouldUseDarkColors);
181181
const label = shouldUseDarkColors ? "#9ca3af" : "#6b7280";
182182
const accent = shouldUseDarkColors ? "#f8fafc" : "#1f2937";
183183
const track = shouldUseDarkColors ? "rgba(248,250,252,0.18)" : "rgba(31,41,55,0.18)";
184-
const html = `<!doctype html><html><head><meta charset="utf-8"><meta http-equiv="Content-Security-Policy" content="default-src 'none'; style-src 'unsafe-inline'"><style>html,body{margin:0;height:100%}body{background:${background};color:${label};font-family:system-ui,-apple-system,'Segoe UI',sans-serif;display:flex;flex-direction:column;align-items:center;justify-content:center;gap:18px;-webkit-user-select:none;user-select:none;-webkit-app-region:drag}.spinner{width:26px;height:26px;border:3px solid ${track};border-top-color:${accent};border-radius:50%;animation:spin .8s linear infinite}.label{font-size:13px}@keyframes spin{to{transform:rotate(360deg)}}</style></head><body><div class="spinner"></div><div class="label">Connecting to WSL…</div></body></html>`;
184+
const html = `<!doctype html><html><head><meta charset="utf-8"><meta http-equiv="Content-Security-Policy" content="default-src 'none'; style-src 'unsafe-inline'"><style>html,body{margin:0;height:100%}body{background:${background};color:${label};font-family:system-ui,-apple-system,'Segoe UI',sans-serif;display:flex;flex-direction:column;align-items:center;justify-content:center;gap:18px;-webkit-user-select:none;user-select:none;-webkit-app-region:drag}.spinner{width:26px;height:26px;border:3px solid ${track};border-top-color:${accent};border-radius:50%;animation:spin .8s linear infinite}.label{font-size:13px}@keyframes spin{to{transform:rotate(360deg)}}</style></head><body><div class="spinner"></div><div class="label">${text}</div></body></html>`;
185185
return `data:text/html;charset=utf-8,${encodeURIComponent(html)}`;
186186
}
187187

@@ -315,11 +315,7 @@ export const make = Effect.gen(function* () {
315315
}
316316
});
317317

318-
// currentMainOrFirst / focusedMainOrFirst fall back to "any first window",
319-
// which during WSL-only boot is the connecting splash. The splash is never
320-
// registered via setMain, so it must be treated as "no real main window" --
321-
// otherwise ensureMain/activate/dispatchMenuAction latch onto it and never
322-
// open (or retry) the real main.
318+
// Window lookups fall back to the first window, which may be the splash.
323319
const withoutSplash = (window: Option.Option<Electron.BrowserWindow>) =>
324320
Ref.get(splashWindowRef).pipe(
325321
Effect.map((splash) =>
@@ -903,6 +899,11 @@ export const make = Effect.gen(function* () {
903899

904900
const shouldUseDarkColors = yield* electronTheme.shouldUseDarkColors;
905901
if (yield* Ref.get(desktopState.quitting)) return;
902+
const settings = yield* desktopSettings.get;
903+
const text =
904+
settings.wslOnly === true && settings.wslBackendEnabled === true
905+
? "Connecting to WSL…"
906+
: "Starting T3 Code…";
906907
const splash = yield* electronWindow.create({
907908
width: 360,
908909
height: 220,
@@ -936,7 +937,7 @@ export const make = Effect.gen(function* () {
936937
splash.show();
937938
}
938939
});
939-
void splash.loadURL(buildConnectingSplashDataUrl(shouldUseDarkColors));
940+
void splash.loadURL(buildConnectingSplashDataUrl(shouldUseDarkColors, text));
940941
yield* logWindowInfo("connecting splash shown");
941942
}).pipe(
942943
Effect.catch((error) =>

0 commit comments

Comments
 (0)