mirror of
https://github.com/openai/codex.git
synced 2026-11-19 15:04:25 +00:00
Option to Notify Workspace Owner When Usage Limit is Reached (#16969)
## Summary - Replace the manual `/notify-owner` flow with an inline confirmation prompt when a usage-based workspace member hits a credits-depleted limit. - Fetch the current workspace role from the live ChatGPT `accounts/check/v4-2023-04-27` endpoint so owner/member behavior matches the desktop and web clients. - Keep owner, member, and spend-cap messaging distinct so we only offer the owner nudge when the workspace is actually out of credits. ## What Changed - `backend-client` - Added a typed fetch for the current account role from `accounts/check`. - Mapped backend role values into a Rust workspace-role enum. - `app-server` and protocol - Added `workspaceRole` to `account/read` and `account/updated`. - Derived `isWorkspaceOwner` from the live role, with a fallback to the cached token claim when the role fetch is unavailable. - `tui` - Removed the explicit `/notify-owner` slash command. - When a member is blocked because the workspace is out of credits, the error now prompts: - `Your workspace is out of credits. Request more from your workspace owner? [y/N]` - Choosing `y` sends the existing owner-notification request. - Choosing `n`, pressing `Esc`, or accepting the default selection dismisses the prompt without sending anything. - Selection popups now honor explicit item shortcuts, which is how the `y` / `n` interaction is wired. ## Reviewer Notes - The main behavior change is scoped to usage-based workspace members whose workspace credits are depleted. - Spend-cap reached should not show the owner-notification prompt. - Owners and admins should continue to see `/usage` guidance instead of the member prompt. - The live role fetch is best-effort; if it fails, we fall back to the existing token-derived ownership signal. ## Testing - Manual verification - Workspace owner does not see the member prompt. - Workspace member with depleted credits sees the confirmation prompt and can send the nudge with `y`. - Workspace member with spend cap reached does not see the owner-notification prompt. ### Workspace member out of usage https://github.com/user-attachments/assets/341ac396-eff4-4a7f-bf0c-60660becbea1 ### Workspace owner <img width="1728" height="1086" alt="Screenshot 2026-04-09 at 11 48 22 AM" src="https://github.com/user-attachments/assets/06262a45-e3fc-4cc4-8326-1cbedad46ed6" />
This commit is contained in:
1 parent
36712d8546
commit
9f2a585153
82 files changed
+3233
-60
No files matched your search
@@ -1,8 +1,10 @@
|
||||
use crate::types::AccountsCheckV4Response;
|
||||
use crate::types::CodeTaskDetailsResponse;
|
||||
use crate::types::ConfigFileResponse;
|
||||
use crate::types::PaginatedListTaskListItem;
|
||||
use crate::types::RateLimitStatusPayload;
|
||||
use crate::types::TurnAttemptsSiblingTurnsResponse;
|
||||
use crate::types::WorkspaceRole;
|
||||
use anyhow::Result;
|
||||
use codex_client::build_reqwest_client_with_custom_ca;
|
||||
use codex_login::CodexAuth;
|
||||
@@ -11,6 +13,7 @@ use codex_protocol::account::PlanType as AccountPlanType;
|
||||
use codex_protocol::protocol::CreditsSnapshot;
|
||||
use codex_protocol::protocol::RateLimitSnapshot;
|
||||
use codex_protocol::protocol::RateLimitWindow;
|
||||
use codex_protocol::protocol::SpendControlSnapshot;
|
||||
use reqwest::StatusCode;
|
||||
use reqwest::header::AUTHORIZATION;
|
||||
use reqwest::header::CONTENT_TYPE;
|
||||
@@ -20,6 +23,10 @@ use reqwest::header::HeaderValue;
|
||||
use reqwest::header::USER_AGENT;
|
||||
use serde::de::DeserializeOwned;
|
||||
use std::fmt;
|
||||
use std::time::Duration;
|
||||
|
||||
const BACKEND_REQUEST_TIMEOUT: Duration = Duration::from_secs(10);
|
||||
const ACCOUNTS_CHECK_V4_VERSION: &str = "v4-2023-04-27";
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum RequestError {
|
||||
@@ -259,12 +266,55 @@ impl Client {
|
||||
PathStyle::CodexApi => format!("{}/api/codex/usage", self.base_url),
|
||||
PathStyle::ChatGptApi => format!("{}/wham/usage", self.base_url),
|
||||
};
|
||||
let req = self.http.get(&url).headers(self.headers());
|
||||
let req = self
|
||||
.http
|
||||
.get(&url)
|
||||
.headers(self.headers())
|
||||
.timeout(BACKEND_REQUEST_TIMEOUT);
|
||||
let (body, ct) = self.exec_request(req, "GET", &url).await?;
|
||||
let payload: RateLimitStatusPayload = self.decode_json(&url, &ct, &body)?;
|
||||
Ok(Self::rate_limit_snapshots_from_payload(payload))
|
||||
}
|
||||
|
||||
pub async fn send_add_credits_nudge_email(&self) -> std::result::Result<(), RequestError> {
|
||||
let url = match self.path_style {
|
||||
PathStyle::CodexApi => {
|
||||
format!(
|
||||
"{}/api/codex/accounts/send_add_credits_nudge_email",
|
||||
self.base_url
|
||||
)
|
||||
}
|
||||
PathStyle::ChatGptApi => {
|
||||
format!("{}/accounts/send_add_credits_nudge_email", self.base_url)
|
||||
}
|
||||
};
|
||||
let req = self
|
||||
.http
|
||||
.post(&url)
|
||||
.headers(self.headers())
|
||||
.timeout(BACKEND_REQUEST_TIMEOUT);
|
||||
let _ = self.exec_request_detailed(req, "POST", &url).await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn get_current_workspace_role(&self) -> Result<Option<WorkspaceRole>> {
|
||||
if self.path_style != PathStyle::ChatGptApi {
|
||||
return Ok(None);
|
||||
}
|
||||
let url = format!(
|
||||
"{}/accounts/check/{ACCOUNTS_CHECK_V4_VERSION}",
|
||||
self.base_url
|
||||
);
|
||||
let req = self
|
||||
.http
|
||||
.get(&url)
|
||||
.headers(self.headers())
|
||||
.timeout(BACKEND_REQUEST_TIMEOUT);
|
||||
let (body, ct) = self.exec_request(req, "GET", &url).await?;
|
||||
let payload: AccountsCheckV4Response = self.decode_json(&url, &ct, &body)?;
|
||||
Ok(payload.current_workspace_role(self.chatgpt_account_id.as_deref()))
|
||||
}
|
||||
|
||||
pub async fn list_tasks(
|
||||
&self,
|
||||
limit: Option<i32>,
|
||||
@@ -397,20 +447,23 @@ impl Client {
|
||||
payload: RateLimitStatusPayload,
|
||||
) -> Vec<RateLimitSnapshot> {
|
||||
let plan_type = Some(Self::map_plan_type(payload.plan_type));
|
||||
let spend_control = payload.spend_control.map(|details| *details);
|
||||
let mut snapshots = vec![Self::make_rate_limit_snapshot(
|
||||
Some("codex".to_string()),
|
||||
/*limit_name*/ None,
|
||||
payload.rate_limit.flatten().map(|details| *details),
|
||||
payload.credits.flatten().map(|details| *details),
|
||||
payload.rate_limit.map(|details| *details),
|
||||
payload.credits.map(|details| *details),
|
||||
spend_control,
|
||||
plan_type,
|
||||
)];
|
||||
if let Some(additional) = payload.additional_rate_limits.flatten() {
|
||||
if let Some(additional) = payload.additional_rate_limits {
|
||||
snapshots.extend(additional.into_iter().map(|details| {
|
||||
Self::make_rate_limit_snapshot(
|
||||
Some(details.metered_feature),
|
||||
Some(details.limit_name),
|
||||
details.rate_limit.flatten().map(|rate_limit| *rate_limit),
|
||||
/*credits*/ None,
|
||||
/*spend_control*/ None,
|
||||
plan_type,
|
||||
)
|
||||
}));
|
||||
@@ -423,6 +476,7 @@ impl Client {
|
||||
limit_name: Option<String>,
|
||||
rate_limit: Option<crate::types::RateLimitStatusDetails>,
|
||||
credits: Option<crate::types::CreditStatusDetails>,
|
||||
spend_control: Option<crate::types::SpendControlStatusDetails>,
|
||||
plan_type: Option<AccountPlanType>,
|
||||
) -> RateLimitSnapshot {
|
||||
let (primary, secondary) = match rate_limit {
|
||||
@@ -438,6 +492,7 @@ impl Client {
|
||||
primary,
|
||||
secondary,
|
||||
credits: Self::map_credits(credits),
|
||||
spend_control: Self::map_spend_control(spend_control),
|
||||
plan_type,
|
||||
}
|
||||
}
|
||||
@@ -467,6 +522,15 @@ impl Client {
|
||||
})
|
||||
}
|
||||
|
||||
fn map_spend_control(
|
||||
spend_control: Option<crate::types::SpendControlStatusDetails>,
|
||||
) -> Option<SpendControlSnapshot> {
|
||||
let details = spend_control?;
|
||||
Some(SpendControlSnapshot {
|
||||
reached: details.reached,
|
||||
})
|
||||
}
|
||||
|
||||
fn map_plan_type(plan_type: crate::types::PlanType) -> AccountPlanType {
|
||||
match plan_type {
|
||||
crate::types::PlanType::Free => AccountPlanType::Free,
|
||||
@@ -503,7 +567,6 @@ impl Client {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use codex_backend_openapi_models::models::AdditionalRateLimitDetails;
|
||||
use pretty_assertions::assert_eq;
|
||||
|
||||
#[test]
|
||||
@@ -522,7 +585,7 @@ mod tests {
|
||||
fn usage_payload_maps_primary_and_additional_rate_limits() {
|
||||
let payload = RateLimitStatusPayload {
|
||||
plan_type: crate::types::PlanType::Pro,
|
||||
rate_limit: Some(Some(Box::new(crate::types::RateLimitStatusDetails {
|
||||
rate_limit: Some(Box::new(crate::types::RateLimitStatusDetails {
|
||||
primary_window: Some(Some(Box::new(crate::types::RateLimitWindowSnapshot {
|
||||
used_percent: 42,
|
||||
limit_window_seconds: 300,
|
||||
@@ -536,8 +599,8 @@ mod tests {
|
||||
reset_at: 456,
|
||||
}))),
|
||||
..Default::default()
|
||||
}))),
|
||||
additional_rate_limits: Some(Some(vec![AdditionalRateLimitDetails {
|
||||
})),
|
||||
additional_rate_limits: Some(vec![crate::types::AdditionalRateLimitDetails {
|
||||
limit_name: "codex_other".to_string(),
|
||||
metered_feature: "codex_other".to_string(),
|
||||
rate_limit: Some(Some(Box::new(crate::types::RateLimitStatusDetails {
|
||||
@@ -550,13 +613,16 @@ mod tests {
|
||||
secondary_window: None,
|
||||
..Default::default()
|
||||
}))),
|
||||
}])),
|
||||
credits: Some(Some(Box::new(crate::types::CreditStatusDetails {
|
||||
}]),
|
||||
credits: Some(Box::new(crate::types::CreditStatusDetails {
|
||||
has_credits: true,
|
||||
unlimited: false,
|
||||
balance: Some(Some("9.99".to_string())),
|
||||
..Default::default()
|
||||
}))),
|
||||
})),
|
||||
spend_control: Some(Box::new(crate::types::SpendControlStatusDetails {
|
||||
reached: true,
|
||||
})),
|
||||
};
|
||||
|
||||
let snapshots = Client::rate_limit_snapshots_from_payload(payload);
|
||||
@@ -580,6 +646,10 @@ mod tests {
|
||||
balance: Some("9.99".to_string()),
|
||||
})
|
||||
);
|
||||
assert_eq!(
|
||||
snapshots[0].spend_control,
|
||||
Some(SpendControlSnapshot { reached: true })
|
||||
);
|
||||
assert_eq!(snapshots[0].plan_type, Some(AccountPlanType::Pro));
|
||||
|
||||
assert_eq!(snapshots[1].limit_id.as_deref(), Some("codex_other"));
|
||||
@@ -589,6 +659,7 @@ mod tests {
|
||||
Some(70.0)
|
||||
);
|
||||
assert_eq!(snapshots[1].credits, None);
|
||||
assert_eq!(snapshots[1].spend_control, None);
|
||||
assert_eq!(snapshots[1].plan_type, Some(AccountPlanType::Pro));
|
||||
}
|
||||
|
||||
@@ -597,12 +668,13 @@ mod tests {
|
||||
let payload = RateLimitStatusPayload {
|
||||
plan_type: crate::types::PlanType::Plus,
|
||||
rate_limit: None,
|
||||
additional_rate_limits: Some(Some(vec![AdditionalRateLimitDetails {
|
||||
additional_rate_limits: Some(vec![crate::types::AdditionalRateLimitDetails {
|
||||
limit_name: "codex_other".to_string(),
|
||||
metered_feature: "codex_other".to_string(),
|
||||
rate_limit: None,
|
||||
}])),
|
||||
}]),
|
||||
credits: None,
|
||||
spend_control: None,
|
||||
};
|
||||
|
||||
let snapshots = Client::rate_limit_snapshots_from_payload(payload);
|
||||
@@ -610,6 +682,7 @@ mod tests {
|
||||
assert_eq!(snapshots[0].limit_id.as_deref(), Some("codex"));
|
||||
assert_eq!(snapshots[0].limit_name, None);
|
||||
assert_eq!(snapshots[0].primary, None);
|
||||
assert_eq!(snapshots[0].spend_control, None);
|
||||
assert_eq!(snapshots[1].limit_id.as_deref(), Some("codex_other"));
|
||||
assert_eq!(snapshots[1].limit_name.as_deref(), Some("codex_other"));
|
||||
}
|
||||
@@ -627,6 +700,7 @@ mod tests {
|
||||
}),
|
||||
secondary: None,
|
||||
credits: None,
|
||||
spend_control: None,
|
||||
plan_type: Some(AccountPlanType::Pro),
|
||||
},
|
||||
RateLimitSnapshot {
|
||||
@@ -639,6 +713,7 @@ mod tests {
|
||||
}),
|
||||
secondary: None,
|
||||
credits: None,
|
||||
spend_control: None,
|
||||
plan_type: Some(AccountPlanType::Pro),
|
||||
},
|
||||
];
|
||||
@@ -650,4 +725,46 @@ mod tests {
|
||||
.unwrap_or_else(|| snapshots[0].clone());
|
||||
assert_eq!(preferred.limit_id.as_deref(), Some("codex"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn add_credits_nudge_email_uses_expected_paths() {
|
||||
let codex_api = Client::new("https://example.com").expect("codex api client");
|
||||
assert_eq!(
|
||||
match codex_api.path_style {
|
||||
PathStyle::CodexApi => format!(
|
||||
"{}/api/codex/accounts/send_add_credits_nudge_email",
|
||||
codex_api.base_url
|
||||
),
|
||||
PathStyle::ChatGptApi => unreachable!("plain host should use codex api paths"),
|
||||
},
|
||||
"https://example.com/api/codex/accounts/send_add_credits_nudge_email"
|
||||
);
|
||||
|
||||
let chatgpt_api = Client::new("https://chatgpt.com").expect("chatgpt backend api client");
|
||||
assert_eq!(
|
||||
match chatgpt_api.path_style {
|
||||
PathStyle::CodexApi => unreachable!("chatgpt host should use backend-api paths"),
|
||||
PathStyle::ChatGptApi => format!(
|
||||
"{}/accounts/send_add_credits_nudge_email",
|
||||
chatgpt_api.base_url
|
||||
),
|
||||
},
|
||||
"https://chatgpt.com/backend-api/accounts/send_add_credits_nudge_email"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn current_workspace_role_uses_expected_path() {
|
||||
let chatgpt_api = Client::new("https://chatgpt.com").expect("chatgpt backend api client");
|
||||
assert_eq!(
|
||||
match chatgpt_api.path_style {
|
||||
PathStyle::CodexApi => unreachable!("chatgpt host should use backend-api paths"),
|
||||
PathStyle::ChatGptApi => format!(
|
||||
"{}/accounts/check/{ACCOUNTS_CHECK_V4_VERSION}",
|
||||
chatgpt_api.base_url
|
||||
),
|
||||
},
|
||||
"https://chatgpt.com/backend-api/accounts/check/v4-2023-04-27"
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user