Repository navigation
Expand file tree
/
Copy pathUsageService.ts
More file actions
977 lines (908 loc) · 36.9 KB
/
Copy pathUsageService.ts
File metadata and controls
977 lines (908 loc) · 36.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
import {
type ProviderInstanceConfig,
ProviderInstanceId,
USAGE_CONTRACT_VERSION,
type ServerSettings as ServerSettingsValue,
type UsageProviderKind,
type UsageSource,
type UsagePricing,
type UsageSummary,
type UsageSummaryInput,
UsageReadError,
} from "@t3tools/contracts";
import * as HostProcess from "@t3tools/shared/HostProcess";
import * as Cause from "effect/Cause";
import * as Clock from "effect/Clock";
import * as Context from "effect/Context";
import * as DateTime from "effect/DateTime";
import * as Deferred from "effect/Deferred";
import * as Effect from "effect/Effect";
import * as Exit from "effect/Exit";
import * as Fiber from "effect/Fiber";
import * as FileSystem from "effect/FileSystem";
import * as Layer from "effect/Layer";
import * as Option from "effect/Option";
import * as Path from "effect/Path";
import * as Schema from "effect/Schema";
import * as Semaphore from "effect/Semaphore";
import { HttpClient, HttpClientResponse } from "effect/http";
import { writeFileStringAtomically } from "@t3tools/shared/atomicWrite";
import { formatMalformedUsageWarning } from "@t3tools/shared/usageFormat";
import * as ServerConfig from "../config.ts";
import * as ServerSettings from "../serverSettings.ts";
import { BUILT_IN_USAGE_DRIVERS, type BuiltInUsageReadersEnv } from "../provider/builtInDrivers.ts";
import type { ProviderDriver } from "@t3tools/provider-core/server/driver";
import { mergeProviderInstanceEnvironment } from "@t3tools/provider-core/server/instanceEnvironment";
import type {
ProviderUsageInstance,
TranscriptUsageFormat,
UsageRecord,
} from "@t3tools/provider-core/server/usage";
import { canonicalModelFilter, resolveModelAliases, UsageAggregator } from "./usageAggregation.ts";
import { createOverrideRateTable, parseRateTable, type RateTable } from "./usagePricing.ts";
import {
listTranscriptFiles,
readDirectoryVolumeId,
readTranscriptRecords,
} from "./usageTranscriptReader.ts";
import {
decodeScanCache,
dedupeWithinFile,
LEGACY_SCAN_CACHE_FILE_NAMES,
makeScanCacheWriter,
pruneScanCache,
SCAN_CACHE_FILE_NAME,
type CachedFile,
type ScanCache,
} from "./usageScanCache.ts";
const LITELLM_RATES_URL =
"https://raw.githubusercontent.com/BerriAI/litellm/main/model_prices_and_context_window.json";
const LITELLM_RATES_API_URL =
"https://api.github.com/repos/BerriAI/litellm/contents/model_prices_and_context_window.json?ref=main";
const RATES_TTL_MS = 24 * 60 * 60 * 1000;
const RATES_REFRESH_FLOOR_MS = 60 * 1000;
// mtime slack includes writes just before local midnight on the window's first day.
const MTIME_SLACK_MS = 36 * 60 * 60 * 1000;
const MAX_HOURLY_WINDOW_MS = 24 * 60 * 60 * 1000;
const CACHE_RETENTION_DAYS = 92;
const STALE_TEMP_DIRECTORY_MS = 60 * 60 * 1000;
const TRANSCRIPT_READ_CONCURRENCY = 4;
const transcriptReaders = BUILT_IN_USAGE_DRIVERS.flatMap((driver) =>
driver.usage?.kind === "transcripts" ? [{ driver, reader: driver.usage }] : [],
);
const scanReaders = BUILT_IN_USAGE_DRIVERS.flatMap((driver) =>
driver.usage?.kind === "scan" ? [{ driver, reader: driver.usage }] : [],
);
const transcriptFormats = new Map(
transcriptReaders.map(({ reader }) => [reader.provider, reader.format] as const),
);
interface TranscriptSource {
readonly provider: UsageProviderKind;
readonly format: TranscriptUsageFormat<unknown>;
readonly dir: string;
readonly volumeId: string;
readonly fileName?: string;
}
const RatesCacheFile = Schema.Struct({
fetchedAtMs: Schema.Number,
document: Schema.Unknown,
});
const decodeRatesCache = Schema.decodeUnknownEffect(Schema.fromJsonString(RatesCacheFile));
const encodeRatesCache = Schema.encodeEffect(Schema.fromJsonString(RatesCacheFile));
const ScanCacheJson = Schema.fromJsonString(Schema.Unknown);
const decodeScanCacheFile = Schema.decodeUnknownEffect(ScanCacheJson);
const encodeUsageRecordKey = Schema.encodeSync(ScanCacheJson);
const CachedSource = Schema.Struct({ dir: Schema.String, volumeId: Schema.String });
function isLaterRead(a: CachedFile, b: CachedFile): boolean {
return a.mtimeMs > b.mtimeMs || (a.mtimeMs === b.mtimeMs && a.size > b.size);
}
const sharedSessionProviders: ReadonlySet<UsageProviderKind> = new Set(
transcriptReaders.flatMap(({ reader }) =>
reader.format.sharedSessionsAcrossFiles ? [reader.provider] : [],
),
);
// Only shared sessions need cross-file dedupe; per-file occurrence counts make other keys unique.
function sharedSessions(
files: readonly { readonly records: readonly UsageRecord[] }[],
): ReadonlySet<string> {
const firstFile = new Map<string, number>();
const shared = new Set<string>();
for (const [index, file] of files.entries()) {
let previous = "";
for (const { provider, sessionId } of file.records) {
if (!sharedSessionProviders.has(provider) || sessionId === previous || sessionId.length === 0)
continue;
previous = sessionId;
const first = firstFile.get(sessionId);
if (first === undefined) firstFile.set(sessionId, index);
else if (first !== index) shared.add(sessionId);
}
}
return shared;
}
const decodeCachedSources = Schema.decodeUnknownOption(
Schema.Struct({ sources: Schema.Record(Schema.String, CachedSource) }),
);
export class UsageService extends Context.Service<
UsageService,
{
readonly readSummary: (input: UsageSummaryInput) => Effect.Effect<UsageSummary, UsageReadError>;
readonly refreshRates: Effect.Effect<UsagePricing>;
}
>()("t3/usage/UsageService") {}
export const make = Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const config = yield* ServerConfig.ServerConfig;
const settingsService = yield* ServerSettings.ServerSettingsService;
const httpClient = yield* HttpClient.HttpClient;
const hostEnvironment = yield* HostProcess.Environment;
const hostname = yield* HostProcess.Hostname;
const readerContext = yield* Effect.context<BuiltInUsageReadersEnv>();
const fileCache: ScanCache = new Map();
// Reads from concurrent windows can still hold the original record after it is corrected.
const resolvedRecords = new WeakMap<UsageRecord, UsageRecord>();
const correctedRecord = (record: UsageRecord) => resolvedRecords.get(record) ?? record;
const correctedBatch = (records: readonly UsageRecord[]) =>
records.some((record) => resolvedRecords.has(record)) ? records.map(correctedRecord) : records;
const sourceCache = new Map<string, typeof CachedSource.Type>();
let cacheDirty = false;
const isWithinDirectory = (filePath: string, dir: string) => {
const relative = path.relative(dir, filePath);
return relative !== ".." && !relative.startsWith(".." + path.sep) && !path.isAbsolute(relative);
};
const ratesCachePath = path.join(config.stateDir, "usage-model-rates.json");
const scanCachePath = path.join(config.stateDir, SCAN_CACHE_FILE_NAME);
const writeCacheFile = (filePath: string, contents: string | Iterable<string>) =>
writeFileStringAtomically({ filePath, contents }).pipe(
Effect.provideService(FileSystem.FileSystem, fileSystem),
Effect.provideService(Path.Path, path),
);
const hostIdPath = path.join(config.baseDir, "usage-host-id");
const explicitHostId = hostEnvironment["T3CODE_HOST_ID"]?.trim();
const hostId =
explicitHostId ||
(yield* fileSystem.readFileString(hostIdPath).pipe(
Effect.catchIf(
(error) => error.reason._tag === "NotFound",
() =>
Effect.scoped(
Effect.gen(function* () {
yield* fileSystem.makeDirectory(config.baseDir, { recursive: true });
const tempDirectory = yield* fileSystem.makeTempDirectoryScoped({
directory: config.baseDir,
prefix: "usage-host-id.",
});
const tempFile = path.join(tempDirectory, "identity");
yield* fileSystem.writeFileString(tempFile, `${hostname}\n`);
// Publish complete contents without replacing another initializer's identity.
yield* fileSystem.link(tempFile, hostIdPath).pipe(
Effect.catchIf(
(error) => error.reason._tag === "AlreadyExists",
() => Effect.void,
),
);
return yield* fileSystem.readFileString(hostIdPath);
}),
),
),
Effect.map((value) => value.trim() || hostname),
Effect.orElseSucceed(() => hostname),
));
let rates: RateTable = new Map();
let ratesFetchedAtMs: number | null = null;
let ratesLastFailedAtMs: number | null = null;
let ratesStatus: UsagePricing["status"] = "unavailable";
const ratesLock = yield* Semaphore.make(1);
const pricing = (): UsagePricing => ({
status: ratesStatus,
source: LITELLM_RATES_URL,
fetchedAt:
ratesFetchedAtMs === null ? null : DateTime.formatIso(DateTime.makeUnsafe(ratesFetchedAtMs)),
knownModels: rates.size,
});
const fetchRates = (url: string, accept = "application/json") =>
httpClient.get(url, { headers: { accept } }).pipe(
Effect.flatMap(HttpClientResponse.filterStatusOk),
Effect.flatMap((response) => response.json),
Effect.map((document) => {
const parsed = parseRateTable(document);
return parsed.size > 0 ? { document, parsed } : null;
}),
Effect.timeout(10_000),
Effect.catchCause(() => Effect.succeed(null)),
);
const loadRates = Effect.fn("UsageService.loadRates")(function* (force: boolean) {
const now = yield* Clock.currentTimeMillis;
const maxAgeMs = force ? RATES_REFRESH_FLOOR_MS : RATES_TTL_MS;
if (ratesFetchedAtMs !== null && now - ratesFetchedAtMs < maxAgeMs) return;
if (ratesFetchedAtMs === null) {
const fromDisk = yield* fileSystem.readFileString(ratesCachePath).pipe(
Effect.flatMap((raw) => decodeRatesCache(raw)),
Effect.catchCause(() => Effect.succeed(null)),
);
if (fromDisk !== null) {
const parsed = parseRateTable(fromDisk.document);
if (parsed.size > 0) {
rates = parsed;
ratesFetchedAtMs = fromDisk.fetchedAtMs;
ratesStatus = "cached";
if (now - fromDisk.fetchedAtMs < maxAgeMs) return;
}
}
}
if (ratesLastFailedAtMs !== null && now - ratesLastFailedAtMs < RATES_REFRESH_FLOOR_MS) return;
let fetched = yield* fetchRates(LITELLM_RATES_URL);
if (fetched === null) {
fetched = yield* fetchRates(LITELLM_RATES_API_URL, "application/vnd.github.raw+json");
}
if (fetched === null) {
ratesLastFailedAtMs = yield* Clock.currentTimeMillis;
if (rates.size > 0) ratesStatus = "cached";
return;
}
rates = fetched.parsed;
ratesFetchedAtMs = now;
ratesLastFailedAtMs = null;
ratesStatus = "fresh";
yield* encodeRatesCache({ fetchedAtMs: now, document: fetched.document }).pipe(
Effect.flatMap((contents) => writeCacheFile(ratesCachePath, contents)),
Effect.ignoreCause,
);
});
const ensureRates = (force: boolean) => ratesLock.withPermit(loadRates(force));
const refreshRates = ensureRates(true).pipe(
Effect.map(pricing),
Effect.withSpan("UsageService.refreshRates"),
);
const readSettings = settingsService.getSettings.pipe(
Effect.catchCause(
(cause) =>
new UsageReadError({
reason: "scanFailed",
detail: "Server settings could not be read.",
cause: Cause.squash(cause),
}),
),
);
const usageInstances = Effect.fn("UsageService.usageInstances")(function* <Config>(
driver: ProviderDriver<Config, unknown, unknown>,
settings: ServerSettingsValue,
) {
const entries: Array<
readonly [ProviderInstanceId, Pick<ProviderInstanceConfig, "config" | "environment">, boolean]
> = Object.entries(settings.providerInstances)
.filter(([, instance]) => instance.driver === driver.driverKind)
.map(([id, instance]) => [ProviderInstanceId.make(id), instance, true] as const);
if (!Object.hasOwn(settings.providerInstances, driver.driverKind)) {
entries.push([ProviderInstanceId.make(driver.driverKind), {}, false]);
}
const decodeConfig = Schema.decodeUnknownOption(driver.configSchema);
return yield* Effect.forEach(
entries,
Effect.fnUntraced(function* ([instanceId, instance, configured]) {
const instanceConfig: ProviderUsageInstance<Config> = {
instanceId,
config: Option.getOrUndefined(decodeConfig(instance.config ?? {})),
environment: yield* mergeProviderInstanceEnvironment(
instance.environment,
hostEnvironment,
),
configured,
};
return instanceConfig;
}),
);
});
const resolveTranscriptDirs = Effect.fn("UsageService.resolveTranscriptDirs")(function* (
settings: ServerSettingsValue,
retentionCutoffMs: number,
) {
const dirs: Array<TranscriptSource> = [];
const seen = new Set<string>();
for (const { driver, reader } of transcriptReaders) {
const { provider, format } = reader;
const directories = yield* Effect.forEach(
yield* usageInstances(driver, settings),
(instance) => reader.directories(instance),
);
for (const { dir: directory, fileName } of directories.flat()) {
const sourceKey = provider + "\0" + directory;
const previous = sourceCache.get(sourceKey);
const dir = yield* fileSystem
.realPath(directory)
.pipe(Effect.orElseSucceed(() => previous?.dir ?? directory));
const currentVolumeId = yield* Effect.promise(() => readDirectoryVolumeId(dir));
const hasRetainedHistory = fileCache
.entries()
.some(
([filePath, entry]) =>
entry.provider === provider &&
entry.mtimeMs >= retentionCutoffMs &&
(entry.records.length + entry.tailRecords.length > 0 || entry.malformedRecords > 0) &&
isWithinDirectory(filePath, dir),
);
const volumeId =
previous?.dir === dir && (hasRetainedHistory || !currentVolumeId)
? previous.volumeId || currentVolumeId
: currentVolumeId;
if (previous?.dir !== dir || previous.volumeId !== volumeId) {
sourceCache.set(sourceKey, { dir, volumeId });
cacheDirty = true;
}
const key = `${provider}\0${dir}`;
if (seen.has(key)) continue;
seen.add(key);
dirs.push({
provider,
format,
dir,
volumeId,
...(fileName === undefined ? {} : { fileName }),
});
}
}
return dirs;
});
// Share first loads so concurrent readers cannot scan against a still-empty cache.
const ensureScanCacheLoaded = yield* Effect.cached(
Effect.gen(function* () {
const readDocument = (filePath: string) =>
fileSystem.readFileString(filePath).pipe(
Effect.flatMap((raw) => decodeScanCacheFile(raw)),
Effect.catchCause(() => Effect.succeed(null)),
);
let document = yield* readDocument(scanCachePath);
for (const fileName of LEGACY_SCAN_CACHE_FILE_NAMES) {
if (document !== null) break;
document = yield* readDocument(path.join(config.stateDir, fileName));
cacheDirty = document !== null;
}
if (document === null) return;
for (const [path, entry] of decodeScanCache(document, transcriptFormats)) {
fileCache.set(path, entry);
}
const sources = decodeCachedSources(document);
if (Option.isSome(sources)) {
for (const [key, source] of Object.entries(sources.value.sources))
sourceCache.set(key, source);
}
}),
);
const writeScanCache = makeScanCacheWriter();
// Serialize writes so concurrently finished window scans cannot overwrite newer snapshots.
const persistLock = yield* Semaphore.make(1);
// The saved cache supersedes older versions. Temp folders an aborted write left behind are
// removed once idle for an hour, so a write in progress from another server survives.
let supersededFilesRemoved = false;
const removeSupersededCacheFiles = Effect.gen(function* () {
for (const fileName of LEGACY_SCAN_CACHE_FILE_NAMES) {
yield* fileSystem.remove(path.join(config.stateDir, fileName)).pipe(Effect.ignore);
}
const tempPrefixes = [SCAN_CACHE_FILE_NAME, ...LEGACY_SCAN_CACHE_FILE_NAMES].map(
(fileName) => `${fileName}.`,
);
const staleBeforeMs = (yield* Clock.currentTimeMillis) - STALE_TEMP_DIRECTORY_MS;
for (const name of yield* fileSystem.readDirectory(config.stateDir)) {
if (!tempPrefixes.some((prefix) => name.startsWith(prefix))) continue;
const tempPath = path.join(config.stateDir, name);
yield* fileSystem.stat(tempPath).pipe(
Effect.flatMap((info) => {
const mtimeMs = Option.getOrUndefined(info.mtime)?.getTime();
return info.type === "Directory" && mtimeMs !== undefined && mtimeMs <= staleBeforeMs
? fileSystem.remove(tempPath, { recursive: true })
: Effect.void;
}),
Effect.ignore,
);
}
}).pipe(Effect.ignore);
// Clear dirty before encoding to retain concurrent changes; restore it on failure for retry.
const persistCaches = Effect.gen(function* () {
if (cacheDirty) {
cacheDirty = false;
yield* Effect.sync(() =>
writeScanCache(fileCache, { sources: Object.fromEntries(sourceCache) }),
).pipe(
Effect.flatMap((contents) => writeCacheFile(scanCachePath, contents)),
Effect.andThen(
Effect.suspend(() => {
if (supersededFilesRemoved) return Effect.void;
supersededFilesRemoved = true;
return removeSupersededCacheFiles;
}),
),
Effect.catchCause(() =>
Effect.sync(() => {
cacheDirty = true;
}),
),
);
}
}).pipe(persistLock.withPermit, Effect.withSpan("UsageService.persistCaches"));
const pendingPersists = new Set<Fiber.Fiber<void>>();
const schedulePersist = Effect.forkDetach(persistCaches).pipe(
Effect.map((fiber) => {
pendingPersists.add(fiber);
fiber.addObserver(() => pendingPersists.delete(fiber));
}),
);
const awaitPersisted = Effect.suspend(() => Fiber.awaitAll([...pendingPersists])).pipe(
Effect.asVoid,
);
yield* Effect.addFinalizer(() => awaitPersisted);
/**
* Reads run concurrently, and the caller stores updates in walk order rather
* than completion order: saved records of deleted transcripts aggregate in
* cache order, where the first copy of a duplicate decides its bucket. Untraced: a scan
* reads thousands of files, so scanTranscriptDir records the counts instead.
*/
const readFileRecords = Effect.fnUntraced(function* (
filePath: string,
size: number,
mtimeMs: number,
provider: UsageProviderKind,
format: TranscriptUsageFormat<unknown>,
): Effect.fn.Return<{
readonly records: readonly UsageRecord[];
readonly malformedRecords: number;
readonly failed?: true;
readonly update?: { readonly entry: CachedFile; readonly replaces: CachedFile | undefined };
}> {
const cached = fileCache.get(filePath);
// Provider is part of the identity: if both providers were ever pointed
// at one directory, a hit parsed by the other parser must not be reused.
if (
cached &&
cached.size === size &&
cached.mtimeMs === mtimeMs &&
cached.provider === provider
) {
return {
records:
cached.tailRecords.length === 0
? cached.records
: [...cached.records, ...cached.tailRecords],
malformedRecords: cached.malformedRecords,
};
}
// Only a strictly grown file may resume. Same size with a new mtime, or
// a shrunken file, means rewritten content; re-parse it whole.
const resumeFrom =
cached !== undefined && cached.provider === provider && size > cached.size
? cached.position
: undefined;
const parsed = yield* Effect.promise(() => readTranscriptRecords(filePath, format, resumeFrom));
// A read failure is not an empty transcript: caching it under this
// (size, mtime) would silently drop the file's usage until it changes.
if (parsed === null)
return {
records: cached?.provider === provider ? [...cached.records, ...cached.tailRecords] : [],
malformedRecords: cached?.provider === provider ? cached.malformedRecords : 0,
failed: true,
};
if (parsed.resumed && cached !== undefined && cached.tailRecords.length > 0) {
// Completing a tentative line reparses it. Reuse its saved correction only when the
// same usage is emitted again, without putting inferred tiers in the parser state.
const reparsed = [...parsed.records, ...parsed.tailRecords];
const identity = (record: UsageRecord) =>
encodeUsageRecordKey([
record.provider,
record.sessionId,
record.timestampMs,
record.model,
record.rateModel,
record.totals,
record.reportedCostUsd,
record.dedupeKey,
]);
for (const [index, previous] of cached.tailRecords.entries()) {
const record = reparsed[index];
const corrected = correctedRecord(previous);
if (
record?.unresolvedServiceTierTurnId !== undefined &&
corrected.unresolvedServiceTierTurnId === undefined &&
identity(record) === identity(corrected)
) {
resolvedRecords.set(record, corrected);
}
}
}
const base = parsed.resumed && cached !== undefined ? cached.records : [];
const records = dedupeWithinFile([...base, ...parsed.records]);
const tailRecords = parsed.tailRecords;
return {
records: tailRecords.length === 0 ? records : [...records, ...tailRecords],
malformedRecords: parsed.malformedRecords,
update: {
entry: {
size,
mtimeMs,
provider,
records,
tailRecords,
malformedRecords: parsed.malformedRecords,
position: parsed.position,
},
replaces: cached,
},
};
});
interface ScannedDir {
readonly provider: UsageProviderKind;
readonly dir: string;
readonly volumeId: string;
readonly hostId?: string;
readonly status?: UsageSource["status"];
readonly message?: string;
readonly files:
| readonly {
readonly path: string;
readonly records: readonly UsageRecord[];
readonly malformedRecords: number;
}[]
| null;
readonly refreshing?: true;
}
const scanTranscriptDir = Effect.fn("UsageService.scanTranscriptDir")(function* (
source: TranscriptSource,
windowStartMs: number,
) {
const { provider, format, dir, volumeId, fileName } = source;
const exists = yield* fileSystem
.exists(dir)
.pipe(Effect.catchCause(() => Effect.succeed(false)));
if (!exists) return { provider, dir, volumeId, files: null } satisfies ScannedDir;
const { files, failedPaths } = yield* Effect.promise(() =>
listTranscriptFiles(dir, windowStartMs, fileName === undefined ? undefined : { fileName }),
);
const read = yield* Effect.forEach(
files,
(file) =>
readFileRecords(file.path, file.size, file.mtimeMs, provider, format).pipe(
Effect.map((result) => ({ path: file.path, ...result })),
),
{ concurrency: TRANSCRIPT_READ_CONCURRENCY },
);
const parsedFiles = read.map(({ path, records, malformedRecords, update }) => {
if (update === undefined) return { path, records, malformedRecords };
// A scan of another window may have cached its own read of this file
// meanwhile. Then keep whichever read saw the later file, so a slower
// scan never replaces newer usage with older.
const current = fileCache.get(path);
if (
current === update.replaces ||
current === undefined ||
isLaterRead(update.entry, current)
) {
fileCache.set(path, {
...update.entry,
records: correctedBatch(update.entry.records),
tailRecords: correctedBatch(update.entry.tailRecords),
});
cacheDirty = true;
}
return { path, records, malformedRecords };
});
const unread = failedPaths + read.filter((file) => file.failed).length;
yield* Effect.annotateCurrentSpan({
"usage.files": files.length,
"usage.files_parsed": read.filter((file) => file.update !== undefined).length,
});
return {
provider,
dir,
volumeId,
files: parsedFiles,
...(unread > 0
? {
status: "partial",
message: `${unread} transcript path(s) could not be read; usage may be incomplete.`,
}
: {}),
} satisfies ScannedDir;
});
const collectDirs = Effect.fn("UsageService.collectDirs")(function* (
windowStartMs: number,
settings: ServerSettingsValue,
retentionCutoffMs: number,
awaitRefresh: boolean,
) {
const dirs = yield* resolveTranscriptDirs(settings, retentionCutoffMs).pipe(
Effect.provideContext(readerContext),
);
const scans = Effect.forEach(
scanReaders,
({ driver, reader }) =>
usageInstances(driver, settings).pipe(
Effect.flatMap((instances) =>
reader.scan({ instances, settings, windowStartMs, retentionCutoffMs, awaitRefresh }),
),
Effect.flatMap((sources) =>
Effect.forEach(sources, ({ volumeId, ...source }) =>
Effect.map(
volumeId === undefined
? Effect.promise(() => readDirectoryVolumeId(source.dir))
: Effect.succeed(volumeId),
(resolved): ScannedDir => ({
...source,
files: source.files?.map((file) => ({ ...file, malformedRecords: 0 })) ?? null,
provider: reader.provider,
volumeId: resolved,
}),
),
),
),
Effect.provideContext(readerContext),
),
{ concurrency: "unbounded" },
);
// Scan independent sources together, directories sequentially to bound open files; keep order, since the first copy decides a duplicate's bucket.
const [transcripts, scanDirs] = yield* Effect.all(
[Effect.forEach(dirs, (dir) => scanTranscriptDir(dir, windowStartMs)), scans],
{ concurrency: "unbounded" },
);
const scanned: readonly ScannedDir[] = [...transcripts, ...scanDirs.flat()];
return scanned;
});
const scanSummary = Effect.fn("UsageService.scanSummary")(function* (
input: UsageSummaryInput,
settings: ServerSettingsValue,
) {
if (input.sinceDay > input.untilDay) {
return yield* new UsageReadError({
reason: "invalidWindow",
detail: `sinceDay '${input.sinceDay}' is after untilDay '${input.untilDay}'`,
});
}
let hourlyWindow: { readonly sinceTimeMs: number; readonly untilTimeMs: number } | null = null;
if (input.resolution === "hour") {
const sinceTime =
input.sinceTime === undefined ? Option.none() : DateTime.make(input.sinceTime);
const untilTime =
input.untilTime === undefined ? Option.none() : DateTime.make(input.untilTime);
if (Option.isNone(sinceTime) || Option.isNone(untilTime)) {
return yield* new UsageReadError({
reason: "invalidWindow",
detail: "Hourly usage requires valid sinceTime and untilTime instants",
});
}
const sinceTimeMs = DateTime.toEpochMillis(sinceTime.value);
const untilTimeMs = DateTime.toEpochMillis(untilTime.value);
const durationMs = untilTimeMs - sinceTimeMs;
if (durationMs <= 0 || durationMs > MAX_HOURLY_WINDOW_MS) {
return yield* new UsageReadError({
reason: "invalidWindow",
detail: "Hourly usage window must be greater than zero and at most 24 hours",
});
}
hourlyWindow = { sinceTimeMs, untilTimeMs };
}
const startedAtMs = yield* Clock.currentTimeMillis;
yield* ensureScanCacheLoaded;
const windowStart = DateTime.make(`${input.sinceDay}T00:00:00Z`);
if (Option.isNone(windowStart)) {
return yield* new UsageReadError({
reason: "invalidWindow",
detail: `sinceDay '${input.sinceDay}' is not a valid date`,
});
}
const windowStartMs =
(hourlyWindow?.sinceTimeMs ?? DateTime.toEpochMillis(windowStart.value)) - MTIME_SLACK_MS;
const retentionCutoffMs = startedAtMs - CACHE_RETENTION_DAYS * 24 * 60 * 60 * 1000;
const [, scannedDirs] = yield* Effect.all(
[
ensureRates(false),
collectDirs(windowStartMs, settings, retentionCutoffMs, input.awaitRefresh === true),
],
{ concurrency: 2 },
);
const aggregator = new UsageAggregator({
timeZone: input.timeZone,
sinceDay: input.sinceDay,
untilDay: input.untilDay,
resolution: input.resolution ?? "day",
...hourlyWindow,
rates,
priceOverrides: createOverrideRateTable(settings.usagePriceOverrides),
modelAliases: resolveModelAliases(settings.usageModelAliases),
...(input.modelFilter === undefined ? {} : { modelFilter: input.modelFilter }),
});
const sources: UsageSource[] = [];
// Deleted transcripts' saved usage still aggregates and deduplicates normally.
const retainedSinceMs = Math.max(windowStartMs, retentionCutoffMs);
const filesByDir = scannedDirs.map(({ provider, dir, files }) => {
const retainedFiles = [...(files ?? [])];
const livePaths = new Set(retainedFiles.map((file) => file.path));
for (const [filePath, entry] of fileCache) {
if (
entry.provider !== provider ||
entry.mtimeMs < retainedSinceMs ||
livePaths.has(filePath) ||
!isWithinDirectory(filePath, dir)
)
continue;
retainedFiles.push({
path: filePath,
records: [...entry.records, ...entry.tailRecords],
malformedRecords: entry.malformedRecords,
});
}
return retainedFiles;
});
const windowEndMs =
hourlyWindow?.untilTimeMs ??
Date.parse(`${input.untilDay}T00:00:00Z`) + 86400000 + MTIME_SLACK_MS;
let resolvedAny = false;
for (const { reader } of transcriptReaders) {
if (reader.resolveServiceTiers === undefined) continue;
const pending = new Set<UsageRecord>();
for (const [index, files] of filesByDir.entries()) {
if (scannedDirs[index]?.provider !== reader.provider) continue;
for (const file of files) {
for (const raw of file.records) {
const record = correctedRecord(raw);
if (
record.provider === reader.provider &&
record.unresolvedServiceTierTurnId !== undefined &&
record.timestampMs >= windowStartMs &&
record.timestampMs < windowEndMs
) {
pending.add(record);
}
}
}
}
if (pending.size === 0) continue;
const resolved = yield* reader
.resolveServiceTiers([...pending])
.pipe(Effect.provideContext(readerContext));
for (const [record, speed] of resolved) {
const { unresolvedServiceTierTurnId: _turnId, ...rest } = record;
resolvedRecords.set(record, { ...rest, speed });
resolvedAny = true;
}
}
if (resolvedAny) {
for (const [filePath, entry] of fileCache) {
const records = correctedBatch(entry.records);
const tailRecords = correctedBatch(entry.tailRecords);
if (records === entry.records && tailRecords === entry.tailRecords) continue;
// Update the current entry by identity; a slow resolver cannot restore an older file.
fileCache.set(filePath, { ...entry, records, tailRecords });
cacheDirty = true;
}
}
const crossFileSessions = sharedSessions(filesByDir.flat());
for (const [
index,
{ provider, dir, volumeId, files, status, message, refreshing, hostId: sourceHostId },
] of scannedDirs.entries()) {
let scannedFiles = 0;
let skippedFiles = 0;
let malformedRecords = 0;
// Distinct per directory. Buckets carry per-cell session counts, but a
// session spans days and models, so clients total this figure instead.
const sessionIds = new Set<string>();
for (const file of filesByDir[index] ?? []) {
malformedRecords += file.malformedRecords;
if (file.records.length === 0) {
skippedFiles += 1;
continue;
}
scannedFiles += 1;
const eventOccurrences = new Map<string, number>();
for (const rawRecord of file.records) {
const record = correctedRecord(rawRecord);
let usageRecord = record;
if (
sharedSessionProviders.has(record.provider) &&
crossFileSessions.has(record.sessionId)
) {
// Dedupe moved copies but retain repeated equal events within a file, including second-precision timestamps.
const key = encodeUsageRecordKey([
record.provider,
record.sessionId,
record.timestampMs,
record.model,
record.totals,
]);
const occurrence = (eventOccurrences.get(key) ?? 0) + 1;
eventOccurrences.set(key, occurrence);
usageRecord = { ...record, dedupeKey: key + ":" + occurrence };
}
if (aggregator.add(usageRecord, dir) && record.sessionId.length > 0) {
sessionIds.add(record.sessionId);
}
}
}
const sourceMessage =
message ?? (files === null ? "No transcript directory on this environment." : null);
sources.push({
fingerprint: { hostId: sourceHostId ?? hostId, provider, resolvedHomePath: dir, volumeId },
status:
files === null && scannedFiles === 0
? "missing"
: malformedRecords > 0
? status === undefined || status === "ok"
? "partial"
: status
: (status ?? "ok"),
scannedFiles,
skippedFiles,
malformedRecords,
distinctSessions: sessionIds.size,
message:
malformedRecords > 0
? [sourceMessage, formatMalformedUsageWarning(malformedRecords)]
.filter(Boolean)
.join(" ")
: sourceMessage,
...(refreshing ? { refreshing } : {}),
});
}
const pruned = pruneScanCache(fileCache, retentionCutoffMs);
if (pruned > 0) cacheDirty = true;
const aggregated = aggregator.finish();
const readAt = yield* DateTime.now;
const finishedAtMs = yield* Clock.currentTimeMillis;
return {
contractVersion: USAGE_CONTRACT_VERSION,
readAt: DateTime.formatIso(readAt),
timeZone: input.timeZone,
sinceDay: input.sinceDay,
untilDay: input.untilDay,
buckets: aggregated.buckets,
sources,
pricing: pricing(),
scanDurationMs: Math.max(0, finishedAtMs - startedAtMs),
...(input.modelFilter === undefined ? {} : { modelFilter: input.modelFilter }),
} satisfies UsageSummary;
});
const inflightScans = new Map<string, Deferred.Deferred<UsageSummary, UsageReadError>>();
const scanKey = (input: UsageSummaryInput, settings: ServerSettingsValue): string =>
JSON.stringify([
input.timeZone,
input.sinceDay,
input.untilDay,
input.resolution ?? "day",
input.sinceTime ?? null,
input.untilTime ?? null,
settings,
input.awaitRefresh === true,
input.modelFilter ?? null,
]);
const readSummary = Effect.fn("UsageService.readSummary")(function* (
requested: UsageSummaryInput,
) {
const { modelFilter: requestedFilter, ...unfiltered } = requested;
const modelFilter = canonicalModelFilter(requestedFilter);
const input = modelFilter === undefined ? unfiltered : { ...unfiltered, modelFilter };
const settings = yield* readSettings;
const key = scanKey(input, settings);
const deferred = yield* Effect.uninterruptible(
Effect.gen(function* () {
const existing = inflightScans.get(key);
if (existing !== undefined) return existing;
// Register and fork atomically so cancellation cannot leave a Deferred without a scan.
const created = Deferred.makeUnsafe<UsageSummary, UsageReadError>();
inflightScans.set(key, created);
// Detach so caller departure cannot cancel shared scans; finished scans warm the cache.
// Register writes before releasing waiters, but start writing after delivering their summary.
yield* scanSummary(input, settings).pipe(
Effect.onExit((exit) =>
Effect.sync(() => inflightScans.delete(key)).pipe(
Effect.andThen(Exit.isSuccess(exit) ? schedulePersist : Effect.void),
Effect.andThen(Deferred.done(created, exit)),
),
),
Effect.forkDetach,
);
return created;
}),
);
return yield* Deferred.await(deferred);
});
return { readSummary, refreshRates, awaitPersisted } as const;
});
export const layer = Layer.effect(UsageService, make);