-
Notifications
You must be signed in to change notification settings - Fork 12.8k
[1 of 4] tui: route primary settings writes through app server #22913
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
25cda68
tui: persist primary settings via app server config RPC
etraut-openai b36f89a
codex: fix CI failure on PR #22913
etraut-openai 04813b6
tui: simplify app-server config updates
etraut-openai ff669bc
tui: preserve dotted profile names in config writes
etraut-openai 7395f16
app-server: clarify config key path parsing
etraut-openai b74ce8d
tui: avoid fallible profile path quoting
etraut-openai 61bd2d9
app-server: preserve existing config key path syntax
etraut-openai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| //! App-server-backed config update helpers for the TUI. | ||
| //! | ||
| //! This module centralizes the small typed update helpers the TUI uses | ||
| //! when a config mutation must be owned by the app server rather than written | ||
| //! to the local `config.toml` directly. | ||
|
|
||
| use codex_app_server_client::AppServerRequestHandle; | ||
| use codex_app_server_protocol::ClientRequest; | ||
| use codex_app_server_protocol::ConfigBatchWriteParams; | ||
| use codex_app_server_protocol::ConfigEdit; | ||
| use codex_app_server_protocol::ConfigWriteResponse; | ||
| use codex_app_server_protocol::MergeStrategy; | ||
| use codex_app_server_protocol::RequestId; | ||
| use color_eyre::eyre::Result; | ||
| use color_eyre::eyre::WrapErr; | ||
| use serde_json::Value as JsonValue; | ||
| use uuid::Uuid; | ||
|
|
||
| pub(crate) fn replace_config_value(key_path: impl Into<String>, value: JsonValue) -> ConfigEdit { | ||
| ConfigEdit { | ||
| key_path: key_path.into(), | ||
| value, | ||
| merge_strategy: MergeStrategy::Replace, | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn clear_config_value(key_path: impl Into<String>) -> ConfigEdit { | ||
| replace_config_value(key_path, JsonValue::Null) | ||
| } | ||
|
|
||
| pub(crate) fn profile_scoped_key_path(profile: Option<&str>, key_path: &str) -> String { | ||
| if let Some(profile) = profile { | ||
| let profile = serde_json::Value::String(profile.to_string()).to_string(); | ||
| format!("profiles.{profile}.{key_path}") | ||
| } else { | ||
| key_path.to_string() | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn build_model_selection_edits( | ||
| profile: Option<&str>, | ||
| model: &str, | ||
| effort: Option<impl ToString>, | ||
| ) -> Vec<ConfigEdit> { | ||
| let effort_edit = effort.map_or_else( | ||
| || clear_config_value(profile_scoped_key_path(profile, "model_reasoning_effort")), | ||
| |effort| { | ||
| replace_config_value( | ||
| profile_scoped_key_path(profile, "model_reasoning_effort"), | ||
| serde_json::json!(effort.to_string()), | ||
| ) | ||
| }, | ||
| ); | ||
| vec![ | ||
| replace_config_value( | ||
| profile_scoped_key_path(profile, "model"), | ||
| serde_json::json!(model), | ||
| ), | ||
| effort_edit, | ||
| ] | ||
| } | ||
|
|
||
| pub(crate) fn build_service_tier_selection_edits( | ||
| profile: Option<&str>, | ||
| service_tier: Option<&str>, | ||
| ) -> Vec<ConfigEdit> { | ||
| let service_tier_edit = service_tier.map_or_else( | ||
| || clear_config_value(profile_scoped_key_path(profile, "service_tier")), | ||
| |service_tier| { | ||
| let config_value = | ||
| match codex_protocol::config_types::ServiceTier::from_request_value(service_tier) { | ||
| Some(codex_protocol::config_types::ServiceTier::Fast) => "fast", | ||
| Some(codex_protocol::config_types::ServiceTier::Flex) => "flex", | ||
| None => service_tier, | ||
| }; | ||
| replace_config_value( | ||
| profile_scoped_key_path(profile, "service_tier"), | ||
| serde_json::json!(config_value), | ||
| ) | ||
| }, | ||
| ); | ||
| let mut edits = vec![service_tier_edit]; | ||
| if service_tier.is_none() { | ||
| edits.push(replace_config_value( | ||
| "notice.fast_default_opt_out", | ||
| serde_json::json!(true), | ||
| )); | ||
| } | ||
| edits | ||
| } | ||
|
|
||
| pub(crate) async fn write_config_batch( | ||
| request_handle: AppServerRequestHandle, | ||
| edits: Vec<ConfigEdit>, | ||
| ) -> Result<()> { | ||
| let request_id = RequestId::String(format!("tui-config-write-{}", Uuid::new_v4())); | ||
| let _: ConfigWriteResponse = request_handle | ||
| .request_typed(ClientRequest::ConfigBatchWrite { | ||
| request_id, | ||
| params: ConfigBatchWriteParams { | ||
| edits, | ||
| file_path: None, | ||
| expected_version: None, | ||
| reload_user_config: true, | ||
| }, | ||
| }) | ||
| .await | ||
| .wrap_err("config/batchWrite failed in TUI")?; | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
| use pretty_assertions::assert_eq; | ||
|
|
||
| #[test] | ||
| fn profile_scoped_key_path_quotes_dotted_profile_names() { | ||
| assert_eq!( | ||
| profile_scoped_key_path(Some("team.prod"), "model"), | ||
| "profiles.\"team.prod\".model" | ||
| ); | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found a problem here with the help of Codex. When you write a profile with "a.b" notation, it will write to config.toml as:
The correct way is:
I created a profile like this:
And when I changed the model in the TUI I got:
And sure enough it uses the version with quotes when I start codex:
Suggested fix: reuse the existing segment-based config edit model instead of building profile paths with raw dot concatenation. Core already preserves profile names as one segment via
ConfigEdit::SetPath { segments }/ConfigEditsBuilder::with_profile; the lossy part here is the app-serverkey_pathstring being parsed withsplit('.').A compatible fix would be:
parse_key_pathwith a small TOML dotted-key parser that supports quoted segments.profile_scoped_key_path, e.g.profiles."team.prod".model.[profiles."team.prod"]and[profiles.team.prod]exist, then assertconfig/batchWriteupdates only the quoted active profile.That keeps this PR’s app-server write direction while matching the profile resolution behavior used at startup.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good find. This appears to be an existing bug in the app server layer. I'm going to explore whether it makes sense to fix as part of this PR or whether we should get a fix in place prior to merging this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was able to fix the app server bug with a relatively surgical fix (plus some regression tests), so I decided to include it as part of this PR.