File size: 18,198 Bytes
5655a42
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
"""``hermes photon ...`` CLI subcommands (registered via ``ctx.register_cli_command()``):
setup (device login + project + user + sidecar), status, install-sidecar (npm install in
the sidecar dir), telemetry [on|off]. Device login is the first step of ``setup`` (no
standalone ``login`` verb); inbound is the gRPC stream, so there are no webhook subcommands.
"""
from __future__ import annotations

import argparse
import getpass
import os
import shutil
import subprocess
import sys
from typing import Optional

from hermes_cli.colors import Colors, color

from . import auth as photon_auth
from .adapter import sidecar_deps_installed
from .sidecar_paths import _NPM_ERROR_LOG_MAX_CHARS, _npm_error_log, _sidecar_dir
import contextlib


def register_cli(parser: argparse.ArgumentParser) -> None:
    """Wire up `hermes photon ...` subcommands."""
    subs = parser.add_subparsers(dest="photon_command", required=False)
    p_setup = subs.add_parser("setup", help="First-time setup (device login + project + user + sidecar)")
    p_setup.add_argument("--project-name", default=None, help="Project name (default: 'Hermes Agent')")
    p_setup.add_argument("--phone", default=None, help="Your E.164 phone number (e.g. +15551234567)")
    p_setup.add_argument("--first-name", default=None)
    p_setup.add_argument("--last-name", default=None)
    p_setup.add_argument("--email", default=None)
    p_setup.add_argument("--no-browser", action="store_true",
                         help="Don't try to open a browser for device login; print the URL only")
    p_setup.add_argument("--skip-sidecar-install", action="store_true",
                         help="Skip `npm install` inside the sidecar directory")
    subs.add_parser("status", help="Show login + project + sidecar dep state")
    subs.add_parser("install-sidecar", help="Run npm install inside the sidecar directory")
    p_telemetry = subs.add_parser("telemetry", help="Show or toggle Spectrum SDK telemetry (on/off)")
    p_telemetry.add_argument(
        "state", nargs="?", choices=("on", "off"),
        help="Turn telemetry on or off (omit to show the current state)")
    parser.set_defaults(func=dispatch)


def dispatch(args: argparse.Namespace) -> int:
    sub = getattr(args, "photon_command", None)
    handler = _cmd_status if sub is None else _COMMANDS.get(sub)  # no subcommand β€” status by default
    if handler is None:
        print(f"unknown subcommand: {sub}", file=sys.stderr)
        return 2
    return handler(args)


# -- Subcommand handlers -------------------------------------------------------------

def _run_device_login(args: argparse.Namespace) -> int:
    """Run the RFC 8628 device-code login flow and persist the token (first step of ``setup``)."""
    def _print_code(code):
        print("\nβ”Œβ”€ Photon device login ────────────────────────────────────────\n"
              f"β”‚  Open this URL:  {code.verification_uri_complete or code.verification_uri}\n"
              f"β”‚  Enter the code: {code.user_code}\n"
              "β”‚  (waiting for approval β€” Ctrl-C to cancel)\n"
              "└──────────────────────────────────────────────────────────────\n")
    try:
        photon_auth.login_device_flow(open_browser=not args.no_browser, on_user_code=_print_code)
    except Exception as e:
        print(f"login failed: {e}", file=sys.stderr)
        return 1
    # Never print any portion of the token (shoulder-surfing / screen recordings).
    print(f"βœ“ logged in β€” token saved to {photon_auth._auth_json_path()}")
    return 0


def _setup_token(args: argparse.Namespace) -> Optional[str]:
    """[1/5] Reuse a valid dashboard token or run device login; None on failure."""
    token = photon_auth.load_photon_token()
    if token:
        # The dashboard token has a short TTL (~3-4 days); a stale one makes every management
        # call 401, so validate upfront and fall back to a fresh login.
        print("[1/5] Checking existing Photon token...")
        if photon_auth.check_photon_token_valid(token):
            print("  βœ“ token is valid")
            print("[1/5] Reusing existing Photon token")
            return token
        print("  βœ— token is stale (dashboard rejected it) β€” re-authenticating")
        photon_auth.clear_photon_token()
    print("[1/5] No valid Photon token found β€” running device login...")
    if _run_device_login(args) != 0:
        return None
    token = photon_auth.load_photon_token()
    if not token:
        print("login completed but token was not stored", file=sys.stderr)
    return token


