openclaw/src/memory/manager.readonly-recovery.test.ts

import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import type { DatabaseSync } from "node:sqlite";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { OpenClawConfig } from "../config/config.js";
import { resetEmbeddingMocks } from "./embedding.test-mocks.js";
import type { MemoryIndexManager } from "./index.js";
import { getRequiredMemoryIndexManager } from "./test-manager-helpers.js";

describe("memory manager readonly recovery", () => {
  let workspaceDir = "";
  let indexPath = "";
  let manager: MemoryIndexManager | null = null;

  function createMemoryConfig(): OpenClawConfig {
    return {
      agents: {
        defaults: {
          workspace: workspaceDir,
          memorySearch: {
            provider: "openai",
            model: "mock-embed",
            store: { path: indexPath },
            sync: { watch: false, onSessionStart: false, onSearch: false },
          },
        },
        list: [{ id: "main", default: true }],
      },
    } as OpenClawConfig;
  }

  async function createManager() {
    manager = await getRequiredMemoryIndexManager({ cfg: createMemoryConfig(), agentId: "main" });
    return manager;
  }

  function createSyncSpies(instance: MemoryIndexManager) {
    const runSyncSpy = vi.spyOn(
      instance as unknown as {
        runSync: (params?: { reason?: string; force?: boolean }) => Promise<void>;
      },
      "runSync",
    );
    const openDatabaseSpy = vi.spyOn(
      instance as unknown as { openDatabase: () => DatabaseSync },
      "openDatabase",
    );
    return { runSyncSpy, openDatabaseSpy };
  }

  function expectReadonlyRecoveryStatus(lastError: string) {
    expect(manager?.status().custom?.readonlyRecovery).toEqual({
      attempts: 1,
      successes: 1,
      failures: 0,
      lastError,
    });
  }

  async function expectReadonlyRetry(params: { firstError: unknown; expectedLastError: string }) {
    const currentManager = await createManager();
    const { runSyncSpy, openDatabaseSpy } = createSyncSpies(currentManager);
    runSyncSpy.mockRejectedValueOnce(params.firstError).mockResolvedValueOnce(undefined);

    await currentManager.sync({ reason: "test" });

    expect(runSyncSpy).toHaveBeenCalledTimes(2);
    expect(openDatabaseSpy).toHaveBeenCalledTimes(1);
    expectReadonlyRecoveryStatus(params.expectedLastError);
  }

  beforeEach(async () => {
    resetEmbeddingMocks();
    workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-mem-readonly-"));
    indexPath = path.join(workspaceDir, "index.sqlite");
    await fs.mkdir(path.join(workspaceDir, "memory"), { recursive: true });
    await fs.writeFile(path.join(workspaceDir, "MEMORY.md"), "Hello memory.");
  });

  afterEach(async () => {
    if (manager) {
      await manager.close();
      manager = null;
    }
    await fs.rm(workspaceDir, { recursive: true, force: true });
  });

  it("reopens sqlite and retries once when sync hits SQLITE_READONLY", async () => {
    await expectReadonlyRetry({
      firstError: new Error("attempt to write a readonly database"),
      expectedLastError: "attempt to write a readonly database",
    });
  });

  it("reopens sqlite and retries when readonly appears in error code", async () => {
    await expectReadonlyRetry({
      firstError: { message: "write failed", code: "SQLITE_READONLY" },
      expectedLastError: "write failed",
    });
  });

  it("does not retry non-readonly sync errors", async () => {
    const currentManager = await createManager();
    const { runSyncSpy, openDatabaseSpy } = createSyncSpies(currentManager);
    runSyncSpy.mockRejectedValueOnce(new Error("embedding timeout"));

    await expect(currentManager.sync({ reason: "test" })).rejects.toThrow("embedding timeout");
    expect(runSyncSpy).toHaveBeenCalledTimes(1);
    expect(openDatabaseSpy).toHaveBeenCalledTimes(0);
  });

  it("sets busy_timeout on memory sqlite connections", async () => {
    const currentManager = await createManager();
    const db = (currentManager as unknown as { db: DatabaseSync }).db;
    const row = db.prepare("PRAGMA busy_timeout").get() as
      | { busy_timeout?: number; timeout?: number }
      | undefined;
    const busyTimeout = row?.busy_timeout ?? row?.timeout;
    expect(busyTimeout).toBe(5000);
  });
});