Add missing "nullable" macro to protocol structs that contain optional fields #5901
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…l fields
Also includes a test that validates that all ts protocol code that contains "| null" is marked optional ("?") to catch cases where "#[ts(optional_fields = nullable)]" is omitted
bolinfest
reviewed
Oct 29, 2025
bolinfest
approved these changes
Oct 29, 2025
# Conflicts: # codex-rs/protocol/src/protocol.rs
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses a current hole in the TypeScript code generation for the API server protocol. Fields that are marked as "Optional<>" in the Rust code are serialized such that the value is omitted when it is deserialized — appearing as
undefined, but the TS type indicates (incorrectly) that it is always defined but possiblynull. This can lead to subtle errors that the TypeScript compiler doesn't catch. The fix is to include the#[ts(optional_fields = nullable)]macro for all protocol structs that contain one or moreOptional<>fields.This PR also includes a new test that validates that all TS protocol code containing "| null" in its type is marked optional ("?") to catch cases where
#[ts(optional_fields = nullable)]is omitted.