typeduck-codex-execpolicy 0.13.0

Support package for the standalone Codex Web runtime (codex-rollout-trace)
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
//! Terminal reduction for exec-like tool calls.
//!
//! The raw trace records terminal activity as normal tool lifecycle events.
//! Protocol-backed exec events carry `ExecCommand*` payloads with the richest
//! runtime details. Direct tools without protocol observations, such as
//! `write_stdin`, can still form a terminal row from the canonical dispatch
//! invocation/result payloads when those payloads carry the session join key.

use anyhow::Context;
use anyhow::Result;
use anyhow::bail;
use serde::Deserialize;
use serde_json::Value as JsonValue;

use super::push_unique;
use crate::model::ExecutionStatus;
use crate::model::ExecutionWindow;
use crate::model::TerminalModelObservation;
use crate::model::TerminalObservationSource;
use crate::model::TerminalOperation;
use crate::model::TerminalOperationId;
use crate::model::TerminalOperationKind;
use crate::model::TerminalRequest;
use crate::model::TerminalResult;
use crate::model::TerminalSession;
use crate::model::ToolCallKind;
use crate::payload::RawPayloadRef;
use crate::raw_event::RawEventSeq;
use crate::reducer::TraceReducer;

impl TraceReducer {
    /// Starts a terminal operation from a canonical dispatch invocation payload.
    ///
    /// This is currently needed for direct tools such as write-stdin that do not
    /// emit a richer protocol runtime-begin event with the terminal join key.
    pub(in crate::reducer) fn start_terminal_operation_from_invocation(
        &mut self,
        seq: RawEventSeq,
        wall_time_unix_ms: i64,
        thread_id: &str,
        tool_call_id: &str,
        kind: &ToolCallKind,
        invocation_payload: Option<&RawPayloadRef>,
    ) -> Result<Option<TerminalOperationId>> {
        if !matches!(kind, ToolCallKind::WriteStdin) {
            return Ok(None);
        }
        let operation_kind = TerminalOperationKind::WriteStdin;
        let Some(invocation_payload) = invocation_payload else {
            // Payload writes are best-effort in the live recorder. If the
            // canonical invocation is missing, keep the ToolCall but avoid
            // fabricating a lossy terminal row.
            return Ok(None);
        };

        let payload = self.read_payload_json(invocation_payload)?;
        let request = parse_dispatch_terminal_request(payload).with_context(|| {
            format!(
                "parse terminal invocation payload {} as dispatch payload",
                invocation_payload.raw_payload_id
            )
        })?;
        self.insert_terminal_operation(TerminalOperationStart {
            seq,
            wall_time_unix_ms,
            thread_id,
            tool_call_id,
            operation_kind,
            raw_payload: invocation_payload,
            request,
        })
    }

    /// Starts a terminal operation from a protocol runtime-begin payload.
    pub(in crate::reducer) fn start_terminal_operation_from_runtime(
        &mut self,
        seq: RawEventSeq,
        wall_time_unix_ms: i64,
        thread_id: &str,
        tool_call_id: &str,
        kind: &ToolCallKind,
        runtime_payload: &RawPayloadRef,
    ) -> Result<Option<TerminalOperationId>> {
        let Some(operation_kind) = terminal_operation_kind(kind) else {
            return Ok(None);
        };

        let payload = self.read_payload_json(runtime_payload)?;
        let payload: ExecCommandBeginPayload =
            serde_json::from_value(payload).with_context(|| {
                format!(
                    "parse terminal runtime start payload {}",
                    runtime_payload.raw_payload_id
                )
            })?;
        let request = parse_protocol_terminal_request(payload, &operation_kind);
        self.insert_terminal_operation(TerminalOperationStart {
            seq,
            wall_time_unix_ms,
            thread_id,
            tool_call_id,
            operation_kind,
            raw_payload: runtime_payload,
            request,
        })
    }

