-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTurnExecutionTypes.cs
More file actions
987 lines (821 loc) · 45.6 KB
/
Copy pathTurnExecutionTypes.cs
File metadata and controls
987 lines (821 loc) · 45.6 KB
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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
using System.Text;
using System.Text.Json.Nodes;
namespace Incursa.OpenAI.Codex;
/// <summary>
/// Stable category for a normalized Codex turn event.
/// </summary>
public enum CodexTurnEventKind
{
/// <summary>Low-value execution progress.</summary>
Progress,
/// <summary>Meaningful turn activity.</summary>
Activity,
/// <summary>Partial streamed assistant text.</summary>
AssistantDelta,
/// <summary>Concrete assistant message content.</summary>
AssistantMessage,
/// <summary>Final assistant response content.</summary>
FinalResponse,
/// <summary>Generated or referenced artifact.</summary>
Artifact,
/// <summary>User approval is needed before work can continue.</summary>
ApprovalNeeded,
/// <summary>Error or failure information.</summary>
Error,
/// <summary>The turn reached a terminal, incomplete, or lost state.</summary>
Terminal,
}
/// <summary>
/// Relative importance for a normalized Codex turn event.
/// </summary>
public enum CodexTurnEventImportance
{
/// <summary>Noise that most user interfaces can hide by default.</summary>
Low,
/// <summary>Normal turn activity.</summary>
Normal,
/// <summary>Important activity or output.</summary>
High,
/// <summary>Critical failure or user action required.</summary>
Critical,
}
/// <summary>
/// Terminal state inferred from the Codex terminal event or stream closeout.
/// </summary>
public enum CodexTurnTerminalState
{
/// <summary>No terminal state has been observed yet.</summary>
None,
/// <summary>Codex reported that the turn completed successfully.</summary>
Completed,
/// <summary>Codex reported that the turn failed.</summary>
Failed,
/// <summary>Codex reported that the turn was interrupted.</summary>
Interrupted,
/// <summary>The event stream ended before a Codex terminal event was observed.</summary>
Incomplete,
/// <summary>The terminal state was not recognized.</summary>
Unknown,
}
/// <summary>
/// Source used to populate a turn's final response.
/// </summary>
public enum CodexFinalResponseSource
{
/// <summary>No final response text was captured.</summary>
None,
/// <summary>The final response came from the terminal turn event.</summary>
TerminalEvent,
/// <summary>The final response came from a completed assistant message item before the terminal event.</summary>
CompletedItem,
/// <summary>The final response came from accumulated assistant text deltas.</summary>
AssistantDelta,
}
/// <summary>
/// Summary of an artifact referenced or produced during a turn.
/// </summary>
public sealed record CodexTurnArtifactSummary
{
/// <summary>Gets or sets the artifact item identifier.</summary>
public string Id { get; init; } = "";
/// <summary>Gets or sets the raw Codex item type.</summary>
public string Type { get; init; } = "";
/// <summary>Gets or sets the artifact path, if one was reported.</summary>
public string? Path { get; init; }
/// <summary>Gets or sets the artifact result value, if one was reported.</summary>
public string? Result { get; init; }
/// <summary>Gets or sets the artifact status, if one was reported.</summary>
public string? Status { get; init; }
}
/// <summary>
/// Normalized turn event suitable for UI, tracing, and diagnostics clients.
/// </summary>
public sealed record CodexTurnEvent
{
/// <summary>Gets or sets the monotonically increasing event sequence number for this turn.</summary>
public long SequenceNumber { get; init; }
/// <summary>Gets or sets the project or workspace identifier, when available.</summary>
public string? ProjectId { get; init; }
/// <summary>Gets or sets the working directory associated with the turn, when available.</summary>
public string? WorkingDirectory { get; init; }
/// <summary>Gets or sets the thread identifier.</summary>
public string ThreadId { get; init; } = "";
/// <summary>Gets or sets the turn identifier.</summary>
public string TurnId { get; init; } = "";
/// <summary>Gets or sets the raw Codex event type.</summary>
public string RawEventType { get; init; } = "";
/// <summary>Gets or sets the stable normalized event kind.</summary>
public CodexTurnEventKind Kind { get; init; }
/// <summary>Gets or sets the event importance.</summary>
public CodexTurnEventImportance Importance { get; init; }
/// <summary>Gets or sets when the SDK normalized this event.</summary>
public DateTimeOffset Timestamp { get; init; }
/// <summary>Gets or sets the short event title, when applicable.</summary>
public string? Title { get; init; }
/// <summary>Gets or sets the event body text, when applicable.</summary>
public string? Text { get; init; }
/// <summary>Gets or sets structured event metadata.</summary>
public IReadOnlyDictionary<string, string?> Metadata { get; init; } = new Dictionary<string, string?>(StringComparer.Ordinal);
/// <summary>Gets or sets a value indicating whether this event represents turn closeout.</summary>
public bool IsTerminal { get; init; }
/// <summary>Gets or sets the terminal state represented by this event, if any.</summary>
public CodexTurnTerminalState TerminalState { get; init; }
/// <summary>Gets or sets a value indicating whether this event contributes to assistant output capture.</summary>
public bool ContributesToFinalOutput { get; init; }
/// <summary>Gets or sets a value indicating whether a UI can present this event by default.</summary>
public bool IsUserVisibleByDefault { get; init; }
}
/// <summary>
/// Detailed result for a Codex turn after the event stream ends.
/// </summary>
public sealed record CodexTurnResult
{
/// <summary>Gets or sets the project or workspace identifier, when available.</summary>
public string? ProjectId { get; init; }
/// <summary>Gets or sets the working directory associated with the turn, when available.</summary>
public string? WorkingDirectory { get; init; }
/// <summary>Gets or sets the thread identifier.</summary>
public string ThreadId { get; init; } = "";
/// <summary>Gets or sets the turn identifier.</summary>
public string TurnId { get; init; } = "";
/// <summary>Gets or sets the normalized terminal state.</summary>
public CodexTurnTerminalState TerminalState { get; init; }
/// <summary>Gets or sets the raw Codex turn status, when available.</summary>
public CodexTurnStatus? TurnStatus { get; init; }
/// <summary>Gets or sets a value indicating whether a Codex terminal event was observed.</summary>
public bool TerminalEventSeen { get; init; }
/// <summary>Gets or sets the raw terminal event type, when one was observed.</summary>
public string? TerminalEventType { get; init; }
/// <summary>Gets or sets the final assistant response text, when captured.</summary>
public string? FinalResponseText { get; init; }
/// <summary>Gets or sets the source used to populate the final response.</summary>
public CodexFinalResponseSource FinalResponseSource { get; init; }
/// <summary>Gets or sets a value indicating whether the SDK saw a complete final response source.</summary>
public bool FinalResponseComplete { get; init; }
/// <summary>Gets or sets the terminal or stream error message, when available.</summary>
public string? ErrorMessage { get; init; }
/// <summary>Gets or sets when the SDK started observing the turn.</summary>
public DateTimeOffset StartedUtc { get; init; }
/// <summary>Gets or sets when the SDK observed turn closeout or stream end.</summary>
public DateTimeOffset? CompletedUtc { get; init; }
/// <summary>Gets or sets the raw Codex event count observed by the SDK.</summary>
public int RawEventCount { get; init; }
/// <summary>Gets or sets the normalized Codex event count produced by the SDK.</summary>
public int NormalizedEventCount { get; init; }
/// <summary>Gets or sets the number of assistant output characters observed from messages and deltas.</summary>
public int AssistantOutputCharCount { get; init; }
/// <summary>Gets or sets the final response character count.</summary>
public int FinalResponseCharCount { get; init; }
/// <summary>Gets or sets artifact summaries captured during the turn.</summary>
public IReadOnlyList<CodexTurnArtifactSummary> Artifacts { get; init; } = [];
/// <summary>Gets or sets the final thread items captured for the turn.</summary>
public IReadOnlyList<CodexThreadItem> Items { get; init; } = [];
/// <summary>Gets or sets token usage reported for the turn, when available.</summary>
public CodexUsage? Usage { get; init; }
/// <summary>Gets or sets the diagnostics trace identifier, when supplied by a host application.</summary>
public string? DiagnosticsTraceId { get; init; }
}
internal sealed class CodexTurnOutcomeBuilder
{
private const string SyntheticStreamEndedType = "turn.stream.ended";
private const string SyntheticStreamFailedType = "turn.stream.failed";
private readonly Func<DateTimeOffset> _clock;
private readonly List<CodexThreadItem> _items = [];
private readonly List<CodexTurnArtifactSummary> _artifacts = [];
private readonly StringBuilder _assistantDeltas = new();
private string _threadId;
private string _turnId;
private string? _finalResponseText;
private CodexFinalResponseSource _finalResponseSource;
private string? _lastEmittedFinalResponseText;
private CodexTurnTerminalState _terminalState;
private CodexTurnStatus? _turnStatus;
private string? _terminalEventType;
private string? _errorMessage;
private CodexUsage? _usage;
private DateTimeOffset? _completedUtc;
private long _sequenceNumber;
public CodexTurnOutcomeBuilder(
string? threadId,
string? turnId,
string? workingDirectory,
Func<DateTimeOffset>? clock = null,
string? projectId = null,
string? diagnosticsTraceId = null)
{
_threadId = string.IsNullOrWhiteSpace(threadId) ? string.Empty : threadId!;
_turnId = string.IsNullOrWhiteSpace(turnId) ? string.Empty : turnId!;
WorkingDirectory = string.IsNullOrWhiteSpace(workingDirectory) ? null : workingDirectory;
ProjectId = string.IsNullOrWhiteSpace(projectId) ? null : projectId;
DiagnosticsTraceId = string.IsNullOrWhiteSpace(diagnosticsTraceId) ? null : diagnosticsTraceId;
_clock = clock ?? (() => DateTimeOffset.UtcNow);
StartedUtc = _clock();
}
public string? ProjectId { get; }
public string? WorkingDirectory { get; }
public string? DiagnosticsTraceId { get; }
public DateTimeOffset StartedUtc { get; }
public int RawEventCount { get; private set; }
public int NormalizedEventCount { get; private set; }
public bool TerminalEventSeen { get; private set; }
public IReadOnlyList<CodexTurnEvent> Process(CodexThreadEvent evt)
{
RawEventCount++;
DateTimeOffset timestamp = _clock();
List<CodexTurnEvent> events = [];
switch (evt)
{
case CodexThreadStartedEvent threadStarted:
BindThreadId(threadStarted.Thread.Id);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Thread started", threadStarted.Thread.Name ?? threadStarted.Thread.Id, timestamp, isUserVisibleByDefault: false);
break;
case CodexTurnStartedEvent turnStarted:
BindThreadId(turnStarted.ThreadId);
ApplyTurnRecord(turnStarted.Turn);
_terminalState = CodexTurnTerminalState.None;
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Turn started", turnStarted.Turn.Id, timestamp, Metadata("status", turnStarted.Turn.Status.ToString()), isUserVisibleByDefault: false);
break;
case CodexAgentMessageDeltaEvent agentDelta:
BindThreadId(agentDelta.ThreadId);
BindTurnId(agentDelta.TurnId);
RecordAssistantDelta(agentDelta.Delta);
AddEvent(events, evt.Type, CodexTurnEventKind.AssistantDelta, CodexTurnEventImportance.High, "Assistant response delta", agentDelta.Delta, timestamp, Metadata("itemId", agentDelta.ItemId), contributesToFinalOutput: true, isUserVisibleByDefault: true);
break;
case CodexItemCompletedEvent completed:
BindThreadId(completed.ThreadId);
BindTurnId(completed.TurnId);
_items.Add(completed.Item);
AddItemCompletedEvents(events, evt.Type, completed.Item, timestamp);
break;
case CodexItemStartedEvent started:
BindThreadId(started.ThreadId);
BindTurnId(started.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, DescribeItemTitle("Item started", started.Item), DescribeItemText(started.Item), timestamp, DescribeItemMetadata(started.Item), isUserVisibleByDefault: false);
break;
case CodexItemUpdatedEvent updated:
BindThreadId(updated.ThreadId);
BindTurnId(updated.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, DescribeItemTitle("Item updated", updated.Item), DescribeItemText(updated.Item), timestamp, DescribeItemMetadata(updated.Item), isUserVisibleByDefault: false);
break;
case CodexTurnCompletedEvent completedTurn:
BindThreadId(completedTurn.ThreadId);
ApplyTerminalTurn(evt.Type, completedTurn.Turn, timestamp, events);
break;
case CodexTurnFailedEvent failedTurn:
BindThreadId(failedTurn.ThreadId);
ApplyTerminalTurn(evt.Type, failedTurn.Turn, timestamp, events);
break;
case CodexThreadErrorEvent threadError:
BindThreadId(threadError.ThreadId);
BindTurnId(threadError.TurnId);
_errorMessage = threadError.Error.Message;
AddEvent(events, evt.Type, CodexTurnEventKind.Error, CodexTurnEventImportance.Critical, "Thread error", threadError.Error.Message, timestamp, Metadata("willRetry", threadError.WillRetry.ToString()), isUserVisibleByDefault: true);
break;
case CodexTurnPlanUpdatedEvent planUpdated:
BindThreadId(planUpdated.ThreadId);
BindTurnId(planUpdated.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Plan updated", planUpdated.Explanation, timestamp, Metadata("planStepCount", planUpdated.Plan.Count.ToString()), isUserVisibleByDefault: true);
break;
case CodexPlanDeltaEvent planDelta:
BindThreadId(planDelta.ThreadId);
BindTurnId(planDelta.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Plan delta", planDelta.Delta, timestamp, Metadata("itemId", planDelta.ItemId), isUserVisibleByDefault: false);
break;
case CodexCommandExecutionOutputDeltaEvent commandDelta:
BindThreadId(commandDelta.ThreadId);
BindTurnId(commandDelta.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Normal, "Command output", commandDelta.Delta, timestamp, Metadata("itemId", commandDelta.ItemId), isUserVisibleByDefault: false);
break;
case CodexCommandExecutionTerminalInteractionEvent terminalInteraction:
BindThreadId(terminalInteraction.ThreadId);
BindTurnId(terminalInteraction.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Terminal interaction", terminalInteraction.Stdin, timestamp, Metadata("itemId", terminalInteraction.ItemId, "processId", terminalInteraction.ProcessId), isUserVisibleByDefault: false);
break;
case CodexCommandExecOutputDeltaEvent commandExecDelta:
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Normal, "Command exec output", commandExecDelta.DeltaBase64, timestamp, Metadata("processId", commandExecDelta.ProcessId, "stream", commandExecDelta.Stream.ToString(), "capReached", commandExecDelta.CapReached.ToString()), isUserVisibleByDefault: false);
break;
case CodexFileChangeOutputDeltaEvent fileChangeDelta:
BindThreadId(fileChangeDelta.ThreadId);
BindTurnId(fileChangeDelta.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Normal, "File change output", fileChangeDelta.Delta, timestamp, Metadata("itemId", fileChangeDelta.ItemId), isUserVisibleByDefault: false);
break;
case CodexFileChangePatchUpdatedEvent fileChangePatch:
BindThreadId(fileChangePatch.ThreadId);
BindTurnId(fileChangePatch.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "File change patch updated", null, timestamp, Metadata("itemId", fileChangePatch.ItemId, "changeCount", fileChangePatch.Changes.Count.ToString()), isUserVisibleByDefault: false);
break;
case CodexMcpToolCallProgressEvent mcpProgress:
BindThreadId(mcpProgress.ThreadId);
BindTurnId(mcpProgress.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Normal, "MCP tool progress", mcpProgress.Message, timestamp, Metadata("itemId", mcpProgress.ItemId), isUserVisibleByDefault: false);
break;
case CodexReasoningTextDeltaEvent reasoningText:
BindThreadId(reasoningText.ThreadId);
BindTurnId(reasoningText.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, "Reasoning text delta", reasoningText.Delta, timestamp, Metadata("itemId", reasoningText.ItemId, "contentIndex", reasoningText.ContentIndex.ToString()), isUserVisibleByDefault: false);
break;
case CodexReasoningSummaryPartAddedEvent reasoningSummaryPart:
BindThreadId(reasoningSummaryPart.ThreadId);
BindTurnId(reasoningSummaryPart.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, "Reasoning summary part added", null, timestamp, Metadata("itemId", reasoningSummaryPart.ItemId, "summaryIndex", reasoningSummaryPart.SummaryIndex.ToString()), isUserVisibleByDefault: false);
break;
case CodexReasoningSummaryTextDeltaEvent reasoningSummary:
BindThreadId(reasoningSummary.ThreadId);
BindTurnId(reasoningSummary.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, "Reasoning summary delta", reasoningSummary.Delta, timestamp, Metadata("itemId", reasoningSummary.ItemId, "summaryIndex", reasoningSummary.SummaryIndex.ToString()), isUserVisibleByDefault: false);
break;
case CodexTurnDiffUpdatedEvent diffUpdated:
BindThreadId(diffUpdated.ThreadId);
BindTurnId(diffUpdated.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Turn diff updated", diffUpdated.Diff, timestamp, Metadata("diffLength", diffUpdated.Diff.Length.ToString()), isUserVisibleByDefault: false);
break;
case CodexThreadTokenUsageUpdatedEvent tokenUsage:
BindThreadId(tokenUsage.ThreadId);
BindTurnId(tokenUsage.TurnId);
_usage = tokenUsage.TokenUsage;
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, "Token usage updated", null, timestamp, Metadata("lastTokens", tokenUsage.TokenUsage.Last.TotalTokens.ToString(), "totalTokens", tokenUsage.TokenUsage.Total.TotalTokens.ToString()), isUserVisibleByDefault: false);
break;
case CodexThreadGoalUpdatedEvent goalUpdated:
BindThreadId(goalUpdated.ThreadId);
BindTurnId(goalUpdated.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Goal updated", goalUpdated.Goal.Objective, timestamp, Metadata("status", goalUpdated.Goal.Status.ToString(), "tokenBudget", goalUpdated.Goal.TokenBudget?.ToString(), "tokensUsed", goalUpdated.Goal.TokensUsed.ToString()), isUserVisibleByDefault: true);
break;
case CodexThreadGoalClearedEvent goalCleared:
BindThreadId(goalCleared.ThreadId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Goal cleared", null, timestamp, isUserVisibleByDefault: true);
break;
case CodexThreadSettingsUpdatedEvent settingsUpdated:
BindThreadId(settingsUpdated.ThreadId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Thread settings updated", null, timestamp, Metadata("hasSettings", (settingsUpdated.ThreadSettings is not null).ToString()), isUserVisibleByDefault: false);
break;
case CodexItemAutoApprovalReviewStartedEvent reviewStarted:
BindThreadId(reviewStarted.ThreadId);
BindTurnId(reviewStarted.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Auto-approval review started", null, timestamp, Metadata("reviewId", reviewStarted.ReviewId, "targetItemId", reviewStarted.TargetItemId), isUserVisibleByDefault: false);
break;
case CodexItemAutoApprovalReviewCompletedEvent reviewCompleted:
BindThreadId(reviewCompleted.ThreadId);
BindTurnId(reviewCompleted.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Auto-approval review completed", null, timestamp, Metadata("reviewId", reviewCompleted.ReviewId, "targetItemId", reviewCompleted.TargetItemId, "decisionSource", reviewCompleted.DecisionSource), isUserVisibleByDefault: false);
break;
case CodexHookStartedEvent hookStarted:
BindThreadId(hookStarted.ThreadId);
BindTurnId(hookStarted.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, "Hook started", hookStarted.Run.StatusMessage, timestamp, DescribeHookMetadata(hookStarted.Run), isUserVisibleByDefault: false);
break;
case CodexHookCompletedEvent hookCompleted:
BindThreadId(hookCompleted.ThreadId);
BindTurnId(hookCompleted.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, "Hook completed", hookCompleted.Run.StatusMessage, timestamp, DescribeHookMetadata(hookCompleted.Run), isUserVisibleByDefault: false);
break;
case CodexModelReroutedEvent modelRerouted:
BindThreadId(modelRerouted.ThreadId);
BindTurnId(modelRerouted.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.High, "Model rerouted", $"{modelRerouted.FromModel} -> {modelRerouted.ToModel}", timestamp, Metadata("reason", modelRerouted.Reason.ToString()), isUserVisibleByDefault: true);
break;
case CodexModelVerificationEvent modelVerification:
BindThreadId(modelVerification.ThreadId);
BindTurnId(modelVerification.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Model verification", null, timestamp, Metadata("verificationCount", modelVerification.Verifications.Count.ToString()), isUserVisibleByDefault: false);
break;
case CodexAccountRateLimitsUpdatedEvent rateLimits:
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Rate limits updated", rateLimits.RateLimits.LimitId, timestamp, Metadata("planType", rateLimits.RateLimits.PlanType.ToString(), "primaryUsedPercent", rateLimits.RateLimits.Primary?.UsedPercent.ToString()), isUserVisibleByDefault: false);
break;
case CodexWarningEvent warning:
BindThreadId(warning.ThreadId);
AddEvent(events, evt.Type, CodexTurnEventKind.Error, CodexTurnEventImportance.High, "Warning", warning.Message, timestamp, isUserVisibleByDefault: true);
break;
case CodexConfigWarningEvent configWarning:
AddEvent(events, evt.Type, CodexTurnEventKind.Error, CodexTurnEventImportance.High, "Config warning", configWarning.Summary, timestamp, Metadata("path", configWarning.Path, "details", configWarning.Details), isUserVisibleByDefault: true);
break;
case CodexDeprecationNoticeEvent deprecation:
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Deprecation notice", deprecation.Summary, timestamp, Metadata("details", deprecation.Details), isUserVisibleByDefault: true);
break;
case CodexGuardianWarningEvent guardianWarning:
BindThreadId(guardianWarning.ThreadId);
AddEvent(events, evt.Type, CodexTurnEventKind.Error, CodexTurnEventImportance.High, "Guardian warning", guardianWarning.Message, timestamp, isUserVisibleByDefault: true);
break;
case CodexThreadRealtimeTranscriptDeltaEvent transcriptDelta:
BindThreadId(transcriptDelta.ThreadId);
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Normal, "Realtime transcript delta", transcriptDelta.Delta, timestamp, Metadata("role", transcriptDelta.Role), isUserVisibleByDefault: false);
break;
case CodexThreadRealtimeTranscriptDoneEvent transcriptDone:
BindThreadId(transcriptDone.ThreadId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "Realtime transcript", transcriptDone.Text, timestamp, Metadata("role", transcriptDone.Role), isUserVisibleByDefault: true);
break;
case CodexRawResponseItemCompletedEvent rawResponseItem:
BindThreadId(rawResponseItem.ThreadId);
BindTurnId(rawResponseItem.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Low, "Raw response item completed", null, timestamp, Metadata("hasItem", (rawResponseItem.Item is not null).ToString()), isUserVisibleByDefault: false);
break;
case CodexExternalAgentConfigImportCompletedEvent:
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, "External agent config import completed", null, timestamp, isUserVisibleByDefault: false);
break;
case CodexThreadCompactedEvent compacted:
BindThreadId(compacted.ThreadId);
BindTurnId(compacted.TurnId);
AddEvent(events, evt.Type, CodexTurnEventKind.Activity, CodexTurnEventImportance.High, "Thread compacted", null, timestamp, isUserVisibleByDefault: true);
break;
case CodexUnknownThreadEvent unknown when IsUnknownAgentMessageDelta(unknown, out string? delta):
BindThreadId(GetString(unknown.RawPayload, "threadId"));
BindTurnId(GetString(unknown.RawPayload, "turnId"));
RecordAssistantDelta(delta);
AddEvent(events, unknown.UnknownType, CodexTurnEventKind.AssistantDelta, CodexTurnEventImportance.High, "Assistant response delta", delta, timestamp, contributesToFinalOutput: true, isUserVisibleByDefault: true);
break;
case CodexUnknownThreadEvent unknown when IsApprovalRequestType(unknown.UnknownType):
BindThreadId(GetString(unknown.RawPayload, "threadId"));
BindTurnId(GetString(unknown.RawPayload, "turnId"));
AddEvent(events, unknown.UnknownType, CodexTurnEventKind.ApprovalNeeded, CodexTurnEventImportance.Critical, "Approval needed", null, timestamp, isUserVisibleByDefault: true);
break;
default:
AddEvent(events, evt.Type, CodexTurnEventKind.Progress, CodexTurnEventImportance.Low, evt.Type, null, timestamp, isUserVisibleByDefault: false);
break;
}
return events;
}
public IReadOnlyList<CodexTurnEvent> CompleteStream()
{
if (TerminalEventSeen)
{
return [];
}
List<CodexTurnEvent> events = [];
DateTimeOffset timestamp = _clock();
_completedUtc = timestamp;
_terminalState = CodexTurnTerminalState.Incomplete;
ResolveFallbackFinalResponse(finalResponseComplete: false, events, timestamp);
AddEvent(
events,
SyntheticStreamEndedType,
CodexTurnEventKind.Terminal,
CodexTurnEventImportance.Critical,
"Turn stream ended without a terminal event",
"The SDK did not observe turn.completed or turn.failed.",
timestamp,
isTerminal: true,
terminalState: CodexTurnTerminalState.Incomplete,
isUserVisibleByDefault: true);
return events;
}
public void RecordStreamException(Exception exception)
{
if (TerminalEventSeen)
{
_errorMessage ??= exception.Message;
return;
}
_completedUtc = _clock();
_terminalState = CodexTurnTerminalState.Incomplete;
_terminalEventType = SyntheticStreamFailedType;
_errorMessage = exception.Message;
}
public CodexTurnResult ToResult()
{
ResolveFallbackFinalResponse(finalResponseComplete: TerminalEventSeen, events: null, timestamp: _completedUtc ?? _clock());
return new CodexTurnResult
{
ProjectId = ProjectId,
WorkingDirectory = WorkingDirectory,
ThreadId = _threadId,
TurnId = _turnId,
TerminalState = _terminalState,
TurnStatus = _turnStatus,
TerminalEventSeen = TerminalEventSeen,
TerminalEventType = _terminalEventType,
FinalResponseText = _finalResponseText,
FinalResponseSource = _finalResponseSource,
FinalResponseComplete = !string.IsNullOrWhiteSpace(_finalResponseText) && TerminalEventSeen,
ErrorMessage = _errorMessage,
StartedUtc = StartedUtc,
CompletedUtc = _completedUtc,
RawEventCount = RawEventCount,
NormalizedEventCount = NormalizedEventCount,
AssistantOutputCharCount = CountAssistantOutputCharacters(),
FinalResponseCharCount = _finalResponseText?.Length ?? 0,
Artifacts = _artifacts.ToArray(),
Items = _items.ToArray(),
Usage = _usage,
DiagnosticsTraceId = DiagnosticsTraceId,
};
}
private void ApplyTerminalTurn(string rawEventType, CodexTurnRecord turn, DateTimeOffset timestamp, List<CodexTurnEvent> events)
{
ApplyTurnRecord(turn);
TerminalEventSeen = true;
_terminalEventType = rawEventType;
_terminalState = MapTerminalState(turn.Status);
_completedUtc = timestamp;
if (turn.Items.Count > 0)
{
_items.Clear();
_items.AddRange(turn.Items);
AddArtifactSummaries(turn.Items);
}
if (!string.IsNullOrWhiteSpace(turn.Error?.Message))
{
_errorMessage = turn.Error.Message;
AddEvent(events, rawEventType, CodexTurnEventKind.Error, CodexTurnEventImportance.Critical, "Turn failed", turn.Error.Message, timestamp, isUserVisibleByDefault: true);
}
string? finalResponse = CodexResultHelpers.SelectFinalResponse(_items);
if (!string.IsNullOrWhiteSpace(finalResponse))
{
SetFinalResponse(finalResponse, CodexFinalResponseSource.TerminalEvent, finalResponseComplete: true, events, timestamp);
}
else
{
ResolveFallbackFinalResponse(finalResponseComplete: true, events, timestamp);
}
AddEvent(
events,
rawEventType,
CodexTurnEventKind.Terminal,
_terminalState == CodexTurnTerminalState.Completed ? CodexTurnEventImportance.High : CodexTurnEventImportance.Critical,
_terminalState == CodexTurnTerminalState.Completed ? "Turn completed" : "Turn failed",
_errorMessage,
timestamp,
Metadata("status", turn.Status.ToString()),
isTerminal: true,
terminalState: _terminalState,
isUserVisibleByDefault: true);
}
private void ApplyTurnRecord(CodexTurnRecord turn)
{
BindTurnId(turn.Id);
_turnStatus = turn.Status;
_usage = turn.Usage ?? _usage;
if (!string.IsNullOrWhiteSpace(turn.Error?.Message))
{
_errorMessage = turn.Error.Message;
}
}
private void AddItemCompletedEvents(List<CodexTurnEvent> events, string rawEventType, CodexThreadItem item, DateTimeOffset timestamp)
{
switch (item)
{
case CodexAgentMessageItem agentMessage:
RecordAssistantMessage(agentMessage.Text);
if (agentMessage.Phase == CodexMessagePhase.FinalAnswer)
{
SetFinalResponse(agentMessage.Text, CodexFinalResponseSource.CompletedItem, finalResponseComplete: false, events, timestamp);
}
else
{
AddEvent(events, rawEventType, CodexTurnEventKind.AssistantMessage, CodexTurnEventImportance.Normal, "Assistant message", agentMessage.Text, timestamp, Metadata("phase", agentMessage.Phase?.ToString()), contributesToFinalOutput: agentMessage.Phase is null, isUserVisibleByDefault: agentMessage.Phase is null);
}
break;
case CodexErrorItem error:
_errorMessage = error.Message;
AddEvent(events, rawEventType, CodexTurnEventKind.Error, CodexTurnEventImportance.Critical, "Error", error.Message, timestamp, isUserVisibleByDefault: true);
break;
case CodexImageViewItem or CodexImageGenerationItem:
AddArtifactSummary(item);
AddEvent(events, rawEventType, CodexTurnEventKind.Artifact, CodexTurnEventImportance.High, DescribeItemTitle("Artifact", item), DescribeItemText(item), timestamp, DescribeItemMetadata(item), isUserVisibleByDefault: true);
break;
case CodexFileChangeItem:
AddArtifactSummary(item);
AddEvent(events, rawEventType, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, DescribeItemTitle("Item completed", item), DescribeItemText(item), timestamp, DescribeItemMetadata(item), isUserVisibleByDefault: false);
break;
default:
AddEvent(events, rawEventType, CodexTurnEventKind.Activity, CodexTurnEventImportance.Normal, DescribeItemTitle("Item completed", item), DescribeItemText(item), timestamp, DescribeItemMetadata(item), isUserVisibleByDefault: false);
break;
}
}
private void SetFinalResponse(
string? text,
CodexFinalResponseSource source,
bool finalResponseComplete,
List<CodexTurnEvent>? events,
DateTimeOffset timestamp)
{
if (string.IsNullOrWhiteSpace(text))
{
return;
}
string normalized = text.Trim();
_finalResponseText = normalized;
_finalResponseSource = source;
if (events is not null && !string.Equals(_lastEmittedFinalResponseText, normalized, StringComparison.Ordinal))
{
_lastEmittedFinalResponseText = normalized;
AddEvent(
events,
source == CodexFinalResponseSource.AssistantDelta ? SyntheticStreamEndedType : "turn.finalResponse",
CodexTurnEventKind.FinalResponse,
CodexTurnEventImportance.High,
"Final response",
normalized,
timestamp,
Metadata("source", source.ToString(), "complete", finalResponseComplete.ToString()),
contributesToFinalOutput: true,
isUserVisibleByDefault: true);
}
}
private void ResolveFallbackFinalResponse(bool finalResponseComplete, List<CodexTurnEvent>? events, DateTimeOffset timestamp)
{
if (!string.IsNullOrWhiteSpace(_finalResponseText))
{
return;
}
string? finalResponse = CodexResultHelpers.SelectFinalResponse(_items);
if (!string.IsNullOrWhiteSpace(finalResponse))
{
SetFinalResponse(finalResponse, CodexFinalResponseSource.CompletedItem, finalResponseComplete, events, timestamp);
return;
}
if (_assistantDeltas.Length > 0)
{
SetFinalResponse(_assistantDeltas.ToString(), CodexFinalResponseSource.AssistantDelta, finalResponseComplete, events, timestamp);
}
}
private void AddArtifactSummaries(IEnumerable<CodexThreadItem> items)
{
foreach (CodexThreadItem item in items)
{
AddArtifactSummary(item);
}
}
private void AddArtifactSummary(CodexThreadItem item)
{
CodexTurnArtifactSummary? artifact = item switch
{
CodexImageViewItem imageView => new CodexTurnArtifactSummary
{
Id = imageView.Id,
Type = imageView.Type,
Path = imageView.Path,
},
CodexImageGenerationItem imageGeneration => new CodexTurnArtifactSummary
{
Id = imageGeneration.Id,
Type = imageGeneration.Type,
Path = imageGeneration.SavedPath,
Result = imageGeneration.Result,
Status = imageGeneration.Status,
},
CodexFileChangeItem fileChange => new CodexTurnArtifactSummary
{
Id = fileChange.Id,
Type = fileChange.Type,
Status = fileChange.Status.ToString(),
},
_ => null,
};
if (artifact is null || _artifacts.Any(existing => string.Equals(existing.Id, artifact.Id, StringComparison.Ordinal) && string.Equals(existing.Type, artifact.Type, StringComparison.Ordinal)))
{
return;
}
_artifacts.Add(artifact);
}
private void AddEvent(
List<CodexTurnEvent> events,
string rawEventType,
CodexTurnEventKind kind,
CodexTurnEventImportance importance,
string? title,
string? text,
DateTimeOffset timestamp,
IReadOnlyDictionary<string, string?>? metadata = null,
bool isTerminal = false,
CodexTurnTerminalState terminalState = CodexTurnTerminalState.None,
bool contributesToFinalOutput = false,
bool isUserVisibleByDefault = false)
{
NormalizedEventCount++;
events.Add(new CodexTurnEvent
{
SequenceNumber = ++_sequenceNumber,
ProjectId = ProjectId,
WorkingDirectory = WorkingDirectory,
ThreadId = _threadId,
TurnId = _turnId,
RawEventType = rawEventType,
Kind = kind,
Importance = importance,
Timestamp = timestamp,
Title = title,
Text = text,
Metadata = metadata ?? new Dictionary<string, string?>(StringComparer.Ordinal),
IsTerminal = isTerminal,
TerminalState = terminalState,
ContributesToFinalOutput = contributesToFinalOutput,
IsUserVisibleByDefault = isUserVisibleByDefault,
});
}
private void BindThreadId(string? threadId)
{
if (!string.IsNullOrWhiteSpace(threadId))
{
_threadId = threadId;
}
}
private void BindTurnId(string? turnId)
{
if (!string.IsNullOrWhiteSpace(turnId))
{
_turnId = turnId;
}
}
private void RecordAssistantDelta(string? text)
{
if (!string.IsNullOrEmpty(text))
{
_assistantDeltas.Append(text);
}
}
private void RecordAssistantMessage(string? text)
{
if (!string.IsNullOrWhiteSpace(text))
{
_assistantDeltas.Append(text);
}
}
private int CountAssistantOutputCharacters()
=> Math.Max(_assistantDeltas.Length, _finalResponseText?.Length ?? 0);
private static CodexTurnTerminalState MapTerminalState(CodexTurnStatus status)
=> status switch
{
CodexTurnStatus.Completed => CodexTurnTerminalState.Completed,
CodexTurnStatus.Failed => CodexTurnTerminalState.Failed,
CodexTurnStatus.Interrupted => CodexTurnTerminalState.Interrupted,
CodexTurnStatus.InProgress => CodexTurnTerminalState.Incomplete,
_ => CodexTurnTerminalState.Unknown,
};
private static IReadOnlyDictionary<string, string?> Metadata(params string?[] values)
{
Dictionary<string, string?> metadata = new(StringComparer.Ordinal);
for (int index = 0; index + 1 < values.Length; index += 2)
{
string? key = values[index];
if (!string.IsNullOrWhiteSpace(key))
{
metadata[key] = values[index + 1];
}
}
return metadata;
}
private static string DescribeItemTitle(string prefix, CodexThreadItem item)
=> $"{prefix}: {item.Type}";
private static string? DescribeItemText(CodexThreadItem item)
=> item switch
{
CodexAgentMessageItem agentMessage => agentMessage.Text,
CodexPlanItem plan => plan.Text,
CodexCommandExecutionItem command => command.Command,
CodexMcpToolCallItem mcp => $"{mcp.Server}/{mcp.Tool}",
CodexDynamicToolCallItem dynamicTool => dynamicTool.Tool,
CodexWebSearchItem webSearch => webSearch.Query,
CodexImageViewItem imageView => imageView.Path,
CodexImageGenerationItem imageGeneration => imageGeneration.SavedPath ?? imageGeneration.Result,
CodexErrorItem error => error.Message,
_ => null,
};
private static IReadOnlyDictionary<string, string?> DescribeItemMetadata(CodexThreadItem item)
=> item switch
{
CodexAgentMessageItem agentMessage => Metadata("itemId", agentMessage.Id, "phase", agentMessage.Phase?.ToString()),
CodexCommandExecutionItem command => Metadata("itemId", command.Id, "status", command.Status.ToString(), "exitCode", command.ExitCode?.ToString()),
CodexFileChangeItem fileChange => Metadata("itemId", fileChange.Id, "status", fileChange.Status.ToString(), "changeCount", fileChange.Changes.Count.ToString()),
CodexMcpToolCallItem mcp => Metadata("itemId", mcp.Id, "server", mcp.Server, "tool", mcp.Tool, "status", mcp.Status.ToString()),
CodexDynamicToolCallItem dynamicTool => Metadata("itemId", dynamicTool.Id, "tool", dynamicTool.Tool, "status", dynamicTool.Status.ToString()),
CodexImageViewItem imageView => Metadata("itemId", imageView.Id, "path", imageView.Path),
CodexImageGenerationItem imageGeneration => Metadata("itemId", imageGeneration.Id, "path", imageGeneration.SavedPath, "result", imageGeneration.Result, "status", imageGeneration.Status),
_ => Metadata("itemId", item.Id),
};
private static IReadOnlyDictionary<string, string?> DescribeHookMetadata(CodexHookRunSummary run)
=> Metadata(
"hookRunId", run.Id,
"eventName", run.EventName.ToString(),
"status", run.Status.ToString(),
"handlerType", run.HandlerType.ToString(),
"executionMode", run.ExecutionMode.ToString(),
"source", run.Source.ToString());
private static bool IsUnknownAgentMessageDelta(CodexUnknownThreadEvent unknown, out string? delta)
{
delta = null;
if (!string.Equals(unknown.UnknownType, "item.agentMessage.delta", StringComparison.OrdinalIgnoreCase))
{
return false;
}
delta = GetString(unknown.RawPayload, "delta")
?? GetString(unknown.RawPayload, "text")
?? GetString(GetObject(unknown.RawPayload, "message"), "text");
return !string.IsNullOrEmpty(delta);
}
private static bool IsApprovalRequestType(string type)
=> type.Contains("requestApproval", StringComparison.OrdinalIgnoreCase)
|| type.Contains("approval.required", StringComparison.OrdinalIgnoreCase);
private static JsonObject? GetObject(JsonObject? payload, string name)
=> payload is not null
&& payload.TryGetPropertyValue(name, out JsonNode? node)
&& node is JsonObject obj
? obj
: null;
private static string? GetString(JsonObject? payload, string name)
=> payload is not null
&& payload.TryGetPropertyValue(name, out JsonNode? node)
&& node is JsonValue value
&& value.TryGetValue(out string? text)
&& !string.IsNullOrEmpty(text)
? text
: null;
}