|
| 1 | +import { test as base, type Page } from "@playwright/test"; |
| 2 | +import { type ChildProcess, spawn } from "node:child_process"; |
| 3 | +import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises"; |
| 4 | +import net from "node:net"; |
| 5 | +import { platform, tmpdir } from "node:os"; |
| 6 | +import { dirname, join } from "node:path"; |
| 7 | + |
| 8 | +/** The platform-appropriate modifier key: Meta on macOS, Control elsewhere. */ |
| 9 | +export const mod = platform() === "darwin" ? "Meta" : "Control"; |
| 10 | + |
| 11 | +export type SBServer = { |
| 12 | + url: string; |
| 13 | + port: number; |
| 14 | + spaceDir: string; |
| 15 | +}; |
| 16 | + |
| 17 | +type SBFixtures = { |
| 18 | + spaceFiles: Record<string, string>; |
| 19 | + sbServer: SBServer; |
| 20 | + sbPage: Page; |
| 21 | + sbPageWithSync: Page; |
| 22 | +}; |
| 23 | + |
| 24 | +async function getFreePort(): Promise<number> { |
| 25 | + return new Promise((resolve, reject) => { |
| 26 | + const srv = net.createServer(); |
| 27 | + srv.listen(0, "127.0.0.1", () => { |
| 28 | + const addr = srv.address() as net.AddressInfo; |
| 29 | + srv.close(() => resolve(addr.port)); |
| 30 | + }); |
| 31 | + srv.on("error", reject); |
| 32 | + }); |
| 33 | +} |
| 34 | + |
| 35 | +async function waitForServer(url: string, timeoutMs = 30_000): Promise<void> { |
| 36 | + const deadline = Date.now() + timeoutMs; |
| 37 | + while (Date.now() < deadline) { |
| 38 | + try { |
| 39 | + const resp = await fetch(url); |
| 40 | + if (resp.ok) return; |
| 41 | + } catch { |
| 42 | + // server not ready yet |
| 43 | + } |
| 44 | + await new Promise((r) => setTimeout(r, 200)); |
| 45 | + } |
| 46 | + throw new Error(`Server did not become ready at ${url} within ${timeoutMs}ms`); |
| 47 | +} |
| 48 | + |
| 49 | +export const test = base.extend<SBFixtures>({ |
| 50 | + spaceFiles: [{}, { option: true }], |
| 51 | + |
| 52 | + sbServer: async ({ spaceFiles }, use) => { |
| 53 | + const spaceDir = await mkdtemp(join(tmpdir(), "sb-e2e-")); |
| 54 | + |
| 55 | + // Seed space with files |
| 56 | + for (const [path, content] of Object.entries(spaceFiles)) { |
| 57 | + const fullPath = join(spaceDir, path); |
| 58 | + await mkdir(dirname(fullPath), { recursive: true }); |
| 59 | + await writeFile(fullPath, content); |
| 60 | + } |
| 61 | + |
| 62 | + const port = await getFreePort(); |
| 63 | + |
| 64 | + const proc: ChildProcess = spawn( |
| 65 | + "./silverbullet", |
| 66 | + [spaceDir, "-p", String(port), "-L", "127.0.0.1"], |
| 67 | + { |
| 68 | + cwd: join(import.meta.dirname, ".."), |
| 69 | + stdio: ["ignore", "pipe", "pipe"], |
| 70 | + }, |
| 71 | + ); |
| 72 | + |
| 73 | + let serverOutput = ""; |
| 74 | + proc.stdout?.on("data", (d: Buffer) => { |
| 75 | + serverOutput += d.toString(); |
| 76 | + }); |
| 77 | + proc.stderr?.on("data", (d: Buffer) => { |
| 78 | + serverOutput += d.toString(); |
| 79 | + }); |
| 80 | + |
| 81 | + const url = `http://127.0.0.1:${port}`; |
| 82 | + |
| 83 | + try { |
| 84 | + await waitForServer(`${url}/.ping`); |
| 85 | + } catch (err) { |
| 86 | + proc.kill("SIGKILL"); |
| 87 | + throw new Error(`Server failed to start. Output:\n${serverOutput}\n${err}`); |
| 88 | + } |
| 89 | + |
| 90 | + await use({ url, port, spaceDir }); |
| 91 | + |
| 92 | + // Cleanup |
| 93 | + proc.kill("SIGTERM"); |
| 94 | + await new Promise<void>((resolve) => { |
| 95 | + const timer = setTimeout(() => { |
| 96 | + proc.kill("SIGKILL"); |
| 97 | + resolve(); |
| 98 | + }, 5000); |
| 99 | + proc.on("exit", () => { |
| 100 | + clearTimeout(timer); |
| 101 | + resolve(); |
| 102 | + }); |
| 103 | + }); |
| 104 | + await rm(spaceDir, { recursive: true, force: true }); |
| 105 | + }, |
| 106 | + |
| 107 | + sbPage: async ({ sbServer, page }, use) => { |
| 108 | + await page.goto(`${sbServer.url}/?enableSW=0`); |
| 109 | + await page.locator("#sb-editor .cm-editor").waitFor({ state: "visible", timeout: 30_000 }); |
| 110 | + await use(page); |
| 111 | + }, |
| 112 | + |
| 113 | + sbPageWithSync: async ({ sbServer, page }, use) => { |
| 114 | + await page.goto(sbServer.url); |
| 115 | + await page.locator("#sb-editor .cm-editor").waitFor({ state: "visible", timeout: 30_000 }); |
| 116 | + await use(page); |
| 117 | + }, |
| 118 | +}); |
| 119 | + |
| 120 | +/** |
| 121 | + * Wait for the client to save (indicated by #sb-current-page having class "sb-saved"), |
| 122 | + * then fetch the page content from the server's filesystem API. |
| 123 | + */ |
| 124 | +export async function waitForSaveAndReadFromServer( |
| 125 | + page: Page, |
| 126 | + sbServer: SBServer, |
| 127 | + pagePath: string, |
| 128 | +): Promise<string> { |
| 129 | + // Wait for the save indicator — "sb-saved" class on the page name element |
| 130 | + await page.locator("#sb-current-page.sb-saved").waitFor({ state: "attached", timeout: 10_000 }); |
| 131 | + // Fetch the file from the server |
| 132 | + const resp = await fetch(`${sbServer.url}/.fs/${pagePath}`); |
| 133 | + if (!resp.ok) { |
| 134 | + throw new Error(`Failed to read ${pagePath} from server: ${resp.status}`); |
| 135 | + } |
| 136 | + return resp.text(); |
| 137 | +} |
| 138 | + |
| 139 | +export { expect } from "@playwright/test"; |
0 commit comments