-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathprocessUsage.test.ts
More file actions
930 lines (823 loc) · 33.6 KB
/
processUsage.test.ts
File metadata and controls
930 lines (823 loc) · 33.6 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
import { test, describe, expect } from '@jest/globals';
import type { MicrodollarUsageStats, MicrodollarUsageContext } from './processUsage.types';
import {
extractPromptInfo,
extractUsageContextInfo,
parseMicrodollarUsageFromStream,
parseMicrodollarUsageFromString,
mapToUsageStats,
logMicrodollarUsage,
processOpenRouterUsage,
stripNulBytesInPlace,
toInsertableDbUsageRecord,
} from './processUsage';
import type { OpenRouterGeneration } from '@/lib/ai-gateway/providers/openrouter/types';
import { verifyApproval } from '../../tests/helpers/approval.helper';
import { insertTestUser } from '../../tests/helpers/user.helper';
import { insertUsageWithOverrides } from '../../tests/helpers/microdollar-usage.helper';
import { join } from 'node:path';
import { createReadStream } from 'node:fs';
import { readFile } from 'node:fs/promises';
import { db } from '@/lib/drizzle';
import { microdollar_usage, microdollar_usage_metadata } from '@kilocode/db/schema';
import { eq, getTableColumns } from 'drizzle-orm';
import { findUserById } from '../user';
import { Readable } from 'node:stream';
import { getFraudDetectionHeaders, toMicrodollars } from '../utils';
// Note: Legacy banned_ja4/whitelist_ja4 tests removed - abuse classification
// is now handled by the external abuse detection service (src/lib/abuse-service.ts)
describe('processOpenRouterUsage', () => {
const coreProps = {
messageId: 'test-message-id',
model: 'test-model',
responseContent: 'test-response',
hasError: false,
kiloUserId: 'test-user-id',
inference_provider: 'Provider',
upstream_id: null,
finish_reason: null,
latency: null,
moderation_latency: null,
generation_time: null,
streamed: null,
cancelled: null,
status_code: 200,
};
test('should correctly process usage for a non-byok case', () => {
const usage = {
cost: 0.001,
is_byok: false,
cost_details: { upstream_inference_cost: 0.7 },
completion_tokens: 100,
completion_tokens_details: { reasoning_tokens: 0 },
prompt_tokens: 50,
prompt_tokens_details: { cached_tokens: 0 },
total_tokens: 150,
};
const result = processOpenRouterUsage(usage, coreProps);
expect(result.cost_mUsd).toBe(1000);
expect(result.is_byok).toBe(false);
});
test('should correctly process usage for a byok case', () => {
const usage = {
is_byok: true,
cost: 0.001,
cost_details: { upstream_inference_cost: 0.02 },
completion_tokens: 100,
completion_tokens_details: { reasoning_tokens: 0 },
prompt_tokens: 50,
prompt_tokens_details: { cached_tokens: 0 },
total_tokens: 150,
};
const result = processOpenRouterUsage(usage, coreProps);
expect(result.cost_mUsd).toBe(20000);
expect(result.is_byok).toBe(true);
});
});
const sampleDir = join(process.cwd(), 'src/tests/sample');
describe('parseMicrodollarUsageFromStream approval tests', () => {
const normalAnthropic = 'normal-anthropic.log.resp.sse';
test(normalAnthropic, async () => {
const inputFile = join(sampleDir, normalAnthropic);
const nodeStream = createReadStream(inputFile);
const stream = Readable.toWeb(nodeStream) as ReadableStream<Uint8Array>;
const result = await parseMicrodollarUsageFromStream(
stream,
'fake-user-id',
undefined,
'openrouter',
200
);
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
const normalGpt41 = 'normal-gpt41.log.resp.sse';
test(normalGpt41, async () => {
const inputFile = join(sampleDir, normalGpt41);
const nodeStream = createReadStream(inputFile);
const stream = Readable.toWeb(nodeStream) as ReadableStream<Uint8Array>;
const result = await parseMicrodollarUsageFromStream(
stream,
'fake-user-id',
undefined,
'openrouter',
200
);
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
const outOfCredits = 'openrouter-key-out-of-credits.log.resp.sse';
test(outOfCredits, async () => {
const inputFile = join(sampleDir, outOfCredits);
const nodeStream = createReadStream(inputFile);
const stream = Readable.toWeb(nodeStream) as ReadableStream<Uint8Array>;
const result = await parseMicrodollarUsageFromStream(
stream,
'fake-user-id',
undefined,
'openrouter',
200
);
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
const nonStreaming = 'nonstreaming-anthropic.log.resp.json';
test(nonStreaming, async () => {
const inputFile = join(sampleDir, nonStreaming);
const jsonString = await readFile(inputFile, 'utf-8');
const result = parseMicrodollarUsageFromString(jsonString, 'fake-user-id', 200);
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
test('handles ResponseAborted error gracefully and returns partial data', async () => {
// Create a stream that emits some SSE data then throws ResponseAborted
const partialSSEData = `data: {"id":"gen-123","model":"anthropic/claude-3-5-sonnet","choices":[{"delta":{"content":"Hello"}}]}\n\ndata: {"id":"gen-123","model":"anthropic/claude-3-5-sonnet","choices":[{"delta":{"content":" world"}}]}\n\n`;
// Create a custom error that mimics ResponseAborted
const responseAbortedError = new Error('Response aborted');
responseAbortedError.name = 'ResponseAborted';
let pullCount = 0;
// Create a readable stream that emits partial data then throws on second pull
const stream = new ReadableStream<Uint8Array>({
pull(controller) {
pullCount++;
if (pullCount === 1) {
controller.enqueue(new TextEncoder().encode(partialSSEData));
} else {
// Simulate abort on subsequent read
controller.error(responseAbortedError);
}
},
});
const result = await parseMicrodollarUsageFromStream(
stream,
'fake-user-id',
undefined,
'openrouter',
200
);
// Should have captured partial data before abort
expect(result.messageId).toBe('gen-123');
expect(result.model).toBe('anthropic/claude-3-5-sonnet');
expect(result.responseContent).toBe('Hello world');
expect(result.hasError).toBe(true); // Should be marked as error due to abort
});
test('captures numeric error.code from in-stream error event as status_code_override', async () => {
const errorChunk = `data: {"id":"gen-1","object":"chat.completion.chunk","created":1,"model":"","provider":"Amazon Bedrock","choices":[],"error":{"code":502,"message":"Internal server error","metadata":{"error_type":"provider_unavailable"}}}\n\n`;
const stream = new ReadableStream<Uint8Array>({
start(controller) {
controller.enqueue(new TextEncoder().encode(errorChunk));
controller.close();
},
});
const result = await parseMicrodollarUsageFromStream(
stream,
'fake-user-id',
undefined,
'openrouter',
200
);
expect(result.hasError).toBe(true);
expect(result.status_code).toBe(502);
});
});
const sampleReqDir = join(process.cwd(), 'src/tests/req_sample');
describe('extractPromptInfo approval tests', () => {
const anthropicFile = 'anthropic-claude37.log.req.json';
test(anthropicFile, async () => {
const inputFile = join(sampleReqDir, anthropicFile);
const prompt = await readFile(inputFile, 'utf-8');
const result = extractPromptInfo(JSON.parse(prompt));
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.extractPromptInfo.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
const geminiFile = 'google-gemini25.log.req.json';
test(geminiFile, async () => {
const inputFile = join(sampleReqDir, geminiFile);
const prompt = await readFile(inputFile, 'utf-8');
const result = extractPromptInfo(JSON.parse(prompt));
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.extractPromptInfo.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
const openAiGptFile = 'openai-gpt41.log.req.json';
test(openAiGptFile, async () => {
const inputFile = join(sampleReqDir, openAiGptFile);
const prompt = await readFile(inputFile, 'utf-8');
const result = extractPromptInfo(JSON.parse(prompt));
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.extractPromptInfo.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
});
describe('mapToUsageStats approval tests', () => {
const claudeSonnetGeneration = 'claude-3-7-sonnet-generation.log.generation.json';
test(claudeSonnetGeneration, async () => {
const inputFile = join(sampleDir, claudeSonnetGeneration);
const generationData = JSON.parse(await readFile(inputFile, 'utf-8')) as OpenRouterGeneration;
const result = mapToUsageStats(
generationData,
'nonsense',
'fake-user-id',
'fake-model',
'openrouter'
);
const resultString = JSON.stringify(result, null, 2);
const approvalFilePath = inputFile + '.mapToUsageStats.approved.json';
await verifyApproval(resultString, approvalFilePath);
});
});
describe('toMicrodollars', () => {
test('converts dollar amount to microdollars', () => {
expect(toMicrodollars(0.123456)).toBe(123456);
expect(toMicrodollars(1)).toBe(1000000);
expect(toMicrodollars(0)).toBe(0);
expect(toMicrodollars(0.00000099)).toBe(1); // 0.00000099 * 1000000 = 0.99, round to 1
expect(toMicrodollars(0.1234567)).toBe(123457); // 0.1234567 * 1000000 = 123456.7, round to 123457
expect(toMicrodollars(0.0849 / 20)).toBe(4245); // float accuracy: 4245.000000000001 should round to 4245.
});
});
describe('mapToUsageStats', () => {
test('applies BYOK multiplier when is_byok is true', () => {
// Create a sample OpenRouterGeneration with is_byok set to true
const byokGeneration: OpenRouterGeneration = {
data: {
id: 'test-byok-id',
total_cost: 0.1,
upstream_inference_cost: 2.0, // Example cost for BYOK
is_byok: true,
created_at: '2025-05-14T00:00:00Z',
model: 'test-model',
origin: 'test-origin',
usage: 0.1,
native_tokens_prompt: 100,
native_tokens_completion: 50,
native_tokens_cached: 0,
},
};
// Call mapToUsageStats with the BYOK generation
const result = mapToUsageStats(
byokGeneration,
'test response',
'fake-user-id',
'fake-model',
'openrouter'
);
// Verify that the cost is multiplied by OPENROUTER_BYOK_COST_MULTIPLIER
expect(result.cost_mUsd).toBe(toMicrodollars(0.1 * 20.0)); // 0.1 * 20 = 2, then convert to microdollars
});
test('does not apply BYOK multiplier when is_byok is false', () => {
// Create a sample OpenRouterGeneration with is_byok set to false
const nonByokGeneration: OpenRouterGeneration = {
data: {
id: 'test-non-byok-id',
total_cost: 0.1,
created_at: '2025-05-14T00:00:00Z',
model: 'test-model',
origin: 'test-origin',
usage: 0.1,
is_byok: false,
native_tokens_prompt: 100,
native_tokens_completion: 50,
native_tokens_cached: 0,
},
};
// Call mapToUsageStats with the non-BYOK generation
const result = mapToUsageStats(
nonByokGeneration,
'test response',
' fake-user-id',
'fake-model',
'openrouter'
);
// Verify that the cost is not multiplied
expect(result.cost_mUsd).toBe(toMicrodollars(0.1)); // Just convert to microdollars without multiplier
});
});
describe('logMicrodollarUsage', () => {
const BASE_USAGE_STATS: MicrodollarUsageStats = {
messageId: 'test-msg-123',
hasError: false,
cost_mUsd: 500,
inputTokens: 100,
outputTokens: 50,
cacheWriteTokens: 10,
cacheHitTokens: 5,
is_byok: true,
model: 'anthropic/claude-3.7-sonnet',
responseContent: 'Test response content',
inference_provider: 'Provider',
upstream_id: null,
finish_reason: null,
latency: null,
moderation_latency: null,
generation_time: null,
streamed: null,
cancelled: null,
status_code: 200,
};
const createBaseUsageContext = (user: {
id: string;
microdollars_used: number;
google_user_email: string | null;
}) =>
({
api_kind: 'chat_completions',
kiloUserId: user.id,
prior_microdollar_usage: user.microdollars_used,
posthog_distinct_id: user.google_user_email!,
provider: 'openrouter',
fraudHeaders: getFraudDetectionHeaders(new Headers({ 'user-agent': 'test-agent' })),
isStreaming: true,
project_id: null,
requested_model: 'anthropic/claude-3.7-sonnet',
promptInfo: {
system_prompt_prefix: 'You are a helpful assistant',
system_prompt_length: 'You are a helpful assistant'.length,
user_prompt_prefix: 'Please help me with',
},
max_tokens: 200,
has_middle_out_transform: true,
status_code: 200,
editor_name: null,
machine_id: null,
user_byok: false,
has_tools: false,
feature: 'vscode-extension',
session_id: null,
mode: null,
auto_model: null,
ttfb_ms: null,
}) satisfies MicrodollarUsageContext;
test('stores usage data and increments user microdollars for positive cost', async () => {
const user = await insertTestUser({
id: 'test-log-user-1',
microdollars_used: 1000,
google_user_email: 'test@example.com',
});
const usageStats = BASE_USAGE_STATS;
const usageContext = createBaseUsageContext(user);
await logMicrodollarUsage(usageStats, usageContext);
const updatedUser = await findUserById('test-log-user-1');
expect(updatedUser?.microdollars_used).toBe(1500); // 1000 + 500
const metadataRecord = await db._query.microdollar_usage_metadata.findFirst({
where: eq(microdollar_usage_metadata.message_id, 'test-msg-123'),
});
expect(metadataRecord).toBeTruthy();
const usageRecord = await db._query.microdollar_usage.findFirst({
where: eq(microdollar_usage.id, metadataRecord!.id),
});
expect(usageRecord).toBeTruthy();
expect(usageRecord?.kilo_user_id).toBe('test-log-user-1');
expect(usageRecord?.cost).toBe(500);
expect(usageRecord?.input_tokens).toBe(100);
expect(usageRecord?.output_tokens).toBe(50);
expect(usageRecord?.cache_write_tokens).toBe(10);
expect(usageRecord?.cache_hit_tokens).toBe(5);
expect(usageRecord?.provider).toBe('openrouter');
expect(usageRecord?.model).toBe('anthropic/claude-3.7-sonnet');
expect(metadataRecord?.system_prompt_length).toBe(27);
expect(metadataRecord?.user_prompt_prefix).toBe('Please help me with');
expect(metadataRecord?.max_tokens).toBe(200);
expect(metadataRecord?.has_middle_out_transform).toBe(true);
expect(metadataRecord?.session_id).toBeNull();
expect(usageRecord?.has_error).toBe(false);
expect(usageRecord?.created_at).toBeTruthy();
expect(metadataRecord?.created_at).toBe(usageRecord?.created_at);
});
test('stores session_id when provided', async () => {
const user = await insertTestUser({
id: 'test-log-user-session',
microdollars_used: 0,
google_user_email: 'session-test@example.com',
});
const usageStats: MicrodollarUsageStats = {
...BASE_USAGE_STATS,
messageId: 'test-msg-session',
};
const usageContext: MicrodollarUsageContext = {
...createBaseUsageContext(user),
session_id: 'task-abc123',
};
await logMicrodollarUsage(usageStats, usageContext);
const metadataRecord = await db._query.microdollar_usage_metadata.findFirst({
where: eq(microdollar_usage_metadata.message_id, 'test-msg-session'),
});
expect(metadataRecord).toBeTruthy();
expect(metadataRecord?.session_id).toBe('task-abc123');
});
test('stores usage data without incrementing user microdollars for zero cost', async () => {
const user = await insertTestUser({
id: 'test-log-user-2',
microdollars_used: 2000,
google_user_email: 'test2@example.com',
});
const usageStats: MicrodollarUsageStats = {
...BASE_USAGE_STATS,
messageId: 'test-msg-456',
hasError: true,
cost_mUsd: 0, // Zero cost
model: 'openai/gpt-4.1',
};
const usageContext: MicrodollarUsageContext = {
...createBaseUsageContext(user),
requested_model: 'openai/gpt-4.1',
isStreaming: false,
has_middle_out_transform: false,
promptInfo: {
system_prompt_prefix: '',
system_prompt_length: 0,
user_prompt_prefix: 'error test',
},
};
await logMicrodollarUsage(usageStats, usageContext);
// Verify user microdollars were NOT incremented
const updatedUser = await findUserById('test-log-user-2');
expect(updatedUser?.microdollars_used).toBe(2000); // unchanged
const metadataRecord = await db._query.microdollar_usage_metadata.findFirst({
where: eq(microdollar_usage_metadata.message_id, 'test-msg-456'),
});
expect(metadataRecord).toBeTruthy();
const usageRecord = await db._query.microdollar_usage.findFirst({
where: eq(microdollar_usage.id, metadataRecord!.id),
});
expect(usageRecord).toBeTruthy();
expect(usageRecord?.kilo_user_id).toBe('test-log-user-2');
expect(usageRecord?.cost).toBe(0);
expect(usageRecord?.has_error).toBe(true);
expect(usageRecord?.model).toBe('openai/gpt-4.1');
expect(metadataRecord?.has_middle_out_transform).toBe(false);
});
test('stores 3 usage records with overlapping data and tests metadata deduplication', async () => {
const user = await insertTestUser({
id: 'test-dedup-user',
microdollars_used: 3000,
google_user_email: 'dedup@example.com',
});
// Record 1: baseline data
const usageStats1 = { ...BASE_USAGE_STATS, messageId: 'dedup-msg-1', cost_mUsd: 300 };
const baseContext1 = createBaseUsageContext(user);
const req1headers = {
'user-agent': 'test-agent-1',
'x-forwarded-for': '192.168.1.1',
'x-vercel-ip-country': 'US',
'x-vercel-ip-city': 'NYC',
'x-vercel-ja4-digest': 'digest1',
};
const usageContext1: MicrodollarUsageContext = {
...baseContext1,
fraudHeaders: getFraudDetectionHeaders(new Headers(req1headers)),
promptInfo: {
system_prompt_prefix: 'You are helpful',
system_prompt_length: 'You are helpful'.length,
user_prompt_prefix: 'Test message',
},
};
// Record 2: overlapping IP, country, ja4, and system prompt with record 1
const usageStats2 = { ...BASE_USAGE_STATS, messageId: 'dedup-msg-2', cost_mUsd: 400 };
const baseContext2 = createBaseUsageContext(user);
const usageContext2: MicrodollarUsageContext = {
...baseContext2,
fraudHeaders: getFraudDetectionHeaders(
new Headers({
...req1headers,
'user-agent': 'test-agent-2',
'x-vercel-ip-city': 'LA',
})
),
promptInfo: {
system_prompt_prefix: 'You are helpful', // same system prompt as record 1
system_prompt_length: 'You are helpful'.length,
user_prompt_prefix: 'Test message',
},
};
// Record 3: overlapping user-agent and city with record 1, different others
const usageStats3 = { ...BASE_USAGE_STATS, messageId: 'dedup-msg-3', cost_mUsd: 500 };
const baseContext3 = createBaseUsageContext(user);
const usageContext3: MicrodollarUsageContext = {
...baseContext3,
fraudHeaders: getFraudDetectionHeaders(
new Headers({
...req1headers,
'x-forwarded-for': '192.168.1.2',
'x-vercel-ip-country': 'CA',
'x-vercel-ja4-digest': 'digest2',
})
),
promptInfo: {
system_prompt_prefix: 'You are an assistant', // different system prompt
system_prompt_length: 'You are an assistant'.length,
user_prompt_prefix: 'Test message',
},
};
await logMicrodollarUsage(usageStats1, usageContext1);
await logMicrodollarUsage(usageStats2, usageContext2);
await logMicrodollarUsage(usageStats3, usageContext3);
const updatedUser = await findUserById('test-dedup-user');
expect(updatedUser?.microdollars_used).toBe(4200); // 3000 + 300 + 400 + 500
// Verify all 3 usage records exist
const usageRecords = await db._query.microdollar_usage.findMany({
where: eq(microdollar_usage.kilo_user_id, 'test-dedup-user'),
});
expect(usageRecords).toHaveLength(3);
const relevantMetadata = await db
.select(getTableColumns(microdollar_usage_metadata))
.from(microdollar_usage_metadata)
.innerJoin(microdollar_usage, eq(microdollar_usage_metadata.id, microdollar_usage.id))
.where(eq(microdollar_usage.kilo_user_id, 'test-dedup-user'))
.orderBy(microdollar_usage_metadata.message_id);
// If we get here, the tables exist and we can test deduplication
expect(relevantMetadata).toHaveLength(3);
// Test deduplication by checking that shared values have the same IDs
const metadata1 = relevantMetadata.find(r => r.message_id === 'dedup-msg-1')!;
const metadata2 = relevantMetadata.find(r => r.message_id === 'dedup-msg-2')!;
const metadata3 = relevantMetadata.find(r => r.message_id === 'dedup-msg-3')!;
// Records 1 and 3 should share the same user-agent ID (both use 'test-agent-1')
expect(metadata1.http_user_agent_id).toBe(metadata3.http_user_agent_id);
expect(metadata1.http_user_agent_id).not.toBe(metadata2.http_user_agent_id);
// Records 1 and 2 should share the same IP ID (both use '192.168.1.1')
expect(metadata1.http_ip_id).toBe(metadata2.http_ip_id);
expect(metadata1.http_ip_id).not.toBe(metadata3.http_ip_id);
// Records 1 and 2 should share the same country ID (both use 'US')
expect(metadata1.vercel_ip_country_id).toBe(metadata2.vercel_ip_country_id);
expect(metadata1.vercel_ip_country_id).not.toBe(metadata3.vercel_ip_country_id);
// Records 1 and 3 should share the same city ID (both use 'NYC')
expect(metadata1.vercel_ip_city_id).toBe(metadata3.vercel_ip_city_id);
expect(metadata1.vercel_ip_city_id).not.toBe(metadata2.vercel_ip_city_id);
// Records 1 and 2 should share the same ja4 ID (both use 'digest1')
expect(metadata1.ja4_digest_id).toBe(metadata2.ja4_digest_id);
expect(metadata1.ja4_digest_id).not.toBe(metadata3.ja4_digest_id);
// Records 1 and 2 should share the same system prompt prefix ID (both use 'You are helpful')
expect(metadata1.system_prompt_prefix_id).toBe(metadata2.system_prompt_prefix_id);
expect(metadata1.system_prompt_prefix_id).not.toBe(metadata3.system_prompt_prefix_id);
// All records should have their expected non-shared metadata
expect(metadata1.max_tokens).toBe(200);
expect(metadata2.max_tokens).toBe(200);
expect(metadata3.max_tokens).toBe(200);
expect(metadata1.has_middle_out_transform).toBe(true);
expect(metadata2.has_middle_out_transform).toBe(true);
expect(metadata3.has_middle_out_transform).toBe(true);
});
test('nullifies sensitive data for organization usage (data minimization)', async () => {
const user = await insertTestUser({
id: 'test-org-user-1',
microdollars_used: 500,
google_user_email: 'orguser@example.com',
});
const usageStats: MicrodollarUsageStats = {
...BASE_USAGE_STATS,
messageId: 'test-org-msg-123',
};
const usageContext: MicrodollarUsageContext = {
...createBaseUsageContext(user),
organizationId: '12345678-1234-1234-1234-123456789abc', // This triggers data minimization
};
await logMicrodollarUsage(usageStats, usageContext);
const metadataRecord = await db._query.microdollar_usage_metadata.findFirst({
where: eq(microdollar_usage_metadata.message_id, 'test-org-msg-123'),
});
expect(metadataRecord).toBeTruthy();
const usageRecord = await db._query.microdollar_usage.findFirst({
where: eq(microdollar_usage.id, metadataRecord!.id),
});
expect(usageRecord).toBeTruthy();
expect(usageRecord?.kilo_user_id).toBe('test-org-user-1');
expect(usageRecord?.organization_id).toBe('12345678-1234-1234-1234-123456789abc');
expect(usageRecord?.cost).toBe(500);
// Verify data minimization: sensitive prompt data should be null for organizations
expect(metadataRecord?.user_prompt_prefix).toBe(null);
expect(metadataRecord?.system_prompt_prefix_id).toBe(null);
// Other fields should still be populated normally
expect(usageRecord?.input_tokens).toBe(100);
expect(usageRecord?.output_tokens).toBe(50);
expect(usageRecord?.model).toBe('anthropic/claude-3.7-sonnet');
expect(usageRecord?.provider).toBe('openrouter');
});
test('insertUsageRecord updates user balance atomically via insertUsageWithOverrides', async () => {
const user = await insertTestUser({
id: 'test-insert-balance-user',
microdollars_used: 5000,
google_user_email: 'insertbalance@example.com',
});
// Insert usage record directly via insertUsageWithOverrides (which calls insertUsageRecord)
await insertUsageWithOverrides({
kilo_user_id: user.id,
cost: 2500,
});
// Verify user balance was updated
const updatedUser = await findUserById('test-insert-balance-user');
expect(updatedUser?.microdollars_used).toBe(7500); // 5000 + 2500
// Insert another usage record
await insertUsageWithOverrides({
kilo_user_id: user.id,
cost: 1000,
});
// Verify balance accumulated correctly
const finalUser = await findUserById('test-insert-balance-user');
expect(finalUser?.microdollars_used).toBe(8500); // 7500 + 1000
});
test('insertUsageRecord does not update balance for zero cost via insertUsageWithOverrides', async () => {
const user = await insertTestUser({
id: 'test-insert-zero-cost-user',
microdollars_used: 3000,
google_user_email: 'insertzero@example.com',
});
// Insert usage record with zero cost
await insertUsageWithOverrides({
kilo_user_id: user.id,
cost: 0,
});
// Verify user balance was NOT updated
const updatedUser = await findUserById('test-insert-zero-cost-user');
expect(updatedUser?.microdollars_used).toBe(3000); // unchanged
});
test('insertUsageRecord does not update user balance for organization usage via insertUsageWithOverrides', async () => {
const user = await insertTestUser({
id: 'test-insert-org-user',
microdollars_used: 4000,
google_user_email: 'insertorg@example.com',
});
// Insert usage record with organization_id (should not update user balance)
await insertUsageWithOverrides({
kilo_user_id: user.id,
organization_id: '12345678-1234-1234-1234-123456789abc',
cost: 2000,
});
// Verify user balance was NOT updated (org usage doesn't deplete user balance)
const updatedUser = await findUserById('test-insert-org-user');
expect(updatedUser?.microdollars_used).toBe(4000); // unchanged
});
});
describe('stripNulBytesInPlace', () => {
test('strips NUL bytes from string values and tracks field names', () => {
const obj: Record<string, unknown> = {
clean: 'normal',
dirty: 'bad\u0000val',
other: 42,
nil: null,
multiple: 'a\u0000b\u0000c',
};
const dirtyFields: string[] = [];
stripNulBytesInPlace(obj, dirtyFields);
expect(obj.clean).toBe('normal');
expect(obj.dirty).toBe('badval');
expect(obj.other).toBe(42);
expect(obj.nil).toBeNull();
expect(obj.multiple).toBe('abc');
expect(dirtyFields.sort()).toEqual(['dirty', 'multiple']);
});
test('is a no-op when no NUL bytes are present', () => {
const obj: Record<string, unknown> = { a: 'x', b: 'y', c: 1 };
const dirtyFields: string[] = [];
stripNulBytesInPlace(obj, dirtyFields);
expect(dirtyFields).toEqual([]);
expect(obj).toEqual({ a: 'x', b: 'y', c: 1 });
});
});
describe('toInsertableDbUsageRecord NUL-byte sanitization', () => {
const baseUsageStats: MicrodollarUsageStats = {
messageId: 'msg-id',
hasError: false,
cost_mUsd: 500,
inputTokens: 100,
outputTokens: 50,
cacheWriteTokens: 0,
cacheHitTokens: 0,
is_byok: false,
model: 'provider/model',
responseContent: '',
inference_provider: 'prov',
upstream_id: 'up',
finish_reason: 'stop',
latency: null,
moderation_latency: null,
generation_time: null,
streamed: null,
cancelled: null,
status_code: 200,
};
// Node's Headers constructor rejects values containing NUL bytes (invalid
// per RFC 7230), so HTTP-header-sourced fields like `http_user_agent`,
// `machine_id`, `session_id`, `editor_name`, and `project_id` cannot
// realistically carry NULs in production. The realistic vector is fields
// sourced from the JSON request body or upstream LLM responses:
// `model`, `requested_model`, `inference_provider`, `upstream_id`,
// `finish_reason`, `message_id`, `system_prompt_prefix`, `user_prompt_prefix`.
// The sanitizer still covers every string field defensively.
const makeUsageContext = (overrides: Partial<MicrodollarUsageContext> = {}) =>
({
api_kind: 'chat_completions',
kiloUserId: 'user-1',
prior_microdollar_usage: 0,
provider: 'openrouter',
fraudHeaders: getFraudDetectionHeaders(new Headers({ 'user-agent': 'test-agent' })),
isStreaming: false,
project_id: null,
requested_model: 'provider/requested-model',
promptInfo: {
system_prompt_prefix: 'sys-prefix',
system_prompt_length: 10,
user_prompt_prefix: 'usr-prefix',
},
max_tokens: null,
has_middle_out_transform: null,
status_code: null,
editor_name: 'vscode',
machine_id: 'machine',
user_byok: false,
has_tools: false,
feature: null,
session_id: 'session',
mode: null,
auto_model: null,
ttfb_ms: null,
...overrides,
}) satisfies MicrodollarUsageContext;
test('strips NUL bytes from body- and upstream-sourced string fields', () => {
// Fields whose values cross the CTE insert as individual SQL parameters.
// A NUL byte in any of them crashes the insert with Postgres 22021 --
// see KILOCODE-WEB-1G3Z.
const usageStats: MicrodollarUsageStats = {
...baseUsageStats,
messageId: 'msg\u0000id',
model: 'provider/model\u0000evil',
inference_provider: 'prov\u0000',
upstream_id: 'up\u0000',
finish_reason: 'stop\u0000',
};
const usageContext = makeUsageContext({
requested_model: 'req\u0000model',
promptInfo: {
system_prompt_prefix: 'sys\u0000prefix',
system_prompt_length: 10,
user_prompt_prefix: 'usr\u0000prefix',
},
});
const { core, metadata } = toInsertableDbUsageRecord(
usageStats,
extractUsageContextInfo(usageContext)
);
// core fields (from the LLM response body)
expect(core.model).toBe('provider/modelevil');
expect(core.inference_provider).toBe('prov');
expect(core.requested_model).toBe('reqmodel');
// metadata fields (from prompt extraction + upstream response)
expect(metadata.system_prompt_prefix).toBe('sysprefix');
expect(metadata.user_prompt_prefix).toBe('usrprefix');
expect(metadata.upstream_id).toBe('up');
expect(metadata.finish_reason).toBe('stop');
expect(metadata.message_id).toBe('msgid');
// No stray NUL bytes anywhere in the returned record.
for (const value of Object.values(core)) {
if (typeof value === 'string') expect(value.includes('\u0000')).toBe(false);
}
for (const value of Object.values(metadata)) {
if (typeof value === 'string') expect(value.includes('\u0000')).toBe(false);
}
});
test('strips NUL bytes from a directly-constructed fraudHeaders object', () => {
// Bypass Node's Headers validation to exercise the defensive coverage of
// HTTP-header-sourced fields. This documents that IF a NUL byte ever
// reaches these fields (e.g. through a future upstream change), the
// sanitizer will still strip it.
const usageContext = makeUsageContext({
fraudHeaders: {
http_x_forwarded_for: '1.2.3.4\u0000',
http_x_vercel_ip_city: 'Amsterdam\u0000',
http_x_vercel_ip_country: 'NL\u0000',
http_x_vercel_ip_latitude: 52.37,
http_x_vercel_ip_longitude: 4.89,
http_x_vercel_ja4_digest: 'abc\u0000',
http_user_agent: 'kilo\u0000evil',
},
});
const { metadata } = toInsertableDbUsageRecord(
baseUsageStats,
extractUsageContextInfo(usageContext)
);
expect(metadata.http_user_agent).toBe('kiloevil');
expect(metadata.http_x_forwarded_for).toBe('1.2.3.4');
expect(metadata.http_x_vercel_ip_city).toBe('Amsterdam');
expect(metadata.http_x_vercel_ip_country).toBe('NL');
expect(metadata.http_x_vercel_ja4_digest).toBe('abc');
});
test('is a no-op on records without NUL bytes', () => {
const { core, metadata } = toInsertableDbUsageRecord(
baseUsageStats,
extractUsageContextInfo(makeUsageContext())
);
expect(core.model).toBe('provider/model');
expect(core.inference_provider).toBe('prov');
expect(core.requested_model).toBe('provider/requested-model');
expect(metadata.machine_id).toBe('machine');
expect(metadata.session_id).toBe('session');
expect(metadata.editor_name).toBe('vscode');
expect(metadata.upstream_id).toBe('up');
expect(metadata.finish_reason).toBe('stop');
expect(metadata.message_id).toBe('msg-id');
});
});