scaffold.ts 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880
  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 } from 'node:fs'
  26. import { mkdir, mkdtemp, readFile, readdir, realpath, rm, writeFile } from 'node:fs/promises'
  27. import { tmpdir } from 'node:os'
  28. import { join } from 'node:path'
  29. import { pathToFileURL } from 'node:url'
  30. import type { Page } from 'playwright'
  31. import { expect } from 'vitest'
  32. import { Context } from '@deepseek-ai/cordis'
  33. import Loader from '@deepseek-ai/cordis-plugin-loader'
  34. import Include, { type PatchOptions } from '@deepseek-ai/cordis-plugin-include'
  35. import Group from '@deepseek-ai/cordis-plugin-group'
  36. import { scrubRequestHeaders, stabilizeFixtureMessageIds } from '@deepseek-ai/dsh-acp-snapshot'
  37. import {
  38. assertEntriesLoaded,
  39. composeEntries,
  40. healProfilesModuleFallback,
  41. loadOverlayPatches,
  42. } from '@deepseek-ai/dsh-app-boot'
  43. import { dshHomePath } from '@deepseek-ai/dsh-home-paths'
  44. import { LlmAdapter } from '@deepseek-ai/dsh-llm'
  45. import type {
  46. LlmModelInfo, LlmProviderInfo, LlmResolvedModelInfo, StreamChunk,
  47. } from '@deepseek-ai/dsh-llm'
  48. import type { ReplayHandle } from '@deepseek-ai/dsh-llm-replay'
  49. import { installLlmReplay, parseSessionLog } from '@deepseek-ai/dsh-llm-replay'
  50. import SessionStore, {
  51. packChunkRuns,
  52. SESSION_FORMAT_VERSION,
  53. SessionId,
  54. type Session,
  55. type SessionEvent,
  56. type SessionHeader,
  57. } from '@deepseek-ai/dsh-session'
  58. import JsonlSessionPersistence from '@deepseek-ai/dsh-session-persistence-jsonl'
  59. // Empty type imports carry the webServer/agents/sessionPersistence Context merges.
  60. import type {} from '@deepseek-ai/dsh-host-webserver'
  61. import type {} from '@deepseek-ai/dsh-agent'
  62. import { provideCmdline } from '@deepseek-ai/dsh-cmdline'
  63. import { REPO_ROOT, requireDist } from './support.ts'
  64. /** Snapshot mode for the lane, from $DSH_SNAPSHOT (same vocabulary as the other snapshot suites). */
  65. export type WebSnapshotMode = 'replay' | 'record' | 'refresh'
  66. /**
  67. * Resolve and validate the lane's snapshot mode.
  68. * @returns the active mode; unset/empty selects replay.
  69. */
  70. export function webSnapshotMode(): WebSnapshotMode {
  71. const value = process.env.DSH_SNAPSHOT
  72. if (value === undefined || value === '' || value === 'replay') return 'replay'
  73. if (value === 'record' || value === 'refresh') return value
  74. throw new Error(`DSH_SNAPSHOT must be replay, record, or refresh; got ${JSON.stringify(value)}`)
  75. }
  76. /** The shipped composition under test: the dsh-base and dsh-web-app bundle patches over the empty profile root. */
  77. const BASE_PATCH_PATH = join(REPO_ROOT, 'packages/bundle/base/cordis.patch.yml')
  78. const WEB_PATCH_PATH = join(REPO_ROOT, 'packages/bundle/web-app/cordis.patch.yml')
  79. /** The installation anchor whose dependency surface the profile module fallback mirrors. */
  80. const INSTALL_ANCHOR = join(REPO_ROOT, 'apps/cli/package.json')
  81. /** The deployment's own agent-preset root, shipped beside the app's config. */
  82. const SHIPPED_PRESET_DIR = join(REPO_ROOT, 'apps/cli/config/agent-presets')
  83. // Replay publishes the provider catalog the gateway routes to (providers
  84. // mode, never catch-all: with llm-deepseek disabled no adapter exists, so a
  85. // catch-all would leave resolveModelInfo unroutable and compaction-basic's
  86. // post-step pressure check would warn every step). The published
  87. // contextWindow keeps that pressure path provably inert for small fixtures.
  88. const REPLAY_PROVIDERS = [{
  89. id: 'deepseek-official',
  90. name: 'DeepSeek',
  91. models: [{ id: 'deepseek-v4-flash', name: 'DeepSeek-V4-Flash', contextWindow: 128_000 }],
  92. }]
  93. /**
  94. * The routes a shipped composition always has, with no ability to stream.
  95. * A fixture-less keyless scenario issues no model calls, but its tree must
  96. * still answer `listProviders()` — surfaces legitimately gate on whether any
  97. * adapter serves a session's route, and an empty registry is a test artifact,
  98. * not a product state.
  99. */
  100. class RouteOnlyAdapter extends LlmAdapter {
  101. constructor(private readonly providers: typeof REPLAY_PROVIDERS) {
  102. super()
  103. }
  104. override providerInfo(provider: string): LlmProviderInfo {
  105. return { id: provider, name: this.providers.find(entry => entry.id === provider)?.name ?? provider }
  106. }
  107. override listModels(provider: string): Promise<readonly LlmModelInfo[]> {
  108. return Promise.resolve((this.providers.find(entry => entry.id === provider)?.models ?? [])
  109. .map(model => ({ provider, id: model.id, name: model.name })))
  110. }
  111. override resolveModel(provider: string, model: string): Promise<LlmResolvedModelInfo> {
  112. const listed = this.providers.find(entry => entry.id === provider)?.models
  113. .find(entry => entry.id === model)
  114. return Promise.resolve({
  115. provider,
  116. id: model,
  117. name: listed?.name ?? model,
  118. ...listed?.contextWindow === undefined ? {} : { contextWindow: listed.contextWindow },
  119. })
  120. }
  121. override async *stream(): AsyncIterable<StreamChunk> {
  122. throw new Error(
  123. 'web e2e scaffold: a model call was issued by a scenario that declared no replay fixture'
  124. + ' — pass replayFixture, or keep the scenario free of model calls',
  125. )
  126. }
  127. }
  128. function replayProviders(contextWindow: number | undefined): typeof REPLAY_PROVIDERS {
  129. if (contextWindow === undefined) return REPLAY_PROVIDERS
  130. return REPLAY_PROVIDERS.map(provider => ({
  131. ...provider,
  132. models: provider.models.map(model => ({ ...model, contextWindow })),
  133. }))
  134. }
  135. /** A booted web scaffold: real composition, mode-selected model backend, temp world. */
  136. export interface WebScaffold {
  137. /** The active snapshot mode this scaffold booted under. */
  138. mode: WebSnapshotMode
  139. /** Browser-facing origin for the bound test server. */
  140. baseUrl: string
  141. /** Settled root context (the in-process readiness barrier; headless event subscription is its sanctioned use). */
  142. ctx: Context
  143. /** Temp project directory sessions run in (shell/fs tool cwd). */
  144. workspaceCwd: string
  145. /** Temp persistence root (seeded sessions land here through the real API). */
  146. persistenceRoot: string
  147. /** Isolated harness home the settings/credentials rows write ($DSH_HOME double). */
  148. harnessHome: string
  149. /** Await a settled turn end: in-process turn/end, then the agent's idle flip (which follows the persistence flush). */
  150. whenTurnSettled(timeoutMs?: number): Promise<SessionId>
  151. /** Tear everything down; asserts the replay fixture was fully consumed first (replay/refresh). */
  152. close(): Promise<void>
  153. }
  154. /** Options for {@link launchWebScaffold}. */
  155. export interface LaunchOptions {
  156. /**
  157. * Optional product overlay applied after the shipped Web surface and before
  158. * the scaffold's hermetic test patches, matching the launcher's `--patch`
  159. * ordering.
  160. */
  161. extraOverlayPath?: string
  162. /**
  163. * Replay fixture (session.jsonl) served by the inserted dsh-llm-replay row
  164. * in replay/refresh modes; ignored in record mode (the real adapter
  165. * answers). Omit for scenarios issuing no model calls — a stray stream then
  166. * fails loud with NO_ADAPTER (llm-deepseek is disabled and no replay row
  167. * mounts).
  168. */
  169. replayFixture?: string
  170. /**
  171. * Recorded child logs assigned in child creation order. Each child owns its
  172. * own positional replay cursor across initial and continuation turns.
  173. */
  174. replayChildFixtures?: string[]
  175. /**
  176. * Optional replay.override.json sidecar (whole-script replacement or
  177. * `{ patches }` augmentation) for throw/hang scenarios not expressible as
  178. * recorded chunks; replay/refresh only.
  179. */
  180. replayOverride?: string
  181. /** Per-chunk replay pacing (ms) so the browser observes genuinely incremental SSE; replay/refresh only. */
  182. paceMs?: number
  183. /** Synthetic model capacity for UI scenarios whose seeded history must remain uncompacted. */
  184. replayContextWindow?: number
  185. /**
  186. * Tool presentation mode patched onto the shipped `tools` row (`code`
  187. * collapses the wire to run_code + the SDK prompt section). Omit for the
  188. * yml default. The code runtime row is always in the tree, so no extra
  189. * insertion is needed.
  190. */
  191. toolsMode?: 'native' | 'code' | 'both'
  192. /**
  193. * Insert the opt-in model-facing Cordis tool provider into the shipped tree.
  194. * Record and replay use the same tool surface, so captured request headers
  195. * remain reconstructable without making the tools a product default.
  196. */
  197. cordisTools?: boolean
  198. /**
  199. * Keep the shipped DeepSeek adapter mounted while masking the process
  200. * environment's DEEPSEEK_API_KEY for this scaffold lifetime. This is the
  201. * keyless first-run configuration lane; the default disables the adapter.
  202. */
  203. deepSeekMissingCredential?: boolean
  204. /**
  205. * Patch the shipped DeepSeek search row to a deterministic endpoint and
  206. * credential reference. Browser search scenarios keep the real provider and
  207. * credentials seam while avoiding external search traffic and ambient keys.
  208. */
  209. deepSeekSearch?: {
  210. /** Anthropic-compatible base URL; the provider appends `/messages`. */
  211. baseURL: string
  212. /** Credential reference resolved by the shipped search provider. */
  213. apiKeyEnv: string
  214. }
  215. /**
  216. * Replace the roster the scaffold mounts by default (the shipped directory
  217. * at `system` trust, default `standard`). Supply this only to change WHICH
  218. * presets a scenario sees — a writable user root, a different default —
  219. * never to turn the roster on: without one every session composes an agent
  220. * with no tools, no persona, and no token meter, which is not a shape the
  221. * product ever boots in. The patch lands after the default, so it wins.
  222. */
  223. agentPresets?: {
  224. /** Roots to discover, in precedence order; the shipped directory is `system`. */
  225. roots: { path: string; trust: 'system' | 'user' }[]
  226. /** The preset a session that names none is composed from. */
  227. default: string
  228. }
  229. /**
  230. * Mount the shipped telemetry row in FULL mode against this exporter URL
  231. * instead of disabling it. Used to pin a real backend disclosure in
  232. * assembled coverage; point the URL at a local dead endpoint so no record
  233. * leaves the process.
  234. */
  235. telemetryUrl?: string
  236. /**
  237. * Browse through a trusted non-loopback hostname that the browser resolves
  238. * to loopback (for example `*.localhost`). The test server stays bound to
  239. * 127.0.0.1; a non-resolving authority fails before Host trust is exercised.
  240. */
  241. remoteAuthority?: string
  242. /** Reuse an existing harness home so a second Host can verify user settings across origins. */
  243. harnessHome?: string
  244. }
  245. /** Dispose the booted tree and remove both owned temp roots, reporting every independent cleanup failure. */
  246. async function cleanupScaffoldWorld(ctx: Context, workspaceCwd: string, persistenceRoot: string): Promise<unknown[]> {
  247. const failures: unknown[] = []
  248. await Promise.resolve(ctx.fiber.dispose()).catch((error: unknown) => failures.push(error))
  249. await rm(workspaceCwd, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
  250. await rm(persistenceRoot, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
  251. return failures
  252. }
  253. /**
  254. * Boot the real web composition under the current snapshot mode.
  255. * @param options - replay fixture selection and pacing.
  256. * @returns the running scaffold.
  257. */
  258. export async function launchWebScaffold(options: LaunchOptions = {}): Promise<WebScaffold> {
  259. requireDist()
  260. const mode = webSnapshotMode()
  261. const browserHost = options.remoteAuthority ?? '127.0.0.1'
  262. if (mode === 'record') {
  263. // Both owning vitest configs (web unconditionally, snapshot in record
  264. // mode) load the repo-root .env before this file runs.
  265. if (process.env.DEEPSEEK_API_KEY === undefined || process.env.DEEPSEEK_API_KEY.length === 0) {
  266. throw new Error('web e2e record mode needs DEEPSEEK_API_KEY (env or repo-root .env)')
  267. }
  268. }
  269. if (mode === 'record' && options.deepSeekMissingCredential === true) {
  270. throw new Error('deepSeekMissingCredential is a keyless replay/refresh option')
  271. }
  272. const maskDeepSeekCredential = mode !== 'record' && options.deepSeekMissingCredential === true
  273. const originalDeepSeekCredential = process.env.DEEPSEEK_API_KEY
  274. let credentialEnvironmentRestored = false
  275. const restoreCredentialEnvironment = (): void => {
  276. if (credentialEnvironmentRestored || !maskDeepSeekCredential) return
  277. credentialEnvironmentRestored = true
  278. if (originalDeepSeekCredential === undefined) {
  279. Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
  280. } else {
  281. process.env.DEEPSEEK_API_KEY = originalDeepSeekCredential
  282. }
  283. }
  284. const workspaceCwd = await realpath(await mkdtemp(join(tmpdir(), 'dsh-web-e2e-ws-')))
  285. // Isolated harness home: the settings/credentials rows resolve $DSH_HOME
  286. // paths at load, and an in-process boot must NEVER touch the developer's
  287. // real ~/.dsh document or credential file.
  288. const harnessHome = options.harnessHome ?? join(workspaceCwd, '.dsh-home')
  289. // Skill discovery is model-visible input, and its roots now resolve inside a
  290. // PRESET — a subtree this lane's include patches cannot reach, because the
  291. // roster mounts it directly per session rather than as a row of the booted
  292. // tree. The row's documented fallback is the environment, so pin that: the
  293. // whole scaffold lifetime, not just the boot, since presets mount when a
  294. // session is created. Without this a developer's real ~/.dsh/skills silently
  295. // enters replay requests and goldens while CI sees none. `DSH_HOME` follows
  296. // the resolved harness home so a scaffold sharing another's home — the
  297. // cross-port persistence scenario — pins the same roots the settings and
  298. // credentials rows were configured with.
  299. const skillRootEnvironment = {
  300. DSH_HOME: harnessHome,
  301. DSH_AGENTS_HOME: join(workspaceCwd, '.agents-home'),
  302. DSH_BUNDLED_SKILL_DIR: join(workspaceCwd, '.bundled-skills'),
  303. }
  304. const originalSkillRootEnvironment = Object.fromEntries(
  305. Object.keys(skillRootEnvironment).map(key => [key, process.env[key]]),
  306. )
  307. let skillRootEnvironmentRestored = false
  308. const restoreSkillRootEnvironment = (): void => {
  309. if (skillRootEnvironmentRestored) return
  310. skillRootEnvironmentRestored = true
  311. for (const [key, value] of Object.entries(originalSkillRootEnvironment)) {
  312. if (value === undefined) Reflect.deleteProperty(process.env, key)
  313. else process.env[key] = value
  314. }
  315. }
  316. Object.assign(process.env, skillRootEnvironment)
  317. let persistenceRoot: string
  318. try {
  319. persistenceRoot = await mkdtemp(join(tmpdir(), 'dsh-web-e2e-sessions-'))
  320. } catch (error) {
  321. const failures: unknown[] = [error]
  322. await rm(workspaceCwd, { recursive: true, force: true }).catch((cleanupError: unknown) => failures.push(cleanupError))
  323. restoreSkillRootEnvironment()
  324. if (failures.length > 1) throw new AggregateError(failures, 'web scaffold temp-root setup failed')
  325. throw error
  326. }
  327. if (maskDeepSeekCredential) Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
  328. // The include patch set — the same layer stack the profile boot composes
  329. // (bundle patches in dsh.profile.bundles order), applied over the SAME empty root (a
  330. // patch id that stops matching a row fails the boot sweep loudly instead of
  331. // drifting).
  332. const basePatches = loadOverlayPatches('web e2e scaffold', BASE_PATCH_PATH)
  333. const surfacePatches = loadOverlayPatches('web e2e scaffold', WEB_PATCH_PATH)
  334. const extraOverlayPatches = options.extraOverlayPath === undefined
  335. ? []
  336. : loadOverlayPatches('web e2e scaffold', options.extraOverlayPath)
  337. const composedRows = composeEntries([basePatches, surfacePatches, extraOverlayPatches])
  338. const webRuntimeConfig = composedRows.find(row => row.id === 'web-runtime')?.config as {
  339. surfaceContext?: boolean
  340. } | undefined
  341. const surfaceContext = webRuntimeConfig?.surfaceContext !== false
  342. const patches: PatchOptions[] = [
  343. ...basePatches,
  344. ...surfacePatches,
  345. ...extraOverlayPatches,
  346. // The roster's `roots` is an assembly fact AppCLIEntry resolves and patches
  347. // in, exactly like `distIndex` on the webserver row — the shipped preset
  348. // directory sits beside the composition that names it, and no config author
  349. // chooses it. This lane boots the shipped tree WITHOUT AppCLIEntry, so it
  350. // has to supply the same fact or the roster resolves nothing and every
  351. // session composes an agent with no tools, no persona, and no token meter.
  352. // Only the shipped root: a developer's own `~/.dsh/.agent-presets` must not be
  353. // able to change a golden.
  354. {
  355. id: 'agent-presets',
  356. config: {
  357. default: 'standard',
  358. roots: [{ path: SHIPPED_PRESET_DIR, trust: 'system' }],
  359. includeUserRoot: false,
  360. },
  361. },
  362. { id: 'session-persistence-jsonl', config: { root: persistenceRoot } },
  363. // Content search is enabled here although the shipped bundles default it
  364. // off (`openAt: never`, pinned by apps/cli/tests/lazy-search-startup):
  365. // the seeded-session scenarios navigate by content search, and these e2e
  366. // runs are the assembled coverage for the opt-in search path.
  367. { id: 'session-query-sqlite', config: { path: ':memory:', openAt: 'first-search' } },
  368. // storage-json's yml root is anchored to the real $DSH_HOME; pin the row
  369. // to an absolute temp root (removed with the workspace at close) so tests
  370. // never write the user's harness home.
  371. { id: 'storage-json', config: { root: join(workspaceCwd, '.dsh-storages') } },
  372. // Skill discovery is model-visible input. Pin every host-level root inside
  373. // the owned temp world so ~/.dsh, ~/.agents, and a bundled-root env setting
  374. // cannot change replay requests or conversation goldens. Project roots stay
  375. // enabled against the same empty temp workspace, preserving the real seam.
  376. {
  377. id: 'skill-filesystem',
  378. config: {
  379. dshHome: join(workspaceCwd, '.dsh-home'),
  380. agentsHome: join(workspaceCwd, '.agents-home'),
  381. bundledSkillDir: join(workspaceCwd, '.bundled-skills'),
  382. watch: false,
  383. },
  384. },
  385. // fs/bash cwd default to process.cwd(); the gateway injects the same
  386. // value into session.cwd — chdir below anchors all three to the temp
  387. // workspace, keeping the composition untouched.
  388. { id: 'agent-instructions', disabled: true },
  389. { id: 'session-title-llm', disabled: true },
  390. // Fixture sessions must never leave the process: the shipped row defaults
  391. // to the production OTLP endpoint (or whatever DSH_TELEMETRY_OTLP_URL
  392. // names in the ambient environment). A scenario that pins a real backend
  393. // disclosure passes a local dead endpoint instead of disabling the row.
  394. options.telemetryUrl === undefined
  395. ? { id: 'session-telemetry-otel', disabled: true }
  396. : {
  397. id: 'session-telemetry-otel',
  398. config: {
  399. mode: 'FULL',
  400. exporter: { url: options.telemetryUrl },
  401. shutdownTimeoutMillis: 1_000,
  402. },
  403. },
  404. {
  405. id: 'webserver',
  406. config: { host: '127.0.0.1', port: 0 },
  407. },
  408. // The bundle's web-runtime row resolves the same built dist under test
  409. // (apps/web IS @deepseek-ai/dsh-web-frontend); only the URL line is silenced.
  410. // Preserve the composed surface-context choice because a patch replaces
  411. // the row's complete config.
  412. { id: 'web-runtime', config: { printUrl: false, surfaceContext } },
  413. ...options.remoteAuthority === undefined
  414. ? []
  415. : [{ id: 'connection', config: { trustedHosts: [options.remoteAuthority] } }],
  416. { id: 'settings', config: { dshHome: harnessHome } },
  417. { id: 'credentials', config: { dshHome: harnessHome } },
  418. // The shipped directory-picker row is the -auto chooser, which resolves
  419. // the interaction from the RUNNING host (display, SSH launch, bind). The
  420. // lane's goldens are interaction-specific (workspace-management drives
  421. // the in-app browse dialog), so pin -browse deterministically on every
  422. // host: patch `name` is an assertion, not an override, hence the
  423. // disable+insert pair.
  424. { id: 'directory-picker', disabled: true },
  425. { insert: [
  426. { id: 'directory-picker-browse', name: '@deepseek-ai/dsh-host-directory-picker-browse' },
  427. { id: 'ui-directory-picker-browse', name: '@deepseek-ai/dsh-client-ui-directory-picker-browse' },
  428. ] },
  429. ...options.agentPresets === undefined
  430. ? []
  431. // Never the derived harness-home root: a developer's own presets must not
  432. // be able to change a golden, whatever roots a scenario asks for.
  433. : [{ id: 'agent-presets', config: { ...options.agentPresets, includeUserRoot: false } }],
  434. ...options.toolsMode === undefined ? [] : [{ id: 'tools', config: { mode: options.toolsMode } }],
  435. // The shipped Web bundle already owns both runners and the Cordis UI. This
  436. // scenario adds only the model-facing tools that exercise those services.
  437. ...options.cordisTools === true
  438. ? [{ insert: [
  439. { id: 'tool-cordis', name: '@deepseek-ai/dsh-tool-cordis' },
  440. ] }]
  441. : [],
  442. ...options.deepSeekSearch === undefined
  443. ? []
  444. : [{
  445. id: 'web-search-deepseek',
  446. config: {
  447. apiKeyEnv: options.deepSeekSearch.apiKeyEnv,
  448. baseURL: options.deepSeekSearch.baseURL,
  449. },
  450. }],
  451. ...mode === 'record' || options.deepSeekMissingCredential === true
  452. ? []
  453. : [{ id: 'llm-deepseek', disabled: true }],
  454. ]
  455. // Sessions inherit the gateway's process.cwd() default; run the boot from
  456. // the temp workspace so tool cwd, session cwd, and fixtures agree.
  457. const originalCwd = process.cwd()
  458. const ctx = new Context()
  459. let port = 0
  460. let replayHandle: ReplayHandle | undefined
  461. try {
  462. process.chdir(workspaceCwd)
  463. // The production module-resolution setup: an empty profile root inside the temp
  464. // harness home, with bare plugin names resolving through the flat module
  465. // fallback the launcher heals under <home>/profiles.
  466. healProfilesModuleFallback(INSTALL_ANCHOR, harnessHome)
  467. const profileDir = join(harnessHome, 'profiles', 'scaffold')
  468. await mkdir(profileDir, { recursive: true })
  469. const rootConfig = join(profileDir, 'cordis.yml')
  470. await writeFile(rootConfig, '[]\n')
  471. ctx.baseUrl = pathToFileURL(profileDir).href + '/'
  472. // This direct Loader harness supplies the same root-path capability as app-boot.
  473. ctx.provide('dshHomePath', dshHomePath)
  474. // A host with no command line still provides one: the web bundle's startup
  475. // row releases the rows waiting on it, and with no arguments each starts on
  476. // the values this scaffold composed above. An exit request can only come
  477. // from a rejected argument, which a fixed empty list has none of.
  478. provideCmdline(ctx, {
  479. args: [],
  480. exit: (code) => {
  481. throw new Error(`web e2e scaffold: the web app requested exit ${String(code)} with no arguments to reject`)
  482. },
  483. })
  484. await ctx.plugin(Loader)
  485. ctx.loader.builtins.include = Include
  486. // `cordis:group` beside it, exactly as `boot()` registers it: a group row is
  487. // how a preset gives one `isolate` realm to a provider and its consumers,
  488. // and a preset resolving package names from its own directory cannot reach
  489. // `@deepseek-ai/cordis-plugin-group` by name.
  490. ctx.loader.builtins.group = Group
  491. await ctx.loader.create({
  492. name: 'cordis:include',
  493. config: { path: pathToFileURL(rootConfig).href, patches },
  494. })
  495. await ctx.loader.await()
  496. assertEntriesLoaded(ctx, 'web e2e scaffold')
  497. const boundPort = ctx.get('webServer')?.port
  498. if (boundPort === undefined) {
  499. throw new Error('web e2e scaffold: webServer service missing after settled boot')
  500. }
  501. port = boundPort
  502. // Fill the open llm seam on the settled root ctx. Ordinary keyless modes
  503. // disable llm-deepseek; the first-run lane keeps it mounted but has no
  504. // replay fixture and never streams. The direct install, unlike the plugin
  505. // row, returns the ReplayHandle for the teardown consumption check.
  506. if (mode !== 'record' && options.replayFixture !== undefined) {
  507. replayHandle = installLlmReplay(ctx, {
  508. file: options.replayFixture,
  509. providers: replayProviders(options.replayContextWindow),
  510. ...(options.replayOverride === undefined ? {} : { overrideFile: options.replayOverride }),
  511. ...(options.replayChildFixtures === undefined ? {} : { childFiles: options.replayChildFixtures }),
  512. ...(options.paceMs === undefined ? {} : { paceMs: options.paceMs }),
  513. })
  514. } else if (mode !== 'record' && options.deepSeekMissingCredential !== true) {
  515. // No fixture and no shipped adapter would leave the tree with ZERO
  516. // provider routes — a state no product composition has, and one the
  517. // composer refuses to type into. Register the same routes
  518. // a fixture would, with streaming that still fails loud: the scenario
  519. // issues no model calls, and one that slipped in must not pass quietly.
  520. ctx.effect(() => ctx.llm.registerAdapter(
  521. replayProviders(options.replayContextWindow).map(provider => provider.id),
  522. new RouteOnlyAdapter(replayProviders(options.replayContextWindow)),
  523. ), 'web e2e scaffold: route-only adapter')
  524. }
  525. } catch (error) {
  526. if (process.cwd() !== originalCwd) process.chdir(originalCwd)
  527. const cleanupFailures = await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot)
  528. restoreCredentialEnvironment()
  529. restoreSkillRootEnvironment()
  530. if (cleanupFailures.length > 0) {
  531. throw new AggregateError([error, ...cleanupFailures], 'web scaffold setup failed and cleanup was incomplete')
  532. }
  533. throw error
  534. } finally {
  535. if (process.cwd() !== originalCwd) process.chdir(originalCwd)
  536. }
  537. return {
  538. harnessHome,
  539. mode,
  540. baseUrl: `http://${browserHost}:${port}`,
  541. ctx,
  542. workspaceCwd,
  543. persistenceRoot,
  544. // Barrier stack: the in-process turn/end identifies the session, its
  545. // explicit flush makes the transcript durable, and the caller's browser
  546. // settled-poll comes last because host completion strictly precedes render.
  547. whenTurnSettled(timeoutMs = mode === 'record' ? 180_000 : 30_000): Promise<SessionId> {
  548. return new Promise<SessionId>((resolveSettled, reject) => {
  549. const timer = setTimeout(() => {
  550. off()
  551. reject(new Error(`no turn/end within ${timeoutMs}ms`))
  552. }, timeoutMs)
  553. const off = ctx.on('session/event', (session: Session, event: SessionEvent) => {
  554. if (event.type !== 'turn/end') return
  555. clearTimeout(timer)
  556. off()
  557. ctx.sessions.flush(session)
  558. .then(() => { resolveSettled(session.id) }, reject)
  559. })
  560. })
  561. },
  562. async close(): Promise<void> {
  563. const failures: unknown[] = []
  564. // Fixture-consumption check first, while the run's binding state is
  565. // still authoritative — a scenario that drove fewer model calls than
  566. // recorded fails here instead of drifting green.
  567. try {
  568. replayHandle?.assertConsumed()
  569. } catch (error) {
  570. failures.push(error)
  571. }
  572. try {
  573. failures.push(...await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot))
  574. } finally {
  575. restoreCredentialEnvironment()
  576. restoreSkillRootEnvironment()
  577. }
  578. if (failures.length > 0) throw new AggregateError(failures, 'web scaffold teardown failed')
  579. },
  580. }
  581. }
  582. /**
  583. * Serialize a live session to the canonical raw session-JSONL layout — the
  584. * in-memory record-mode harvest, so the on-disk zstd default never matters.
  585. */
  586. function rawSessionLog(session: Session): string {
  587. return [
  588. JSON.stringify({ type: 'session', ...session.header }),
  589. ...packChunkRuns(session.events).map(record => JSON.stringify(record)),
  590. '',
  591. ].join('\n')
  592. }
  593. /**
  594. * Record-mode fixture write-back: harvest the live session, scrub request
  595. * headers to {{system}}/{{tools}} (TODO(web-header-pin): the web lane pins no
  596. * header class — a deliberate deviation logged in the Agent Note's deferred
  597. * work), tokenize the run-local session id, cwd, and browser RPC id
  598. * ({{sessionId}}/{{cwd}}/{{rpcId}}, the committed fixture convention —
  599. * re-records then diff only on real content), and write the fixture.
  600. * @param scaffold - the record-mode scaffold.
  601. * @param sessionId - the driven session.
  602. * @param fixturePath - the committed session.jsonl / seed.jsonl target.
  603. */
  604. export async function recordFixture(scaffold: WebScaffold, sessionId: SessionId, fixturePath: string): Promise<void> {
  605. const agent = scaffold.ctx.agents.get(sessionId)
  606. if (agent === undefined) throw new Error(`record harvest: no live agent for ${sessionId}`)
  607. const fresh = scrubRequestHeaders(rawSessionLog(agent.session))
  608. .split(sessionId).join('{{sessionId}}')
  609. .split(scaffold.workspaceCwd).join('{{cwd}}')
  610. .replace(/"rpcId":"[^"]+"/g, '"rpcId":"{{rpcId}}"')
  611. const existing = existsSync(fixturePath) ? await readFile(fixturePath, 'utf8') : ''
  612. const stable = stabilizeFixtureMessageIds([fresh], [existing])[0]
  613. if (stable === undefined) throw new Error('record harvest: no stabilized fixture')
  614. await writeFile(fixturePath, stable)
  615. }
  616. /**
  617. * The user prompts recorded in a fixture, in order — the single source tying
  618. * spec drive steps to recorded reality so script and fixture cannot drift.
  619. * @param fixtureText - raw session.jsonl contents.
  620. * @returns the recorded user prompt texts.
  621. */
  622. export function fixtureUserPrompts(fixtureText: string): string[] {
  623. return parseSessionLog(fixtureText).flatMap((event) => {
  624. if (event.type !== 'user/message' || event.data.source.kind !== 'user') return []
  625. const text = event.data.content.filter(block => block.type === 'text').map(block => block.text).join('')
  626. return text.length > 0 ? [text] : []
  627. })
  628. }
  629. /**
  630. * Seed a recorded session fixture into the scaffold's persistence root
  631. * through the REAL backend API (throwaway Context + SessionStore + JSONL
  632. * plugin — the semantic-checkpoint precedent), never raw file writes: no
  633. * knowledge of bucket hashing, filename encoding, or compression, and
  634. * malformed session events fail loud at seed time. The fixture's tokenized identity
  635. * ({{sessionId}}/{{cwd}}) is realized for this world before parsing.
  636. * @param scaffold - the target scaffold.
  637. * @param fixtureText - raw recorded session.jsonl contents.
  638. * @param id - the seeded session id (stable for deterministic goldens).
  639. * @param agentPreset - the preset the recorded session was composed from,
  640. * for scenarios asserting what a resumed session reports running.
  641. * @returns the seeded id.
  642. */
  643. /**
  644. * Realize a recorded seed fixture against one scaffold: substitute the
  645. * `{{sessionId}}`/`{{cwd}}` placeholders and rewrite the recorded cwd to the
  646. * scaffold's workspace. Idempotent, so a caller may realize early (e.g. to
  647. * price content exactly as the host will fold it) and still pass the result
  648. * through {@link seedSession}.
  649. * @param scaffold - the booted scaffold whose workspace the seed targets.
  650. * @param fixtureText - the committed seed fixture text.
  651. * @param id - the session id the seed is realized for.
  652. * @returns the realized fixture text.
  653. */
  654. export function realizeSeedFixture(scaffold: WebScaffold, fixtureText: string, id: string): string {
  655. const realized = fixtureText
  656. .split('{{sessionId}}').join(id)
  657. .split('{{cwd}}').join(scaffold.workspaceCwd)
  658. const fixtureCwd = (JSON.parse(realized.split('\n', 1)[0]!) as { cwd?: string }).cwd
  659. return fixtureCwd === undefined
  660. ? realized
  661. : realized.split(fixtureCwd).join(scaffold.workspaceCwd)
  662. }
  663. export async function seedSession(
  664. scaffold: WebScaffold,
  665. fixtureText: string,
  666. id: string,
  667. agentPreset?: string,
  668. ): Promise<SessionId> {
  669. const events = parseSessionLog(realizeSeedFixture(scaffold, fixtureText, id))
  670. if (events.length === 0) throw new Error('seed fixture has no events')
  671. const last = events[events.length - 1]!
  672. // An open final turn would be mutated by resume's crash repair on first
  673. // open; a committed seed must be a closed recording.
  674. if (last.type !== 'turn/end') throw new Error(`seed fixture must end in turn/end, got ${last.type}`)
  675. const meta: SessionHeader = {
  676. version: SESSION_FORMAT_VERSION,
  677. id: SessionId(id),
  678. createdAt: Date.now() - 60_000,
  679. cwd: scaffold.workspaceCwd,
  680. delegationDepth: 0,
  681. ...agentPreset === undefined ? {} : { agentPreset },
  682. }
  683. await persistSeedSession(scaffold, meta, events)
  684. return meta.id
  685. }
  686. /** Seed one materialized cold Session whose log has no turn/start event. */
  687. export async function seedBlankSession(
  688. scaffold: WebScaffold,
  689. id: string,
  690. cwd: string,
  691. ): Promise<SessionId> {
  692. const meta: SessionHeader = {
  693. version: SESSION_FORMAT_VERSION,
  694. id: SessionId(id),
  695. createdAt: Date.now() - 60_000,
  696. cwd,
  697. delegationDepth: 0,
  698. }
  699. await persistSeedSession(scaffold, meta, [{
  700. type: 'session/end-seed',
  701. seq: 0,
  702. time: meta.createdAt,
  703. data: {},
  704. }])
  705. return meta.id
  706. }
  707. /** Materialize one detached Session fixture through the shipped JSONL provider. */
  708. async function persistSeedSession(
  709. scaffold: WebScaffold,
  710. meta: SessionHeader,
  711. events: readonly SessionEvent[],
  712. ): Promise<void> {
  713. const seeder = new Context()
  714. try {
  715. await seeder.plugin(SessionStore)
  716. // Same root as the booted tree with the plugin's own default compression,
  717. // so the host's directory-scan list() sees one consistent encoding.
  718. await seeder.plugin(JsonlSessionPersistence, { root: scaffold.persistenceRoot })
  719. await seeder.sessionPersistence.create(meta)
  720. await seeder.sessionPersistence.append(meta.id, events)
  721. } finally {
  722. await seeder.fiber.dispose()
  723. }
  724. }
  725. /**
  726. * Normalize an aria snapshot: uuid, cwd, workspace-basename, duration,
  727. * decode-throughput, and path-sensitive compaction estimates collapse to
  728. * stable tokens.
  729. *
  730. * Throughput needs a token for the same reason durations do, and no fixture
  731. * can supply one: the figure divides a replayed step's output tokens by the
  732. * wall time the local run took to stream them, so it moves between two runs
  733. * on one machine (measured 69 → 70 tok/s) and swings wildly on a fast replay
  734. * (26333 tok/s for a 3 ms stream).
  735. */
  736. function normalizeAria(snapshot: string, workspaceCwd: string): string {
  737. // The session heading renders the workspace's basename, not the full
  738. // path, so both spellings must collapse to the token.
  739. const base = workspaceCwd.split('/').pop()!
  740. return snapshot
  741. .split(workspaceCwd).join('{{cwd}}')
  742. .split(base).join('{{workspace}}')
  743. .replace(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, '{{uuid}}')
  744. // The optional space in `\d+m ?\d+s` covers both minute spellings: the
  745. // stats line's compact `2m42s` and the message-chrome template's `2m 42s`.
  746. .replace(
  747. /~\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,
  748. duration => duration.startsWith('~') ? duration : '{{duration}}',
  749. )
  750. .replace(
  751. /约\d+(?:年(?:\d+个月)?|个月(?:\d+天)?)|\d+(?:天(?:\d+小时(?:\d+分\d+秒)?)?|小时\d+分\d+秒|分\d+秒|(?:\.\d+)?秒)/g,
  752. duration => duration.startsWith('约') ? duration : '{{duration}}',
  753. )
  754. .replace(/\d+(?:\.\d+)?(?= tok\/s(?!\w))/g, '{{throughput}}')
  755. // Seeded compaction prices realized file paths, whose length differs
  756. // between local worktrees and CI scratch directories.
  757. .replace(/(Compacted \d+ history items \(~)\d+( tokens\))/g, '$1{{tokens}}$2')
  758. // Message IconActions clocks widen by calendar day/year; collapse every
  759. // format so goldens stay stable across midnight and year changes.
  760. .replace(/\d{4}年\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
  761. .replace(/\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
  762. .replace(/(?<!\d)\d{1,2}:\d{2}:\d{2}(?:\.\d+)?(?:\s*[AP]M)?(?!\d)/gi, '{{clock}}')
  763. .replace(/(?<!\d)\d{2}:\d{2}(?!\d)/g, '{{clock}}')
  764. }
  765. /**
  766. * Capture the region's aria snapshot at a settled milestone: poll until two
  767. * consecutive normalized captures are equal — a single-shot capture races the
  768. * last React commits.
  769. * @param page - the page under test.
  770. * @param selector - the region locator selector.
  771. * @param workspaceCwd - normalization input.
  772. * @returns the stable normalized snapshot.
  773. */
  774. export async function captureStableAria(page: Page, selector: string, workspaceCwd: string): Promise<string> {
  775. const region = page.locator(selector).first()
  776. let previous = normalizeAria(await region.ariaSnapshot(), workspaceCwd)
  777. await expect.poll(async () => {
  778. const current = normalizeAria(await region.ariaSnapshot(), workspaceCwd)
  779. const stable = current === previous
  780. previous = current
  781. return stable
  782. }, { timeout: 5_000, message: 'aria snapshot did not stabilize' }).toBe(true)
  783. return previous
  784. }
  785. /**
  786. * Compare a normalized golden, or rewrite it under refresh. Refresh is the
  787. * ONLY writer: a missing golden in replay mode fails with the healing command
  788. * instead of silently self-bootstrapping.
  789. * @param goldenPath - the committed ui.expected.md path.
  790. * @param actual - the stable normalized snapshot.
  791. * @param mode - the active snapshot mode.
  792. */
  793. export async function compareOrRefreshGolden(goldenPath: string, actual: string, mode: WebSnapshotMode): Promise<void> {
  794. const payload = `${actual}\n`
  795. if (mode === 'refresh') {
  796. await writeFile(goldenPath, payload)
  797. return
  798. }
  799. if (!existsSync(goldenPath)) {
  800. throw new Error(`missing golden ${goldenPath} — run DSH_SNAPSHOT=refresh pnpm run test:web to generate it`)
  801. }
  802. expect(payload).toBe(await readFile(goldenPath, 'utf8'))
  803. }
  804. /**
  805. * Fixture-inventory guard: the scenario directory holds exactly the expected
  806. * files and every committed JSONL is a scrub fixed-point without a run-local
  807. * browser RPC id.
  808. * @param dir - the scenario snapshot directory.
  809. * @param expected - the exact expected file inventory.
  810. */
  811. export async function assertFixtureInventory(dir: string, expected: string[]): Promise<void> {
  812. const entries = (await readdir(dir)).sort()
  813. expect(entries).toEqual([...expected].sort())
  814. for (const entry of entries.filter(name => name.endsWith('.jsonl'))) {
  815. const content = await readFile(join(dir, entry), 'utf8')
  816. expect(scrubRequestHeaders(content), `${dir}/${entry} carries request-header bulk`).toBe(content)
  817. expect(content, `${dir}/${entry} carries a run-local rpcId`)
  818. .not.toMatch(/"rpcId":"(?!\{\{rpcId\}\})[^"]+"/)
  819. }
  820. }
  821. /**
  822. * Console tripwires: reconnect/gap-repair self-healing or a pageerror must
  823. * fail the scenario, not mask a dead wire behind eventual consistency.
  824. * @param page - the page under test.
  825. * @returns live warning/pageerror collectors to assert empty at scenario end.
  826. */
  827. export function watchConsole(page: Page): { warnings: string[]; pageErrors: string[] } {
  828. const warnings: string[] = []
  829. const pageErrors: string[] = []
  830. page.on('console', (message) => {
  831. const text = message.text()
  832. if (/connection lost|gap repair|discontinuous/i.test(text)) warnings.push(text)
  833. })
  834. page.on('pageerror', (error) => { pageErrors.push(String(error)) })
  835. return { warnings, pageErrors }
  836. }
  837. /**
  838. * Remove only connection-loss warnings emitted after an intentional reload.
  839. * Earlier warnings and all gap-repair/discontinuity warnings remain fatal.
  840. * @param tripwire - the live console-warning collector.
  841. * @param warningStart - warning count captured immediately before reloading.
  842. */
  843. export function acknowledgeReloadConnectionLoss(
  844. tripwire: ReturnType<typeof watchConsole>,
  845. warningStart: number,
  846. ): void {
  847. const reloadWarnings = tripwire.warnings.splice(warningStart)
  848. tripwire.warnings.push(...reloadWarnings.filter(text => !/connection lost/i.test(text)))
  849. }