src/cli/gateway-cli/pre-bootstrap.process.test.ts

import { createHash } from "node:crypto";
import fs from "node:fs";
import path from "node:path";
import { afterAll, beforeEach, describe, expect, it } from "vitest";
import { useAutoCleanupTempDirTracker } from "../../../test/helpers/temp-dir.js";
import {
  createSourceRuntime,
  runIsolatedModuleScript,
} from "../../commands/doctor-config-preflight.process.test-support.js";

const tempDirs = useAutoCleanupTempDirTracker(afterAll);
const runtimeParent = fs.realpathSync(tempDirs.make("openclaw-selection-runtime-"));
const childTempDir = fs.realpathSync(tempDirs.make("openclaw-selection-tmp-"));

beforeEach(() => {
  // TSX keys transforms by source path. Reuse that path, but recreate package
  // assets after the previous child has joined; scenario state stays private.
  fs.rmSync(path.join(runtimeParent, "runtime"), { recursive: true, force: true });
});

function stateManifest(root: string): Record<string, string> {
  return Object.fromEntries(
    fs
      .readdirSync(root, { recursive: true, withFileTypes: true })
      .filter((entry) => entry.isFile())
      .map((entry) => {
        const filename = path.join(entry.parentPath, entry.name);
        return [
          path.relative(root, filename),
          createHash("sha256").update(fs.readFileSync(filename)).digest("hex"),
        ];
      }),
  );
}

