Skip to content

Commit cc2d350

Browse files
fix(server): compact superseded event history and reclaim database space
1 parent 740f601 commit cc2d350

14 files changed

Lines changed: 501 additions & 11 deletions

‎apps/server/src/binCli.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { databaseCommand } from "./cli/database.ts";
12
import * as NodeRuntime from "@effect/platform-node/NodeRuntime";
23
import * as NodeServices from "@effect/platform-node/NodeServices";
34
import * as Effect from "effect/Effect";
@@ -84,6 +85,7 @@ export const makeCli = ({ cloudEnabled = hasCloudPublicConfig } = {}) =>
8485
servicePreflightCommand,
8586
themeCommand,
8687
traceCommand,
88+
databaseCommand,
8789
triageCommand,
8890
cloudEnabled ? connectCommand : connectUnavailableCommand,
8991
]),

‎apps/server/src/cli/database.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import * as Config from "effect/Config";
2+
import * as Console from "effect/Console";
3+
import * as Effect from "effect/Effect";
4+
import * as Option from "effect/Option";
5+
import { Command } from "effect/cli";
6+
7+
import { baseDirFlag } from "./config.ts";
8+
import { resolveBaseDir } from "../os-jank.ts";
9+
import * as DatabaseMaintenance from "../persistence/DatabaseMaintenance.ts";
10+
11+
const compactCommand = Command.make("compact", { baseDir: baseDirFlag }).pipe(
12+
Command.withDescription(
13+
"Remove superseded history and reclaim disk space. Stop the server first.",
14+
),
15+
Command.withHandler(({ baseDir }) =>
16+
Effect.gen(function* () {
17+
const home = yield* Config.String("T3CODE_HOME").pipe(Config.option);
18+
const directory = yield* resolveBaseDir(
19+
Option.getOrUndefined(Option.orElse(baseDir, () => home)),
20+
);
21+
const maintenance = yield* DatabaseMaintenance.DatabaseMaintenance;
22+
const result = yield* maintenance.compact(directory);
23+
yield* Console.log(
24+
`Removed ${result.deletedEventCount} events and ${result.deletedReceiptCount} receipts. Database: ${result.beforeBytes} → ${result.afterBytes} bytes.`,
25+
);
26+
}).pipe(Effect.provide(DatabaseMaintenance.layer)),
27+
),
28+
);
29+
30+
export const databaseCommand = Command.make("database").pipe(
31+
Command.withDescription("Maintain the local T3 Code database."),
32+
Command.withSubcommands([compactCommand]),
33+
);
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import { assert, it } from "@effect/vitest";
2+
import * as Deferred from "effect/Deferred";
3+
import * as Effect from "effect/Effect";
4+
import * as Layer from "effect/Layer";
5+
import * as TestClock from "effect/testing/TestClock";
6+
7+
import * as EventCompaction from "./EventCompaction.ts";
8+
import * as ProjectionMaintenance from "./ProjectionMaintenance.ts";
9+
10+
it.effect("defers compaction until after startup and repeats it without overlapping", () =>
11+
Effect.scoped(
12+
Effect.gen(function* () {
13+
let calls = 0;
14+
const first = yield* Deferred.make<void>();
15+
const second = yield* Deferred.make<void>();
16+
const compactEventStore = Effect.gen(function* () {
17+
calls += 1;
18+
yield* Deferred.succeed(calls === 1 ? first : second, undefined);
19+
return { deletedEventCount: 0, deletedReceiptCount: 0, reclaimableBytes: 0 };
20+
});
21+
yield* Layer.build(
22+
EventCompaction.layer.pipe(
23+
Layer.provide(
24+
Layer.mock(ProjectionMaintenance.ProjectionMaintenanceV2)({ compactEventStore }),
25+
),
26+
),
27+
);
28+
assert.equal(calls, 0);
29+
yield* TestClock.adjust("59 seconds");
30+
assert.equal(calls, 0);
31+
yield* TestClock.adjust("1 second");
32+
yield* Deferred.await(first);
33+
assert.equal(calls, 1);
34+
yield* TestClock.adjust("6 hours");
35+
yield* Deferred.await(second);
36+
assert.equal(calls, 2);
37+
}),
38+
),
39+
);
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import * as Effect from "effect/Effect";
2+
import * as Layer from "effect/Layer";
3+
import * as Schedule from "effect/Schedule";
4+
5+
import { forkParked } from "../serverActivation.ts";
6+
import * as ProjectionMaintenance from "./ProjectionMaintenance.ts";
7+
8+
/** Remove superseded history after startup, in the maintenance service's bounded batches. */
9+
export const layer = Layer.effectDiscard(
10+
Effect.gen(function* () {
11+
const maintenance = yield* ProjectionMaintenance.ProjectionMaintenanceV2;
12+
yield* forkParked(
13+
Effect.sleep("1 minute").pipe(
14+
Effect.andThen(
15+
maintenance.compactEventStore.pipe(
16+
Effect.tap((result) =>
17+
result.deletedEventCount > 0 || result.deletedReceiptCount > 0
18+
? Effect.logInfo("Compacted orchestration history", result)
19+
: Effect.void,
20+
),
21+
Effect.catchTags({
22+
ProjectionMaintenanceError: (error) =>
23+
Effect.logWarning("Orchestration history compaction failed", { cause: error }),
24+
}),
25+
Effect.repeat(Schedule.spaced("6 hours")),
26+
),
27+
),
28+
),
29+
);
30+
}),
31+
);