    fn insert_terminal_operation(
        &mut self,
        start: TerminalOperationStart<'_>,
    ) -> Result<Option<TerminalOperationId>> {
        let operation_id = self.next_terminal_operation_id();
        let ParsedTerminalRequest {
            terminal_id,
            request,
        } = start.request;

        self.rollout.terminal_operations.insert(
            operation_id.clone(),
            TerminalOperation {
                operation_id: operation_id.clone(),
                terminal_id: terminal_id.clone(),
                tool_call_id: start.tool_call_id.to_string(),
                kind: start.operation_kind,
                execution: ExecutionWindow {
                    started_at_unix_ms: start.wall_time_unix_ms,
                    started_seq: start.seq,
                    ended_at_unix_ms: None,
                    ended_seq: None,
                    status: ExecutionStatus::Running,
                },
                request,
                result: None,
                model_observations: Vec::new(),
                raw_payload_ids: vec![start.raw_payload.raw_payload_id.clone()],
            },
        );

        if let Some(terminal_id) = terminal_id {
            self.ensure_terminal_session(
                start.thread_id,
                &terminal_id,
                &operation_id,
                start.wall_time_unix_ms,
                start.seq,
            )?;
        }

        Ok(Some(operation_id))
    }

    /// Completes the terminal operation associated with a tool call, if one exists.
    ///
    /// Non-terminal tools flow through the same generic tool lifecycle, so callers
    /// may invoke this unconditionally and receive Ok for unrelated tool kinds.
    pub(in crate::reducer) fn end_terminal_operation(
        &mut self,
        seq: RawEventSeq,
        wall_time_unix_ms: i64,
        thread_id: &str,
        operation_id: &str,
        status: ExecutionStatus,
        response_payload: Option<&RawPayloadRef>,
    ) -> Result<()> {
        let Some(operation_kind) = self
            .rollout
            .terminal_operations
            .get(operation_id)
            .map(|operation| operation.kind.clone())
        else {
            bail!("terminal end referenced unknown operation {operation_id}");
        };
        let response = response_payload
            .map(|payload| {
                let value = self.read_payload_json(payload)?;
                let response = parse_terminal_response_payload(
                    value,
                    &operation_kind,
                    &payload.raw_payload_id,
                )?;
                Ok::<_, anyhow::Error>((payload.raw_payload_id.clone(), response))
            })
            .transpose()?;

        let (terminal_id, started_at_unix_ms, started_seq) = {
            let Some(operation) = self.rollout.terminal_operations.get_mut(operation_id) else {
                bail!("terminal end referenced unknown operation {operation_id}");
            };
            operation.execution.ended_at_unix_ms = Some(wall_time_unix_ms);
            operation.execution.ended_seq = Some(seq);
            operation.execution.status = status;

            if let Some((raw_payload_id, response)) = response {
                push_unique(&mut operation.raw_payload_ids, &raw_payload_id);
                // If begin and end both report a process id they must name the
                // same terminal. If begin omitted it, the end event completes
                // the session join key for this operation.
                match (&operation.terminal_id, response.terminal_id.as_deref()) {
                    (Some(existing), Some(process_id)) if existing != process_id => {
                        bail!(
                            "terminal operation {operation_id} changed process id from \
                             {existing} to {process_id}"
                        );
                    }
                    (None, Some(process_id)) => {
                        operation.terminal_id = Some(process_id.to_string());
                    }
                    (Some(_), Some(_)) | (Some(_), None) | (None, None) => {}
                }
                operation.result = Some(response.result);
            }

            (
                operation.terminal_id.clone(),
                operation.execution.started_at_unix_ms,
                operation.execution.started_seq,
            )
        };

        if let Some(terminal_id) = terminal_id {
            self.ensure_terminal_session(
                thread_id,
                &terminal_id,
                operation_id,
                started_at_unix_ms,
                started_seq,
            )?;
        }

        Ok(())
    }

