import {test as base, expect} from "@playwright/test" import type {BrowserContext, BrowserContextOptions, Page} from "@playwright/test" import type {Maybe, MaybeAsync} from "@welshman/lib" import {normalizeRelayUrl} from "@welshman/util" import {Zooid, describeDockerProblem} from "./zooid/relay" import { installHttpRoutes, mockAnalytics, mockBlossom, mockDufflepud, mockHosting, mockImages, mockPushServer, mockRelayInfo, } from "./net/http" import type {BlossomOptions, HostingFixtures, RelayInfoOverrides} from "./net/http" import {assertNoLeaks, installWebSocketRoutes} from "./net/websocket" import {boot} from "./app/boot" import {injectNip07} from "./app/nip07" import {seed} from "./seed/scenario" import type {Scenario, SeedTools} from "./seed/scenario" import type {TestUser} from "./keys" export {expect} export {makeTestUser, users} from "./keys" export type {TestUser} from "./keys" export type {Scenario} from "./seed/scenario" export type {SeededRumor, SeededSpace} from "./seed/space" export type {TenantName} from "./zooid/config" export type {TranscriptEntry} from "./net/websocket" export {formatTranscript, getTranscript} from "./net/websocket" export { assertNoBlockedRequests, getHosting, mockBlossom, mockDufflepud, mockLivekit, } from "./net/http" export type {DufflepudFixtures, HostingFixtures, HostingHandle, HostingRecord} from "./net/http" // Mirrors encodeRelay in src/app/relays.ts, which can't be imported here — it reaches the app's // module graph, and with it sveltekit. const encodeRelay = (url: string) => encodeURIComponent( normalizeRelayUrl(url) .replace(/^wss:\/\//, "") .replace(/\/$/, ""), ) export const spacePath = (url: string) => `/spaces/${encodeRelay(url)}` export const roomPath = (url: string, h: string) => `${spacePath(url)}/${h}` // What a page is opened with, over and above the scenario's own relays. export type PageOptions = { // Overrides the project's context options, for a spec that needs a viewport, a colour scheme or // a permission of its own. context?: BrowserContextOptions // VITE_ values applied over the ones derived from the scenario's relays, e.g. a platform space // or the domain hosted relays are created under. Whatever is named here has to be something the // scenario owns, or the app will reach for it and the test will fail on a leak. env?: Record // A NIP-07 provider signing as this user, for a login that goes through an extension. nip07?: TestUser // A blossom server, installed before the page boots. A spec whose server is one the app probes // on load — a space's own url, which src/app/sync.ts asks about as soon as its page opens — // has to name it here: mockBlossom called on the page `as()` returns arrives after that probe // has already been answered and cached, and uploads go to the default server instead. blossom?: BlossomOptions // Fields merged over a relay's own nip-11 document, keyed by relay url. relayInfo?: RelayInfoOverrides // What the hosting backend already knows about this user. Read `getHosting(page.context())` for // the handle that changes it mid-test. hosting?: HostingFixtures } export type Harness = { zooid: Zooid seed(build: (tools: SeedTools) => MaybeAsync): Promise // A logged-in page for a user: its own browser context, its own storage, its own sockets into // the relays every other user is talking to. as(user: TestUser, path?: string, options?: PageOptions): Promise // The same page with no session injected — the app as someone who has never logged in sees it, // and the only way to watch a login, a reload or a logout happen. visit(path?: string, options?: PageOptions): Promise } export type HarnessFixtures = { harness: Harness seed: Harness["seed"] as: Harness["as"] visit: Harness["visit"] } export type HarnessWorkerFixtures = { zooid: Zooid } export const test = base.extend({ // Playwright's own context — and the `page` fixture built on it — is unrouted: no websocket // interception, no http block-all, no injected env, and nothing collecting leaks from it. A page // born there boots the app against the relays baked into .env, which is the one thing this suite // exists to prevent, so it is refused outright and `as()`/`visit()` are the only ways to get a // page. context: async () => { throw new Error( "The built-in `context` and `page` fixtures reach the real network. Open a page with the " + "harness's `as(user, path)` or `visit(path)` fixture, which install interception before " + "they navigate.", ) }, // Playwright builds this one with `playwright.request.newContext()`, so it is an http client in // this process that belongs to no browser context: `installHttpRoutes` cannot see it and nothing // records what it sent. request: async () => { throw new Error( "The built-in `request` fixture makes http requests from node, where nothing intercepts " + "them. Anything the app fetches belongs in a mock installed by `as(user, path)`.", ) }, // One container per worker, torn down when the worker ends. It is reset between tests rather // than recreated, so the docker start-up cost is paid once. zooid: [ // playwright reads a fixture's dependencies off this pattern, so it has to stay a pattern // even when there are none. // eslint-disable-next-line no-empty-pattern async ({}, use) => { const zooid = new Zooid() await use(zooid) await zooid.stop() }, {scope: "worker"}, ], harness: async ({zooid, browser}, use, testInfo) => { const dockerProblem = await describeDockerProblem() testInfo.skip(Boolean(dockerProblem), dockerProblem) await zooid.start() await zooid.reset() const contexts: BrowserContext[] = [] let scenario: Maybe const requireScenario = () => { if (scenario) return scenario throw new Error("Seed a scenario before opening a page for a user") } const open = async (path: string, options: PageOptions, user?: TestUser) => { const {urls, cache} = requireScenario() // The project's own `use` first, so a viewport, colour scheme or device descriptor set in // playwright.config.ts reaches the context rather than being silently dropped. // // A request a service worker makes is not seen by context.route, so a worker is the one // way out of the block-all below. Sveltekit registers src/service-worker.js on every // navigation in dev; it has no fetch handler today, and blocking registration is what keeps // that from being the thing containment rests on. const context = await browser.newContext({ ...testInfo.project.use, serviceWorkers: "block", ...options.context, }) contexts.push(context) // Interception before navigation, and the block-all before the mocks — playwright matches // the most recently registered route first, and every mock falls through what it doesn't // recognize, so the mocks have to be registered last to be reachable at all. await installHttpRoutes(context) await installWebSocketRoutes(context, zooid) await mockRelayInfo(context, options.relayInfo ?? {}) await mockAnalytics(context) await mockDufflepud(context) await mockHosting(context, options.hosting) await mockPushServer(context) await mockImages(context) if (options.blossom) { await mockBlossom(context, options.blossom) } if (options.nip07) { await injectNip07(context, options.nip07) } return boot(context, { user, path, env: options.env, relays: urls, spaces: urls, events: user ? cache(user) : [], }) } await use({ zooid, as: (user, path = "/", options = {}) => open(path, options, user), visit: (path = "/", options = {}) => open(path, options), seed: async build => { scenario = await seed(zooid, build) return scenario }, }) for (const context of contexts) { await context.close() } for (const context of contexts) { assertNoLeaks(context) } }, seed: async ({harness}, use) => use(harness.seed), as: async ({harness}, use) => use(harness.as), visit: async ({harness}, use) => use(harness.visit), })