Skip to content

#1 Persistent memory for AI coding agents based on real-world benchmarks

20.5 KB
Raw Blame
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import { mkdtempSync, mkdirSync, rmSync, readFileSync, existsSync, writeFileSync } from "node:fs";
import { tmpdir, platform } from "node:os";
import { join } from "node:path";

// Connect adapters for Qwen Code, Antigravity, and Kiro. Each writes
// the canonical MCP block (npx @agentmemory/mcp + env defaults) into
// the agent's documented config path.

function freshHome(): string {
  return mkdtempSync(join(tmpdir(), "am-connect-"));
}

describe("connect: Qwen Code", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.qwen/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/qwen.js");
    expect(adapter.detect()).toBe(false);
  });

  it("writes mcpServers.agentmemory to ~/.qwen/settings.json", async () => {
    mkdirSync(join(home, ".qwen"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/qwen.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfg = JSON.parse(
      readFileSync(join(home, ".qwen", "settings.json"), "utf-8"),
    );
    expect(cfg.mcpServers.agentmemory.command).toBe("npx");
    expect(cfg.mcpServers.agentmemory.args).toContain("@agentmemory/mcp");
    expect(cfg.mcpServers.agentmemory.env.AGENTMEMORY_URL).toMatch(
      /\$\{AGENTMEMORY_URL:-/,
    );
    expect(cfg.mcpServers.agentmemory.env.AGENTMEMORY_TOOLS).toMatch(
      /\$\{AGENTMEMORY_TOOLS:-all\}/,
    );
  });
});

describe("connect: Antigravity", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it.each(["antigravity", "antigravity-ide", "legacy"])("detects %s and writes the shared config while preserving other servers", async (surface) => {
    const legacyDir = platform() === "darwin"
      ? join(home, "Library", "Application Support", "Antigravity", "User")
      : join(home, ".config", "Antigravity", "User");
    mkdirSync(surface === "legacy" ? legacyDir : join(home, ".gemini", surface), { recursive: true });
    const configDir = join(home, ".gemini", "config");
    mkdirSync(configDir, { recursive: true });
    writeFileSync(join(configDir, "mcp_config.json"), JSON.stringify({ mcpServers: { existing: { command: "custom" } } }));
    const { adapter } = await import("../src/cli/connect/antigravity.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false, withHooks: true });
    expect(result.kind).toBe("installed");
    const cfg = JSON.parse(
      readFileSync(join(configDir, "mcp_config.json"), "utf-8"),
    );
    expect(cfg.mcpServers.agentmemory.command).toBe("npx");
    expect(cfg.mcpServers.existing).toEqual({ command: "custom" });
    expect(existsSync(join(legacyDir, "mcp_config.json"))).toBe(false);
    expect(JSON.parse(readFileSync(join(configDir, "hooks.json"), "utf8")).agentmemory.enabled).toBe(true);
    expect(cfg.mcpServers.agentmemory.env).toEqual({});
  });
});

describe("connect: Kiro", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.kiro/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/kiro.js");
    expect(adapter.detect()).toBe(false);
  });

  it("writes mcpServers.agentmemory to ~/.kiro/settings/mcp.json", async () => {
    mkdirSync(join(home, ".kiro"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/kiro.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfgPath = join(home, ".kiro", "settings", "mcp.json");
    expect(existsSync(cfgPath)).toBe(true);
    const cfg = JSON.parse(readFileSync(cfgPath, "utf-8"));
    expect(cfg.mcpServers.agentmemory.command).toBe("npx");
    expect(cfg.mcpServers.agentmemory.args).toContain("@agentmemory/mcp");
  });
});

