mirror of
https://github.com/openai/codex.git
synced 2026-11-18 23:02:23 +00:00
Show estimated thread usage in /status (#38281)
## What changed - Extend `account/usage/read` with an optional `threadId` request and a backward-compatible `threadUsage` response containing estimated credits, optional USD cost, and model, reasoning, speed, and token breakdowns. - Fetch thread usage for eligible Business and Enterprise plans when `/status` is opened, then update the rendered status card asynchronously. - Preserve terminal scrollback when replacing a visible status-card tail, and append a refreshed card when the original tail can no longer be updated. ## Testing - Add app-server coverage for authentication, canonical thread IDs, unavailable billing routes, and malformed IDs. - Add TUI coverage for usage formatting, stale responses, retries, history updates, terminal reflow, and scrollback preservation. GitOrigin-RevId: 49300914b3fba917c0f08e8595363e04e5ba6d37
This commit is contained in:
1 parent
27a98dde4d
commit
f1a1fce26a
55 files changed
+2903
-60
No files matched your search
@@ -8,18 +8,20 @@ use super::plugin_mentions::fetch_plugin_mentions;
|
||||
use super::*;
|
||||
use crate::app_event::ConnectorsSnapshot;
|
||||
use crate::app_info::app_info_from_api;
|
||||
use crate::chatwidget::ThreadUsageOutcome;
|
||||
use crate::config_update::format_config_error;
|
||||
use codex_app_server_protocol::AppsListParams;
|
||||
use codex_app_server_protocol::AppsListResponse;
|
||||
use codex_app_server_protocol::ConsumeAccountRateLimitResetCreditParams;
|
||||
use codex_app_server_protocol::ConsumeAccountRateLimitResetCreditResponse;
|
||||
use codex_app_server_protocol::GetAccountTokenUsageParams;
|
||||
use codex_app_server_protocol::GetAccountTokenUsageResponse;
|
||||
use codex_app_server_protocol::MarketplaceAddParams;
|
||||
use codex_app_server_protocol::MarketplaceAddResponse;
|
||||
use codex_app_server_protocol::MarketplaceRemoveParams;
|
||||
use codex_app_server_protocol::MarketplaceRemoveResponse;
|
||||
use codex_app_server_protocol::MarketplaceUpgradeParams;
|
||||
use codex_app_server_protocol::MarketplaceUpgradeResponse;
|
||||
|
||||
use codex_app_server_protocol::RequestId;
|
||||
|
||||
use crate::hooks_rpc::fetch_hooks_list;
|
||||
@@ -29,6 +31,8 @@ use codex_utils_absolute_path::AbsolutePathBuf;
|
||||
|
||||
const TOKEN_ACTIVITY_FETCH_TIMEOUT: std::time::Duration =
|
||||
std::time::Duration::from_secs(/*secs*/ 15);
|
||||
const THREAD_USAGE_FETCH_TIMEOUT: std::time::Duration =
|
||||
std::time::Duration::from_secs(/*secs*/ 65);
|
||||
const RATE_LIMIT_RESET_REQUEST_TIMEOUT: std::time::Duration =
|
||||
std::time::Duration::from_secs(/*secs*/ 15);
|
||||
const WORKSPACE_HEADLINE_FETCH_TIMEOUT: std::time::Duration =
|
||||
@@ -124,6 +128,30 @@ impl App {
|
||||
});
|
||||
}
|
||||
|
||||
pub(super) fn refresh_thread_usage(
|
||||
&mut self,
|
||||
app_server: &AppServerSession,
|
||||
thread_id: ThreadId,
|
||||
request_id: u64,
|
||||
) {
|
||||
let request_handle = app_server.request_handle();
|
||||
let app_event_tx = self.app_event_tx.clone();
|
||||
tokio::spawn(async move {
|
||||
let result = tokio::time::timeout(
|
||||
THREAD_USAGE_FETCH_TIMEOUT,
|
||||
fetch_thread_usage(request_handle, thread_id),
|
||||
)
|
||||
.await
|
||||
.map_err(|_| "thread usage request timed out in TUI".to_string())
|
||||
.and_then(|result| result.map_err(|err| err.to_string()));
|
||||
app_event_tx.send(AppEvent::ThreadUsageLoaded {
|
||||
thread_id,
|
||||
request_id,
|
||||
result,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
pub(super) fn consume_rate_limit_reset_credit(
|
||||
&mut self,
|
||||
app_server: &AppServerSession,
|
||||
@@ -783,6 +811,26 @@ pub(super) async fn fetch_account_token_activity(
|
||||
.wrap_err("account/usage/read failed in TUI")
|
||||
}
|
||||
|
||||
async fn fetch_thread_usage(
|
||||
request_handle: AppServerRequestHandle,
|
||||
thread_id: ThreadId,
|
||||
) -> Result<ThreadUsageOutcome> {
|
||||
let request_id = RequestId::String(format!("thread-usage-{}", Uuid::new_v4()));
|
||||
let response: GetAccountTokenUsageResponse = request_handle
|
||||
.request_typed(ClientRequest::GetAccountTokenUsage {
|
||||
request_id,
|
||||
params: Some(GetAccountTokenUsageParams {
|
||||
thread_id: Some(thread_id.to_string()),
|
||||
}),
|
||||
})
|
||||
.await
|
||||
.wrap_err("account/usage/read failed for thread usage in TUI")?;
|
||||
Ok(response
|
||||
.thread_usage
|
||||
.map(ThreadUsageOutcome::Available)
|
||||
.unwrap_or(ThreadUsageOutcome::Disabled))
|
||||
}
|
||||
|
||||
pub(super) async fn consume_rate_limit_reset_credit_request(
|
||||
request_handle: AppServerRequestHandle,
|
||||
idempotency_key: String,
|
||||
@@ -1285,11 +1333,79 @@ pub(super) fn mcp_inventory_maps_from_statuses(statuses: Vec<McpServerStatus>) -
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::app::test_support::make_test_app;
|
||||
use app_test_support::ChatGptAuthFixture;
|
||||
use app_test_support::write_chatgpt_auth;
|
||||
use codex_app_server_protocol::PluginMarketplaceEntry;
|
||||
use codex_app_server_protocol::ThreadUsage;
|
||||
use codex_config::types::AuthCredentialsStoreMode;
|
||||
use codex_protocol::mcp::Tool;
|
||||
use codex_utils_absolute_path::AbsolutePathBuf;
|
||||
use pretty_assertions::assert_eq;
|
||||
|
||||
#[tokio::test]
|
||||
async fn fetch_thread_usage_uses_app_server_auth_after_persisted_account_changes() {
|
||||
let mut app = make_test_app().await;
|
||||
let server = wiremock::MockServer::start().await;
|
||||
let thread_id = ThreadId::new();
|
||||
app.config.chatgpt_base_url = server.uri();
|
||||
app.config.cli_auth_credentials_store_mode = AuthCredentialsStoreMode::File;
|
||||
write_chatgpt_auth(
|
||||
app.config.codex_home.as_path(),
|
||||
ChatGptAuthFixture::new("chatgpt-token").account_id("account-123"),
|
||||
AuthCredentialsStoreMode::File,
|
||||
)
|
||||
.expect("write ChatGPT authentication");
|
||||
let app_server = crate::start_embedded_app_server_for_picker(&app.config)
|
||||
.await
|
||||
.expect("start authenticated embedded app server");
|
||||
write_chatgpt_auth(
|
||||
app.config.codex_home.as_path(),
|
||||
ChatGptAuthFixture::new("different-token").account_id("different-account"),
|
||||
AuthCredentialsStoreMode::File,
|
||||
)
|
||||
.expect("replace persisted ChatGPT authentication");
|
||||
|
||||
wiremock::Mock::given(wiremock::matchers::method("POST"))
|
||||
.and(wiremock::matchers::path(
|
||||
"/api/codex/usage/thread_usage/query",
|
||||
))
|
||||
.and(wiremock::matchers::header(
|
||||
"authorization",
|
||||
"Bearer chatgpt-token",
|
||||
))
|
||||
.and(wiremock::matchers::header(
|
||||
"chatgpt-account-id",
|
||||
"account-123",
|
||||
))
|
||||
.and(wiremock::matchers::body_json(serde_json::json!({
|
||||
"thread_ids": [thread_id.to_string()]
|
||||
})))
|
||||
.respond_with(wiremock::ResponseTemplate::new(/*s*/ 200).set_body_json(
|
||||
serde_json::json!({
|
||||
"threads": [{
|
||||
"thread_id": thread_id.to_string(),
|
||||
"estimated_usage_credits_micros": 46_000_000,
|
||||
"estimated_usage_usd_micros": 1_820_000
|
||||
}]
|
||||
}),
|
||||
))
|
||||
.expect(/*r*/ 1)
|
||||
.mount(&server)
|
||||
.await;
|
||||
|
||||
assert_eq!(
|
||||
fetch_thread_usage(app_server.request_handle(), thread_id)
|
||||
.await
|
||||
.expect("read thread usage through the authenticated app server"),
|
||||
ThreadUsageOutcome::Available(ThreadUsage {
|
||||
thread_id: thread_id.to_string(),
|
||||
estimated_usage_credits_micros: 46_000_000,
|
||||
estimated_usage_usd_micros: Some(1_820_000),
|
||||
groups: Vec::new(),
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
fn test_absolute_path(path: &str) -> AbsolutePathBuf {
|
||||
AbsolutePathBuf::try_from(PathBuf::from(path)).expect("absolute test path")
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user