mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-20 18:26:40 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - Operators and agents change agent instructions (AGENTS.md), and they
must see who changed them and when
> - Agent files replaced instruction revisions. Saves no longer write
revision rows, so instruction history is empty
> - The current revision is stamped with the reader and the date
1970-01-01, so it gives false audit data
> - Separately, an agent that lists tool rules gets a timeout when many
rules name the same resources
> - This pull request reads history from the save records that Paperclip
already writes, credits the real writer, and checks each tool-rule
resource one time
> - The benefit is a correct audit trail for instruction changes and a
tool-rule list that agents can read
## Linked Issues or Issue Description
No public issue exists. I searched open and closed issues and PRs for
these problems and found none.
**What happened?**
1. `get_agent_instruction_history` (and the history API) returns 0
revisions for an agent whose AGENTS.md was saved many times. The
activity log shows each save as `agent.files_updated` with the path,
content hash, actor and run.
2. `read_agent_instructions` returns a current revision with `createdAt`
1970-01-01. Its actor is the agent that reads it, and its `sourceRunId`
is the run that reads it.
3. `GET /api/companies/{companyId}/tools/policies` from an agent fails
with a transport timeout most of the time when the company has many tool
rules. A board user gets the list without a problem.
**Expected behavior**
1. History lists each save, newest first, with its writer, run, source
and time.
2. The current revision names the agent or user that wrote those bytes,
and the time of that save. If no save is recorded, it names no writer.
3. The agent gets the tool-rule list in normal time, with the same rules
hidden as before.
**Steps to reproduce**
1. Save an agent's instruction entry file (board editor,
`update_agent_instructions`, or a run that edits the file). Read the
history. It is empty.
2. As a different agent, call `read_agent_instructions` on that agent.
The revision shows the reader and 1970-01-01.
3. Create about 40 tool rules that name the same connection and agent.
As an agent, list `/tools/policies`. Each rule does a new set of access
checks for each resource, one after another.
**Paperclip version or commit**
`master` at `819420a60a`.
**Deployment mode**
Hosted. The new tests reproduce all 3 problems on `master`.
## What Changed
- `agent-instruction-revisions.ts`: history merges the legacy revision
rows with the `agent.files_updated` save records for the entry file. The
order is `(created_at, id)` descending, and cursors keep PostgreSQL
timestamp precision.
- `agent-instruction-revisions.ts`: the current revision takes its
writer, run, source and time from the latest save of the same content
hash. A reader is never the writer. Bytes with no save record have no
writer.
- `agent-instruction-revisions.ts`: an identical re-save over bytes with
no record is marked `source: "adopted"`. It repairs the runtime journal
but is not listed as a save.
- `agent-instruction-revisions.ts`: a history ID can be a legacy
revision, a save record, or the current content token. A save record
keeps only metadata. If its bytes are no longer current, a read returns
404 with `INSTRUCTION_REVISION_CONTENT_NOT_RETAINED`.
- `agent-file-store.ts`: saves record `byteLength`. A run collection
that changes the entry file records its path, hash and size, so history
shows saves from runs.
- `connection-management-authz.ts`: `filterConnectionManagementPolicies`
keeps one read decision for each distinct resource in a request, and
loads each application or catalog entry one time. A rule is still hidden
when any resource that it names is hidden. Board callers do not use this
path.
- Tests: new tests for save history, paging, writer credit, adoption,
and the tool-rule list. Old assertions that expected empty history now
check the exact saves.
## Verification
- `pnpm --filter @paperclipai/server exec vitest run
src/__tests__/agent-instruction-revisions.test.ts
src/__tests__/agent-instruction-working-copies.test.ts
src/__tests__/agent-directory-working-copies.test.ts
src/__tests__/built-in-agents.test.ts
src/services/native-runtime/agent-instruction-tools.integration.test.ts
src/__tests__/tool-policy-list-authz.integration.test.ts`
- With the fix: all pass (revisions: 28 passed, 1 skipped on Linux;
other 5 files: 230 passed).
- With the new tests on `master` code: 13 tests fail, as expected.
- `src/__tests__/connection-management.integration.test.ts`: 90 passed.
- The new tool-rule test lists 40 rules that name 1 connection and
counts the connection reads. It needs fewer than 10.
- I could not run the full server typecheck in my sandbox because of a
memory limit. CI runs it.
- CI on head `a2f0b825`: all checks pass, including `ci / verify` and
`ci / e2e`.
## Risks
- History now shows entries whose ID is an activity row ID, not a
revision row ID. Clients that read or restore an older save get a clear
404 because Paperclip no longer keeps those bytes. The latest save and
legacy revisions still read and restore as before.
- Saves recorded before this change have no `byteLength`. For those,
history shows the current size when the hash matches, and 0 otherwise.
- Stock updates of built-in agents do not record a file path, so they do
not show in history.
- No migration. No change to the stored data model.
> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.
## Model Used
- Anthropic Claude Opus 5.5 (`claude-opus-5-5`), in Claude Code with
tool use (shell, file edits, test runs). Standard context window.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [ ] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: lucktastic <13757243+lucktastic@users.noreply.github.com>
240 lines
12 KiB
TypeScript
240 lines
12 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { randomUUID } from "node:crypto";
|
|
import { Readable } from "node:stream";
|
|
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { and, eq, sql } from "drizzle-orm";
|
|
import { agentFileRoots, agents, authUsers, closeFileStorageDb, companies, companyMemberships, createDb, principalPermissionGrants } from "@paperclipai/db";
|
|
import { startEmbeddedPostgresTestDatabase } from "./helpers/embedded-postgres.js";
|
|
import { agentFileStore, fileHash } from "../services/agent-file-store.js";
|
|
import { agentInstructionRevisionService } from "../services/agent-instruction-revisions.js";
|
|
import { resolveManagedInstructionsRoot } from "../services/agent-instructions.js";
|
|
|
|
const objects = vi.hoisted(() => ({
|
|
bytes: new Map<string, Buffer>(),
|
|
downloads: [] as Array<{ objectKey: string; agentRowLocked: boolean | null }>,
|
|
probe: null as null | (() => Promise<boolean>),
|
|
gate: null as null | { opened: Promise<void>; reached: () => void },
|
|
delayMs: 0,
|
|
}));
|
|
vi.mock("../storage/index.js", () => ({ getStorageService: () => ({
|
|
provider: "s3",
|
|
async putFile(input: { companyId: string; namespace: string; body: Readable }) {
|
|
const chunks: Buffer[] = [];
|
|
for await (const chunk of input.body) chunks.push(Buffer.from(chunk));
|
|
const objectKey = `${input.companyId}/${input.namespace}/${randomUUID()}`;
|
|
objects.bytes.set(objectKey, Buffer.concat(chunks));
|
|
return { objectKey };
|
|
},
|
|
async getObject(_companyId: string, objectKey: string) {
|
|
const body = objects.bytes.get(objectKey);
|
|
if (!body) throw new Error("fixture object missing");
|
|
objects.downloads.push({ objectKey, agentRowLocked: objects.probe ? await objects.probe() : null });
|
|
const gate = objects.gate;
|
|
if (gate) { objects.gate = null; gate.reached(); await gate.opened; }
|
|
if (objects.delayMs) await new Promise(resolve => setTimeout(resolve, objects.delayMs));
|
|
return { stream: Readable.from([body]) };
|
|
},
|
|
}) }));
|
|
|
|
describe("agent file restore locking", () => {
|
|
let database: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>>;
|
|
let db: ReturnType<typeof createDb>;
|
|
let observer: ReturnType<typeof createDb>;
|
|
let home: string, companyId: string, agentId: string, userId: string, root: string;
|
|
const entryFile = "AGENTS.md";
|
|
const board = () => ({ type: "board" as const, userId, source: "session" as const });
|
|
const target = () => ({ companyId, agentId });
|
|
|
|
const lockCheckQuery = () => sql`select id from agents where id = ${agentId} for share nowait`;
|
|
async function agentRowLocked(): Promise<boolean> {
|
|
try {
|
|
await observer.transaction(async tx => { await tx.execute(lockCheckQuery()); });
|
|
return false;
|
|
} catch (error) {
|
|
const code = (error as { code?: string; cause?: { code?: string } }).code ?? (error as { cause?: { code?: string } }).cause?.code;
|
|
if (code === "55P03") return true;
|
|
throw error;
|
|
}
|
|
}
|
|
async function head() {
|
|
const [row] = await db.select().from(agentFileRoots).where(and(eq(agentFileRoots.companyId, companyId), eq(agentFileRoots.agentId, agentId)));
|
|
return row!;
|
|
}
|
|
async function loseLocalProjection() {
|
|
await fs.rm(root, { recursive: true, force: true });
|
|
await fs.rm(path.join(path.dirname(root), "file-sync", "durable-generation"), { force: true });
|
|
}
|
|
async function stagingLeftovers() {
|
|
return (await fs.readdir(path.dirname(root))).filter(name => name.startsWith(".agent-files-"));
|
|
}
|
|
|
|
beforeAll(async () => {
|
|
database = await startEmbeddedPostgresTestDatabase("agent-file-restore-locking-");
|
|
db = createDb(database.connectionString);
|
|
observer = createDb(database.connectionString);
|
|
}, 90_000);
|
|
afterAll(async () => {
|
|
await observer?.$client.end({ timeout: 1 });
|
|
if (db) { await closeFileStorageDb(db, 1); await db.$client.end({ timeout: 1 }); }
|
|
await database?.cleanup();
|
|
});
|
|
beforeEach(async () => {
|
|
home = await fs.realpath(await fs.mkdtemp(path.join(os.tmpdir(), "agent-file-restore-locking-")));
|
|
vi.stubEnv("PAPERCLIP_HOME", home);
|
|
vi.stubEnv("PAPERCLIP_DURABLE_AGENT_FILES", "true");
|
|
objects.bytes.clear(); objects.downloads.length = 0; objects.probe = null; objects.gate = null; objects.delayMs = 0;
|
|
companyId = randomUUID(); agentId = randomUUID(); userId = randomUUID();
|
|
root = resolveManagedInstructionsRoot({ id: agentId, companyId, name: "Owner", adapterConfig: {} });
|
|
await db.insert(companies).values({ id: companyId, name: "Restore locking", issuePrefix: randomUUID().slice(0, 8) });
|
|
await db.insert(authUsers).values({ id: userId, name: "Editor", email: `${userId}@example.test`, createdAt: new Date(), updatedAt: new Date() });
|
|
await db.insert(agents).values({ id: agentId, companyId, name: "Owner",
|
|
adapterConfig: { instructionsBundleMode: "managed", instructionsRootPath: root, instructionsEntryFile: entryFile } });
|
|
await db.insert(companyMemberships).values([
|
|
{ companyId, principalType: "user", principalId: userId, membershipRole: "operator" },
|
|
{ companyId, principalType: "agent", principalId: agentId, membershipRole: "member" },
|
|
]);
|
|
await db.insert(principalPermissionGrants).values({ companyId, principalType: "user", principalId: userId,
|
|
permissionKey: "agents:configure", scope: { agentIds: [agentId] } });
|
|
await fs.mkdir(root, { recursive: true });
|
|
await fs.writeFile(path.join(root, entryFile), "# Policy\n");
|
|
expect((await agentInstructionRevisionService(db).readCommittedForRuntime(target()))?.content).toBe("# Policy\n");
|
|
expect((await head()).entries.map(entry => entry.path)).toEqual([entryFile]);
|
|
});
|
|
afterEach(async () => {
|
|
vi.unstubAllEnvs();
|
|
await fs.rm(home, { recursive: true, force: true });
|
|
});
|
|
|
|
async function whileHolding(lock: (tx: Parameters<Parameters<typeof db.transaction>[0]>[0]) => Promise<unknown>, check: () => Promise<void>) {
|
|
let release!: () => void;
|
|
const released = new Promise<void>(resolve => { release = resolve; });
|
|
let holding!: () => void;
|
|
const held = new Promise<void>(resolve => { holding = resolve; });
|
|
const holder = db.transaction(async tx => { await lock(tx); holding(); await released; });
|
|
await Promise.race([held, holder]);
|
|
try { await check(); } finally { release(); }
|
|
await holder;
|
|
}
|
|
|
|
it("a lock check does not block another lock check", async () => {
|
|
await whileHolding(tx => tx.execute(lockCheckQuery()), async () => {
|
|
expect(await agentRowLocked()).toBe(false);
|
|
});
|
|
});
|
|
|
|
it("a lock check detects the product's agent row lock", async () => {
|
|
await whileHolding(tx => tx.select().from(agents).where(eq(agents.id, agentId)).for("update"), async () => {
|
|
expect(await agentRowLocked()).toBe(true);
|
|
});
|
|
expect(await agentRowLocked()).toBe(false);
|
|
});
|
|
|
|
it("downloads a stale projection without holding the agent row lock", async () => {
|
|
await loseLocalProjection();
|
|
objects.probe = agentRowLocked;
|
|
objects.delayMs = 300;
|
|
let lockedMs = 0;
|
|
let sampling = true;
|
|
const sampler = (async () => {
|
|
let last = performance.now();
|
|
while (sampling) {
|
|
const locked = await agentRowLocked();
|
|
const now = performance.now();
|
|
if (locked) lockedMs += now - last;
|
|
last = now;
|
|
await new Promise(resolve => setTimeout(resolve, 10));
|
|
}
|
|
})();
|
|
const startedAt = performance.now();
|
|
let current: Awaited<ReturnType<ReturnType<typeof agentInstructionRevisionService>["readCommittedForRuntime"]>>;
|
|
let elapsedMs: number;
|
|
try {
|
|
current = await agentInstructionRevisionService(db).readCommittedForRuntime(target());
|
|
elapsedMs = performance.now() - startedAt;
|
|
} finally {
|
|
sampling = false;
|
|
await sampler;
|
|
}
|
|
console.info(JSON.stringify({ metric: "agent_file_restore_row_lock", downloads: objects.downloads.length,
|
|
downloadsWhileLocked: objects.downloads.filter(download => download.agentRowLocked).length, lockedMs: Math.round(lockedMs), elapsedMs: Math.round(elapsedMs) }));
|
|
expect(current?.content).toBe("# Policy\n");
|
|
expect(objects.downloads).toEqual([{ objectKey: expect.any(String), agentRowLocked: false }]);
|
|
expect(lockedMs).toBeLessThan(150);
|
|
expect(await fs.readFile(path.join(path.dirname(root), "file-sync", "durable-generation"), "utf8")).toBe((await head()).generation);
|
|
expect(await stagingLeftovers()).toEqual([]);
|
|
});
|
|
|
|
it.each(["history", "revision"] as const)("a %s read downloads a stale projection without holding the agent row lock", async (operation) => {
|
|
const service = agentInstructionRevisionService(db);
|
|
const current = await service.readCurrent(target(), board());
|
|
await loseLocalProjection();
|
|
objects.probe = agentRowLocked;
|
|
if (operation === "history") {
|
|
await expect(service.history({ ...target(), entryFile }, board())).resolves.toMatchObject({ revisions: expect.any(Array) });
|
|
} else {
|
|
await expect(service.readRevision({ ...target(), entryFile, revisionId: current!.revision.id }, board()))
|
|
.resolves.toMatchObject({ content: "# Policy\n" });
|
|
}
|
|
expect(objects.downloads).toEqual([{ objectKey: expect.any(String), agentRowLocked: false }]);
|
|
expect(await stagingLeftovers()).toEqual([]);
|
|
});
|
|
|
|
it("lets a writer commit during the download and then serves the writer's head, not the stale download", async () => {
|
|
await loseLocalProjection();
|
|
let open!: () => void, reached!: () => void;
|
|
const opened = new Promise<void>(resolve => { open = resolve; });
|
|
const reachedPromise = new Promise<void>(resolve => { reached = resolve; });
|
|
objects.gate = { opened, reached };
|
|
const before = (await head()).generation;
|
|
const reader = agentInstructionRevisionService(db).readCommittedForRuntime(target());
|
|
await reachedPromise;
|
|
try {
|
|
const written = await Promise.race([
|
|
agentFileStore(db).write({ companyId, agentId, path: entryFile, bytes: Buffer.from("# Policy v2\n"), baseHash: fileHash(Buffer.from("# Policy\n")) }, board()),
|
|
new Promise<never>((_, reject) => setTimeout(() => reject(new Error("the writer waited for the reader's download")), 5_000)),
|
|
]);
|
|
expect(written).toMatchObject({ changed: true });
|
|
} finally { open(); }
|
|
const current = await reader;
|
|
const after = await head();
|
|
expect(after.generation).not.toBe(before);
|
|
expect(current?.content).toBe("# Policy v2\n");
|
|
expect(await fs.readFile(path.join(root, entryFile), "utf8")).toBe("# Policy v2\n");
|
|
expect(await fs.readFile(path.join(path.dirname(root), "file-sync", "durable-generation"), "utf8")).toBe(after.generation);
|
|
expect(await stagingLeftovers()).toEqual([]);
|
|
});
|
|
|
|
it("fails once, without the row lock and without retrying, when the staged download fails", async () => {
|
|
await loseLocalProjection();
|
|
const attempts: boolean[] = [];
|
|
objects.probe = async () => {
|
|
attempts.push(await agentRowLocked());
|
|
throw new Error("object storage unavailable");
|
|
};
|
|
await expect(agentInstructionRevisionService(db).readCommittedForRuntime(target())).rejects.toThrow("object storage unavailable");
|
|
expect(attempts).toEqual([false]);
|
|
expect(await stagingLeftovers()).toEqual([]);
|
|
});
|
|
|
|
it("restores under the lock as before when the head keeps changing during every download", async () => {
|
|
await loseLocalProjection();
|
|
const store = agentFileStore(db);
|
|
let version = 0;
|
|
const realGet = objects.probe;
|
|
objects.probe = async () => {
|
|
if (version < 2) {
|
|
version++;
|
|
await db.update(agentFileRoots).set({ generation: randomUUID() })
|
|
.where(and(eq(agentFileRoots.companyId, companyId), eq(agentFileRoots.agentId, agentId)));
|
|
}
|
|
return realGet ? realGet() : false;
|
|
};
|
|
expect((await store.read(companyId, agentId, entryFile, board()))?.toString("utf8")).toBe("# Policy\n");
|
|
expect(objects.downloads).toHaveLength(3);
|
|
expect(await fs.readFile(path.join(path.dirname(root), "file-sync", "durable-generation"), "utf8")).toBe((await head()).generation);
|
|
expect(await stagingLeftovers()).toEqual([]);
|
|
});
|
|
});
|