describe("connect: Warp", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.warp/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/warp.js");
    expect(adapter.detect()).toBe(false);
  });

  it("writes mcpServers.agentmemory to ~/.warp/.mcp.json", async () => {
    mkdirSync(join(home, ".warp"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/warp.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfgPath = join(home, ".warp", ".mcp.json");
    expect(existsSync(cfgPath)).toBe(true);
    const cfg = JSON.parse(readFileSync(cfgPath, "utf-8"));
    expect(cfg.mcpServers.agentmemory.command).toBe("npx");
    expect(cfg.mcpServers.agentmemory.args).toContain("@agentmemory/mcp");
    expect(cfg.mcpServers.agentmemory.env.AGENTMEMORY_URL).toMatch(
      /\$\{AGENTMEMORY_URL:-/,
    );
  });
});

describe("connect: Cline", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    vi.stubEnv("CLINE_MCP_SETTINGS_PATH", undefined);
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    vi.unstubAllEnvs();
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.cline/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/cline.js");
    expect(adapter.detect()).toBe(false);
  });

  it("writes to the native Cline CLI settings path", async () => {
    mkdirSync(join(home, ".cline"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/cline.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfg = JSON.parse(
      readFileSync(join(home, ".cline", "data", "settings", "cline_mcp_settings.json"), "utf-8"),
    );
    expect(cfg.mcpServers.agentmemory.command).toBe("npx");
    expect(cfg.mcpServers.agentmemory.args).toContain("@agentmemory/mcp");
    expect(existsSync(join(home, ".cline", "mcp.json"))).toBe(false);
  });

  it("uses an explicit settings path without a default Cline directory", async () => {
    const configPath = join(home, "custom-cline", "nested", "mcp.json");
    vi.stubEnv("CLINE_MCP_SETTINGS_PATH", configPath);
    const { adapter } = await import("../src/cli/connect/cline.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result).toMatchObject({ kind: "installed", mutatedPath: configPath });
    expect(JSON.parse(readFileSync(configPath, "utf-8")).mcpServers.agentmemory.args).toContain("@agentmemory/mcp");
    expect(existsSync(join(home, ".cline"))).toBe(false);
  });

  it("falls back to native settings when the override is empty", async () => {
    vi.stubEnv("CLINE_MCP_SETTINGS_PATH", "");
    mkdirSync(join(home, ".cline"));
    const { adapter } = await import("../src/cli/connect/cline.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result).toMatchObject({
      kind: "installed",
      mutatedPath: join(home, ".cline", "data", "settings", "cline_mcp_settings.json"),
    });
  });

  it.each(["default", "override"])("preserves existing servers and settings at the %s path", async (location) => {
    const dir = location === "default" ? join(home, ".cline", "data", "settings") : join(home, "custom-cline");
    const configPath = join(dir, "cline_mcp_settings.json");
    mkdirSync(dir, { recursive: true });
    if (location === "override") vi.stubEnv("CLINE_MCP_SETTINGS_PATH", configPath);
    const existing = { mcpServers: { other: { command: "custom", args: ["server"], disabled: true, autoApprove: ["read"] } }, customSetting: true };
    const before = JSON.stringify(existing);
    writeFileSync(configPath, before);
    const { adapter } = await import("../src/cli/connect/cline.js");
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    if (result.kind !== "installed") throw new Error("installation failed");
    expect(readFileSync(result.backupPath!, "utf-8")).toBe(before);
    expect(JSON.parse(readFileSync(configPath, "utf-8"))).toMatchObject(existing);
    const installed = readFileSync(configPath, "utf-8");
    expect((await adapter.install({ dryRun: false, force: false })).kind).toBe("already-wired");
    expect(readFileSync(configPath, "utf-8")).toBe(installed);
  });

  it("does not create an override directory during dry-run", async () => {
    const configPath = join(home, "custom-cline", "mcp.json");
    vi.stubEnv("CLINE_MCP_SETTINGS_PATH", configPath);
    const { adapter } = await import("../src/cli/connect/cline.js");
    expect(await adapter.install({ dryRun: true, force: false })).toMatchObject({ kind: "installed", mutatedPath: configPath });
    expect(existsSync(join(home, "custom-cline"))).toBe(false);
  });
});

