Files
nanobot/nanobot/cli/gateway.py
T

414 lines
18 KiB
Python

"""Typer commands for foreground and background gateway control."""
from __future__ import annotations
import subprocess
import sys
from collections.abc import Callable
from pathlib import Path
from typing import Any
import typer
from loguru import logger
from rich.console import Console
from nanobot.config.schema import Config
from nanobot.gateway import (
GatewayClientLease,
GatewayRuntime,
GatewayRuntimePaths,
GatewayStartOptions,
GatewayStatus,
)
from nanobot.gateway.service import (
GatewayServiceInstaller,
GatewayServiceOptions,
GatewayServiceResult,
ServiceManagerKind,
)
from nanobot.webui.build import BuildMode
RuntimeConfigLoader = Callable[[str | None, str | None], Config]
GatewayRunner = Callable[..., None]
GatewayConfigValidator = Callable[[Config], str | None]
GatewayRuntimeFactory = Callable[..., Any]
GatewayServiceFactory = Callable[[], Any]
WebUIBundlePreparer = Callable[[Config, BuildMode], None]
def _resolved_config_selector(config: str | None) -> Path:
"""Return the one canonical config identity used by every local client."""
if config:
return Path(config).expanduser().resolve(strict=False)
from nanobot.config.loader import get_config_path
return get_config_path().resolve(strict=False)
def create_gateway_app(
*,
console: Console,
log_handler_id: int,
load_runtime_config: RuntimeConfigLoader,
run_gateway: GatewayRunner,
validate_startup_config: GatewayConfigValidator | None = None,
runtime_factory: GatewayRuntimeFactory | None = None,
service_factory: GatewayServiceFactory | None = None,
prepare_webui_bundle: WebUIBundlePreparer | None = None,
) -> typer.Typer:
gateway_app = typer.Typer(
help="Start and manage the nanobot gateway.",
invoke_without_command=True,
no_args_is_help=False,
)
def configure_logging(verbose: bool) -> None:
if not verbose:
return
logger.remove(log_handler_id)
logger.add(
sys.stderr,
format=(
"<green>{time:YYYY-MM-DD HH:mm:ss}</green> | "
"<level>{level: <5}</level> | "
"<cyan>{extra[channel]}</cyan> | "
"<level>{message}</level>"
),
level="DEBUG",
colorize=None,
filter=lambda record: record["extra"].setdefault("channel", "-") or True,
)
def runtime_for_instance(*, workspace: str | None = None, config: str | None = None):
if runtime_factory is not None:
return runtime_factory(workspace=workspace, config=config)
resolved_config = _resolved_config_selector(config)
config_path = str(resolved_config)
workspace_path = str(Path(workspace).expanduser().resolve(strict=False)) if workspace else None
return GatewayRuntime(
paths=GatewayRuntimePaths.for_instance(
data_dir=resolved_config.parent,
workspace=workspace_path,
config_path=config_path,
)
)
def service_installer():
return service_factory() if service_factory is not None else GatewayServiceInstaller()
def interactive_build_mode() -> BuildMode:
# `nanobot gateway` is often launched by tests, supervisors, or service managers.
# The higher-level `nanobot webui` command owns interactive first-run guidance.
return "warn"
def start_options(
*,
port: int | None,
verbose: bool,
workspace: str | None,
config: str | None,
loaded_config: Config | None = None,
) -> GatewayStartOptions:
cfg = loaded_config or load_runtime_config(config, workspace)
resolved_config = str(_resolved_config_selector(config)) if config else None
resolved_workspace = str(Path(workspace).expanduser().resolve(strict=False)) if workspace else None
return GatewayStartOptions(
port=port if port is not None else cfg.gateway.port,
verbose=verbose,
workspace=resolved_workspace,
config_path=resolved_config,
)
def print_status(status: GatewayStatus) -> None:
console.print(f"Running: {'yes' if status.running else 'no'}")
console.print(f"Reason: {status.reason}")
if status.pid is not None:
console.print(f"PID: {status.pid}")
if status.port is not None:
console.print(f"Port: {status.port}")
if status.started_at is not None:
console.print(f"Started At: {status.started_at}")
if status.running:
console.print(f"Launch Mode: {status.launch_mode}")
console.print(f"Lifetime: {status.lifetime}")
console.print(f"Clients: {status.clients}")
console.print(f"State: {status.state_path}")
console.print(f"Logs: {status.log_path}")
def print_service_result(result: GatewayServiceResult) -> None:
console.print(f"Manager: {result.manager}")
if result.path is not None:
console.print(f"Path: {result.path}")
if result.commands:
console.print("Commands:")
for command in result.commands:
console.print(" " + " ".join(command))
if result.content is not None:
console.print()
console.print(result.content)
# Typer consumes these callbacks through decorator registration.
@gateway_app.callback(invoke_without_command=True)
def gateway( # pyright: ignore[reportUnusedFunction]
ctx: typer.Context,
port: int | None = typer.Option(None, "--port", "-p", help="Gateway port"),
workspace: str | None = typer.Option(None, "--workspace", "-w", help="Workspace directory"),
verbose: bool = typer.Option(False, "--verbose", "-v", help="Verbose output"),
config: str | None = typer.Option(None, "--config", "-c", help="Path to config file"),
foreground: bool = typer.Option(False, "--foreground", help="Run in the foreground"),
background: bool = typer.Option(False, "--background", help="Start as a background process"),
) -> None:
"""Start the nanobot gateway."""
if ctx.invoked_subcommand is not None:
return
if foreground and background:
console.print("[red]Error: --foreground and --background cannot be used together.[/red]")
raise typer.Exit(1)
if background:
cfg = load_runtime_config(config, workspace)
if validate_startup_config is not None:
validate_startup_config(cfg)
if prepare_webui_bundle is not None:
prepare_webui_bundle(cfg, interactive_build_mode())
runtime = runtime_for_instance(workspace=workspace, config=config)
result = runtime.start_background(
start_options(
port=port,
verbose=verbose,
workspace=workspace,
config=config,
loaded_config=cfg,
)
)
if (
result.message == "gateway_already_running"
and result.status.launch_mode == "foreground"
):
console.print(
"[yellow]Gateway is already running in the foreground; "
"an attached process cannot be detached in place.[/yellow]"
)
console.print(
"[dim]Stop it in its current terminal, then run "
"`nanobot gateway --background`.[/dim]"
)
print_status(result.status)
raise typer.Exit(1)
if (
result.message == "gateway_already_running"
and result.status.launch_mode == "unknown"
and result.status.lifetime == "explicit"
):
console.print(
"[yellow]Gateway is already running, but this older process did "
"not record whether it is attached or detached.[/yellow]"
)
console.print(
"[dim]Stop it first, then rerun `nanobot gateway --background` "
"to establish an unambiguous lifecycle.[/dim]"
)
print_status(result.status)
raise typer.Exit(1)
promoted = False
if result.ok or result.message == "gateway_already_running":
promoted = GatewayClientLease(
runtime,
kind="gateway-background",
).mark_persistent()
if result.ok:
console.print("[green]Gateway started in the background.[/green]")
print_status(runtime.status())
return
if result.message == "gateway_already_running":
if promoted:
console.print(
"[green]Existing on-demand gateway promoted to persistent "
"background mode.[/green]"
)
console.print(
"[dim]It will keep running after all local clients exit; "
"use `nanobot gateway stop` to stop it.[/dim]"
)
else:
console.print(
"[yellow]Gateway is already running in persistent "
"background mode.[/yellow]"
)
print_status(runtime.status())
return
console.print(f"[yellow]Gateway was not started: {result.message}[/yellow]")
print_status(result.status)
raise typer.Exit(1)
configure_logging(verbose)
cfg = load_runtime_config(config, workspace)
unconfigured_provider_error = None
if validate_startup_config is not None:
unconfigured_provider_error = validate_startup_config(cfg)
if unconfigured_provider_error is None:
run_gateway(cfg, port=port, webui_bundle_mode=interactive_build_mode())
else:
run_gateway(
cfg,
port=port,
webui_bundle_mode=interactive_build_mode(),
unconfigured_provider_error=unconfigured_provider_error,
)
@gateway_app.command("status")
def gateway_status( # pyright: ignore[reportUnusedFunction]
workspace: str | None = typer.Option(None, "--workspace", "-w", help="Workspace directory"),
config: str | None = typer.Option(None, "--config", "-c", help="Path to config file"),
) -> None:
"""Show the background gateway status."""
print_status(runtime_for_instance(workspace=workspace, config=config).status())
@gateway_app.command("logs")
def gateway_logs( # pyright: ignore[reportUnusedFunction]
tail: int = typer.Option(200, "--tail", help="Number of recent lines to show"),
follow: bool = typer.Option(True, "--follow/--no-follow", help="Follow new log output"),
workspace: str | None = typer.Option(None, "--workspace", "-w", help="Workspace directory"),
config: str | None = typer.Option(None, "--config", "-c", help="Path to config file"),
) -> None:
"""Show background gateway logs."""
runtime = runtime_for_instance(workspace=workspace, config=config)
if follow:
raise typer.Exit(runtime.follow_logs(tail=tail))
lines = runtime.read_log_tail(tail=tail)
if not lines:
console.print("[dim]No gateway log output available yet.[/dim]")
return
for line in lines:
console.print(line)
@gateway_app.command("stop")
def gateway_stop( # pyright: ignore[reportUnusedFunction]
timeout: int = typer.Option(20, "--timeout", help="Stop timeout in seconds"),
workspace: str | None = typer.Option(None, "--workspace", "-w", help="Workspace directory"),
config: str | None = typer.Option(None, "--config", "-c", help="Path to config file"),
) -> None:
"""Stop the background gateway."""
runtime = runtime_for_instance(workspace=workspace, config=config)
result = runtime.stop(timeout_s=timeout)
if result.ok or result.message == "gateway_not_running":
GatewayClientLease(runtime, kind="gateway-stop").clear()
if result.ok:
console.print("[green]Gateway stopped.[/green]")
else:
console.print(f"[yellow]Gateway was not stopped: {result.message}[/yellow]")
print_status(result.status)
if not result.ok and result.message != "gateway_not_running":
raise typer.Exit(1)
@gateway_app.command("restart")
def gateway_restart( # pyright: ignore[reportUnusedFunction]
port: int | None = typer.Option(None, "--port", "-p", help="Gateway port"),
workspace: str | None = typer.Option(None, "--workspace", "-w", help="Workspace directory"),
verbose: bool = typer.Option(False, "--verbose", "-v", help="Verbose output"),
config: str | None = typer.Option(None, "--config", "-c", help="Path to config file"),
timeout: int = typer.Option(20, "--timeout", help="Restart timeout in seconds"),
) -> None:
"""Restart the background gateway."""
cfg = load_runtime_config(config, workspace)
if validate_startup_config is not None:
validate_startup_config(cfg)
if prepare_webui_bundle is not None:
prepare_webui_bundle(cfg, interactive_build_mode())
runtime = runtime_for_instance(workspace=workspace, config=config)
result = runtime.restart(
start_options(
port=port,
verbose=verbose,
workspace=workspace,
config=config,
loaded_config=cfg,
),
timeout_s=timeout,
)
if result.ok:
console.print("[green]Gateway restarted in the background.[/green]")
print_status(result.status)
return
if result.message == "gateway_not_running":
console.print("[yellow]Gateway is not running; there is nothing to restart.[/yellow]")
console.print(
"[dim]Start a persistent gateway with `nanobot gateway --background`.[/dim]"
)
print_status(result.status)
raise typer.Exit(1)
if result.message == "gateway_foreground_restart_required":
console.print(
"[yellow]Gateway is attached to a foreground terminal and cannot "
"be restarted as a background process.[/yellow]"
)
console.print(
"[dim]Restart it in that terminal, or stop it and run "
"`nanobot gateway --background`.[/dim]"
)
print_status(result.status)
raise typer.Exit(1)
console.print(f"[red]Gateway restart failed: {result.message}[/red]")
print_status(result.status)
raise typer.Exit(1)
@gateway_app.command("install-service")
def gateway_install_service( # pyright: ignore[reportUnusedFunction]
port: int | None = typer.Option(None, "--port", "-p", help="Gateway port"),
workspace: str | None = typer.Option(None, "--workspace", "-w", help="Workspace directory"),
verbose: bool = typer.Option(False, "--verbose", "-v", help="Verbose output"),
config: str | None = typer.Option(None, "--config", "-c", help="Path to config file"),
name: str = typer.Option("nanobot-gateway", "--name", help="Service name"),
manager: ServiceManagerKind = typer.Option("auto", "--manager", help="auto, systemd, or launchd"),
enable: bool = typer.Option(True, "--enable/--no-enable", help="Enable the service after writing it"),
start_now: bool = typer.Option(True, "--start/--no-start", help="Start the service after writing it"),
dry_run: bool = typer.Option(False, "--dry-run", help="Print generated service without installing"),
) -> None:
"""Install a systemd user service or macOS LaunchAgent for the gateway."""
options = GatewayServiceOptions(
start=start_options(port=port, verbose=verbose, workspace=workspace, config=config),
name=name,
manager=manager,
enable=enable,
start_now=start_now,
)
try:
result = service_installer().install(options, dry_run=dry_run)
except subprocess.CalledProcessError as exc:
console.print(f"[red]Service install failed while running: {' '.join(exc.cmd)}[/red]")
raise typer.Exit(exc.returncode or 1) from exc
except OSError as exc:
console.print(f"[red]Service install failed: {exc}[/red]")
raise typer.Exit(1) from exc
if result.ok:
console.print("[green]Gateway service installed.[/green]" if not dry_run else "[green]Gateway service dry run.[/green]")
print_service_result(result)
return
console.print(f"[red]Gateway service was not installed: {result.message}[/red]")
print_service_result(result)
raise typer.Exit(1)
@gateway_app.command("uninstall-service")
def gateway_uninstall_service( # pyright: ignore[reportUnusedFunction]
name: str = typer.Option("nanobot-gateway", "--name", help="Service name"),
manager: ServiceManagerKind = typer.Option("auto", "--manager", help="auto, systemd, or launchd"),
dry_run: bool = typer.Option(False, "--dry-run", help="Print actions without uninstalling"),
) -> None:
"""Uninstall the system gateway service."""
try:
result = service_installer().uninstall(name=name, manager=manager, dry_run=dry_run)
except subprocess.CalledProcessError as exc:
console.print(f"[red]Service uninstall failed while running: {' '.join(exc.cmd)}[/red]")
raise typer.Exit(exc.returncode or 1) from exc
except OSError as exc:
console.print(f"[red]Service uninstall failed: {exc}[/red]")
raise typer.Exit(1) from exc
if result.ok:
console.print("[green]Gateway service uninstalled.[/green]" if not dry_run else "[green]Gateway service uninstall dry run.[/green]")
print_service_result(result)
return
console.print(f"[red]Gateway service was not uninstalled: {result.message}[/red]")
print_service_result(result)
raise typer.Exit(1)
return gateway_app