    fn ensure_terminal_session(
        &mut self,
        thread_id: &str,
        terminal_id: &str,
        operation_id: &str,
        started_at_unix_ms: i64,
        started_seq: RawEventSeq,
    ) -> Result<()> {
        if !self.rollout.terminal_sessions.contains_key(terminal_id) {
            self.rollout.terminal_sessions.insert(
                terminal_id.to_string(),
                TerminalSession {
                    terminal_id: terminal_id.to_string(),
                    thread_id: thread_id.to_string(),
                    created_by_operation_id: operation_id.to_string(),
                    operation_ids: Vec::new(),
                    execution: ExecutionWindow {
                        started_at_unix_ms,
                        started_seq,
                        // Current raw events do not report a terminal/session
                        // shutdown boundary, so the session remains open even
                        // after individual operations complete.
                        ended_at_unix_ms: None,
                        ended_seq: None,
                        status: ExecutionStatus::Running,
                    },
                },
            );
        }

        let Some(session) = self.rollout.terminal_sessions.get_mut(terminal_id) else {
            bail!("terminal session {terminal_id} disappeared during reduction");
        };
        if session.thread_id != thread_id {
            bail!(
                "terminal session {terminal_id} belongs to thread {}, not {thread_id}",
                session.thread_id
            );
        }
        push_unique(&mut session.operation_ids, operation_id);
        Ok(())
    }

    /// Mirrors model-visible tool items onto the terminal observation view.
    ///
    /// Runtime terminal rows are useful on their own, but the model-visible call
    /// and output item ids let viewers jump between transcript and terminal timelines.
    pub(in crate::reducer) fn sync_terminal_model_observation(
        &mut self,
        tool_call_id: &str,
    ) -> Result<()> {
        let Some(tool_call) = self.rollout.tool_calls.get(tool_call_id) else {
            bail!("tool call {tool_call_id} disappeared during terminal observation linking");
        };
        let Some(operation_id) = tool_call.terminal_operation_id.clone() else {
            return Ok(());
        };
        let call_item_ids = tool_call.model_visible_call_item_ids.clone();
        let output_item_ids = tool_call.model_visible_output_item_ids.clone();
        if call_item_ids.is_empty() && output_item_ids.is_empty() {
            return Ok(());
        }

        let Some(operation) = self.rollout.terminal_operations.get_mut(&operation_id) else {
            bail!("terminal operation {operation_id} disappeared during observation linking");
        };
        // A terminal result and a model-visible tool output are intentionally
        // separate: the former is what the runtime saw, the latter is what later
        // inference payloads prove was shown back to the model.
        if let Some(observation) = operation
            .model_observations
            .iter_mut()
            .find(|observation| observation.source == TerminalObservationSource::DirectToolCall)
        {
            observation.call_item_ids = call_item_ids;
            observation.output_item_ids = output_item_ids;
        } else {
            operation.model_observations.push(TerminalModelObservation {
                call_item_ids,
                output_item_ids,
                source: TerminalObservationSource::DirectToolCall,
            });
        }
        Ok(())
    }

    fn next_terminal_operation_id(&mut self) -> TerminalOperationId {
        let ordinal = self.next_terminal_operation_ordinal;
        self.next_terminal_operation_ordinal += 1;
        format!("terminal_operation:{ordinal}")
    }
}

fn terminal_operation_kind(kind: &ToolCallKind) -> Option<TerminalOperationKind> {
    match kind {
        ToolCallKind::ExecCommand => Some(TerminalOperationKind::ExecCommand),
        ToolCallKind::WriteStdin => Some(TerminalOperationKind::WriteStdin),
        ToolCallKind::ApplyPatch
        | ToolCallKind::Mcp { .. }
        | ToolCallKind::Web
        | ToolCallKind::ImageGeneration
        | ToolCallKind::SpawnAgent
        | ToolCallKind::AssignAgentTask
        | ToolCallKind::SendMessage
        | ToolCallKind::WaitAgent
        | ToolCallKind::CloseAgent
        | ToolCallKind::Other { .. } => None,
    }
}

struct TerminalOperationStart<'a> {
    seq: RawEventSeq,
    wall_time_unix_ms: i64,
    thread_id: &'a str,
    tool_call_id: &'a str,
    operation_kind: TerminalOperationKind,
    raw_payload: &'a RawPayloadRef,
    request: ParsedTerminalRequest,
}

