Skip to content

Commit 559c4b1

Browse files
fix(acp): one malformed session update no longer ends the session (pingdotgg#20015)
Co-authored-by: Claude Opus 5.5 <[email protected]>
1 parent ede3f2d commit 559c4b1

8 files changed

Lines changed: 326 additions & 65 deletions

File tree

‎apps/server/src/orchestration-v2/testkit/fixtures/index.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ import { skillInvocationInput } from "./skill_invocation/input.ts";
128128
import { assertSimpleOutput } from "./simple/codex_output.ts";
129129
import { assertPiSimpleOutput } from "./simple/pi_output.ts";
130130
import { simpleInput } from "./simple/input.ts";
131+
import { malformedSessionUpdateInput } from "./malformed_session_update/input.ts";
132+
import { assertMalformedSessionUpdateOutput } from "./malformed_session_update/output.ts";
131133
import { assertSubagentOutput } from "./subagent/codex_output.ts";
132134
import { assertClaudeSubagentOutput } from "./subagent/claude_output.ts";
133135
import { subagentInput } from "./subagent/input.ts";
@@ -594,6 +596,21 @@ export const ORCHESTRATOR_REPLAY_FIXTURES: ReadonlyArray<OrchestratorReplayFixtu
594596
},
595597
],
596598
},
599+
{
600+
name: "malformed_session_update",
601+
buildInput: malformedSessionUpdateInput,
602+
providers: [
603+
{
604+
driver: ProviderDriverKind.make("acpRegistry"),
605+
transcriptFile: new URL(
606+
"./malformed_session_update/registry_transcript.ndjson",
607+
import.meta.url,
608+
),
609+
modelSelection: ACP_REGISTRY_MODEL_SELECTION,
610+
assertOutput: assertMalformedSessionUpdateOutput,
611+
},
612+
],
613+
},
597614
{
598615
name: "simple",
599616
buildInput: simpleInput,
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import type { OrchestratorFixtureInput } from "../shared.ts";
2+
3+
export const MALFORMED_SESSION_UPDATE_PROMPT =
4+
"Respond with the following text: malformed update fixture ok";
5+
6+
/**
7+
* An agent sends a `usage_update` without the required `used` and `size`
8+
* mid-turn, the way clanka did (reported 2026-10-15). T3 drops that one
9+
* update and the turn completes with the text and usage that follow it.
10+
*/
11+
export function malformedSessionUpdateInput(): OrchestratorFixtureInput {
12+
return {
13+
steps: [{ type: "message", text: MALFORMED_SESSION_UPDATE_PROMPT }],
14+
};
15+
}
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import { assert } from "@effect/vitest";
2+
import type { ProviderReplayTranscript } from "@t3tools/contracts";
3+
4+
import type { OrchestratorV2ScenarioResult } from "../../OrchestratorScenario.ts";
5+
import {
6+
assertAssistantTextIncludes,
7+
assertBaseProjection,
8+
assertSemanticProjectionIntegrity,
9+
assertTurnItemTypes,
10+
assertUserMessagesInclude,
11+
projectionFor,
12+
} from "../shared.ts";
13+
import { MALFORMED_SESSION_UPDATE_PROMPT } from "./input.ts";
14+
15+
export function assertMalformedSessionUpdateOutput(
16+
result: OrchestratorV2ScenarioResult,
17+
transcript: ProviderReplayTranscript,
18+
) {
19+
assertBaseProjection({ result, transcript, runCount: 1, runStatuses: ["completed"] });
20+
const projection = projectionFor(result, transcript.scenario);
21+
assertSemanticProjectionIntegrity(projection);
22+
assertUserMessagesInclude(projection, [MALFORMED_SESSION_UPDATE_PROMPT]);
23+
assertTurnItemTypes(projection, ["user_message", "assistant_message"]);
24+
// The dropped update does not fail the turn.
25+
assert.notInclude(
26+
projection.turnItems.map((item) => item.type),
27+
"error",
28+
);
29+
assertAssistantTextIncludes(projection, "malformed update fixture ok");
30+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{"type":"transcript_start","provider":"acpRegistry","protocol":"acp.ndjson-jsonrpc","version":"1","scenario":"malformed_session_update","metadata":{"generatedBy":"protocol-semantic-fixture","nativeSessionId":"grok-replay-session-1"}}
2+
{"type":"expect_outbound","label":"initialize","frame":{"kind":"request","method":"initialize","params":{"protocolVersion":2,"info":"<any>","capabilities":"<any>","clientCapabilities":"<any>","clientInfo":"<any>"}}}
3+
{"type":"emit_inbound","label":"initialized","frame":{"kind":"response","method":"initialize","result":{"protocolVersion":1,"agentCapabilities":{"loadSession":true,"mcpCapabilities":{"http":true,"sse":true},"promptCapabilities":{"audio":false,"embeddedContext":true,"image":false}},"authMethods":[{"id":"replay","name":"Replay"}],"agentInfo":{"name":"grok-replay","version":"1"}}}}
4+
{"type":"expect_outbound","label":"session.new","frame":{"kind":"request","method":"session/new","params":{"cwd":"<workspace>","mcpServers":"<any>"}}}
5+
{"type":"emit_inbound","label":"session.created","frame":{"kind":"response","method":"session/new","result":{"sessionId":"grok-replay-session-1","models":{"currentModelId":"grok-build","availableModels":[{"modelId":"grok-build","name":"Grok Build"},{"modelId":"grok-composer-2.5-fast","name":"Grok Composer 2.5 Fast"}]}}}}
6+
{"type":"expect_outbound","label":"session.prompt","frame":{"kind":"request","method":"session/prompt","params":{"sessionId":"grok-replay-session-1","prompt":[{"type":"text","text":"<t3_code_instructions>\n<any>\n</t3_code_instructions>\n\n<user_request>\nRespond with the following text: malformed update fixture ok\n</user_request>"}]}}}
7+
{"type":"emit_inbound","label":"reasoning.1","frame":{"kind":"notification","method":"session/update","params":{"sessionId":"grok-replay-session-1","update":{"sessionUpdate":"agent_thought_chunk","content":{"type":"text","text":"I should "}}}}}
8+
{"type":"emit_inbound","label":"reasoning.2","frame":{"kind":"notification","method":"session/update","params":{"sessionId":"grok-replay-session-1","update":{"sessionUpdate":"agent_thought_chunk","content":{"type":"text","text":"answer exactly."}}}}}
9+
{"type":"emit_inbound","label":"usage.malformed","frame":{"kind":"notification","method":"session/update","params":{"sessionId":"grok-replay-session-1","update":{"sessionUpdate":"usage_update","cost":{"amount":0.01,"currency":"USD"}}}}}
10+
{"type":"emit_inbound","label":"assistant.1","frame":{"kind":"notification","method":"session/update","params":{"sessionId":"grok-replay-session-1","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"malformed update "}}}}}
11+
{"type":"emit_inbound","label":"assistant.2","frame":{"kind":"notification","method":"session/update","params":{"sessionId":"grok-replay-session-1","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"fixture ok"}}}}}
12+
{"type":"emit_inbound","label":"usage.valid","frame":{"kind":"notification","method":"session/update","params":{"sessionId":"grok-replay-session-1","update":{"sessionUpdate":"usage_update","used":1200,"size":200000}}}}
13+
{"type":"emit_inbound","label":"prompt.completed","frame":{"kind":"response","method":"session/prompt","result":{"stopReason":"end_turn"}}}
14+
{"type":"runtime_exit","status":"success"}

‎packages/effect-acp/src/errors.test.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,33 @@ describe("effect-acp errors", () => {
161161
expect("detail" in protocolError).toBe(false);
162162
}),
163163
);
164+
165+
// The summary goes into logs, so it names where a payload broke its schema
166+
// and never copies a value, including a record key the agent chose.
167+
it.effect("summarizes schema issues by path without payload values", () =>
168+
Effect.gen(function* () {
169+
const secret = "acp-summary-secret";
170+
const cause = yield* Schema.decodeUnknownEffect(
171+
Schema.Struct({
172+
update: Schema.Struct({ used: Schema.Number, size: Schema.Number }),
173+
env: Schema.Record(Schema.String, Schema.Number),
174+
}),
175+
)({ update: { size: secret }, env: { [`${secret} key`]: secret } }, { errors: "all" }).pipe(
176+
Effect.flip,
177+
);
178+
const error = AcpError.AcpProtocolParseError.fromSchemaError(
179+
"decode-notification-payload",
180+
"session/update",
181+
cause,
182+
);
183+
184+
expect(error.issueSummary).toBe(
185+
"update.used missing, update.size wrong type, env.* wrong type",
186+
);
187+
expect(error.message).toBe(
188+
"ACP protocol operation 'decode-notification-payload' failed for method 'session/update': update.used missing, update.size wrong type, env.* wrong type.",
189+
);
190+
expect(error.message).not.toContain(secret);
191+
}),
192+
);
164193
});

‎packages/effect-acp/src/errors.ts‎

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import * as Schema from "effect/Schema";
2+
import * as SchemaAST from "effect/SchemaAST";
23
import type * as SchemaIssue from "effect/SchemaIssue";
34

45
import * as AcpSchema from "./_generated/schema.gen.ts";
@@ -37,6 +38,74 @@ interface AcpSchemaIssueDiagnostics {
3738
readonly maximumPathDepth: number;
3839
}
3940

41+
const MAX_SUMMARY_ISSUES = 3;
42+
const MAX_SUMMARY_PATH_SEGMENTS = 8;
43+
44+
// Record keys come from the payload, so a key that is not a plain identifier
45+
// is shown as `*` rather than copied.
46+
const summaryPathSegment = (segment: PropertyKey): string =>
47+
typeof segment === "number" || /^[A-Za-z_][A-Za-z0-9_]{0,63}$/.test(String(segment))
48+
? String(segment)
49+
: "*";
50+
51+
const summaryPath = (path: ReadonlyArray<PropertyKey>): string => {
52+
if (path.length === 0) return "payload";
53+
const shown = path.slice(0, MAX_SUMMARY_PATH_SEGMENTS).map(summaryPathSegment).join(".");
54+
return path.length > MAX_SUMMARY_PATH_SEGMENTS ? `${shown}…` : shown;
55+
};
56+
57+
const summaryReason = (issue: SchemaIssue.Issue): string => {
58+
switch (issue._tag) {
59+
case "MissingKey":
60+
return "missing";
61+
case "UnexpectedKey":
62+
return "unexpected";
63+
case "InvalidType":
64+
return "wrong type";
65+
default:
66+
return "invalid";
67+
}
68+
};
69+
70+
const isCatchAllMember = (issue: SchemaIssue.Issue) =>
71+
"ast" in issue && SchemaAST.resolveTitle(issue.ast) === "other";
72+
73+
/**
74+
* Names where a payload broke its schema, such as `update.used missing`,
75+
* without copying any value from it. ACP unions end in a member titled
76+
* "other" that admits custom and future variants; it fails only because the
77+
* discriminator names a known variant, so the known variant's issues are the
78+
* ones reported.
79+
*/
80+
const schemaIssueSummary = (root: SchemaIssue.Issue): string => {
81+
const entries = new Set<string>();
82+
const visit = (issue: SchemaIssue.Issue, path: ReadonlyArray<PropertyKey>): void => {
83+
switch (issue._tag) {
84+
case "Filter":
85+
case "Encoding":
86+
visit(issue.issue, path);
87+
return;
88+
case "Pointer":
89+
visit(issue.issue, [...path, ...issue.path]);
90+
return;
91+
case "Composite":
92+
case "AnyOf": {
93+
const known = issue.issues.filter((child) => !isCatchAllMember(child));
94+
const children = known.length > 0 ? known : issue.issues;
95+
if (children.length === 0) entries.add(`${summaryPath(path)} ${summaryReason(issue)}`);
96+
for (const child of children) visit(child, path);
97+
return;
98+
}
99+
default:
100+
entries.add(`${summaryPath(path)} ${summaryReason(issue)}`);
101+
}
102+
};
103+
visit(root, []);
104+
const shown = [...entries].slice(0, MAX_SUMMARY_ISSUES);
105+
const hidden = entries.size - shown.length;
106+
return hidden > 0 ? `${shown.join(", ")} (+${hidden} more)` : shown.join(", ");
107+
};
108+
40109
const schemaIssueDiagnostics = (root: SchemaIssue.Issue): AcpSchemaIssueDiagnostics => {
41110
let issueCount = 0;
42111
let maximumPathDepth = 0;
@@ -123,12 +192,15 @@ export class AcpProtocolParseError extends Schema.TaggedError<AcpProtocolParseEr
123192
issueCount: Schema.optionalKey(Schema.Number),
124193
issueKinds: Schema.optionalKey(Schema.Array(AcpSchemaIssueKind)),
125194
maximumPathDepth: Schema.optionalKey(Schema.Number),
195+
/** Where the payload broke its schema, e.g. `update.used missing`; never payload values. */
196+
issueSummary: Schema.optionalKey(Schema.String),
126197
cause: Schema.Defect(),
127198
},
128199
) {
129200
override get message() {
130201
const method = this.method === undefined ? "" : ` for method '${this.method}'`;
131-
return `ACP protocol operation '${this.operation}' failed${method}.`;
202+
const summary = this.issueSummary === undefined ? "" : `: ${this.issueSummary}`;
203+
return `ACP protocol operation '${this.operation}' failed${method}${summary}.`;
132204
}
133205

134206
static fromSchemaError(
@@ -140,6 +212,7 @@ export class AcpProtocolParseError extends Schema.TaggedError<AcpProtocolParseEr
140212
operation,
141213
method,
142214
...schemaIssueDiagnostics(cause.issue),
215+
issueSummary: schemaIssueSummary(cause.issue),
143216
cause,
144217
});
145218
}

‎packages/effect-acp/src/protocol.test.ts‎

Lines changed: 93 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ import * as Effect from "effect/Effect";
44
import * as Deferred from "effect/Deferred";
55
import * as Fiber from "effect/Fiber";
66
import * as Exit from "effect/Exit";
7+
import * as Logger from "effect/Logger";
78
import * as Queue from "effect/Queue";
9+
import * as References from "effect/References";
810
import * as Schema from "effect/Schema";
911
import * as Scope from "effect/Scope";
1012
import * as Sink from "effect/Sink";
@@ -209,50 +211,116 @@ it.layer(NodeServices.layer)("effect-acp protocol", (it) => {
209211
}),
210212
);
211213

212-
it.effect("keeps invalid core notification values only in the schema cause", () =>
214+
// clanka once sent a usage_update without `used` and `size`. One bad update
215+
// must not end a session whose later updates are fine.
216+
it.effect("drops a session/update that fails to decode and keeps reading", () =>
213217
Effect.gen(function* () {
214218
const secret = "acp-core-notification-secret-sentinel";
215219
const { stdio, input } = yield* makeInMemoryStdio();
216-
const termination = yield* Deferred.make<AcpError.AcpError>();
220+
const events: Array<AcpProtocol.AcpProtocolLogEvent> = [];
221+
const warnings: Array<unknown> = [];
222+
let terminated = false;
217223
let transformCalls = 0;
218-
yield* AcpProtocol.makeAcpPatchedProtocol({
224+
const transport = yield* AcpProtocol.makeAcpPatchedProtocol({
219225
stdio,
220226
serverRequestMethods: new Set(),
227+
logIncoming: true,
228+
logger: (event) =>
229+
Effect.sync(() => {
230+
events.push(event);
231+
}),
221232
transformSessionUpdate: (notification) => {
222233
transformCalls += 1;
223234
return notification;
224235
},
225-
onTermination: (error) => Deferred.succeed(termination, error).pipe(Effect.asVoid),
236+
onTermination: () =>
237+
Effect.sync(() => {
238+
terminated = true;
239+
}),
240+
}).pipe(
241+
Effect.provide(
242+
Logger.layer([
243+
Logger.make(({ logLevel, fiber }) => {
244+
if (logLevel === "Warn")
245+
warnings.push(fiber.getRef(References.CurrentLogAnnotations));
246+
}),
247+
]),
248+
),
249+
);
250+
const received = yield* Deferred.make<AcpProtocol.AcpIncomingNotification>();
251+
yield* transport.incoming.pipe(
252+
Stream.runForEach((notification) => Deferred.succeed(received, notification)),
253+
Effect.forkScoped,
254+
);
255+
256+
const send = (params: unknown) =>
257+
Queue.offer(
258+
input,
259+
encoder.encode(
260+
`${encodeUnknownJsonString({ jsonrpc: "2.0", method: "session/update", params })}\n`,
261+
),
262+
);
263+
const malformed = {
264+
sessionId: "session-1",
265+
update: { sessionUpdate: "usage_update", cost: { amount: 1, currency: secret } },
266+
};
267+
yield* send(malformed);
268+
yield* send(malformed);
269+
yield* send({
270+
sessionId: "session-1",
271+
update: { sessionUpdate: "usage_update", used: 10, size: 100 },
226272
});
227273

228-
yield* Queue.offer(
229-
input,
230-
encoder.encode(
231-
`${encodeUnknownJsonString({
232-
jsonrpc: "2.0",
233-
method: "session/update",
234-
params: {
235-
sessionId: { secret },
236-
update: {
237-
sessionUpdate: "plan",
238-
entries: [],
239-
},
240-
},
241-
})}\n`,
242-
),
274+
const notification = yield* TestClock.withLive(
275+
Deferred.await(received).pipe(Effect.timeout("2 seconds")),
243276
);
277+
assert.equal(notification._tag, "SessionUpdate");
278+
assert.deepEqual(notification.params, {
279+
sessionId: "session-1",
280+
update: { sessionUpdate: "usage_update", used: 10, size: 100 },
281+
});
282+
assert.isFalse(terminated);
283+
assert.equal(transformCalls, 1);
284+
285+
const decodeFailed = events.find(({ stage }) => stage === "decode_failed");
286+
assert.deepInclude(decodeFailed?.payload as object, {
287+
operation: "decode-notification-payload",
288+
method: "session/update",
289+
issueSummary: "update.used missing",
290+
});
291+
// The repeated bad update is dropped again but warned about once.
292+
assert.lengthOf(
293+
events.filter(({ stage }) => stage === "decode_failed"),
294+
2,
295+
);
296+
assert.lengthOf(warnings, 1);
297+
assert.deepInclude(warnings[0] as object, {
298+
issueSummary: "update.used missing",
299+
});
300+
assert.notInclude(encodeUnknownJsonString({ decodeFailed, warnings }), secret);
301+
}),
302+
);
244303

245-
const error = yield* Deferred.await(termination);
246-
assert.equal(transformCalls, 0);
247-
assert.instanceOf(error, AcpError.AcpProtocolParseError);
248-
const parseError = error as AcpError.AcpProtocolParseError;
249-
const { cause, ...directDiagnostics } = parseError;
304+
it.effect("keeps invalid core notification values only in the schema cause", () =>
305+
Effect.gen(function* () {
306+
const secret = "acp-core-notification-secret-sentinel";
307+
const cause = yield* Schema.decodeUnknownEffect(AcpSchema.SessionNotification)({
308+
sessionId: { secret },
309+
update: { sessionUpdate: "plan", entries: [] },
310+
}).pipe(Effect.flip);
311+
const parseError = AcpError.AcpProtocolParseError.fromSchemaError(
312+
"decode-notification-payload",
313+
"session/update",
314+
cause,
315+
);
316+
const { cause: directCause, ...directDiagnostics } = parseError;
250317
assert.equal(parseError.operation, "decode-notification-payload");
251318
assert.equal(parseError.method, "session/update");
252319
assert.isAbove(parseError.issueCount ?? 0, 0);
253320
assert.include(parseError.issueKinds ?? [], "Pointer");
254321
assert.isAbove(parseError.maximumPathDepth ?? 0, 0);
255-
assert.isTrue(Schema.isSchemaError(cause));
322+
assert.equal(parseError.issueSummary, "sessionId wrong type");
323+
assert.isTrue(Schema.isSchemaError(directCause));
256324
assert.notInclude(parseError.message, secret);
257325
assert.notInclude(encodeUnknownJsonString(directDiagnostics), secret);
258326
}),

0 commit comments

Comments
 (0)