scaffold.ts 42 KB

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