Skip to content

Commit 0d411e3

Browse files
refactor(usage): OpenCode usage comes from provider-opencode
The SQLite/JSON reader and its OPENCODE_DATA_DIR/XDG root resolution move into provider-opencode as a scan reader on OpenCodeDriver.usage. UsageService runs scan readers generically and fills in a source's volume id from its directory when the reader leaves it out. Co-Authored-By: Claude Opus 5.5 <[email protected]>
1 parent 6c36724 commit 0d411e3

7 files changed

Lines changed: 191 additions & 84 deletions

File tree

‎apps/server/src/provider/builtInDrivers.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ export const BUILT_IN_DRIVERS: ReadonlyArray<AnyProviderDriver<BuiltInDriversEnv
7474
export type BuiltInUsageReadersEnv =
7575
| ProviderUsageReaderEnv<typeof ClaudeDriver>
7676
| ProviderUsageReaderEnv<typeof CodexDriver>
77-
| ProviderUsageReaderEnv<typeof GrokDriver>;
77+
| ProviderUsageReaderEnv<typeof GrokDriver>
78+
| ProviderUsageReaderEnv<typeof OpenCodeDriver>;
7879

7980
/**
8081
* The drivers that keep usage history, in the order the usage page reads
@@ -83,4 +84,4 @@ export type BuiltInUsageReadersEnv =
8384
*/
8485
export const BUILT_IN_USAGE_DRIVERS: ReadonlyArray<
8586
AnyProviderDriver<BuiltInDriversEnv, BuiltInUsageReadersEnv>
86-
> = [ClaudeDriver, CodexDriver, GrokDriver];
87+
> = [ClaudeDriver, CodexDriver, GrokDriver, OpenCodeDriver];

