fix(snapshot): stabilize refresh volatiles
This commit is contained in:
Dudu-0223
@@ -1,6 +1,6 @@
|
||||
# Bilingual-pair consistency record (docs/i18n/README.md): the git blob hash of each
|
||||
# side as of the last confirmed-consistent state. Both languages carry equal authority;
|
||||
# after editing either side, bring the other along and re-record with:
|
||||
# pnpm run verify-translation-pairing --write
|
||||
README.md: d35872e5bb06be88dc5999bfa1800083b2fbbf3c
|
||||
README.zh.md: a706b6db5408538c578cb2a1cfc3aa99804a930d
|
||||
# pnpm run verify-translation-pairing --write packages/support/acp-snapshot/README.md
|
||||
README.md: 682ab478a2e7453fa18769de93ff88a9a5316317
|
||||
README.zh.md: 8e67b9fbe3b6f66df303a1f4bbfaf1de46b64a8f
|
||||
|
||||
@@ -9,7 +9,7 @@ Four layers, importable separately:
|
||||
- **`launchAcpTestAgent` (launcher)** — boots a source agent under tsx or a built `lib` agent under plain Node from a supplied cwd, connects the SDK client over a raw-byte stdout tee, collects session updates and stderr, surfaces asynchronous spawn failures through startup, fails closed on unhandled permission requests, and owns graceful or signalled shutdown. Shutdown waits for process exit, inherited stdio closure, and ACP parser exhaustion before resolving or propagating a child error, so captures are complete and callers can remove owned paths after either outcome. When Windows accepts forced termination but publishes its exit marker asynchronously, shutdown gives that marker a bounded grace before treating fallback refusal as a second failure. Snapshot and ordinary e2e suites share this process boundary; a test supplies only agent paths, cwd, environment overrides, and any permission policy.
|
||||
- **`runScenario` (harness)** — drives ACP JSON-RPC stdio from a deterministic `input.json` script through the launcher, tees raw stdout for the expected-output and purity checks, and harvests every persisted raw JSONL session log (parent and subagent children, primary-first) after graceful stdin EOF. `AgentUnderTest` supplies absolute `binScript`, optional `libBinScript`, `configPath`, and `tsconfigPath` paths because the subprocess cwd is outside the repo; `workspaceParent` may move the generated child cwd from the platform temp directory when that grant is itself under test. Startup failures preserve captured agent stderr in the rejected diagnostic.
|
||||
- **Normalizers** — pure functions turning the two captured surfaces into stable text: `normalizeStdout` (JSON-RPC ids → first-seen sequence; UUIDs and every native/JavaScript filesystem spelling of the generated cwd → tokens, longest-first; cwd-rooted separators selected as canonical `/` or host-native; doubles as the stdout-purity check), `normalizeSessionLog` (times zeroed, `seq` kept, the same cwd-path policy), `scrubSystemPrompts` (prompt text → `{{system}}`), `scrubToolSchemas` (schema bulk → `{{tools}}`), and `scrubRequestHeaders` (all header bulk → `{{system}}`/`{{tools}}`/`{{messagePrefix}}` outside each pin, structure kept — [pinned-header Agent Note](../../../.agents/notes/archived/testing/2026-07-06-pin-request-header-content-in-one-scenario.md)).
|
||||
- **`defineAcpSnapshotSuite` (factory)** — registers the whole describe/it tree for a scenario table: per-scenario expected-output and re-persisted-log comparisons, record/refresh fixture write-back, rejection of structured `UNKNOWN_TOOL` results, the per-header-class pin (`system-prompt.expected.md` plus `tool-schemas.expected.json`) with its live uniformity guard, and the fixture guard block (no orphan scenario dirs, required files present, exactly one pin per class, every JSONL prompt/schema-scrubbed, non-pinning fixtures fully header-scrubbed). Refresh expands packed timing envelopes before aligning existing volatile event times, so switching between packed and unpacked layouts cannot shift later records; fresh chunk-fragment arrays remain authoritative. A newly inserted `session/title` receives its preceding event's time so feature-driven insertions do not churn the remainder of a fixture. Each scenario directory's `session.jsonl` plus contiguous `session.<n>.jsonl` siblings are the ordered primary/child inventory; the scenario table does not duplicate their count. Must be called at vitest collection time.
|
||||
- **`defineAcpSnapshotSuite` (factory)** — registers the whole describe/it tree for a scenario table: per-scenario expected-output and re-persisted-log comparisons, record/refresh fixture write-back, rejection of structured `UNKNOWN_TOOL` results, the per-header-class pin (`system-prompt.expected.md` plus `tool-schemas.expected.json`) with its live uniformity guard, and the fixture guard block (no orphan scenario dirs, required files present, exactly one pin per class, every JSONL prompt/schema-scrubbed, non-pinning fixtures fully header-scrubbed). Refresh reuses normalized-equivalent leaves from aligned existing records while fresh semantic values remain authoritative; it also expands packed timing envelopes before aligning event times, so switching between packed and unpacked layouts cannot shift later records. A newly inserted `session/title` receives its preceding event's time so feature-driven insertions do not churn the remainder of a fixture. Each scenario directory's `session.jsonl` plus contiguous `session.<n>.jsonl` siblings are the ordered primary/child inventory; the scenario table does not duplicate their count. Must be called at vitest collection time.
|
||||
|
||||
Committed session fixtures use canonical packed rows. An in-flight branch that merges this contract runs the [temporary repository migrator](../../../scripts/migrate-packed-session-fixtures.ts) with `pnpm run migrate:packed-session-fixtures`; its [removal proposal](../../../.agents/notes/proposed/process/2026-07-26-remove-packed-session-fixture-migrator.md) owns deletion after affected branches converge.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ ACP 快照套件工具包：无密钥快照层（`pnpm run test:snapshot`，见[
|
||||
- **`launchAcpTestAgent`（启动器）**：从指定 cwd 在 tsx 下启动源 agent，或在普通 Node 下启动已构建 `lib` agent；通过原始字节 stdout tee 连接 SDK 客户端，收集会话更新和 stderr，在启动过程中公开异步 spawn 失败，对未处理权限请求快速失败，并负责优雅或带信号关闭。关闭会等待进程退出、继承 stdio 关闭和 ACP parser 耗尽，然后才解析或传播子级错误，使捕获内容完整，且调用方可在任一结果后移除自有路径。当 Windows 接受强制终止但异步发布退出标记时，关闭会给该标记有界宽限，然后才将回退拒绝视为第二次失败。快照和普通 e2e 套件共享该进程边界；测试只需提供 agent 路径、cwd、环境覆盖和任何权限策略。
|
||||
- **`runScenario`（harness）**：通过启动器从确定性 `input.json` 脚本驱动 ACP JSON-RPC stdio，将原始 stdout tee 给预期输出和纯度检查，并在优雅 stdin EOF 后收集每个持久化原始 JSONL 会话日志（父级和 subagent 子级，主级优先）。`AgentUnderTest` 提供绝对 `binScript`、可选 `libBinScript`、`configPath` 和 `tsconfigPath` 路径，因为子进程 cwd 位于仓库外。当生成子级 cwd 自身位于待测授权中时，`workspaceParent` 可以将它从平台临时目录移出。启动失败会在拒绝诊断中保留已捕获 agent stderr。
|
||||
- **规范化器**：将两个已捕获接口转换为稳定文本的纯函数：`normalizeStdout`（JSON-RPC id → 首次出现序列；UUID 以及生成 cwd 的每个原生/JavaScript 文件系统写法 → token，按最长优先；根据 cwd 的分隔符选择规范 `/` 或宿主原生形式；同时作为 stdout 纯度检查）、`normalizeSessionLog`（时间归零、保留 `seq`、使用同一 cwd 路径策略）、`scrubSystemPrompts`（提示词文本 → `{{system}}`）、`scrubToolSchemas`（schema bulk → `{{tools}}`）和 `scrubRequestHeaders`（每个 pin 之外的所有 header bulk → `{{system}}`/`{{tools}}`/`{{messagePrefix}}`，保留结构；见[header 固定 Agent Note](../../../.agents/notes/archived/testing/2026-07-06-pin-request-header-content-in-one-scenario.md)）。
|
||||
- **`defineAcpSnapshotSuite`（工厂）**：为场景表注册完整 describe/it 树：每场景预期输出与重新持久化日志比较、录制/刷新 fixture 回写、拒绝结构化 `UNKNOWN_TOOL` 结果、每 header 类别 pin（`system-prompt.expected.md` 加 `tool-schemas.expected.json`）及其实时一致性保护，以及 fixture 保护块（无遗留场景目录、必需文件存在、每类别恰好一个 pin、每个 JSONL 的提示词/schema 已擦除、非 pin fixture 的 header 已完全擦除）。刷新会在对齐现有可变事件时间前展开打包时序 envelope，因此切换打包/非打包布局无法移动后续记录；新分片碎片数组仍为权威数据。新插入的 `session/title` 使用前一个事件的时间，因此功能驱动的插入不会扰动 fixture 余下部分。每个场景目录的 `session.jsonl` 和连续 `session.<n>.jsonl` 同级文件是有序主级/子级清单；场景表不重复其数量。必须在 vitest 收集时调用。
|
||||
- **`defineAcpSnapshotSuite`（工厂）**：为场景表注册完整 describe/it 树：每场景预期输出与重新持久化日志比较、录制/刷新 fixture 回写、拒绝结构化 `UNKNOWN_TOOL` 结果、每 header 类别 pin（`system-prompt.expected.md` 加 `tool-schemas.expected.json`）及其实时一致性保护，以及 fixture 保护块（无遗留场景目录、必需文件存在、每类别恰好一个 pin、每个 JSONL 的提示词/schema 已擦除、非 pin fixture 的 header 已完全擦除）。刷新会从已对齐的现有记录复用规范化后等价的叶值，而新生成的语义值仍为权威数据；它还会在对齐事件时间前展开打包时序 envelope，因此切换打包/非打包布局无法移动后续记录。新插入的 `session/title` 使用前一个事件的时间，因此功能驱动的插入不会扰动 fixture 余下部分。每个场景目录的 `session.jsonl` 和连续 `session.<n>.jsonl` 同级文件是有序主级/子级清单；场景表不重复其数量。必须在 vitest 收集时调用。
|
||||
|
||||
签入仓库的会话 fixture 使用规范打包行。合并此契约的在途分支通过 `pnpm run migrate:packed-session-fixtures` 运行[临时仓库迁移器](../../../scripts/migrate-packed-session-fixtures.ts)；待受影响分支收敛后，由其[移除提案](../../../.agents/notes/proposed/process/2026-07-26-remove-packed-session-fixture-migrator.md)负责删除该迁移器。
|
||||
|
||||
|
||||
@@ -510,13 +510,78 @@ function preservePackedMemberTimes(
|
||||
row.data.dt = gaps
|
||||
}
|
||||
|
||||
/** Whether a parsed JSON value is a non-array object. */
|
||||
function isRecord(value: unknown): value is Record<string, unknown> {
|
||||
return value !== null && typeof value === 'object' && !Array.isArray(value)
|
||||
}
|
||||
|
||||
/**
|
||||
* Reuse existing leaves whose normalized values equal the fresh values.
|
||||
* Objects merge by key; arrays merge only when their positions still align.
|
||||
*/
|
||||
function preserveNormalizedVolatiles(
|
||||
fresh: unknown,
|
||||
existing: unknown,
|
||||
normalizedFresh: unknown,
|
||||
normalizedExisting: unknown,
|
||||
): unknown {
|
||||
if (
|
||||
Array.isArray(fresh)
|
||||
&& Array.isArray(existing)
|
||||
&& Array.isArray(normalizedFresh)
|
||||
&& Array.isArray(normalizedExisting)
|
||||
) {
|
||||
if (
|
||||
fresh.length !== existing.length
|
||||
|| fresh.length !== normalizedFresh.length
|
||||
|| fresh.length !== normalizedExisting.length
|
||||
) return fresh
|
||||
return fresh.map((value, index) => preserveNormalizedVolatiles(
|
||||
value,
|
||||
existing[index],
|
||||
normalizedFresh[index],
|
||||
normalizedExisting[index],
|
||||
))
|
||||
}
|
||||
if (
|
||||
isRecord(fresh)
|
||||
&& isRecord(existing)
|
||||
&& isRecord(normalizedFresh)
|
||||
&& isRecord(normalizedExisting)
|
||||
) {
|
||||
return Object.fromEntries(Object.entries(fresh).map(([key, value]) => [
|
||||
key,
|
||||
Object.hasOwn(existing, key)
|
||||
&& Object.hasOwn(normalizedFresh, key)
|
||||
&& Object.hasOwn(normalizedExisting, key)
|
||||
? preserveNormalizedVolatiles(
|
||||
value,
|
||||
existing[key],
|
||||
normalizedFresh[key],
|
||||
normalizedExisting[key],
|
||||
)
|
||||
: value,
|
||||
]))
|
||||
}
|
||||
return Object.is(normalizedFresh, normalizedExisting) ? existing : fresh
|
||||
}
|
||||
|
||||
/** Normalize one aligned record with the same contract used by fixture comparison. */
|
||||
function normalizedRefreshRecord(
|
||||
record: Record<string, unknown>,
|
||||
context: NormalizeContext,
|
||||
): Record<string, unknown> {
|
||||
return JSON.parse(normalizeSessionLog(`${JSON.stringify(record)}\n`, context)) as Record<string, unknown>
|
||||
}
|
||||
|
||||
/**
|
||||
* Rewrite a fresh replay-produced log so repeated refreshes do not churn
|
||||
* volatile fixture fields. Meaningful event payloads come from `fresh`; the
|
||||
* existing fixture lends session ids, cwd, creation times, logical event
|
||||
* times, and hook durations where the record shape still matches. Packed
|
||||
* timing envelopes expand for alignment, so packing does not shift later
|
||||
* records; fresh fragment arrays remain authoritative.
|
||||
* existing fixture lends normalized-equivalent values, including ids, paths,
|
||||
* creation/event times, spill locators, and hook durations, where records
|
||||
* still align. Packed timing envelopes expand for alignment, so packing does
|
||||
* not shift later records; fresh semantic values and fragment arrays remain
|
||||
* authoritative.
|
||||
*
|
||||
* @param fresh The newly harvested session JSONL.
|
||||
* @param existing The committed fixture JSONL being refreshed.
|
||||
@@ -528,10 +593,11 @@ export function stabilizeRefreshLog(fresh: string, existing: string, replacement
|
||||
for (const { from, to } of replacements) stable = stable.split(from).join(to)
|
||||
const existingRecords = logicalRecords(parseJsonlRecords(existing))
|
||||
const records = parseJsonlRecords(stable)
|
||||
const context = fixtureContext(existing)
|
||||
let existingIndex = 0
|
||||
let previousEventTime: unknown
|
||||
for (let i = 0; i < records.length; i++) {
|
||||
const record = records[i] as Record<string, unknown>
|
||||
let record = records[i] as Record<string, unknown>
|
||||
const existingRecord = existingRecords[existingIndex]
|
||||
const memberCount = packedTimes(record)?.length ?? 1
|
||||
const insertedTitle = record.type === 'session/title' && existingRecord?.type !== 'session/title'
|
||||
@@ -540,6 +606,15 @@ export function stabilizeRefreshLog(fresh: string, existing: string, replacement
|
||||
if (typeof previousEventTime !== 'number') throw new Error('acp-snapshot: inserted title has no preceding event time')
|
||||
record.time = previousEventTime
|
||||
} else {
|
||||
if (memberCount === 1 && existingRecord !== undefined && existingRecord.type === record.type) {
|
||||
record = preserveNormalizedVolatiles(
|
||||
record,
|
||||
existingRecord,
|
||||
normalizedRefreshRecord(record, context),
|
||||
normalizedRefreshRecord(existingRecord, context),
|
||||
) as Record<string, unknown>
|
||||
records[i] = record
|
||||
}
|
||||
preservePackedMemberTimes(record, existingRecords.slice(existingIndex, existingIndex + memberCount))
|
||||
preserveFixtureVolatiles(record, existingRecord)
|
||||
existingIndex += memberCount
|
||||
|
||||
@@ -592,4 +592,107 @@ describe('stabilizeRefreshLog', () => {
|
||||
'',
|
||||
].join('\n'))
|
||||
})
|
||||
|
||||
it('preserves normalized volatile fields while accepting fresh semantic fields', () => {
|
||||
const freshApprovalId = '11111111-1111-4111-8111-111111111111'
|
||||
const existingApprovalId = '22222222-2222-4222-8222-222222222222'
|
||||
const freshSpill = '/tmp/dsh-acp-snap-012345678/session-111111111111/222222222222-bash.txt'
|
||||
const existingSpill = '/tmp/dsh-acp-snap-012345678/session-aaaaaaaaaaaa/bbbbbbbbbbbb-bash.txt'
|
||||
const freshEventRead = [
|
||||
'Session main — title',
|
||||
'Target event seq 4:',
|
||||
'```json',
|
||||
'{',
|
||||
' "time": 1785000000000,',
|
||||
' "data": {}',
|
||||
'}',
|
||||
'```',
|
||||
'',
|
||||
`(Omitted 40000 bytes. Full formatted result stored at: ${freshSpill}. Use read with offset/limit, or grep this path to search within it.)`,
|
||||
].join('\n')
|
||||
const existingEventRead = freshEventRead
|
||||
.replace('1785000000000', '1784000000000')
|
||||
.replace('40000 bytes', '30000 bytes')
|
||||
.replace(freshSpill, existingSpill)
|
||||
const fresh = [
|
||||
'{"type":"session","id":"same","createdAt":200,"cwd":"/old"}',
|
||||
JSON.stringify({
|
||||
type: 'approval/asked',
|
||||
seq: 1,
|
||||
time: 22,
|
||||
data: {
|
||||
id: freshApprovalId,
|
||||
outcome: 'fresh',
|
||||
aliases: [freshApprovalId, 'fresh'],
|
||||
resized: [freshApprovalId, 'new'],
|
||||
shape: { shared: freshApprovalId, added: true },
|
||||
},
|
||||
}),
|
||||
JSON.stringify({
|
||||
type: 'tool/result',
|
||||
seq: 2,
|
||||
time: 23,
|
||||
data: {
|
||||
spill: `Full formatted result stored at: ${freshSpill}. Use read with offset/limit, or grep this path to search within it.`,
|
||||
path: '/private/old/result.txt',
|
||||
eventRead: freshEventRead,
|
||||
},
|
||||
}),
|
||||
'',
|
||||
].join('\n')
|
||||
const existing = [
|
||||
'{"type":"session","id":"same","createdAt":100,"cwd":"/old"}',
|
||||
JSON.stringify({
|
||||
type: 'approval/asked',
|
||||
seq: 1,
|
||||
time: 11,
|
||||
data: {
|
||||
id: existingApprovalId,
|
||||
outcome: 'stale',
|
||||
aliases: [existingApprovalId, 'stale'],
|
||||
resized: [existingApprovalId],
|
||||
shape: { shared: existingApprovalId },
|
||||
},
|
||||
}),
|
||||
JSON.stringify({
|
||||
type: 'tool/result',
|
||||
seq: 2,
|
||||
time: 12,
|
||||
data: {
|
||||
spill: `Full formatted result stored at: ${existingSpill}. Use read with offset/limit, or grep this path to search within it.`,
|
||||
path: '/old/result.txt',
|
||||
eventRead: existingEventRead,
|
||||
},
|
||||
}),
|
||||
'',
|
||||
].join('\n')
|
||||
|
||||
const output = stabilizeRefreshLog(fresh, existing, []).trim().split('\n')
|
||||
.map(line => JSON.parse(line) as Record<string, unknown>)
|
||||
expect(output).toEqual([
|
||||
{ type: 'session', id: 'same', createdAt: 100, cwd: '/old' },
|
||||
{
|
||||
type: 'approval/asked',
|
||||
seq: 1,
|
||||
time: 11,
|
||||
data: {
|
||||
id: existingApprovalId,
|
||||
outcome: 'fresh',
|
||||
aliases: [existingApprovalId, 'fresh'],
|
||||
resized: [freshApprovalId, 'new'],
|
||||
shape: { shared: existingApprovalId, added: true },
|
||||
},
|
||||
},
|
||||
{
|
||||
type: 'tool/result',
|
||||
seq: 2,
|
||||
time: 12,
|
||||
data: {
|
||||
spill: `Full formatted result stored at: ${existingSpill}. Use read with offset/limit, or grep this path to search within it.`,
|
||||
path: '/old/result.txt',
|
||||
eventRead: existingEventRead,
|
||||
},
|
||||
},
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user