scaffold.ts 42 KB

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