describe("connect: Droid (Factory.ai)", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.factory/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/droid.js");
    expect(adapter.detect()).toBe(false);
  });

  it("writes mcpServers.agentmemory to ~/.factory/mcp.json with type:stdio", async () => {
    mkdirSync(join(home, ".factory"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/droid.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfg = JSON.parse(
      readFileSync(join(home, ".factory", "mcp.json"), "utf-8"),
    );
    expect(cfg.mcpServers.agentmemory.command).toBe("npx");
    expect(cfg.mcpServers.agentmemory.args).toContain("@agentmemory/mcp");
    // Droid requires `type` per its documented schema
    expect(cfg.mcpServers.agentmemory.type).toBe("stdio");
  });

  it("--with-hooks additionally writes ~/.factory/hooks.json with Droid's native events", async () => {
    mkdirSync(join(home, ".factory"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/droid.js");
    const result = await adapter.install({
      dryRun: false,
      force: false,
      withHooks: true,
    });
    expect(result.kind).toBe("installed");
    const hooksPath = join(home, ".factory", "hooks.json");
    expect(existsSync(hooksPath)).toBe(true);
    const hooks = JSON.parse(readFileSync(hooksPath, "utf-8"));
    for (const event of [
      "SessionStart",
      "UserPromptSubmit",
      "PreToolUse",
      "PostToolUse",
      "SessionEnd",
    ]) {
      expect(Object.keys(hooks.hooks)).toContain(event);
    }
  });

  it("without --with-hooks, does not write ~/.factory/hooks.json", async () => {
    mkdirSync(join(home, ".factory"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/droid.js");
    await adapter.install({ dryRun: false, force: false });
    expect(existsSync(join(home, ".factory", "hooks.json"))).toBe(false);
  });

  it("re-running install with --with-hooks on an already-wired MCP config still refreshes hooks.json", async () => {
    mkdirSync(join(home, ".factory"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/droid.js");
    await adapter.install({ dryRun: false, force: false });
    const result = await adapter.install({
      dryRun: false,
      force: false,
      withHooks: true,
    });
    expect(result.kind).toBe("already-wired");
    expect(existsSync(join(home, ".factory", "hooks.json"))).toBe(true);
  });
});

describe("connect: Zed", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.config/zed/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/zed.js");
    expect(adapter.detect()).toBe(false);
  });

  it("writes context_servers.agentmemory to ~/.config/zed/settings.json", async () => {
    mkdirSync(join(home, ".config", "zed"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/zed.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfg = JSON.parse(
      readFileSync(join(home, ".config", "zed", "settings.json"), "utf-8"),
    );
    expect(cfg.context_servers.agentmemory.command).toBe("npx");
    expect(cfg.context_servers.agentmemory.args).toContain("@agentmemory/mcp");
    expect(cfg.mcpServers).toBeUndefined();
  });
});

describe("connect: Continue.dev", () => {
  let home: string;
  const ORIG = process.env["HOME"];
  const ORIG_USERPROFILE = process.env["USERPROFILE"];
  beforeEach(() => {
    home = freshHome();
    vi.resetModules();
    process.env["HOME"] = home;
    // os.homedir() on win32 reads USERPROFILE, not HOME — without this,
    // adapter.detect()/install() resolve the real user's home directory
    // instead of the isolated temp one.
    process.env["USERPROFILE"] = home;
  });
  afterEach(() => {
    process.env["HOME"] = ORIG;
    if (ORIG_USERPROFILE === undefined) delete process.env["USERPROFILE"];
    else process.env["USERPROFILE"] = ORIG_USERPROFILE;
    rmSync(home, { recursive: true, force: true });
  });

  it("does not detect when ~/.continue/ is absent", async () => {
    const { adapter } = await import("../src/cli/connect/continue.js");
    expect(adapter.detect()).toBe(false);
  });

  it("creates config.yaml from scratch when neither yaml nor json exists", async () => {
    mkdirSync(join(home, ".continue"), { recursive: true });
    const { adapter } = await import("../src/cli/connect/continue.js");
    expect(adapter.detect()).toBe(true);
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const yamlPath = join(home, ".continue", "config.yaml");
    expect(existsSync(yamlPath)).toBe(true);
    expect(existsSync(join(home, ".continue", "config.json"))).toBe(false);
    const yaml = readFileSync(yamlPath, "utf-8");
    expect(yaml).toContain("mcpServers:");
    expect(yaml).toContain("name: agentmemory");
    expect(yaml).toContain("@agentmemory/mcp");
    expect(yaml).toContain("AGENTMEMORY_URL");
  });

  it("modifies existing legacy config.json", async () => {
    mkdirSync(join(home, ".continue"), { recursive: true });
    const { writeFileSync } = await import("node:fs");
    writeFileSync(
      join(home, ".continue", "config.json"),
      JSON.stringify({ models: [], mcpServers: [] }),
    );
    const { adapter } = await import("../src/cli/connect/continue.js");
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("installed");
    const cfg = JSON.parse(
      readFileSync(join(home, ".continue", "config.json"), "utf-8"),
    );
    expect(Array.isArray(cfg.mcpServers)).toBe(true);
    const entry = cfg.mcpServers.find(
      (s: { name: string }) => s.name === "agentmemory",
    );
    expect(entry.command).toBe("npx");
    expect(entry.args).toContain("@agentmemory/mcp");
  });

  it("returns stub when config.yaml already exists (refuses silent yaml mutation)", async () => {
    mkdirSync(join(home, ".continue"), { recursive: true });
    const { writeFileSync } = await import("node:fs");
    writeFileSync(
      join(home, ".continue", "config.yaml"),
      "models: []\nmcpServers:\n  - name: existing\n    command: noop\n",
    );
    const { adapter } = await import("../src/cli/connect/continue.js");
    const result = await adapter.install({ dryRun: false, force: false });
    expect(result.kind).toBe("stub");
    // user's yaml must be untouched
    const yaml = readFileSync(
      join(home, ".continue", "config.yaml"),
      "utf-8",
    );
    expect(yaml).toContain("existing");
    expect(yaml).not.toContain("agentmemory");
  });
});

describe("connect: all eight new agents registered in ADAPTERS", () => {
  beforeEach(() => {
    vi.resetModules();
  });

  it("knownAgents includes qwen, antigravity, kiro, warp, cline, continue, zed, droid", async () => {
    const { knownAgents } = await import("../src/cli/connect/index.js");
    const agents = knownAgents();
    for (const name of [
      "qwen",
      "antigravity",
      "kiro",
      "warp",
      "cline",
      "continue",
      "zed",
      "droid",
    ]) {
      expect(agents).toContain(name);
    }
  });
});