Skip to content

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

6.1 KB
Raw Blame
import { lstat, readFile } from "node:fs/promises";
import { basename, dirname, extname, join, resolve } from "node:path";
import type { IIIClient } from "iii-sdk";
import type { MemoryProvider } from "../types.js";
import type { StateKV } from "../state/kv.js";
import { recordAudit } from "./audit.js";
import { allowedFileRoots, confinePath, expandHome, writeConfinedFile } from "./path-guard.js";

const SENSITIVE_PATH_TERMS = [
  "secret",
  "credential",
  "private_key",
  ".env",
  "id_rsa",
  "token",
];

const COMPRESS_FILE_SYSTEM_PROMPT = `You compress markdown while preserving structure.
Rules:
- Keep all headings exactly as-is.
- Keep all URLs exactly as-is.
- Keep all fenced code blocks exactly as-is.
- Do not remove sections; shorten prose under each section.
- Output only markdown, no wrappers or explanations.`;

function stripMarkdownFence(text: string): string {
  const trimmed = text.trim();
  const match = trimmed.match(/^```(?:markdown|md)?\s*([\s\S]*?)\s*```$/i);
  return match ? match[1].trim() : trimmed;
}

function extractUrls(text: string): string[] {
  return Array.from(new Set(text.match(/https?:\/\/[^\s)]+/g) || []));
}

function extractHeadings(text: string): string[] {
  return text
    .split("\n")
    .map((line) => line.trim())
    .filter((line) => /^#{1,6}\s+/.test(line));
}

function extractCodeBlocks(text: string): string[] {
  return text.match(/```[\s\S]*?```/g) || [];
}

function validateCompression(original: string, compressed: string): string[] {
  const errors: string[] = [];

  const originalHeadings = extractHeadings(original);
  const compressedHeadings = extractHeadings(compressed);
  for (const heading of originalHeadings) {
    if (!compressedHeadings.includes(heading)) {
      errors.push(`missing heading: ${heading}`);
    }
  }

  const originalUrls = extractUrls(original).sort();
  const compressedUrls = extractUrls(compressed).sort();
  if (originalUrls.length !== compressedUrls.length) {
    errors.push("url count changed");
  } else {
    for (let i = 0; i < originalUrls.length; i++) {
      if (originalUrls[i] !== compressedUrls[i]) {
        errors.push("url set changed");
        break;
      }
    }
  }

  const originalBlocks = extractCodeBlocks(original);
  const compressedBlocks = extractCodeBlocks(compressed);
  if (originalBlocks.length !== compressedBlocks.length) {
    errors.push("code block count changed");
  } else {
    for (let i = 0; i < originalBlocks.length; i++) {
      if (originalBlocks[i] !== compressedBlocks[i]) {
        errors.push("code block content changed");
        break;
      }
    }
  }

  return errors;
}

function writeFailure(err: unknown, fallback: string): string {
  const code = (err as NodeJS.ErrnoException).code;
  if (code === "ELOOP" || code === "EINVAL") return "symlinks are not supported";
  if (code) return fallback;
  return err instanceof Error ? err.message : fallback;
}

function resolveBackupPath(filePath: string): string {
  const base = basename(filePath, extname(filePath));
  const name = base.endsWith(".original")
    ? `${base}.backup`
    : `${base}.original`;
  return join(dirname(filePath), `${name}.md`);
}

export function registerCompressFileFunction(
  sdk: IIIClient,
  kv: StateKV,
  provider: MemoryProvider,
): void {
  sdk.registerFunction(
    "mem::compress-file",
    async (data: { filePath: string }) => {
      if (!data?.filePath || typeof data.filePath !== "string") {
        return { success: false, error: "filePath is required" };
      }

      const requestedPath = resolve(expandHome(data.filePath));
      const lowerPath = requestedPath.toLowerCase();
      if (extname(requestedPath).toLowerCase() !== ".md") {
        return { success: false, error: "filePath must point to a .md file" };
      }
      if (SENSITIVE_PATH_TERMS.some((term) => lowerPath.includes(term))) {
        return { success: false, error: "refusing to process sensitive-looking path" };
      }

      try {
        const stat = await lstat(requestedPath);
        if (stat.isSymbolicLink()) {
          return { success: false, error: "symlinks are not supported" };
        }
      } catch {
        return { success: false, error: "file not found" };
      }

      const confined = await confinePath(requestedPath);
      if (!confined.ok) {
        return { success: false, error: confined.error };
      }
      const absolutePath = confined.path;

      let original: string;
      try {
        original = await readFile(absolutePath, "utf-8");
      } catch {
        return { success: false, error: "failed to read file" };
      }

      if (!original.trim()) {
        return { success: true, skipped: true, reason: "file is empty" };
      }

      const response = await provider.summarize(
        COMPRESS_FILE_SYSTEM_PROMPT,
        `Compress this markdown file while preserving structure and code blocks:\n\n${original}`,
      );
      const compressed = stripMarkdownFence(response);
      const validationErrors = validateCompression(original, compressed);
      if (validationErrors.length > 0) {
        return {
          success: false,
          error: "compression validation failed",
          details: validationErrors,
        };
      }

      const roots = allowedFileRoots();
      let backupPath: string;
      try {
        backupPath = await writeConfinedFile(resolveBackupPath(absolutePath), original, roots);
      } catch (err: unknown) {
        return { success: false, error: writeFailure(err, "failed to write backup file") };
      }

      try {
        await writeConfinedFile(absolutePath, compressed, roots);
      } catch (err: unknown) {
        return { success: false, error: writeFailure(err, "failed to write compressed file") };
      }

      try {
        await recordAudit(kv, "compress", "mem::compress-file", [], {
          filePath: absolutePath,
          backupPath,
          originalChars: original.length,
          compressedChars: compressed.length,
        });
      } catch {}

      return {
        success: true,
        filePath: absolutePath,
        backupPath,
        originalChars: original.length,
        compressedChars: compressed.length,
      };
    },
  );
}