| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659 |
- // Shared scaffold for the keyless browser e2e lane (Agent Note:
- // .agents/notes/implemented/testing/2026-07-24-web-gui-browser-e2e-lane.md).
- // Boots the REAL web composition — the shipped base plus web overlay through
- // the vendored Loader (the same include boot AppCLIEntry drives), patched the
- // snapshot way — so a real chromium exercises the real HTTP uplink/WebSocket
- // downlink, api-gateway, agent loop, tools, and persistence. Modes ride $DSH_SNAPSHOT:
- // replay (default, keyless: normally disables the llm-deepseek row and
- // inserts dsh-llm-replay in providers mode), record (real adapter + key,
- // harvests fixtures from live session memory), refresh (keyless replay that
- // rewrites goldens). A first-run option keeps the real adapter mounted while
- // masking its credential, without making a model call.
- //
- // Composition divergences from `dsh web`, all deliberate, all via include
- // patches after the shipped surface overlay, over the SAME tree (never a
- // second yml): temp persistenceRoot; host-level skill roots confined to the
- // temp workspace while project skill discovery remains real; workspace-context
- // disabled (recorded fixtures must not embed this repo's AGENTS.md);
- // session-title-llm disabled (its fire-and-forget title call would race the
- // loop for the session's replay cursor); webserver pinned to port 0 with the
- // built dist; ordinary keyless modes disable llm-deepseek and fill the open
- // llm seam post-boot with installLlmReplay on the settled root ctx
- // (the plugin-row path discards the ReplayHandle; the direct install keeps
- // assertConsumed for the teardown fixture-consumption check).
- import { existsSync } from 'node:fs'
- import { mkdtemp, readFile, readdir, realpath, rm, utimes, writeFile } from 'node:fs/promises'
- import { tmpdir } from 'node:os'
- import { join, resolve } from 'node:path'
- import { pathToFileURL } from 'node:url'
- import type { Page } from 'playwright'
- import { expect } from 'vitest'
- import { Context } from 'cordis'
- import Loader from '@cordisjs/plugin-loader'
- import Include, { type PatchOptions } from '@cordisjs/plugin-include'
- import { scrubRequestHeaders } from '@deepseek-ai/dsh-acp-snapshot'
- import { assertEntriesLoaded, loadOverlayPatches } from '@deepseek-ai/dsh-app-boot'
- import { dshHomePath } from '@deepseek-ai/dsh-paths'
- import {
- WELCOME_NOTICE_ACK_FIELD, WELCOME_NOTICE_SETTINGS_NAMESPACE, WELCOME_NOTICE_VERSION,
- } from '@deepseek-ai/dsh-client-ui-settings-general'
- import { settingsNamespace } from '@deepseek-ai/dsh-settings'
- import type { ReplayHandle } from '@deepseek-ai/dsh-llm-replay'
- import { installLlmReplay, parseSessionLog } from '@deepseek-ai/dsh-llm-replay'
- import SessionStore, {
- packChunkRuns,
- SESSION_FORMAT_VERSION,
- SessionId,
- type Session,
- type SessionEvent,
- type SessionHeader,
- } from '@deepseek-ai/dsh-session'
- import SessionPersistenceJsonl from '@deepseek-ai/dsh-session-persistence-jsonl'
- import * as ToolCordis from '@deepseek-ai/dsh-tool-cordis'
- // Empty type imports carry the httpServer/agents/sessionPersistence Context merges.
- import type {} from '@deepseek-ai/dsh-host-webserver'
- import type {} from '@deepseek-ai/dsh-agent'
- import { prepareWebRuntimeContext } from '../../cli/src/web.ts'
- import { DIST_INDEX, REPO_ROOT, requireDist } from './support.ts'
- /** Snapshot mode for the lane, from $DSH_SNAPSHOT (same vocabulary as the other snapshot suites). */
- export type WebSnapshotMode = 'replay' | 'record' | 'refresh'
- /**
- * Resolve and validate the lane's snapshot mode.
- * @returns the active mode; unset/empty selects replay.
- */
- export function webSnapshotMode(): WebSnapshotMode {
- const value = process.env.DSH_SNAPSHOT
- if (value === undefined || value === '' || value === 'replay') return 'replay'
- if (value === 'record' || value === 'refresh') return value
- throw new Error(`DSH_SNAPSHOT must be replay, record, or refresh; got ${JSON.stringify(value)}`)
- }
- /** The shipped composition under test: apps/cli's shared base and web overlay. */
- const CONFIG_PATH = join(REPO_ROOT, 'apps/cli/config/base.cordis.yml')
- const WEB_OVERLAY_PATH = join(REPO_ROOT, 'apps/cli/config/web.cordis.yml')
- // Replay publishes the provider catalog the gateway routes to (providers
- // mode, never catch-all: with llm-deepseek disabled no adapter exists, so a
- // catch-all would leave resolveModelInfo unroutable and compact-basic's
- // post-step pressure check would warn every step). The published
- // contextWindow keeps that pressure path provably inert for small fixtures.
- const REPLAY_PROVIDERS = [{
- id: 'deepseek-official',
- name: 'DeepSeek',
- models: [{ id: 'deepseek-v4-flash', name: 'DeepSeek-V4-Flash', contextWindow: 128_000 }],
- }]
- function replayProviders(contextWindow: number | undefined): typeof REPLAY_PROVIDERS {
- if (contextWindow === undefined) return REPLAY_PROVIDERS
- return REPLAY_PROVIDERS.map(provider => ({
- ...provider,
- models: provider.models.map(model => ({ ...model, contextWindow })),
- }))
- }
- /** A booted web scaffold: real composition, mode-selected model backend, temp world. */
- export interface WebScaffold {
- /** The active snapshot mode this scaffold booted under. */
- mode: WebSnapshotMode
- /** Browser-facing origin for the bound test server. */
- baseUrl: string
- /** Settled root context (the in-process barrier seam; headless event subscription is its sanctioned use). */
- ctx: Context
- /** Temp project directory sessions run in (bash/fs tool cwd). */
- workspaceCwd: string
- /** Temp persistence root (seeded sessions land here through the real API). */
- persistenceRoot: string
- /** Isolated harness home the settings/credentials rows write ($DSH_HOME double). */
- harnessHome: string
- /** Await a settled turn end: in-process turn/end, then the agent's idle flip (which follows the persistence flush). */
- whenTurnSettled(timeoutMs?: number): Promise<SessionId>
- /** Tear everything down; asserts the replay fixture was fully consumed first (replay/refresh). */
- close(): Promise<void>
- }
- /** Options for {@link launchWebScaffold}. */
- export interface LaunchOptions {
- /**
- * Optional product overlay applied after the shipped Web surface and before
- * the scaffold's hermetic test patches, matching AppCLIEntry's `--config`
- * ordering.
- */
- extraOverlayPath?: string
- /**
- * Replay fixture (session.jsonl) served by the inserted dsh-llm-replay row
- * in replay/refresh modes; ignored in record mode (the real adapter
- * answers). Omit for scenarios issuing no model calls — a stray stream then
- * fails loud with NO_ADAPTER (llm-deepseek is disabled and no replay row
- * mounts).
- */
- replayFixture?: string
- /**
- * Recorded child logs assigned in child creation order. Each child owns its
- * own positional replay cursor across initial and continuation turns.
- */
- replayChildFixtures?: string[]
- /**
- * Optional replay.override.json sidecar (whole-script replacement or
- * `{ patches }` augmentation) for throw/hang scenarios not expressible as
- * recorded chunks; replay/refresh only.
- */
- replayOverride?: string
- /** Per-chunk replay pacing (ms) so the browser observes genuinely incremental SSE; replay/refresh only. */
- paceMs?: number
- /** Synthetic model capacity for UI scenarios whose seeded history must remain uncompacted. */
- replayContextWindow?: number
- /**
- * Tool presentation mode patched onto the shipped `tools` row (`code`
- * collapses the wire to run_code + the SDK prompt section). Omit for the
- * yml default. The code runtime row is always in the tree, so no extra
- * insertion is needed.
- */
- toolsMode?: 'native' | 'code' | 'both'
- /**
- * Insert the opt-in self-referential Cordis tools into the shipped tree.
- * Record and replay use the same tool surface, so captured request headers
- * remain reconstructable without making the tools a product default.
- */
- cordisTools?: boolean
- /**
- * Keep the shipped DeepSeek adapter mounted while masking the process
- * environment's DEEPSEEK_API_KEY for this scaffold lifetime. This is the
- * keyless first-run configuration lane; the default disables the adapter.
- */
- deepSeekMissingCredential?: boolean
- /**
- * Patch the shipped DeepSeek search row to a deterministic endpoint and
- * credential reference. Browser search scenarios keep the real provider and
- * credentials seam while avoiding external search traffic and ambient keys.
- */
- deepSeekSearch?: {
- /** Anthropic-compatible base URL; the provider appends `/messages`. */
- baseURL: string
- /** Credential reference resolved by the shipped search provider. */
- apiKeyEnv: string
- }
- /** Leave the current welcome notice unacknowledged; ordinary scenarios publish it as complete before browser boot. */
- welcomeNoticePending?: boolean
- /**
- * Browse through a trusted non-loopback hostname that the browser resolves
- * to loopback (for example `*.localhost`). The test server stays bound to
- * 127.0.0.1; a non-resolving authority fails before Host trust is exercised.
- */
- remoteAuthority?: string
- }
- /** Dispose the booted tree and remove both owned temp roots, reporting every independent cleanup failure. */
- async function cleanupScaffoldWorld(ctx: Context, workspaceCwd: string, persistenceRoot: string): Promise<unknown[]> {
- const failures: unknown[] = []
- await Promise.resolve(ctx.fiber.dispose()).catch((error: unknown) => failures.push(error))
- await rm(workspaceCwd, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
- await rm(persistenceRoot, { recursive: true, force: true }).catch((error: unknown) => failures.push(error))
- return failures
- }
- /**
- * Boot the real web composition under the current snapshot mode.
- * @param options - replay fixture selection and pacing.
- * @returns the running scaffold.
- */
- export async function launchWebScaffold(options: LaunchOptions = {}): Promise<WebScaffold> {
- requireDist()
- const mode = webSnapshotMode()
- const browserHost = options.remoteAuthority ?? '127.0.0.1'
- if (mode === 'record') {
- // Both owning vitest configs (web unconditionally, snapshot in record
- // mode) load the repo-root .env before this file runs.
- if (process.env.DEEPSEEK_API_KEY === undefined || process.env.DEEPSEEK_API_KEY.length === 0) {
- throw new Error('web e2e record mode needs DEEPSEEK_API_KEY (env or repo-root .env)')
- }
- }
- if (mode === 'record' && options.deepSeekMissingCredential === true) {
- throw new Error('deepSeekMissingCredential is a keyless replay/refresh option')
- }
- const maskDeepSeekCredential = mode !== 'record' && options.deepSeekMissingCredential === true
- const originalDeepSeekCredential = process.env.DEEPSEEK_API_KEY
- let credentialEnvironmentRestored = false
- const restoreCredentialEnvironment = (): void => {
- if (credentialEnvironmentRestored || !maskDeepSeekCredential) return
- credentialEnvironmentRestored = true
- if (originalDeepSeekCredential === undefined) {
- Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
- } else {
- process.env.DEEPSEEK_API_KEY = originalDeepSeekCredential
- }
- }
- const workspaceCwd = await realpath(await mkdtemp(join(tmpdir(), 'dsh-web-e2e-ws-')))
- // Isolated harness home: the settings/credentials rows resolve $DSH_HOME
- // paths at load, and an in-process boot must NEVER touch the developer's
- // real ~/.dsh document or credential file.
- const harnessHome = join(workspaceCwd, '.dsh-home')
- let persistenceRoot: string
- try {
- persistenceRoot = await mkdtemp(join(tmpdir(), 'dsh-web-e2e-sessions-'))
- } catch (error) {
- const failures: unknown[] = [error]
- await rm(workspaceCwd, { recursive: true, force: true }).catch((cleanupError: unknown) => failures.push(cleanupError))
- if (failures.length > 1) throw new AggregateError(failures, 'web scaffold temp-root setup failed')
- throw error
- }
- if (maskDeepSeekCredential) Reflect.deleteProperty(process.env, 'DEEPSEEK_API_KEY')
- // The include patch set — the same mechanism AppCLIEntry and the ACP
- // snapshot overlay use, applied over the SAME shipped tree (a patch id that
- // stops matching a row fails the boot sweep loudly instead of drifting).
- const surfacePatches = loadOverlayPatches('web e2e scaffold', WEB_OVERLAY_PATH)
- const extraOverlayPatches = options.extraOverlayPath === undefined
- ? []
- : loadOverlayPatches('web e2e scaffold', options.extraOverlayPath)
- const patches: PatchOptions[] = [
- ...surfacePatches,
- ...extraOverlayPatches,
- { id: 'session-persistence-jsonl', config: { root: persistenceRoot } },
- { id: 'session-query-sqlite', config: { path: ':memory:', openAt: 'first-search' } },
- // storage-json's yml root is anchored to the real $DSH_HOME; pin the row
- // to an absolute temp root (removed with the workspace at close) so tests
- // never write the user's harness home.
- { id: 'storage-json', config: { root: join(workspaceCwd, '.dsh-storages') } },
- // Skill discovery is model-visible input. Pin every host-level root inside
- // the owned temp world so ~/.dsh, ~/.agents, and a bundled-root env setting
- // cannot change replay requests or conversation goldens. Project roots stay
- // enabled against the same empty temp workspace, preserving the real seam.
- {
- id: 'skill-local',
- config: {
- dshHome: join(workspaceCwd, '.dsh-home'),
- agentsHome: join(workspaceCwd, '.agents-home'),
- bundledSkillDir: join(workspaceCwd, '.bundled-skills'),
- watch: false,
- },
- },
- // fs/bash cwd default to process.cwd(); the gateway injects the same
- // value into session.cwd — chdir below anchors all three to the temp
- // workspace, keeping the composition untouched.
- { id: 'workspace-context', disabled: true },
- { id: 'session-title-llm', disabled: true },
- // Fixture sessions must never leave the process: the shipped row defaults
- // to the production OTLP endpoint (or whatever DSH_TELEMETRY_OTLP_URL
- // names in the ambient environment).
- { id: 'telemetry-otel', disabled: true },
- {
- id: 'webserver',
- config: { host: '127.0.0.1', port: 0, distIndex: DIST_INDEX },
- },
- ...options.remoteAuthority === undefined
- ? []
- : [{ id: 'connection', config: { trustedHosts: [options.remoteAuthority] } }],
- { id: 'settings', config: { dshHome: harnessHome } },
- { id: 'credentials', config: { dshHome: harnessHome } },
- // The shipped directory-picker row is the -auto chooser, which resolves
- // the interaction from the RUNNING host (display, SSH launch, bind). The
- // lane's goldens are interaction-specific (workspace-management drives
- // the in-app browse dialog), so pin -browse deterministically on every
- // host: patch `name` is an assertion, not an override, hence the
- // disable+insert pair.
- { id: 'directory-picker', disabled: true },
- { insert: [{ id: 'directory-picker-browse', name: '@deepseek-ai/dsh-host-directory-picker-browse' }] },
- ...options.toolsMode === undefined ? [] : [{ id: 'tools', config: { mode: options.toolsMode } }],
- ...options.cordisTools === true
- ? [{ insert: [{ id: 'tool-cordis', name: 'cordis:tool-cordis' }] }]
- : [],
- ...options.deepSeekSearch === undefined
- ? []
- : [{
- id: 'web-search-deepseek',
- config: {
- apiKeyEnv: options.deepSeekSearch.apiKeyEnv,
- baseURL: options.deepSeekSearch.baseURL,
- },
- }],
- ...mode === 'record' || options.deepSeekMissingCredential === true
- ? []
- : [{ id: 'llm-deepseek', disabled: true }],
- ]
- // Sessions inherit the gateway's process.cwd() default; run the boot from
- // the temp workspace so tool cwd, session cwd, and fixtures agree.
- const originalCwd = process.cwd()
- const ctx = new Context()
- let port = 0
- let replayHandle: ReplayHandle | undefined
- try {
- process.chdir(workspaceCwd)
- ctx.baseUrl = pathToFileURL(join(resolve(CONFIG_PATH), '..')).href + '/'
- // This direct Loader harness supplies the same root-path capability as app-boot.
- ctx.provide('dshHomePath', dshHomePath)
- await ctx.plugin(Loader)
- ctx.loader.builtins.include = Include
- // The shipped CLI deliberately has no dependency on this opt-in package.
- // Keep the Loader row real without broadening the product installation.
- if (options.cordisTools === true) ctx.loader.builtins['tool-cordis'] = ToolCordis
- prepareWebRuntimeContext(ctx, REPO_ROOT, 'production')
- await ctx.loader.create({
- name: 'cordis:include',
- config: { path: pathToFileURL(resolve(CONFIG_PATH)).href, patches },
- })
- await ctx.loader.await()
- assertEntriesLoaded(ctx, 'web e2e scaffold')
- if (options.welcomeNoticePending !== true) {
- await ctx.settings.mutate(settingsNamespace(WELCOME_NOTICE_SETTINGS_NAMESPACE), [{
- op: 'set', path: [WELCOME_NOTICE_ACK_FIELD], value: WELCOME_NOTICE_VERSION,
- }])
- }
- const boundPort = ctx.get('httpServer')?.port
- if (boundPort === undefined) {
- throw new Error('web e2e scaffold: httpServer service missing after settled boot')
- }
- port = boundPort
- // Fill the open llm seam on the settled root ctx. Ordinary keyless modes
- // disable llm-deepseek; the first-run lane keeps it mounted but has no
- // replay fixture and never streams. The direct install, unlike the plugin
- // row, returns the ReplayHandle for the teardown consumption check.
- if (mode !== 'record' && options.replayFixture !== undefined) {
- replayHandle = installLlmReplay(ctx, {
- file: options.replayFixture,
- providers: replayProviders(options.replayContextWindow),
- ...(options.replayOverride === undefined ? {} : { overrideFile: options.replayOverride }),
- ...(options.replayChildFixtures === undefined ? {} : { childFiles: options.replayChildFixtures }),
- ...(options.paceMs === undefined ? {} : { paceMs: options.paceMs }),
- })
- }
- } catch (error) {
- if (process.cwd() !== originalCwd) process.chdir(originalCwd)
- const cleanupFailures = await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot)
- restoreCredentialEnvironment()
- if (cleanupFailures.length > 0) {
- throw new AggregateError([error, ...cleanupFailures], 'web scaffold setup failed and cleanup was incomplete')
- }
- throw error
- } finally {
- if (process.cwd() !== originalCwd) process.chdir(originalCwd)
- }
- return {
- harnessHome,
- mode,
- baseUrl: `http://${browserHost}:${port}`,
- ctx,
- workspaceCwd,
- persistenceRoot,
- // Barrier stack: the in-process turn/end identifies the session, its
- // explicit flush makes the transcript durable, and the caller's browser
- // settled-poll comes last because host completion strictly precedes render.
- whenTurnSettled(timeoutMs = mode === 'record' ? 180_000 : 30_000): Promise<SessionId> {
- return new Promise<SessionId>((resolveSettled, reject) => {
- const timer = setTimeout(() => {
- off()
- reject(new Error(`no turn/end within ${timeoutMs}ms`))
- }, timeoutMs)
- const off = ctx.on('session/event', (session: Session, event: SessionEvent) => {
- if (event.type !== 'turn/end') return
- clearTimeout(timer)
- off()
- ctx.sessions.flush(session)
- .then(() => { resolveSettled(session.id) }, reject)
- })
- })
- },
- async close(): Promise<void> {
- const failures: unknown[] = []
- // Fixture-consumption check first, while the run's binding state is
- // still authoritative — a scenario that drove fewer model calls than
- // recorded fails here instead of drifting green.
- try {
- replayHandle?.assertConsumed()
- } catch (error) {
- failures.push(error)
- }
- try {
- failures.push(...await cleanupScaffoldWorld(ctx, workspaceCwd, persistenceRoot))
- } finally {
- restoreCredentialEnvironment()
- }
- if (failures.length > 0) throw new AggregateError(failures, 'web scaffold teardown failed')
- },
- }
- }
- /**
- * Serialize a live session to the canonical raw session-JSONL layout — the
- * in-memory record-mode harvest, so the on-disk zstd default never matters.
- */
- function rawSessionLog(session: Session): string {
- return [
- JSON.stringify({ type: 'session', ...session.header }),
- ...packChunkRuns(session.events).map(record => JSON.stringify(record)),
- '',
- ].join('\n')
- }
- /**
- * Record-mode fixture write-back: harvest the live session, scrub request
- * headers to {{system}}/{{tools}} (TODO(web-header-pin): the web lane pins no
- * header class — a deliberate deviation logged in the Agent Note's deferred
- * work), tokenize the run-local session id, cwd, and browser RPC id
- * ({{sessionId}}/{{cwd}}/{{rpcId}}, the committed fixture convention —
- * re-records then diff only on real content), and write the fixture.
- * @param scaffold - the record-mode scaffold.
- * @param sessionId - the driven session.
- * @param fixturePath - the committed session.jsonl / seed.jsonl target.
- */
- export async function recordFixture(scaffold: WebScaffold, sessionId: SessionId, fixturePath: string): Promise<void> {
- const agent = scaffold.ctx.agents.get(sessionId)
- if (agent === undefined) throw new Error(`record harvest: no live agent for ${sessionId}`)
- const tokenized = scrubRequestHeaders(rawSessionLog(agent.session))
- .split(sessionId).join('{{sessionId}}')
- .split(scaffold.workspaceCwd).join('{{cwd}}')
- .replace(/"rpcId":"[^"]+"/g, '"rpcId":"{{rpcId}}"')
- await writeFile(fixturePath, tokenized)
- }
- /**
- * The user prompts recorded in a fixture, in order — the single source tying
- * spec drive steps to recorded reality so script and fixture cannot drift.
- * @param fixtureText - raw session.jsonl contents.
- * @returns the recorded user prompt texts.
- */
- export function fixtureUserPrompts(fixtureText: string): string[] {
- return parseSessionLog(fixtureText).flatMap((event) => {
- if (event.type !== 'user/message' || event.data.source.kind !== 'user') return []
- const text = event.data.content.filter(block => block.type === 'text').map(block => block.text).join('')
- return text.length > 0 ? [text] : []
- })
- }
- /**
- * Seed a recorded session fixture into the scaffold's persistence root
- * through the REAL backend API (throwaway Context + SessionStore + JSONL
- * plugin — the semantic-checkpoint precedent), never raw file writes: no
- * knowledge of bucket hashing, filename encoding, or compression, and
- * malformed shapes fail loud at seed time. The fixture's tokenized identity
- * ({{sessionId}}/{{cwd}}) is realized for this world before parsing.
- * @param scaffold - the target scaffold.
- * @param fixtureText - raw recorded session.jsonl contents.
- * @param id - the seeded session id (stable for deterministic goldens).
- * @returns the seeded id.
- */
- /**
- * Realize a recorded seed fixture against one scaffold: substitute the
- * `{{sessionId}}`/`{{cwd}}` placeholders and rewrite the recorded cwd to the
- * scaffold's workspace. Idempotent, so a caller may realize early (e.g. to
- * price content exactly as the host will fold it) and still pass the result
- * through {@link seedSession}.
- * @param scaffold - the booted scaffold whose workspace the seed targets.
- * @param fixtureText - the committed seed fixture text.
- * @param id - the session id the seed is realized for.
- * @returns the realized fixture text.
- */
- export function realizeSeedFixture(scaffold: WebScaffold, fixtureText: string, id: string): string {
- const realized = fixtureText
- .split('{{sessionId}}').join(id)
- .split('{{cwd}}').join(scaffold.workspaceCwd)
- const fixtureCwd = (JSON.parse(realized.split('\n', 1)[0]!) as { cwd?: string }).cwd
- return fixtureCwd === undefined
- ? realized
- : realized.split(fixtureCwd).join(scaffold.workspaceCwd)
- }
- export async function seedSession(scaffold: WebScaffold, fixtureText: string, id: string): Promise<SessionId> {
- const events = parseSessionLog(realizeSeedFixture(scaffold, fixtureText, id))
- if (events.length === 0) throw new Error('seed fixture has no events')
- const last = events[events.length - 1]!
- // An open final turn would be mutated by resume's crash repair on first
- // open; a committed seed must be a closed recording.
- if (last.type !== 'turn/end') throw new Error(`seed fixture must end in turn/end, got ${last.type}`)
- const meta: SessionHeader = {
- version: SESSION_FORMAT_VERSION,
- id: SessionId(id),
- createdAt: Date.now() - 60_000,
- cwd: scaffold.workspaceCwd,
- delegationDepth: 0,
- }
- const seeder = new Context()
- try {
- await seeder.plugin(SessionStore)
- // Same root as the booted tree with the plugin's own default compression,
- // so the host's directory-scan list() sees one consistent encoding.
- await seeder.plugin(SessionPersistenceJsonl, { root: scaffold.persistenceRoot })
- await seeder.sessionPersistence.create(meta)
- await seeder.sessionPersistence.append(meta.id, events)
- // Deterministic sidebar order: cold summaries take updatedAt from mtime.
- const located = seeder.sessionPersistence.locate(meta)
- if (located !== undefined) {
- const backdated = new Date(meta.createdAt)
- await utimes(located.path, backdated, backdated)
- }
- } finally {
- await seeder.fiber.dispose()
- }
- return meta.id
- }
- /**
- * Normalize an aria snapshot: uuid, cwd, workspace-basename, duration, and
- * decode-throughput volatility collapse to stable tokens.
- *
- * Throughput needs a token for the same reason durations do, and no fixture
- * can supply one: the figure divides a replayed step's output tokens by the
- * wall time the local run took to stream them, so it moves between two runs
- * on one machine (measured 69 → 70 tok/s) and swings wildly on a fast replay
- * (26333 tok/s for a 3 ms stream).
- */
- function normalizeAria(snapshot: string, workspaceCwd: string): string {
- // The session heading renders the workspace's basename, not the full
- // path, so both spellings must collapse to the token.
- const base = workspaceCwd.split('/').pop()!
- return snapshot
- .split(workspaceCwd).join('{{cwd}}')
- .split(base).join('{{workspace}}')
- .replace(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, '{{uuid}}')
- // The optional space in `\d+m ?\d+s` covers both minute spellings: the
- // stats line's compact `2m42s` and the message-chrome template's `2m 42s`.
- .replace(
- /~\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,
- duration => duration.startsWith('~') ? duration : '{{duration}}',
- )
- .replace(
- /约\d+(?:年(?:\d+个月)?|个月(?:\d+天)?)|\d+(?:天(?:\d+小时(?:\d+分\d+秒)?)?|小时\d+分\d+秒|分\d+秒|(?:\.\d+)?秒)/g,
- duration => duration.startsWith('约') ? duration : '{{duration}}',
- )
- .replace(/\d+(?:\.\d+)?(?= tok\/s(?!\w))/g, '{{throughput}}')
- // Message IconActions clocks widen by calendar day/year; collapse every
- // shape so goldens stay stable across midnight and year boundaries.
- .replace(/\d{4}年\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
- .replace(/\d{1,2}月\d{1,2}日 \d{2}:\d{2}/g, '{{clock}}')
- .replace(/(?<!\d)\d{1,2}:\d{2}:\d{2}(?:\.\d+)?(?:\s*[AP]M)?(?!\d)/gi, '{{clock}}')
- .replace(/(?<!\d)\d{2}:\d{2}(?!\d)/g, '{{clock}}')
- }
- /**
- * Capture the region's aria snapshot at a settled milestone: poll until two
- * consecutive normalized captures are equal — a single-shot capture races the
- * last React commits.
- * @param page - the page under test.
- * @param selector - the region locator selector.
- * @param workspaceCwd - normalization input.
- * @returns the stable normalized snapshot.
- */
- export async function captureStableAria(page: Page, selector: string, workspaceCwd: string): Promise<string> {
- const region = page.locator(selector).first()
- let previous = normalizeAria(await region.ariaSnapshot(), workspaceCwd)
- await expect.poll(async () => {
- const current = normalizeAria(await region.ariaSnapshot(), workspaceCwd)
- const stable = current === previous
- previous = current
- return stable
- }, { timeout: 5_000, message: 'aria snapshot did not stabilize' }).toBe(true)
- return previous
- }
- /**
- * Compare a normalized golden, or rewrite it under refresh. Refresh is the
- * ONLY writer: a missing golden in replay mode fails with the healing command
- * instead of silently self-bootstrapping.
- * @param goldenPath - the committed ui.expected.md path.
- * @param actual - the stable normalized snapshot.
- * @param mode - the active snapshot mode.
- */
- export async function compareOrRefreshGolden(goldenPath: string, actual: string, mode: WebSnapshotMode): Promise<void> {
- const payload = `${actual}\n`
- if (mode === 'refresh') {
- await writeFile(goldenPath, payload)
- return
- }
- if (!existsSync(goldenPath)) {
- throw new Error(`missing golden ${goldenPath} — run DSH_SNAPSHOT=refresh pnpm run test:web to generate it`)
- }
- expect(payload).toBe(await readFile(goldenPath, 'utf8'))
- }
- /**
- * Fixture-inventory guard: the scenario directory holds exactly the expected
- * files and every committed JSONL is a scrub fixed-point without a run-local
- * browser RPC id.
- * @param dir - the scenario snapshot directory.
- * @param expected - the exact expected file inventory.
- */
- export async function assertFixtureInventory(dir: string, expected: string[]): Promise<void> {
- const entries = (await readdir(dir)).sort()
- expect(entries).toEqual([...expected].sort())
- for (const entry of entries.filter(name => name.endsWith('.jsonl'))) {
- const content = await readFile(join(dir, entry), 'utf8')
- expect(scrubRequestHeaders(content), `${dir}/${entry} carries request-header bulk`).toBe(content)
- expect(content, `${dir}/${entry} carries a run-local rpcId`)
- .not.toMatch(/"rpcId":"(?!\{\{rpcId\}\})[^"]+"/)
- }
- }
- /**
- * Console tripwires: reconnect/gap-repair self-healing or a pageerror must
- * fail the scenario, not mask a dead wire behind eventual consistency.
- * @param page - the page under test.
- * @returns live warning/pageerror collectors to assert empty at scenario end.
- */
- export function watchConsole(page: Page): { warnings: string[]; pageErrors: string[] } {
- const warnings: string[] = []
- const pageErrors: string[] = []
- page.on('console', (message) => {
- const text = message.text()
- if (/connection lost|gap repair|discontinuous/i.test(text)) warnings.push(text)
- })
- page.on('pageerror', (error) => { pageErrors.push(String(error)) })
- return { warnings, pageErrors }
- }
- /**
- * Remove only connection-loss warnings emitted after an intentional reload.
- * Earlier warnings and all gap-repair/discontinuity warnings remain fatal.
- * @param tripwire - the live console-warning collector.
- * @param warningStart - warning count captured immediately before reloading.
- */
- export function acknowledgeReloadConnectionLoss(
- tripwire: ReturnType<typeof watchConsole>,
- warningStart: number,
- ): void {
- const reloadWarnings = tripwire.warnings.splice(warningStart)
- tripwire.warnings.push(...reloadWarnings.filter(text => !/connection lost/i.test(text)))
- }
|