struct ParsedTerminalRequest {
    terminal_id: Option<String>,
    request: TerminalRequest,
}

struct ParsedTerminalResponse {
    terminal_id: Option<String>,
    result: TerminalResult,
}

fn parse_protocol_terminal_request(
    payload: ExecCommandBeginPayload,
    operation_kind: &TerminalOperationKind,
) -> ParsedTerminalRequest {
    // Startup/poll paths usually include a process id at begin time, but plain
    // exec starts may only learn it in the matching end event.
    let terminal_id = payload.process_id.clone();
    let request = match operation_kind {
        TerminalOperationKind::ExecCommand => TerminalRequest::ExecCommand {
            display_command: payload.command.join(" "),
            command: payload.command,
            cwd: payload.cwd,
            yield_time_ms: None,
            max_output_tokens: None,
        },
        TerminalOperationKind::WriteStdin => TerminalRequest::WriteStdin {
            stdin: payload.interaction_input.unwrap_or_default(),
            yield_time_ms: None,
            max_output_tokens: None,
        },
    };
    ParsedTerminalRequest {
        terminal_id,
        request,
    }
}

fn parse_dispatch_terminal_request(value: JsonValue) -> Result<ParsedTerminalRequest> {
    let payload: DispatchedToolTraceRequestPayload = serde_json::from_value(value)?;
    if payload.tool_name != "write_stdin" {
        bail!(
            "dispatch terminal request is for {}, not write_stdin",
            payload.tool_name
        );
    }
    if payload.payload.kind != "function" {
        bail!(
            "write_stdin dispatch payload used unsupported {} payload",
            payload.payload.kind
        );
    }
    let arguments = payload
        .payload
        .arguments
        .context("write_stdin dispatch payload omitted function arguments")?;
    let args: DispatchedWriteStdinArgs = serde_json::from_str(&arguments)
        .context("parse write_stdin dispatch function arguments")?;
    let terminal_id = terminal_id_from_json(&args.session_id)
        .context("write_stdin dispatch payload omitted session_id")?;

    Ok(ParsedTerminalRequest {
        terminal_id: Some(terminal_id),
        request: TerminalRequest::WriteStdin {
            stdin: args.chars,
            yield_time_ms: args.yield_time_ms,
            max_output_tokens: args.max_output_tokens,
        },
    })
}

fn parse_terminal_response_payload(
    value: JsonValue,
    operation_kind: &TerminalOperationKind,
    raw_payload_id: &str,
) -> Result<ParsedTerminalResponse> {
    match operation_kind {
        TerminalOperationKind::ExecCommand => {
            let payload = serde_json::from_value::<ExecCommandEndPayload>(value)
                .with_context(|| format!("parse exec terminal response {raw_payload_id}"))?;
            Ok(parse_protocol_terminal_response(payload))
        }
        TerminalOperationKind::WriteStdin => {
            match serde_json::from_value::<ExecCommandEndPayload>(value.clone()) {
                Ok(payload) => Ok(parse_protocol_terminal_response(payload)),
                Err(protocol_err) => parse_dispatch_terminal_response(value).with_context(|| {
                    format!(
                        "parse write_stdin terminal response {raw_payload_id} as protocol payload \
                         ({protocol_err}) or dispatch payload"
                    )
                }),
            }
        }
    }
}

fn parse_protocol_terminal_response(payload: ExecCommandEndPayload) -> ParsedTerminalResponse {
    ParsedTerminalResponse {
        terminal_id: payload.process_id,
        result: TerminalResult {
            exit_code: Some(payload.exit_code),
            stdout: payload.stdout,
            stderr: payload.stderr,
            formatted_output: Some(payload.formatted_output),
            original_token_count: None,
            chunk_id: None,
        },
    }
}