def _setup_project(token: str, name: str) -> Optional[str]:
    """[2/5] Find or create the project; returns its id or None on failure."""
    dashboard_id = photon_auth.load_dashboard_project_id()
    try:
        if dashboard_id:
            print("[2/5] Reusing configured Photon project")
        elif (existing := photon_auth.find_project_by_name(token, name)) and existing.get("id"):
            dashboard_id = existing["id"]
            print(f"[2/5] Found existing project '{name}'")
        else:
            print(f"[2/5] Creating Photon project '{name}'...")
            dashboard_id = photon_auth.create_project(token, name=name).get("id")
            print("  βœ“ project created")
    except Exception as e:
        print(f"project setup failed: {e}", file=sys.stderr)
        return None
    if not dashboard_id:
        print("could not resolve a Photon project id", file=sys.stderr)
        return None
    return dashboard_id


def _setup_credentials(token: str, dashboard_id: str, name: str) -> Optional[str]:
    """[3/5] Provision Spectrum credentials (runtime -> .env, ids -> auth.json); the dashboard
    id *is* the Spectrum id. A valid existing secret is reused: regenerating breaks a running
    sidecar's sends until restart. Returns the secret or None."""
    try:
        # 3. Spectrum is always enabled and provisioned at create-time, and the dashboard project id *is*
        #   the Spectrum project id (ids unified), so there's nothing to enable β€” the id we already have is
        #   the Spectrum id. Regenerating invalidates the credential that a running sidecar holds in its
        #   process env, causing all outbound sends to fail with AuthenticationError until the gateway is
        #   restarted (GH #50755).
        print("[3/5] Provisioning Spectrum credentials...")
        existing_id, existing_secret = photon_auth.load_project_credentials()
        secret: str = ""
        if existing_id and existing_secret:
            with contextlib.suppress(Exception):  # failure => fall through to regeneration
                photon_auth.list_users(existing_id, existing_secret)  # lightweight validation
                secret = existing_secret
        reused = bool(secret)
        if not secret:
            secret = photon_auth.regenerate_project_secret(token, dashboard_id)
        photon_auth.store_project_credentials(
            spectrum_project_id=dashboard_id, project_secret=secret, dashboard_project_id=dashboard_id, name=name)
        if reused:
            print(f"  βœ“ Spectrum ready (project id {dashboard_id}) β€” existing credentials valid")
        else:
            print(f"  βœ“ Spectrum ready (project id {dashboard_id}) β€” new secret saved")
            print("  ⚠ Project secret was regenerated. If the gateway is running, "
                  "restart it so the sidecar picks up the new secret:\n"
                  "      hermes gateway restart")
    except Exception as e:
        print(f"spectrum provisioning failed: {e}", file=sys.stderr)
        return None
    return secret


