Skip to content

feat: Usage-limit alerts: make them dynamic and descriptive (time, date, profile, remaining) instead of the generic hardcoded #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrei-hasna wants to merge 1 commit into
base: main
Choose a base branch
from
+198 −53
Open

feat: Usage-limit alerts: make them dynamic and descriptive (time, date, profile, remaining) instead of the generic hardcoded #396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 77 additions & 39 deletions codex-rs/tui/src/chatwidget/rate_limits.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,19 @@ pub(super) struct RateLimitWarningState {
pub(super) primary_index: usize,
}

pub(super) struct RateLimitWarningContext<'a> {
pub(super) observed_at: &'a chrono::DateTime<Local>,
pub(super) profile: Option<&'a str>,
}

impl RateLimitWarningState {
pub(super) fn take_warnings(
&mut self,
secondary_used_percent: Option<f64>,
secondary_window_minutes: Option<i64>,
primary_used_percent: Option<f64>,
primary_window_minutes: Option<i64>,
context: &RateLimitWarningContext<'_>,
) -> Vec<String> {
let reached_secondary_cap =
matches!(secondary_used_percent, Some(percent) if percent == 100.0);
Expand All @@ -45,37 +51,39 @@ impl RateLimitWarningState {
let mut warnings = Vec::new();

if let Some(secondary_used_percent) = secondary_used_percent {
let mut highest_secondary: Option<f64> = None;
let mut crossed_threshold = false;
while self.secondary_index < RATE_LIMIT_WARNING_THRESHOLDS.len()
&& secondary_used_percent >= RATE_LIMIT_WARNING_THRESHOLDS[self.secondary_index]
{
highest_secondary = Some(RATE_LIMIT_WARNING_THRESHOLDS[self.secondary_index]);
crossed_threshold = true;
self.secondary_index += 1;
}
if let Some(threshold) = highest_secondary {
if crossed_threshold {
let limit_label =
limit_label_for_window(secondary_window_minutes, /*is_secondary*/ true);
let remaining_percent = 100.0 - threshold;
warnings.push(format!(
"Heads up, you have less than {remaining_percent:.0}% of your {limit_label} limit left. Run /status for a breakdown."
warnings.push(rate_limit_warning_message(
secondary_used_percent,
&limit_label,
context,
));
}
}

if let Some(primary_used_percent) = primary_used_percent {
let mut highest_primary: Option<f64> = None;
let mut crossed_threshold = false;
while self.primary_index < RATE_LIMIT_WARNING_THRESHOLDS.len()
&& primary_used_percent >= RATE_LIMIT_WARNING_THRESHOLDS[self.primary_index]
{
highest_primary = Some(RATE_LIMIT_WARNING_THRESHOLDS[self.primary_index]);
crossed_threshold = true;
self.primary_index += 1;
}
if let Some(threshold) = highest_primary {
if crossed_threshold {
let limit_label =
limit_label_for_window(primary_window_minutes, /*is_secondary*/ false);
let remaining_percent = 100.0 - threshold;
warnings.push(format!(
"Heads up, you have less than {remaining_percent:.0}% of your {limit_label} limit left. Run /status for a breakdown."
warnings.push(rate_limit_warning_message(
primary_used_percent,
&limit_label,
context,
));
}
}
Expand All @@ -84,6 +92,19 @@ impl RateLimitWarningState {
}
}

fn rate_limit_warning_message(
used_percent: f64,
limit_label: &str,
context: &RateLimitWarningContext<'_>,
) -> String {
let observed_at = context.observed_at.format("%-I:%M %p %b %-d");
let profile = context.profile.unwrap_or("default");
let remaining_percent = (100.0 - used_percent).clamp(0.0, 100.0);
format!(
"As of {observed_at}, profile {profile} has {remaining_percent:.0}% of its {limit_label} limit remaining."
)
}

pub(crate) fn limit_label_for_window(window_minutes: Option<i64>, is_secondary: bool) -> String {
broker_limit_label_for_window(window_minutes, is_secondary)
}
Expand Down Expand Up @@ -129,14 +150,18 @@ pub(super) fn is_app_server_cyber_policy_error(info: &AppServerCodexErrorInfo) -
}

#[derive(Clone, Copy)]
enum RateLimitSnapshotSource {
pub(super) enum RateLimitSnapshotSource {
AccountUsage,
RollingUpdate,
}

impl ChatWidget {
pub(crate) fn on_rate_limit_snapshot(&mut self, snapshot: Option<RateLimitSnapshot>) {
self.on_rate_limit_snapshot_from(snapshot, RateLimitSnapshotSource::AccountUsage);
self.on_rate_limit_snapshot_from(
snapshot,
RateLimitSnapshotSource::AccountUsage,
Local::now(),
);
}

pub(crate) fn on_auth_profile_rate_limit_snapshots(
Expand Down Expand Up @@ -172,18 +197,23 @@ impl ChatWidget {

pub(crate) fn on_rolling_rate_limit_snapshot(&mut self, snapshot: RateLimitSnapshot) {
// Rolling app-server notifications are sparse. Preserve metadata learned from the full read.
self.on_rate_limit_snapshot_from(Some(snapshot), RateLimitSnapshotSource::RollingUpdate);
self.on_rate_limit_snapshot_from(
Some(snapshot),
RateLimitSnapshotSource::RollingUpdate,
Local::now(),
);
}

pub(crate) fn begin_authoritative_selected_rate_limit_refresh(&mut self) {
self.auth_profile_auto_switch_snapshots_by_limit_id.clear();
self.codex_rate_limit_reached_type = None;
}

fn on_rate_limit_snapshot_from(
pub(super) fn on_rate_limit_snapshot_from(
&mut self,
snapshot: Option<RateLimitSnapshot>,
source: RateLimitSnapshotSource,
observed_at: chrono::DateTime<Local>,
) {
if let Some(mut snapshot) = snapshot {
let limit_id = snapshot
Expand Down Expand Up @@ -223,28 +253,36 @@ impl ChatWidget {
{
self.codex_rate_limit_reached_type = Some(rate_limit_reached_type);
}
let warnings = if is_codex_limit {
self.rate_limit_warnings.take_warnings(
snapshot
.secondary
.as_ref()
.map(|window| f64::from(window.used_percent)),
snapshot
.secondary
.as_ref()
.and_then(|window| window.window_duration_mins),
snapshot
.primary
.as_ref()
.map(|window| f64::from(window.used_percent)),
snapshot
.primary
.as_ref()
.and_then(|window| window.window_duration_mins),
)
} else {
vec![]
};
// Rolling notifications do not identify their profile, so only an authoritative
// account-usage read can emit or consume profile-attributed warning thresholds.
let warnings =
if is_codex_limit && matches!(source, RateLimitSnapshotSource::AccountUsage) {
let selected_auth_profile = self.config.selected_auth_profile.clone();
self.rate_limit_warnings.take_warnings(
snapshot
.secondary
.as_ref()
.map(|window| f64::from(window.used_percent)),
snapshot
.secondary
.as_ref()
.and_then(|window| window.window_duration_mins),
snapshot
.primary
.as_ref()
.map(|window| f64::from(window.used_percent)),
snapshot
.primary
.as_ref()
.and_then(|window| window.window_duration_mins),
&RateLimitWarningContext {
observed_at: &observed_at,
profile: selected_auth_profile.as_deref(),
},
)
} else {
vec![]
};

let high_usage = is_codex_limit
&& (snapshot
Expand Down Expand Up @@ -282,7 +320,7 @@ impl ChatWidget {
}

let mut display =
rate_limit_snapshot_display_for_limit(&snapshot, limit_label, Local::now());
rate_limit_snapshot_display_for_limit(&snapshot, limit_label, observed_at);
if display.individual_limit.is_none() {
display.individual_limit = preserved_individual_limit;
}
Expand Down
Loading
Loading