Skip to content

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

9.4 KB
Raw Blame
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";

vi.mock("../src/logger.js", () => ({
  logger: { info: vi.fn(), warn: vi.fn(), error: vi.fn() },
}));

import { registerAutoForgetFunction } from "../src/functions/auto-forget.js";
import {
  getSearchIndex,
  setIndexPersistence,
} from "../src/functions/search.js";
import { memoryToObservation } from "../src/state/memory-utils.js";
import type { Memory, CompressedObservation, Session, Facet } from "../src/types.js";

function mockKV() {
  const store = new Map<string, Map<string, unknown>>();
  return {
    get: async <T>(scope: string, key: string): Promise<T | null> => {
      return (store.get(scope)?.get(key) as T) ?? null;
    },
    set: async <T>(scope: string, key: string, data: T): Promise<T> => {
      if (!store.has(scope)) store.set(scope, new Map());
      store.get(scope)!.set(key, data);
      return data;
    },
    delete: async (scope: string, key: string): Promise<void> => {
      store.get(scope)?.delete(key);
    },
    list: async <T>(scope: string): Promise<T[]> => {
      const entries = store.get(scope);
      return entries ? (Array.from(entries.values()) as T[]) : [];
    },
  };
}

function mockSdk() {
  const functions = new Map<string, Function>();
  return {
    registerFunction: (idOrOpts: string | { id: string }, handler: Function) => {
      const id = typeof idOrOpts === "string" ? idOrOpts : idOrOpts.id;
      functions.set(id, handler);
    },
    registerTrigger: () => {},
    trigger: async (idOrInput: string | { function_id: string; payload: unknown }, data?: unknown) => {
      const id = typeof idOrInput === "string" ? idOrInput : idOrInput.function_id;
      const payload = typeof idOrInput === "string" ? data : idOrInput.payload;
      const fn = functions.get(id);
      if (!fn) throw new Error(`No function: ${id}`);
      return fn(payload);
    },
  };
}

function makeMemory(overrides: Partial<Memory> = {}): Memory {
  return {
    id: "mem_1",
    createdAt: new Date().toISOString(),
    updatedAt: new Date().toISOString(),
    type: "pattern",
    title: "Test memory",
    content: "This is a test memory with enough words for comparison",
    concepts: ["test"],
    files: [],
    sessionIds: ["ses_1"],
    strength: 5,
    version: 1,
    isLatest: true,
    ...overrides,
  };
}

