import type {BrowserContext} from "@playwright/test" import {MINUTE, int, ms} from "@welshman/lib" import type {TrustedEvent} from "@welshman/util" import type {TestUser} from "../keys" import {injectEvents, injectSession} from "./session" // Must match TEST_ENV_KEY in src/lib/test/env.ts. const TEST_ENV_KEY = "__TEST_ENV__" // Set the first time the app reads a value out of the injected env, which is this side's only // evidence that the hook in src/app/env.ts ran at all. const TEST_ENV_READ_KEY = "__TEST_ENV_READ__" export type BootOptions = { // Every relay list the app reads at startup is pointed here, so the urls it dials on its own // initiative can only ever be relays the scenario created. relays: string[] spaces?: string[] user?: TestUser // What this user's client already has in local storage, e.g. their room list. events?: TrustedEvent[] path?: string } export const boot = async ( context: BrowserContext, {relays, spaces = [], user, events = [], path = "/"}: BootOptions, ) => { const urls = relays.join(",") await context.addInitScript( ([key, readKey, env]) => { Object.assign(window, { [key]: new Proxy(env, { get(target, prop) { Object.assign(window, {[readKey]: true}) return Reflect.get(target, prop) }, }), }) }, [ TEST_ENV_KEY, TEST_ENV_READ_KEY, { VITE_DEFAULT_RELAYS: urls, VITE_INDEXER_RELAYS: urls, VITE_DEFAULT_SEARCH_RELAYS: urls, VITE_DEFAULT_MESSAGING_RELAYS: urls, VITE_SIGNER_RELAYS: urls, VITE_DEFAULT_SPACES: spaces.join(","), VITE_PLATFORM_RELAYS: "", VITE_BLOCKED_RELAYS: "", // Nothing serves this url, so a push bridge connection is reported as a leak instead of // blending into the traffic of a relay the scenario did create. VITE_PUSH_BRIDGE: "ws://localhost:1/", }, ] as const, ) if (user) { await injectSession(context, user) await injectEvents(context, events) } const page = await context.newPage() await page.goto(path) // The root layout renders nothing until its async setup block resolves, so the shell appearing // is the first point at which the app is really running. With a session injected, wait for the // signed-in nav instead — one the app rejected renders the landing dialog, and failing on that // here is much easier to read than the assertions it would break later. await page .locator(user ? ".primary-nav" : ".fl") .waitFor({state: "attached", timeout: ms(int(1, MINUTE))}) // src/app/env.ts reads every VITE_ value as it is imported, so by now the app has either resolved // them against the env above or against .env's real relays — which would otherwise surface as // every assertion in the suite timing out. const usedTestEnv = await page.evaluate( key => Boolean(Reflect.get(window, key)), TEST_ENV_READ_KEY, ) if (!usedTestEnv) { throw new Error( "The app read none of its VITE_ values from the harness, so it is pointed at the relays in " + ".env rather than at this scenario's. Check that src/app/env.ts still resolves them " + "through maybeGetTestEnv, and that the dev server is running in dev mode.", ) } return page }