stack/packages/stack-cli/src/lib/dev-env-state.test.ts

import { chmodSync, mkdtempSync, readFileSync, rmSync, statSync, writeFileSync } from "fs";
import { tmpdir } from "os";
import { join } from "path";
import { afterEach, describe, expect, it, vi } from "vitest";
import { devEnvStatePath, ensureLocalDashboardSecret, readDevEnvState, recordLocalDashboardProcess, writeDevEnvState } from "./dev-env-state";

let tempDir: string | undefined;

function useTempStateFile() {
  tempDir = mkdtempSync(join(tmpdir(), "stack-dev-env-state-"));
  process.env.STACK_DEV_ENVS_PATH = join(tempDir, "dev-envs.json");
}

afterEach(() => {
  delete process.env.STACK_DEV_ENVS_PATH;
  delete process.env.LOCALAPPDATA;
  vi.restoreAllMocks();
  if (tempDir != null) {
    rmSync(tempDir, { recursive: true, force: true });
    tempDir = undefined;
  }
});

describe("dev env state", () => {
  it("uses the Windows local app data directory by default on Windows", () => {
    vi.spyOn(process, "platform", "get").mockReturnValue("win32");
    process.env.LOCALAPPDATA = "C:\\Users\\Test\\AppData\\Local";
    expect(devEnvStatePath()).toBe(join("C:\\Users\\Test\\AppData\\Local", "Stack Auth", "dev-envs.json"));
  });

  it("returns an empty v1 state when no file exists", () => {
    useTempStateFile();
    expect(readDevEnvState()).toEqual({
      version: 1,
      projectsByConfigPath: {},
    });
  });

  it("persists the dashboard secret without replacing it", () => {
    useTempStateFile();
    const first = ensureLocalDashboardSecret(9101);
    const second = ensureLocalDashboardSecret(9101);
    expect(second).toBe(first);
    expect(readDevEnvState().localDashboard).toMatchObject({
      port: 9101,
      secret: first,
    });
  });

  it("records the dashboard process without rotating the secret", () => {
    useTempStateFile();
    const secret = ensureLocalDashboardSecret(26700);
    recordLocalDashboardProcess(26700, secret, 12345, "/tmp/stack-rde-dashboard.log");

    expect(readDevEnvState().localDashboard).toMatchObject({
      port: 26700,
      secret,
      pid: 12345,
      logPath: "/tmp/stack-rde-dashboard.log",
    });
  });

  it("writes state as owner-readable JSON", () => {
    useTempStateFile();
    writeDevEnvState({
      version: 1,
      anonymousRefreshToken: "rt",
      projectsByConfigPath: {},
    });
    const statePath = process.env.STACK_DEV_ENVS_PATH;
    if (statePath == null) {
      throw new Error("STACK_DEV_ENVS_PATH should be set by useTempStateFile().");
    }
    const content = readFileSync(statePath, "utf-8");
    if (process.platform !== "win32") {
      expect(statSync(statePath).mode & 0o777).toBe(0o600);
    }
    expect(JSON.parse(content)).toMatchObject({
      version: 1,
      anonymousRefreshToken: "rt",
    });
  });

  it("repairs state file permissions before reading", () => {
    if (process.platform === "win32") {
      return;
    }
    useTempStateFile();
    const statePath = process.env.STACK_DEV_ENVS_PATH;
    if (statePath == null) {
      throw new Error("STACK_DEV_ENVS_PATH should be set by useTempStateFile().");
    }
    writeFileSync(statePath, JSON.stringify({ version: 1, projectsByConfigPath: {} }));
    chmodSync(statePath, 0o644);

    expect(readDevEnvState()).toEqual({
      version: 1,
      projectsByConfigPath: {},
    });
    expect(statSync(statePath).mode & 0o777).toBe(0o600);
  });

  it("does not enforce POSIX state file permissions on Windows", () => {
    vi.spyOn(process, "platform", "get").mockReturnValue("win32");
    useTempStateFile();
    const statePath = process.env.STACK_DEV_ENVS_PATH;
    if (statePath == null) {
      throw new Error("STACK_DEV_ENVS_PATH should be set by useTempStateFile().");
    }
    writeFileSync(statePath, JSON.stringify({ version: 1, projectsByConfigPath: {} }));
    chmodSync(statePath, 0o644);

    expect(readDevEnvState()).toEqual({
      version: 1,
      projectsByConfigPath: {},
    });
  });
});