mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-19 15:18:03 +00:00
* feat(tui): rename /billing slash command to /topup
Behavior-preserving rename of the /billing command surface to /topup.
Changes: billing.ts → topup.ts (export topupCommands, name 'topup', new
help string), registry.ts import+spread updated, billingOverlay.tsx
overview header 'Usage credits' → 'Top up credits', billingCommand.test.ts
→ topupCommand.test.ts with import/lookup/call updated. RPC method names
(billing.state, billing.charge, etc.) and component/symbol names unchanged.
* refactor(tui): extract overlay primitives to shared module
Lift MenuRow, ActionRow, footer, and barCells() out of billingOverlay.tsx
into overlayPrimitives.tsx so the upcoming subscriptionOverlay.tsx can
import them instead of duplicating. spendBar now calls barCells() —
output is byte-identical. Pure behavior-preserving refactor.
* feat(tui): add /subscription + /topup CTAs to /usage output
Every /usage render now ends with 'Run /subscription to change plan
· /topup to add credits' — both the healthy (with-calls) and depleted
(no-calls) paths. Strings-only change, no WS1 dependency.
* feat(tui): add subscription wire types
Add SubscriptionTierOption, SubscriptionStateResponse, and
SubscriptionManageLinkResponse to gatewayTypes.ts. Type-only — no
usages yet. Mirrors the BillingStateResponse conventions (snake_case,
Decimals as strings) and reuses BillingErrorPayload for error mapping.
* feat(gateway): add subscription.state + subscription.manage_link RPCs
- agent/subscription_view.py: SubscriptionState dataclass + fail-open
build_subscription_state() (mirrors billing_view pattern) +
get_subscription_manage_link() for the Stripe deep-link.
- hermes_cli/nous_billing.py: get_subscription_state() +
post_subscription_manage_link() HTTP helpers for the two NAS endpoints
(WS1 Phase A/C). The manage-link endpoint raises BillingScopeRequired
when Remote-Spending is missing (Phase 4 step-up trigger).
- tui_gateway/server.py: _serialize_subscription_state() +
subscription.state RPC (fail-open) + subscription.manage_link RPC
(returns {ok,kind,url} or typed error envelope via
_serialize_billing_error). NOT added to _LONG_HANDLERS — synchronous
HTTP round-trip, not a device flow.
* feat(tui): add subscription overlay state types + store slot
Add SubscriptionScreen, SubscriptionOverlayCtx, SubscriptionOverlayState
to interfaces.ts and a 'subscription' slot to OverlayState. Wire it into
overlayStore.ts (buildOverlayState + $isBlocked). NOT added to
resetFlowOverlays preserve list — flow-scoped like billing, drops on
turn end.
* feat(tui): build SubscriptionOverlay — overview + confirm + handoff
Pure-render Ink component mirroring billingOverlay.tsx's structure.
Overview screen covers all 5 states (free-upgradeable, mid-tier,
top-tier, not-admin, downgrade-pending) + dunning. Confirm screen is
y/n deep-link to Stripe (NO in-terminal charge). Handoff is the
transient 'Opening Stripe' screen. Imports shared primitives from
overlayPrimitives.tsx. 8 render tests via renderSync covering every
state.
* feat(tui): add /subscription command + overlay wiring
- subscription.ts: SubscriptionOverlayCtx closure (openManageLink,
refreshState, requestRemoteSpending) + run handler that fetches
subscription.state and opens the overlay. Alias /upgrade.
- registry.ts: spread subscriptionCommands into SLASH_COMMANDS.
- appOverlays.tsx: render SubscriptionOverlay when overlay.subscription set.
- useInputHandlers.ts: Esc closes subscription overlay; promptOverlay OR
includes subscription so input is intercepted while open.
- subscriptionCommand.test.ts: 4 tests (fetch+open, logged-out sys line,
/upgrade alias, /subscription resolves).
* fix(tui/subscription): stop saying Stripe in deep-link copy + fix manage link kind type
Replace all user-facing 'Stripe' mentions in the /subscription overlay and
sys messages with 'your subscription page' — the deep-link target is NAS's
own /manage-subscription page, not the Stripe hosted portal. Stripe only
legitimately appears later at actual Checkout. Also add 'manage' to the
SubscriptionManageLinkResponse.kind union (NAS emits kind:'manage'; was
previously missing from the TypeScript type causing silent narrowing errors).
* feat(tui/subscription): render cancellation-scheduled note with headline precedence
Parse cancelAtPeriodEnd + cancellationEffectiveAt from the NAS contract
(camelCase) in the agent parser (_parse_current), emit cancel_at_period_end
+ cancellation_effective_at from the gateway serializer, extend the
SubscriptionStateResponse type, and render a warn note in OverviewScreen:
'Cancels on {date} — your plan stays active until then.'
Headline precedence when multiple flags co-occur:
past-due > cancel-scheduled > downgrade-pending > active
The downgradeNote guard is tightened to suppress when cancel is scheduled,
so at most one status line renders at a time.
* feat(tui/subscription): team-context screen — redirect to /topup for team orgs
Parse the NAS context:'personal'|'team' field (defaults to 'personal' for
unknown/missing values), emit it on the gateway wire, add it to
SubscriptionStateResponse. When context is 'team', SubscriptionOverlay
renders a dedicated read-only screen instead of the tier picker:
'This terminal is connected to {org_name}. Teams run on shared
credits — use /topup to add funds. Personal subscriptions live
on your personal account.'
The screen closes on Enter or Esc. The personal/tier-picker path is
unchanged.
* fix(subscription): drop manage-link gateway RPC, build URL locally
The NAS POST /api/billing/subscription/manage-link endpoint was dropped
(it added no server work — the target is the static /manage-subscription
page, not a Stripe-minted secret). Build the URL client-side instead:
{portal_base}/manage-subscription?org_id=<org.id>.
- Remove subscription.manage_link gateway RPC (server.py)
- Remove get_subscription_manage_link helper (subscription_view.py)
- Remove post_subscription_manage_link (nous_billing.py)
- Remove SubscriptionManageLinkResponse type (gatewayTypes.ts)
- Add org_id to SubscriptionState + wire through serializer + TS type
- openManageLink() builds the URL locally via buildManageUrl(), opens
it with the existing openExternalUrl(), no gateway round-trip
- Drop targetTierId param from openManageLink (v1 sends everyone to
/manage-subscription; no tier deep-link needed)
- Fix stale test expectations (Stripe copy → subscription page copy)
* chore(subscription): drop unused format_money import
* feat(cli): /subscription + /upgrade, /billing→/topup rename, /usage CTAs
Add the classic-CLI half of the terminal billing surface to match the TUI:
- /subscription (alias /upgrade) command + /topup (renamed /billing, keeps
'billing' as a back-compat alias) in the command registry.
- Drop the stale 'billing' entry from _SLACK_VIA_HERMES_ONLY (now cli_only).
* feat(subscription): CLI /subscription handler, drop dunning, current:null no-plan
- CLI _show_subscription mirrors the TUI overlay (plan read + tier list + usage
bar + browser deep-link via subscription_manage_url); credits render as counts.
- Adapt to the updated NAS read contract: remove is_past_due/dunning everywhere
(a card-failing subscriber returns as a normal plan now), and treat no-plan as
current:null (parser returns None) rather than an all-null object.
- HERMES_DEV_SUBSCRIPTION_FIXTURE env-driven fixtures + ui-tui fixture harness
drive every state (CLI + live TUI) with no portal.
Verified against handoff 2026-06-24_subscription-tui-handoff.md.
* feat(billing): CF-4 Remote-Spending revoked-terminal UX (NAS PR #481)
Wire the Remote-Spending gate denial contract end to end:
- nous_billing: BillingRemoteSpendingRevoked (403 remote_spending_revoked →
reconnect) + BillingSessionRevoked (401 session_revoked → re-login), distinct
from insufficient_scope; capture actor/code/recovery; 503 stays transient.
- gateway _serialize_billing_error threads the new typed kinds + actor/code/
recovery to the TUI.
- TUI renderBillingError: actor-aware revoke copy, kills the spend overlay
immediately (no 15-min zombie button), handles session_revoked, the dual-
emitted cli_billing_disabled/remote_spending_disabled, role_required,
idempotency_conflict; poll treats a mid-poll revoke as ambiguous (check
balance before retry), not a failure.
- CLI _billing_render_charge_error: same denial matrix, actor-aware copy.
Tests: gate-contract mapping + envelope (py) and revoke/session/disabled (TUI).
Per handoff 2026-06-24_remote-spending-TUI-contract-handoff.md.
* refactor(subscription): remove dead step-up scaffolding from /subscription
/subscription only opens a browser deep-link to manage-subscription — that needs
no billing scope, so it can never hit insufficient_scope. Drop the never-fired
'stepup' screen type, requestRemoteSpending ctx fn, and resumeScreen bookkeeping
(leftovers from a superseded plan). The resumable step-up lives on /topup, where
the charge actually gets gated.
* feat(tui/topup): resumable 'Allow Remote Spending' step-up on the charge path
Phase 4: when a charge returns insufficient_scope, the /topup modal no longer
tears down with a 'run /billing again' ConfirmReq. Instead it stays MOUNTED and
switches to a step-up screen:
- charge() is now awaitable, returning a discriminated outcome (submitted |
needs_remote_spending | error) so the overlay can route without closing.
- StepUpScreen: 'Allow Remote Spending' → await the device-flow grant (browser
opens via the existing out-of-band billing.step_up.verification event) →
replay the held charge (pendingCharge.amount) and settle, with no command
re-run. Never surfaces the raw billing:manage scope.
- armStepUp's fire-and-forget ConfirmReq replaced by requestRemoteSpending();
the leaky 'billing:manage' / 'Re-authorize' / 'run /billing again' copy is gone.
Tests: charge-outcome routing, step-up grant/deny, and a render test asserting
the step-up copy holds the amount and never leaks billing:manage.
Per handoff 2026-06-24_remote-spending-TUI-contract-handoff.md §2 (Grady #6).
* feat(billing): shared dollar usage model + two-bar view (drop "credits")
Single source of truth for the /usage and /subscription usage bars across
TUI + CLI. Reads the NAS account-info dollar fields (subscription/top-up/total
remaining, monthly allowance, renewal) and produces a surface-agnostic model:
two full-resolution bars (plan allowance + purchased top-up), a status
classification (free | healthy | low | depleted), and a human renewal date.
- agent/billing_usage.py: UsageModel/UsageBar, usage_model_from_account
(fail-open), build_usage_model (HERMES_DEV_CREDITS_FIXTURE-aware),
format_renews (ISO -> "Jul 24, 2026", Windows-safe), $5 low-balance threshold.
- tui_gateway/server.py: _serialize_usage_model/_serialize_usage_bar, a
usage.bars RPC, and the model embedded into subscription.state so the overlay
renders the same bars from its single fetch.
- Dollars only, never "credits"; two separate bars (not a crammed
three-segment one) for legibility at terminal widths.
- tests/agent/test_billing_usage.py: status classification, bar math
(clamp/over-cap), NaN/Inf rejection, fail-open invariants.
* feat(tui): dollar usage bars on /usage + /subscription, drop tier picker
Render the shared two-bar dollar model in both overlays; strip "credits" and
the in-terminal tier selection per UX feedback.
- overlayPrimitives.tsx: UsageBars (themed plan/top-up bars — gold allowance,
green top-up) + usageBarsText for the /usage panel. Plan name labels the
bar; "$X left of $Y · N% used" (disambiguated so the % matches); top-up
"never expires".
- subscriptionOverlay.tsx: status line dedupes ($X left once; bar carries the
breakdown), human renewal date, state-matched nudges (free upsell / <$5
low alert) with box-safe ASCII markers (! / >) instead of the width-unstable
emoji that broke the border. Tier picker removed — overview shows usage +
plan, then "Manage on portal" / "Close" (free users get "Start a
subscription"). No "credits" anywhere.
- session.ts: /usage renders the dollar bars + balance summary, falling back
to the legacy credits lines only when the model is unavailable; CTA reworded.
- gatewayTypes.ts: UsageModelData/UsageBarData wire types + usage on
SessionUsageResponse/SubscriptionStateResponse.
- Tests updated to the new contract (no "credits", "left of", dedup, markers).
* feat(cli): mirror dollar usage bars on /usage + /subscription
CLI parity with the TUI billing rework, from the same shared usage model.
- _print_nous_credits_block (/usage) and _subscription_overview render the
two-bar dollar view (plan name on the bar, "$X left of $Y · N% used",
top-up "never expires", total spendable) instead of the credits-worded block.
- Dollars only — dropped the tier catalog (no more "$N/mo (… credits)") and
every user-facing "credits"; team copy says "shared balance".
- Human renewal date via the shared format_renews; status line dedupes the
"$X left"; free upsell + <$5 low alert with ASCII markers.
- /subscription manage modal no longer dumps the raw manage-subscription URL
in its detail — the [1] Open / [2] Copy link / [3] Cancel options carry it.
Title is "Manage your subscription" (no in-terminal plan change). The raw URL
stays only in the non-interactive / not-admin fallbacks, which have no menu.
- /usage token-usage panel (model, tokens, cost, context) left untouched.
* feat(billing): embed dollar usage model into billing.state for /topup
The /topup overview renders the same two-bar dollar usage (plan + top-up) as
/usage and /subscription. Embed the shared usage model into the billing.state
RPC payload (mirrors subscription.state) so the overlay gets the bars from its
single fetch, and add the `usage` field to BillingStateResponse.
* feat(tui/topup): reorder overview + in-flight reauth with press-Enter resume
Reworks the /topup overlay per the Jun 19 review and the no-preflight decision.
Overview:
- Balance leads in the title ("Top up · balance $X"); the shared two-bar dollar
usage (plan + top-up) renders below. Dropped the old monthly-cap spend bar.
- "Add funds" is the first action (was "Buy credits"); auto-reload / monthly
limit / manage-on-portal follow. Dollars only — no "credits" anywhere.
- No "Enable terminal billing" menu item and NO scope preflight: whether the
terminal can charge is discovered reactively at pay time. (We deliberately do
not read/refresh the OAuth token to gate UI.)
Step-up (reached only on a charge's insufficient_scope 403):
- New 4-phase flow that keeps the modal mounted: prompt (one-time-setup
heads-up) → waiting (browser authorize) → granted (explicit "Press Enter to
resume") → replay the held charge → settle. The press-Enter beat is the
reassuring "you're back, finish your purchase" moment.
- Renamed user copy "Allow Remote Spending" → "Enable terminal billing"; never
leaks the raw billing:manage scope (guarded by the render test).
- topup.ts error copy de-crufted to terminal-billing wording, emoji removed.
Tests: step-up prompt copy, the no-raw-scope invariant, and new overview tests
(balance-in-title, Add-funds-first, two-bar usage, no "credits").
* feat(cli/topup): mirror overview reorder + in-flight reauth resume
CLI parity with the TUI /topup rehaul, from the same shared usage model.
- _billing_overview: balance in the title, the two-bar dollar usage (plan name
on the plan bar, top-up "never expires") in place of the old cap spend bar,
"Add funds" first, dollars throughout — no "credits", no scope preflight.
- _billing_handle_scope_required: now takes the held amount + idempotency key
and runs the in-flight flow — "Enable terminal billing" → browser device-flow
→ re-check the org kill-switch → press-Enter to resume → replay the held
charge (reusing the key so a double-submit collapses to one). Stops leaking
the raw billing:manage scope.
- Charge-error + buy/auto-reload copy de-crufted to terminal-billing/dollars.
- Tests updated to the new overview + buy copy.
* fix(billing): guard non-JSON 2xx responses in the billing HTTP client
A 2xx response with a non-JSON body — e.g. a reverse-proxy / SPA fallback HTML
page served when a billing route isn't actually mounted on a deployment — hit
json.loads() on the success path of _request() and raised a raw
json.JSONDecodeError. That escaped the typed-BillingError contract, so callers'
`except BillingError` missed it and fell through to a generic fail-open that
rendered as a misleading "not logged in" (observed when /api/billing/subscription
was briefly unshipped on staging: 200 text/html, x-matched-path /[...notFound]).
Now a non-JSON 2xx body raises a typed BillingError(error="endpoint_unavailable")
so surfaces degrade gracefully ("could not load …") instead of crashing or
mislabeling a valid session as logged-out. The 4xx/5xx path already guarded its
.json(); this closes the same hole on the success path.
Test: tests/hermes_cli/test_nous_billing_request.py — non-JSON 2xx → typed
error (not JSONDecodeError, not BillingAuthError), empty body → {}, valid JSON
parses.
* feat(billing/dev): add HERMES_DEV_BILLING_FIXTURE for offline card/scope testing
build_billing_state short-circuits to a fixture when HERMES_DEV_BILLING_FIXTURE
is set (mirrors HERMES_DEV_CREDITS_FIXTURE for the usage model). States:
nocard | card | card-autoreload | notadmin | billing-off | logged-out — so the
card-on-file gate, admin role, and kill-switch paths are exercisable offline
without a live portal. Env-var gated; returns None when unset (no prod leak).
Adds 8 behavior tests asserting the card/admin/billing-on contract per state.
* refactor(billing): fold /credits into /topup
/credits is redundant now that /topup shows the dollar balance + portal handoff.
Make 'credits' (and 'billing') aliases of /topup so typing /credits still works,
resolving to topup everywhere (CLI, gateway, Slack, TUI, autocomplete, help).
Remove the standalone /credits surface across 6 places:
- CLI _show_credits handler + dispatch
- gateway _handle_credits_command -> renamed _handle_topup_command, copy softened
to 'Manage billing on the portal' (the messaging billing surface; /topup is now
gateway-available so messaging keeps billing — credits was the only one before)
- TUI commands/credits.ts + creditsCommand.test.ts (deleted), registry entry
- tui_gateway credits.view RPC + the CreditsViewResponse type
- Slack _SLACK_VIA_HERMES_ONLY: credits -> topup
Sweep user-facing /credits -> /topup (usage-block hint, depletion notice) and
stale doc-comments. OpenRouter's /credits endpoint URL left untouched. Tests
updated (test_credits_folds_into_topup) or pruned for the removed symbols.
* fix(billing): card-on-file heads-up, no-card portal gate, /usage bar ordering, modal glyph
In-terminal charge (POST /charge against the org's server-held card, no card ref
leaves the client):
- card present: confirm screen shows 'Your card saved on the portal will be
charged' + a 'Manage on portal' escape option (CLI); heads-up line (TUI)
- no card on file: /topup overview + buy flow detect it and route to the portal
to add a card, instead of offering a charge that 403s no_payment_method
/usage bar ordering: route the dollar block through _cprint consistently. The
Plan: line (_cprint) and the bar (raw print) flushed to different buffers under
patch_stdout and interleaved nondeterministically; now Plan: -> bar -> status/CTA
is stable across all states.
Modal glyph: strip the leading emoji from bordered _prompt_text_input_modal
titles — it measures 1 char but renders 2 columns, shifting the box's right
border (the stray '|'). Includes the f-string 'Pay $X?' title.
Small /credits -> /topup string bits in cli.py ride along with the surrounding
charge edits (the fold lives in the sibling refactor commit).
* refactor(billing): apply safe simplify-pass fixes
Three low-risk cleanups from a parallel simplify review (reuse/quality/efficiency):
- dev fixture portal URL: reuse the prod host (was drifted to staging-* — a real
mismatch vs subscription_view's _DEV_FIXTURE_PORTAL)
- TUI billingOverlay choose(): collapse two byte-identical branches (needsCard +
the not-full else both = portal-or-close at index 0) into one tail; the only
divergent path (full && !needsCard → buy/auto/limit) stays explicit
- /topup overview comment: correct the stale 'buy_flow detects no_payment_method'
note (the overview's no-card gate fires first, so reaching Add funds implies a
card on file)
Skipped (judgment): the orphaned CreditsView.depleted field (harmless, on a live
dataclass), the defensive card gates in _billing_buy_flow/_confirm_and_charge
(cheap correct defense on the money path), and folding the no-card handoff into a
shared helper (touches 4 money-path sites for tidiness — not worth the risk here).
* fix(billing): reactive charge gating — drop card preflight, react to 403 (scope→reauth, no-card→portal)
* refactor(billing): drop the /credits alias entirely
The /credits fold made it an alias of /topup; now remove that too. Typing
/credits is an unknown command, not a silent redirect — billing lives only on
/topup (with /billing kept as the old command's back-compat name). Dropped the
alias from the registry CommandDef and the TUI topup.ts; updated the test to
assert /credits resolves to nothing (no command, no alias).
* docs(billing): fix stale comment in _billing_overview — describe reactive no-card path
The comment still described the removed overview-level card gate ('no-card case
handled above'). Corrected to: the buy flow reacts to the server's
no_payment_method 403 and hands off to the portal at charge time (no preflight).
* refactor(billing): simplify-pass — share usage-payload helper, drop dead bar wire fields + redundant admin gate
* refactor(billing): drop the /billing alias too — /topup is the only billing command
Following /credits removal, retire the old /billing name as well. /topup now has
NO aliases — both /credits and /billing are unknown commands. Dropped the alias
from the registry CommandDef and TUI topup.ts; fixed the one live user-facing
straggler (the not-logged-in message said 'then /billing' → /topup) and the
_show_billing docstring/default-arg references. Test asserts /topup carries no
aliases and neither old name resolves.
* fix(billing): code-review fixes — money-path + parity bugs
Money path (TUI):
- auto-reload "Turn off" now echoes current threshold/top_up_amount so the
PATCH succeeds (was sending {enabled:false} → invalid_request → stayed ON)
- charge poll honors the 5-min cap on the 429/503 throttle branch too (was
rescheduling forever); cap folded into one timedOut() helper
- step-up resume reacts to the replay outcome instead of unconditionally
closing on a reassuring line with no charge made
- synchronous submit guard on Confirm so two key events can't double-charge
Gateway:
- billing.step_up routes typed errors through _serialize_billing_error (was a
raw {error:'error'} dict → generic copy for session_revoked)
- billing.state / subscription.state / usage.bars / session.usage moved to
_LONG_HANDLERS (blocking portal HTTP no longer stalls the main stdin loop)
CLI:
- _billing_render_charge_error handles insufficient_scope without leaking the
raw billing:manage scope name on a post-grant replay re-raise
Python model:
- subscription_view tier parse None-coalesces tierOrder/dollarsPerMonth so a
free tier's 0 survives ($0, not "—"; correct sort order)
TUI parity/robustness:
- /usage shows formatted renews_display, not raw ISO renews_at
- subscription overview guards a null pending_downgrade_at (was "on null.")
- subscription overview surfaces a message instead of silently closing when
portal_url is missing
- buildManageUrl wraps new URL() so a malformed portal_url can't throw out of
the Ink key handler
* fix(billing): cross-surface bar direction, formatted cancel/downgrade dates, Slack alias gating
- CLI plan bar now fills by REMAINING (fuel-gauge), matching the shared model's
fill_fraction, the top-up bar, and the TUI — same account renders identically
on both surfaces (#8)
- subscription serializer emits cancellation_effective_display /
pending_downgrade_display (format_renews); TUI shows 'Jul 1, 2026' not raw ISO (#14b)
- _SLACK_VIA_HERMES_ONLY now includes the 'billing' alias so it follows its
canonical /topup via /hermes instead of leaking a native Slack slot (#9)
* fix(billing): thread idempotency key through the TUI step-up replay (#2)
Mint a stable idempotency key when the purchase amount is chosen; it rides
pendingCharge into both the Confirm charge and the post-grant step-up replay,
so a retried charge dedups server-side (the gateway already echoes the key).
A fresh amount selection gets a fresh key. Combined with the sync submit guard,
a double-submit now collapses to one charge.
* refactor(billing): remove dead /subscription tier-picker scaffolding (#18)
The in-terminal plan picker was cut (deep-link only), leaving a whole unreached
state machine. Removed end-to-end:
- TUI: ConfirmScreen, HandoffScreen, the 'confirm'/'handoff' screen types,
pendingTargetTierId, and the now-dead onPatch threading (collapsed the dispatch
to a single overview screen + folded the duplicate Box wrapper)
- gateway: the tiers serialization + SubscriptionTierOption wire type
- model: SubscriptionTier, _parse_tier, _coalesce, _dev_tiers and the tiers field
(never displayed on either surface, so this supersedes the tier-parse fix)
- tests: dropped the confirm/handoff/tier-passthrough tests; slimmed the overview
render tests
Net: a large dead-code cull (no behavior change — the picker never ran).
* test(billing): parametrize usage-model tests; drop dead is_low/is_free props
Collapse the fail-open + status-classification cases into parametrized tables
(same coverage, ~80 fewer lines) and remove the now-unused UsageModel.is_low /
is_free properties (only a test pinned them).
* fix(billing): revert dead 'billing' Slack-via-hermes entry — the alias was dropped
#9 was based on a stale review diff: /billing is no longer an alias of /topup
(dropped earlier), so routing it via /hermes filtered a name that doesn't exist.
* test(billing): cull redundant TUI billing tests (parametrize, merge dupes)
usageCommand: collapse 3 CTA tests into one + a panel helper.
billingStepUp: merge the two step-up render asserts.
topupCommand: parametrize requestRemoteSpending + the revoked-actor pair, drop
the redundant happy-path-submitted test. Money-path + error-mapping coverage
preserved.
* refactor(billing): extract _usage_bar_lines — one source of truth for the CLI bars
The plan + top-up bar format was copy-pasted across _print_nous_credits_block,
_subscription_overview, and _billing_overview. Extract a helper returning the
ready-to-print lines; each caller keeps its own print fn (the _cprint-ordering
constraint stays) and resolves its plan-name label. Centralizes the format so
the three surfaces can't drift.
* feat(billing): NAS V3 subscription-change HTTP client wrappers
Add the four write-side wrappers for the V3 subscription contract to nous_billing,
each a thin _request() call (reusing auth, JSON, 401-retry, typed errors):
- post_subscription_preview → POST /subscription/preview (chargeless quote)
- put_subscription_pending_change→ PUT /subscription/pending-change (downgrade/cancel)
- delete_subscription_pending_change → DELETE .../pending-change (resume/undo)
- post_subscription_upgrade → POST /subscription/upgrade (the money route)
pending-change takes a discriminated body (tier_change | cancellation); upgrade
requires an Idempotency-Key (mandatory, validated client-side before any I/O).
Tests assert the exact method/path/body/header each wrapper puts on the wire.
* feat(billing): subscription tier catalog + change-preview models
Reinstate the catalog the in-terminal picker needs (was culled when /subscription
was deep-link-only): SubscriptionTier + SubscriptionState.tiers + _parse_tier, with
_coalesce so the free tier's 0 tierOrder/price survives a falsy-or. Parse the
catalog from GET /subscription's tiers and seed _dev_tiers into every fixture.
Add SubscriptionChangePreview + subscription_change_preview_from_payload for the
POST /preview quote (effect/amountDueNowCents/effectiveAt/reason + tier delta); a
malformed/missing effect fails safe to 'blocked' so a bad quote never reads as a
charge. Module docstring updated: the overlay is no longer deep-link-only.
* feat(billing): gateway RPCs for the V3 subscription change flow
Add subscription.preview / .change / .resume / .upgrade RPCs, each wrapping its
nous_billing call and reusing _serialize_billing_error for the typed envelope
(so a 403 still drives the device step-up). upgrade mints + echoes the
idempotency key and surfaces status + recovery_url so the TUI can route an
SCA/decline to the portal. Re-add the tier catalog to _serialize_subscription_state
(price pre-formatted) for the picker. All four are pool-routed (_LONG_HANDLERS) —
preview + upgrade hit Stripe and must not stall the main stdin loop.
* feat(billing): in-terminal subscription change flow (TUI)
/subscription is no longer deep-link-only: it drives the change in-terminal
against the V3 contract via the new gateway RPCs. The overlay is a state machine
overview → picker → confirm → result:
- picker lists the tier catalog with upgrade/downgrade hints (current + free
excluded; free=cancel, on the overview);
- confirm shows the previewed effect — pay $X now (upgrade) / scheduled at date
(downgrade) / cancel at period end / blocked-with-reason — then applies it;
- an upgrade's SCA/decline routes to the portal via the result screen's recovery
link; resume/cancel/downgrade are chargeless.
Starting a NEW subscription still deep-links (needs a fresh card). insufficient_scope
points to /topup (the step-up stays there, not duplicated here). Adds the wire
types (tiers + preview/upgrade responses), widens the overlay ctx + screen state,
and threads onPatch. Render tests cover every screen.
* feat(billing): in-terminal step-up + clearer scheduled-change UX (TUI)
Two improvements to the /subscription overlay:
Step-up re-auth in place. When a mutation (preview/change/upgrade/resume) returns
insufficient_scope, route to a new 'stepup' screen that grants terminal billing
via billing.step_up and AUTO-REPLAYS the held action on grant — no bounce to
/topup. Scope routing is centralized in previewAndRoute/applyPendingAndRoute/
resumeAndRoute (shared by the picker, confirm, overview + the step-up replay). The
browser opens via the shared global verification handler; copy never leaks the raw
billing:manage scope.
Make a scheduled change unmissable. A downgrade/cancel was one buried warn line
that read as 'nothing happened'. Now the overview leads with a banner
(⏳ Scheduled change · Ultra ──▶ Plus · <date> · you keep Ultra until then), the
status line echoes the transition (Plan: Ultra → Plus), 'Keep <tier> (undo)' is
promoted to the first olive action, the result screen says 'your plan doesn't
change today', and confirm gets a charged-now / scheduled chip.
* feat(billing): full in-terminal subscription change flow in the classic CLI
Bring the CLI to parity with the TUI overlay — /subscription is no longer
deep-link-only. A paid admin/owner gets picker → preview → confirm → apply,
mirroring the /topup buy flow's modal idioms:
- _subscription_change_menu (change / undo-or-cancel / manage-on-portal),
- _subscription_pick_tier (catalog with upgrade/downgrade hints),
- _subscription_preview_and_confirm (POST /preview → effect-aware confirm),
- _subscription_apply (schedule / cancel / resume chargeless; upgrade charges
the sub's card, SCA/decline → portal),
- _subscription_handle_scope_required (insufficient_scope → step_up_nous_billing_scope
inline, then replays the held preview/mutation — reusing the upgrade idempotency key).
Also the scheduled-change UX fix: the overview leads with a prominent banner
(⏳ Scheduled change · Super ──▶ Plus · <date> · you keep Super until then) and the
status line echoes the transition, matching the TUI. Members / non-interactive /
free still deep-link. Tests drive every branch via a mocked modal + nous_billing.
* fix(billing): close TUI subscription money-path holes (ultracode review)
- Un-consented charge (P1): the step-up now HOLDS at a 'granted' phase requiring
an explicit Continue, and an abortedRef gates the grant's late .then — a cancel
during the browser flow can no longer replay the held upgrade + charge.
- Missing idempotency key (P2): mint it when building an upgrade 'pending' so it
rides into confirm AND the step-up replay (was always undefined → gateway minted
a fresh key per call, defeating dedup).
- Navigate-away re-charge (P2): confirm 'back' is guarded by submittingRef while an
apply is in flight.
- Ambiguous charge (P2): a transport-null upgrade is reported as 'may or may not
have charged — re-check', never a flat failure that invites a blind retry.
- Typed step-up denial (P2): requestRemoteSpending returns {granted,error,message};
the screen maps session_revoked / remote_spending_revoked / rate_limited to the
right recovery instead of always 'an admin must allow it'.
* fix(billing): close CLI subscription money-path holes (ultracode review)
- Bounded step-up (P2): bust the 30s token cache after a grant (it held the
pre-grant unscoped token; _request only busts on 401, not 403) and replay ONCE
with allow_stepup=False so a still-denied scope can't re-prompt/re-open in a loop.
- Stray-keystroke charge (P3→near-P2): the upgrade confirm defaults to 'Go back',
not 'Pay ' — a bare Enter can't move money.
- Fail-open on unknown effect (P3→near-P2): an unrecognized preview effect now
fails SAFE (portal hand-off) instead of scheduling a real PUT.
- 'cancel' word collision (P3): the Close row uses value 'close' so typing 'cancel'
can't hit it and falsely report 'Cancelled'.
- blocked effect re-offers the portal; undo is promoted to the first row when a
change is pending (TUI parity).
* fix(billing): guard the step-up resume against double-fire (2nd ultracode pass, BUG A)
The P1 fix split the auto-replay into a user-triggered resume() on the granted
screen, where the default row is the charging action — but resume() had no
re-entrancy guard, so a double-Enter fired two replays (the upgrade dedups on the
shared key, but schedule/cancel/resume replays carry none → duplicate PUT/DELETEs).
Mirror billingOverlay.resume(): flip to a 'resuming' phase + a resumingRef so it
fires at most once, and block 'back' once resuming (no re-mount → no second submit).
* fix(billing): CLI charge-route ambiguous-charge caveat (2nd ultracode pass, BUG B)
The TUI hardened upgradeResult(null) but the CLI charging route did not: a
transport/timeout/500 (or unknown 2xx status) on post_subscription_upgrade — after
NAS may have already prorated + charged — printed a flat failure, and a manual
re-run mints a FRESH idempotency key the server can't dedup → a real second charge.
Now the charge route reports 'your card may or may not have been charged — re-run
/subscription to check before trying again' and steers away from a blind retry
(the CLI can't persist the key across a command re-run). Also thread allow_stepup
through the preview→apply replay (BUG C.1) and route the requires_action/
payment_failed portal lines through _cprint for deterministic ordering.
* fix(billing): cap the TUI step-up replay to avoid a resume-deadlock (final pass, R1)
The round-2 resume guard ('resuming' phase + resumingRef) could deadlock: on a
REPEAT insufficient_scope during the post-grant replay, the route helpers did
onPatch({screen:'stepup'}) — a no-op since we're already mounted on stepup (no key
→ no remount) — leaving phase='resuming'/resumingRef=true frozen on 'Applying your
change…'. Thread allowStepUp through previewAndRoute/applyPendingAndRoute/
resumeAndRoute; the resume() replay passes false, so a repeat scope denial surfaces
a 'still isn't enabled' result instead (mirrors the CLI's allow_stepup=False cap).
Also: applyPendingAndRoute(pending=null) now routes to overview, not a stranded
Promise.resolve().
* fix(billing): narrow the CLI ambiguous-charge catch to indeterminate outcomes (final pass, R2)
The round-2 fix caught EVERY non-scope BillingError as 'may or may not have been
charged' — but typed pre-charge rejections (BillingRateLimited 429, BillingSessionRevoked
401, BillingRemoteSpendingRevoked 403, role_required/no_payment_method 4xx) never
reached Stripe, so the ambiguity copy was wrong and dropped their real recovery hints.
Now route those to _subscription_render_error, and reserve the ambiguous copy for
genuinely indeterminate outcomes (network_error / endpoint_unavailable / status None /
5xx). Tests: rate-limit stays deterministic; a real transport failure stays ambiguous.
* feat(billing): card visibility + guided add-card path in /topup and /subscription
Consume the NAS card-resolver contract (card.resolvedVia + chargeability) across
both surfaces, degrading cleanly on today's NAS (fields absent → prior behavior):
- WHICH card: the payment lines render provenance — 'Visa ····4242 — the card on
your subscription' (resolvedVia → label; unknown rung/older NAS → masked card +
the old generic line). Link payment methods render the brand alone (last4 is
empty — never 'Link ····').
- Presence at a glance: the /topup overview now shows 'Card: …' or 'No saved
card on file' for the full-menu case, plus a warning when the resolver marks
the card needs_repair (failing auto-reloads) on overview/buy/confirm.
- Add-card path: with no card on file, 'Add funds' becomes a guided screen —
open the portal billing page, then 'I've added it — check again' re-fetches
billing state and continues straight into the purchase (also recovers a
transient display miss). Cards are never entered in-terminal.
- /subscription upgrade confirm names the exact card ('Visa ····4242 — the card
on your subscription — will be charged'), best-effort via billing.state and
only when the resolution rung matches what a subscription charge actually
uses (subPin/customerDefault, mirroring Stripe's precedence); otherwise the
generic line stands. Fail-soft: any lookup error keeps the generic line.
- Gateway serializes display/resolved_via/needs_repair; TUI ctx gains
refreshState (topup) + fetchCard (subscription); new offline fixtures
card-sub / card-repair.
Tests: TUI ctx mocks extended; CLI suites cover provenance + repair-warning
render, the Link guard, the add-card path (continue-after-recheck + abandon),
the sub-confirm card line, and keep the confirm-time lookup offline in tests.
* fix(billing): consume server canChangePlan, preserve distinct refusal codes, drop dead chargeability
- Parse canChangePlan verbatim from NAS payloads into BillingState and
SubscriptionState; fall back to the legacy OWNER/ADMIN check only when the
server omits the field (FINANCE_ADMIN stops being locked out where NAS
authorizes it). Role model updated to the 5-role enum.
- Add the autoReload.card union (canonical | distinct | none) end-to-end:
parse + gateway serialization, distinct carries payment_method_id/brand/last4
with nullable display fields.
- stripe_unavailable (503, transient) and upgrade_cap_exceeded (429, daily cap)
now survive to the wire as their own codes instead of collapsing into
rate_limited; new exception types subclass BillingRateLimited so existing
backoff call sites keep working.
- Remove card.chargeability / needs_repair parsing, serialization, fixtures and
the cli warning blocks: NAS #670 removed the field, so the repair path was
permanently dead. The future card-health signal belongs to the NAS W1/W3 work.
- Tests: five-role fixtures, canChangePlan override/fallback, all three
auto-reload card variants, 429-vs-503 code preservation end-to-end.
* feat(tui): render the full NAS billing refusal surface
- billingOverlay: divergence notice when auto-refill charges a distinct card
(portal deep-link to reconcile); needs_repair warnings removed with the field.
- topup: explicit copy for consent_required, org_access_denied,
upgrade_cap_exceeded, auto_top_up_disabled_failures and stripe_unavailable
(honors retry_after); processing_error is an explicit charge-failure case;
transport loss during charge polling now reads as an unconfirmed outcome
(check balance before retrying), matching the revocation path.
- subscriptionOverlay: branch on upgrade reason, not status, so an SCA-needing
upgrade routes to portal verification even while NAS pre-#711 labels it
payment_failed; after an upgrade, poll subscription state until the tier
flips (bounded), rendering applying/still-applying rather than assuming
immediacy.
- Capability-neutral refusal copy (owner, admin, or finance admin) replaces
the stale org admin/owner wording.
- gatewayTypes: BillingAutoReload.card union added, needs_repair removed.
* docs(billing): client-side billing state and refusal lifecycle table
Enumerates, from the code, every billing.state shape and typed refusal the
gateway serves and the exact TUI copy + recovery each renders. Acceptance from
the billing-integration handoff: no NAS billing state or typed refusal falls
through to a generic toast; unknown codes still degrade to the default branch
that surfaces the server message.
716 lines
31 KiB
Python
716 lines
31 KiB
Python
"""Tests for evaluate_credits_notices — pure threshold reconciliation policy (L4.1).
|
|
|
|
All tests use fresh latch = {"active": set(), "seen_below_90": False, "usage_band": None} per scenario.
|
|
CreditsState is constructed directly (not parsed from headers).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
from agent.credits_tracker import (
|
|
CREDITS_NOTICE_KIND,
|
|
CREDITS_RESTORED_TTL_MS,
|
|
AgentNotice,
|
|
CreditsState,
|
|
evaluate_credits_notices,
|
|
)
|
|
|
|
|
|
# ── Helpers ──────────────────────────────────────────────────────────────────
|
|
|
|
|
|
def fresh_latch() -> dict:
|
|
return {"active": set(), "seen_below_90": False, "usage_band": None}
|
|
|
|
|
|
def state_with_fraction(
|
|
uf: float | None,
|
|
*,
|
|
paid_access: bool = True,
|
|
denominator_kind: str = "subscription_cap",
|
|
purchased_micros: int = 0,
|
|
purchased_usd: str = "0.00",
|
|
subscription_limit_usd: str | None = "20.00",
|
|
) -> CreditsState:
|
|
"""Build a minimal CreditsState that yields the desired used_fraction.
|
|
|
|
used_fraction = (limit - subscription_micros) / limit
|
|
|
|
When uf is None, we set limit to None so used_fraction returns None.
|
|
"""
|
|
if uf is None:
|
|
return CreditsState(
|
|
subscription_limit_micros=None,
|
|
subscription_limit_usd=None,
|
|
subscription_micros=0,
|
|
denominator_kind="none",
|
|
paid_access=paid_access,
|
|
purchased_micros=purchased_micros,
|
|
purchased_usd=purchased_usd,
|
|
)
|
|
# We want (limit - sub) / limit == uf → sub = limit * (1 - uf)
|
|
limit = 20_000_000 # $20 in micros
|
|
sub = int(limit * (1.0 - uf))
|
|
return CreditsState(
|
|
subscription_limit_micros=limit,
|
|
subscription_limit_usd=subscription_limit_usd,
|
|
subscription_micros=sub,
|
|
denominator_kind=denominator_kind,
|
|
paid_access=paid_access,
|
|
purchased_micros=purchased_micros,
|
|
purchased_usd=purchased_usd,
|
|
)
|
|
|
|
|
|
# ── Scenario 1: crossing 90% threshold ───────────────────────────────────────
|
|
|
|
|
|
class TestWarn90Crossing:
|
|
def test_below_lowest_band_no_notice_but_latch_set(self):
|
|
latch = fresh_latch()
|
|
s = state_with_fraction(0.10) # below the 50% band
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert "credits.usage" not in to_clear
|
|
assert latch["seen_below_90"] is True
|
|
|
|
def test_crossing_to_90_fires_once(self):
|
|
latch = fresh_latch()
|
|
# First call: uf < 0.5 — sets seen_below_90 (below lowest band)
|
|
s1 = state_with_fraction(0.10)
|
|
evaluate_credits_notices(s1, latch)
|
|
# Second call: uf >= 0.9 — should fire the usage band at 90
|
|
s2 = state_with_fraction(0.95)
|
|
to_show, to_clear = evaluate_credits_notices(s2, latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.usage" in keys
|
|
assert "credits.usage" not in to_clear
|
|
|
|
def test_no_refire_on_repeated_over_90(self):
|
|
latch = fresh_latch()
|
|
s_below = state_with_fraction(0.10)
|
|
evaluate_credits_notices(s_below, latch)
|
|
s_over = state_with_fraction(0.95)
|
|
evaluate_credits_notices(s_over, latch)
|
|
# Third call: still ≥ 0.9 — must NOT re-fire
|
|
to_show, to_clear = evaluate_credits_notices(s_over, latch)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert "credits.usage" not in to_clear
|
|
|
|
|
|
# ── Scenario 2: recovery + re-cross ──────────────────────────────────────────
|
|
|
|
|
|
class TestWarn90RecoveryReCross:
|
|
def test_recovery_clears_warn90(self):
|
|
latch = fresh_latch()
|
|
# Cross below → above
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
# Recovery: uf drops back below ALL bands → usage notice clears entirely
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
assert "credits.usage" in to_clear
|
|
assert "credits.usage" not in latch["active"]
|
|
|
|
def test_recross_after_recovery_fires_again(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch) # recovery
|
|
# Re-cross: uf >= 0.9 again — should fire again because the band is clearable
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.usage" in keys
|
|
|
|
|
|
# ── Scenario 3: open-already-over (hybrid Q3 gate) ───────────────────────────
|
|
|
|
|
|
class TestOpenAlreadyOver:
|
|
def test_warn90_does_not_fire_without_seen_below_90(self):
|
|
"""First call uf≥0.9 with seen_below_90=False — warn90 must NOT fire."""
|
|
latch = fresh_latch()
|
|
assert latch["seen_below_90"] is False
|
|
s = state_with_fraction(0.95)
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert "credits.usage" not in to_clear
|
|
|
|
|
|
# ── Scenario 3b: boundary — exact 0.9 and just-below-1.0 ────────────────────
|
|
|
|
|
|
class TestBoundaryFractions:
|
|
def test_exact_0_9_fires_warn90(self):
|
|
"""used_fraction == 0.9 exactly must fire warn90 (threshold is inclusive)."""
|
|
latch = fresh_latch()
|
|
# First: prime seen_below_90 with a sub-50% observation
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
# Now construct a state where used_fraction is EXACTLY 0.9:
|
|
# subscription_limit_micros=20_000_000, subscription_micros=2_000_000
|
|
# → used = 18_000_000 / 20_000_000 = 0.9 exactly
|
|
s = CreditsState(
|
|
subscription_limit_micros=20_000_000,
|
|
subscription_limit_usd="20.00",
|
|
subscription_micros=2_000_000,
|
|
denominator_kind="subscription_cap",
|
|
paid_access=True,
|
|
)
|
|
assert s.used_fraction == 0.9
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.usage" in keys
|
|
assert "credits.usage" not in to_clear
|
|
|
|
def test_just_below_1_0_does_not_fire_grant_spent(self):
|
|
"""subscription_micros = limit - 1 (used_fraction just under 1.0) must NOT fire grant_spent.
|
|
|
|
Locks the boundary so a future used_fraction clamp refactor cannot fire
|
|
grant_spent a micro early.
|
|
"""
|
|
latch = fresh_latch()
|
|
limit = 20_000_000
|
|
s = CreditsState(
|
|
subscription_limit_micros=limit,
|
|
subscription_limit_usd="20.00",
|
|
subscription_micros=1, # limit - 1 → used_fraction < 1.0
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=5_000_000,
|
|
purchased_usd="5.00",
|
|
paid_access=True,
|
|
)
|
|
assert s.used_fraction is not None and s.used_fraction < 1.0
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
assert all(n.key != "credits.grant_spent" for n in to_show)
|
|
assert "credits.grant_spent" not in to_clear
|
|
|
|
|
|
# ── Scenario 4: grant_spent ───────────────────────────────────────────────────
|
|
|
|
|
|
class TestGrantSpent:
|
|
def _grant_state(self, purchased_micros: int = 12_340_000) -> CreditsState:
|
|
return state_with_fraction(
|
|
1.0,
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=purchased_micros,
|
|
purchased_usd="12.34",
|
|
)
|
|
|
|
def test_grant_spent_fires_on_first_obs(self):
|
|
"""No crossing gate for grant_spent — fires immediately on first obs."""
|
|
latch = fresh_latch()
|
|
to_show, to_clear = evaluate_credits_notices(self._grant_state(), latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.grant_spent" in keys
|
|
|
|
def test_grant_spent_no_refire(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(self._grant_state(), latch)
|
|
to_show, to_clear = evaluate_credits_notices(self._grant_state(), latch)
|
|
assert all(n.key != "credits.grant_spent" for n in to_show)
|
|
assert "credits.grant_spent" not in to_clear
|
|
|
|
def test_grant_spent_clears_when_purchased_zero(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(self._grant_state(), latch)
|
|
# Now purchased → 0: grant_cond becomes False
|
|
s_no_purchase = state_with_fraction(
|
|
1.0,
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=0,
|
|
purchased_usd="0.00",
|
|
)
|
|
to_show, to_clear = evaluate_credits_notices(s_no_purchase, latch)
|
|
assert "credits.grant_spent" in to_clear
|
|
assert all(n.key != "credits.grant_spent" for n in to_show)
|
|
|
|
|
|
# ── Scenario 5: depleted + recovery ──────────────────────────────────────────
|
|
|
|
|
|
class TestDepleted:
|
|
def test_depleted_fires_level_error_kind_sticky(self):
|
|
latch = fresh_latch()
|
|
s = CreditsState(paid_access=False)
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
depleted_notices = [n for n in to_show if n.key == "credits.depleted"]
|
|
assert len(depleted_notices) == 1
|
|
n = depleted_notices[0]
|
|
assert n.level == "error"
|
|
assert n.kind == CREDITS_NOTICE_KIND
|
|
|
|
def test_recovery_emits_clear_and_restored(self):
|
|
latch = fresh_latch()
|
|
# Fire depleted
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
# Now recovered
|
|
to_show, to_clear = evaluate_credits_notices(CreditsState(paid_access=True), latch)
|
|
assert "credits.depleted" in to_clear
|
|
restored = [n for n in to_show if n.key == "credits.restored"]
|
|
assert len(restored) == 1
|
|
r = restored[0]
|
|
assert r.level == "success"
|
|
assert r.kind == "ttl"
|
|
assert r.ttl_ms == CREDITS_RESTORED_TTL_MS
|
|
|
|
def test_depleted_refires_after_recovery(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
evaluate_credits_notices(CreditsState(paid_access=True), latch)
|
|
# Goes depleted again
|
|
to_show, to_clear = evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.depleted" in keys
|
|
|
|
|
|
# ── Scenario 5b: free-model suppression of the depleted notice ───────────────
|
|
|
|
|
|
class TestDepletedFreeModelSuppression:
|
|
def test_depleted_suppressed_when_model_is_free(self):
|
|
latch = fresh_latch()
|
|
s = CreditsState(paid_access=False)
|
|
to_show, to_clear = evaluate_credits_notices(s, latch, model_is_free=True)
|
|
assert all(n.key != "credits.depleted" for n in to_show)
|
|
assert "credits.depleted" not in latch["active"]
|
|
assert to_clear == []
|
|
|
|
def test_switch_to_free_model_clears_without_restored(self):
|
|
latch = fresh_latch()
|
|
# Depleted on a paid model → notice fires
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
assert "credits.depleted" in latch["active"]
|
|
# Same depleted account, but now on a free model → clear, NO "restored"
|
|
to_show, to_clear = evaluate_credits_notices(
|
|
CreditsState(paid_access=False), latch, model_is_free=True
|
|
)
|
|
assert "credits.depleted" in to_clear
|
|
assert "credits.depleted" not in latch["active"]
|
|
assert all(n.key != "credits.restored" for n in to_show)
|
|
|
|
def test_switch_back_to_paid_model_while_depleted_reshows(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch, model_is_free=True)
|
|
# Back on a paid model, still depleted → notice re-fires
|
|
to_show, to_clear = evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.depleted" in keys
|
|
assert "credits.depleted" in latch["active"]
|
|
|
|
def test_genuine_recovery_on_free_model_no_spurious_restored(self):
|
|
"""Recovery observed while suppressed (notice never shown) → nothing to
|
|
clear, no 'restored' (there was no visible depleted state to restore)."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch, model_is_free=True)
|
|
to_show, to_clear = evaluate_credits_notices(
|
|
CreditsState(paid_access=True), latch, model_is_free=True
|
|
)
|
|
assert to_clear == []
|
|
assert all(n.key != "credits.restored" for n in to_show)
|
|
|
|
def test_genuine_recovery_still_emits_restored_when_notice_active(self):
|
|
"""paid_access flip back to True with the notice showing → clear + restored
|
|
(unchanged behaviour, regardless of the model-free flag)."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(CreditsState(paid_access=False), latch)
|
|
to_show, to_clear = evaluate_credits_notices(
|
|
CreditsState(paid_access=True), latch, model_is_free=True
|
|
)
|
|
assert "credits.depleted" in to_clear
|
|
restored = [n for n in to_show if n.key == "credits.restored"]
|
|
assert len(restored) == 1
|
|
|
|
def test_free_flag_does_not_affect_other_notices(self):
|
|
"""Usage-band and grant notices are independent of the model-free gate."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch, model_is_free=True)
|
|
to_show, _ = evaluate_credits_notices(
|
|
state_with_fraction(0.95, paid_access=False), latch, model_is_free=True
|
|
)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.usage" in keys
|
|
assert "credits.depleted" not in keys
|
|
|
|
|
|
# ── Scenario 5c: is_free_tier_model (local-data-only check) ──────────────────
|
|
|
|
|
|
class TestIsFreeTierModel:
|
|
def test_free_suffix_is_free(self):
|
|
from agent.credits_tracker import is_free_tier_model
|
|
|
|
assert is_free_tier_model("nvidia/nemotron-3-ultra:free") is True
|
|
assert is_free_tier_model("Hermes-4-70B:free", "https://inference-api.nousresearch.com") is True
|
|
|
|
def test_empty_or_paid_model_is_not_free(self):
|
|
from agent.credits_tracker import is_free_tier_model
|
|
|
|
assert is_free_tier_model("") is False
|
|
assert is_free_tier_model("Hermes-4-405B") is False
|
|
|
|
def test_pricing_cache_peek_zero_priced_model(self, monkeypatch):
|
|
from agent.credits_tracker import is_free_tier_model
|
|
import hermes_cli.models as models_mod
|
|
|
|
# The picker keys the cache on the pre-/v1 root (get_pricing_for_provider
|
|
# strips a trailing /v1 before fetch_models_with_pricing).
|
|
monkeypatch.setattr(
|
|
models_mod,
|
|
"_pricing_cache",
|
|
{
|
|
"https://inference-api.nousresearch.com": {
|
|
"some/zero-priced": {"prompt": "0", "completion": "0"},
|
|
"some/paid": {"prompt": "0.000001", "completion": "0.000002"},
|
|
}
|
|
},
|
|
)
|
|
# The agent holds the /v1-suffixed URL (DEFAULT_NOUS_INFERENCE_URL) —
|
|
# the helper must normalize it down to the picker's cache key.
|
|
base = "https://inference-api.nousresearch.com/v1"
|
|
assert is_free_tier_model("some/zero-priced", base) is True
|
|
assert is_free_tier_model("some/paid", base) is False
|
|
# Pre-stripped and trailing-slash variants resolve to the same key.
|
|
assert is_free_tier_model("some/zero-priced", "https://inference-api.nousresearch.com/") is True
|
|
assert is_free_tier_model("some/zero-priced", "https://inference-api.nousresearch.com/v1/") is True
|
|
|
|
def test_cache_miss_is_not_free_and_no_fetch(self, monkeypatch):
|
|
from agent.credits_tracker import is_free_tier_model
|
|
import hermes_cli.models as models_mod
|
|
|
|
monkeypatch.setattr(models_mod, "_pricing_cache", {})
|
|
|
|
def _boom(*args, **kwargs): # any network attempt fails the test
|
|
raise AssertionError("is_free_tier_model must never hit the network")
|
|
|
|
import urllib.request
|
|
|
|
monkeypatch.setattr(urllib.request, "urlopen", _boom)
|
|
assert is_free_tier_model("some/model", "https://inference-api.nousresearch.com/v1") is False
|
|
|
|
def test_exception_fails_open_to_false(self, monkeypatch):
|
|
from agent.credits_tracker import is_free_tier_model
|
|
import hermes_cli.models as models_mod
|
|
|
|
class _Exploding:
|
|
def get(self, *_a, **_kw):
|
|
raise RuntimeError("boom")
|
|
|
|
monkeypatch.setattr(models_mod, "_pricing_cache", _Exploding())
|
|
assert is_free_tier_model("some/model", "https://inference-api.nousresearch.com") is False
|
|
|
|
|
|
# ── Scenario 6: denominator none (uf is None) ────────────────────────────────
|
|
|
|
|
|
class TestDenominatorNone:
|
|
def test_no_warn90_when_uf_none(self):
|
|
latch = fresh_latch()
|
|
s = state_with_fraction(None)
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert "credits.usage" not in to_clear
|
|
|
|
def test_no_grant_spent_when_uf_none(self):
|
|
latch = fresh_latch()
|
|
s = CreditsState(
|
|
subscription_limit_micros=None,
|
|
denominator_kind="none",
|
|
purchased_micros=5_000_000,
|
|
purchased_usd="5.00",
|
|
)
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
assert all(n.key != "credits.grant_spent" for n in to_show)
|
|
|
|
def test_warn90_clears_when_uf_becomes_none(self):
|
|
"""If warn90 was active and uf becomes None, it should clear."""
|
|
latch = fresh_latch()
|
|
# Establish usage notice active: cross below → above
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
assert "credits.usage" in latch["active"]
|
|
# Now uf becomes None (denominator changed to "none")
|
|
s_none = state_with_fraction(None)
|
|
to_show, to_clear = evaluate_credits_notices(s_none, latch)
|
|
assert "credits.usage" in to_clear
|
|
assert "credits.usage" not in latch["active"]
|
|
|
|
|
|
# ── Scenario 7: copy / verbatim USD strings ──────────────────────────────────
|
|
|
|
|
|
class TestNoticeCopy:
|
|
def test_warn90_contains_verbatim_subscription_limit_usd(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
s = state_with_fraction(0.95, subscription_limit_usd="20.00")
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
warn_notice = next(n for n in to_show if n.key == "credits.usage")
|
|
assert "$20.00" in warn_notice.text
|
|
assert "cap" in warn_notice.text
|
|
|
|
def test_grant_spent_contains_verbatim_purchased_usd(self):
|
|
latch = fresh_latch()
|
|
s = state_with_fraction(
|
|
1.0,
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=12_340_000,
|
|
purchased_usd="12.34",
|
|
)
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
grant_notice = next(n for n in to_show if n.key == "credits.grant_spent")
|
|
assert "$12.34" in grant_notice.text
|
|
assert "top-up left" in grant_notice.text
|
|
|
|
def test_depleted_mentions_credits_command(self):
|
|
latch = fresh_latch()
|
|
s = CreditsState(paid_access=False)
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
depleted_notice = next(n for n in to_show if n.key == "credits.depleted")
|
|
assert "/topup" in depleted_notice.text
|
|
|
|
|
|
# ── Scenario 8: severity order in a single call ──────────────────────────────
|
|
|
|
|
|
class TestSeverityOrder:
|
|
def test_multiple_new_notices_ordered_ascending_severity(self):
|
|
"""grant_spent < depleted in to_show when both fire in one call.
|
|
|
|
(usage is suppressed here: purchased>0 — see TestTopUpSuppression.
|
|
usage + grant_spent are now mutually exclusive by design.)
|
|
"""
|
|
latch = {"active": set(), "seen_below_90": True, "usage_band": None}
|
|
|
|
# Build state: subscription_cap, uf >= 1.0, purchased_micros > 0, NOT paid_access
|
|
# grant_cond: subscription_cap + uf >= 1.0 + purchased > 0 ✓
|
|
# depleted_cond: not paid_access ✓
|
|
# usage band: suppressed (purchased > 0)
|
|
s = CreditsState(
|
|
subscription_limit_micros=20_000_000,
|
|
subscription_limit_usd="20.00",
|
|
subscription_micros=0, # uf = 1.0
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=5_000_000,
|
|
purchased_usd="5.00",
|
|
paid_access=False,
|
|
)
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.usage" not in keys
|
|
assert "credits.grant_spent" in keys
|
|
assert "credits.depleted" in keys
|
|
# Ascending severity: grant_spent before depleted
|
|
assert keys.index("credits.grant_spent") < keys.index("credits.depleted")
|
|
|
|
def test_usage_before_depleted_without_topup(self):
|
|
"""With no top-up funds, usage fires and precedes depleted."""
|
|
latch = {"active": set(), "seen_below_90": True, "usage_band": None}
|
|
s = CreditsState(
|
|
subscription_limit_micros=20_000_000,
|
|
subscription_limit_usd="20.00",
|
|
subscription_micros=0, # uf = 1.0
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=0,
|
|
purchased_usd="0.00",
|
|
paid_access=False,
|
|
)
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.usage" in keys
|
|
assert "credits.depleted" in keys
|
|
assert keys.index("credits.usage") < keys.index("credits.depleted")
|
|
|
|
|
|
# ── Scenario 8b: top-up suppression of the usage gauge ───────────────────────
|
|
|
|
|
|
class TestTopUpSuppression:
|
|
"""purchased_micros > 0 suppresses the sub-cap usage gauge: the cap is the
|
|
wrong denominator for an account that can keep spending top-up funds."""
|
|
|
|
def test_no_usage_band_with_topup_at_90pct(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(
|
|
state_with_fraction(0.10, purchased_micros=5_000_000, purchased_usd="5.00"),
|
|
latch,
|
|
)
|
|
to_show, to_clear = evaluate_credits_notices(
|
|
state_with_fraction(0.95, purchased_micros=5_000_000, purchased_usd="5.00"),
|
|
latch,
|
|
)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert latch["usage_band"] is None
|
|
|
|
def test_topup_landing_mid_session_clears_active_band(self):
|
|
"""A showing 90% warn must clear when a top-up lands (purchased 0 → >0)."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
assert latch["usage_band"] == 90
|
|
to_show, to_clear = evaluate_credits_notices(
|
|
state_with_fraction(0.95, purchased_micros=10_000_000, purchased_usd="10.00"),
|
|
latch,
|
|
)
|
|
assert "credits.usage" in to_clear
|
|
assert latch["usage_band"] is None
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
|
|
def test_band_resumes_after_topup_spent(self):
|
|
"""purchased back to 0 with usage still in-band → gauge resumes."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(
|
|
state_with_fraction(0.95, purchased_micros=10_000_000, purchased_usd="10.00"),
|
|
latch,
|
|
)
|
|
assert latch["usage_band"] is None
|
|
to_show, _ = evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
n = next(n for n in to_show if n.key == "credits.usage")
|
|
assert "90%" in n.text
|
|
assert latch["usage_band"] == 90
|
|
|
|
def test_grant_spent_still_fires_with_topup(self):
|
|
"""Suppression only affects the gauge — grant_spent (which NEEDS purchased>0)
|
|
is untouched."""
|
|
latch = fresh_latch()
|
|
s = state_with_fraction(
|
|
1.0,
|
|
denominator_kind="subscription_cap",
|
|
purchased_micros=12_340_000,
|
|
purchased_usd="12.34",
|
|
)
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
keys = [n.key for n in to_show]
|
|
assert "credits.grant_spent" in keys
|
|
assert "credits.usage" not in keys
|
|
|
|
def test_depleted_unaffected_by_topup_suppression(self):
|
|
latch = fresh_latch()
|
|
s = CreditsState(paid_access=False, purchased_micros=5_000_000, purchased_usd="5.00")
|
|
to_show, _ = evaluate_credits_notices(s, latch)
|
|
assert any(n.key == "credits.depleted" for n in to_show)
|
|
|
|
|
|
# ── Invariant: never fire + clear same key in one call ────────────────────────
|
|
|
|
|
|
class TestNoFireAndClearSameKey:
|
|
def test_usage_never_both_fired_and_cleared(self):
|
|
latch = fresh_latch()
|
|
# Run many state transitions; across each, assert no key is in both lists
|
|
states = [
|
|
state_with_fraction(0.10),
|
|
state_with_fraction(0.95),
|
|
state_with_fraction(0.10),
|
|
state_with_fraction(0.95),
|
|
state_with_fraction(None),
|
|
]
|
|
for s in states:
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
fired_keys = {n.key for n in to_show}
|
|
cleared_keys = set(to_clear)
|
|
overlap = fired_keys & cleared_keys
|
|
assert not overlap, f"Key(s) both fired and cleared: {overlap}"
|
|
|
|
def test_depleted_never_both_fired_and_cleared(self):
|
|
latch = fresh_latch()
|
|
states = [
|
|
CreditsState(paid_access=False),
|
|
CreditsState(paid_access=True),
|
|
CreditsState(paid_access=False),
|
|
]
|
|
for s in states:
|
|
to_show, to_clear = evaluate_credits_notices(s, latch)
|
|
fired_keys = {n.key for n in to_show}
|
|
cleared_keys = set(to_clear)
|
|
overlap = fired_keys & cleared_keys
|
|
assert not overlap, f"Key(s) both fired and cleared: {overlap}"
|
|
|
|
|
|
# ── Scenario 9: escalating usage bands (50 → 75 → 90) ────────────────────────
|
|
|
|
|
|
class TestUsageBands:
|
|
"""The usage notice shows the HIGHEST crossed band as a single escalating line."""
|
|
|
|
def _band_text(self, to_show):
|
|
n = next((n for n in to_show if n.key == "credits.usage"), None)
|
|
return n.text if n else None
|
|
|
|
def test_50_band_fires_info(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch) # prime
|
|
to_show, _ = evaluate_credits_notices(state_with_fraction(0.55), latch)
|
|
n = next(n for n in to_show if n.key == "credits.usage")
|
|
assert "50%" in n.text and n.level == "info"
|
|
assert latch["usage_band"] == 50
|
|
|
|
def test_75_band_fires_warn(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
to_show, _ = evaluate_credits_notices(state_with_fraction(0.80), latch)
|
|
n = next(n for n in to_show if n.key == "credits.usage")
|
|
assert "75%" in n.text and n.level == "warn"
|
|
assert latch["usage_band"] == 75
|
|
|
|
def test_climb_replaces_band(self):
|
|
"""Climbing 50→75→90 replaces the single line (clear old + show new)."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
# 55% → 50 band
|
|
evaluate_credits_notices(state_with_fraction(0.55), latch)
|
|
assert latch["usage_band"] == 50
|
|
# 80% → climbs to 75, clearing the 50 line
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.80), latch)
|
|
assert "credits.usage" in to_clear
|
|
assert "75%" in self._band_text(to_show)
|
|
assert latch["usage_band"] == 75
|
|
# 95% → climbs to 90
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
assert "credits.usage" in to_clear
|
|
assert "90%" in self._band_text(to_show)
|
|
assert latch["usage_band"] == 90
|
|
|
|
def test_step_down_on_recovery(self):
|
|
"""Recovering steps the band back down, then clears below the lowest band."""
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.95), latch)
|
|
assert latch["usage_band"] == 90
|
|
# drop to 80% → steps down to 75
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.80), latch)
|
|
assert "credits.usage" in to_clear
|
|
assert "75%" in self._band_text(to_show)
|
|
# drop to 55% → steps down to 50
|
|
to_show, _ = evaluate_credits_notices(state_with_fraction(0.55), latch)
|
|
assert "50%" in self._band_text(to_show)
|
|
# drop below 50% → clears entirely
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
assert "credits.usage" in to_clear
|
|
assert latch["usage_band"] is None
|
|
|
|
def test_no_refire_same_band(self):
|
|
latch = fresh_latch()
|
|
evaluate_credits_notices(state_with_fraction(0.10), latch)
|
|
evaluate_credits_notices(state_with_fraction(0.80), latch) # fires 75
|
|
# still 80% → same band, no re-emit, no clear
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.80), latch)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert "credits.usage" not in to_clear
|
|
|
|
def test_exact_band_boundaries_inclusive(self):
|
|
"""Thresholds are inclusive: exactly 0.50 / 0.75 / 0.90 land in their band."""
|
|
for uf, want in [(0.50, 50), (0.75, 75), (0.90, 90)]:
|
|
latch = fresh_latch()
|
|
latch["seen_below_90"] = True # allow firing
|
|
evaluate_credits_notices(state_with_fraction(uf), latch)
|
|
assert latch["usage_band"] == want, (uf, latch["usage_band"])
|
|
|
|
def test_open_below_lowest_band_no_notice(self):
|
|
latch = fresh_latch()
|
|
to_show, to_clear = evaluate_credits_notices(state_with_fraction(0.30), latch)
|
|
assert all(n.key != "credits.usage" for n in to_show)
|
|
assert latch["usage_band"] is None
|