fn parse_dispatch_terminal_response(value: JsonValue) -> Result<ParsedTerminalResponse> {
    let payload: DispatchedToolTraceResponsePayload = serde_json::from_value(value)?;
    let result = match payload {
        DispatchedToolTraceResponsePayload::DirectResponse { response_item } => {
            let output = response_item
                .get("output")
                .and_then(json_text_content)
                .unwrap_or_else(|| response_item.to_string());
            TerminalResult {
                exit_code: None,
                stdout: output.clone(),
                stderr: String::new(),
                formatted_output: Some(output),
                original_token_count: None,
                chunk_id: None,
            }
        }
        DispatchedToolTraceResponsePayload::CodeModeResponse { value } => {
            // Code-mode returns the JavaScript-facing tool value, not the text
            // shown to the model. For write_stdin that value is the structured
            // unified-exec result, so keep ToolCall.raw_result_payload_id as the
            // raw boundary while projecting terminal-specific fields here.
            parse_code_mode_exec_result(value)
        }
        DispatchedToolTraceResponsePayload::Error { error } => TerminalResult {
            exit_code: None,
            stdout: String::new(),
            stderr: error.clone(),
            formatted_output: Some(error),
            original_token_count: None,
            chunk_id: None,
        },
    };
    Ok(ParsedTerminalResponse {
        terminal_id: None,
        result,
    })
}

fn parse_code_mode_exec_result(value: JsonValue) -> TerminalResult {
    match serde_json::from_value::<CodeModeExecResult>(value.clone()) {
        Ok(result) => TerminalResult {
            exit_code: result.exit_code,
            stdout: result.output.clone(),
            stderr: String::new(),
            formatted_output: Some(result.output),
            original_token_count: result.original_token_count,
            chunk_id: result.chunk_id,
        },
        Err(_) => {
            let output = json_text_content(&value).unwrap_or_else(|| value.to_string());
            TerminalResult {
                exit_code: None,
                stdout: output.clone(),
                stderr: String::new(),
                formatted_output: Some(output),
                original_token_count: None,
                chunk_id: None,
            }
        }
    }
}

fn json_text_content(value: &JsonValue) -> Option<String> {
    match value {
        JsonValue::String(text) => Some(text.clone()),
        JsonValue::Array(items) => {
            let text = items
                .iter()
                .filter_map(|item| item.get("text").and_then(JsonValue::as_str))
                .collect::<Vec<_>>()
                .join("\n");
            (!text.is_empty()).then_some(text)
        }
        JsonValue::Null => None,
        other => Some(other.to_string()),
    }
}

fn terminal_id_from_json(value: &JsonValue) -> Option<String> {
    match value {
        JsonValue::String(value) if !value.is_empty() => Some(value.clone()),
        JsonValue::Number(value) => Some(value.to_string()),
        _ => None,
    }
}

#[derive(Deserialize)]
struct ExecCommandBeginPayload {
    process_id: Option<String>,
    command: Vec<String>,
    cwd: String,
    interaction_input: Option<String>,
}

#[derive(Deserialize)]
struct ExecCommandEndPayload {
    process_id: Option<String>,
    stdout: String,
    stderr: String,
    exit_code: i32,
    formatted_output: String,
}

#[derive(Deserialize)]
struct DispatchedToolTraceRequestPayload {
    tool_name: String,
    payload: DispatchedToolPayload,
}

#[derive(Deserialize)]
struct DispatchedToolPayload {
    #[serde(rename = "type")]
    kind: String,
    arguments: Option<String>,
}

#[derive(Deserialize)]
struct DispatchedWriteStdinArgs {
    session_id: JsonValue,
    #[serde(default)]
    chars: String,
    yield_time_ms: Option<u64>,
    max_output_tokens: Option<usize>,
}

#[derive(Deserialize)]
#[serde(rename_all = "snake_case", tag = "type")]
enum DispatchedToolTraceResponsePayload {
    DirectResponse { response_item: JsonValue },
    CodeModeResponse { value: JsonValue },
    Error { error: String },
}

#[derive(Deserialize)]
struct CodeModeExecResult {
    chunk_id: Option<String>,
    exit_code: Option<i32>,
    original_token_count: Option<usize>,
    output: String,
}

#[cfg(test)]
#[path = "terminal_tests.rs"]
mod tests;