[codex] Thread backend-selected near-limit prompt state through client models

This commit is contained in:
James Chu
2026-05-03 23:33:48 -04:00
parent ff27d01676
commit 53dbdbfa9d
28 changed files with 558 additions and 3 deletions
@@ -2425,6 +2425,16 @@
}
]
},
"currentUsageLimitNudge": {
"anyOf": [
{
"$ref": "#/definitions/UsageLimitNudge"
},
{
"type": "null"
}
]
},
"limitId": {
"type": [
"string",
@@ -4373,6 +4383,30 @@
],
"type": "string"
},
"UsageLimitNudge": {
"properties": {
"action": {
"$ref": "#/definitions/UsageLimitNudgeAction"
},
"threshold": {
"format": "uint8",
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"action",
"threshold"
],
"type": "object"
},
"UsageLimitNudgeAction": {
"enum": [
"add_credits",
"upgrade"
],
"type": "string"
},
"UserInput": {
"oneOf": [
{
@@ -12770,6 +12770,16 @@
}
]
},
"currentUsageLimitNudge": {
"anyOf": [
{
"$ref": "#/definitions/v2/UsageLimitNudge"
},
{
"type": "null"
}
]
},
"limitId": {
"type": [
"string",
@@ -17804,6 +17814,30 @@
"title": "TurnSteerResponse",
"type": "object"
},
"UsageLimitNudge": {
"properties": {
"action": {
"$ref": "#/definitions/v2/UsageLimitNudgeAction"
},
"threshold": {
"format": "uint8",
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"action",
"threshold"
],
"type": "object"
},
"UsageLimitNudgeAction": {
"enum": [
"add_credits",
"upgrade"
],
"type": "string"
},
"UserInput": {
"oneOf": [
{
@@ -9423,6 +9423,16 @@
}
]
},
"currentUsageLimitNudge": {
"anyOf": [
{
"$ref": "#/definitions/UsageLimitNudge"
},
{
"type": "null"
}
]
},
"limitId": {
"type": [
"string",
@@ -15690,6 +15700,30 @@
"title": "TurnSteerResponse",
"type": "object"
},
"UsageLimitNudge": {
"properties": {
"action": {
"$ref": "#/definitions/UsageLimitNudgeAction"
},
"threshold": {
"format": "uint8",
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"action",
"threshold"
],
"type": "object"
},
"UsageLimitNudgeAction": {
"enum": [
"add_credits",
"upgrade"
],
"type": "string"
},
"UserInput": {
"oneOf": [
{
@@ -61,6 +61,16 @@
}
]
},
"currentUsageLimitNudge": {
"anyOf": [
{
"$ref": "#/definitions/UsageLimitNudge"
},
{
"type": "null"
}
]
},
"limitId": {
"type": [
"string",
@@ -141,6 +151,30 @@
"usedPercent"
],
"type": "object"
},
"UsageLimitNudge": {
"properties": {
"action": {
"$ref": "#/definitions/UsageLimitNudgeAction"
},
"threshold": {
"format": "uint8",
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"action",
"threshold"
],
"type": "object"
},
"UsageLimitNudgeAction": {
"enum": [
"add_credits",
"upgrade"
],
"type": "string"
}
},
"properties": {
@@ -61,6 +61,16 @@
}
]
},
"currentUsageLimitNudge": {
"anyOf": [
{
"$ref": "#/definitions/UsageLimitNudge"
},
{
"type": "null"
}
]
},
"limitId": {
"type": [
"string",
@@ -141,6 +151,30 @@
"usedPercent"
],
"type": "object"
},
"UsageLimitNudge": {
"properties": {
"action": {
"$ref": "#/definitions/UsageLimitNudgeAction"
},
"threshold": {
"format": "uint8",
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"action",
"threshold"
],
"type": "object"
},
"UsageLimitNudgeAction": {
"enum": [
"add_credits",
"upgrade"
],
"type": "string"
}
},
"properties": {
@@ -5,5 +5,6 @@ import type { PlanType } from "../PlanType";
import type { CreditsSnapshot } from "./CreditsSnapshot";
import type { RateLimitReachedType } from "./RateLimitReachedType";
import type { RateLimitWindow } from "./RateLimitWindow";
import type { UsageLimitNudge } from "./UsageLimitNudge";
export type RateLimitSnapshot = { limitId: string | null, limitName: string | null, primary: RateLimitWindow | null, secondary: RateLimitWindow | null, credits: CreditsSnapshot | null, planType: PlanType | null, rateLimitReachedType: RateLimitReachedType | null, };
export type RateLimitSnapshot = { limitId: string | null, limitName: string | null, primary: RateLimitWindow | null, secondary: RateLimitWindow | null, credits: CreditsSnapshot | null, planType: PlanType | null, rateLimitReachedType: RateLimitReachedType | null, currentUsageLimitNudge: UsageLimitNudge | null, };
@@ -0,0 +1,6 @@
// GENERATED CODE! DO NOT MODIFY BY HAND!
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { UsageLimitNudgeAction } from "./UsageLimitNudgeAction";
export type UsageLimitNudge = { threshold: number, action: UsageLimitNudgeAction, };
@@ -0,0 +1,5 @@
// GENERATED CODE! DO NOT MODIFY BY HAND!
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
export type UsageLimitNudgeAction = "add_credits" | "upgrade";
@@ -428,6 +428,8 @@ export type { TurnStartedNotification } from "./TurnStartedNotification";
export type { TurnStatus } from "./TurnStatus";
export type { TurnSteerParams } from "./TurnSteerParams";
export type { TurnSteerResponse } from "./TurnSteerResponse";
export type { UsageLimitNudge } from "./UsageLimitNudge";
export type { UsageLimitNudgeAction } from "./UsageLimitNudgeAction";
export type { UserInput } from "./UserInput";
export type { WarningNotification } from "./WarningNotification";
export type { WebSearchAction } from "./WebSearchAction";
@@ -101,6 +101,8 @@ use codex_protocol::protocol::SubAgentSource as CoreSubAgentSource;
use codex_protocol::protocol::ThreadGoalStatus as CoreThreadGoalStatus;
use codex_protocol::protocol::TokenUsage as CoreTokenUsage;
use codex_protocol::protocol::TokenUsageInfo as CoreTokenUsageInfo;
use codex_protocol::protocol::UsageLimitNudge as CoreUsageLimitNudge;
use codex_protocol::protocol::UsageLimitNudgeAction as CoreUsageLimitNudgeAction;
use codex_protocol::request_permissions::PermissionGrantScope as CorePermissionGrantScope;
use codex_protocol::request_permissions::RequestPermissionProfile as CoreRequestPermissionProfile;
use codex_protocol::user_input::ByteRange as CoreByteRange;
@@ -7867,6 +7869,7 @@ pub struct RateLimitSnapshot {
pub credits: Option<CreditsSnapshot>,
pub plan_type: Option<PlanType>,
pub rate_limit_reached_type: Option<RateLimitReachedType>,
pub current_usage_limit_nudge: Option<UsageLimitNudge>,
}
impl From<CoreRateLimitSnapshot> for RateLimitSnapshot {
@@ -7881,6 +7884,54 @@ impl From<CoreRateLimitSnapshot> for RateLimitSnapshot {
rate_limit_reached_type: value
.rate_limit_reached_type
.map(RateLimitReachedType::from),
current_usage_limit_nudge: value
.current_usage_limit_nudge
.as_ref()
.and_then(CoreUsageLimitNudge::from_payload)
.map(UsageLimitNudge::from),
}
}
}
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
#[serde(rename_all = "camelCase")]
#[ts(export_to = "v2/")]
pub struct UsageLimitNudge {
pub threshold: u8,
pub action: UsageLimitNudgeAction,
}
impl From<CoreUsageLimitNudge> for UsageLimitNudge {
fn from(value: CoreUsageLimitNudge) -> Self {
Self {
threshold: value.threshold.as_percent(),
action: value.action.into(),
}
}
}
#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, JsonSchema, TS)]
#[serde(rename_all = "snake_case")]
#[ts(export_to = "v2/", rename_all = "snake_case")]
pub enum UsageLimitNudgeAction {
AddCredits,
Upgrade,
}
impl From<CoreUsageLimitNudgeAction> for UsageLimitNudgeAction {
fn from(value: CoreUsageLimitNudgeAction) -> Self {
match value {
CoreUsageLimitNudgeAction::AddCredits => Self::AddCredits,
CoreUsageLimitNudgeAction::Upgrade => Self::Upgrade,
}
}
}
impl From<UsageLimitNudgeAction> for CoreUsageLimitNudgeAction {
fn from(value: UsageLimitNudgeAction) -> Self {
match value {
UsageLimitNudgeAction::AddCredits => Self::AddCredits,
UsageLimitNudgeAction::Upgrade => Self::Upgrade,
}
}
}
@@ -11309,4 +11360,75 @@ mod tests {
"unexpected error: {err}"
);
}
#[test]
fn rate_limit_snapshot_preserves_current_usage_limit_nudge() {
let active: RateLimitSnapshot = serde_json::from_value(json!({
"limitId": "codex",
"limitName": null,
"primary": null,
"secondary": null,
"credits": null,
"planType": null,
"rateLimitReachedType": null,
"currentUsageLimitNudge": {
"threshold": 75,
"action": "upgrade"
}
}))
.expect("active snapshot should deserialize");
assert_eq!(
active.current_usage_limit_nudge,
Some(UsageLimitNudge {
threshold: 75,
action: UsageLimitNudgeAction::Upgrade,
})
);
assert_eq!(
serde_json::to_value(&active)
.expect("active snapshot should serialize")
.get("currentUsageLimitNudge"),
Some(&json!({
"threshold": 75,
"action": "upgrade"
}))
);
let inactive: RateLimitSnapshot = serde_json::from_value(json!({
"limitId": "codex",
"limitName": null,
"primary": null,
"secondary": null,
"credits": null,
"planType": null,
"rateLimitReachedType": null,
"currentUsageLimitNudge": null
}))
.expect("inactive snapshot should deserialize");
assert_eq!(inactive.current_usage_limit_nudge, None);
assert_eq!(
serde_json::to_value(&inactive)
.expect("inactive snapshot should serialize")
.get("currentUsageLimitNudge"),
Some(&json!(null))
);
let missing: RateLimitSnapshot = serde_json::from_value(json!({
"limitId": "codex",
"limitName": null,
"primary": null,
"secondary": null,
"credits": null,
"planType": null,
"rateLimitReachedType": null
}))
.expect("missing snapshot should deserialize");
assert_eq!(missing.current_usage_limit_nudge, None);
assert_eq!(
serde_json::to_value(&missing)
.expect("missing snapshot should serialize")
.get("currentUsageLimitNudge"),
Some(&json!(null))
);
}
}