mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-08 13:12:08 +00:00
* feat(billing): nous_billing http client + BillingState core (phase 2b)
Phase 2b terminal-billing client foundation:
- hermes_cli/nous_billing.py: typed client for the 4 /api/billing/* endpoints
(state/charge/poll/auto-top-up). Raises typed errors (BillingScopeRequired,
BillingRateLimited, BillingAuthError) mapped from the live-verified contract;
fail-open is the caller's job. Idempotency-Key enforced client-side.
- agent/billing_view.py: surface-agnostic BillingState core + Decimal money
parsing (server emits decimal strings, not 2dp), fail-open builder,
idempotency-key gen, custom-amount validation.
- 51 unit tests (decimal parse/format, payload tiering, error->exception
matrix, fail-open, amount validation).
Plan: docs/plans/2026-06-13-001-phase-2b-terminal-billing-tui-plan.md
* feat(billing): billing:manage scope + lazy step-up re-auth (phase 2b)
- NOUS_BILLING_MANAGE_SCOPE constant.
- nous_token_has_billing_scope(): split-based scope check (no false-positive
substring match).
- step_up_nous_billing_scope(): re-runs the device flow requesting
billing:manage, reusing the held credential's portal/inference URLs + client_id
(so a preview stays a preview), persists like _login_nous but WITHOUT the model
picker. Returns True iff the minted token carries the scope (False when NAS
silently downscopes a non-admin / unticked grant).
Lazy step-up (plan D-A): normal login path unchanged; 403 insufficient_scope
from a billing call triggers this. 7 unit tests.
* feat(billing): billing JSON-RPC methods for the TUI (phase 2b)
billing.state / charge / charge_status / auto_reload / step_up in
tui_gateway/server.py. Return STRUCTURED success envelopes (result.ok +
result.error=<code>) rather than JSON-RPC-level errors, so the Ink rpc() promise
always resolves and the TUI branches on the typed billing error code
(insufficient_scope, rate_limited, no_payment_method, …) to render the right
affordance. Money serialized as decimal STRINGS + display strings. charge mints
+ echoes an idempotency_key for retry reuse. 16 unit tests.
* feat(billing): /billing CLI handler + command registry (phase 2b)
- CommandDef("billing", subcommands=buy|auto-reload|limit), added to
_SLACK_VIA_HERMES_ONLY so it routes via /hermes on Slack (keeps the 50-cap
parity test green, same as /credits).
- cli.py::_show_billing + screen helpers: all 5 screens (overview, buy→confirm→
poll, auto-reload, monthly-limit read-only). Reuses _prompt_text_input_modal /
_prompt_text_input (D-C). Non-interactive (_app is None) renders text + portal
deep-link, never prompts (R7). Decimal money end-to-end. 2s/5-min cancellable
poll loop; 429/503 = retry not failure; settled = ledger truth. Lazy step-up on
403 insufficient_scope. no_payment_method treated as mainline funnel-to-portal.
- 6 CLI tests; 156 command tests (incl. Slack/Telegram parity) green.
* feat(billing): /billing Ink TUI screens + tests (phase 2b)
- ui-tui/src/app/slash/commands/billing.ts: /billing TUI command covering all 5
screens — overview (text), buy <amt> → ConfirmReq → charge → non-blocking 2s/
5-min poll loop → settled/failed/timeout branches, auto-reload <below> <to> →
ConfirmReq → PATCH, limit (read-only). Reuses the existing ConfirmReq overlay
(D-C) — no bespoke component. Typed-error envelope branching: insufficient_scope
arms the lazy step-up confirm; no_payment_method/rate_limited/cap funnel to
portal. Client-side amount validation mirrors the server (bounds + 2dp).
- gatewayTypes.ts: Billing* response interfaces.
- registry.ts: register billingCommands.
- billingCommand.test.ts: 12 vitest cases (overview/gating/buy-confirm-poll-
settled/no_payment_method/step-up/limit/auto-reload/validation).
TUI build green; 12/12 vitest pass; slash tests pass once @hermes/ink is built.
* docs(billing): scrub private cross-repo references
NAS is a private repo — remove all references to it from the public PR:
- drop the cross-repo planning doc (planning scaffolding, not a deliverable;
the PR description documents the design)
- replace 'NAS' / 'PR #412 preview' mentions in code + test comments with
generic 'the server' / 'a preview deployment'
* docs(billing): scrub final NAS reference in step-up docstring
* docs(billing): drop dangling plan-doc refs
The phase-2b plan doc was removed in the cross-repo scrub (300afcc0b)
but two module docstrings still pointed at it. Drop the dead refs.
* feat(billing): interactive /billing overlay + step-up UX, portal-URL & token fixes
Adds the interactive /billing TUI overlay and hardens the terminal-billing
client across CLI and TUI.
- TUI: full /billing overlay state machine (overview to buy to confirm,
auto-reload, read-only monthly limit) reusing the existing confirm overlay.
- Step-up: surface the verification link in-transcript and open the browser
via the TUI's own opener (the device flow runs in the headless gateway, so a
printed URL was being dropped); run the step-up handler off the main loop and
emit the link as an out-of-band event so the gateway stays responsive.
- Step-up copy is scope-accurate ("Billing permission granted") and re-checks
/state so it never claims "enabled" when the org kill-switch is still off.
- Portal deep-links resolve to absolute URLs against the active portal base
(the server emits them relative) - fixes a bare "/billing?topup=open" link.
- Billing calls refresh an expired access token via the stored refresh token
instead of reporting a false "not logged in".
- Optimistic funnel: advise "set up a saved card on the portal" up front when
no card is on file (advisory, not a hard gate).
- Token resolution is cached briefly so the 2s charge poll loop stops
re-locking + re-reading the auth store on every tick; 401 re-resolves fresh.
- Remove the temporary demo-mode shims.
Validation: 87 Python billing tests, 88 TS tests (billing command + gateway
event handler), tsc clean, ink + ui-tui builds green.
* docs(billing): add /billing TUI screenshots for PR
* fix(cli): guard _last_invalidate on bare instances; update stale prompt-fallback test
The UI-invalidate throttle read self._last_invalidate unconditionally, which
raised AttributeError on HermesCLI instances built without __init__ (the
thread-safety test's object.__new__ shell). Guard the read with getattr.
The off-main-thread branch of _prompt_text_input was changed (#23185) to cancel
cleanly to None instead of falling back to a bare input() that would hang on the
slash-worker thread; the test still asserted the old direct-input fallback.
Update it to assert the current intended behavior: returns None, calls neither
run_in_terminal nor input(), and does not hang.
301 lines
9.6 KiB
TypeScript
301 lines
9.6 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { getOverlayState, resetOverlayState } from '../app/overlayStore.js'
|
|
import { billingCommands } from '../app/slash/commands/billing.js'
|
|
import type { BillingStateResponse } from '../gatewayTypes.js'
|
|
|
|
vi.mock('../lib/openExternalUrl.js', () => ({
|
|
openExternalUrl: vi.fn(() => true)
|
|
}))
|
|
|
|
const billingCommand = billingCommands.find(cmd => cmd.name === 'billing')!
|
|
|
|
const ownerState = (overrides: Partial<BillingStateResponse> = {}): BillingStateResponse => ({
|
|
auto_reload: {
|
|
enabled: false,
|
|
reload_to_display: '—',
|
|
reload_to_usd: null,
|
|
threshold_display: '—',
|
|
threshold_usd: null
|
|
},
|
|
balance_display: '$142.50',
|
|
balance_usd: '142.5',
|
|
can_charge: true,
|
|
card: { brand: 'visa', last4: '4242', masked: 'visa ····4242' },
|
|
charge_presets: ['25', '50', '100'],
|
|
charge_presets_display: ['$25', '$50', '$100'],
|
|
cli_billing_enabled: true,
|
|
is_admin: true,
|
|
logged_in: true,
|
|
max_usd: '10000',
|
|
min_usd: '10',
|
|
monthly_cap: {
|
|
is_default_ceiling: true,
|
|
limit_display: '$1000',
|
|
limit_usd: '1000',
|
|
spent_display: '$180',
|
|
spent_this_month_usd: '180'
|
|
},
|
|
ok: true,
|
|
org_name: 'Acme',
|
|
portal_url: 'https://portal/billing?topup=open',
|
|
role: 'OWNER',
|
|
...overrides
|
|
})
|
|
|
|
const guarded =
|
|
<T>(fn: (r: T) => void) =>
|
|
(r: null | T) => {
|
|
if (r) {
|
|
fn(r)
|
|
}
|
|
}
|
|
|
|
/** Build a ctx whose rpc routes by method name to a supplied map of results. */
|
|
const buildCtx = (results: Record<string, unknown>) => {
|
|
const sys = vi.fn()
|
|
const calls: Array<{ method: string; params: unknown }> = []
|
|
|
|
const rpc = vi.fn((method: string, params: unknown) => {
|
|
calls.push({ method, params })
|
|
|
|
return Promise.resolve(results[method])
|
|
})
|
|
|
|
const ctx = {
|
|
gateway: { rpc },
|
|
guarded,
|
|
guardedErr: vi.fn(),
|
|
sid: 'sid-1',
|
|
stale: () => false,
|
|
transcript: { page: vi.fn(), panel: vi.fn(), sys }
|
|
}
|
|
|
|
const run = async (arg: string) => {
|
|
billingCommand.run(arg, ctx as any, 'billing')
|
|
await rpc.mock.results[0]?.value
|
|
await Promise.resolve()
|
|
await Promise.resolve()
|
|
}
|
|
|
|
return { calls, ctx, rpc, run, sys }
|
|
}
|
|
|
|
const printed = (sys: ReturnType<typeof vi.fn>) => sys.mock.calls.map(c => c[0]).join('\n')
|
|
|
|
describe('/billing slash command (overlay-driven)', () => {
|
|
beforeEach(() => {
|
|
resetOverlayState()
|
|
})
|
|
|
|
it('not logged in → prompts to log in, no overlay', async () => {
|
|
const { run, sys } = buildCtx({ 'billing.state': { ...ownerState(), logged_in: false, ok: true } })
|
|
await run('')
|
|
expect(printed(sys)).toContain('Not logged into Nous Portal')
|
|
expect(getOverlayState().billing).toBeNull()
|
|
})
|
|
|
|
it('bare /billing opens the overlay on the overview screen with state', async () => {
|
|
const { run, rpc } = buildCtx({ 'billing.state': ownerState() })
|
|
await run('')
|
|
expect(rpc).toHaveBeenCalledWith('billing.state', {})
|
|
const billing = getOverlayState().billing
|
|
expect(billing).toBeTruthy()
|
|
expect(billing?.screen).toBe('overview')
|
|
expect(billing?.state.balance_display).toBe('$142.50')
|
|
expect(billing?.state.charge_presets_display).toEqual(['$25', '$50', '$100'])
|
|
})
|
|
|
|
it('any sub-command arg is ignored — still opens the overview overlay', async () => {
|
|
const { run } = buildCtx({ 'billing.state': ownerState() })
|
|
await run('buy 100')
|
|
const billing = getOverlayState().billing
|
|
expect(billing?.screen).toBe('overview')
|
|
// No confirm overlay armed directly by the command anymore.
|
|
expect(getOverlayState().confirm).toBeNull()
|
|
})
|
|
|
|
it('member overview carries the non-admin state for component-side gating', async () => {
|
|
const { run } = buildCtx({
|
|
'billing.state': ownerState({
|
|
is_admin: false,
|
|
can_charge: false,
|
|
role: 'MEMBER',
|
|
card: null,
|
|
monthly_cap: null,
|
|
auto_reload: null
|
|
})
|
|
})
|
|
|
|
await run('')
|
|
const billing = getOverlayState().billing
|
|
expect(billing?.state.is_admin).toBe(false)
|
|
expect(billing?.screen).toBe('overview')
|
|
})
|
|
|
|
// ── Overlay ctx behaviors (RPC + error mapping live in billing.ts) ──
|
|
|
|
it('ctx.validate rejects out-of-bounds and sub-cent amounts, accepts valid', async () => {
|
|
const { run } = buildCtx({ 'billing.state': ownerState() })
|
|
await run('')
|
|
const ctx = getOverlayState().billing!.ctx
|
|
expect(ctx.validate('5').error).toContain('Minimum is $10')
|
|
expect(ctx.validate('10.005').error).toContain('2 decimal places')
|
|
expect(ctx.validate('100').amount).toBe('100')
|
|
expect(ctx.validate('$50').amount).toBe('50')
|
|
})
|
|
|
|
it('ctx.charge → poll → settled', async () => {
|
|
vi.useFakeTimers()
|
|
|
|
try {
|
|
const { run, sys } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.charge': { ok: true, charge_id: 'ch_1', idempotency_key: 'k' },
|
|
'billing.charge_status': { ok: true, status: 'settled', amount_usd: '100' }
|
|
})
|
|
|
|
await run('')
|
|
const ctx = getOverlayState().billing!.ctx
|
|
ctx.charge('100')
|
|
await vi.runAllTimersAsync()
|
|
const out = printed(sys)
|
|
expect(out).toContain('Charge submitted')
|
|
expect(out).toContain('✅ $100 added.')
|
|
} finally {
|
|
vi.useRealTimers()
|
|
}
|
|
})
|
|
|
|
it('ctx.charge → poll → failed adds the portal funnel line', async () => {
|
|
vi.useFakeTimers()
|
|
|
|
try {
|
|
const { run, sys } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.charge': { ok: true, charge_id: 'ch_1', idempotency_key: 'k' },
|
|
'billing.charge_status': { ok: true, status: 'failed', reason: 'card_declined' }
|
|
})
|
|
|
|
await run('')
|
|
getOverlayState().billing!.ctx.charge('100')
|
|
await vi.runAllTimersAsync()
|
|
const out = printed(sys)
|
|
expect(out).toContain('Your card was declined')
|
|
// Parity with the CLI: a failed poll funnels to the portal (from state.portal_url).
|
|
expect(out).toContain('Portal: https://portal/billing?topup=open')
|
|
} finally {
|
|
vi.useRealTimers()
|
|
}
|
|
})
|
|
|
|
it('ctx.charge monthly_cap_exceeded surfaces remaining headroom', async () => {
|
|
const { run, sys } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.charge': {
|
|
ok: false,
|
|
error: 'monthly_cap_exceeded',
|
|
message: 'Monthly spend cap reached.',
|
|
payload: { remainingUsd: '42.50' },
|
|
portal_url: '/billing?topup=open',
|
|
idempotency_key: 'k'
|
|
}
|
|
})
|
|
|
|
await run('')
|
|
getOverlayState().billing!.ctx.charge('100')
|
|
await Promise.resolve()
|
|
await Promise.resolve()
|
|
const out = printed(sys)
|
|
expect(out).toContain('Monthly spend cap reached — $42.50 headroom left.')
|
|
expect(out).toContain('Portal: /billing?topup=open')
|
|
})
|
|
|
|
it('ctx.charge no_payment_method → portal funnel copy', async () => {
|
|
const { run, sys } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.charge': {
|
|
ok: false,
|
|
error: 'no_payment_method',
|
|
portal_url: '/billing?topup=open',
|
|
idempotency_key: 'k'
|
|
}
|
|
})
|
|
|
|
await run('')
|
|
getOverlayState().billing!.ctx.charge('100')
|
|
await Promise.resolve()
|
|
await Promise.resolve()
|
|
const out = printed(sys)
|
|
expect(out).toContain('No saved card for terminal charges')
|
|
expect(out).toContain('Portal: /billing?topup=open')
|
|
})
|
|
|
|
it('ctx.charge insufficient_scope → arms step-up confirm', async () => {
|
|
const { run } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.charge': { ok: false, error: 'insufficient_scope', idempotency_key: 'k' }
|
|
})
|
|
|
|
await run('')
|
|
getOverlayState().billing!.ctx.charge('100')
|
|
await Promise.resolve()
|
|
await Promise.resolve()
|
|
// The charge failed with insufficient_scope → a NEW confirm (step-up) is armed.
|
|
const stepUp = getOverlayState().confirm
|
|
expect(stepUp?.title).toBe('Grant terminal billing access?')
|
|
})
|
|
|
|
it('ctx.applyAutoReload(true, …) → billing.auto_reload RPC, resolves true', async () => {
|
|
const { run, calls } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.auto_reload': { ok: true }
|
|
})
|
|
|
|
await run('')
|
|
const ok = await getOverlayState().billing!.ctx.applyAutoReload(true, 20, 100)
|
|
expect(ok).toBe(true)
|
|
const ar = calls.find(c => c.method === 'billing.auto_reload')
|
|
expect(ar?.params).toEqual({ enabled: true, threshold: 20, top_up_amount: 100 })
|
|
})
|
|
|
|
it('ctx.applyAutoReload(false) → disables (enabled:false, no amounts)', async () => {
|
|
const { run, calls } = buildCtx({
|
|
'billing.state': ownerState({
|
|
auto_reload: {
|
|
enabled: true,
|
|
reload_to_display: '$100',
|
|
reload_to_usd: '100',
|
|
threshold_display: '$20',
|
|
threshold_usd: '20'
|
|
}
|
|
}),
|
|
'billing.auto_reload': { ok: true }
|
|
})
|
|
|
|
await run('')
|
|
const ok = await getOverlayState().billing!.ctx.applyAutoReload(false)
|
|
expect(ok).toBe(true)
|
|
const ar = calls.find(c => c.method === 'billing.auto_reload')
|
|
expect(ar?.params).toEqual({ enabled: false })
|
|
})
|
|
|
|
it('ctx.applyAutoReload error → resolves false + maps the error', async () => {
|
|
const { run, sys } = buildCtx({
|
|
'billing.state': ownerState(),
|
|
'billing.auto_reload': { ok: false, error: 'monthly_cap_exceeded', message: 'Monthly spend cap reached.' }
|
|
})
|
|
|
|
await run('')
|
|
const ok = await getOverlayState().billing!.ctx.applyAutoReload(true, 20, 100)
|
|
expect(ok).toBe(false)
|
|
expect(printed(sys)).toContain('Monthly spend cap reached.')
|
|
})
|
|
|
|
it('ctx.openPortal opens the URL + echoes a transcript line', async () => {
|
|
const { run, sys } = buildCtx({ 'billing.state': ownerState() })
|
|
await run('')
|
|
getOverlayState().billing!.ctx.openPortal('https://portal/x')
|
|
expect(printed(sys)).toContain('Opening portal: https://portal/x')
|
|
})
|
|
})
|