scaffold.ts 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557
  1. // Shared scaffold for the keyless browser e2e lane (Agent Note:
  2. // .agents/notes/implemented/testing/2026-07-24-web-gui-browser-e2e-lane.md).
  3. // Boots the REAL web composition — the shipped base plus web overlay through
  4. // the vendored Loader (the same include boot AppCLIEntry drives), patched the
  5. // snapshot way — so a real chromium exercises the real HTTP/SSE wire, the
  6. // api-gateway, agent loop, tools, and persistence. Modes ride $DSH_SNAPSHOT:
  7. // replay (default, keyless: normally disables the llm-deepseek row and
  8. // inserts dsh-llm-replay in providers mode), record (real adapter + key,
  9. // harvests fixtures from live session memory), refresh (keyless replay that
  10. // rewrites goldens). A first-run option keeps the real adapter mounted while
  11. // masking its credential, without making a model call.
  12. //
  13. // Composition divergences from `dsh web`, all deliberate, all via include
  14. // patches after the shipped surface overlay: temp persistenceRoot; local skill
  15. // roots confined to the temp workspace; workspace-context disabled (recorded
  16. // fixtures must not embed this repo's AGENTS.md); session-title-llm disabled
  17. // (its fire-and-forget title call would race the loop for the session's replay
  18. // cursor); webserver pinned to port 0 with the built dist; ordinary keyless
  19. // modes disable llm-deepseek and fill the open llm seam post-boot with
  20. // installLlmReplay on the settled root ctx
  21. // (the plugin-row path discards the ReplayHandle; the direct install keeps
  22. // assertConsumed for the teardown fixture-consumption check).
  23. import { existsSync } from 'node:fs'
  24. import { mkdtemp, readFile, readdir, realpath, rm, utimes, writeFile } from 'node:fs/promises'
  25. import { tmpdir } from 'node:os'
  26. import { join, resolve } from 'node:path'
  27. import { pathToFileURL } from 'node:url'
  28. import type { Page } from 'playwright'
  29. import { expect } from 'vitest'
  30. import { Context } from 'cordis'
  31. import Loader from '@cordisjs/plugin-loader'
  32. import Include, { type PatchOptions } from '@cordisjs/plugin-include'
  33. import { scrubRequestHeaders } from '@deepseek-ai/dsh-acp-snapshot'
  34. import { assertEntriesLoaded, loadOverlayPatches } from '@deepseek-ai/dsh-app-boot'
  35. import type { ReplayHandle } from '@deepseek-ai/dsh-llm-replay'
  36. import { installLlmReplay, parseSessionLog } from '@deepseek-ai/dsh-llm-replay'
  37. import SessionStore, {
  38. packChunkRuns,
  39. SESSION_FORMAT_VERSION,
  40. SessionId,
  41. type Session,
  42. type SessionEvent,
  43. type SessionHeader,
  44. } from '@deepseek-ai/dsh-session'
  45. import SessionPersistenceJsonl from '@deepseek-ai/dsh-session-persistence-jsonl'
  46. import * as ToolCordis from '@deepseek-ai/dsh-tool-cordis'
  47. // Empty type imports carry the httpServer/agents/sessionPersistence Context merges.
  48. import type {} from '@deepseek-ai/dsh-host-webserver'
  49. import type {} from '@deepseek-ai/dsh-agent'
  50. import { DIST_INDEX, REPO_ROOT, requireDist } from './support.ts'
  51. /** Snapshot mode for the lane, from $DSH_SNAPSHOT (same vocabulary as the ACP/TUI suites). */
  52. export type WebSnapshotMode = 'replay' | 'record' | 'refresh'
  53. /**
  54. * Resolve and validate the lane's snapshot mode.
  55. * @returns the active mode; unset/empty selects replay.
  56. */
  57. export function webSnapshotMode(): WebSnapshotMode {
  58. const value = process.env.DSH_SNAPSHOT
  59. if (value === undefined || value === '' || value === 'replay') return 'replay'
  60. if (value === 'record' || value === 'refresh') return value
  61. throw new Error(`DSH_SNAPSHOT must be replay, record, or refresh; got ${JSON.stringify(value)}`)
  62. }
  63. /** The shipped composition under test: apps/cli's shared base and web overlay. */
  64. const CONFIG_PATH = join(REPO_ROOT, 'apps/cli/config/base.cordis.yml')
  65. const WEB_OVERLAY_PATH = join(REPO_ROOT, 'apps/cli/config/web.cordis.yml')
  66. // Replay publishes the provider catalog the gateway routes to (providers
  67. // mode, never catch-all: with llm-deepseek disabled no adapter exists, so a
  68. // catch-all would leave resolveModelInfo unroutable and compact-basic's
  69. // post-step pressure check would warn every step). The published
  70. // contextWindow keeps that pressure path provably inert for small fixtures.
  71. const REPLAY_PROVIDERS = [{
  72. id: 'deepseek-official',
  73. name: 'DeepSeek',
  74. models: [{ id: 'deepseek-v4-flash', name: 'DeepSeek-V4-Flash', contextWindow: 128_000 }],
  75. }]
  76. /** A booted web scaffold: real composition, mode-selected model backend, temp world. */
  77. export interface WebScaffold {
  78. /** The active snapshot mode this scaffold booted under. */
  79. mode: WebSnapshotMode
  80. /** Browser-facing origin (http://127.0.0.1:<bound port>). */
  81. baseUrl: string
  82. /** Settled root context (the in-process barrier seam; headless event subscription is its sanctioned use). */
  83. ctx: Context
  84. /** Temp project directory sessions run in (bash/fs tool cwd). */
  85. workspaceCwd: string
  86. /** Temp persistence root (seeded sessions land here through the real API). */
  87. persistenceRoot: string
  88. /** Isolated harness home the settings/credentials rows write ($DSH_HOME double). */
  89. harnessHome: string
  90. /** Await a settled turn end: in-process turn/end, then the agent's idle flip (which follows the persistence flush). */
  91. whenTurnSettled(timeoutMs?: number): Promise<SessionId>
  92. /** Tear everything down; asserts the replay fixture was fully consumed first (replay/refresh). */
  93. close(): Promise<void>
  94. }
  95. /** Options for {@link launchWebScaffold}. */
  96. export interface LaunchOptions {
  97. /**
  98. * Replay fixture (session.jsonl) served by the inserted dsh-llm-replay row
  99. * in replay/refresh modes; ignored in record mode (the real adapter
  100. * answers). Omit for scenarios issuing no model calls — a stray stream then
  101. * fails loud with NO_ADAPTER (llm-deepseek is disabled and no replay row
  102. * mounts).
  103. */
  104. replayFixture?: string
  105. /**
  106. * Optional replay.override.json sidecar (whole-script replacement or
  107. * `{ patches }` augmentation) for throw/hang scenarios not expressible as
  108. * recorded chunks; replay/refresh only.
  109. */
  110. replayOverride?: string
  111. /** Per-chunk replay pacing (ms) so the browser observes genuinely incremental SSE; replay/refresh only. */
  112. paceMs?: number
  113. /**
  114. * Tool presentation mode patched onto the shipped `tools` row (`code`
  115. * collapses the wire to run_code + the SDK prompt section). Omit for the
  116. * yml default. The code runtime row is always in the tree, so no extra
  117. * insertion is needed.
  118. */
  119. toolsMode?: 'native' | 'code' | 'both'
  120. /**
  121. * Insert the opt-in self-referential Cordis tools into the shipped tree.
  122. * Record and replay use the same tool surface, so captured request headers
  123. * remain reconstructable without making the tools a product default.
  124. */
  125. cordisTools?: boolean
  126. /**
  127. * Keep the shipped DeepSeek adapter mounted while masking the process
  128. * environment's DEEPSEEK_API_KEY for this scaffold lifetime. This is the
  129. * keyless first-run configuration lane; the default disables the adapter.
  130. */
  131. deepSeekMissingCredential?: boolean
  132. }
  133. /** Dispose the booted tree and remove both owned temp roots, reporting every independent cleanup failure. */
  134. async function cleanupScaffoldWorld(ctx: Context, workspaceCwd: string, persistenceRoot: string): Promise<unknown[]> {
  135. const failures: unknown[] = []
  136. await Promise.resolve(ctx.fiber.dispose()).catch((error: unknown) => failures.push(error))
  137. await rm(workspaceCwd, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
  138. await rm(persistenceRoot, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
  139. return failures
  140. }
  141. /**
  142. * Boot the real web composition under the current snapshot mode.
  143. * @param options - replay fixture selection and pacing.
  144. * @returns the running scaffold.
  145. */
  146. export async function launchWebScaffold(options: LaunchOptions = {}): Promise<WebScaffold> {
  147. requireDist()
  148. const mode = webSnapshotMode()
  149. if (mode === 'record') {
  150. // Both owning vitest configs (web unconditionally, snapshot in record
  151. // mode) load the repo-root .env before this file runs.
  152. if (process.env.DEEPSEEK_API_KEY === undefined || process.env.DEEPSEEK_API_KEY.length === 0) {
  153. throw new Error('web e2e record mode needs DEEPSEEK_API_KEY (env or repo-root .env)')
  154. }
  155. }
  156. if (mode === 'record' && options.deepSeekMissingCredential === true) {
  157. throw new Error('deepSeekMissingCredential is a keyless replay/refresh option')
  158. }
  159. const maskDeepSeekCredential = mode !== 'record' && options.deepSeekMissingCredential === true
  160. const originalDeepSeekCredential = process.env.DEEPSEEK_API_KEY
  161. let credentialEnvironmentRestored = false
  162. const restoreCredentialEnvironment = (): void => {
  163. if (credentialEnvironmentRestored || !maskDeepSeekCredential) return
  164. credentialEnvironmentRestored = true
  165. if (originalDeepSeekCredential === undefined) {
  166. Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
  167. } else {
  168. process.env.DEEPSEEK_API_KEY = originalDeepSeekCredential
  169. }
  170. }
  171. const workspaceCwd = await realpath(await mkdtemp(join(tmpdir(), 'dsh-web-e2e-ws-')))
  172. // Isolated harness home: the settings/credentials rows resolve $DSH_HOME
  173. // paths at load, and an in-process boot must NEVER touch the developer's
  174. // real ~/.dsh document or credential file.
  175. const harnessHome = join(workspaceCwd, '.dsh-home')
  176. let persistenceRoot: string
  177. try {
  178. persistenceRoot = await mkdtemp(join(tmpdir(), 'dsh-web-e2e-sessions-'))
  179. } catch (error) {
  180. const failures: unknown[] = [error]
  181. await rm(workspaceCwd, { recursive: true, force: true }).catch((cleanupError: unknown) => failures.push(cleanupError))
  182. if (failures.length > 1) throw new AggregateError(failures, 'web scaffold temp-root setup failed')
  183. throw error
  184. }
  185. if (maskDeepSeekCredential) Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
  186. // The include patch set — the same mechanism AppCLIEntry and the ACP
  187. // snapshot overlay use, applied over the SAME shipped tree (a patch id that
  188. // stops matching a row fails the boot sweep loudly instead of drifting).
  189. const surfacePatches = loadOverlayPatches('web e2e scaffold', WEB_OVERLAY_PATH)
  190. const patches: PatchOptions[] = [
  191. ...surfacePatches,
  192. { id: 'session-persistence-jsonl', config: { root: persistenceRoot } },
  193. { id: 'session-query-sqlite', config: { path: ':memory:', openAt: 'first-search' } },
  194. // storage-json's './.storages' yml default is cwd-relative and resolves
  195. // per write; the scaffold restores the original cwd after boot, so the
  196. // row gets an absolute temp root (removed with the workspace at close).
  197. { id: 'storage-json', config: { root: join(workspaceCwd, '.dsh-storages') } },
  198. // Skill discovery is model-visible input. Pin every host-level root inside
  199. // the owned temp world so ~/.dsh, ~/.agents, and a bundled-root env setting
  200. // cannot change replay requests or conversation goldens. Project roots stay
  201. // enabled against the same empty temp workspace, preserving the real seam.
  202. {
  203. id: 'skill-local',
  204. config: {
  205. dshHome: join(workspaceCwd, '.dsh-home'),
  206. agentsHome: join(workspaceCwd, '.agents-home'),
  207. bundledSkillDir: join(workspaceCwd, '.bundled-skills'),
  208. watch: false,
  209. },
  210. },
  211. // fs/bash cwd default to process.cwd(); the gateway injects the same
  212. // value into session.cwd — chdir below anchors all three to the temp
  213. // workspace, keeping the composition untouched.
  214. { id: 'workspace-context', disabled: true },
  215. { id: 'session-title-llm', disabled: true },
  216. // Fixture sessions must never leave the process: the shipped row defaults
  217. // to the production OTLP endpoint (or whatever DSH_TELEMETRY_OTLP_URL
  218. // names in the ambient environment).
  219. { id: 'telemetry-otel', disabled: true },
  220. { id: 'webserver', config: { host: '127.0.0.1', port: 0, distIndex: DIST_INDEX } },
  221. { id: 'settings', config: { dshHome: harnessHome } },
  222. { id: 'credentials', config: { dshHome: harnessHome } },
  223. // The shipped directory-picker row is the -auto chooser, which resolves
  224. // the interaction from the RUNNING host (display, SSH launch, bind). The
  225. // lane's goldens are interaction-specific (workspace-management drives
  226. // the in-app browse dialog), so pin -browse deterministically on every
  227. // host: patch `name` is an assertion, not an override, hence the
  228. // disable+insert pair.
  229. { id: 'directory-picker', disabled: true },
  230. { insert: [{ id: 'directory-picker-browse', name: '@deepseek-ai/dsh-host-directory-picker-browse' }] },
  231. ...options.toolsMode === undefined ? [] : [{ id: 'tools', config: { mode: options.toolsMode } }],
  232. ...options.cordisTools === true
  233. ? [{ insert: [{ id: 'tool-cordis', name: 'cordis:tool-cordis' }] }]
  234. : [],
  235. ...mode === 'record' || options.deepSeekMissingCredential === true
  236. ? []
  237. : [{ id: 'llm-deepseek', disabled: true }],
  238. ]
  239. // Sessions inherit the gateway's process.cwd() default; run the boot from
  240. // the temp workspace so tool cwd, session cwd, and fixtures agree.
  241. const originalCwd = process.cwd()
  242. const ctx = new Context()
  243. let port = 0
  244. let replayHandle: ReplayHandle | undefined
  245. try {
  246. process.chdir(workspaceCwd)
  247. ctx.baseUrl = pathToFileURL(join(resolve(CONFIG_PATH), '..')).href + '/'
  248. await ctx.plugin(Loader)
  249. ctx.loader.builtins.include = Include
  250. // The shipped CLI deliberately has no dependency on this opt-in package.
  251. // Keep the Loader row real without broadening the product installation.
  252. if (options.cordisTools === true) ctx.loader.builtins['tool-cordis'] = ToolCordis
  253. await ctx.loader.create({
  254. name: 'cordis:include',
  255. config: { path: pathToFileURL(resolve(CONFIG_PATH)).href, patches },
  256. })
  257. await ctx.loader.await()
  258. assertEntriesLoaded(ctx, 'web e2e scaffold')
  259. const boundPort = ctx.get('httpServer')?.port
  260. if (boundPort === undefined) {
  261. throw new Error('web e2e scaffold: httpServer service missing after settled boot')
  262. }
  263. port = boundPort
  264. // Fill the open llm seam on the settled root ctx. Ordinary keyless modes
  265. // disable llm-deepseek; the first-run lane keeps it mounted but has no
  266. // replay fixture and never streams. The direct install, unlike the plugin
  267. // row, returns the ReplayHandle for the teardown consumption check.
  268. if (mode !== 'record' && options.replayFixture !== undefined) {
  269. replayHandle = installLlmReplay(ctx, {
  270. file: options.replayFixture,
  271. providers: REPLAY_PROVIDERS,
  272. ...(options.replayOverride === undefined ? {} : { overrideFile: options.replayOverride }),
  273. ...(options.paceMs === undefined ? {} : { paceMs: options.paceMs }),
  274. })
  275. }
  276. } catch (error) {
  277. if (process.cwd() !== originalCwd) process.chdir(originalCwd)
  278. const cleanupFailures = await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot)
  279. restoreCredentialEnvironment()
  280. if (cleanupFailures.length > 0) {
  281. throw new AggregateError([error, ...cleanupFailures], 'web scaffold setup failed and cleanup was incomplete')
  282. }
  283. throw error
  284. } finally {
  285. if (process.cwd() !== originalCwd) process.chdir(originalCwd)
  286. }
  287. return {
  288. harnessHome,
  289. mode,
  290. baseUrl: `http://127.0.0.1:${port}`,
  291. ctx,
  292. workspaceCwd,
  293. persistenceRoot,
  294. // Barrier stack: the in-process turn/end identifies the session, then
  295. // agent.whenIdle() covers the persistence flush (the idle flip follows
  296. // the flush), and the caller's browser settled-poll comes last because
  297. // host completion strictly precedes render.
  298. whenTurnSettled(timeoutMs = mode === 'record' ? 180_000 : 30_000): Promise<SessionId> {
  299. return new Promise<SessionId>((resolveSettled, reject) => {
  300. const timer = setTimeout(() => {
  301. off()
  302. reject(new Error(`no turn/end within ${timeoutMs}ms`))
  303. }, timeoutMs)
  304. const off = ctx.on('session/event', (session: { id: SessionId }, event: SessionEvent) => {
  305. if (event.type !== 'turn/end') return
  306. clearTimeout(timer)
  307. off()
  308. const agent = ctx.agents.get(session.id)
  309. if (agent === undefined) {
  310. reject(new Error(`turn/end for ${session.id} but no live agent`))
  311. return
  312. }
  313. agent.whenIdle().then(() => { resolveSettled(session.id) }, reject)
  314. })
  315. })
  316. },
  317. async close(): Promise<void> {
  318. const failures: unknown[] = []
  319. // Fixture-consumption check first, while the run's binding state is
  320. // still authoritative — a scenario that drove fewer model calls than
  321. // recorded fails here instead of drifting green.
  322. try {
  323. replayHandle?.assertConsumed()
  324. } catch (error) {
  325. failures.push(error)
  326. }
  327. try {
  328. failures.push(...await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot))
  329. } finally {
  330. restoreCredentialEnvironment()
  331. }
  332. if (failures.length > 0) throw new AggregateError(failures, 'web scaffold teardown failed')
  333. },
  334. }
  335. }
  336. /**
  337. * Serialize a live session to the canonical raw session-JSONL layout — the
  338. * in-memory record-mode harvest, so the on-disk zstd default never matters.
  339. */
  340. function rawSessionLog(session: Session): string {
  341. return [
  342. JSON.stringify({ type: 'session', ...session.header }),
  343. ...packChunkRuns(session.events).map(record => JSON.stringify(record)),
  344. '',
  345. ].join('\n')
  346. }
  347. /**
  348. * Record-mode fixture write-back: harvest the live session, scrub request
  349. * headers to {{system}}/{{tools}} (TODO(web-header-pin): the web lane pins no
  350. * header class — a deliberate deviation logged in the Agent Note's deferred
  351. * work), tokenize the run-local session id, cwd, and browser RPC id
  352. * ({{sessionId}}/{{cwd}}/{{rpcId}}, the committed fixture convention —
  353. * re-records then diff only on real content), and write the fixture.
  354. * @param scaffold - the record-mode scaffold.
  355. * @param sessionId - the driven session.
  356. * @param fixturePath - the committed session.jsonl / seed.jsonl target.
  357. */
  358. export async function recordFixture(scaffold: WebScaffold, sessionId: SessionId, fixturePath: string): Promise<void> {
  359. const agent = scaffold.ctx.agents.get(sessionId)
  360. if (agent === undefined) throw new Error(`record harvest: no live agent for ${sessionId}`)
  361. const tokenized = scrubRequestHeaders(rawSessionLog(agent.session))
  362. .split(sessionId).join('{{sessionId}}')
  363. .split(scaffold.workspaceCwd).join('{{cwd}}')
  364. .replace(/"rpcId":"[^"]+"/g, '"rpcId":"{{rpcId}}"')
  365. await writeFile(fixturePath, tokenized)
  366. }
  367. /**
  368. * The user prompts recorded in a fixture, in order — the single source tying
  369. * spec drive steps to recorded reality so script and fixture cannot drift.
  370. * @param fixtureText - raw session.jsonl contents.
  371. * @returns the recorded user prompt texts.
  372. */
  373. export function fixtureUserPrompts(fixtureText: string): string[] {
  374. return parseSessionLog(fixtureText).flatMap((event) => {
  375. if (event.type !== 'user/message' || event.data.source.kind !== 'user') return []
  376. const text = event.data.content.filter(block => block.type === 'text').map(block => block.text).join('')
  377. return text.length > 0 ? [text] : []
  378. })
  379. }
  380. /**
  381. * Seed a recorded session fixture into the scaffold's persistence root
  382. * through the REAL backend API (throwaway Context + SessionStore + JSONL
  383. * plugin — the semantic-checkpoint precedent), never raw file writes: no
  384. * knowledge of bucket hashing, filename encoding, or compression, and
  385. * malformed shapes fail loud at seed time. The fixture's tokenized identity
  386. * ({{sessionId}}/{{cwd}}) is realized for this world before parsing.
  387. * @param scaffold - the target scaffold.
  388. * @param fixtureText - raw recorded session.jsonl contents.
  389. * @param id - the seeded session id (stable for deterministic goldens).
  390. * @returns the seeded id.
  391. */
  392. export async function seedSession(scaffold: WebScaffold, fixtureText: string, id: string): Promise<SessionId> {
  393. const realized = fixtureText
  394. .split('{{sessionId}}').join(id)
  395. .split('{{cwd}}').join(scaffold.workspaceCwd)
  396. const fixtureCwd = (JSON.parse(realized.split('\n', 1)[0]!) as { cwd?: string }).cwd
  397. const rewritten = fixtureCwd === undefined
  398. ? realized
  399. : realized.split(fixtureCwd).join(scaffold.workspaceCwd)
  400. const events = parseSessionLog(rewritten)
  401. if (events.length === 0) throw new Error('seed fixture has no events')
  402. const last = events[events.length - 1]!
  403. // An open final turn would be mutated by resume's crash repair on first
  404. // open; a committed seed must be a closed recording.
  405. if (last.type !== 'turn/end') throw new Error(`seed fixture must end in turn/end, got ${last.type}`)
  406. const meta: SessionHeader = {
  407. version: SESSION_FORMAT_VERSION,
  408. id: SessionId(id),
  409. createdAt: Date.now() - 60_000,
  410. cwd: scaffold.workspaceCwd,
  411. delegationDepth: 0,
  412. }
  413. const seeder = new Context()
  414. try {
  415. await seeder.plugin(SessionStore)
  416. // Same root as the booted tree with the plugin's own default compression,
  417. // so the host's directory-scan list() sees one consistent encoding.
  418. await seeder.plugin(SessionPersistenceJsonl, { root: scaffold.persistenceRoot })
  419. await seeder.sessionPersistence.create(meta)
  420. await seeder.sessionPersistence.append(meta.id, events)
  421. // Deterministic sidebar order: cold summaries take updatedAt from mtime.
  422. const located = seeder.sessionPersistence.locate(meta)
  423. if (located !== undefined) {
  424. const backdated = new Date(meta.createdAt)
  425. await utimes(located.path, backdated, backdated)
  426. }
  427. } finally {
  428. await seeder.fiber.dispose()
  429. }
  430. return meta.id
  431. }
  432. /**
  433. * Normalize an aria snapshot: uuid, cwd, workspace-basename, and duration
  434. * volatility collapse to stable tokens.
  435. */
  436. function normalizeAria(snapshot: string, workspaceCwd: string): string {
  437. // The header breadcrumb renders the workspace's basename, not the full
  438. // path, so both spellings must collapse to the token.
  439. const base = workspaceCwd.split('/').pop()!
  440. return snapshot
  441. .split(workspaceCwd).join('{{cwd}}')
  442. .split(base).join('{{workspace}}')
  443. .replace(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, '{{uuid}}')
  444. .replace(/\b\d+(?:\.\d+)?(?:ms|s|秒)\b/g, '{{duration}}')
  445. // Message IconActions clocks widen by calendar day/year; collapse every
  446. // shape so goldens stay stable across midnight and year boundaries.
  447. .replace(/\d{4}年\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
  448. .replace(/\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
  449. .replace(/(?<!\d)\d{2}:\d{2}(?!\d)/g, '{{clock}}')
  450. }
  451. /**
  452. * Capture the region's aria snapshot at a settled milestone: poll until two
  453. * consecutive normalized captures are equal — a single-shot capture races the
  454. * last React commits.
  455. * @param page - the page under test.
  456. * @param selector - the region locator selector.
  457. * @param workspaceCwd - normalization input.
  458. * @returns the stable normalized snapshot.
  459. */
  460. export async function captureStableAria(page: Page, selector: string, workspaceCwd: string): Promise<string> {
  461. const region = page.locator(selector).first()
  462. let previous = normalizeAria(await region.ariaSnapshot(), workspaceCwd)
  463. await expect.poll(async () => {
  464. const current = normalizeAria(await region.ariaSnapshot(), workspaceCwd)
  465. const stable = current === previous
  466. previous = current
  467. return stable
  468. }, { timeout: 5_000, message: 'aria snapshot did not stabilize' }).toBe(true)
  469. return previous
  470. }
  471. /**
  472. * Compare a normalized golden, or rewrite it under refresh. Refresh is the
  473. * ONLY writer: a missing golden in replay mode fails with the healing command
  474. * instead of silently self-bootstrapping.
  475. * @param goldenPath - the committed ui.expected.md path.
  476. * @param actual - the stable normalized snapshot.
  477. * @param mode - the active snapshot mode.
  478. */
  479. export async function compareOrRefreshGolden(goldenPath: string, actual: string, mode: WebSnapshotMode): Promise<void> {
  480. const payload = `${actual}\n`
  481. if (mode === 'refresh') {
  482. await writeFile(goldenPath, payload)
  483. return
  484. }
  485. if (!existsSync(goldenPath)) {
  486. throw new Error(`missing golden ${goldenPath} — run DSH_SNAPSHOT=refresh pnpm run test:web to generate it`)
  487. }
  488. expect(payload).toBe(await readFile(goldenPath, 'utf8'))
  489. }
  490. /**
  491. * Fixture-inventory guard (the TUI afterAll shape): the scenario directory
  492. * holds exactly the expected files and every committed JSONL is a scrub
  493. * fixed-point without a run-local browser RPC id.
  494. * @param dir - the scenario snapshot directory.
  495. * @param expected - the exact expected file inventory.
  496. */
  497. export async function assertFixtureInventory(dir: string, expected: string[]): Promise<void> {
  498. const entries = (await readdir(dir)).sort()
  499. expect(entries).toEqual([...expected].sort())
  500. for (const entry of entries.filter(name => name.endsWith('.jsonl'))) {
  501. const content = await readFile(join(dir, entry), 'utf8')
  502. expect(scrubRequestHeaders(content), `${dir}/${entry} carries request-header bulk`).toBe(content)
  503. expect(content, `${dir}/${entry} carries a run-local rpcId`)
  504. .not.toMatch(/"rpcId":"(?!\{\{rpcId\}\})[^"]+"/)
  505. }
  506. }
  507. /**
  508. * Console tripwires: reconnect/gap-repair self-healing or a pageerror must
  509. * fail the scenario, not mask a dead wire behind eventual consistency.
  510. * @param page - the page under test.
  511. * @returns live warning/pageerror collectors to assert empty at scenario end.
  512. */
  513. export function watchConsole(page: Page): { warnings: string[]; pageErrors: string[] } {
  514. const warnings: string[] = []
  515. const pageErrors: string[] = []
  516. page.on('console', (message) => {
  517. const text = message.text()
  518. if (/connection lost|gap repair|discontinuous/i.test(text)) warnings.push(text)
  519. })
  520. page.on('pageerror', (error) => { pageErrors.push(String(error)) })
  521. return { warnings, pageErrors }
  522. }
  523. /**
  524. * Remove only connection-loss warnings emitted after an intentional reload.
  525. * Earlier warnings and all gap-repair/discontinuity warnings remain fatal.
  526. * @param tripwire - the live console-warning collector.
  527. * @param warningStart - warning count captured immediately before reloading.
  528. */
  529. export function acknowledgeReloadConnectionLoss(
  530. tripwire: ReturnType<typeof watchConsole>,
  531. warningStart: number,
  532. ): void {
  533. const reloadWarnings = tripwire.warnings.splice(warningStart)
  534. tripwire.warnings.push(...reloadWarnings.filter(text => !/connection lost/i.test(text)))
  535. }