PaperClipAI/cli/src/onboard-service.ts

import fs from "node:fs";
import path from "node:path";
import * as p from "@clack/prompts";
import pc from "picocolors";
import type { PaperclipConfig } from "./config/schema.js";
import { openUrl } from "./client/board-auth.js";
import { installCommand, runCommandWithDiagnostics, smokePayload } from "./commands/install.js";
import { resolvePaperclipInstanceId } from "./config/home.js";
import { readRuntimeInfo, type PaperclipRuntimeInfo } from "./runtime-info.js";
import {
  readInstallManifest,
  resolveInstallStorePaths,
  writeManagedShim,
  type InstallManifest,
} from "./install-store.js";
import {
  detectServiceManager,
  isExecutableFile,
  resolveServiceShimPath,
  type ServiceManagerDetection,
} from "./services/service-manager.js";
import { buildLocalAppUrl, buildLocalHealthUrl } from "./utils/health-url.js";
import { packageVersion } from "./version.js";

export type OnboardServiceOptions = {
  yes?: boolean;
  installService?: boolean;
};

type EnsureShimResult = { ok: boolean; installedNow: boolean; reason?: string };
type OnboardServiceDashboardConfig = {
  auth: Pick<PaperclipConfig["auth"], "baseUrlMode" | "publicBaseUrl">;
  server: Pick<PaperclipConfig["server"], "host" | "port">;
};

type OnboardServiceDashboardDependencies = {
  isInteractive: () => boolean;
  waitUntilReady: () => Promise<PaperclipRuntimeInfo | null>;
  openDashboard: (url: string) => Promise<boolean>;
  info: (message: string) => void;
  success: (message: string) => void;
  warn: (message: string) => void;
};

function envDisablesBrowser(value = process.env.PAPERCLIP_NO_BROWSER): boolean {
  const normalized = value?.trim().toLowerCase();
  return normalized === "1" || normalized === "true" || normalized === "yes";
}

async function waitUntilDashboardReady(timeoutMs = 60_000): Promise<PaperclipRuntimeInfo | null> {
  const instanceId = resolvePaperclipInstanceId();
  const detection = await detectServiceManager({ instanceId });
  if (!detection.supported) return null;
  const deadline = Date.now() + timeoutMs;
  while (Date.now() < deadline) {
    const info = readRuntimeInfo(instanceId);
    if (info) {
      const status = await detection.manager.status().catch(() => null);
      if (status?.active && status.pid === info.pid) {
        try {
          const response = await fetch(buildLocalHealthUrl(info.host, info.port), {
            signal: AbortSignal.timeout(2_000),
          });
          const body = await response.json() as { status?: unknown };
          if (response.ok && body.status === "ok") return info;
        } catch {}
      }
    }
    await new Promise((resolve) => setTimeout(resolve, 500));
  }
  return null;
}

const defaultDashboardDependencies: OnboardServiceDashboardDependencies = {
  isInteractive: () => process.stdin.isTTY === true && process.stdout.isTTY === true,
  waitUntilReady: waitUntilDashboardReady,
  openDashboard: openUrl,
  info: (message) => p.log.info(message),
  success: (message) => p.log.success(message),
  warn: (message) => p.log.warn(message),
};

export function resolveOnboardServiceDashboardUrl(
  config: OnboardServiceDashboardConfig,
  runtime?: Pick<PaperclipRuntimeInfo, "dashboardUrl"> | null,
): string {
  if (runtime?.dashboardUrl.trim()) return runtime.dashboardUrl.trim().replace(/\/+$/, "");
  if (config.auth.baseUrlMode === "explicit" && config.auth.publicBaseUrl?.trim()) {
    return config.auth.publicBaseUrl.trim().replace(/\/+$/, "");
  }
  return buildLocalAppUrl(config.server.host, config.server.port);
}

export async function handoffToOnboardedService(
  config: OnboardServiceDashboardConfig,
  dependencies: Partial<OnboardServiceDashboardDependencies> = {},
): Promise<void> {
  const deps = { ...defaultDashboardDependencies, ...dependencies };
  const runtime = await deps.waitUntilReady();
  const dashboardUrl = resolveOnboardServiceDashboardUrl(config, runtime);
  deps.info(`Paperclip dashboard: ${pc.cyan(dashboardUrl)}`);

  if (!runtime) {
    deps.warn(
      `The background service started, but the dashboard is not ready yet. ` +
        `Open ${dashboardUrl} after checking \`paperclipai service logs\`.`,
    );
    return;
  }

  if (!deps.isInteractive() || envDisablesBrowser()) return;

  if (await deps.openDashboard(dashboardUrl)) {
    deps.success("Sent the Paperclip dashboard to your browser.");
  } else {
    deps.warn(`Could not open a browser automatically. Open ${dashboardUrl} manually.`);
  }
}

// Source checkouts carry the repository placeholder version; installing
// that as an npm spec would fetch an ancient release (or nothing) instead
// of the running code. Only real calendar versions are installable.
export function isInstallableReleaseVersion(version: string): boolean {
  return /^\d{4}\.\d{1,4}\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(version);
}

type OnboardServiceDependencies = {
  detect: (instanceId: string) => Promise<ServiceManagerDetection>;
  ensureServiceShim: () => Promise<EnsureShimResult>;
  confirm: () => Promise<boolean>;
  confirmLinger: () => Promise<boolean>;
  isInteractive: () => boolean;
  info: (message: string) => void;
  success: (message: string) => void;
  warn: (message: string) => void;
};