‎apps/server/src/orchestration-v2/ProjectionMaintenance.ts‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ export const layer: Layer.Layer<
230230
];
231231

232232
const supersedableThreadEventTypes = new Set(SUPERSEDABLE_THREAD_EVENT_TYPES);
233-
const COMPACTION_PAGE_SIZE = 500;
233+
const COMPACTION_PAGE_SIZE = 50;
234234

235235
/**
236236
* Scan newest first to retain the newest state for each entity.
@@ -274,6 +274,11 @@ export const layer: Layer.Layer<
274274
WHEN event.application_event_version = 2
275275
AND event.event_type IN ('message.updated', 'node.updated')
276276
THEN json_extract(event.payload_json, '$.id')
277+
WHEN event.application_event_version = 2
278+
AND event.event_type = 'thread.pull-request-link-updated'
279+
THEN json_array(json_extract(event.payload_json, '$.host'),
280+
json_extract(event.payload_json, '$.repository'),
281+
json_extract(event.payload_json, '$.number'))
277282
ELSE NULL
278283
END AS entity_id,
279284
CASE
@@ -301,6 +306,11 @@ export const layer: Layer.Layer<
301306
) {
302307
if (retainedThreadIds.has(row.stream_id)) obsolete.push(row.sequence);
303308
else retainedThreadIds.add(row.stream_id);
309+
} else if (row.event_type === "thread.pull-request-link-updated") {
310+
const key = encodeEntityKey([row.event_type, row.stream_id, row.entity_id]);
311+
if (retainedThreadIds.has(row.stream_id) || retainedEntityKeys.has(key)) {
312+
obsolete.push(row.sequence);
313+
} else retainedEntityKeys.add(key);
304314
} else if (row.event_type === "message.updated" || row.event_type === "node.updated") {
305315
const key = encodeEntityKey([row.event_type, row.stream_id, row.entity_id]);
306316
if (retainedEntityKeys.has(key)) obsolete.push(row.sequence);
@@ -312,7 +322,21 @@ export const layer: Layer.Layer<
312322
// when this page has nothing to delete so startup and requests can progress.
313323
yield* Effect.yieldNow;
314324
if (obsolete.length > 0) {
315-
yield* sql`DELETE FROM orchestration_events WHERE sequence IN ${sql.in(obsolete)}`;
325+
// Publish the replay boundary atomically with deletion. A reconnecting client
326+
// with an older cursor must receive a projection snapshot instead.
327+
yield* sql.withTransaction(
328+
Effect.gen(function* () {
329+
yield* sql`
330+
INSERT INTO orchestration_v2_projection_metadata
331+
(projection_name, schema_version, last_sequence, updated_at)
332+
VALUES ('event-compaction', 1, ${Math.max(...obsolete)}, ${DateTime.formatIso(yield* DateTime.now)})
333+
ON CONFLICT(projection_name) DO UPDATE SET
334+
last_sequence = MAX(last_sequence, excluded.last_sequence),
335+
updated_at = excluded.updated_at
336+
`;
337+
yield* sql`DELETE FROM orchestration_events WHERE sequence IN ${sql.in(obsolete)}`;
338+
}),
339+
);
316340
deletedEventCount += obsolete.length;
317341
yield* Effect.yieldNow;
318342
}

‎apps/server/src/orchestration-v2/runtimeLayer.test.ts‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4937,11 +4937,29 @@ it.layer(Layer.fresh(layerSharedApplicationDataPlaneTest))("compact PR events",
49374937
(yield* orchestrator.getThreadShell(threadId))?.pullRequests,
49384938
after?.pullRequests,
49394939
);
4940+
const currentLink = after?.pullRequests?.[1];
4941+
assert.isDefined(currentLink?.snapshot);
4942+
if (currentLink?.snapshot == null) return;
4943+
yield* orchestrator.dispatch({
4944+
type: "thread.pull-request-link.sync",
4945+
commandId: CommandId.make("compact-pr-sync-again"),
4946+
threadId,
4947+
...key,
4948+
number: 2,
4949+
snapshot: { ...currentLink.snapshot, title: "Latest PR" },
4950+
stack: currentLink.stack,
4951+
});
4952+
const latest = yield* orchestrator.getThreadShell(threadId);
49404953
yield* maintenance.compactEventStore;
4954+
const retained = yield* sql<{
4955+
count: number;
4956+
}>`SELECT COUNT(*) AS count FROM orchestration_events
4957+
WHERE stream_id = ${threadId} AND event_type = 'thread.pull-request-link-updated'`;
4958+
assert.equal(retained[0]?.count, 1);
49414959
assert.isTrue((yield* maintenance.rebuild).valid);
49424960
assert.deepEqual(
49434961
(yield* orchestrator.getThreadShell(threadId))?.pullRequests,
4944-
after?.pullRequests,
4962+
latest?.pullRequests,
49454963
);
49464964
}),
49474965
);
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
// @effect-diagnostics nodeBuiltinImport:off -- isolated on-disk SQLite fixtures exercise VACUUM.
2+
import * as NodeFS from "node:fs";
3+
import * as NodeSqlite from "node:sqlite";
4+
import * as NodeOS from "node:os";
5+
import * as NodePath from "node:path";
6+
import * as NodeServices from "@effect/platform-node/NodeServices";
7+
import { assert, it } from "@effect/vitest";
8+
import * as Effect from "effect/Effect";
9+
import * as Layer from "effect/Layer";
10+
import * as SqlClient from "effect/sql/SqlClient";
11+
12+
import * as DatabaseMaintenance from "./DatabaseMaintenance.ts";
13+
import * as Sqlite from "./Sqlite.ts";
14+
import * as EventStore from "../orchestration-v2/EventStore.ts";
15+
import * as ProjectionMaintenance from "../orchestration-v2/ProjectionMaintenance.ts";
16+
import * as ProjectionStore from "../orchestration-v2/ProjectionStore.ts";
17+
18+
const withDirectory = <A, E, R>(run: (directory: string) => Effect.Effect<A, E, R>) =>
19+
Effect.acquireUseRelease(
20+
Effect.sync(() => NodeFS.mkdtempSync(NodePath.join(NodeOS.tmpdir(), "t3-compact-"))),
21+
run,
22+
(directory) => Effect.sync(() => NodeFS.rmSync(directory, { recursive: true, force: true })),
23+
);
24+
25+
const layer = DatabaseMaintenance.layer.pipe(Layer.provide(NodeServices.layer));
26+
27+
it.effect("reclaims free database pages without losing retained data", () =>
28+
withDirectory((directory) =>
29+
Effect.gen(function* () {
30+
const dbPath = NodePath.join(directory, "userdata", "statev2.sqlite");
31+
yield* Effect.gen(function* () {
32+
const sql = yield* SqlClient.SqlClient;
33+
const maintenance = yield* ProjectionMaintenance.ProjectionMaintenanceV2;
34+
yield* sql`CREATE TABLE retained_data (value TEXT)`;
35+
yield* sql`INSERT INTO retained_data VALUES ('keep')`;
36+
yield* sql`CREATE TABLE discarded_data (value BLOB)`;
37+
yield* sql`INSERT INTO discarded_data VALUES (zeroblob(1048576))`;
38+
yield* sql`DROP TABLE discarded_data`;
39+
yield* maintenance.rebuild;
40+
}).pipe(
41+
Effect.provide(
42+
ProjectionMaintenance.layer.pipe(
43+
Layer.provide(Layer.merge(EventStore.layer, ProjectionStore.layer)),
44+
Layer.provideMerge(Sqlite.layerFromPath(dbPath)),
45+
Layer.provide(NodeServices.layer),
46+
),
47+
),
48+
);
49+
const maintenance = yield* DatabaseMaintenance.DatabaseMaintenance;
50+
const result = yield* maintenance.compact(directory);
51+
assert.isBelow(result.afterBytes, result.beforeBytes);
52+
yield* Effect.gen(function* () {
53+
const sql = yield* SqlClient.SqlClient;
54+
assert.deepEqual(yield* sql`SELECT value FROM retained_data`, [{ value: "keep" }]);
55+
}).pipe(Effect.provide(Sqlite.layerFromPath(dbPath).pipe(Layer.provide(NodeServices.layer))));
56+
}).pipe(Effect.provide(layer)),
57+
),
58+
);
59+
60+
it.effect("refuses a running server before opening its database", () =>
61+
withDirectory((directory) =>
62+
Effect.gen(function* () {
63+
NodeFS.mkdirSync(NodePath.join(directory, "userdata"));
64+
NodeFS.writeFileSync(
65+
NodePath.join(directory, "userdata", "server-runtime.json"),
66+
JSON.stringify({
67+
version: 1,
68+
pid: process.pid,
69+
port: 3773,
70+
origin: "http://localhost:3773",
71+
startedAt: "2026-10-13T00:00:00.000Z",
72+
}),
73+
);
74+
const maintenance = yield* DatabaseMaintenance.DatabaseMaintenance;
75+
const error = yield* maintenance.compact(directory).pipe(Effect.flip);
76+
assert.equal(error.reason, "running");
77+
assert.isFalse(NodeFS.existsSync(NodePath.join(directory, "userdata", "statev2.sqlite")));
78+
}).pipe(Effect.provide(layer)),
79+
),
80+
);
81+
82+
it.effect("does not create a database for an incorrect data directory", () =>
83+
withDirectory((directory) =>
84+
Effect.gen(function* () {
85+
const maintenance = yield* DatabaseMaintenance.DatabaseMaintenance;
86+
assert.equal((yield* maintenance.compact(directory).pipe(Effect.flip)).reason, "missing");
87+
}).pipe(Effect.provide(layer)),
88+
),
89+
);
90+
91+
it.effect("refuses an unrecorded reader holding the database open", () =>
92+
withDirectory((directory) =>
93+
Effect.gen(function* () {
94+
const dbPath = NodePath.join(directory, "userdata", "statev2.sqlite");
95+
yield* Effect.void.pipe(
96+
Effect.provide(Sqlite.layerFromPath(dbPath).pipe(Layer.provide(NodeServices.layer))),
97+
);
98+
const reader = yield* Effect.acquireRelease(
99+
Effect.sync(() => new NodeSqlite.DatabaseSync(dbPath)),
100+
(database) => Effect.sync(() => database.close()),
101+
);
102+
reader.exec("BEGIN");
103+
reader.prepare("SELECT * FROM effect_sql_migrations").all();
104+
const maintenance = yield* DatabaseMaintenance.DatabaseMaintenance;
105+
assert.equal((yield* maintenance.compact(directory).pipe(Effect.flip)).reason, "compact");
106+
}).pipe(Effect.scoped, Effect.provide(layer)),
107+
),
108+
);

0 commit comments

Comments
 (0)