hermes-agent/tests/tui_gateway/test_billing_rpc.py
Siddharth Balyan 73cd8622f9
feat(billing): /billing terminal billing — interactive TUI + CLI client (#45449)
* 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.
2026-06-19 01:53:32 +05:30

206 lines
7.5 KiB
Python

"""Tests for the Phase 2b billing JSON-RPC methods (tui_gateway/server.py).
Verifies the structured envelope contract the Ink side branches on:
- billing.state serializes BillingState (Decimals → strings) + fails open.
- billing.charge / charge_status / auto_reload return typed error envelopes
(result.ok=false, result.error=<code>) instead of JSON-RPC errors.
- billing.charge mints + echoes an idempotency_key for retry reuse.
"""
from __future__ import annotations
from decimal import Decimal
import pytest
import tui_gateway.server as srv
import hermes_cli.nous_billing as nb
import agent.billing_view as bv
from agent.billing_view import BillingState, CardInfo, MonthlyCap
def _call(method: str, params: dict) -> dict:
"""Invoke a registered RPC method and return its result dict."""
envelope = srv._methods[method](1, params)
return envelope["result"]
# ---------------------------------------------------------------------------
# billing.state
# ---------------------------------------------------------------------------
def test_billing_state_serializes_decimals_as_strings(monkeypatch):
state = BillingState(
logged_in=True,
org_name="Acme",
role="OWNER",
balance_usd=Decimal("142.5"),
cli_billing_enabled=True,
charge_presets=(Decimal("100"), Decimal("250")),
min_usd=Decimal("10"),
max_usd=Decimal("10000"),
card=CardInfo(brand="visa", last4="4242"),
monthly_cap=MonthlyCap(
limit_usd=Decimal("1000"), spent_this_month_usd=Decimal("180"), is_default_ceiling=True
),
portal_url="https://portal/billing?topup=open",
)
monkeypatch.setattr(bv, "build_billing_state", lambda *a, **kw: state)
res = _call("billing.state", {})
assert res["ok"] is True and res["logged_in"] is True
# Money on the wire is STRING, not float/number.
assert res["balance_usd"] == "142.5"
assert res["balance_display"] == "$142.50"
assert res["charge_presets"] == ["100", "250"]
assert res["card"]["masked"] == "visa ····4242"
assert res["monthly_cap"]["is_default_ceiling"] is True
assert res["is_admin"] is True and res["can_charge"] is True
def test_billing_state_fail_open(monkeypatch):
def _boom(*a, **kw):
raise RuntimeError("portal down")
monkeypatch.setattr(bv, "build_billing_state", _boom)
res = _call("billing.state", {})
assert res["ok"] is True and res["logged_in"] is False
# ---------------------------------------------------------------------------
# billing.charge — typed error envelopes
# ---------------------------------------------------------------------------
def test_billing_charge_success_echoes_charge_id(monkeypatch):
monkeypatch.setattr(nb, "post_charge", lambda **kw: {"chargeId": "ch_123"})
res = _call("billing.charge", {"amount_usd": "100", "idempotency_key": "key-1"})
assert res["ok"] is True
assert res["charge_id"] == "ch_123"
assert res["idempotency_key"] == "key-1"
def test_billing_charge_mints_key_when_absent(monkeypatch):
seen = {}
def _post(**kw):
seen["key"] = kw["idempotency_key"]
return {"chargeId": "ch_x"}
monkeypatch.setattr(nb, "post_charge", _post)
res = _call("billing.charge", {"amount_usd": "50"})
assert res["ok"] is True
assert res["idempotency_key"] == seen["key"] # minted key echoed back
assert len(res["idempotency_key"]) == 36
def test_billing_charge_insufficient_scope_envelope(monkeypatch):
def _post(**kw):
raise nb.BillingScopeRequired("need scope", status=403, error="insufficient_scope")
monkeypatch.setattr(nb, "post_charge", _post)
res = _call("billing.charge", {"amount_usd": "100", "idempotency_key": "k"})
assert res["ok"] is False
assert res["error"] == "insufficient_scope"
assert res["idempotency_key"] == "k" # preserved for reuse post-stepup
def test_billing_charge_no_payment_method_envelope(monkeypatch):
def _post(**kw):
raise nb.BillingError(
"no reusable card", status=403, error="no_payment_method",
portal_url="/billing?topup=open",
)
monkeypatch.setattr(nb, "post_charge", _post)
res = _call("billing.charge", {"amount_usd": "100", "idempotency_key": "k"})
assert res["ok"] is False
assert res["error"] == "no_payment_method"
assert res["portal_url"] == "/billing?topup=open"
def test_billing_charge_rate_limited_envelope(monkeypatch):
def _post(**kw):
raise nb.BillingRateLimited("slow down", status=429, error="rate_limited", retry_after=60)
monkeypatch.setattr(nb, "post_charge", _post)
res = _call("billing.charge", {"amount_usd": "100", "idempotency_key": "k"})
assert res["error"] == "rate_limited"
assert res["retry_after"] == 60
# ---------------------------------------------------------------------------
# billing.charge_status — the poll
# ---------------------------------------------------------------------------
@pytest.mark.parametrize(
"server_resp,expected",
[
({"status": "pending"}, {"status": "pending"}),
(
{"status": "settled", "amountUsd": "50", "settledAt": "2026-06-13T00:00:00Z"},
{"status": "settled", "amount_usd": "50"},
),
({"status": "failed", "reason": "card_declined"}, {"status": "failed", "reason": "card_declined"}),
],
)
def test_billing_charge_status_maps_fields(monkeypatch, server_resp, expected):
monkeypatch.setattr(nb, "get_charge_status", lambda cid, **kw: server_resp)
res = _call("billing.charge_status", {"charge_id": "ch_1"})
assert res["ok"] is True
for k, v in expected.items():
assert res[k] == v
def test_billing_charge_status_requires_id():
res = _call("billing.charge_status", {})
assert res["ok"] is False and res["error"] == "invalid_charge_id"
# ---------------------------------------------------------------------------
# billing.auto_reload
# ---------------------------------------------------------------------------
def test_billing_auto_reload_success(monkeypatch):
seen = {}
monkeypatch.setattr(nb, "patch_auto_top_up", lambda **kw: seen.update(kw) or {"ok": True})
res = _call("billing.auto_reload", {"enabled": True, "threshold": 20, "top_up_amount": 100})
assert res["ok"] is True
assert seen == {"enabled": True, "threshold": 20, "top_up_amount": 100}
def test_billing_auto_reload_validation_error_envelope(monkeypatch):
def _patch(**kw):
raise nb.BillingError("bad", status=400, error="validation_failed")
monkeypatch.setattr(nb, "patch_auto_top_up", _patch)
res = _call("billing.auto_reload", {"enabled": True, "threshold": 20, "top_up_amount": 100})
assert res["ok"] is False and res["error"] == "validation_failed"
def test_billing_auto_reload_requires_fields():
res = _call("billing.auto_reload", {"enabled": True})
assert res["ok"] is False and res["error"] == "invalid_request"
# ---------------------------------------------------------------------------
# billing.step_up
# ---------------------------------------------------------------------------
def test_billing_step_up_granted(monkeypatch):
import hermes_cli.auth as auth
monkeypatch.setattr(auth, "step_up_nous_billing_scope", lambda **kw: True)
res = _call("billing.step_up", {})
assert res["ok"] is True and res["granted"] is True
def test_billing_step_up_downscoped(monkeypatch):
import hermes_cli.auth as auth
monkeypatch.setattr(auth, "step_up_nous_billing_scope", lambda **kw: False)
res = _call("billing.step_up", {})
assert res["ok"] is True and res["granted"] is False