// The service definition targets the managed shim. An ephemeral run (npx)
// never lays it down, so installing the service without this step creates
// a definition that crash-loops on a missing binary.
export async function ensureServiceShim(options: { installIfMissing?: boolean } = {}): Promise<EnsureShimResult> {
  const shimPath = resolveServiceShimPath();
  if (await isExecutableFile(shimPath)) {
    return { ok: true, installedNow: false };
  }
  if (options.installIfMissing === false) {
    return { ok: false, installedNow: false, reason: `no executable exists at ${shimPath}` };
  }
  const storeShimPath = resolveInstallStorePaths().shimPath;
  if (path.resolve(shimPath) !== path.resolve(storeShimPath)) {
    return {
      ok: false,
      installedNow: false,
      reason: `no executable exists at ${shimPath} (PAPERCLIP_SHIM_PATH), and it is outside the managed install store`,
    };
  }
  let manifest: InstallManifest | null = null;
  try {
    manifest = readInstallManifest();
  } catch {}
  try {
    if (
      manifest &&
      fs.existsSync(path.join(resolveInstallStorePaths().currentPath, "node_modules", "paperclipai", "dist", "index.js"))
    ) {
      // Only the shim is missing: smoke-test and restore it for the recorded payload,
      // keeping its version and update channel instead of reinstalling.
      await smokePayload(resolveInstallStorePaths().currentPath, manifest.version, runCommandWithDiagnostics);
      writeManagedShim();
    } else if (manifest?.source === "git" && manifest.repo) {
      // A managed git payload must be preserved as-is: reinstall the
      // exact revision the manifest records, not an npm release.
      await installCommand({ repo: manifest.repo, ref: manifest.sha ?? manifest.ref, yes: true });
    } else if (isInstallableReleaseVersion(packageVersion)) {
      // packageVersion, not cliVersion: a managed executable's cliVersion
      // carries provenance text that is not an installable npm spec.
      await installCommand({ version: packageVersion, yes: true });
    } else {
      return {
        ok: false,
        installedNow: false,
        reason:
          `this build reports version ${packageVersion}, which is not an installable release; ` +
          "run `paperclipai install` (or `paperclipai install --repo <repo> --ref <ref>` for source builds) first",
      };
    }
  } catch (error) {
    return {
      ok: false,
      installedNow: false,
      reason: error instanceof Error ? error.message : String(error),
    };
  }
  if (await isExecutableFile(shimPath)) {
    return { ok: true, installedNow: true };
  }
  return {
    ok: false,
    installedNow: false,
    reason: `the managed install completed but no executable shim appeared at ${shimPath}`,
  };
}

const defaultDependencies: OnboardServiceDependencies = {
  detect: (instanceId) => detectServiceManager({ instanceId }),
  ensureServiceShim: () => ensureServiceShim(),
  confirm: async () => {
    const answer = await p.confirm({
      message: "Install Paperclip as a background service?",
      initialValue: true,
    });
    return !p.isCancel(answer) && answer === true;
  },
  confirmLinger: async () => {
    const answer = await p.confirm({
      message: "Allow Paperclip to keep running after logout? This may request system authorization.",
      initialValue: false,
    });
    return !p.isCancel(answer) && answer === true;
  },
  isInteractive: () => process.stdin.isTTY === true && process.stdout.isTTY === true,
  info: (message) => p.log.message(pc.dim(message)),
  success: (message) => p.log.success(message),
  warn: (message) => p.log.warn(message),
};

export async function handleOnboardService(
  options: OnboardServiceOptions,
  dependencies: Partial<OnboardServiceDependencies> = {},
): Promise<boolean> {
  const deps = { ...defaultDependencies, ...dependencies };
  if (options.installService === false) return false;

  const explicitlyRequested = options.installService === true;
  const canPrompt = options.yes !== true && deps.isInteractive();
  if (!explicitlyRequested && !canPrompt) {
    deps.info(
      "Background service not installed. Use `paperclipai onboard --install-service` or `paperclipai service install` to opt in.",
    );
    return false;
  }

  const instanceId = resolvePaperclipInstanceId();
  const detection = await deps.detect(instanceId);
  if (!detection.supported) {
    if (explicitlyRequested) deps.warn(detection.reason);
    return false;
  }

  if (!explicitlyRequested && !(await deps.confirm())) return false;

  // A definition pointing at a missing binary crash-loops in the platform
  // supervisor's penalty box while doctor blames a port conflict.
  // Materialize the managed install first, or decline with the repair path
  // instead of installing a corpse.
  const shim = await deps.ensureServiceShim();
  if (!shim.ok) {
    deps.warn(
      `Background service not installed: ${shim.reason ?? "the managed install could not be completed"}. ` +
        "Run `paperclipai install`, then `paperclipai service install`.",
    );
    return false;
  }
  if (shim.installedNow) {
    deps.success("Installed the managed paperclipai payload and command shim for the service.");
  }

  await detection.manager.install({ startNow: true, startOnLogin: true });
  if (!explicitlyRequested && detection.manager.enableLinger && await deps.confirmLinger()) {
    await detection.manager.enableLinger();
  }
  deps.success(`Installed and started ${detection.manager.serviceName}.`);
  return true;
}

// Onboarding falls back to offering a foreground start when nothing else
// will serve. A just-installed service is already serving, so offering the
// start would only run the user into the already-running instance guard.
export function shouldOfferForegroundStart(options: {
  serviceInstalled: boolean;
  startAlreadyDecided: boolean;
  invokedByRun: boolean;
  interactive: boolean;
}): boolean {
  return (
    !options.startAlreadyDecided &&
    !options.serviceInstalled &&
    !options.invokedByRun &&
    options.interactive
  );
}