scaffold.ts 28 KB

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