Skip to content

Commit 9e61004

Browse files
perf(desktop): show splash while local backend starts
1 parent 00b3bd4 commit 9e61004

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
@@ -26,6 +26,8 @@ vi.mock("electron", async (importOriginal) => ({
2626
setUserAgent: vi.fn(),
2727
})),
2828
},
29+
BrowserWindow: { getAllWindows: () => [], getFocusedWindow: () => null },
30+
app: { setBadgeCount: vi.fn() },
2931
screen: {
3032
getAllDisplays: vi.fn(() => [
3133
{
@@ -35,6 +37,42 @@ vi.mock("electron", async (importOriginal) => ({
3537
},
3638
}));
3739

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

132170
return {
133171
window: window as unknown as Electron.BrowserWindow,
172+
close: window.close,
134173
getBounds: window.getBounds,
135174
getNormalBounds: window.getNormalBounds,
136175
isDestroyed: window.isDestroyed,
@@ -347,7 +386,10 @@ function layerTest(input: {
347386
);
348387
}
349388

350-
const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | null)[]) =>
389+
const makeSplashScenario = (
390+
createOutcomes: readonly (Electron.BrowserWindow | null)[],
391+
settings = DesktopAppSettings.DEFAULT_DESKTOP_SETTINGS,
392+
) =>
351393
Effect.gen(function* () {
352394
const createdWindows = yield* Ref.make<Electron.BrowserWindow[]>([]);
353395
const createCalls = yield* Ref.make(0);
@@ -413,7 +455,7 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
413455
} satisfies ElectronWindow.ElectronWindow["Service"];
414456

415457
const layer = DesktopWindow.layer.pipe(
416-
Layer.provide(
458+
Layer.provideMerge(
417459
Layer.mergeAll(
418460
layerDesktopAssets,
419461
Layer.succeed(DesktopRendererHistory.DesktopRendererHistory, {
@@ -422,7 +464,7 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
422464
shutdown: Effect.void,
423465
}),
424466
layerDesktopEnvironment,
425-
DesktopAppSettings.layerTest(),
467+
DesktopAppSettings.layerTest(settings),
426468
layerDesktopClientSettings,
427469
layerDesktopServerExposure,
428470
layerElectronApp,
@@ -435,11 +477,17 @@ const makeSplashScenario = (createOutcomes: readonly (Electron.BrowserWindow | n
435477
layerElectronTheme,
436478
Layer.succeed(ElectronWindow.ElectronWindow, electronWindowShape),
437479
Layer.mock(PreviewPasskeys.PreviewPasskeys)({
480+
configure: Effect.void,
438481
bridgeEnabled: false,
439482
installSessionHandlers: () => {},
440483
attachGuest: () => () => {},
441484
}),
442485
Layer.mock(PreviewManager.PreviewManager)({
486+
subscribeStateChanges: () => Effect.void,
487+
subscribeRecordingFrames: () => Effect.void,
488+
subscribeRecordingInputs: () => Effect.void,
489+
subscribePointerEvents: () => Effect.void,
490+
subscribeOpenLinks: () => Effect.void,
443491
getBrowserSession: () => Effect.succeed({} as Electron.Session),
444492
setMainWindow: () => Effect.void,
445493
isBrowserPartition: (partition) => partition.startsWith("persist:t3code-preview-"),
@@ -456,6 +504,152 @@ const captureOne = DesktopSnapShotId.make("11111111-1111-4111-8111-111111111111"
456504
const captureTwo = DesktopSnapShotId.make("22222222-2222-4222-8222-222222222222");
457505

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

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

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

177-
function buildConnectingSplashDataUrl(shouldUseDarkColors: boolean): string {
177+
function buildConnectingSplashDataUrl(shouldUseDarkColors: boolean, text: string): string {
178178
const background = getInitialWindowBackgroundColor(shouldUseDarkColors);
179179
const label = shouldUseDarkColors ? "#9ca3af" : "#6b7280";
180180
const accent = shouldUseDarkColors ? "#f8fafc" : "#1f2937";
181181
const track = shouldUseDarkColors ? "rgba(248,250,252,0.18)" : "rgba(31,41,55,0.18)";
182-
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>`;
182+
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>`;
183183
return `data:text/html;charset=utf-8,${encodeURIComponent(html)}`;
184184
}
185185

@@ -312,11 +312,7 @@ export const make = Effect.gen(function* () {
312312
}
313313
});
314314

315-
// currentMainOrFirst / focusedMainOrFirst fall back to "any first window",
316-
// which during WSL-only boot is the connecting splash. The splash is never
317-
// registered via setMain, so it must be treated as "no real main window" --
318-
// otherwise ensureMain/activate/dispatchMenuAction latch onto it and never
319-
// open (or retry) the real main.
315+
// Window lookups fall back to the first window, which may be the splash.
320316
const withoutSplash = (window: Option.Option<Electron.BrowserWindow>) =>
321317
Ref.get(splashWindowRef).pipe(
322318
Effect.map((splash) =>
@@ -878,6 +874,11 @@ export const make = Effect.gen(function* () {
878874
if (Option.isSome(existingWindow)) return;
879875

880876
const shouldUseDarkColors = yield* electronTheme.shouldUseDarkColors;
877+
const settings = yield* desktopSettings.get;
878+
const text =
879+
settings.wslOnly === true && settings.wslBackendEnabled === true
880+
? "Connecting to WSL…"
881+
: "Starting T3 Code…";
881882
const splash = yield* electronWindow.create({
882883
width: 360,
883884
height: 220,
@@ -907,7 +908,7 @@ export const make = Effect.gen(function* () {
907908
splash.show();
908909
}
909910
});
910-
void splash.loadURL(buildConnectingSplashDataUrl(shouldUseDarkColors));
911+
void splash.loadURL(buildConnectingSplashDataUrl(shouldUseDarkColors, text));
911912
yield* logWindowInfo("connecting splash shown");
912913
}).pipe(
913914
Effect.catch((error) =>

0 commit comments

Comments
 (0)