describe("Gateway config selection before migration admission", () => {
  it.each([
    { name: "managed template", apiKey: "${REPRO_PROVIDER_KEY}", managed: true, included: false },
    {
      name: "unmanaged template",
      apiKey: "${REPRO_PROVIDER_KEY}",
      managed: false,
      included: false,
    },
    { name: "included template", apiKey: "${REPRO_PROVIDER_KEY}", managed: true, included: true },
    { name: "managed shorthand", apiKey: "$REPRO_PROVIDER_KEY", managed: true, included: false },
    {
      name: "managed object",
      apiKey: { source: "env", provider: "default", id: "REPRO_PROVIDER_KEY" },
      managed: true,
      included: false,
    },
  ])(
    "preserves $name through startup without writing config",
    async ({ apiKey, managed, included }) => {
      const root = fs.realpathSync(tempDirs.make("openclaw-managed-env-selection-"));
      const runtimeRoot = createSourceRuntime(runtimeParent);
      const stateDir = path.join(root, "state");
      fs.mkdirSync(stateDir);
      const configPath = path.join(stateDir, "openclaw.json");
      const providers = {
        minimax: {
          baseUrl: "https://api.minimax.io/anthropic",
          api: "anthropic-messages",
          apiKey,
          models: [],
        },
      };
      if (included) {
        fs.writeFileSync(path.join(stateDir, "providers.json"), JSON.stringify(providers));
      }
      fs.writeFileSync(
        configPath,
        JSON.stringify({
          gateway: { mode: "local" },
          plugins: { enabled: false },
          messages: { responsePrefix: "$${STALE_KEY}" },
          models: { providers: included ? { $include: "providers.json" } : providers },
        }),
      );
      const before = stateManifest(stateDir);
      const result = await runIsolatedModuleScript(
        {
          PATH: process.env.PATH,
          TMPDIR: childTempDir,
          TEMP: childTempDir,
          TMP: childTempDir,
          HOME: root,
          USERPROFILE: root,
          OPENCLAW_HOME: root,
          OPENCLAW_STATE_DIR: stateDir,
          OPENCLAW_CONFIG_PATH: configPath,
          OPENCLAW_WORKSPACE_DIR: path.join(root, "workspace"),
          OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
          OPENCLAW_BUNDLED_PLUGINS_DIR: path.join(root, "bundled"),
          INVOCATION_ID: "repro",
          REPRO_PROVIDER_KEY: "repro-not-a-real-key",
          STALE_KEY: "removed-service-value",
          OPENCLAW_SERVICE_MANAGED_ENV_KEYS: managed ? "REPRO_PROVIDER_KEY,STALE_KEY" : "STALE_KEY",
        },
        `
        Object.defineProperty(process, "platform", { value: "linux" });
        const { selectGatewayRunEnvironment, prepareGatewayRunBootstrap, recheckGatewayRunBootstrap } = await import("./src/cli/gateway-cli/pre-bootstrap.ts");
        const { ExitError } = await import("./src/runtime.ts");
        const runtime = { log() {}, error: console.error, exit(code) { throw new ExitError(code); } };
        let admitted = false;
        try {
          if (await selectGatewayRunEnvironment({ opts: {}, runtime }) &&
              await prepareGatewayRunBootstrap({ opts: {}, runtime })) {
            admitted = await recheckGatewayRunBootstrap({ opts: {}, runtime });
          }
        } catch (error) {
          if (!(error instanceof ExitError)) throw error;
        }
        console.log("__RESULT__" + JSON.stringify({ admitted,
          keyPresent: process.env.REPRO_PROVIDER_KEY === "repro-not-a-real-key",
          stalePresent: process.env.STALE_KEY !== undefined,
        }));
        `,
        { runtimeRoot, timeoutMs: 60_000 },
      );
      const output = `${result.stdout}\n${result.stderr}`;
      const line = result.stdout.split("\n").find((entry) => entry.startsWith("__RESULT__"));
      expect(line, output).toBeDefined();
      expect(JSON.parse(line!.slice("__RESULT__".length)), output).toEqual({
        admitted: true,
        keyPresent: true,
        stalePresent: false,
      });
      expect(stateManifest(stateDir)).toEqual(before);
    },
    75_000,
  );

  it.each([
    { name: "future backup before reset", code: 1 },
    { name: "future current config", code: 1 },
    { name: "future service-mode backup", code: 78 },
    { name: "future backup after config selection changes", code: 1 },
    { name: "discarded clobbered environment", code: 0 },
  ])(
    "prepares recovery safely for $name",
    async ({ name, code }) => {
      const root = fs.realpathSync(tempDirs.make("openclaw-recovery-selection-"));
      const runtimeRoot = createSourceRuntime(runtimeParent);
      const stateDir = path.join(root, "state");
      fs.mkdirSync(stateDir);
      const configPath = path.join(stateDir, "openclaw.json");
      const healthy = {
        gateway: { mode: "local" },
        plugins: { enabled: false },
        meta: { lastTouchedVersion: "1.0.0" },
      };
      const future = { ...healthy, meta: { lastTouchedVersion: "9999.1.1" } };
      const clobbered = { update: { channel: "stable" } };
      let current: Record<string, unknown> = clobbered;
      let backup: Record<string, unknown> = future;
      if (name === "future current config") {
        current = future;
        backup = healthy;
      } else if (name === "future service-mode backup") {
        backup = { ...future, env: { vars: { OPENCLAW_SERVICE_MARKER: "openclaw" } } };
      } else if (name === "future backup after config selection changes") {
        const selectedPath = path.join(stateDir, "selected.json");
        backup = { ...healthy, env: { vars: { OPENCLAW_CONFIG_PATH: selectedPath } } };
        fs.writeFileSync(selectedPath, JSON.stringify(clobbered));
        fs.writeFileSync(`${selectedPath}.bak`, JSON.stringify(future));
      } else if (name === "discarded clobbered environment") {
        current = {
          gateway: { mode: "local" },
          env: { vars: { OPENCLAW_GATEWAY_TOKEN: "discarded-test-token" } },
        };
        backup = healthy;
      }
      fs.writeFileSync(configPath, JSON.stringify(current));
      fs.writeFileSync(`${configPath}.bak`, JSON.stringify(backup));
      const before = stateManifest(stateDir);
      const result = await runIsolatedModuleScript(
        {
          ...process.env,
          TMPDIR: childTempDir,
          TEMP: childTempDir,
          TMP: childTempDir,
          HOME: root,
          USERPROFILE: root,
          OPENCLAW_HOME: root,
          OPENCLAW_STATE_DIR: stateDir,
          OPENCLAW_CONFIG_PATH: undefined,
          OPENCLAW_WORKSPACE_DIR: path.join(root, "workspace"),
          OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
          OPENCLAW_BUNDLED_PLUGINS_DIR: path.join(root, "bundled"),
          OPENCLAW_SERVICE_MARKER: undefined,
          OPENCLAW_GATEWAY_TOKEN: undefined,
          OPENCLAW_PROXY_ACTIVE: "1",
          OPENCLAW_ALLOW_OLDER_BINARY_DESTRUCTIVE_ACTIONS:
            name === "future service-mode backup" ? "1" : undefined,
        },
        `
        const { selectGatewayRunEnvironment } = await import("./src/cli/gateway-cli/pre-bootstrap.ts");
        const { ExitError } = await import("./src/runtime.ts");
        let code = 0;
        try {
          await selectGatewayRunEnvironment({
            opts: ${JSON.stringify(name === "future backup before reset" ? { dev: true, reset: true } : {})},
            runtime: { log() {}, error: console.error, exit(code) { throw new ExitError(code); } },
          });
        } catch (error) {
          if (!(error instanceof ExitError)) throw error;
          code = error.code;
        }
        process.stdout.write("__RESULT__" + JSON.stringify({ code,
          tokenPresent: Boolean(process.env.OPENCLAW_GATEWAY_TOKEN),
          proxyRetained: process.env.OPENCLAW_PROXY_ACTIVE === "1",
        }) + "\\n");
      `,
        { runtimeRoot, timeoutMs: 60_000 },
      );
      const output = `${result.stdout}\n${result.stderr}`;
      const line = result.stdout.split("\n").find((entry) => entry.startsWith("__RESULT__"));
      expect(line, output).toBeDefined();
      expect(JSON.parse(line!.slice("__RESULT__".length)), output).toEqual({
        code,
        tokenPresent: false,
        proxyRetained: true,
      });
      expect(stateManifest(stateDir)).toEqual(before);
    },
    75_000,
  );

  it.each([false, true])(
    "preserves every state artifact with backup=%s",
    async (withBackup) => {
      const root = fs.realpathSync(tempDirs.make("openclaw-readonly-bootstrap-"));
      const runtimeRoot = createSourceRuntime(runtimeParent);
      const stateDir = path.join(root, "state");
      fs.mkdirSync(stateDir);
      const configPath = path.join(stateDir, "openclaw.json");
      fs.writeFileSync(
        configPath,
        JSON.stringify({
          gateway: { mode: "local" },
          meta: { lastTouchedAt: "2026-02-15T00:00:00.000Z" },
          agents: { list: [{ id: "main" }, { id: "helper" }] },
          plugins: {
            enabled: false,
            installs: { example: { source: "path", installPath: path.join(root, "plugin") } },
          },
        }),
      );
      if (withBackup) {
        fs.writeFileSync(
          `${configPath}.bak`,
          JSON.stringify({
            gateway: { mode: "local" },
            agents: { defaults: { workspace: path.join(root, "workspace") } },
            messages: { ackReaction: "synthetic long-lived config baseline" },
            plugins: {
              enabled: false,
              installs: { example: { source: "path", installPath: path.join(root, "plugin") } },
            },
          }),
        );
      }
      const before = stateManifest(stateDir);
      const env = {
        ...process.env,
        TMPDIR: childTempDir,
        TEMP: childTempDir,
        TMP: childTempDir,
        HOME: root,
        USERPROFILE: root,
        OPENCLAW_HOME: root,
        OPENCLAW_STATE_DIR: stateDir,
        OPENCLAW_CONFIG_PATH: configPath,
        OPENCLAW_WORKSPACE_DIR: path.join(root, "workspace"),
        OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
        OPENCLAW_BUNDLED_PLUGINS_DIR: path.join(root, "bundled"),
        OPENCLAW_TEST_FAST: "1",
      };
      const result = await runIsolatedModuleScript(
        env,
        `
      const { selectGatewayRunEnvironment, prepareGatewayRunBootstrap } = await import("./src/cli/gateway-cli/pre-bootstrap.ts");
      const runtime = { log() {}, error() {}, exit(code) { throw new Error("unexpected exit " + code); } };
      if (!await selectGatewayRunEnvironment({ opts: {}, runtime })) throw new Error("selection refused");
      if (!await prepareGatewayRunBootstrap({ opts: {}, runtime })) throw new Error("preparation refused");
      console.log("prepared");
    `,
        { runtimeRoot, timeoutMs: 60_000 },
      );
      expect(result.stdout).toContain("prepared");
      expect(stateManifest(stateDir)).toEqual(before);
    },
    90_000,
  );

  it.each([
    {
      flag: "--allow-unconfigured",
      dispatch: "fast",
      suffix: [],
      dev: false,
      allowUnconfigured: true,
    },
    {
      flag: "--allow-unconfigured",
      dispatch: "Commander",
      suffix: ["--"],
      dev: false,
      allowUnconfigured: true,
    },
    { flag: "--dev", dispatch: "fast", suffix: [], dev: true, allowUnconfigured: false },
    { flag: "--dev", dispatch: "Commander", suffix: ["--"], dev: true, allowUnconfigured: false },
  ])(
    "passes $flag through $dispatch startup admission without config",
    async ({ flag, suffix, dev, allowUnconfigured }) => {
      const root = fs.realpathSync(tempDirs.make("openclaw-startup-allowance-"));
      const runtimeRoot = createSourceRuntime(runtimeParent);
      const stateDir = path.join(root, "state");
      fs.mkdirSync(stateDir);
      const configPath = path.join(stateDir, "openclaw.json");
      const env = {
        PATH: process.env.PATH,
        HOME: root,
        USERPROFILE: root,
        OPENCLAW_HOME: root,
        OPENCLAW_STATE_DIR: stateDir,
        OPENCLAW_CONFIG_PATH: configPath,
        OPENCLAW_WORKSPACE_DIR: path.join(root, "workspace"),
        OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
        OPENCLAW_BUNDLED_PLUGINS_DIR: path.join(root, "bundled"),
        OPENCLAW_HIDE_BANNER: "1",
        OPENCLAW_GATEWAY_TOKEN: "synthetic-startup-allowance-token",
        XDG_CONFIG_HOME: path.join(root, "xdg-config"),
        XDG_DATA_HOME: path.join(root, "xdg-data"),
        XDG_STATE_HOME: path.join(root, "xdg-state"),
        XDG_CACHE_HOME: path.join(root, "cache"),
        NPM_CONFIG_USERCONFIG: path.join(root, "npmrc"),
        TMPDIR: childTempDir,
        TEMP: childTempDir,
        TMP: childTempDir,
        NO_COLOR: "1",
      };
      // Keep parsing, environment selection, preaction, and config admission real.
      // Replace only the final Gateway action; the built rig proves listener startup.
      const result = await runIsolatedModuleScript(
        env,
        `
      import { registerHooks } from "node:module";
      const calls = globalThis[Symbol.for("openclaw.test.startupAllowanceCalls")] = [];
      registerHooks({
        resolve(specifier, context, nextResolve) {
          const parent = context.parentURL ?? "";
          if (specifier === "./run.js" &&
              (parent.endsWith("/cli/gateway-cli/run-command.ts") || parent.endsWith("/cli/gateway-cli/run-command.js"))) {
            return {
              shortCircuit: true,
              url: "data:text/javascript," + encodeURIComponent(
                'export async function runGatewayCommand(opts) {' +
                'globalThis[Symbol.for("openclaw.test.startupAllowanceCalls")].push({' +
                'dev: opts.dev === true, allowUnconfigured: opts.allowUnconfigured === true }); }'
              ),
            };
          }
          return nextResolve(specifier, context);
        },
      });
      const { runCli } = await import("./src/cli/run-main.ts");
      process.argv = [process.execPath, "openclaw", "gateway", "run", "--port", "18736", ${JSON.stringify(flag)}, ...${JSON.stringify(suffix)}];
      await runCli(process.argv);
      process.stdout.write("__RESULT__" + JSON.stringify(calls) + "\\n");
    `,
        { runtimeRoot, timeoutMs: 60_000 },
      );
      const output = `${result.stdout}\n${result.stderr}`;
      const results = result.stdout.split("\n").filter((line) => line.startsWith("__RESULT__"));
      expect(results, output).toHaveLength(1);
      expect(JSON.parse(results[0]!.slice("__RESULT__".length))).toEqual([
        { dev, allowUnconfigured },
      ]);
    },
    75_000,
  );
});