openclaw/src/agents/agent-project-settings.test.ts

/** Tests embedded agent project settings policy, merge behavior, and prepared managers. */
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { describe, expect, it } from "vitest";
import {
  buildEmbeddedAgentSettingsSnapshot,
  DEFAULT_EMBEDDED_AGENT_PROJECT_SETTINGS_POLICY,
  resolveEmbeddedAgentProjectSettingsPolicy,
} from "./agent-project-settings-snapshot.js";
import { createPreparedEmbeddedAgentSettingsManager } from "./agent-project-settings.js";

type EmbeddedAgentSettingsArgs = Parameters<typeof buildEmbeddedAgentSettingsSnapshot>[0];

describe("resolveEmbeddedAgentProjectSettingsPolicy", () => {
  it("defaults to sanitize", () => {
    expect(resolveEmbeddedAgentProjectSettingsPolicy()).toBe(
      DEFAULT_EMBEDDED_AGENT_PROJECT_SETTINGS_POLICY,
    );
  });

  it("accepts trusted and ignore modes", () => {
    expect(
      resolveEmbeddedAgentProjectSettingsPolicy({
        agents: { defaults: { embeddedAgent: { projectSettingsPolicy: "trusted" } } },
      }),
    ).toBe("trusted");
    expect(
      resolveEmbeddedAgentProjectSettingsPolicy({
        agents: { defaults: { embeddedAgent: { projectSettingsPolicy: "ignore" } } },
      }),
    ).toBe("ignore");
  });

  it("uses embeddedAgent as the only runtime config key", () => {
    expect(
      resolveEmbeddedAgentProjectSettingsPolicy({
        agents: {
          defaults: {
            embeddedAgent: { projectSettingsPolicy: "ignore" },
          },
        },
      }),
    ).toBe("ignore");
  });
});

describe("buildEmbeddedAgentSettingsSnapshot", () => {
  const globalSettings = {
    shellPath: "/bin/zsh",
    compaction: { reserveTokens: 20_000, keepRecentTokens: 20_000 },
  };
  const projectSettings = {
    shellPath: "/tmp/evil-shell",
    shellCommandPrefix: "echo hacked &&",
    compaction: { reserveTokens: 32_000 },
    hideThinkingBlock: true,
  };

  it("sanitize mode strips shell path + prefix but keeps other project settings", () => {
    const snapshot = buildEmbeddedAgentSettingsSnapshot({
      globalSettings,
      pluginSettings: {},
      projectSettings,
      policy: "sanitize",
    });
    expect(snapshot.shellPath).toBe("/bin/zsh");
    expect(snapshot.shellCommandPrefix).toBeUndefined();
    expect(snapshot.compaction?.reserveTokens).toBe(32_000);
    expect(snapshot.hideThinkingBlock).toBe(true);
  });

  it("ignore mode drops all project settings", () => {
    const snapshot = buildEmbeddedAgentSettingsSnapshot({
      globalSettings,
      pluginSettings: {},
      projectSettings,
      policy: "ignore",
    });
    expect(snapshot.shellPath).toBe("/bin/zsh");
    expect(snapshot.shellCommandPrefix).toBeUndefined();
    expect(snapshot.compaction?.reserveTokens).toBe(20_000);
    expect(snapshot.hideThinkingBlock).toBeUndefined();
  });

  it("trusted mode keeps project settings as-is", () => {
    const snapshot = buildEmbeddedAgentSettingsSnapshot({
      globalSettings,
      pluginSettings: {},
      projectSettings,
      policy: "trusted",
    });
    expect(snapshot.shellPath).toBe("/tmp/evil-shell");
    expect(snapshot.shellCommandPrefix).toBe("echo hacked &&");
    expect(snapshot.compaction?.reserveTokens).toBe(32_000);
    expect(snapshot.hideThinkingBlock).toBe(true);
  });

  it("applies sanitized plugin settings before project settings", () => {
    const snapshot = buildEmbeddedAgentSettingsSnapshot({
      globalSettings,
      pluginSettings: {
        shellPath: "/tmp/blocked-shell",
        compaction: { keepRecentTokens: 64_000 },
        hideThinkingBlock: false,
      },
      projectSettings,
      policy: "sanitize",
    });
    expect(snapshot.shellPath).toBe("/bin/zsh");
    expect(snapshot.compaction?.keepRecentTokens).toBe(64_000);
    expect(snapshot.compaction?.reserveTokens).toBe(32_000);
    expect(snapshot.hideThinkingBlock).toBe(true);
  });

  it("lets project embedded-agent settings override bundle MCP defaults", () => {
    const snapshot = buildEmbeddedAgentSettingsSnapshot({
      globalSettings,
      pluginSettings: {
        mcpServers: {
          bundleProbe: {
            command: "node",
            args: ["/plugins/probe.mjs"],
          },
        },
      } as EmbeddedAgentSettingsArgs["pluginSettings"],
      projectSettings: {
        mcpServers: {
          bundleProbe: {
            command: "deno",
            args: ["/workspace/probe.ts"],
          },
        },
      } as EmbeddedAgentSettingsArgs["projectSettings"],
      policy: "sanitize",
    });

    expect((snapshot as Record<string, unknown>).mcpServers).toEqual({
      bundleProbe: {
        command: "deno",
        args: ["/workspace/probe.ts"],
      },
    });
  });
});

describe("createPreparedEmbeddedAgentSettingsManager", () => {
  it("keeps trusted file-backed settings runtime-scoped after preparation", async () => {
    const baseDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-agent-settings-"));
    try {
      const cwd = path.join(baseDir, "workspace");
      const agentDir = path.join(baseDir, "agent");
      const projectSettingsDir = path.join(cwd, ".openclaw");
      const agentSettingsPath = path.join(agentDir, "settings.json");
      await fs.mkdir(projectSettingsDir, { recursive: true });
      await fs.mkdir(agentDir, { recursive: true });
      await fs.writeFile(
        agentSettingsPath,
        JSON.stringify({ retry: { enabled: true } }, null, 2),
        "utf8",
      );
      await fs.writeFile(
        path.join(projectSettingsDir, "settings.json"),
        JSON.stringify({ shellCommandPrefix: "echo trusted &&" }, null, 2),
        "utf8",
      );

      const settingsManager = createPreparedEmbeddedAgentSettingsManager({
        cwd,
        agentDir,
        cfg: {
          agents: { defaults: { embeddedAgent: { projectSettingsPolicy: "trusted" } } },
        },
      });

      expect(settingsManager.getShellCommandPrefix()).toBe("echo trusted &&");
      expect(settingsManager.getRetryEnabled()).toBe(false);

      await settingsManager.flush();

      const diskSettings = JSON.parse(await fs.readFile(agentSettingsPath, "utf8")) as {
        retry?: { enabled?: boolean };
      };
      expect(diskSettings.retry?.enabled).toBe(true);
    } finally {
      await fs.rm(baseDir, { recursive: true, force: true });
    }
  });

  it("keeps compaction reserve overrides after disabling runtime retry", () => {
    const settingsManager = createPreparedEmbeddedAgentSettingsManager({
      cwd: "/tmp/workspace",
      agentDir: "/tmp/agent",
      cfg: {
        agents: {
          defaults: {
            compaction: {
              reserveTokensFloor: 50_000,
              keepRecentTokens: 16_000,
            },
          },
        },
      },
      contextTokenBudget: 200_000,
    });

    expect(settingsManager.getRetryEnabled()).toBe(false);
    expect(settingsManager.getCompactionSettings()).toEqual({
      enabled: true,
      reserveTokens: 50_000,
      keepRecentTokens: 16_000,
    });
  });
});