mirror of
https://github.com/openai/codex.git
synced 2026-11-09 00:39:32 +00:00
gameofby
98923654d0
Issue #7661 revealed that users are confused by deprecation warnings like: > `tools.web_search` is deprecated. Use `web_search_request` instead. This message misleadingly suggests renaming the config key from `web_search` to `web_search_request`, when the actual required change is to **move and rename the configuration from the `[tools]` section to the `[features]` section**. This PR clarifies the warning messages and documentation to make it clear that deprecated `[tools]` configurations should be moved to `[features]`. Changes made: - Updated deprecation warning format in `codex-rs/core/src/codex.rs:520` to include `[features].` prefix - Updated corresponding test expectations in `codex-rs/core/tests/suite/deprecation_notice.rs:39` - Improved documentation in `docs/config.md` to clarify upfront that `[tools]` options are deprecated in favor of `[features]`
51 lines
1.7 KiB
Rust
51 lines
1.7 KiB
Rust
#![cfg(not(target_os = "windows"))]
|
|
|
|
use anyhow::Ok;
|
|
use codex_core::features::Feature;
|
|
use codex_core::protocol::DeprecationNoticeEvent;
|
|
use codex_core::protocol::EventMsg;
|
|
use core_test_support::responses::start_mock_server;
|
|
use core_test_support::skip_if_no_network;
|
|
use core_test_support::test_codex::TestCodex;
|
|
use core_test_support::test_codex::test_codex;
|
|
use core_test_support::wait_for_event_match;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
|
async fn emits_deprecation_notice_for_legacy_feature_flag() -> anyhow::Result<()> {
|
|
skip_if_no_network!(Ok(()));
|
|
|
|
let server = start_mock_server().await;
|
|
|
|
let mut builder = test_codex().with_config(|config| {
|
|
config.features.enable(Feature::UnifiedExec);
|
|
config
|
|
.features
|
|
.record_legacy_usage_force("use_experimental_unified_exec_tool", Feature::UnifiedExec);
|
|
config.use_experimental_unified_exec_tool = true;
|
|
});
|
|
|
|
let TestCodex { codex, .. } = builder.build(&server).await?;
|
|
|
|
let notice = wait_for_event_match(&codex, |event| match event {
|
|
EventMsg::DeprecationNotice(ev) => Some(ev.clone()),
|
|
_ => None,
|
|
})
|
|
.await;
|
|
|
|
let DeprecationNoticeEvent { summary, details } = notice;
|
|
assert_eq!(
|
|
summary,
|
|
"`use_experimental_unified_exec_tool` is deprecated. Use `[features].unified_exec` instead."
|
|
.to_string(),
|
|
);
|
|
assert_eq!(
|
|
details.as_deref(),
|
|
Some(
|
|
"Enable it with `--enable unified_exec` or `[features].unified_exec` in config.toml. See https://github.com/openai/codex/blob/main/docs/config.md#feature-flags for details."
|
|
),
|
|
);
|
|
|
|
Ok(())
|
|
}
|