‎apps/server/src/usage/UsageService.ts‎

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ import type {
6363
TranscriptUsageFormat,
6464
UsageRecord,
6565
} from "@t3tools/provider-core/server/usage";
66-
import { readOpenCodeUsage } from "./opencodeUsageReader.ts";
6766
import { makeAntigravityUsageCache, readAntigravityUsage } from "./antigravityUsageReader.ts";
6867
import {
6968
CURSOR_ACCOUNT_CACHE_FILE_NAME,
@@ -127,6 +126,11 @@ const transcriptReaders = BUILT_IN_USAGE_DRIVERS.flatMap((driver) =>
127126
driver.usage?.kind === "transcripts" ? [{ driver, reader: driver.usage }] : [],
128127
);
129128

129+
/** The scan readers, in driver order. */
130+
const scanReaders = BUILT_IN_USAGE_DRIVERS.flatMap((driver) =>
131+
driver.usage?.kind === "scan" ? [{ driver, reader: driver.usage }] : [],
132+
);
133+
130134
/** Transcript formats by provider, for decoding the persisted scan cache. */
131135
const transcriptFormats = new Map(
132136
transcriptReaders.map(({ reader }) => [reader.provider, reader.format] as const),
@@ -851,32 +855,36 @@ export const make = Effect.gen(function* () {
851855
}
852856
return [...canonical];
853857
});
854-
const dataHome = hostEnvironment["XDG_DATA_HOME"]?.trim();
855858

856-
const openCode = Effect.gen(function* () {
857-
const roots = yield* envRoots("OPENCODE_DATA_DIR", [
858-
path.join(
859-
dataHome && path.isAbsolute(dataHome) ? dataHome : path.join(home, ".local", "share"),
860-
"opencode",
861-
),
862-
]);
863-
return yield* Effect.forEach(
864-
roots,
865-
(dir) =>
866-
Effect.gen(function* () {
867-
const result = yield* Effect.promise(() => readOpenCodeUsage(dir, windowStartMs));
868-
return {
869-
provider: "opencode",
870-
dir,
871-
volumeId: yield* Effect.promise(() => readDirectoryVolumeId(dir)),
872-
files: result.missing && !result.error ? null : result.files,
873-
status: result.error ? "partial" : "ok",
874-
...(result.error ? { message: "Some OpenCode history could not be read." } : {}),
875-
} satisfies ScannedDir;
876-
}),
877-
{ concurrency: "unbounded" },
878-
);
879-
});
859+
const scans = Effect.forEach(
860+
scanReaders,
861+
({ driver, reader }) =>
862+
reader
863+
.scan({
864+
instances: usageInstances(driver, settings),
865+
windowStartMs,
866+
retentionCutoffMs,
867+
awaitRefresh,
868+
})
869+
.pipe(
870+
Effect.flatMap((sources) =>
871+
Effect.forEach(sources, ({ volumeId, ...source }) =>
872+
Effect.map(
873+
volumeId === undefined
874+
? Effect.promise(() => readDirectoryVolumeId(source.dir))
875+
: Effect.succeed(volumeId),
876+
(resolved): ScannedDir => ({
877+
...source,
878+
provider: reader.provider,
879+
volumeId: resolved,
880+
}),
881+
),
882+
),
883+
),
884+
Effect.provideContext(readerContext),
885+
),
886+
{ concurrency: "unbounded" },
887+
).pipe(Effect.map((sources) => sources.flat()));
880888

881889
const antigravity = Effect.gen(function* () {
882890
const antigravityRoots = yield* envRoots("ANTIGRAVITY_DATA_DIR", [
@@ -999,18 +1007,18 @@ export const make = Effect.gen(function* () {
9991007
// Independent sources scan together. Transcript directories go one at a
10001008
// time, so open files stay at `TRANSCRIPT_READ_CONCURRENCY`. The result
10011009
// keeps this order, since aggregation keeps the first copy of a duplicate.
1002-
const [transcripts, openCodeDirs, antigravityDirs, cursorDirs] = yield* Effect.all(
1010+
const [transcripts, scanDirs, antigravityDirs, cursorDirs] = yield* Effect.all(
10031011
[
10041012
Effect.forEach(dirs, (dir) => scanTranscriptDir(dir, windowStartMs)),
1005-
openCode,
1013+
scans,
10061014
antigravity,
10071015
cursor,
10081016
],
10091017
{ concurrency: "unbounded" },
10101018
);
10111019
const scanned: readonly ScannedDir[] = [
10121020
...transcripts,
1013-
...openCodeDirs,
1021+
...scanDirs,
10141022
...antigravityDirs,
10151023
...cursorDirs,
10161024
];

‎apps/server/src/usage/usageTranscriptReader.test.ts‎

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import { afterEach, assert, beforeEach, describe, it } from "@effect/vitest";
1010

1111
import { TEST_FORMATS } from "./usageTestFormats.ts";
1212
import { readTranscriptRecords } from "./usageTranscriptReader.ts";
13-
import { readOpenCodeUsage } from "./opencodeUsageReader.ts";
1413
import { readCursorAccountUsage } from "./cursorUsageReader.ts";
1514
import { makeAntigravityUsageCache, readAntigravityUsage } from "./antigravityUsageReader.ts";
1615

@@ -482,55 +481,6 @@ describe("SQLite usage readers", () => {
482481
assert.isFalse(requested);
483482
});
484483

485-
it("counts migrated OpenCode messages once and sees subsequent WAL writes", async () => {
486-
const db = new NodeSqlite.DatabaseSync(NodePath.join(dir, "opencode.db"));
487-
try {
488-
db.exec(
489-
"PRAGMA journal_mode = WAL; PRAGMA wal_autocheckpoint = 0; CREATE TABLE message (id TEXT, session_id TEXT, data TEXT)",
490-
);
491-
const message = {
492-
id: "msg-1",
493-
sessionID: "session-1",
494-
role: "assistant",
495-
modelID: "claude-sonnet-4-5",
496-
time: { created: 1780000000000 },
497-
cost: 0.25,
498-
tokens: { input: 100, output: 20, reasoning: 5, cache: { read: 30, write: 10 } },
499-
};
500-
const insert = db.prepare("INSERT INTO message VALUES (?, ?, ?)");
501-
insert.run(message.id, message.sessionID, JSON.stringify(message));
502-
const legacy = NodePath.join(dir, "storage", "message", message.sessionID);
503-
await NodeFSP.mkdir(legacy, { recursive: true });
504-
await NodeFSP.writeFile(NodePath.join(legacy, "msg-1.json"), JSON.stringify(message));
505-
const first = await readOpenCodeUsage(dir, 0);
506-
assert.isFalse(first.error);
507-
const records = first.files.flatMap((file) => file.records);
508-
assert.strictEqual(records.length, 1);
509-
assert.deepStrictEqual(records[0]?.totals, {
510-
uncachedInputTokens: 100,
511-
cachedInputTokens: 30,
512-
cacheCreationTokens: 10,
513-
outputTokens: 25,
514-
reasoningTokens: 5,
515-
});
516-
assert.strictEqual(records[0]?.reportedCostUsd, 0.25);
517-
insert.run(
518-
"msg-2",
519-
message.sessionID,
520-
JSON.stringify({ ...message, id: "msg-2", time: { created: 1780000001000 } }),
521-
);
522-
const next = await readOpenCodeUsage(dir, 1780000001000);
523-
assert.isFalse(next.error);
524-
assert.deepStrictEqual(
525-
next.files.flatMap((file) => file.records).map((record) => record.dedupeKey),
526-
["opencode:msg-2"],
527-
);
528-
assert.isAbove((await NodeFSP.stat(NodePath.join(dir, "opencode.db-wal"))).size, 0);
529-
} finally {
530-
db.close();
531-
}
532-
});
533-
534484
it("deduplicates Antigravity generation and step usage while preserving retry model and token buckets", async () => {
535485
const db = new NodeSqlite.DatabaseSync(NodePath.join(dir, "session-1.db"));
536486
const stamp = protoNumber(1, 1780000000);

‎packages/provider-core/src/server/usage.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,8 @@ export interface ProviderUsageInstance<Config> {
129129
/** One source a `scan` reader read. */
130130
export interface ProviderUsageScan {
131131
readonly dir: string;
132-
readonly volumeId: string;
132+
/** Identity of the source across hosts. Defaults to the filesystem identity of `dir`. */
133+
readonly volumeId?: string;
133134
/** Overrides the server's host name in the source fingerprint, for account-wide sources. */
134135
readonly hostId?: string;
135136
readonly status?: UsageSource["status"];

‎packages/provider-opencode/src/server/driver.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import * as OpenCode2AdapterV2 from "./v2/adapter.ts";
3434
import type * as ProviderAdapter from "@t3tools/provider-core/server/ProviderAdapter";
3535
import type { ProviderTextGeneration } from "@t3tools/provider-core/server/textGeneration";
3636
import { ProviderDriverError } from "@t3tools/provider-core/server/errors";
37+
import { openCodeUsageReader, type OpenCodeUsageReaderEnv } from "./usage.ts";
3738
import { readOpenCodeGoUsageLimits } from "./usageLimits.ts";
3839
import {
3940
checkOpenCodeProviderStatus,
@@ -182,14 +183,19 @@ export type OpenCodeDriverEnv =
182183
| OpenCodeRuntime.OpenCodeRuntime
183184
| Path.Path;
184185

185-
export const OpenCodeDriver: ProviderDriver<OpenCodeSettings, OpenCodeDriverEnv> = {
186+
export const OpenCodeDriver: ProviderDriver<
187+
OpenCodeSettings,
188+
OpenCodeDriverEnv,
189+
OpenCodeUsageReaderEnv
190+
> = {
186191
driverKind: DRIVER_KIND,
187192
metadata: {
188193
displayName: "OpenCode",
189194
supportsMultipleInstances: true,
190195
},
191196
configSchema: OpenCodeSettings,
192197
defaultConfig: (): OpenCodeSettings => decodeOpenCodeSettings({}),
198+
usage: openCodeUsageReader,
193199
create: ({ instanceId, displayName, accentColor, environment, enabled, config }) =>
194200
Effect.gen(function* () {
195201
const spawner = yield* ChildProcessSpawner.ChildProcessSpawner;
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
// @effect-diagnostics nodeBuiltinImport:off - the reader under test opens real
2+
// SQLite databases and walks a real legacy JSON store.
3+
import * as NodeFSP from "node:fs/promises";
4+
import * as NodeOS from "node:os";
5+
import * as NodePath from "node:path";
6+
import * as NodeSqlite from "node:sqlite";
7+
8+
import { afterEach, assert, beforeEach, describe, it } from "@effect/vitest";
9+
10+
import { readOpenCodeUsage } from "./usage.ts";
11+
12+
let dir: string;
13+
14+
beforeEach(async () => {
15+
dir = await NodeFSP.mkdtemp(NodePath.join(NodeOS.tmpdir(), "usage-reader-test-"));
16+
});
17+
18+
afterEach(async () => {
19+
await NodeFSP.rm(dir, { recursive: true, force: true });
20+
});
21+
22+
describe("readOpenCodeUsage", () => {
23+
it("counts migrated OpenCode messages once and sees subsequent WAL writes", async () => {
24+
const db = new NodeSqlite.DatabaseSync(NodePath.join(dir, "opencode.db"));
25+
try {
26+
db.exec(
27+
"PRAGMA journal_mode = WAL; PRAGMA wal_autocheckpoint = 0; CREATE TABLE message (id TEXT, session_id TEXT, data TEXT)",
28+
);
29+
const message = {
30+
id: "msg-1",
31+
sessionID: "session-1",
32+
role: "assistant",
33+
modelID: "claude-sonnet-4-5",
34+
time: { created: 1780000000000 },
35+
cost: 0.25,
36+
tokens: { input: 100, output: 20, reasoning: 5, cache: { read: 30, write: 10 } },
37+
};
38+
const insert = db.prepare("INSERT INTO message VALUES (?, ?, ?)");
39+
insert.run(message.id, message.sessionID, JSON.stringify(message));
40+
const legacy = NodePath.join(dir, "storage", "message", message.sessionID);
41+
await NodeFSP.mkdir(legacy, { recursive: true });
42+
await NodeFSP.writeFile(NodePath.join(legacy, "msg-1.json"), JSON.stringify(message));
43+
const first = await readOpenCodeUsage(dir, 0);
44+
assert.isFalse(first.error);
45+
const records = first.files.flatMap((file) => file.records);
46+
assert.strictEqual(records.length, 1);
47+
assert.deepStrictEqual(records[0]?.totals, {
48+
uncachedInputTokens: 100,
49+
cachedInputTokens: 30,
50+
cacheCreationTokens: 10,
51+
outputTokens: 25,
52+
reasoningTokens: 5,
53+
});
54+
assert.strictEqual(records[0]?.reportedCostUsd, 0.25);
55+
insert.run(
56+
"msg-2",
57+
message.sessionID,
58+
JSON.stringify({ ...message, id: "msg-2", time: { created: 1780000001000 } }),
59+
);
60+
const next = await readOpenCodeUsage(dir, 1780000001000);
61+
assert.isFalse(next.error);
62+
assert.deepStrictEqual(
63+
next.files.flatMap((file) => file.records).map((record) => record.dedupeKey),
64+
["opencode:msg-2"],
65+
);
66+
assert.isAbove((await NodeFSP.stat(NodePath.join(dir, "opencode.db-wal"))).size, 0);
67+
} finally {
68+
db.close();
69+
}
70+
});
71+
});

apps/server/src/usage/opencodeUsageReader.ts renamed to packages/provider-opencode/src/server/usage.ts

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
11
// node:sqlite reads live OpenCode databases; Node fs walks legacy JSON history.
22
// @effect-diagnostics nodeBuiltinImport:off
3+
/**
4+
* Usage history for OpenCode, read from its SQLite databases and legacy JSON
5+
* message store under each data directory.
6+
*
7+
* @module provider-opencode/server/usage
8+
*/
39
import * as NodeFSP from "node:fs/promises";
10+
import * as NodeOS from "node:os";
411
import * as NodePath from "node:path";
512
import * as NodeSqlite from "node:sqlite";
613
import * as NodeTimersPromises from "node:timers/promises";
714

8-
import { totalTokens, type UsageRecord } from "@t3tools/provider-core/server/usage";
15+
import { expandHomePath } from "@t3tools/provider-core/server/pathExpansion";
16+
import {
17+
totalTokens,
18+
type ProviderUsageReader,
19+
type UsageRecord,
20+
} from "@t3tools/provider-core/server/usage";
21+
import { HostProcessEnvironment } from "@t3tools/shared/hostProcess";
22+
import * as Effect from "effect/Effect";
23+
import * as FileSystem from "effect/FileSystem";
24+
import * as Path from "effect/Path";
25+
26+
import type { OpenCodeSettings } from "../settings.ts";
927

1028
function object(value: unknown): Record<string, unknown> {
1129
return typeof value === "object" && value !== null && !Array.isArray(value)
@@ -186,3 +204,55 @@ export async function readOpenCodeUsage(
186204
}
187205
return { files, missing: !found && !error, error };
188206
}
207+
208+
/**
209+
* The data directories to read: `OPENCODE_DATA_DIR` (comma-separated) or the
210+
* XDG default, canonicalized so aliases count once.
211+
*/
212+
const resolveOpenCodeDataDirs = Effect.fn("resolveOpenCodeDataDirs")(function* () {
213+
const fileSystem = yield* FileSystem.FileSystem;
214+
const path = yield* Path.Path;
215+
const environment = yield* HostProcessEnvironment;
216+
const roots = environment["OPENCODE_DATA_DIR"]
217+
?.split(",")
218+
.map((value) => value.trim())
219+
.filter(Boolean);
220+
const dataHome = environment["XDG_DATA_HOME"]?.trim();
221+
const defaults = [
222+
path.join(
223+
dataHome && path.isAbsolute(dataHome)
224+
? dataHome
225+
: path.join(NodeOS.homedir(), ".local", "share"),
226+
"opencode",
227+
),
228+
];
229+
const canonical = new Set<string>();
230+
for (const root of roots?.length ? roots : defaults) {
231+
const resolved = path.resolve(expandHomePath(root));
232+
canonical.add(yield* fileSystem.realPath(resolved).pipe(Effect.orElseSucceed(() => resolved)));
233+
}
234+
return [...canonical];
235+
});
236+
237+
export type OpenCodeUsageReaderEnv = FileSystem.FileSystem | Path.Path;
238+
239+
export const openCodeUsageReader: ProviderUsageReader<OpenCodeSettings, OpenCodeUsageReaderEnv> = {
240+
kind: "scan",
241+
provider: "opencode",
242+
scan: Effect.fn("openCodeUsageReader.scan")(function* ({ windowStartMs }) {
243+
const roots = yield* resolveOpenCodeDataDirs();
244+
return yield* Effect.forEach(
245+
roots,
246+
(dir) =>
247+
Effect.promise(() => readOpenCodeUsage(dir, windowStartMs)).pipe(
248+
Effect.map((result) => ({
249+
dir,
250+
files: result.missing && !result.error ? null : result.files,
251+
status: result.error ? ("partial" as const) : ("ok" as const),
252+
...(result.error ? { message: "Some OpenCode history could not be read." } : {}),
253+
})),
254+
),
255+
{ concurrency: "unbounded" },
256+
);
257+
}),
258+
};

0 commit comments

Comments
 (0)