hermes-agent/tests/agent/test_credits_view.py
Siddharth Balyan 7ba5df0d52
feat(billing): /credits command — balance + portal top-up handoff (#44776)
* feat(billing): /usage → portal top-up browser handoff

Add the terminal side of the billing slice (phase 2a): start a top-up by
throwing the user to the portal billing page with the top-up modal open. The
terminal does not confirm, poll, or track payment — checkout completes in the
browser and the next /usage shows the new balance.

- nous_account.py: parse organisation.slug/name from /api/oauth/account into
  NousPortalAccountInfo; add nous_portal_topup_url() building the org-pinned
  {base}/orgs/{slug}/billing?topup=open with a null-slug fallback to the legacy
  {base}/billing?topup=open (never /orgs/None/...).
- portal_cli.py: 'hermes portal topup' — fresh account fetch, identity line
  (Topping up as <email> / org <name>), browser open with printed-URL fallback,
  no-wait closing copy. No polling/confirmation (deferred to 2b).
- account_usage.py: the shared /usage credits block now links the org-pinned
  top-up URL (auto-opens the modal) + points to the command.

Depends on NAS #409 (organisation.slug/name + ?topup=open). Do not merge until
that is live on the target env; until then /api/oauth/account returns
organisation: { id } only and the URL falls back to legacy.

* feat(billing): /credits command for balance + top-up handoff

Replace the standalone `hermes portal topup` subcommand with an in-session
/credits slash command — a focused money surface (balance in, top-up out) that
works in the CLI, TUI, and every messaging platform from one registry entry.

- commands.py: register /credits (Info category). Slack is at its 50-slash cap,
  so /credits is routed via /hermes credits on Slack only (new
  _SLACK_VIA_HERMES_ONLY set) to avoid clamping a canonical command off the
  native list and breaking Telegram parity; native everywhere else.
- account_usage.py: build_credits_view() — one portal fetch → balance lines +
  identity line + org-pinned top-up URL + depleted flag, consumed by all
  surfaces. Reuses the same snapshot/URL builder as /usage so numbers match.
- cli.py: _show_credits() — balance block + identity line + 3-button panel
  (Open top-up / Copy link / Cancel) via the existing prompt_toolkit modal.
  ASK, never auto-launch; headless falls back to printing the URL.
- gateway/slash_commands.py: _handle_credits_command() — renders the block +
  tappable top-up URL + no-wait copy; works on button and plain-text platforms.
- /usage credits line now points to /credits.
- Retire `hermes portal topup` (portal_cli.py back to baseline); the engine
  (slug/name parse + nous_portal_topup_url) stays as the shared core.

No polling, no payment confirmation (billing phase 2a). Depends on NAS #409.

* fix(credits): /credits works in the TUI slash-worker (non-interactive)

In the TUI, /credits runs in the slash-worker subprocess where there is no
live prompt_toolkit app and stdin is the JSON-RPC pipe. _show_credits called
the 3-button modal unconditionally, which fell back to reading stdin →
exception → slash.exec rejected → the command produced no output (only the
pre-existing 'Credit access paused' banner showed).

- _show_credits: when self._app is None (TUI worker / piped / non-interactive),
  render the text variant — balance block + tappable top-up URL + no-wait line,
  same affordance as the messaging surfaces — and skip the modal entirely. The
  3-button panel still renders in the interactive CLI.
- Depleted banner copy: 'run /usage for balance' → 'run /credits to top up'
  now that /credits is the dedicated money surface (+ tests).
- Regression tests: _show_credits with self._app=None renders text and never
  invokes the modal; logged-out path.

* feat(tui): credits.view RPC for the /credits tappable top-up button

Add a credits.view JSON-RPC method returning the structured CreditsView
(logged_in, balance_lines, identity_line, topup_url, depleted) so the TUI can
render a clickable <Link> top-up button instead of plain text. Account-
independent (portal fetch gated on a logged-in Nous account), fail-open to
{logged_in: false} on any hiccup. Mirrors session.usage's credits-block pattern.

Frontend (TUI-local /credits command + Ink component) lands separately.

* feat(tui): /credits command with keyboard-driven top-up confirm

TUI-local /credits: fetches the structured balance via the credits.view RPC,
prints the balance + identity + top-up URL, then arms the EXISTING confirm
overlay (Enter = open top-up in browser via openExternalUrl, Esc = cancel).
Reuses ConfirmReq — no new overlay component/state/input handler. Headless
(openExternalUrl returns false) falls back to printing the URL.

- gatewayTypes.ts: CreditsViewResponse.
- commands/credits.ts: the command (mirrors /status's rpc+guarded pattern).
- registry.ts: register creditsCommands.
- test: balance+overlay armed, headless fallback, no-url, logged-out (4 cases).

Matches the CLI /credits 'Enter to open' affordance. Phase 2a: no polling.
2026-06-12 08:51:10 +00:00

260 lines
8.9 KiB
Python

"""Tests for the /credits command — shared view core + gateway handler.
`/credits` is the focused money surface (balance in, top-up out). These tests
exercise the surface-agnostic `build_credits_view()` core and assert the gateway
handler renders the block + tappable top-up URL + no-wait copy. The CLI panel is
a thin wrapper over the same view (interactive prompt_toolkit modal — covered by
the view-core tests plus manual verification).
"""
from __future__ import annotations
import asyncio
import pytest
import agent.account_usage as account_usage
from agent.account_usage import CreditsView, build_credits_view
from hermes_cli.nous_account import NousPortalAccountInfo, NousPaidServiceAccessInfo
def _account(**kwargs) -> NousPortalAccountInfo:
kwargs.setdefault("logged_in", True)
kwargs.setdefault("source", "account_api")
kwargs.setdefault("fresh", True)
kwargs.setdefault("portal_base_url", "https://portal.example.test")
return NousPortalAccountInfo(**kwargs)
@pytest.fixture
def _logged_in_account(monkeypatch):
"""Stub the auth token + account fetch so build_credits_view runs offline."""
monkeypatch.setattr(
"hermes_cli.auth.get_provider_auth_state",
lambda provider: {"access_token": "tok", "portal_base_url": "https://portal.example.test"},
)
def _install(account):
monkeypatch.setattr(
"hermes_cli.nous_account.get_nous_portal_account_info",
lambda *a, **kw: account,
)
return _install
# ── build_credits_view core ─────────────────────────────────────────────────
def test_view_logged_out_when_no_token(monkeypatch):
monkeypatch.setattr("hermes_cli.auth.get_provider_auth_state", lambda provider: {})
view = build_credits_view()
assert view == CreditsView(logged_in=False)
def test_view_built_with_org_pinned_url_and_identity(_logged_in_account):
_logged_in_account(
_account(
org_slug="acme",
org_name="Acme Inc",
email="alice@example.test",
paid_service_access=True,
paid_service_access_info=NousPaidServiceAccessInfo(
purchased_credits_remaining=30.0,
total_usable_credits=30.0,
),
subscription=None,
)
)
view = build_credits_view()
assert view.logged_in is True
assert view.topup_url == "https://portal.example.test/orgs/acme/billing?topup=open"
assert view.identity_line == "Topping up as alice@example.test / org Acme Inc"
assert view.depleted is False
# Balance lines carry the magnitudes but NOT the /usage affordance lines.
blob = "\n".join(view.balance_lines)
assert "Top-up credits: $30.00" in blob
assert "Top up:" not in blob # the trailing /usage affordance is stripped
assert "(or run" not in blob
def test_view_depleted_flag(_logged_in_account):
_logged_in_account(
_account(
org_slug="acme",
email="alice@example.test",
paid_service_access=False,
paid_service_access_info=NousPaidServiceAccessInfo(
total_usable_credits=0.0,
),
subscription=None,
)
)
view = build_credits_view()
assert view.depleted is True
def test_view_falls_back_to_legacy_url_when_slug_null(_logged_in_account):
_logged_in_account(
_account(
org_slug=None,
email="alice@example.test",
paid_service_access=True,
paid_service_access_info=NousPaidServiceAccessInfo(
purchased_credits_remaining=5.0,
total_usable_credits=5.0,
),
subscription=None,
)
)
view = build_credits_view()
assert view.topup_url == "https://portal.example.test/billing?topup=open"
assert "/orgs/" not in view.topup_url
def test_view_fetch_failure_is_logged_out(monkeypatch):
monkeypatch.setattr(
"hermes_cli.auth.get_provider_auth_state",
lambda provider: {"access_token": "tok"},
)
def _boom(*a, **kw):
raise RuntimeError("portal down")
monkeypatch.setattr("hermes_cli.nous_account.get_nous_portal_account_info", _boom)
view = build_credits_view()
assert view.logged_in is False
# ── gateway _handle_credits_command ─────────────────────────────────────────
class _FakeEvent:
pass
def _make_gateway_stub():
"""Minimal object exposing the mixin's _handle_credits_command."""
from gateway.slash_commands import GatewaySlashCommandsMixin
class _Stub(GatewaySlashCommandsMixin):
def __init__(self):
pass
return _Stub()
def test_gateway_credits_renders_block_and_url(monkeypatch):
view = CreditsView(
logged_in=True,
balance_lines=("📈 Nous credits", "Total usable: $52.50"),
identity_line="Topping up as alice@example.test / org Acme",
topup_url="https://portal.example.test/orgs/acme/billing?topup=open",
depleted=False,
)
monkeypatch.setattr(account_usage, "build_credits_view", lambda *a, **kw: view)
stub = _make_gateway_stub()
out = asyncio.run(stub._handle_credits_command(_FakeEvent()))
assert "💳" in out
assert "Total usable: $52.50" in out
assert "Topping up as alice@example.test / org Acme" in out
assert "https://portal.example.test/orgs/acme/billing?topup=open" in out
assert "credits will appear in /credits shortly" in out
# The helper's own 📈 header line is dropped (we render our own 💳 header).
assert "📈 Nous credits" not in out
def test_gateway_credits_not_logged_in(monkeypatch):
monkeypatch.setattr(
account_usage, "build_credits_view", lambda *a, **kw: CreditsView(logged_in=False)
)
stub = _make_gateway_stub()
out = asyncio.run(stub._handle_credits_command(_FakeEvent()))
assert "Not logged into Nous Portal" in out
def test_gateway_credits_fetch_exception_is_not_logged_in(monkeypatch):
def _boom(*a, **kw):
raise RuntimeError("boom")
monkeypatch.setattr(account_usage, "build_credits_view", _boom)
stub = _make_gateway_stub()
out = asyncio.run(stub._handle_credits_command(_FakeEvent()))
assert "Not logged into Nous Portal" in out
# ── command registry ────────────────────────────────────────────────────────
def test_credits_command_registered():
from hermes_cli.commands import resolve_command, COMMAND_REGISTRY
cmd = resolve_command("credits")
assert cmd is not None and cmd.name == "credits"
# Available on every surface (not cli_only / gateway_only).
entry = next(c for c in COMMAND_REGISTRY if c.name == "credits")
assert entry.cli_only is False
assert entry.gateway_only is False
# ── CLI _show_credits non-interactive (TUI slash-worker) path ───────────────
def test_cli_show_credits_non_interactive_renders_text_not_modal(monkeypatch, capsys):
"""In the TUI slash-worker (no self._app), /credits must render the text
variant — never invoke the prompt_toolkit modal, which would read the
worker's JSON-RPC stdin and crash the command (only the depleted banner
would survive). Regression for that exact failure.
"""
import agent.account_usage as account_usage
from cli import HermesCLI
monkeypatch.setattr(
account_usage,
"build_credits_view",
lambda *a, **k: CreditsView(
logged_in=True,
balance_lines=("📈 Nous credits", "Total usable: $0.00"),
identity_line="Topping up as a@b.c / org Acme",
topup_url="https://prev.test/orgs/acme/billing?topup=open",
depleted=True,
),
)
cli = HermesCLI.__new__(HermesCLI)
cli._app = None # non-interactive, like the slash worker
# Must NOT call the modal in this context.
def _boom_modal(*a, **k):
raise AssertionError("modal must not run without a live app")
monkeypatch.setattr(HermesCLI, "_prompt_text_input_modal", _boom_modal, raising=False)
cli._show_credits()
out = capsys.readouterr().out
assert "💳 Nous credits" in out
assert "Total usable: $0.00" in out
assert "Topping up as a@b.c / org Acme" in out
assert "https://prev.test/orgs/acme/billing?topup=open" in out
assert "credits will appear in /credits shortly" in out
def test_cli_show_credits_logged_out(monkeypatch, capsys):
import agent.account_usage as account_usage
from cli import HermesCLI
monkeypatch.setattr(
account_usage, "build_credits_view", lambda *a, **k: CreditsView(logged_in=False)
)
cli = HermesCLI.__new__(HermesCLI)
cli._app = None
cli._show_credits()
assert "Not logged into Nous Portal" in capsys.readouterr().out