def _cmd_setup(args: argparse.Namespace) -> int:
    name = args.project_name or photon_auth.DEFAULT_PROJECT_NAME
    token = _setup_token(args)
    dashboard_id = token and _setup_project(token, name)
    secret = dashboard_id and _setup_credentials(token, dashboard_id, name)
    if not secret:
        return 1
    # 4. Register the operator's phone number as a Spectrum user (idempotent).
    phone = args.phone or _prompt(color("[4/5] Your iMessage phone number (E.164, e.g. +15551234567): ", Colors.CYAN))
    agent_number = registered_phone = registered_user_id = None
    if not phone:
        print("      Skipped user registration (no phone given). Re-run with --phone later.")
    else:
        try:  # name/email are optional and never prompted for (--first-name / --email)
            user, created = photon_auth.register_user_if_absent(
                dashboard_id, secret, phone_number=phone, first_name=args.first_name,
                last_name=args.last_name, email=args.email)
        except ValueError as e:
            print(f"      invalid phone number: {e}", file=sys.stderr)
            return 1
        except Exception as e:
            print(f"      user registration failed: {e}", file=sys.stderr)
            return 1
        print("  βœ“ phone registered" if created else "  βœ“ phone already registered")
        registered_phone = phone
        registered_user_id = user.get("id")
        # The number to text the agent is the user's assigned line ("TEXTS ON"); shared-number
        # plans have no dedicated /lines entry.
        agent_number = photon_auth.user_assigned_line(user)
        # Otherwise the gateway denies the operator's own inbound and has no cron home space.
        _autoconfigure_access(phone)
    # 5. Surface the agent's iMessage number.
    if not agent_number:
        try:
            line = photon_auth.get_imessage_line(token, dashboard_id)
            if line:
                agent_number = line.get("phoneNumber")
        except Exception as e:
            print(f"      (could not fetch the assigned line: {e})", file=sys.stderr)
    if agent_number:
        print("\n" + "\n".join((
            color("β”Œβ”€ Your agent's iMessage number ───────────────────────────────", Colors.GREEN),
            color("β”‚  πŸ“± ", Colors.GREEN) + color(str(agent_number), Colors.GREEN, Colors.BOLD),
            color("β”‚  Text this number from your phone to talk to your agent.", Colors.GREEN),
            color("└──────────────────────────────────────────────────────────────", Colors.GREEN))))
    else:
        print("      No iMessage line assigned yet β€” check the Photon dashboard.")
    if registered_phone:
        try:
            photon_auth.store_user_numbers(
                phone_number=registered_phone, assigned_phone_number=agent_number,
                user_id=str(registered_user_id) if registered_user_id else None, dashboard_project_id=dashboard_id)
        except Exception as e:
            print(f"      (could not save Photon status metadata: {e})", file=sys.stderr)
    # 6. Sidecar deps (spectrum-ts).
    if args.skip_sidecar_install:
        print("[5/5] Skipping sidecar npm install (--skip-sidecar-install)")
    else:
        print("[5/5] Installing Node sidecar deps (spectrum-ts)...")
        rc = _install_sidecar()
        if rc != 0:
            return rc
    # 7. Enable the platform in config.yaml, or the channel silently stays offline.
    try:
        from hermes_cli.config import write_platform_config_field
        write_platform_config_field("photon", "enabled", True, raw=True)
        print("  βœ“ photon platform enabled in config.yaml")
    except Exception as e:
        print(f"      (could not enable Photon in config: {e})", file=sys.stderr)
    print("\nβœ“ Photon setup complete.\n  Start the gateway:  hermes gateway start")
    return 0


def _autoconfigure_access(phone: str) -> None:
    """Set PHOTON_ALLOWED_USERS and PHOTON_HOME_CHANNEL to the operator's number, each only
    when unset so a hand-tuned value is never clobbered on re-run."""
    try:
        from hermes_cli.config import get_env_value, save_env_value
    except ImportError:
        return
    for key, label in (("PHOTON_ALLOWED_USERS", "allowlisted your number"),
                       ("PHOTON_HOME_CHANNEL", "set your DM as the cron home channel")):
        try:
            if get_env_value(key):
                print(f"      {key} already set β€” leaving it as-is.")
                continue
            save_env_value(key, phone)
            print(f"  βœ“ {label} ({key})")
        except Exception as e:
            print(f"      could not set {key}: {e}", file=sys.stderr)


def _cmd_status(_args: argparse.Namespace) -> int:
    phone, assigned = photon_auth.load_user_numbers()
    if not (phone and assigned):
        spectrum_id, project_secret = photon_auth.load_project_credentials()
        if spectrum_id and project_secret:
            try:
                photon_auth.refresh_user_numbers(spectrum_id, project_secret)
            except Exception as e:
                print(f"      (could not refresh Photon user numbers: {e})", file=sys.stderr)
    # auth.print_credential_summary's emit callback is the only sink that sees
    # credential-derived strings (keeps cli.py taint-free for CodeQL).
    photon_auth.print_credential_summary(print)
    node_bin = os.getenv("PHOTON_NODE_BIN") or shutil.which("node")
    print(f"  node binary         : {node_bin or 'βœ— missing (install Node 18+)'}")
    print(f"  sidecar deps        : {'βœ“ installed' if sidecar_deps_installed() else 'βœ— run `hermes photon install-sidecar`'}")
    print(f"  telemetry           : {'on' if _telemetry_enabled() else 'off'} (`hermes photon telemetry on|off`)")
    return 0


def _telemetry_enabled() -> bool:
    """PHOTON_TELEMETRY from env / ~/.hermes/.env; truthy set mirrors the sidecar's."""
    try:
        from hermes_cli.config import get_env_value
        raw = get_env_value("PHOTON_TELEMETRY")
    except ImportError:
        raw = os.getenv("PHOTON_TELEMETRY")
    return (raw or "").strip().lower() in ("1", "true", "yes", "on")