describe("Auto-Forget Function", () => {
  let sdk: ReturnType<typeof mockSdk>;
  let kv: ReturnType<typeof mockKV>;

  beforeEach(() => {
    sdk = mockSdk();
    kv = mockKV();
    registerAutoForgetFunction(sdk as never, kv as never);
  });

  it("detects and deletes TTL-expired memories", async () => {
    const expired = makeMemory({
      id: "mem_expired",
      forgetAfter: "2020-01-01T00:00:00Z",
    });
    await kv.set("mem:memories", "mem_expired", expired);

    const result = (await sdk.trigger("mem::auto-forget", {})) as {
      ttlExpired: string[];
    };

    expect(result.ttlExpired).toContain("mem_expired");
    const deleted = await kv.get("mem:memories", "mem_expired");
    expect(deleted).toBeNull();
  });

  it("removes facets pointing at a TTL-expired memory", async () => {
    const expired = makeMemory({
      id: "mem_expired",
      forgetAfter: "2020-01-01T00:00:00Z",
    });
    const kept = makeMemory({ id: "mem_kept" });
    await kv.set("mem:memories", "mem_expired", expired);
    await kv.set("mem:memories", "mem_kept", kept);
    await kv.set("mem:facets", "fct_1", {
      id: "fct_1",
      targetId: "mem_expired",
      targetType: "memory",
      dimension: "probe",
      value: "value",
      createdAt: "2020-01-01T00:00:00Z",
    });
    await kv.set("mem:facets", "fct_2", {
      id: "fct_2",
      targetId: "mem_kept",
      targetType: "memory",
      dimension: "probe",
      value: "value",
      createdAt: "2020-01-01T00:00:00Z",
    });

    const result = (await sdk.trigger("mem::auto-forget", {})) as {
      ttlExpired: string[];
    };

    expect(result.ttlExpired).toContain("mem_expired");
    const remaining = await kv.list<Facet>("mem:facets");
    expect(remaining.map((f) => f.id)).toEqual(["fct_2"]);
  });

  it("detects contradiction between very similar memories", async () => {
    const mem1 = makeMemory({
      id: "mem_1",
      content: "Use React hooks for state management in all components",
      createdAt: "2026-01-01T00:00:00Z",
    });
    const mem2 = makeMemory({
      id: "mem_2",
      content: "Use React hooks for state management in all components",
      createdAt: "2026-02-01T00:00:00Z",
    });
    await kv.set("mem:memories", "mem_1", mem1);
    await kv.set("mem:memories", "mem_2", mem2);

    const result = (await sdk.trigger("mem::auto-forget", {})) as {
      contradictions: Array<{
        memoryA: string;
        memoryB: string;
        similarity: number;
      }>;
    };

    expect(result.contradictions.length).toBe(1);
    const older = await kv.get<Memory>("mem:memories", "mem_1");
    expect(older!.isLatest).toBe(false);
  });

  it("evicts low-value old observations", async () => {
    const session: Session = {
      id: "ses_1",
      project: "my-project",
      cwd: "/tmp",
      startedAt: "2025-01-01T00:00:00Z",
      status: "completed",
      observationCount: 1,
    };
    await kv.set("mem:sessions", "ses_1", session);

    const oldLowObs: CompressedObservation = {
      id: "obs_old",
      sessionId: "ses_1",
      timestamp: "2025-01-01T00:00:00Z",
      type: "other",
      title: "trivial event",
      facts: [],
      narrative: "nothing important",
      concepts: [],
      files: [],
      importance: 1,
    };
    await kv.set("mem:obs:ses_1", "obs_old", oldLowObs);

    const result = (await sdk.trigger("mem::auto-forget", {})) as {
      lowValueObs: string[];
    };

    expect(result.lowValueObs).toContain("obs_old");
  });

  it("dryRun mode identifies but does not delete anything", async () => {
    const expired = makeMemory({
      id: "mem_expired",
      forgetAfter: "2020-01-01T00:00:00Z",
    });
    await kv.set("mem:memories", "mem_expired", expired);

    const result = (await sdk.trigger("mem::auto-forget", { dryRun: true })) as {
      ttlExpired: string[];
      dryRun: boolean;
    };

    expect(result.dryRun).toBe(true);
    expect(result.ttlExpired).toContain("mem_expired");

    const stillExists = await kv.get("mem:memories", "mem_expired");
    expect(stillExists).not.toBeNull();
  });

  describe("search-index cleanup", () => {
    beforeEach(() => {
      getSearchIndex().clear();
      setIndexPersistence(null);
    });

    afterEach(() => {
      setIndexPersistence(null);
    });

    it("removes TTL-expired memories from the BM25 index and flushes persistence", async () => {
      const persistence = { scheduleSave: vi.fn(), save: vi.fn(async () => {}) };
      setIndexPersistence(persistence);

      const expired = makeMemory({
        id: "mem_expired",
        forgetAfter: "2020-01-01T00:00:00Z",
      });
      await kv.set("mem:memories", "mem_expired", expired);
      getSearchIndex().add(memoryToObservation(expired));
      expect(getSearchIndex().has("mem_expired")).toBe(true);

      await sdk.trigger("mem::auto-forget", {});

      expect(getSearchIndex().has("mem_expired")).toBe(false);
      expect(persistence.save).toHaveBeenCalled();
    });

    it("removes evicted low-value observations from the BM25 index", async () => {
      const session: Session = {
        id: "ses_1",
        project: "my-project",
        cwd: "/tmp",
        startedAt: "2025-01-01T00:00:00Z",
        status: "completed",
        observationCount: 1,
      };
      await kv.set("mem:sessions", "ses_1", session);

      const oldLowObs: CompressedObservation = {
        id: "obs_old",
        sessionId: "ses_1",
        timestamp: "2025-01-01T00:00:00Z",
        type: "other",
        title: "trivial event",
        facts: [],
        narrative: "nothing important",
        concepts: [],
        files: [],
        importance: 1,
      };
      await kv.set("mem:obs:ses_1", "obs_old", oldLowObs);
      getSearchIndex().add(oldLowObs);
      expect(getSearchIndex().has("obs_old")).toBe(true);

      await sdk.trigger("mem::auto-forget", {});

      expect(getSearchIndex().has("obs_old")).toBe(false);
    });

    it("does not flush persistence on dryRun", async () => {
      const persistence = { scheduleSave: vi.fn(), save: vi.fn(async () => {}) };
      setIndexPersistence(persistence);

      const expired = makeMemory({
        id: "mem_expired",
        forgetAfter: "2020-01-01T00:00:00Z",
      });
      await kv.set("mem:memories", "mem_expired", expired);
      getSearchIndex().add(memoryToObservation(expired));

      await sdk.trigger("mem::auto-forget", { dryRun: true });

      // dryRun must not mutate the index or write to disk.
      expect(getSearchIndex().has("mem_expired")).toBe(true);
      expect(persistence.save).not.toHaveBeenCalled();
    });
  });

  it("does not flag non-similar memories as contradictions", async () => {
    const mem1 = makeMemory({
      id: "mem_1",
      content: "We use TypeScript with strict mode enabled for all backend services",
    });
    const mem2 = makeMemory({
      id: "mem_2",
      content: "The deployment pipeline runs integration tests before merging to main",
    });
    await kv.set("mem:memories", "mem_1", mem1);
    await kv.set("mem:memories", "mem_2", mem2);

    const result = (await sdk.trigger("mem::auto-forget", {})) as {
      contradictions: unknown[];
    };

    expect(result.contradictions.length).toBe(0);
  });
});