scaffold.ts 40 KB

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