mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
efrazer-oai
c8e5db16c9
## Summary
Enterprise users can have an effective monthly credit limit, but Codex
`/status` currently drops that metadata from the account-usage response.
This change adds the optional `spend_control.individual_limit`
projection to the existing rate-limit snapshot flow. The backend client
reads the monthly limit, app-server exposes it as `individualLimit`, and
the TUI renders a `Monthly credit limit` row through the existing
progress-bar renderer.
When the backend does not return an effective monthly limit, existing
rate-limit behavior is unchanged.
## Existing backend state
The account-usage backend already returns the effective monthly limit
and current usage together:
```json
{
"spend_control": {
"reached": false,
"individual_limit": {
"limit": "25000",
"used": "8000",
"remaining": "17000",
"used_percent": 32,
"remaining_percent": 68,
"reset_after_seconds": 86400,
"reset_at": 1778137680
}
}
}
```
Before this change, Codex projected rolling `primary` and `secondary`
windows plus `credits`. It ignored `spend_control.individual_limit`, so
app-server clients and `/status` could not render the monthly cap.
The updated flow is:
```text
account usage backend
-> backend-client reads spend_control.individual_limit
-> existing rate-limit snapshot carries optional individual_limit
-> app-server exposes optional individualLimit
-> TUI renders Monthly credit limit
```
## App-server contract
`account/rateLimits/read` and sparse `account/rateLimits/updated`
notifications now include an additive nullable
`rateLimits.individualLimit` field:
```json
{
"individualLimit": {
"limit": "25000",
"used": "8000",
"remainingPercent": 68,
"resetsAt": 1778137680
}
}
```
In an `account/rateLimits/read` response, `null` means no monthly limit
is available. `account/rateLimits/updated` remains a sparse rolling
notification: clients merge available values into their most recent
`account/rateLimits/read` snapshot or refetch. Nullable account metadata
in a rolling notification does not clear a previously observed value.
## Design decisions
- Extend the existing rate-limit snapshot instead of introducing a
separate request or wire-level update protocol.
- Keep the Codex projection narrow: `/status` needs the effective limit,
current usage, remaining percentage, and reset timestamp.
- Render the monthly row through the existing progress-bar renderer,
with one optional detail line for `8,000 of 25,000 credits used`.
- Keep the backend response optional so existing accounts and older
usage states preserve their current behavior.
- Preserve cached monthly metadata when sparse rolling notifications
omit it. Live account-usage reads remain authoritative and can clear a
removed limit.
## Visual evidence
```text
Monthly credit limit: [██████████████░░░░░░] 68% left (resets 07:08 on 7 May)
8,000 of 25,000 credits used
```
Snapshot:
`codex-rs/tui/src/status/snapshots/codex_tui__status__tests__status_snapshot_includes_enterprise_monthly_credit_limit.snap`
## Testing
Tests: generated app-server schema verification, protocol tests,
backend-client tests, app-server integration coverage, TUI snapshot
coverage, formatting, and workspace lint cleanup.
65 lines
2.3 KiB
Rust
65 lines
2.3 KiB
Rust
// Curated minimal export list for current workspace usage.
|
|
// NOTE: This file was previously auto-generated by the OpenAPI generator.
|
|
// Currently export only the types referenced by the workspace
|
|
// The process for this will change
|
|
|
|
// Config
|
|
pub(crate) mod config_bundle_response;
|
|
pub use self::config_bundle_response::ConfigBundleResponse;
|
|
|
|
pub(crate) mod config_file_response;
|
|
pub use self::config_file_response::ConfigFileResponse;
|
|
|
|
pub(crate) mod delivered_config_toml;
|
|
pub use self::delivered_config_toml::DeliveredConfigToml;
|
|
|
|
pub(crate) mod delivered_requirements_toml;
|
|
pub use self::delivered_requirements_toml::DeliveredRequirementsToml;
|
|
|
|
pub(crate) mod delivered_toml_fragment;
|
|
pub use self::delivered_toml_fragment::DeliveredTomlFragment;
|
|
|
|
// Cloud Tasks
|
|
pub(crate) mod code_task_details_response;
|
|
pub use self::code_task_details_response::CodeTaskDetailsResponse;
|
|
|
|
pub(crate) mod task_response;
|
|
pub use self::task_response::TaskResponse;
|
|
|
|
pub(crate) mod external_pull_request_response;
|
|
pub use self::external_pull_request_response::ExternalPullRequestResponse;
|
|
|
|
pub(crate) mod git_pull_request;
|
|
pub use self::git_pull_request::GitPullRequest;
|
|
|
|
pub(crate) mod task_list_item;
|
|
pub use self::task_list_item::TaskListItem;
|
|
|
|
pub(crate) mod paginated_list_task_list_item_;
|
|
pub use self::paginated_list_task_list_item_::PaginatedListTaskListItem;
|
|
|
|
// Rate Limits
|
|
pub(crate) mod additional_rate_limit_details;
|
|
pub use self::additional_rate_limit_details::AdditionalRateLimitDetails;
|
|
|
|
pub(crate) mod rate_limit_status_payload;
|
|
pub use self::rate_limit_status_payload::PlanType;
|
|
pub use self::rate_limit_status_payload::RateLimitReachedKind;
|
|
pub use self::rate_limit_status_payload::RateLimitReachedType;
|
|
pub use self::rate_limit_status_payload::RateLimitStatusPayload;
|
|
|
|
pub(crate) mod rate_limit_status_details;
|
|
pub use self::rate_limit_status_details::RateLimitStatusDetails;
|
|
|
|
pub(crate) mod rate_limit_window_snapshot;
|
|
pub use self::rate_limit_window_snapshot::RateLimitWindowSnapshot;
|
|
|
|
pub(crate) mod credit_status_details;
|
|
pub use self::credit_status_details::CreditStatusDetails;
|
|
|
|
pub(crate) mod spend_control_limit_details;
|
|
pub use self::spend_control_limit_details::SpendControlLimitDetails;
|
|
|
|
pub(crate) mod spend_control_status_details;
|
|
pub use self::spend_control_status_details::SpendControlStatusDetails;
|