scaffold.ts 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530
  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 dsh-base and dsh-web-app bundle
  4. // patches over the empty profile root through the vendored Loader (the same
  5. // layer stack the profile boot composes), patched the
  6. // snapshot way — so a real chromium exercises the real HTTP uplink/WebSocket
  7. // downlink, api-gateway, agent loop, tools, and persistence. Modes ride $DSH_SNAPSHOT:
  8. // replay (default, keyless: normally disables the llm-deepseek row and
  9. // inserts dsh-llm-replay in providers mode), record (real adapter + key,
  10. // harvests fixtures from live session memory), refresh (keyless replay that
  11. // rewrites goldens). A first-run option keeps the real adapter mounted while
  12. // masking its credential, without making a model call.
  13. //
  14. // Composition divergences from `dsh web`, all deliberate, all via include
  15. // patches after the shipped bundle layers, over the SAME tree (never a
  16. // second yml): temp persistenceRoot; host-level skill roots confined to the
  17. // temp workspace while project skill discovery remains real; agent-instructions
  18. // disabled (recorded fixtures must not embed this repo's AGENTS.md);
  19. // session-title-llm disabled (its fire-and-forget title call would race the
  20. // loop for the session's replay cursor); webserver pinned to port 0 with the
  21. // built dist; ordinary keyless modes disable llm-deepseek and fill the open
  22. // llm seam post-boot with installLlmReplay on the settled root ctx
  23. // (the plugin-row path discards the ReplayHandle; the direct install keeps
  24. // assertConsumed for the teardown fixture-consumption check).
  25. import { existsSync, readFileSync } from 'node:fs'
  26. import { createHash } from 'node:crypto'
  27. import { mkdir, mkdtemp, readFile, readdir, realpath, rm, writeFile } from 'node:fs/promises'
  28. import { tmpdir } from 'node:os'
  29. import { basename, dirname, join, resolve } from 'node:path'
  30. import { pathToFileURL } from 'node:url'
  31. import type { Page } from 'playwright'
  32. import { expect } from 'vitest'
  33. import { Context } from '@deepseek-ai/cordis'
  34. import Loader from '@deepseek-ai/cordis-plugin-loader'
  35. import Include, { type PatchOptions } from '@deepseek-ai/cordis-plugin-include'
  36. import Group from '@deepseek-ai/cordis-plugin-group'
  37. import {
  38. captureExpectedWorkspaceSnapshot,
  39. captureWorkspaceSnapshot,
  40. assertSessionFixtureVersion,
  41. formatSystemPromptSnapshot,
  42. formatToolSchemasSnapshot,
  43. normalizedSystemPrompts,
  44. normalizedToolSchemas,
  45. parseSnapshotManifest,
  46. redactSessionSnapshotIds,
  47. normalizeSessionSnapshots,
  48. parseSessionFixtureName,
  49. scrubRequestHeaders,
  50. scrubSessionSnapshot,
  51. sessionFixtureFiles,
  52. sessionFixtureName,
  53. stabilizeFixtureMessageIds,
  54. stabilizeRefreshLog,
  55. writesCurrentSessionFixtures,
  56. type NormalizeContext,
  57. } from '@deepseek-ai/dsh-session-snapshot'
  58. import {
  59. assertEntriesLoaded,
  60. composeEntries,
  61. healProfilesModuleFallback,
  62. loadOverlayPatches,
  63. type Profile,
  64. } from '@deepseek-ai/dsh-app-boot'
  65. import { dshHomePath } from '@deepseek-ai/dsh-home-paths'
  66. import { LlmAdapter } from '@deepseek-ai/dsh-llm'
  67. import type {
  68. LlmModelInfo, LlmProviderInfo, LlmResolvedModelInfo, RetryPolicyConfig, StreamChunk,
  69. } from '@deepseek-ai/dsh-llm'
  70. import type { ReplayHandle } from '@deepseek-ai/dsh-llm-replay'
  71. import {
  72. installLlmReplay,
  73. parseSessionLog,
  74. prepareSessionSnapshotFixtureForComparison,
  75. } from '@deepseek-ai/dsh-llm-replay'
  76. import type { SessionFormatEvent } from '@deepseek-ai/dsh-session-format'
  77. import { sessionFormatCatalog } from '@deepseek-ai/dsh-session-format-catalog'
  78. import {
  79. SESSION_FORMAT_VERSION,
  80. SessionId,
  81. type Session,
  82. type SessionEvent,
  83. type SessionHeader,
  84. } from '@deepseek-ai/dsh-session'
  85. import JsonlSessionPersistence from '@deepseek-ai/dsh-session-persistence-jsonl'
  86. // Empty type imports carry the webServer/agents/sessionPersistence Context merges.
  87. import type {} from '@deepseek-ai/dsh-host-webserver'
  88. import type {} from '@deepseek-ai/dsh-agent'
  89. import { provideCmdline } from '@deepseek-ai/dsh-cmdline'
  90. import { REPO_ROOT, requireDist } from './support.ts'
  91. // Host-side web e2e cannot import a browser package: doing so would pull that
  92. // package's complete TS project into this graph. Mirrored from
  93. // packages/client/ui-settings-models/src/onboarding-copy.ts; drift makes the
  94. // default pre-acknowledgement stop suppressing the notice and fails loudly.
  95. // import {
  96. // WELCOME_NOTICE_ACK_FIELD, WELCOME_NOTICE_SETTINGS_NAMESPACE,
  97. // WELCOME_NOTICE_VERSION, WELCOME_NOTICE_COPY,
  98. // } from '@deepseek-ai/dsh-client-ui-settings-models'
  99. export const WELCOME_NOTICE_SETTINGS_NAMESPACE = 'ui-onboarding'
  100. export const WELCOME_NOTICE_ACK_FIELD = 'welcomeNoticeVersion'
  101. export const WELCOME_NOTICE_VERSION = '2026-08-13.1'
  102. export const WELCOME_NOTICE_COPY = {
  103. zh: {
  104. title: '内测声明',
  105. body: 'DeepSeek Harness 目前的 0.1 版本仍处在面向 Harness 开发者进行测试的阶段,还有许多地方需要持续改进和打磨,希望听取广大开发者的反馈建议。预计 DeepSeek Harness 的核心插件以及基础 API 都会在接下来的一段时间内快速迭代、持续演化。\n\n我们期待与全球开发者一起,在开源、开放、可复用、可组合的基础设施之上,共同探索智能上限。欢迎全球 Harness 开发者加入 DSH 插件生态。',
  106. continueLabel: '继续',
  107. },
  108. } as const
  109. /** Snapshot mode for the lane, from $DSH_SNAPSHOT (same vocabulary as the other snapshot suites). */
  110. export type WebSnapshotMode = 'replay' | 'record' | 'refresh'
  111. /**
  112. * Resolve and validate the lane's snapshot mode.
  113. * @returns the active mode; unset/empty selects replay.
  114. */
  115. export function webSnapshotMode(): WebSnapshotMode {
  116. const value = process.env.DSH_SNAPSHOT
  117. if (value === undefined || value === '' || value === 'replay') return 'replay'
  118. if (value === 'record' || value === 'refresh') return value
  119. throw new Error(`DSH_SNAPSHOT must be replay, record, or refresh; got ${JSON.stringify(value)}`)
  120. }
  121. /**
  122. * Compare a session-driven Web scenario's complete workspace with its committed independent expected state.
  123. * @param scenarioDir - Absolute recorded-session scenario directory.
  124. * @param workspaceRoot - Absolute cwd used by the controlled session.
  125. */
  126. export async function assertFinalWorkspaceSnapshot(scenarioDir: string, workspaceRoot: string): Promise<void> {
  127. const manifestPath = join(scenarioDir, 'snapshot.yml')
  128. const manifest = parseSnapshotManifest(await readFile(manifestPath, 'utf8'), manifestPath)
  129. expect(manifest.workspace?.final, `${manifest.scenario ?? scenarioDir}: mutating Web scenario declares workspace.final`)
  130. .toBe(true)
  131. const actual = await captureWorkspaceSnapshot(workspaceRoot)
  132. const expected = await captureExpectedWorkspaceSnapshot(join(scenarioDir, 'workspace.expected'))
  133. expect(actual, `${manifest.scenario ?? scenarioDir}: complete final workspace`).toEqual(expected)
  134. }
  135. async function ownsReplayFixture(replayFixture: string | undefined): Promise<boolean> {
  136. if (replayFixture === undefined) return false
  137. const fixture = parseSessionFixtureName(basename(replayFixture))
  138. if (fixture === undefined || fixture.index !== 0) return false
  139. const manifestPath = join(dirname(replayFixture), 'snapshot.yml')
  140. if (!existsSync(manifestPath)) return false
  141. const manifest = parseSnapshotManifest(await readFile(manifestPath, 'utf8'), manifestPath)
  142. return manifest.session === undefined
  143. }
  144. /**
  145. * Resolve one requested fixture role to its highest committed generation.
  146. * @param path - any generation path for the requested parent or child role.
  147. * @param allowAbsent - Keep an absent canonical path only for an override-only replay script.
  148. * @returns the highest canonical sibling generation, or the input for non-Session files.
  149. */
  150. export async function selectedSessionFixture(path: string, allowAbsent = false): Promise<string> {
  151. const requested = parseSessionFixtureName(basename(path))
  152. if (requested === undefined) return path
  153. const entries = await readdir(dirname(path))
  154. if (allowAbsent && !entries.some(name => parseSessionFixtureName(name) !== undefined)) return path
  155. const selected = sessionFixtureFiles(entries)
  156. .find(candidate => candidate.index === requested.index)
  157. if (selected === undefined) throw new Error(`${path}: missing Session fixture role ${requested.index}`)
  158. const resolved = join(dirname(path), selected.name)
  159. assertSessionFixtureVersion(selected.name, await readFile(resolved, 'utf8'))
  160. return resolved
  161. }
  162. /**
  163. * Return the current-writer target without replacing the requested older fixture.
  164. * @param path - any canonical fixture generation for one role.
  165. * @param version - generation emitted by the current writer.
  166. * @returns the canonical sibling path for that role and generation.
  167. */
  168. export function recordedSessionFixturePath(path: string, version: number): string {
  169. const fixture = parseSessionFixtureName(basename(path))
  170. if (fixture === undefined) throw new Error(`record harvest: invalid Session fixture path ${path}`)
  171. return join(dirname(path), sessionFixtureName(fixture.index, version))
  172. }
  173. /** The shipped composition under test: the dsh-base and dsh-web-app bundle patches over the empty profile root. */
  174. const BASE_PATCH_PATH = join(REPO_ROOT, 'packages/bundle/base/cordis.patch.yml')
  175. const WEB_PATCH_PATH = join(REPO_ROOT, 'packages/bundle/web-app/cordis.patch.yml')
  176. /** The installation anchor whose dependency surface the profile module fallback mirrors. */
  177. const INSTALL_ANCHOR = join(REPO_ROOT, 'apps/cli/package.json')
  178. // Replay publishes the provider catalog the gateway routes to (providers
  179. // mode, never catch-all: with llm-deepseek disabled no adapter exists, so a
  180. // catch-all would leave resolveModelInfo unroutable and compaction-basic's
  181. // post-step pressure check would warn every step). The published
  182. // contextWindow keeps that pressure path provably inert for small fixtures.
  183. const REPLAY_PROVIDERS = [{
  184. id: 'deepseek-official',
  185. name: 'DeepSeek',
  186. models: [{ id: 'deepseek-v4-flash', name: 'DeepSeek-V4-Flash', contextWindow: 128_000 }],
  187. }]
  188. /**
  189. * The routes a shipped composition always has, with no ability to stream.
  190. * A fixture-less keyless scenario issues no model calls, but its tree must
  191. * still answer `listProviders()` — surfaces legitimately gate on whether any
  192. * adapter serves a session's route, and an empty registry is a test artifact,
  193. * not a product state.
  194. */
  195. class RouteOnlyAdapter extends LlmAdapter {
  196. constructor(private readonly providers: typeof REPLAY_PROVIDERS) {
  197. super()
  198. }
  199. override providerInfo(provider: string): LlmProviderInfo {
  200. return { id: provider, name: this.providers.find(entry => entry.id === provider)?.name ?? provider }
  201. }
  202. override listModels(provider: string): Promise<readonly LlmModelInfo[]> {
  203. return Promise.resolve((this.providers.find(entry => entry.id === provider)?.models ?? [])
  204. .map(model => ({ provider, id: model.id, name: model.name })))
  205. }
  206. override resolveModel(provider: string, model: string): Promise<LlmResolvedModelInfo> {
  207. const listed = this.providers.find(entry => entry.id === provider)?.models
  208. .find(entry => entry.id === model)
  209. return Promise.resolve({
  210. provider,
  211. id: model,
  212. name: listed?.name ?? model,
  213. ...listed?.contextWindow === undefined ? {} : { contextWindow: listed.contextWindow },
  214. })
  215. }
  216. override async *stream(): AsyncIterable<StreamChunk> {
  217. throw new Error(
  218. 'web e2e scaffold: a model call was issued by a scenario that declared no replay fixture'
  219. + ' — pass replayFixture, or keep the scenario free of model calls',
  220. )
  221. }
  222. }
  223. function replayProviders(contextWindow: number | undefined): typeof REPLAY_PROVIDERS {
  224. if (contextWindow === undefined) return REPLAY_PROVIDERS
  225. return REPLAY_PROVIDERS.map(provider => ({
  226. ...provider,
  227. models: provider.models.map(model => ({ ...model, contextWindow })),
  228. }))
  229. }
  230. /** A booted web scaffold: real composition, mode-selected model backend, temp world. */
  231. export interface WebScaffold {
  232. /** The active snapshot mode this scaffold booted under. */
  233. mode: WebSnapshotMode
  234. /** Browser-facing origin for the bound test server. */
  235. baseUrl: string
  236. /** Process-token URL that establishes this scaffold's browser session. */
  237. authenticatedUrl: string
  238. /** Settled root context (the in-process readiness barrier; headless event subscription is its sanctioned use). */
  239. ctx: Context
  240. /** Temp project directory sessions run in (shell/fs tool cwd). */
  241. workspaceCwd: string
  242. /** Temp persistence root (seeded sessions land here through the real API). */
  243. persistenceRoot: string
  244. /** Isolated harness home the settings/credentials rows write ($DSH_HOME double). */
  245. harnessHome: string
  246. /** Send a browser-equivalent Host request with this scaffold's authenticated cookie. */
  247. hostFetch(path: string, init?: RequestInit): Promise<Response>
  248. /** Await a settled turn end: in-process turn/end, then the agent's idle flip (which follows the persistence flush). */
  249. whenTurnSettled(timeoutMs?: number): Promise<SessionId>
  250. /**
  251. * Tear everything down; asserts the replay fixture was fully consumed first
  252. * (replay/refresh), unless booted with replayProvidersOnly (whose fixture
  253. * is validated call-free at boot).
  254. */
  255. close(): Promise<void>
  256. }
  257. /** Options for {@link launchWebScaffold}. */
  258. export interface LaunchOptions {
  259. /** Compare the replayed root session with `replayFixture`; defaults on for a manifest-owned canonical recording. */
  260. compareReplaySession?: boolean
  261. /**
  262. * Optional product overlay applied after the shipped Web surface and before
  263. * the scaffold's hermetic test patches, matching the launcher's `--patch`
  264. * ordering.
  265. */
  266. extraOverlayPath?: string
  267. /**
  268. * Additional source-checkout package manifests whose dependency closures
  269. * supply private profile layers named by {@link extraOverlayPath}.
  270. */
  271. extraInstallAnchors?: string[]
  272. /**
  273. * Replay fixture (session.jsonl) served by the inserted dsh-llm-replay row
  274. * in replay/refresh modes; ignored in record mode (the real adapter
  275. * answers). Omit for scenarios issuing no model calls — a stray stream then
  276. * fails loud with NO_ADAPTER (llm-deepseek is disabled and no replay row
  277. * mounts). With {@link replayProvidersOnly}, the fixture must record no
  278. * model calls (its header alone mounts the catalog).
  279. */
  280. replayFixture?: string
  281. /**
  282. * Mount the replay provider catalog (the model directory the UI shows)
  283. * without consuming any recorded script: for scenarios that never call a
  284. * model but need the real provider/model labels rendered. Requires
  285. * {@link replayFixture} whose log records no model calls, and rejects
  286. * {@link replayOverride} and {@link replayChildFixtures}; the teardown
  287. * consumption check is skipped for this mode. `replayFixture` without this
  288. * flag keeps the consumption check.
  289. */
  290. replayProvidersOnly?: boolean
  291. /**
  292. * Recorded child logs assigned in child creation order. Each child owns its
  293. * own positional replay cursor across initial and continuation turns.
  294. */
  295. replayChildFixtures?: string[]
  296. /**
  297. * Optional replay.override.json sidecar (whole-script replacement or
  298. * `{ patches }` augmentation) for throw/hang scenarios not expressible as
  299. * recorded chunks; replay/refresh only.
  300. */
  301. replayOverride?: string
  302. /**
  303. * Retry policy registered on every replay provider route, for failure-
  304. * injection scenarios that must exhaust recovery quickly instead of walking
  305. * the shared normal default's five backed-off retries; replay/refresh only.
  306. */
  307. replayRetryPolicy?: RetryPolicyConfig
  308. /** Per-chunk replay pacing (ms) so the browser observes genuinely incremental SSE; replay/refresh only. */
  309. paceMs?: number
  310. /** Synthetic model capacity for UI scenarios whose seeded history must remain uncompacted. */
  311. replayContextWindow?: number
  312. /**
  313. * Tool presentation mode patched onto the shipped `tools` row (`code`
  314. * collapses the wire to run_code + the SDK prompt section). Omit for the
  315. * yml default. The code runtime row is always in the tree, so no extra
  316. * insertion is needed.
  317. */
  318. toolsMode?: 'native' | 'ptc' | 'both'
  319. /**
  320. * Insert the opt-in model-facing Cordis tool provider into the shipped tree.
  321. * Record and replay use the same tool surface, so captured request headers
  322. * remain reconstructable without making the tools a product default.
  323. */
  324. cordisTools?: boolean
  325. /**
  326. * Keep the shipped DeepSeek adapter mounted while masking the process
  327. * environment's DEEPSEEK_API_KEY for this scaffold lifetime. This is the
  328. * keyless first-run configuration lane; the default disables the adapter.
  329. */
  330. deepSeekMissingCredential?: boolean
  331. /** Leave the current welcome notice pending; ordinary scenarios pre-acknowledge it before browser boot. */
  332. welcomeNoticePending?: boolean
  333. /**
  334. * Patch the shipped DeepSeek search row to a deterministic endpoint and
  335. * credential reference. Browser search scenarios keep the real provider and
  336. * credentials seam while avoiding external search traffic and ambient keys.
  337. */
  338. deepSeekSearch?: {
  339. /** Anthropic-compatible base URL; the provider appends `/messages`. */
  340. baseURL: string
  341. /** Credential reference resolved by the shipped search provider. */
  342. apiKeyEnv: string
  343. }
  344. /**
  345. * Replace the roster row the scaffold pins by default (no configured roots,
  346. * default `standard` — the plugin's own shipped presets). Supply this only
  347. * to change WHICH presets a scenario sees beyond the shipped set — a
  348. * writable user root, a different default. The patch lands after the
  349. * default, so it wins.
  350. */
  351. agentPresets?: {
  352. /** Roots to discover after the plugin's shipped root, in precedence order. */
  353. roots: { path: string; trust: 'system' | 'user' }[]
  354. /** The preset a session that names none is composed from. */
  355. default: string
  356. }
  357. /**
  358. * Mount the shipped telemetry row against this exporter URL instead of
  359. * disabling it. Used to pin a real backend disclosure in assembled
  360. * coverage; point the URL at a local endpoint (a dead port, or a scenario's
  361. * own mock collector) so no record leaves the machine.
  362. */
  363. telemetryUrl?: string
  364. /** Uploading mode for the mounted telemetry row. Defaults to `FULL`. */
  365. telemetryMode?: 'FULL' | 'FEEDBACK_ONLY'
  366. /**
  367. * Browse through a trusted non-loopback hostname that the browser resolves
  368. * to loopback (for example `*.localhost`). The test server stays bound to
  369. * 127.0.0.1; a non-resolving authority fails before Host trust is exercised.
  370. */
  371. remoteAuthority?: string
  372. /** Reuse an existing harness home so a second Host can verify user settings across origins. */
  373. harnessHome?: string
  374. }
  375. /** Dispose the booted tree and remove both owned temp roots, reporting every independent cleanup failure. */
  376. async function cleanupScaffoldWorld(ctx: Context, workspaceCwd: string, persistenceRoot: string): Promise<unknown[]> {
  377. const failures: unknown[] = []
  378. await Promise.resolve(ctx.fiber.dispose()).catch((error: unknown) => failures.push(error))
  379. await rm(workspaceCwd, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
  380. await rm(persistenceRoot, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
  381. return failures
  382. }
  383. /**
  384. * Boot the real web composition under the current snapshot mode.
  385. * @param options - replay fixture selection and pacing.
  386. * @returns the running scaffold.
  387. */
  388. export async function launchWebScaffold(options: LaunchOptions = {}): Promise<WebScaffold> {
  389. requireDist()
  390. const mode = webSnapshotMode()
  391. const replayFixture = options.replayFixture === undefined
  392. ? undefined
  393. : await selectedSessionFixture(options.replayFixture, options.replayOverride !== undefined)
  394. const replayChildFixtures = options.replayChildFixtures === undefined
  395. ? undefined
  396. : await Promise.all(options.replayChildFixtures.map(path => selectedSessionFixture(path)))
  397. const compareReplaySession = options.compareReplaySession ?? await ownsReplayFixture(replayFixture)
  398. const browserHost = options.remoteAuthority ?? '127.0.0.1'
  399. if (mode === 'record') {
  400. // Both owning vitest configs (web unconditionally, snapshot in record
  401. // mode) load the repo-root .env before this file runs.
  402. if (process.env.DEEPSEEK_API_KEY === undefined || process.env.DEEPSEEK_API_KEY.length === 0) {
  403. throw new Error('web e2e record mode needs DEEPSEEK_API_KEY (env or repo-root .env)')
  404. }
  405. }
  406. if (mode === 'record' && options.deepSeekMissingCredential === true) {
  407. throw new Error('deepSeekMissingCredential is a keyless replay/refresh option')
  408. }
  409. const maskDeepSeekCredential = mode !== 'record' && options.deepSeekMissingCredential === true
  410. const originalDeepSeekCredential = process.env.DEEPSEEK_API_KEY
  411. let credentialEnvironmentRestored = false
  412. const restoreCredentialEnvironment = (): void => {
  413. if (credentialEnvironmentRestored || !maskDeepSeekCredential) return
  414. credentialEnvironmentRestored = true
  415. if (originalDeepSeekCredential === undefined) {
  416. Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
  417. } else {
  418. process.env.DEEPSEEK_API_KEY = originalDeepSeekCredential
  419. }
  420. }
  421. const workspaceCwd = await realpath(await mkdtemp(join(tmpdir(), 'dsh-web-e2e-ws-')))
  422. // Isolated harness home: the settings/credentials rows resolve $DSH_HOME
  423. // paths at load, and an in-process boot must NEVER touch the developer's
  424. // real ~/.dsh document or credential file.
  425. const harnessHome = options.harnessHome ?? join(workspaceCwd, '.dsh-home')
  426. // Skill discovery is model-visible input, and its roots now resolve inside a
  427. // PRESET — a subtree this lane's include patches cannot reach, because the
  428. // roster mounts it directly per session rather than as a row of the booted
  429. // tree. The row's documented fallback is the environment, so pin that: the
  430. // whole scaffold lifetime, not just the boot, since presets mount when a
  431. // session is created. Without this a developer's real ~/.dsh/skills silently
  432. // enters replay requests and goldens while CI sees none. `DSH_HOME` follows
  433. // the resolved harness home so a scaffold sharing another's home — the
  434. // cross-port persistence scenario — pins the same roots the settings and
  435. // credentials rows were configured with.
  436. const skillRootEnvironment = {
  437. DSH_HOME: harnessHome,
  438. DSH_AGENTS_HOME: join(workspaceCwd, '.agents-home'),
  439. DSH_BUNDLED_SKILL_DIR: join(workspaceCwd, '.bundled-skills'),
  440. }
  441. const originalSkillRootEnvironment = Object.fromEntries(
  442. Object.keys(skillRootEnvironment).map(key => [key, process.env[key]]),
  443. )
  444. let skillRootEnvironmentRestored = false
  445. const restoreSkillRootEnvironment = (): void => {
  446. if (skillRootEnvironmentRestored) return
  447. skillRootEnvironmentRestored = true
  448. for (const [key, value] of Object.entries(originalSkillRootEnvironment)) {
  449. if (value === undefined) Reflect.deleteProperty(process.env, key)
  450. else process.env[key] = value
  451. }
  452. }
  453. Object.assign(process.env, skillRootEnvironment)
  454. let persistenceRoot: string
  455. try {
  456. persistenceRoot = await mkdtemp(join(tmpdir(), 'dsh-web-e2e-sessions-'))
  457. } catch (error) {
  458. const failures: unknown[] = [error]
  459. await rm(workspaceCwd, { recursive: true, force: true }).catch((cleanupError: unknown) => failures.push(cleanupError))
  460. restoreSkillRootEnvironment()
  461. if (failures.length > 1) throw new AggregateError(failures, 'web scaffold temp-root setup failed')
  462. throw error
  463. }
  464. if (maskDeepSeekCredential) Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
  465. // The include patch set — the same layer stack the profile boot composes
  466. // (bundle patches in dsh.profile.bundles order), applied over the SAME empty root (a
  467. // patch id that stops matching a row fails the boot sweep loudly instead of
  468. // drifting).
  469. const basePatches = loadOverlayPatches('web e2e scaffold', BASE_PATCH_PATH)
  470. const surfacePatches = loadOverlayPatches('web e2e scaffold', WEB_PATCH_PATH)
  471. const extraOverlayPatches = options.extraOverlayPath === undefined
  472. ? []
  473. : loadOverlayPatches('web e2e scaffold', options.extraOverlayPath)
  474. const composedRows = composeEntries([basePatches, surfacePatches, extraOverlayPatches])
  475. const webRuntimeConfig = composedRows.find(row => row.id === 'web-runtime')?.config as {
  476. surfaceContext?: boolean
  477. } | undefined
  478. const surfaceContext = webRuntimeConfig?.surfaceContext !== false
  479. const patches: PatchOptions[] = [
  480. ...basePatches,
  481. ...surfacePatches,
  482. ...extraOverlayPatches,
  483. // The roster's shipped presets are the plugin's own, bundled inside
  484. // `dsh-agent-presets` and prepended by it. Pin only the machine-local
  485. // root away: a developer's own `~/.dsh/.agent-presets` must not be able
  486. // to change a golden.
  487. {
  488. id: 'agent-presets',
  489. config: {
  490. default: 'standard',
  491. includeUserRoot: false,
  492. },
  493. },
  494. { id: 'session-persistence-jsonl', config: { root: persistenceRoot } },
  495. // Content search is enabled here although the shipped bundles default it
  496. // off (`openAt: never`, pinned by apps/cli/tests/lazy-search-startup):
  497. // the seeded-session scenarios navigate by content search, and these e2e
  498. // runs are the assembled coverage for the opt-in search path.
  499. { id: 'session-query-sqlite', config: { path: ':memory:', openAt: 'first-search' } },
  500. // storage-json's yml root is anchored to the real $DSH_HOME; pin the row
  501. // to an absolute temp root (removed with the workspace at close) so tests
  502. // never write the user's harness home.
  503. { id: 'storage-json', config: { root: join(workspaceCwd, '.dsh-storages') } },
  504. // Skill discovery is model-visible input. Pin every host-level root inside
  505. // the owned temp world so ~/.dsh, ~/.agents, and a bundled-root env setting
  506. // cannot change replay requests or conversation goldens. Project roots stay
  507. // enabled against the same empty temp workspace, preserving the real seam.
  508. {
  509. id: 'skill-filesystem',
  510. config: {
  511. dshHome: join(workspaceCwd, '.dsh-home'),
  512. agentsHome: join(workspaceCwd, '.agents-home'),
  513. bundledSkillDir: join(workspaceCwd, '.bundled-skills'),
  514. watch: false,
  515. },
  516. },
  517. // fs/bash cwd default to process.cwd(); the gateway injects the same
  518. // value into session.cwd — chdir below anchors all three to the temp
  519. // workspace, keeping the composition untouched.
  520. { id: 'agent-instructions', disabled: true },
  521. { id: 'session-title-llm', disabled: true },
  522. // Fixture sessions must never leave the process: the shipped row defaults
  523. // to the production OTLP endpoint (or whatever DSH_TELEMETRY_OTLP_URL
  524. // names in the ambient environment). A scenario that pins a real backend
  525. // disclosure passes a local dead endpoint instead of disabling the row.
  526. options.telemetryUrl === undefined
  527. ? { id: 'session-telemetry-otel', disabled: true }
  528. : {
  529. id: 'session-telemetry-otel',
  530. config: {
  531. mode: options.telemetryMode ?? 'FULL',
  532. exporter: { url: options.telemetryUrl },
  533. shutdownTimeoutMillis: 1_000,
  534. },
  535. },
  536. // Use an ephemeral port while preserving the shipped compression policy;
  537. // a patch replaces the row's complete config.
  538. {
  539. id: 'webserver',
  540. config: {
  541. host: '127.0.0.1', port: 0, compression: 'gzip',
  542. compressionLevel: 1, compressionThresholdBytes: 1024,
  543. },
  544. },
  545. // The bundle's web-runtime row resolves the same built dist under test
  546. // (apps/web IS @deepseek-ai/dsh-web-frontend); native browser opening and the
  547. // URL line are disabled because this scaffold owns its Playwright browser.
  548. // Preserve the composed surface-context choice because a patch replaces
  549. // the row's complete config.
  550. { id: 'web-runtime', config: { openBrowser: false, printUrl: false, surfaceContext } },
  551. ...options.remoteAuthority === undefined
  552. ? []
  553. : [{ id: 'connection', config: { trustedHosts: [options.remoteAuthority] } }],
  554. { id: 'settings', config: { dshHome: harnessHome } },
  555. { id: 'credentials', config: { dshHome: harnessHome } },
  556. // The shipped directory-picker row is the -auto chooser, which resolves
  557. // the interaction from the RUNNING host (display, SSH launch, bind). The
  558. // lane's goldens are interaction-specific (workspace-management drives
  559. // the in-app browse dialog), so pin -browse deterministically on every
  560. // host: patch `name` is an assertion, not an override, hence the
  561. // disable+insert pair.
  562. { id: 'directory-picker', disabled: true },
  563. { insert: [
  564. { id: 'directory-picker-browse', name: '@deepseek-ai/dsh-host-directory-picker-browse' },
  565. { id: 'ui-directory-picker-browse', name: '@deepseek-ai/dsh-client-ui-directory-picker-browse' },
  566. ] },
  567. ...options.agentPresets === undefined
  568. ? []
  569. // Never the derived harness-home root: a developer's own presets must not
  570. // be able to change a golden, whatever roots a scenario asks for.
  571. : [{ id: 'agent-presets', config: { ...options.agentPresets, includeUserRoot: false } }],
  572. ...options.toolsMode === undefined ? [] : [{ id: 'tools', config: { mode: options.toolsMode } }],
  573. // The shipped Web bundle already owns both runners and the Cordis UI. This
  574. // scenario adds only the model-facing tools that exercise those services.
  575. ...options.cordisTools === true
  576. ? [{ insert: [
  577. { id: 'tool-cordis', name: '@deepseek-ai/dsh-tool-cordis' },
  578. ] }]
  579. : [],
  580. ...options.deepSeekSearch === undefined
  581. ? []
  582. : [{
  583. id: 'web-search-deepseek',
  584. config: {
  585. apiKeyEnv: options.deepSeekSearch.apiKeyEnv,
  586. baseURL: options.deepSeekSearch.baseURL,
  587. },
  588. }],
  589. ...mode === 'record' || options.deepSeekMissingCredential === true
  590. ? []
  591. : [{ id: 'llm-deepseek', disabled: true }],
  592. ]
  593. // Sessions inherit the gateway's process.cwd() default; run the boot from
  594. // the temp workspace so tool cwd, session cwd, and fixtures agree.
  595. const originalCwd = process.cwd()
  596. const ctx = new Context()
  597. const observedSessions = new Map<SessionId, Session>()
  598. const stopObservingSessions = ctx.on('session/created', (session) => {
  599. observedSessions.set(session.id, session)
  600. })
  601. let port = 0
  602. let baseUrl = ''
  603. let authenticatedUrl = ''
  604. let cookieHeader = ''
  605. let replayHandle: ReplayHandle | undefined
  606. try {
  607. process.chdir(workspaceCwd)
  608. const profileDir = join(harnessHome, 'profiles', 'scaffold')
  609. const extraLayers: Profile['layers'] = await Promise.all((options.extraInstallAnchors ?? []).map(async (anchor) => {
  610. const manifest = JSON.parse(await readFile(anchor, 'utf8')) as { name?: unknown }
  611. if (typeof manifest.name !== 'string' || manifest.name === '') {
  612. throw new Error(`web scaffold extra install anchor has no package name: ${anchor}`)
  613. }
  614. const packageDir = dirname(anchor)
  615. return {
  616. packageName: manifest.name,
  617. version: undefined,
  618. packageDir,
  619. patchPath: join(packageDir, 'cordis.patch.yml'),
  620. trust: 'builtin' as const,
  621. stage: 'runtime' as const,
  622. patches: [],
  623. }
  624. }))
  625. // Mirror the production launcher: the shared installation closure keeps
  626. // its carrier-specific fallback, while private bundle dependencies stay
  627. // isolated to this synthetic scaffold profile.
  628. await healProfilesModuleFallback({
  629. installAnchor: INSTALL_ANCHOR,
  630. home: harnessHome,
  631. profile: {
  632. name: 'scaffold',
  633. dir: profileDir,
  634. layers: extraLayers,
  635. patchPath: join(profileDir, 'cordis.patch.yml'),
  636. patches: [],
  637. patchReload: 'startup',
  638. },
  639. })
  640. await mkdir(profileDir, { recursive: true })
  641. const rootConfig = join(profileDir, 'cordis.yml')
  642. await writeFile(rootConfig, '[]\n')
  643. ctx.baseUrl = pathToFileURL(profileDir).href + '/'
  644. // This direct Loader harness supplies the same root-path capability as app-boot.
  645. ctx.provide('dshHomePath', dshHomePath)
  646. // A host with no command line still provides one: the web bundle's startup
  647. // row releases the rows waiting on it, and with no arguments each starts on
  648. // the values this scaffold composed above. An exit request can only come
  649. // from a rejected argument, which a fixed empty list has none of.
  650. provideCmdline(ctx, {
  651. args: [],
  652. exit: (code) => {
  653. throw new Error(`web e2e scaffold: the web app requested exit ${String(code)} with no arguments to reject`)
  654. },
  655. })
  656. await ctx.plugin(Loader)
  657. ctx.loader.builtins.include = Include
  658. // `cordis:group` beside it, exactly as `boot()` registers it: a group row is
  659. // how a preset gives one `isolate` realm to a provider and its consumers,
  660. // and a preset resolving package names from its own directory cannot reach
  661. // `@deepseek-ai/cordis-plugin-group` by name.
  662. ctx.loader.builtins.group = Group
  663. await ctx.loader.create({
  664. name: 'cordis:include',
  665. config: { path: pathToFileURL(rootConfig).href, patches },
  666. })
  667. await ctx.loader.await()
  668. assertEntriesLoaded(ctx, 'web e2e scaffold')
  669. if (options.welcomeNoticePending !== true) {
  670. await ctx.settings.mutate(WELCOME_NOTICE_SETTINGS_NAMESPACE, [{
  671. op: 'set', path: [WELCOME_NOTICE_ACK_FIELD], value: WELCOME_NOTICE_VERSION,
  672. }])
  673. }
  674. const boundPort = ctx.get('webServer')?.port
  675. if (boundPort === undefined) {
  676. throw new Error('web e2e scaffold: webServer service missing after settled boot')
  677. }
  678. port = boundPort
  679. // Fill the open llm seam on the settled root ctx. Ordinary keyless modes
  680. // disable llm-deepseek; the first-run lane keeps it mounted but has no
  681. // replay fixture and never streams. The direct install, unlike the plugin
  682. // row, returns the ReplayHandle for the teardown consumption check.
  683. if (options.replayProvidersOnly) {
  684. if (replayFixture === undefined) {
  685. throw new Error('replayProvidersOnly requires replayFixture (its file supplies the header)')
  686. }
  687. const fixtureText = readFileSync(replayFixture, 'utf8')
  688. // The consumption check is skipped for this mode, so no script source
  689. // may carry callable entries: reject override/child sources outright
  690. // and any call-bearing fixture.
  691. if (options.replayOverride !== undefined || replayChildFixtures !== undefined) {
  692. throw new Error('replayProvidersOnly cannot combine with replayOverride or replayChildFixtures')
  693. }
  694. // A fixture without a session header row must not mount the catalog
  695. // silently: the consumption-skip assumes the header-only shape.
  696. let headerType: unknown
  697. try {
  698. headerType = (JSON.parse(fixtureText.trimStart().split('\n', 1)[0] ?? '') as { type?: unknown }).type
  699. } catch {
  700. headerType = undefined
  701. }
  702. if (headerType !== 'session') {
  703. throw new Error('replayProvidersOnly fixture must open with a session header row')
  704. }
  705. const recorded = parseSessionLog(fixtureText)
  706. const hasModelCall = recorded.some(event => (
  707. event.type === 'assistant/message' || event.type === 'assistant/attempt'
  708. || event.type === 'request/header' || event.type === 'tool/call'
  709. ))
  710. if (hasModelCall) {
  711. throw new Error('replayProvidersOnly fixture must record no model calls')
  712. }
  713. }
  714. if (mode !== 'record' && replayFixture !== undefined) {
  715. replayHandle = installLlmReplay(ctx, {
  716. file: replayFixture,
  717. providers: replayProviders(options.replayContextWindow).map(provider => ({
  718. ...provider,
  719. ...(options.replayRetryPolicy === undefined ? {} : { retryPolicy: options.replayRetryPolicy }),
  720. })),
  721. ...(options.replayOverride === undefined ? {} : { overrideFile: options.replayOverride }),
  722. ...(replayChildFixtures === undefined ? {} : { childFiles: replayChildFixtures }),
  723. ...(options.paceMs === undefined ? {} : { paceMs: options.paceMs }),
  724. })
  725. } else if (mode !== 'record' && options.deepSeekMissingCredential !== true) {
  726. // No fixture and no shipped adapter would leave the tree with ZERO
  727. // provider routes — a state no product composition has, and one the
  728. // composer refuses to type into. Register the same routes
  729. // a fixture would, with streaming that still fails loud: the scenario
  730. // issues no model calls, and one that slipped in must not pass quietly.
  731. ctx.effect(() => ctx.llm.registerAdapter(
  732. replayProviders(options.replayContextWindow).map(provider => provider.id),
  733. new RouteOnlyAdapter(replayProviders(options.replayContextWindow)),
  734. ), 'web e2e scaffold: route-only adapter')
  735. }
  736. baseUrl = `http://${browserHost}:${String(port)}`
  737. authenticatedUrl = ctx.connection.authenticatedUrl(baseUrl)
  738. const login = await fetch(authenticatedUrl, { redirect: 'manual' })
  739. const setCookie = login.headers.get('set-cookie')
  740. if (login.status !== 303 || login.headers.get('location') !== '/' || setCookie === null) {
  741. throw new Error('web e2e scaffold: browser token exchange did not return its session cookie')
  742. }
  743. cookieHeader = setCookie.split(';', 1)[0] ?? ''
  744. if (cookieHeader.length === 0) {
  745. throw new Error('web e2e scaffold: browser token exchange returned an empty session cookie')
  746. }
  747. } catch (error) {
  748. if (process.cwd() !== originalCwd) process.chdir(originalCwd)
  749. const cleanupFailures = await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot)
  750. restoreCredentialEnvironment()
  751. restoreSkillRootEnvironment()
  752. if (cleanupFailures.length > 0) {
  753. throw new AggregateError([error, ...cleanupFailures], 'web scaffold setup failed and cleanup was incomplete')
  754. }
  755. throw error
  756. } finally {
  757. if (process.cwd() !== originalCwd) process.chdir(originalCwd)
  758. }
  759. return {
  760. harnessHome,
  761. mode,
  762. baseUrl,
  763. authenticatedUrl,
  764. ctx,
  765. workspaceCwd,
  766. persistenceRoot,
  767. hostFetch(path: string, init: RequestInit = {}): Promise<Response> {
  768. const headers = new Headers(init.headers)
  769. headers.set('cookie', cookieHeader)
  770. return fetch(new URL(path, baseUrl), { ...init, headers })
  771. },
  772. // Barrier stack: the in-process turn/end identifies the session, its
  773. // explicit flush makes the transcript durable, and the caller's browser
  774. // settled-poll comes last because host completion strictly precedes render.
  775. whenTurnSettled(timeoutMs = mode === 'record' ? 180_000 : 30_000): Promise<SessionId> {
  776. return new Promise<SessionId>((resolveSettled, reject) => {
  777. const timer = setTimeout(() => {
  778. off()
  779. reject(new Error(`no turn/end within ${timeoutMs}ms`))
  780. }, timeoutMs)
  781. const off = ctx.on('session/event', (session: Session, event: SessionEvent) => {
  782. if (event.type !== 'turn/end') return
  783. clearTimeout(timer)
  784. off()
  785. ctx.sessions.flush(session)
  786. .then(() => { resolveSettled(session.id) }, reject)
  787. })
  788. })
  789. },
  790. async close(): Promise<void> {
  791. const failures: unknown[] = []
  792. if (mode !== 'record'
  793. && replayFixture !== undefined
  794. && options.replayProvidersOnly !== true
  795. && compareReplaySession) {
  796. try {
  797. await assertReplaySession(
  798. [...observedSessions.values()],
  799. replayFixture,
  800. mode,
  801. `http://${browserHost}:${port}`,
  802. )
  803. } catch (error) {
  804. failures.push(error)
  805. }
  806. }
  807. // Fixture-consumption check first, while the run's binding state is
  808. // still authoritative — a scenario that drove fewer model calls than
  809. // recorded fails here instead of drifting green. Skipped for
  810. // replayProvidersOnly, whose fixture is validated call-free at boot.
  811. if (!options.replayProvidersOnly) {
  812. try {
  813. replayHandle?.assertConsumed()
  814. } catch (error) {
  815. failures.push(error)
  816. }
  817. }
  818. try {
  819. stopObservingSessions()
  820. failures.push(...await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot))
  821. } finally {
  822. restoreCredentialEnvironment()
  823. restoreSkillRootEnvironment()
  824. }
  825. if (failures.length > 0) throw new AggregateError(failures, 'web scaffold teardown failed')
  826. },
  827. }
  828. }
  829. /**
  830. * Serialize a live session to the canonical raw session-JSONL layout — the
  831. * in-memory record-mode harvest, so the on-disk zstd default never matters.
  832. */
  833. function rawSessionLog(session: Session): string {
  834. const encoded = sessionFormatCatalog.encodeCurrent({
  835. header: {
  836. ...session.header,
  837. delegationDepth: session.header.delegationDepth ?? 0,
  838. },
  839. inheritedEventCount: session.inheritedEventCount,
  840. // Session validates durable payloads as JSON; its closed event unions do
  841. // not carry the index signature used by the format package's JSON types.
  842. events: session.snapshotEvents() as unknown as readonly SessionFormatEvent[],
  843. })
  844. return [
  845. JSON.stringify(encoded.header),
  846. ...encoded.rows.map(record => JSON.stringify(record)),
  847. '',
  848. ].join('\n')
  849. }
  850. function mapJsonStringValues(value: unknown, map: (value: string) => string): unknown {
  851. if (typeof value === 'string') return map(value)
  852. if (Array.isArray(value)) return value.map(item => mapJsonStringValues(item, map))
  853. if (value !== null && typeof value === 'object') {
  854. return Object.fromEntries(Object.entries(value).map(([key, item]) => [
  855. key,
  856. mapJsonStringValues(item, map),
  857. ]))
  858. }
  859. return value
  860. }
  861. const WEB_PATH_TEXT_BOUNDARY_RE = /[\s<>'"`()\[\]{},;:!?=]/
  862. const WEB_FILE_URI_PATH_PREFIX_RE = /(?:^|[^a-z0-9+.-])file:\/\/\/?$/i
  863. function isWebCwdMatch(value: string, start: number, length: number): boolean {
  864. const before = value[start - 1]
  865. const after = value[start + length]
  866. const afterPunctuation = value[start + length + 1]
  867. const startsAtBoundary = before === undefined
  868. || WEB_PATH_TEXT_BOUNDARY_RE.test(before)
  869. || WEB_FILE_URI_PATH_PREFIX_RE.test(value.slice(0, start))
  870. const endsAtBoundary = after === undefined
  871. || after === '/'
  872. || after === '\\'
  873. || WEB_PATH_TEXT_BOUNDARY_RE.test(after)
  874. || after === '.' && (afterPunctuation === undefined || WEB_PATH_TEXT_BOUNDARY_RE.test(afterPunctuation))
  875. return startsAtBoundary && endsAtBoundary
  876. }
  877. function replaceWebCwd(value: string, cwd: string): string {
  878. let cursor = 0
  879. let normalized = ''
  880. while (cursor < value.length) {
  881. const match = value.indexOf(cwd, cursor)
  882. if (match < 0) return normalized + value.slice(cursor)
  883. const end = match + cwd.length
  884. if (isWebCwdMatch(value, match, cwd.length)) {
  885. normalized += value.slice(cursor, match) + '{{cwd}}'
  886. cursor = end
  887. } else {
  888. normalized += value.slice(cursor, end)
  889. cursor = end
  890. }
  891. }
  892. return normalized
  893. }
  894. /**
  895. * Normalize Web-only volatile strings while preserving JSON structure and row framing.
  896. * @param log - raw Session JSONL.
  897. * @param workspaceCwd - optional scaffold parent used before a live Session selects its cwd.
  898. * @returns compact JSONL with run-local strings tokenized.
  899. */
  900. export function normalizeWebSessionVolatiles(log: string, workspaceCwd?: string): string {
  901. const headerLine = log.split(/\r?\n/).find(line => line.trim().length > 0)
  902. const header = headerLine === undefined ? undefined : JSON.parse(headerLine) as { cwd?: unknown }
  903. const sessionCwd = typeof header?.cwd === 'string' && header.cwd.length > 0 ? header.cwd : undefined
  904. const cwdSpellings = [...new Set([sessionCwd ?? workspaceCwd]
  905. .filter((value): value is string => typeof value === 'string' && value.length > 0)
  906. .flatMap((value) => {
  907. const forward = value.replaceAll('\\', '/')
  908. const native = /^[A-Za-z]:[\\/]/.test(value) ? forward.replaceAll('/', '\\') : value
  909. return [value, value.replaceAll('\\', '\\\\'), forward, native]
  910. }))].sort((left, right) => right.length - left.length)
  911. return log.split(/\r?\n/).map((line) => {
  912. if (line.trim() === '') return line
  913. const record = mapJsonStringValues(JSON.parse(line), (value) => {
  914. let normalized = value
  915. .replace(/Anonymous user: [^.]+(?=\. Session sharing)/g, 'Anonymous user: {{anonymousUserId}}')
  916. for (const cwd of cwdSpellings) normalized = replaceWebCwd(normalized, cwd)
  917. return normalized
  918. }) as { type?: unknown; data?: { endpoint?: unknown } }
  919. if (record.type === 'web/deepseek-search-llm-request' && typeof record.data?.endpoint === 'string') {
  920. record.data.endpoint = '{{webSearchEndpoint}}'
  921. }
  922. return JSON.stringify(record)
  923. }).join('\n')
  924. }
  925. function stableSessionFixture(
  926. session: Session,
  927. existing: string,
  928. workspaceCwd: string,
  929. ): string {
  930. const prepared = prepareSessionSnapshotFixtureForComparison(
  931. normalizeWebSessionVolatiles(rawSessionLog(session), workspaceCwd),
  932. )
  933. const stabilized = existing === ''
  934. ? prepared
  935. : stabilizeRefreshLog(prepared, existing, [], {
  936. sessionIds: [String(session.id)],
  937. cwd: workspaceCwd,
  938. })
  939. const fresh = scrubSessionSnapshot(stabilized)
  940. .split(session.id).join('{{sessionId}}')
  941. const stable = redactSessionSnapshotIds(stabilizeFixtureMessageIds([fresh], [existing]))[0]
  942. if (stable === undefined) throw new Error('session harvest produced no stabilized fixture')
  943. return stable
  944. }
  945. async function assertReplaySession(
  946. sessions: readonly Session[],
  947. fixturePath: string,
  948. mode: WebSnapshotMode,
  949. webUrl: string,
  950. ): Promise<void> {
  951. let expected = await readFile(fixturePath, 'utf8')
  952. const fixtureDir = dirname(fixturePath)
  953. const manifestPath = join(fixtureDir, 'snapshot.yml')
  954. const manifest = parseSnapshotManifest(await readFile(manifestPath, 'utf8'), manifestPath)
  955. let expectedPath = fixturePath
  956. const userPrompts = fixtureUserPrompts(expected)
  957. const candidates = sessions.filter((session) => {
  958. if (session.header.parentSession !== undefined) return false
  959. const actual = session.snapshotEvents().flatMap((event) => {
  960. if (event.type !== 'user/message' || event.data.source.kind !== 'user') return []
  961. const text = event.data.content.filter(block => block.type === 'text').map(block => block.text).join('')
  962. return text.length === 0 ? [] : [text]
  963. })
  964. return JSON.stringify(actual) === JSON.stringify(userPrompts)
  965. })
  966. expect(candidates, `Web replay fixture ${fixturePath} must match one live root session`).toHaveLength(1)
  967. const session = candidates[0] as Session
  968. const sessionCwd = session.header.cwd
  969. if (sessionCwd === undefined) throw new Error(`${fixturePath}: replayed session has no cwd`)
  970. const actual = rawSessionLog(session)
  971. if (mode === 'refresh' && writesCurrentSessionFixtures(manifest, mode)) {
  972. expected = stableSessionFixture(session, expected, sessionCwd)
  973. expectedPath = recordedSessionFixturePath(fixturePath, session.header.version)
  974. await writeFile(expectedPath, expected)
  975. }
  976. const expectedHeader = JSON.parse(expected.split('\n').find(line => line.trim() !== '') ?? '{}') as {
  977. id?: unknown
  978. cwd?: unknown
  979. }
  980. const actualContext: NormalizeContext = { sessionIds: [String(session.id)], cwd: sessionCwd }
  981. const expectedContext: NormalizeContext = {
  982. sessionIds: typeof expectedHeader.id === 'string' ? [expectedHeader.id] : [],
  983. cwd: typeof expectedHeader.cwd === 'string' ? expectedHeader.cwd : '\0no-cwd\0',
  984. }
  985. expect(normalizeSessionSnapshots([normalizeWebSessionVolatiles(actual)], actualContext)[0], `${fixturePath}: persisted replay`)
  986. .toBe(normalizeSessionSnapshots([normalizeWebSessionVolatiles(expected)], expectedContext)[0])
  987. if (manifest.header?.pin !== true) return
  988. const normalizePrompt = (value: string): string => value
  989. .split(REPO_ROOT).join('{{sourceRoot}}')
  990. .split(webUrl).join('{{webUrl}}')
  991. const prompts = normalizedSystemPrompts(actual, actualContext).map(normalizePrompt)
  992. const schemas = normalizedToolSchemas(actual, actualContext)
  993. const promptPath = join(fixtureDir, 'system-prompt.expected.md')
  994. const schemaPath = join(fixtureDir, 'tool-schemas.expected.json')
  995. const promptSnapshot = formatSystemPromptSnapshot(prompts[0] as string, prompts.slice(1))
  996. const schemaSnapshot = formatToolSchemasSnapshot(schemas[0] as unknown[], schemas.slice(1))
  997. if (mode === 'refresh') {
  998. await Promise.all([writeFile(promptPath, promptSnapshot), writeFile(schemaPath, schemaSnapshot)])
  999. }
  1000. expect(promptSnapshot, `${fixturePath}: system-prompt pin`).toBe(await readFile(promptPath, 'utf8'))
  1001. expect(schemaSnapshot, `${fixturePath}: tool-schema pin`).toBe(await readFile(schemaPath, 'utf8'))
  1002. }
  1003. /**
  1004. * Record-mode fixture write-back: harvest the live session, scrub request
  1005. * headers to {{system}}/{{tools}}, tokenize the run-local cwd, redact opaque
  1006. * identities with typed relationship-preserving tokens, and write the fixture.
  1007. * A manifest-retained historical generation makes the write-back a no-op.
  1008. * @param scaffold - the record-mode scaffold.
  1009. * @param sessionId - the driven session.
  1010. * @param fixturePath - the committed session.jsonl target.
  1011. */
  1012. export async function recordFixture(scaffold: WebScaffold, sessionId: SessionId, fixturePath: string): Promise<void> {
  1013. const agent = scaffold.ctx.agents.get(sessionId)
  1014. if (agent === undefined) throw new Error(`record harvest: no live agent for ${sessionId}`)
  1015. const manifestPath = join(dirname(fixturePath), 'snapshot.yml')
  1016. const manifest = parseSnapshotManifest(await readFile(manifestPath, 'utf8'), manifestPath)
  1017. if (!writesCurrentSessionFixtures(manifest, 'record')) return
  1018. const target = recordedSessionFixturePath(fixturePath, agent.session.header.version)
  1019. const existingPath = existsSync(target) ? target : fixturePath
  1020. const existing = existsSync(existingPath) ? await readFile(existingPath, 'utf8') : ''
  1021. await writeFile(target, stableSessionFixture(agent.session, existing, scaffold.workspaceCwd))
  1022. }
  1023. /**
  1024. * The user prompts recorded in a fixture, in order — the single source tying
  1025. * spec drive steps to recorded reality so script and fixture cannot drift.
  1026. * @param fixtureText - raw session.jsonl contents.
  1027. * @returns the recorded user prompt texts.
  1028. */
  1029. export function fixtureUserPrompts(fixtureText: string): string[] {
  1030. return parseSessionLog(fixtureText).flatMap((event) => {
  1031. if (event.type !== 'user/message' || event.data.source.kind !== 'user') return []
  1032. const text = event.data.content.filter(block => block.type === 'text').map(block => block.text).join('')
  1033. return text.length > 0 ? [text] : []
  1034. })
  1035. }
  1036. /** Deterministic UUID used when a seed fixture's typed identity token is materialized. */
  1037. export function fixtureIdentity(
  1038. kind: 'message' | 'approval' | 'workflow' | 'command' | 'rpc' | 'retry' | 'id',
  1039. ordinal: number,
  1040. ): string {
  1041. const hex = createHash('sha256').update(`${kind}:${ordinal}`).digest('hex').slice(0, 32).split('')
  1042. hex[12] = '4'
  1043. hex[16] = ['8', '9', 'a', 'b'][Number.parseInt(hex[16] as string, 16) % 4] as string
  1044. return `${hex.slice(0, 8).join('')}-${hex.slice(8, 12).join('')}-${hex.slice(12, 16).join('')}-${hex.slice(16, 20).join('')}-${hex.slice(20).join('')}`
  1045. }
  1046. /**
  1047. * Realize a recorded seed fixture against one scaffold: substitute the
  1048. * `{{sessionId}}`/`{{cwd}}` placeholders and rewrite the recorded cwd to the
  1049. * scaffold's workspace. Idempotent, so a caller may realize early (e.g. to
  1050. * price content exactly as the host will fold it) and still pass the result
  1051. * through {@link seedSession}.
  1052. * @param scaffold - the booted scaffold whose workspace the seed targets.
  1053. * @param fixtureText - the committed seed fixture text.
  1054. * @param id - the session id the seed is realized for.
  1055. * @returns the realized fixture text.
  1056. */
  1057. export function realizeSeedFixture(scaffold: WebScaffold, fixtureText: string, id: string): string {
  1058. const firstLine = fixtureText.split(/\r?\n/).find(line => line.trim().length > 0)
  1059. const fixtureCwd = firstLine === undefined
  1060. ? undefined
  1061. : (JSON.parse(firstLine) as { cwd?: unknown }).cwd
  1062. return fixtureText.split(/\r?\n/).map((line) => {
  1063. if (line.trim() === '') return line
  1064. const realized = mapJsonStringValues(JSON.parse(line), (value) => {
  1065. let result = typeof fixtureCwd === 'string'
  1066. ? value.split(fixtureCwd).join(scaffold.workspaceCwd)
  1067. : value
  1068. result = result
  1069. .split('{{sessionId}}').join(id)
  1070. .split('{{session:1}}').join(id)
  1071. .replace(/\{\{session:([2-9]\d*)\}\}/g, (_token, ordinal: string) => `${id}-child-${ordinal}`)
  1072. .replace(/\{\{(message|approval|workflow|command|rpc|retry|id):([1-9]\d*)\}\}/g, (_token, kind: string, ordinal: string) =>
  1073. fixtureIdentity(kind as 'message' | 'approval' | 'workflow' | 'command' | 'rpc' | 'retry' | 'id', Number(ordinal)))
  1074. .split('{{cwd}}').join(scaffold.workspaceCwd)
  1075. return result
  1076. })
  1077. return JSON.stringify(realized)
  1078. }).join('\n')
  1079. }
  1080. /**
  1081. * Parse a committed web seed fixture through the replay reader.
  1082. * @param fixtureText - session JSONL fixture contents.
  1083. * @returns the current header line, parsed header, and logical events.
  1084. */
  1085. /** Give a migrated fixture stream positive relative timing before its final wall-clock rebase. */
  1086. function spreadMigratedSeedStream(
  1087. stream: SessionEvent<'assistant/message'>['data']['stream'],
  1088. ): SessionEvent<'assistant/message'>['data']['stream'] {
  1089. let nextTime = 0
  1090. return stream.map((record) => {
  1091. if ('time' in record) {
  1092. const timed = { ...record, time: nextTime }
  1093. nextTime += 1
  1094. return timed
  1095. }
  1096. const timed = { ...record, time0: nextTime }
  1097. nextTime += record.dt.reduce((total, delta) => total + delta, 0) + 1
  1098. return timed
  1099. })
  1100. }
  1101. export function parseSeedFixture(fixtureText: string): {
  1102. headerLine: string
  1103. header: Record<string, unknown>
  1104. events: SessionEvent[]
  1105. } {
  1106. const sourceHeaderLine = fixtureText.split(/\r?\n/).find(line => line.trim().length > 0)
  1107. if (sourceHeaderLine === undefined) throw new Error('seed fixture has no session header')
  1108. const sourceHeader = JSON.parse(sourceHeaderLine) as { version?: unknown }
  1109. const current = prepareSessionSnapshotFixtureForComparison(fixtureText)
  1110. const headerLine = current.split(/\r?\n/).find(line => line.trim().length > 0)
  1111. if (headerLine === undefined) throw new Error('seed fixture has no session header')
  1112. const header = JSON.parse(headerLine) as Record<string, unknown>
  1113. if (header.type !== 'session') throw new Error('seed fixture must start with a session header')
  1114. const events = parseSessionLog(current).map((event) => {
  1115. if (sourceHeader.version === SESSION_FORMAT_VERSION) return event
  1116. if (event.type === 'assistant/message') {
  1117. return { ...event, data: { ...event.data, stream: spreadMigratedSeedStream(event.data.stream) } }
  1118. }
  1119. if (event.type === 'assistant/attempt') {
  1120. return { ...event, data: { ...event.data, stream: spreadMigratedSeedStream(event.data.stream) } }
  1121. }
  1122. return event
  1123. })
  1124. return { headerLine, header, events }
  1125. }
  1126. /**
  1127. * Render logical events as an envelope-free web seed fixture.
  1128. * @param headerLine - original session header line.
  1129. * @param events - logical session events in order.
  1130. * @returns projected session JSONL.
  1131. */
  1132. export function renderSeedFixture(
  1133. headerLine: string,
  1134. events: readonly ({ readonly seq: number; readonly time: number } & object)[],
  1135. ): string {
  1136. return [
  1137. headerLine,
  1138. ...events.map(({ seq: _seq, time: _time, ...event }) => JSON.stringify(event)),
  1139. '',
  1140. ].join('\n')
  1141. }
  1142. /** Re-anchor one projected embedded stream while preserving every intra-stream gap. */
  1143. function rebaseSeedStream(
  1144. stream: SessionEvent<'assistant/message'>['data']['stream'],
  1145. startAt: number,
  1146. ): SessionEvent<'assistant/message'>['data']['stream'] {
  1147. const first = stream[0]
  1148. if (first === undefined) return stream
  1149. const sourceStart = 'time' in first ? first.time : first.time0
  1150. const delta = startAt - sourceStart
  1151. return stream.map(record => 'time' in record
  1152. ? { ...record, time: record.time + delta }
  1153. : { ...record, time0: record.time0 + delta })
  1154. }
  1155. /** Last logical timestamp carried by an embedded Assistant stream. */
  1156. function seedStreamEnd(
  1157. stream: SessionEvent<'assistant/message'>['data']['stream'],
  1158. ): number | undefined {
  1159. let end: number | undefined
  1160. for (const record of stream) {
  1161. const recordEnd = 'time' in record
  1162. ? record.time
  1163. : record.time0 + record.dt.reduce((total, delta) => total + delta, 0)
  1164. end = end === undefined ? recordEnd : Math.max(end, recordEnd)
  1165. }
  1166. return end
  1167. }
  1168. /**
  1169. * Seed a recorded session fixture into the scaffold's persistence root
  1170. * through the real Session and JSONL APIs.
  1171. * @param scaffold - the target scaffold.
  1172. * @param fixtureText - raw recorded session.jsonl contents.
  1173. * @param id - the seeded session id.
  1174. * @param agentPreset - preset recorded by scenarios that assert resumed composition.
  1175. * @param options - deterministic metadata overrides for ordering-sensitive scenarios.
  1176. * @returns the seeded id.
  1177. */
  1178. export async function seedSession(
  1179. scaffold: WebScaffold,
  1180. fixtureText: string,
  1181. id: string,
  1182. agentPreset?: string,
  1183. options: { readonly createdAt?: number } = {},
  1184. ): Promise<SessionId> {
  1185. const decoded = parseSeedFixture(realizeSeedFixture(scaffold, fixtureText, id))
  1186. const events = decoded.events
  1187. if (events.length === 0) throw new Error('seed fixture has no events')
  1188. const last = events[events.length - 1]!
  1189. // An open final turn would be mutated by resume's crash repair on first
  1190. // open; a committed seed must be a closed recording.
  1191. if (last.type !== 'turn/end') throw new Error(`seed fixture must end in turn/end, got ${last.type}`)
  1192. const createdAt = options.createdAt ?? Date.now() - 60_000
  1193. const meta: SessionHeader = {
  1194. version: SESSION_FORMAT_VERSION,
  1195. id: SessionId(id),
  1196. createdAt,
  1197. isSeeded: false,
  1198. cwd: scaffold.workspaceCwd,
  1199. delegationDepth: 0,
  1200. ...agentPreset === undefined ? {} : { agentPreset },
  1201. }
  1202. const fixtureCreatedAt = decoded.header.createdAt
  1203. if (typeof fixtureCreatedAt !== 'number') {
  1204. throw new Error('seed fixture requires a numeric createdAt header')
  1205. }
  1206. const timeAnchor = fixtureCreatedAt === 0 ? createdAt : fixtureCreatedAt
  1207. let nextTime = timeAnchor
  1208. const materializedEvents: SessionEvent[] = events.map((event) => {
  1209. const time = nextTime
  1210. if (event.type === 'assistant/message') {
  1211. const stream = rebaseSeedStream(event.data.stream, time)
  1212. const completedAt = Math.max(time, seedStreamEnd(stream) ?? time)
  1213. nextTime = completedAt + 1
  1214. return {
  1215. ...event,
  1216. time: completedAt,
  1217. data: { ...event.data, stream },
  1218. }
  1219. }
  1220. if (event.type === 'assistant/attempt') {
  1221. const stream = rebaseSeedStream(event.data.stream, time)
  1222. const completedAt = Math.max(time, seedStreamEnd(stream) ?? time)
  1223. nextTime = completedAt + 1
  1224. return {
  1225. ...event,
  1226. time: completedAt,
  1227. data: { ...event.data, stream },
  1228. }
  1229. }
  1230. nextTime = time + 1
  1231. return { ...event, time }
  1232. })
  1233. await persistSeedSession(scaffold, meta, materializedEvents)
  1234. return meta.id
  1235. }
  1236. /** Materialize one detached Session fixture through the shipped JSONL provider. */
  1237. async function persistSeedSession(
  1238. scaffold: WebScaffold,
  1239. meta: SessionHeader,
  1240. events: readonly SessionEvent[],
  1241. ): Promise<void> {
  1242. const seeder = new Context()
  1243. try {
  1244. // Same root as the booted tree with the plugin's own default compression,
  1245. // so the host's directory-scan list() sees one consistent encoding.
  1246. await seeder.plugin(JsonlSessionPersistence, { root: scaffold.persistenceRoot })
  1247. const handle = await seeder.sessionPersistence.create(meta)
  1248. await handle.append(events)
  1249. await handle.close()
  1250. } finally {
  1251. await seeder.fiber.dispose()
  1252. }
  1253. }
  1254. /**
  1255. * Read one stored session's physical event log through a throwaway read
  1256. * handle. The physical log carries no synthetic closers: a resumed session
  1257. * shows the closers the loop appended durably, and a never-resumed
  1258. * interrupted log stays interrupted.
  1259. * @param scaffold - the booted scaffold whose persistence holds the session.
  1260. * @param id - the stored session to read.
  1261. * @returns the stored events.
  1262. */
  1263. export async function readPersistedEvents(scaffold: WebScaffold, id: SessionId): Promise<readonly SessionEvent[]> {
  1264. const handle = await scaffold.ctx.sessionPersistence.open(id, 'read')
  1265. try {
  1266. return await handle.read()
  1267. } finally {
  1268. await handle.close()
  1269. }
  1270. }
  1271. /**
  1272. * Normalize an aria snapshot: uuid, cwd, workspace-basename, duration,
  1273. * decode-throughput, and path-sensitive compaction estimates collapse to
  1274. * stable tokens.
  1275. *
  1276. * Throughput needs a token for the same reason durations do, and no fixture
  1277. * can supply one: the figure divides a replayed step's output tokens by the
  1278. * wall time the local run took to stream them, so it moves between two runs
  1279. * on one machine (measured 69 → 70 tok/s) and swings wildly on a fast replay
  1280. * (26333 tok/s for a 3 ms stream).
  1281. */
  1282. /**
  1283. * Relative-time buckets rendered by a dated row, in both dictionaries.
  1284. *
  1285. * Opt-in per capture: a session-tree golden asserts its own literal age (a
  1286. * fresh row reads `now`, an older one does not), so collapsing the vocabulary
  1287. * everywhere would delete that assertion. A region whose rows are dated from
  1288. * live wall-clock state asks for it instead. Anchored on an aria label's
  1289. * closing quote, where the bucket is always last.
  1290. */
  1291. const ARIA_AGE =
  1292. /(?:now|\d+min|\d+h|\d+d|\d+mo|\d+y|刚刚|\d+分钟|\d+小时|\d+天|\d+个月|\d+年)(?=")/g
  1293. function normalizeAria(snapshot: string, workspaceCwd: string, age: boolean): string {
  1294. // The session heading renders the workspace's basename, not the full
  1295. // path, so both spellings must collapse to the token.
  1296. const base = workspaceCwd.split('/').pop()!
  1297. return (age ? snapshot.replace(ARIA_AGE, '{{age}}') : snapshot)
  1298. .split(workspaceCwd).join('{{cwd}}')
  1299. .split(base).join('{{workspace}}')
  1300. .replace(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, '{{uuid}}')
  1301. // The optional space in `\d+m ?\d+s` covers both minute spellings: the
  1302. // stats line's compact `2m42s` and the message-chrome template's `2m 42s`.
  1303. .replace(
  1304. /~\d+(?:y(?: \d+mo)?|mo(?: \d+d)?)|\b(?:\d+d(?: \d+h(?: \d+m \d+s)?)?|\d+h \d+m \d+s|\d+m ?\d+s|\d+(?:\.\d+)?s|\d+(?:\.\d+)?ms)\b/g,
  1305. duration => duration.startsWith('~') ? duration : '{{duration}}',
  1306. )
  1307. .replace(/\b\d[\d,]*(?:\.\d+)? ms\b/g, '{{duration}}')
  1308. .replace(
  1309. /约\d+(?:年(?:\d+个月)?|个月(?:\d+天)?)|\d+(?:天(?:\d+小时(?:\d+分\d+秒)?)?|小时\d+分\d+秒|分\d+秒|(?:\.\d+)?秒)/g,
  1310. duration => duration.startsWith('约') ? duration : '{{duration}}',
  1311. )
  1312. .replace(/\d+(?:\.\d+)?(?= tok\/s(?!\w))/g, '{{throughput}}')
  1313. // Seeded compaction prices realized file paths, whose length differs
  1314. // between local worktrees and CI scratch directories.
  1315. .replace(/(Compacted \d+ history items \(~)\d+( tokens\))/g, '$1{{tokens}}$2')
  1316. // Session summaries and Message IconActions clocks cross calendar
  1317. // boundaries; collapse every shape so goldens stay stable across them.
  1318. .replace(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z/g, '{{timestamp}}')
  1319. .replace(/\d{4}年\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
  1320. .replace(/\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
  1321. .replace(/(?<!\d)\d{1,2}:\d{2}:\d{2}(?:\.\d+)?(?:\s*[AP]M)?(?!\d)/gi, '{{clock}}')
  1322. .replace(/(?<!\d)\d{2}:\d{2}(?!\d)/g, '{{clock}}')
  1323. }
  1324. /**
  1325. * Capture the region's aria snapshot at a settled milestone: poll until two
  1326. * consecutive normalized captures are equal — a single-shot capture races the
  1327. * last React commits.
  1328. * @param page - the page under test.
  1329. * @param selector - the region locator selector.
  1330. * @param workspaceCwd - normalization input.
  1331. * @param options - `normalizeAge` collapses relative-time buckets to `{{age}}`
  1332. * for a region whose rows are dated from live wall-clock state.
  1333. * @returns the stable normalized snapshot.
  1334. */
  1335. export async function captureStableAria(
  1336. page: Page,
  1337. selector: string,
  1338. workspaceCwd: string,
  1339. options: { normalizeAge?: boolean } = {},
  1340. ): Promise<string> {
  1341. const region = page.locator(selector).first()
  1342. const age = options.normalizeAge === true
  1343. let previous = normalizeAria(await region.ariaSnapshot(), workspaceCwd, age)
  1344. await expect.poll(async () => {
  1345. const current = normalizeAria(await region.ariaSnapshot(), workspaceCwd, age)
  1346. const stable = current === previous
  1347. previous = current
  1348. return stable
  1349. }, { timeout: 5_000, message: 'aria snapshot did not stabilize' }).toBe(true)
  1350. return previous
  1351. }
  1352. /**
  1353. * Capture a stable aria snapshot with every eligible Turn process expanded,
  1354. * then restore the controls that were closed before the capture.
  1355. * @param page - the page under test.
  1356. * @param selector - the region locator selector.
  1357. * @param workspaceCwd - normalization input.
  1358. * @param options - optional user-visible state to establish before capture.
  1359. * @returns the stable normalized expanded snapshot.
  1360. */
  1361. export async function captureExpandedTurnProcessAria(
  1362. page: Page,
  1363. selector: string,
  1364. workspaceCwd: string,
  1365. options: { scrollToBottom?: boolean } = {},
  1366. ): Promise<string> {
  1367. const controls = page.locator('[data-turn-process]')
  1368. const count = await controls.count()
  1369. expect(count).toBeGreaterThan(0)
  1370. const opened: number[] = []
  1371. for (let index = 0; index < count; index++) {
  1372. const control = controls.nth(index)
  1373. if (!await control.isVisible() || await control.getAttribute('aria-expanded') === 'true') continue
  1374. await control.click()
  1375. opened.push(index)
  1376. }
  1377. try {
  1378. if (options.scrollToBottom === true) {
  1379. const backToBottom = page.getByRole('button', { name: 'Back to bottom', exact: true })
  1380. const scroll = page.locator('[data-conversation-scroll]')
  1381. await expect.poll(async () => {
  1382. const distanceFromBottom = await scroll.evaluate((host) => {
  1383. host.scrollTop = host.scrollHeight
  1384. return host.scrollHeight - host.clientHeight - host.scrollTop
  1385. })
  1386. return Math.abs(distanceFromBottom) <= 1 && await backToBottom.count() === 0
  1387. }, { timeout: 10_000 }).toBe(true)
  1388. }
  1389. return await captureStableAria(page, selector, workspaceCwd)
  1390. } finally {
  1391. for (const index of opened.reverse()) {
  1392. const control = controls.nth(index)
  1393. if (await control.getAttribute('aria-expanded') === 'true') await control.click()
  1394. }
  1395. }
  1396. }
  1397. /**
  1398. * Compare a normalized golden, or rewrite it under refresh. Refresh is the
  1399. * ONLY writer: a missing golden in replay mode fails with the healing command
  1400. * instead of silently self-bootstrapping.
  1401. * @param goldenPath - the committed ui.expected.md path.
  1402. * @param actual - the stable normalized snapshot.
  1403. * @param mode - the active snapshot mode.
  1404. */
  1405. export async function compareOrRefreshGolden(goldenPath: string, actual: string, mode: WebSnapshotMode): Promise<void> {
  1406. const payload = `${actual}\n`
  1407. if (mode === 'refresh') {
  1408. await writeFile(goldenPath, payload)
  1409. return
  1410. }
  1411. if (!existsSync(goldenPath)) {
  1412. throw new Error(`missing golden ${goldenPath} — run DSH_SNAPSHOT=refresh pnpm run test:web to generate it`)
  1413. }
  1414. expect(payload).toBe(await readFile(goldenPath, 'utf8'))
  1415. }
  1416. /**
  1417. * Fixture-inventory guard: the scenario directory holds exactly the expected
  1418. * files and every committed JSONL is a header-scrubbed, typed-redaction fixed point.
  1419. * @param dir - the scenario snapshot directory.
  1420. * @param expected - the exact expected file inventory.
  1421. */
  1422. export async function assertFixtureInventory(dir: string, expected: string[]): Promise<void> {
  1423. const entries = (await readdir(dir)).sort()
  1424. const ownsManifest = entries.includes('snapshot.yml')
  1425. const artifacts = entries.filter(name => name !== 'snapshot.yml')
  1426. const roleInventory = (names: readonly string[]): string[] => [...new Set(names.map((name) => {
  1427. const fixture = parseSessionFixtureName(name)
  1428. return fixture === undefined ? name : sessionFixtureName(fixture.index, 0)
  1429. }))].sort()
  1430. expect(roleInventory(artifacts)).toEqual(roleInventory(expected))
  1431. if (ownsManifest) {
  1432. const manifestPath = join(dir, 'snapshot.yml')
  1433. const manifest = parseSnapshotManifest(await readFile(manifestPath, 'utf8'), manifestPath)
  1434. expect(manifest.profile).toBe('web')
  1435. if (manifest.session === undefined) {
  1436. expect(
  1437. artifacts.some(name => parseSessionFixtureName(name)?.index === 0),
  1438. `${dir}: session owner must carry a canonical parent Session fixture`,
  1439. ).toBe(true)
  1440. } else {
  1441. expect(existsSync(resolve(dir, manifest.session.source)), `${dir}: session source`).toBe(true)
  1442. }
  1443. }
  1444. for (const entry of artifacts.filter(name => name.endsWith('.jsonl'))) {
  1445. const content = await readFile(join(dir, entry), 'utf8')
  1446. expect(scrubRequestHeaders(content), `${dir}/${entry} carries request-header bulk`).toBe(content)
  1447. expect(redactSessionSnapshotIds([content]), `${dir}/${entry} carries unredacted identities`).toEqual([content])
  1448. }
  1449. }
  1450. /**
  1451. * Console tripwires: reconnect/gap-repair self-healing or a pageerror must
  1452. * fail the scenario, not mask a dead wire behind eventual consistency.
  1453. * @param page - the page under test.
  1454. * @returns live warning/pageerror collectors to assert empty at scenario end.
  1455. */
  1456. export function watchConsole(page: Page): { warnings: string[]; pageErrors: string[] } {
  1457. const warnings: string[] = []
  1458. const pageErrors: string[] = []
  1459. page.on('console', (message) => {
  1460. const text = message.text()
  1461. if (/connection lost|gap repair|discontinuous/i.test(text)) warnings.push(text)
  1462. })
  1463. page.on('pageerror', (error) => { pageErrors.push(String(error)) })
  1464. return { warnings, pageErrors }
  1465. }
  1466. /**
  1467. * Remove only connection-loss warnings emitted after an intentional reload.
  1468. * Earlier warnings and all gap-repair/discontinuity warnings remain fatal.
  1469. * @param tripwire - the live console-warning collector.
  1470. * @param warningStart - warning count captured immediately before reloading.
  1471. */
  1472. export function acknowledgeReloadConnectionLoss(
  1473. tripwire: ReturnType<typeof watchConsole>,
  1474. warningStart: number,
  1475. ): void {
  1476. const reloadWarnings = tripwire.warnings.splice(warningStart)
  1477. tripwire.warnings.push(...reloadWarnings.filter(text => !/connection lost/i.test(text)))
  1478. }