agent/codex
1
0
Fork 0
mirror of https://github.com/pchuan98/codex.git synced 2026-07-01 00:31:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

[codex] Add optional IDs to response items (#28812)

Browse Source 
## Why

`ResponseItem` variants do not have a consistent internal ID shape: some
variants carry required IDs, some carry optional IDs, and some cannot
represent an ID at all. The existing fields also use inconsistent serde,
TypeScript, and JSON-schema annotations. A single enum-level access path
is needed before history recording can assign and retain IDs.

This PR establishes that internal model only. It intentionally does not
generate or serialize IDs; allocation and wire persistence are isolated
in the stacked follow-up.

## What changed

- Give every concrete `ResponseItem` variant an `Option<String>` ID
field.
- Apply the same internal-only annotations to every ID field:
`#[serde(default, skip_serializing)]`, `#[ts(skip)]`, and
`#[schemars(skip)]`.
- Add `ResponseItem::id()` and `ResponseItem::set_id()` as the shared
accessors.
- Preserve IDs when history items are rewritten for truncation.
- Adapt consumers that previously assumed reasoning and image-generation
IDs were required.
- Regenerate app-server schemas so the hidden fields are represented
consistently.

The serde catch-all `ResponseItem::Other` remains ID-less because it
must remain a unit variant.

## Test plan

- `cargo check --tests -p codex-core -p codex-api -p codex-rollout-trace
-p codex-image-generation-extension`
- `just test -p codex-protocol`
- `just test -p codex-app-server-protocol`
- `just test -p codex-api -p codex-rollout-trace -p
codex-image-generation-extension`
- `just test -p codex-core event_mapping`
This commit is contained in:
pakrym-oai
2026-06-17 18:27:43 -07:00
committed by GitHub
Unverified
parent c274a83f8b
commit dbd2857f4b
36 changed files with 278 additions and 258 deletions
Download Patch File Download Diff File Expand all files Collapse all files
codex-rs/app-server-protocol/schema/json/ClientRequest.json
Generated
+5 -45
View File
@@ -2289,13 +2289,6 @@
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -2437,14 +2430,6 @@
"null"
]
},
"id": {
"description": "Legacy id field retained for compatibility with older payloads.",
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -2482,13 +2467,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -2537,13 +2515,6 @@
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -2615,13 +2586,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"input": {
"type": "string"
},
@@ -2758,13 +2722,6 @@
}
]
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -2798,7 +2755,11 @@
{
"properties": {
"id": {
"type": "string"
"description": "Existing provider ID retained on serialized history for compatibility.",
"type": [
"string",
"null"
]
},
"metadata": {
"anyOf": [
@@ -2831,7 +2792,6 @@
}
},
"required": [
"id",
"result",
"status",
"type"
codex-rs/app-server-protocol/schema/json/codex_app_server_protocol.schemas.json
Generated
+5 -45
View File
@@ -14791,13 +14791,6 @@
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -14939,14 +14932,6 @@
"null"
]
},
"id": {
"description": "Legacy id field retained for compatibility with older payloads.",
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -14984,13 +14969,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -15039,13 +15017,6 @@
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -15117,13 +15088,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"input": {
"type": "string"
},
@@ -15260,13 +15224,6 @@
}
]
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -15300,7 +15257,11 @@
{
"properties": {
"id": {
"type": "string"
"description": "Existing provider ID retained on serialized history for compatibility.",
"type": [
"string",
"null"
]
},
"metadata": {
"anyOf": [
@@ -15333,7 +15294,6 @@
}
},
"required": [
"id",
"result",
"status",
"type"
codex-rs/app-server-protocol/schema/json/codex_app_server_protocol.v2.schemas.json
Generated
+5 -45
View File
@@ -11236,13 +11236,6 @@
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -11384,14 +11377,6 @@
"null"
]
},
"id": {
"description": "Legacy id field retained for compatibility with older payloads.",
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -11429,13 +11414,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -11484,13 +11462,6 @@
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -11562,13 +11533,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"input": {
"type": "string"
},
@@ -11705,13 +11669,6 @@
}
]
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -11745,7 +11702,11 @@
{
"properties": {
"id": {
"type": "string"
"description": "Existing provider ID retained on serialized history for compatibility.",
"type": [
"string",
"null"
]
},
"metadata": {
"anyOf": [
@@ -11778,7 +11739,6 @@
}
},
"required": [
"id",
"result",
"status",
"type"
codex-rs/app-server-protocol/schema/json/v2/RawResponseItemCompletedNotification.json
Generated
+5 -45
View File
@@ -377,13 +377,6 @@
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -525,14 +518,6 @@
"null"
]
},
"id": {
"description": "Legacy id field retained for compatibility with older payloads.",
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -570,13 +555,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -625,13 +603,6 @@
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -703,13 +674,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"input": {
"type": "string"
},
@@ -846,13 +810,6 @@
}
]
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -886,7 +843,11 @@
{
"properties": {
"id": {
"type": "string"
"description": "Existing provider ID retained on serialized history for compatibility.",
"type": [
"string",
"null"
]
},
"metadata": {
"anyOf": [
@@ -919,7 +880,6 @@
}
},
"required": [
"id",
"result",
"status",
"type"
codex-rs/app-server-protocol/schema/json/v2/ThreadResumeParams.json
Generated
+5 -45
View File
@@ -448,13 +448,6 @@
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -596,14 +589,6 @@
"null"
]
},
"id": {
"description": "Legacy id field retained for compatibility with older payloads.",
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -641,13 +626,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -696,13 +674,6 @@
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -774,13 +745,6 @@
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"input": {
"type": "string"
},
@@ -917,13 +881,6 @@
}
]
},
"id": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"metadata": {
"anyOf": [
{
@@ -957,7 +914,11 @@
{
"properties": {
"id": {
"type": "string"
"description": "Existing provider ID retained on serialized history for compatibility.",
"type": [
"string",
"null"
]
},
"metadata": {
"anyOf": [
@@ -990,7 +951,6 @@
}
},
"required": [
"id",
"result",
"status",
"type"
codex-rs/app-server-protocol/schema/typescript/ResponseItem.ts
Generated
+5 -1
View File
@@ -16,4 +16,8 @@ export type ResponseItem = { "type": "message", role: string, content: Array<Con
/**
* Set when using the Responses API.
*/
call_id: string | null, status: LocalShellStatus, action: LocalShellAction, metadata?: ResponseItemMetadata, } | { "type": "function_call", name: string, namespace?: string, arguments: string, call_id: string, metadata?: ResponseItemMetadata, } | { "type": "tool_search_call", call_id: string | null, status?: string, execution: string, arguments: unknown, metadata?: ResponseItemMetadata, } | { "type": "function_call_output", call_id: string, output: FunctionCallOutputBody, metadata?: ResponseItemMetadata, } | { "type": "custom_tool_call", status?: string, call_id: string, name: string, input: string, metadata?: ResponseItemMetadata, } | { "type": "custom_tool_call_output", call_id: string, name?: string, output: FunctionCallOutputBody, metadata?: ResponseItemMetadata, } | { "type": "tool_search_output", call_id: string | null, status: string, execution: string, tools: unknown[], metadata?: ResponseItemMetadata, } | { "type": "web_search_call", status?: string, action?: WebSearchAction, metadata?: ResponseItemMetadata, } | { "type": "image_generation_call", id: string, status: string, revised_prompt?: string, result: string, metadata?: ResponseItemMetadata, } | { "type": "compaction", encrypted_content: string, metadata?: ResponseItemMetadata, } | { "type": "compaction_trigger", metadata?: ResponseItemMetadata, } | { "type": "context_compaction", encrypted_content?: string, metadata?: ResponseItemMetadata, } | { "type": "other" };
call_id: string | null, status: LocalShellStatus, action: LocalShellAction, metadata?: ResponseItemMetadata, } | { "type": "function_call", name: string, namespace?: string, arguments: string, call_id: string, metadata?: ResponseItemMetadata, } | { "type": "tool_search_call", call_id: string | null, status?: string, execution: string, arguments: unknown, metadata?: ResponseItemMetadata, } | { "type": "function_call_output", call_id: string, output: FunctionCallOutputBody, metadata?: ResponseItemMetadata, } | { "type": "custom_tool_call", status?: string, call_id: string, name: string, input: string, metadata?: ResponseItemMetadata, } | { "type": "custom_tool_call_output", call_id: string, name?: string, output: FunctionCallOutputBody, metadata?: ResponseItemMetadata, } | { "type": "tool_search_output", call_id: string | null, status: string, execution: string, tools: unknown[], metadata?: ResponseItemMetadata, } | { "type": "web_search_call", status?: string, action?: WebSearchAction, metadata?: ResponseItemMetadata, } | { "type": "image_generation_call",
/**
* Existing provider ID retained on serialized history for compatibility.
*/
id?: string, status: string, revised_prompt?: string, result: string, metadata?: ResponseItemMetadata, } | { "type": "compaction", encrypted_content: string, metadata?: ResponseItemMetadata, } | { "type": "compaction_trigger", metadata?: ResponseItemMetadata, } | { "type": "context_compaction", encrypted_content?: string, metadata?: ResponseItemMetadata, } | { "type": "other" };