def _cmd_telemetry(args: argparse.Namespace) -> int:
    state = getattr(args, "state", None)
    if state is None:
        print(f"Photon telemetry: {'on' if _telemetry_enabled() else 'off'}")
        print("  Toggle with `hermes photon telemetry on` / `hermes photon telemetry off`.")
        return 0
    try:
        from hermes_cli.config import save_env_value
        save_env_value("PHOTON_TELEMETRY", "true" if state == "on" else "false")
    except Exception as e:
        print(f"could not save PHOTON_TELEMETRY: {e}", file=sys.stderr)
        return 1
    print(f"βœ“ Spectrum telemetry turned {state} (PHOTON_TELEMETRY in ~/.hermes/.env)")
    print("  Restart the gateway for the sidecar to pick it up:  hermes gateway restart")
    return 0


def _install_sidecar() -> int:
    npm = shutil.which("npm") or "npm"
    if not shutil.which(npm):
        print("npm is not on PATH. Install Node.js 18+ (https://nodejs.org/) and re-run.", file=sys.stderr)
        return 1
    # spectrum-ts is pinned exactly (the SDK ships breaking majors); upgrades are deliberate β€”
    # never `@latest` (see README "Upgrading spectrum-ts"). `npm ci` installs the lockfile
    # verbatim; `npm install` is the fallback for a missing/drifted lockfile.
    print(f"  $ cd {_sidecar_dir()} && {npm} ci")

    def _run(verb: str) -> subprocess.CompletedProcess:
        # stdout streams to the terminal; stderr is captured so the failure reason can be
        # persisted for check_requirements() to surface later.
        proc = subprocess.run(  # noqa: S603
            [npm, verb], cwd=str(_sidecar_dir()), check=False, stderr=subprocess.PIPE, text=True)
        if proc.stderr:
            print(proc.stderr, end="", file=sys.stderr)
        return proc
    proc = _run("ci")
    if proc.returncode != 0:
        print(f"  npm ci failed β€” falling back to:  {npm} install")
        proc = _run("install")
    error = (proc.stderr or "").strip()[:_NPM_ERROR_LOG_MAX_CHARS]  # bounded to what check_requirements surfaces
    if proc.returncode != 0:
        print("npm install failed", file=sys.stderr)
    with contextlib.suppress(OSError):
        if proc.returncode == 0:
            _npm_error_log().unlink()
        elif error:
            _npm_error_log().write_text(error, encoding="utf-8")
    return proc.returncode


_COMMANDS = {
    "setup": _cmd_setup, "status": _cmd_status, "install-sidecar": lambda _args: _install_sidecar(),
    "telemetry": _cmd_telemetry}


def gateway_setup() -> None:
    """Run Photon first-time setup from the unified `hermes gateway setup` wizard (same flow
    as ``hermes photon setup``; phone is prompted when stdin is a TTY)."""
    _cmd_setup(argparse.Namespace(
        photon_command="setup", project_name=None, phone=None, first_name=None, last_name=None,
        email=None, no_browser=False, skip_sidecar_install=False))


def _prompt(prompt: str, *, secret: bool = False) -> str:
    if not sys.stdin.isatty():
        return ""
    try:
        return (getpass.getpass(prompt) if secret else input(prompt)).strip()
    except (KeyboardInterrupt, EOFError):
        print()
        return ""


# ---- BEGIN PLUGIN-COMPAT (revert-scheduled; see COMPAT_MANIFEST.md) ----
# Names external plugins imported from this module before the Sep 2026 decomposition.
# Internal code MUST NOT use these (scripts/check_compat_pointers.py fails CI if it does).
# The whole block is removed by reverting the commit that added it.
from pathlib import Path  # noqa: F401,E402


_PLUGIN_COMPAT_LAZY = {
    'resolve_sidecar_dir': ('plugins.platforms.photon.sidecar_paths', 'resolve_sidecar_dir'),
}


def __getattr__(name):  # PEP 562 β€” lazy so no import cycles
    target = _PLUGIN_COMPAT_LAZY.get(name)
    if target is None:
        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
    import importlib
    from hermes_cli.plugin_compat import warn_once
    warn_once(__name__, name, *target)
    return getattr(importlib.import_module(target[0]), target[1])
# ---- END PLUGIN-COMPAT ----