scaffold.ts 57 KB

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