codex_codes/
messages.rs

1//! Typed dispatch for app-server notifications and server-to-client requests.
2//!
3//! The Codex app-server speaks JSON-RPC where every message carries a
4//! `method` discriminant alongside a free-form `params` blob. This module
5//! lifts that loose envelope into closed enums — [`Notification`] for
6//! server-initiated notifications and [`ServerRequest`] for server-initiated
7//! requests (the approval flow). Each variant wraps a typed param struct
8//! from [`crate::protocol`].
9//!
10//! The pattern mirrors the [`ContentBlock`] dispatch in the sibling
11//! `claude-codes` crate: hand-written [`Serialize`]/[`Deserialize`] impls
12//! inspect the discriminant, route known cases through `serde_json::from_value`
13//! into the typed struct, and route unknown methods into an `Unknown`
14//! variant — preserving the raw payload for forward compatibility with
15//! future codex versions.
16//!
17//! ## Typing contract
18//!
19//! - Unknown methods route to [`Notification::Unknown`] / [`ServerRequest::Unknown`]
20//!   without error. Encountering one in production typically means the
21//!   installed Codex CLI is newer than the bindings.
22//! - Known methods whose payload fails to deserialize **do** cause an error.
23//!   If you see one, the typed binding in [`crate::protocol`] is out of
24//!   sync with the wire format and needs to be updated.
25
26use crate::jsonrpc::RequestId;
27use crate::protocol::{
28    methods, AccountLoginCompletedNotification, AccountRateLimitsUpdatedNotification,
29    AccountUpdatedNotification, AgentMessageDeltaNotification, AppListUpdatedNotification,
30    CommandExecOutputDeltaNotification, CommandExecutionOutputDeltaNotification,
31    CommandExecutionRequestApprovalParams, ConfigWarningNotification, ContextCompactedNotification,
32    DeprecationNoticeNotification, ErrorNotification,
33    ExternalAgentConfigImportCompletedNotification, FileChangeOutputDeltaNotification,
34    FileChangePatchUpdatedNotification, FileChangeRequestApprovalParams, FsChangedNotification,
35    FuzzyFileSearchSessionCompletedNotification, FuzzyFileSearchSessionUpdatedNotification,
36    GuardianWarningNotification, HookCompletedNotification, HookStartedNotification,
37    ItemCompletedNotification, ItemGuardianApprovalReviewCompletedNotification,
38    ItemGuardianApprovalReviewStartedNotification, ItemStartedNotification,
39    McpServerOauthLoginCompletedNotification, McpServerStatusUpdatedNotification,
40    McpToolCallProgressNotification, ModelReroutedNotification, ModelVerificationNotification,
41    PlanDeltaNotification, ProcessExitedNotification, ProcessOutputDeltaNotification,
42    ReasoningSummaryPartAddedNotification, ReasoningSummaryTextDeltaNotification,
43    ReasoningTextDeltaNotification, RemoteControlStatusChangedNotification,
44    ServerRequestResolvedNotification, SkillsChangedNotification, TerminalInteractionNotification,
45    ThreadArchivedNotification, ThreadClosedNotification, ThreadGoalClearedNotification,
46    ThreadGoalUpdatedNotification, ThreadNameUpdatedNotification, ThreadRealtimeClosedNotification,
47    ThreadRealtimeErrorNotification, ThreadRealtimeItemAddedNotification,
48    ThreadRealtimeOutputAudioDeltaNotification, ThreadRealtimeSdpNotification,
49    ThreadRealtimeStartedNotification, ThreadRealtimeTranscriptDeltaNotification,
50    ThreadRealtimeTranscriptDoneNotification, ThreadSettingsUpdatedNotification,
51    ThreadStartedNotification, ThreadStatusChangedNotification,
52    ThreadTokenUsageUpdatedNotification, ThreadUnarchivedNotification, TurnCompletedNotification,
53    TurnDiffUpdatedNotification, TurnModerationMetadataNotification, TurnPlanUpdatedNotification,
54    TurnStartedNotification, WarningNotification, WindowsSandboxSetupCompletedNotification,
55    WindowsWorldWritableWarningNotification,
56};
57use serde::{Deserialize, Deserializer, Serialize, Serializer};
58use serde_json::Value;
59
60/// A server-to-client notification.
61///
62/// Each variant maps to a single `method` string on the wire. The `Unknown`
63/// variant captures methods this crate version doesn't model yet, preserving
64/// the raw payload for inspection.
65#[derive(Debug, Clone)]
66pub enum Notification {
67    /// `thread/started`
68    ThreadStarted(ThreadStartedNotification),
69    /// `thread/status/changed`
70    ThreadStatusChanged(ThreadStatusChangedNotification),
71    /// `thread/tokenUsage/updated`
72    ThreadTokenUsageUpdated(ThreadTokenUsageUpdatedNotification),
73    /// `turn/started`
74    TurnStarted(TurnStartedNotification),
75    /// `turn/completed`
76    TurnCompleted(TurnCompletedNotification),
77    /// `item/started`
78    ItemStarted(ItemStartedNotification),
79    /// `item/completed`
80    ItemCompleted(ItemCompletedNotification),
81    /// `item/agentMessage/delta`
82    AgentMessageDelta(AgentMessageDeltaNotification),
83    /// `item/commandExecution/outputDelta`
84    CmdOutputDelta(CommandExecutionOutputDeltaNotification),
85    /// `item/fileChange/outputDelta`
86    FileChangeOutputDelta(FileChangeOutputDeltaNotification),
87    /// `item/reasoning/summaryTextDelta`
88    ReasoningDelta(ReasoningSummaryTextDeltaNotification),
89    /// `error`
90    Error(ErrorNotification),
91    /// `account/rateLimits/updated`
92    AccountRateLimitsUpdated(AccountRateLimitsUpdatedNotification),
93    /// `mcpServer/startupStatus/updated`
94    McpServerStartupStatusUpdated(McpServerStatusUpdatedNotification),
95    /// `remoteControl/status/changed`
96    RemoteControlStatusChanged(RemoteControlStatusChangedNotification),
97    /// `mcpServer/oauthLogin/completed`
98    McpServerOauthLoginCompleted(McpServerOauthLoginCompletedNotification),
99    /// `item/fileChange/patchUpdated`
100    FileChangePatchUpdated(FileChangePatchUpdatedNotification),
101    /// `item/plan/delta` (EXPERIMENTAL)
102    PlanDelta(PlanDeltaNotification),
103    /// `turn/plan/updated`
104    TurnPlanUpdated(TurnPlanUpdatedNotification),
105    /// `turn/diff/updated`
106    TurnDiffUpdated(TurnDiffUpdatedNotification),
107    /// `item/reasoning/summaryPartAdded`
108    ReasoningSummaryPartAdded(ReasoningSummaryPartAddedNotification),
109    /// `item/reasoning/textDelta`
110    ReasoningTextDelta(ReasoningTextDeltaNotification),
111    /// `account/login/completed`
112    AccountLoginCompleted(AccountLoginCompletedNotification),
113    /// `deprecationNotice`
114    DeprecationNotice(DeprecationNoticeNotification),
115    /// `guardianWarning`
116    GuardianWarning(GuardianWarningNotification),
117    /// `warning`
118    Warning(WarningNotification),
119    /// `thread/archived`
120    ThreadArchived(ThreadArchivedNotification),
121    /// `thread/closed`
122    ThreadClosed(ThreadClosedNotification),
123    /// `thread/unarchived`
124    ThreadUnarchived(ThreadUnarchivedNotification),
125    /// `thread/goal/cleared`
126    ThreadGoalCleared(ThreadGoalClearedNotification),
127    /// `thread/name/updated`
128    ThreadNameUpdated(ThreadNameUpdatedNotification),
129    /// `skills/changed`
130    SkillsChanged(SkillsChangedNotification),
131    /// `fs/changed`
132    FsChanged(FsChangedNotification),
133    /// `configWarning`
134    ConfigWarning(ConfigWarningNotification),
135    /// `account/updated`
136    AccountUpdated(AccountUpdatedNotification),
137    /// `app/list/updated`
138    AppListUpdated(AppListUpdatedNotification),
139    /// `command/exec/outputDelta`
140    CommandExecOutputDelta(CommandExecOutputDeltaNotification),
141    /// `externalAgentConfig/import/completed`
142    ExternalAgentConfigImportCompleted(ExternalAgentConfigImportCompletedNotification),
143    /// `fuzzyFileSearch/sessionCompleted`
144    FuzzyFileSearchSessionCompleted(FuzzyFileSearchSessionCompletedNotification),
145    /// `fuzzyFileSearch/sessionUpdated`
146    FuzzyFileSearchSessionUpdated(FuzzyFileSearchSessionUpdatedNotification),
147    /// `hook/completed`
148    HookCompleted(HookCompletedNotification),
149    /// `hook/started`
150    HookStarted(HookStartedNotification),
151    /// `item/autoApprovalReview/completed`
152    ItemGuardianApprovalReviewCompleted(ItemGuardianApprovalReviewCompletedNotification),
153    /// `item/autoApprovalReview/started`
154    ItemGuardianApprovalReviewStarted(ItemGuardianApprovalReviewStartedNotification),
155    /// `item/commandExecution/terminalInteraction`
156    TerminalInteraction(TerminalInteractionNotification),
157    /// `item/mcpToolCall/progress`
158    McpToolCallProgress(McpToolCallProgressNotification),
159    /// `model/rerouted`
160    ModelRerouted(ModelReroutedNotification),
161    /// `model/verification`
162    ModelVerification(ModelVerificationNotification),
163    /// `process/exited`
164    ProcessExited(ProcessExitedNotification),
165    /// `process/outputDelta`
166    ProcessOutputDelta(ProcessOutputDeltaNotification),
167    /// `serverRequest/resolved`
168    ServerRequestResolved(ServerRequestResolvedNotification),
169    /// `thread/compacted`
170    ContextCompacted(ContextCompactedNotification),
171    /// `thread/goal/updated`
172    ThreadGoalUpdated(ThreadGoalUpdatedNotification),
173    /// `thread/realtime/closed`
174    ThreadRealtimeClosed(ThreadRealtimeClosedNotification),
175    /// `thread/realtime/error`
176    ThreadRealtimeError(ThreadRealtimeErrorNotification),
177    /// `thread/realtime/itemAdded`
178    ThreadRealtimeItemAdded(ThreadRealtimeItemAddedNotification),
179    /// `thread/realtime/outputAudio/delta`
180    ThreadRealtimeOutputAudioDelta(ThreadRealtimeOutputAudioDeltaNotification),
181    /// `thread/realtime/sdp`
182    ThreadRealtimeSdp(ThreadRealtimeSdpNotification),
183    /// `thread/realtime/started`
184    ThreadRealtimeStarted(ThreadRealtimeStartedNotification),
185    /// `thread/realtime/transcript/delta`
186    ThreadRealtimeTranscriptDelta(ThreadRealtimeTranscriptDeltaNotification),
187    /// `thread/realtime/transcript/done`
188    ThreadRealtimeTranscriptDone(ThreadRealtimeTranscriptDoneNotification),
189    /// `windows/worldWritableWarning`
190    WindowsWorldWritableWarning(WindowsWorldWritableWarningNotification),
191    /// `windowsSandbox/setupCompleted`
192    WindowsSandboxSetupCompleted(WindowsSandboxSetupCompletedNotification),
193    /// `thread/settings/updated`
194    ThreadSettingsUpdated(ThreadSettingsUpdatedNotification),
195    /// `turn/moderationMetadata`
196    TurnModerationMetadata(TurnModerationMetadataNotification),
197    /// A method this crate version does not yet model. The raw params are
198    /// preserved for caller inspection. Encountering this typically means
199    /// the installed codex CLI is newer than the bindings.
200    Unknown {
201        method: String,
202        params: Option<Value>,
203    },
204}
205
206impl Notification {
207    /// Return the wire `method` string for this notification.
208    pub fn method(&self) -> &str {
209        match self {
210            Self::ThreadStarted(_) => methods::THREAD_STARTED,
211            Self::ThreadStatusChanged(_) => methods::THREAD_STATUS_CHANGED,
212            Self::ThreadTokenUsageUpdated(_) => methods::THREAD_TOKEN_USAGE_UPDATED,
213            Self::TurnStarted(_) => methods::TURN_STARTED,
214            Self::TurnCompleted(_) => methods::TURN_COMPLETED,
215            Self::ItemStarted(_) => methods::ITEM_STARTED,
216            Self::ItemCompleted(_) => methods::ITEM_COMPLETED,
217            Self::AgentMessageDelta(_) => methods::AGENT_MESSAGE_DELTA,
218            Self::CmdOutputDelta(_) => methods::CMD_OUTPUT_DELTA,
219            Self::FileChangeOutputDelta(_) => methods::FILE_CHANGE_OUTPUT_DELTA,
220            Self::ReasoningDelta(_) => methods::REASONING_DELTA,
221            Self::Error(_) => methods::ERROR,
222            Self::AccountRateLimitsUpdated(_) => methods::ACCOUNT_RATE_LIMITS_UPDATED,
223            Self::McpServerStartupStatusUpdated(_) => methods::MCP_SERVER_STARTUP_STATUS_UPDATED,
224            Self::RemoteControlStatusChanged(_) => methods::REMOTE_CONTROL_STATUS_CHANGED,
225            Self::McpServerOauthLoginCompleted(_) => methods::MCP_SERVER_OAUTH_LOGIN_COMPLETED,
226            Self::FileChangePatchUpdated(_) => methods::FILE_CHANGE_PATCH_UPDATED,
227            Self::PlanDelta(_) => methods::PLAN_DELTA,
228            Self::TurnPlanUpdated(_) => methods::TURN_PLAN_UPDATED,
229            Self::TurnDiffUpdated(_) => methods::TURN_DIFF_UPDATED,
230            Self::ReasoningSummaryPartAdded(_) => methods::REASONING_SUMMARY_PART_ADDED,
231            Self::ReasoningTextDelta(_) => methods::REASONING_TEXT_DELTA,
232            Self::AccountLoginCompleted(_) => methods::ACCOUNT_LOGIN_COMPLETED,
233            Self::DeprecationNotice(_) => methods::DEPRECATION_NOTICE,
234            Self::GuardianWarning(_) => methods::GUARDIAN_WARNING,
235            Self::Warning(_) => methods::WARNING,
236            Self::ThreadArchived(_) => methods::THREAD_ARCHIVED,
237            Self::ThreadClosed(_) => methods::THREAD_CLOSED,
238            Self::ThreadUnarchived(_) => methods::THREAD_UNARCHIVED,
239            Self::ThreadGoalCleared(_) => methods::THREAD_GOAL_CLEARED,
240            Self::ThreadNameUpdated(_) => methods::THREAD_NAME_UPDATED,
241            Self::SkillsChanged(_) => methods::SKILLS_CHANGED,
242            Self::FsChanged(_) => methods::FS_CHANGED,
243            Self::ConfigWarning(_) => methods::CONFIG_WARNING,
244            Self::AccountUpdated(_) => methods::ACCOUNT_UPDATED,
245            Self::AppListUpdated(_) => methods::APP_LIST_UPDATED,
246            Self::CommandExecOutputDelta(_) => methods::COMMAND_EXEC_OUTPUT_DELTA,
247            Self::ExternalAgentConfigImportCompleted(_) => {
248                methods::EXTERNAL_AGENT_CONFIG_IMPORT_COMPLETED
249            }
250            Self::FuzzyFileSearchSessionCompleted(_) => {
251                methods::FUZZY_FILE_SEARCH_SESSION_COMPLETED
252            }
253            Self::FuzzyFileSearchSessionUpdated(_) => methods::FUZZY_FILE_SEARCH_SESSION_UPDATED,
254            Self::HookCompleted(_) => methods::HOOK_COMPLETED,
255            Self::HookStarted(_) => methods::HOOK_STARTED,
256            Self::ItemGuardianApprovalReviewCompleted(_) => {
257                methods::ITEM_AUTO_APPROVAL_REVIEW_COMPLETED
258            }
259            Self::ItemGuardianApprovalReviewStarted(_) => {
260                methods::ITEM_AUTO_APPROVAL_REVIEW_STARTED
261            }
262            Self::TerminalInteraction(_) => methods::ITEM_COMMAND_EXEC_TERMINAL_INTERACTION,
263            Self::McpToolCallProgress(_) => methods::ITEM_MCP_TOOL_CALL_PROGRESS,
264            Self::ModelRerouted(_) => methods::MODEL_REROUTED,
265            Self::ModelVerification(_) => methods::MODEL_VERIFICATION,
266            Self::ProcessExited(_) => methods::PROCESS_EXITED,
267            Self::ProcessOutputDelta(_) => methods::PROCESS_OUTPUT_DELTA,
268            Self::ServerRequestResolved(_) => methods::SERVER_REQUEST_RESOLVED,
269            Self::ContextCompacted(_) => methods::THREAD_COMPACTED,
270            Self::ThreadGoalUpdated(_) => methods::THREAD_GOAL_UPDATED,
271            Self::ThreadRealtimeClosed(_) => methods::THREAD_REALTIME_CLOSED,
272            Self::ThreadRealtimeError(_) => methods::THREAD_REALTIME_ERROR,
273            Self::ThreadRealtimeItemAdded(_) => methods::THREAD_REALTIME_ITEM_ADDED,
274            Self::ThreadRealtimeOutputAudioDelta(_) => methods::THREAD_REALTIME_OUTPUT_AUDIO_DELTA,
275            Self::ThreadRealtimeSdp(_) => methods::THREAD_REALTIME_SDP,
276            Self::ThreadRealtimeStarted(_) => methods::THREAD_REALTIME_STARTED,
277            Self::ThreadRealtimeTranscriptDelta(_) => methods::THREAD_REALTIME_TRANSCRIPT_DELTA,
278            Self::ThreadRealtimeTranscriptDone(_) => methods::THREAD_REALTIME_TRANSCRIPT_DONE,
279            Self::WindowsWorldWritableWarning(_) => methods::WINDOWS_WORLD_WRITABLE_WARNING,
280            Self::WindowsSandboxSetupCompleted(_) => methods::WINDOWS_SANDBOX_SETUP_COMPLETED,
281            Self::ThreadSettingsUpdated(_) => methods::THREAD_SETTINGS_UPDATED,
282            Self::TurnModerationMetadata(_) => methods::TURN_MODERATION_METADATA,
283            Self::Unknown { method, .. } => method,
284        }
285    }
286
287    /// `true` if this notification's method isn't modeled by the crate.
288    pub fn is_unknown(&self) -> bool {
289        matches!(self, Self::Unknown { .. })
290    }
291
292    /// Construct a [`Notification`] from a `method` + `params` envelope.
293    ///
294    /// Returns an error if `method` is recognized but `params` doesn't
295    /// deserialize into the typed struct. Unknown methods route to
296    /// [`Notification::Unknown`] without error.
297    pub fn from_envelope(method: &str, params: Option<Value>) -> Result<Self, serde_json::Error> {
298        let params_value = params.clone().unwrap_or(Value::Null);
299        match method {
300            methods::THREAD_STARTED => {
301                serde_json::from_value(params_value).map(Self::ThreadStarted)
302            }
303            methods::THREAD_STATUS_CHANGED => {
304                serde_json::from_value(params_value).map(Self::ThreadStatusChanged)
305            }
306            methods::THREAD_TOKEN_USAGE_UPDATED => {
307                serde_json::from_value(params_value).map(Self::ThreadTokenUsageUpdated)
308            }
309            methods::TURN_STARTED => serde_json::from_value(params_value).map(Self::TurnStarted),
310            methods::TURN_COMPLETED => {
311                serde_json::from_value(params_value).map(Self::TurnCompleted)
312            }
313            methods::ITEM_STARTED => serde_json::from_value(params_value).map(Self::ItemStarted),
314            methods::ITEM_COMPLETED => {
315                serde_json::from_value(params_value).map(Self::ItemCompleted)
316            }
317            methods::AGENT_MESSAGE_DELTA => {
318                serde_json::from_value(params_value).map(Self::AgentMessageDelta)
319            }
320            methods::CMD_OUTPUT_DELTA => {
321                serde_json::from_value(params_value).map(Self::CmdOutputDelta)
322            }
323            methods::FILE_CHANGE_OUTPUT_DELTA => {
324                serde_json::from_value(params_value).map(Self::FileChangeOutputDelta)
325            }
326            methods::REASONING_DELTA => {
327                serde_json::from_value(params_value).map(Self::ReasoningDelta)
328            }
329            methods::ERROR => serde_json::from_value(params_value).map(Self::Error),
330            methods::ACCOUNT_RATE_LIMITS_UPDATED => {
331                serde_json::from_value(params_value).map(Self::AccountRateLimitsUpdated)
332            }
333            methods::MCP_SERVER_STARTUP_STATUS_UPDATED => {
334                serde_json::from_value(params_value).map(Self::McpServerStartupStatusUpdated)
335            }
336            methods::REMOTE_CONTROL_STATUS_CHANGED => {
337                serde_json::from_value(params_value).map(Self::RemoteControlStatusChanged)
338            }
339            methods::MCP_SERVER_OAUTH_LOGIN_COMPLETED => {
340                serde_json::from_value(params_value).map(Self::McpServerOauthLoginCompleted)
341            }
342            methods::FILE_CHANGE_PATCH_UPDATED => {
343                serde_json::from_value(params_value).map(Self::FileChangePatchUpdated)
344            }
345            methods::PLAN_DELTA => serde_json::from_value(params_value).map(Self::PlanDelta),
346            methods::TURN_PLAN_UPDATED => {
347                serde_json::from_value(params_value).map(Self::TurnPlanUpdated)
348            }
349            methods::TURN_DIFF_UPDATED => {
350                serde_json::from_value(params_value).map(Self::TurnDiffUpdated)
351            }
352            methods::REASONING_SUMMARY_PART_ADDED => {
353                serde_json::from_value(params_value).map(Self::ReasoningSummaryPartAdded)
354            }
355            methods::REASONING_TEXT_DELTA => {
356                serde_json::from_value(params_value).map(Self::ReasoningTextDelta)
357            }
358            methods::ACCOUNT_LOGIN_COMPLETED => {
359                serde_json::from_value(params_value).map(Self::AccountLoginCompleted)
360            }
361            methods::DEPRECATION_NOTICE => {
362                serde_json::from_value(params_value).map(Self::DeprecationNotice)
363            }
364            methods::GUARDIAN_WARNING => {
365                serde_json::from_value(params_value).map(Self::GuardianWarning)
366            }
367            methods::WARNING => serde_json::from_value(params_value).map(Self::Warning),
368            methods::THREAD_ARCHIVED => {
369                serde_json::from_value(params_value).map(Self::ThreadArchived)
370            }
371            methods::THREAD_CLOSED => serde_json::from_value(params_value).map(Self::ThreadClosed),
372            methods::THREAD_UNARCHIVED => {
373                serde_json::from_value(params_value).map(Self::ThreadUnarchived)
374            }
375            methods::THREAD_GOAL_CLEARED => {
376                serde_json::from_value(params_value).map(Self::ThreadGoalCleared)
377            }
378            methods::THREAD_NAME_UPDATED => {
379                serde_json::from_value(params_value).map(Self::ThreadNameUpdated)
380            }
381            methods::SKILLS_CHANGED => {
382                serde_json::from_value(params_value).map(Self::SkillsChanged)
383            }
384            methods::FS_CHANGED => serde_json::from_value(params_value).map(Self::FsChanged),
385            methods::CONFIG_WARNING => {
386                serde_json::from_value(params_value).map(Self::ConfigWarning)
387            }
388            methods::ACCOUNT_UPDATED => {
389                serde_json::from_value(params_value).map(Self::AccountUpdated)
390            }
391            methods::APP_LIST_UPDATED => {
392                serde_json::from_value(params_value).map(Self::AppListUpdated)
393            }
394            methods::COMMAND_EXEC_OUTPUT_DELTA => {
395                serde_json::from_value(params_value).map(Self::CommandExecOutputDelta)
396            }
397            methods::EXTERNAL_AGENT_CONFIG_IMPORT_COMPLETED => {
398                serde_json::from_value(params_value).map(Self::ExternalAgentConfigImportCompleted)
399            }
400            methods::FUZZY_FILE_SEARCH_SESSION_COMPLETED => {
401                serde_json::from_value(params_value).map(Self::FuzzyFileSearchSessionCompleted)
402            }
403            methods::FUZZY_FILE_SEARCH_SESSION_UPDATED => {
404                serde_json::from_value(params_value).map(Self::FuzzyFileSearchSessionUpdated)
405            }
406            methods::HOOK_COMPLETED => {
407                serde_json::from_value(params_value).map(Self::HookCompleted)
408            }
409            methods::HOOK_STARTED => serde_json::from_value(params_value).map(Self::HookStarted),
410            methods::ITEM_AUTO_APPROVAL_REVIEW_COMPLETED => {
411                serde_json::from_value(params_value).map(Self::ItemGuardianApprovalReviewCompleted)
412            }
413            methods::ITEM_AUTO_APPROVAL_REVIEW_STARTED => {
414                serde_json::from_value(params_value).map(Self::ItemGuardianApprovalReviewStarted)
415            }
416            methods::ITEM_COMMAND_EXEC_TERMINAL_INTERACTION => {
417                serde_json::from_value(params_value).map(Self::TerminalInteraction)
418            }
419            methods::ITEM_MCP_TOOL_CALL_PROGRESS => {
420                serde_json::from_value(params_value).map(Self::McpToolCallProgress)
421            }
422            methods::MODEL_REROUTED => {
423                serde_json::from_value(params_value).map(Self::ModelRerouted)
424            }
425            methods::MODEL_VERIFICATION => {
426                serde_json::from_value(params_value).map(Self::ModelVerification)
427            }
428            methods::PROCESS_EXITED => {
429                serde_json::from_value(params_value).map(Self::ProcessExited)
430            }
431            methods::PROCESS_OUTPUT_DELTA => {
432                serde_json::from_value(params_value).map(Self::ProcessOutputDelta)
433            }
434            methods::SERVER_REQUEST_RESOLVED => {
435                serde_json::from_value(params_value).map(Self::ServerRequestResolved)
436            }
437            methods::THREAD_COMPACTED => {
438                serde_json::from_value(params_value).map(Self::ContextCompacted)
439            }
440            methods::THREAD_GOAL_UPDATED => {
441                serde_json::from_value(params_value).map(Self::ThreadGoalUpdated)
442            }
443            methods::THREAD_REALTIME_CLOSED => {
444                serde_json::from_value(params_value).map(Self::ThreadRealtimeClosed)
445            }
446            methods::THREAD_REALTIME_ERROR => {
447                serde_json::from_value(params_value).map(Self::ThreadRealtimeError)
448            }
449            methods::THREAD_REALTIME_ITEM_ADDED => {
450                serde_json::from_value(params_value).map(Self::ThreadRealtimeItemAdded)
451            }
452            methods::THREAD_REALTIME_OUTPUT_AUDIO_DELTA => {
453                serde_json::from_value(params_value).map(Self::ThreadRealtimeOutputAudioDelta)
454            }
455            methods::THREAD_REALTIME_SDP => {
456                serde_json::from_value(params_value).map(Self::ThreadRealtimeSdp)
457            }
458            methods::THREAD_REALTIME_STARTED => {
459                serde_json::from_value(params_value).map(Self::ThreadRealtimeStarted)
460            }
461            methods::THREAD_REALTIME_TRANSCRIPT_DELTA => {
462                serde_json::from_value(params_value).map(Self::ThreadRealtimeTranscriptDelta)
463            }
464            methods::THREAD_REALTIME_TRANSCRIPT_DONE => {
465                serde_json::from_value(params_value).map(Self::ThreadRealtimeTranscriptDone)
466            }
467            methods::WINDOWS_WORLD_WRITABLE_WARNING => {
468                serde_json::from_value(params_value).map(Self::WindowsWorldWritableWarning)
469            }
470            methods::WINDOWS_SANDBOX_SETUP_COMPLETED => {
471                serde_json::from_value(params_value).map(Self::WindowsSandboxSetupCompleted)
472            }
473            methods::THREAD_SETTINGS_UPDATED => {
474                serde_json::from_value(params_value).map(Self::ThreadSettingsUpdated)
475            }
476            methods::TURN_MODERATION_METADATA => {
477                serde_json::from_value(params_value).map(Self::TurnModerationMetadata)
478            }
479            _ => Ok(Self::Unknown {
480                method: method.to_string(),
481                params,
482            }),
483        }
484    }
485
486    /// Decompose this notification back into a `(method, params)` pair.
487    pub fn into_envelope(self) -> Result<(String, Option<Value>), serde_json::Error> {
488        fn pack<T: Serialize>(
489            method: &str,
490            v: &T,
491        ) -> Result<(String, Option<Value>), serde_json::Error> {
492            Ok((method.to_string(), Some(serde_json::to_value(v)?)))
493        }
494        match &self {
495            Self::ThreadStarted(v) => pack(methods::THREAD_STARTED, v),
496            Self::ThreadStatusChanged(v) => pack(methods::THREAD_STATUS_CHANGED, v),
497            Self::ThreadTokenUsageUpdated(v) => pack(methods::THREAD_TOKEN_USAGE_UPDATED, v),
498            Self::TurnStarted(v) => pack(methods::TURN_STARTED, v),
499            Self::TurnCompleted(v) => pack(methods::TURN_COMPLETED, v),
500            Self::ItemStarted(v) => pack(methods::ITEM_STARTED, v),
501            Self::ItemCompleted(v) => pack(methods::ITEM_COMPLETED, v),
502            Self::AgentMessageDelta(v) => pack(methods::AGENT_MESSAGE_DELTA, v),
503            Self::CmdOutputDelta(v) => pack(methods::CMD_OUTPUT_DELTA, v),
504            Self::FileChangeOutputDelta(v) => pack(methods::FILE_CHANGE_OUTPUT_DELTA, v),
505            Self::ReasoningDelta(v) => pack(methods::REASONING_DELTA, v),
506            Self::Error(v) => pack(methods::ERROR, v),
507            Self::AccountRateLimitsUpdated(v) => pack(methods::ACCOUNT_RATE_LIMITS_UPDATED, v),
508            Self::McpServerStartupStatusUpdated(v) => {
509                pack(methods::MCP_SERVER_STARTUP_STATUS_UPDATED, v)
510            }
511            Self::RemoteControlStatusChanged(v) => pack(methods::REMOTE_CONTROL_STATUS_CHANGED, v),
512            Self::McpServerOauthLoginCompleted(v) => {
513                pack(methods::MCP_SERVER_OAUTH_LOGIN_COMPLETED, v)
514            }
515            Self::FileChangePatchUpdated(v) => pack(methods::FILE_CHANGE_PATCH_UPDATED, v),
516            Self::PlanDelta(v) => pack(methods::PLAN_DELTA, v),
517            Self::TurnPlanUpdated(v) => pack(methods::TURN_PLAN_UPDATED, v),
518            Self::TurnDiffUpdated(v) => pack(methods::TURN_DIFF_UPDATED, v),
519            Self::ReasoningSummaryPartAdded(v) => pack(methods::REASONING_SUMMARY_PART_ADDED, v),
520            Self::ReasoningTextDelta(v) => pack(methods::REASONING_TEXT_DELTA, v),
521            Self::AccountLoginCompleted(v) => pack(methods::ACCOUNT_LOGIN_COMPLETED, v),
522            Self::DeprecationNotice(v) => pack(methods::DEPRECATION_NOTICE, v),
523            Self::GuardianWarning(v) => pack(methods::GUARDIAN_WARNING, v),
524            Self::Warning(v) => pack(methods::WARNING, v),
525            Self::ThreadArchived(v) => pack(methods::THREAD_ARCHIVED, v),
526            Self::ThreadClosed(v) => pack(methods::THREAD_CLOSED, v),
527            Self::ThreadUnarchived(v) => pack(methods::THREAD_UNARCHIVED, v),
528            Self::ThreadGoalCleared(v) => pack(methods::THREAD_GOAL_CLEARED, v),
529            Self::ThreadNameUpdated(v) => pack(methods::THREAD_NAME_UPDATED, v),
530            Self::SkillsChanged(v) => pack(methods::SKILLS_CHANGED, v),
531            Self::FsChanged(v) => pack(methods::FS_CHANGED, v),
532            Self::ConfigWarning(v) => pack(methods::CONFIG_WARNING, v),
533            Self::AccountUpdated(v) => pack(methods::ACCOUNT_UPDATED, v),
534            Self::AppListUpdated(v) => pack(methods::APP_LIST_UPDATED, v),
535            Self::CommandExecOutputDelta(v) => pack(methods::COMMAND_EXEC_OUTPUT_DELTA, v),
536            Self::ExternalAgentConfigImportCompleted(v) => {
537                pack(methods::EXTERNAL_AGENT_CONFIG_IMPORT_COMPLETED, v)
538            }
539            Self::FuzzyFileSearchSessionCompleted(v) => {
540                pack(methods::FUZZY_FILE_SEARCH_SESSION_COMPLETED, v)
541            }
542            Self::FuzzyFileSearchSessionUpdated(v) => {
543                pack(methods::FUZZY_FILE_SEARCH_SESSION_UPDATED, v)
544            }
545            Self::HookCompleted(v) => pack(methods::HOOK_COMPLETED, v),
546            Self::HookStarted(v) => pack(methods::HOOK_STARTED, v),
547            Self::ItemGuardianApprovalReviewCompleted(v) => {
548                pack(methods::ITEM_AUTO_APPROVAL_REVIEW_COMPLETED, v)
549            }
550            Self::ItemGuardianApprovalReviewStarted(v) => {
551                pack(methods::ITEM_AUTO_APPROVAL_REVIEW_STARTED, v)
552            }
553            Self::TerminalInteraction(v) => {
554                pack(methods::ITEM_COMMAND_EXEC_TERMINAL_INTERACTION, v)
555            }
556            Self::McpToolCallProgress(v) => pack(methods::ITEM_MCP_TOOL_CALL_PROGRESS, v),
557            Self::ModelRerouted(v) => pack(methods::MODEL_REROUTED, v),
558            Self::ModelVerification(v) => pack(methods::MODEL_VERIFICATION, v),
559            Self::ProcessExited(v) => pack(methods::PROCESS_EXITED, v),
560            Self::ProcessOutputDelta(v) => pack(methods::PROCESS_OUTPUT_DELTA, v),
561            Self::ServerRequestResolved(v) => pack(methods::SERVER_REQUEST_RESOLVED, v),
562            Self::ContextCompacted(v) => pack(methods::THREAD_COMPACTED, v),
563            Self::ThreadGoalUpdated(v) => pack(methods::THREAD_GOAL_UPDATED, v),
564            Self::ThreadRealtimeClosed(v) => pack(methods::THREAD_REALTIME_CLOSED, v),
565            Self::ThreadRealtimeError(v) => pack(methods::THREAD_REALTIME_ERROR, v),
566            Self::ThreadRealtimeItemAdded(v) => pack(methods::THREAD_REALTIME_ITEM_ADDED, v),
567            Self::ThreadRealtimeOutputAudioDelta(v) => {
568                pack(methods::THREAD_REALTIME_OUTPUT_AUDIO_DELTA, v)
569            }
570            Self::ThreadRealtimeSdp(v) => pack(methods::THREAD_REALTIME_SDP, v),
571            Self::ThreadRealtimeStarted(v) => pack(methods::THREAD_REALTIME_STARTED, v),
572            Self::ThreadRealtimeTranscriptDelta(v) => {
573                pack(methods::THREAD_REALTIME_TRANSCRIPT_DELTA, v)
574            }
575            Self::ThreadRealtimeTranscriptDone(v) => {
576                pack(methods::THREAD_REALTIME_TRANSCRIPT_DONE, v)
577            }
578            Self::WindowsWorldWritableWarning(v) => {
579                pack(methods::WINDOWS_WORLD_WRITABLE_WARNING, v)
580            }
581            Self::WindowsSandboxSetupCompleted(v) => {
582                pack(methods::WINDOWS_SANDBOX_SETUP_COMPLETED, v)
583            }
584            Self::ThreadSettingsUpdated(v) => pack(methods::THREAD_SETTINGS_UPDATED, v),
585            Self::TurnModerationMetadata(v) => pack(methods::TURN_MODERATION_METADATA, v),
586            Self::Unknown { method, params } => Ok((method.clone(), params.clone())),
587        }
588    }
589}
590
591impl Serialize for Notification {
592    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
593        let (method, params) = self
594            .clone()
595            .into_envelope()
596            .map_err(serde::ser::Error::custom)?;
597        let mut env = serde_json::Map::new();
598        env.insert("method".to_string(), Value::String(method));
599        if let Some(p) = params {
600            env.insert("params".to_string(), p);
601        }
602        Value::Object(env).serialize(serializer)
603    }
604}
605
606impl<'de> Deserialize<'de> for Notification {
607    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
608        let value = Value::deserialize(deserializer)?;
609        let method = value
610            .get("method")
611            .and_then(|v| v.as_str())
612            .ok_or_else(|| serde::de::Error::missing_field("method"))?
613            .to_string();
614        let params = value.get("params").cloned();
615        Self::from_envelope(&method, params).map_err(serde::de::Error::custom)
616    }
617}
618
619/// A server-to-client request that requires a response (approval flow).
620///
621/// The wire envelope carries an `id` for response correlation; that `id` is
622/// held alongside this enum in [`ServerMessage::Request`] rather than embedded
623/// inside the variant, since responding doesn't depend on which approval-type
624/// was requested.
625#[derive(Debug, Clone)]
626pub enum ServerRequest {
627    /// `item/commandExecution/requestApproval`
628    CmdExecApproval(CommandExecutionRequestApprovalParams),
629    /// `item/fileChange/requestApproval`
630    FileChangeApproval(FileChangeRequestApprovalParams),
631    /// `item/tool/requestUserInput`
632    ToolRequestUserInput(crate::protocol::ToolRequestUserInputParams),
633    /// `mcpServer/elicitation/request`
634    McpServerElicitationRequest(crate::protocol::McpServerElicitationRequestParams),
635    /// `item/permissions/requestApproval`
636    PermissionsRequestApproval(crate::protocol::PermissionsRequestApprovalParams),
637    /// `item/tool/call`
638    ItemToolCall(crate::protocol::DynamicToolCallParams),
639    /// `account/chatgptAuthTokens/refresh`
640    ChatgptAuthTokensRefresh(crate::protocol::ChatgptAuthTokensRefreshParams),
641    /// `attestation/generate`
642    AttestationGenerate(crate::protocol::AttestationGenerateParams),
643    /// `applyPatchApproval`
644    ApplyPatchApproval(crate::protocol::ApplyPatchApprovalParams),
645    /// `execCommandApproval`
646    ExecCommandApproval(crate::protocol::ExecCommandApprovalParams),
647    /// A request method this crate version does not yet model.
648    Unknown {
649        method: String,
650        params: Option<Value>,
651    },
652}
653
654impl ServerRequest {
655    /// Return the wire `method` string for this request.
656    pub fn method(&self) -> &str {
657        match self {
658            Self::CmdExecApproval(_) => methods::CMD_EXEC_APPROVAL,
659            Self::FileChangeApproval(_) => methods::FILE_CHANGE_APPROVAL,
660            Self::ToolRequestUserInput(_) => methods::TOOL_REQUEST_USER_INPUT,
661            Self::McpServerElicitationRequest(_) => methods::MCP_SERVER_ELICITATION_REQUEST,
662            Self::PermissionsRequestApproval(_) => methods::PERMISSIONS_REQUEST_APPROVAL,
663            Self::ItemToolCall(_) => methods::ITEM_TOOL_CALL,
664            Self::ChatgptAuthTokensRefresh(_) => methods::CHATGPT_AUTH_TOKENS_REFRESH,
665            Self::AttestationGenerate(_) => methods::ATTESTATION_GENERATE,
666            Self::ApplyPatchApproval(_) => methods::APPLY_PATCH_APPROVAL,
667            Self::ExecCommandApproval(_) => methods::EXEC_COMMAND_APPROVAL,
668            Self::Unknown { method, .. } => method,
669        }
670    }
671
672    /// `true` if this request's method isn't modeled by the crate.
673    pub fn is_unknown(&self) -> bool {
674        matches!(self, Self::Unknown { .. })
675    }
676
677    /// Construct a [`ServerRequest`] from a `method` + `params` envelope.
678    pub fn from_envelope(method: &str, params: Option<Value>) -> Result<Self, serde_json::Error> {
679        let params_value = params.clone().unwrap_or(Value::Null);
680        match method {
681            methods::CMD_EXEC_APPROVAL => {
682                serde_json::from_value(params_value).map(Self::CmdExecApproval)
683            }
684            methods::FILE_CHANGE_APPROVAL => {
685                serde_json::from_value(params_value).map(Self::FileChangeApproval)
686            }
687            methods::TOOL_REQUEST_USER_INPUT => {
688                serde_json::from_value(params_value).map(Self::ToolRequestUserInput)
689            }
690            methods::MCP_SERVER_ELICITATION_REQUEST => {
691                serde_json::from_value(params_value).map(Self::McpServerElicitationRequest)
692            }
693            methods::PERMISSIONS_REQUEST_APPROVAL => {
694                serde_json::from_value(params_value).map(Self::PermissionsRequestApproval)
695            }
696            methods::ITEM_TOOL_CALL => serde_json::from_value(params_value).map(Self::ItemToolCall),
697            methods::CHATGPT_AUTH_TOKENS_REFRESH => {
698                serde_json::from_value(params_value).map(Self::ChatgptAuthTokensRefresh)
699            }
700            methods::ATTESTATION_GENERATE => {
701                serde_json::from_value(params_value).map(Self::AttestationGenerate)
702            }
703            methods::APPLY_PATCH_APPROVAL => {
704                serde_json::from_value(params_value).map(Self::ApplyPatchApproval)
705            }
706            methods::EXEC_COMMAND_APPROVAL => {
707                serde_json::from_value(params_value).map(Self::ExecCommandApproval)
708            }
709            _ => Ok(Self::Unknown {
710                method: method.to_string(),
711                params,
712            }),
713        }
714    }
715}
716
717/// A message coming from the app-server.
718///
719/// Replaces the previous loose `{ method, params }` shape with typed enums.
720/// Match on the outer variant first to distinguish notifications (no response)
721/// from requests (need [`crate::AsyncClient::respond`] /
722/// [`crate::SyncClient::respond`]).
723#[derive(Debug, Clone)]
724pub enum ServerMessage {
725    /// A notification — no response required.
726    Notification(Notification),
727    /// A request — call `respond(id, ...)` on the client with the matching id.
728    Request {
729        id: RequestId,
730        request: ServerRequest,
731    },
732}
733
734impl ServerMessage {
735    /// `true` if this message is an unmodeled method (notification or request).
736    pub fn is_unknown(&self) -> bool {
737        match self {
738            Self::Notification(n) => n.is_unknown(),
739            Self::Request { request, .. } => request.is_unknown(),
740        }
741    }
742}
743
744#[cfg(test)]
745mod tests {
746    use super::*;
747
748    #[test]
749    fn test_notification_unknown_method_routes_to_unknown_variant() {
750        let n = Notification::from_envelope("foo/bar", Some(serde_json::json!({"x": 1})))
751            .expect("unknown methods do not error");
752        match n {
753            Notification::Unknown { method, params } => {
754                assert_eq!(method, "foo/bar");
755                assert_eq!(params, Some(serde_json::json!({"x": 1})));
756            }
757            other => panic!("expected Unknown, got {:?}", other),
758        }
759    }
760
761    #[test]
762    fn test_notification_known_method_with_bad_params_errors() {
763        // thread/started expects a `thread` field — wrong shape should error.
764        let err = Notification::from_envelope("thread/started", Some(serde_json::json!({})));
765        assert!(err.is_err());
766    }
767
768    #[test]
769    fn test_notification_round_trip_envelope() {
770        let wire = serde_json::json!({
771            "method": "item/agentMessage/delta",
772            "params": {"threadId": "t1", "turnId": "u1", "itemId": "i1", "delta": "hi"},
773        });
774        let n: Notification = serde_json::from_value(wire.clone()).unwrap();
775        assert!(matches!(n, Notification::AgentMessageDelta(_)));
776        let back = serde_json::to_value(&n).unwrap();
777        assert_eq!(back, wire);
778    }
779}
codex_codes/messages.rs

codex_codes/
messages.rs
