-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathstreamBatchItems.test.ts
More file actions
1092 lines (950 loc) · 36 KB
/
streamBatchItems.test.ts
File metadata and controls
1092 lines (950 loc) · 36 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
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { describe, expect, it, vi } from "vitest";
// Mock the db prisma client - needs to be before other imports
vi.mock("~/db.server", () => ({
prisma: {},
$replica: {},
}));
vi.mock("~/services/platform.v3.server", async (importOriginal) => {
const actual = (await importOriginal()) as Record<string, unknown>;
return {
...actual,
getEntitlement: vi.fn(),
};
});
import { RunEngine } from "@internal/run-engine";
import { setupAuthenticatedEnvironment } from "@internal/run-engine/tests";
import { containerTest } from "@internal/testcontainers";
import { trace } from "@opentelemetry/api";
import { PrismaClient } from "@trigger.dev/database";
import { BatchId } from "@trigger.dev/core/v3/isomorphic";
import {
StreamBatchItemsService,
createNdjsonParserStream,
streamToAsyncIterable,
extractIndexAndTask,
type OversizedItemMarker,
} from "../../app/runEngine/services/streamBatchItems.server";
import { ServiceValidationError } from "../../app/v3/services/baseService.server";
vi.setConfig({ testTimeout: 30_000 }); // 30 seconds timeout
describe("StreamBatchItemsService", () => {
/**
* Helper to create a batch directly in the database
*/
async function createBatch(
prisma: PrismaClient,
environmentId: string,
options: {
runCount: number;
status?: "PENDING" | "PROCESSING" | "COMPLETED" | "ABORTED";
sealed?: boolean;
}
) {
const { id, friendlyId } = BatchId.generate();
const batch = await prisma.batchTaskRun.create({
data: {
id,
friendlyId,
runtimeEnvironmentId: environmentId,
status: options.status ?? "PENDING",
runCount: options.runCount,
expectedCount: options.runCount,
runIds: [],
batchVersion: "runengine:v2",
sealed: options.sealed ?? false,
},
});
return batch;
}
/**
* Helper to create an async iterable from items
*/
async function* itemsToAsyncIterable(
items: Array<{ task: string; payload: string; index: number }>
) {
for (const item of items) {
yield item;
}
}
containerTest(
"should seal batch successfully when no race condition",
async ({ prisma, redisOptions }) => {
const engine = new RunEngine({
prisma,
worker: {
redis: redisOptions,
workers: 1,
tasksPerWorker: 10,
pollIntervalMs: 100,
disabled: true,
},
queue: {
redis: redisOptions,
},
runLock: {
redis: redisOptions,
},
machines: {
defaultMachine: "small-1x",
machines: {
"small-1x": {
name: "small-1x" as const,
cpu: 0.5,
memory: 0.5,
centsPerMs: 0.0001,
},
},
baseCostInCents: 0.0005,
},
batchQueue: {
redis: redisOptions,
},
tracer: trace.getTracer("test", "0.0.0"),
});
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
// Create a batch
const batch = await createBatch(prisma, authenticatedEnvironment.id, {
runCount: 2,
status: "PENDING",
sealed: false,
});
// Initialize the batch in Redis
await engine.initializeBatch({
batchId: batch.id,
friendlyId: batch.friendlyId,
environmentId: authenticatedEnvironment.id,
environmentType: authenticatedEnvironment.type,
organizationId: authenticatedEnvironment.organizationId,
projectId: authenticatedEnvironment.projectId,
runCount: 2,
processingConcurrency: 10,
});
// Enqueue items directly to Redis (bypassing the service's item processing)
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 0, {
task: "test-task",
payload: JSON.stringify({ data: "item1" }),
payloadType: "application/json",
});
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 1, {
task: "test-task",
payload: JSON.stringify({ data: "item2" }),
payloadType: "application/json",
});
// Create service with our test engine and prisma
const service = new StreamBatchItemsService({
prisma,
engine,
});
// Create an empty items iterator since items are already enqueued
const items = itemsToAsyncIterable([]);
const result = await service.call(authenticatedEnvironment, batch.friendlyId, items, {
maxItemBytes: 1024 * 1024,
});
expect(result.sealed).toBe(true);
expect(result.id).toBe(batch.friendlyId);
// Verify the batch is sealed in the database
const updatedBatch = await prisma.batchTaskRun.findUnique({
where: { id: batch.id },
});
expect(updatedBatch?.sealed).toBe(true);
expect(updatedBatch?.status).toBe("PROCESSING");
expect(updatedBatch?.sealedAt).toBeDefined();
expect(updatedBatch?.processingStartedAt).toBeDefined();
await engine.quit();
}
);
containerTest(
"should handle race condition when batch already sealed by another request",
async ({ prisma, redisOptions }) => {
const engine = new RunEngine({
prisma,
worker: {
redis: redisOptions,
workers: 1,
tasksPerWorker: 10,
pollIntervalMs: 100,
disabled: true,
},
queue: {
redis: redisOptions,
},
runLock: {
redis: redisOptions,
},
machines: {
defaultMachine: "small-1x",
machines: {
"small-1x": {
name: "small-1x" as const,
cpu: 0.5,
memory: 0.5,
centsPerMs: 0.0001,
},
},
baseCostInCents: 0.0005,
},
batchQueue: {
redis: redisOptions,
},
tracer: trace.getTracer("test", "0.0.0"),
});
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
// Create a batch that is already sealed and PROCESSING (simulating another request won the race)
const batch = await createBatch(prisma, authenticatedEnvironment.id, {
runCount: 2,
status: "PROCESSING",
sealed: true,
});
// Initialize the batch in Redis with full count
await engine.initializeBatch({
batchId: batch.id,
friendlyId: batch.friendlyId,
environmentId: authenticatedEnvironment.id,
environmentType: authenticatedEnvironment.type,
organizationId: authenticatedEnvironment.organizationId,
projectId: authenticatedEnvironment.projectId,
runCount: 2,
processingConcurrency: 10,
});
// Enqueue items directly
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 0, {
task: "test-task",
payload: JSON.stringify({ data: "item1" }),
payloadType: "application/json",
});
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 1, {
task: "test-task",
payload: JSON.stringify({ data: "item2" }),
payloadType: "application/json",
});
const service = new StreamBatchItemsService({
prisma,
engine,
});
// This should fail because the batch is already sealed
await expect(
service.call(authenticatedEnvironment, batch.friendlyId, itemsToAsyncIterable([]), {
maxItemBytes: 1024 * 1024,
})
).rejects.toThrow(ServiceValidationError);
await engine.quit();
}
);
containerTest(
"should return sealed=true when concurrent request already sealed the batch during seal attempt",
async ({ prisma, redisOptions }) => {
const engine = new RunEngine({
prisma,
worker: {
redis: redisOptions,
workers: 1,
tasksPerWorker: 10,
pollIntervalMs: 100,
disabled: true,
},
queue: {
redis: redisOptions,
},
runLock: {
redis: redisOptions,
},
machines: {
defaultMachine: "small-1x",
machines: {
"small-1x": {
name: "small-1x" as const,
cpu: 0.5,
memory: 0.5,
centsPerMs: 0.0001,
},
},
baseCostInCents: 0.0005,
},
batchQueue: {
redis: redisOptions,
},
tracer: trace.getTracer("test", "0.0.0"),
});
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
// Create a batch in PENDING state
const batch = await createBatch(prisma, authenticatedEnvironment.id, {
runCount: 2,
status: "PENDING",
sealed: false,
});
// Initialize the batch in Redis
await engine.initializeBatch({
batchId: batch.id,
friendlyId: batch.friendlyId,
environmentId: authenticatedEnvironment.id,
environmentType: authenticatedEnvironment.type,
organizationId: authenticatedEnvironment.organizationId,
projectId: authenticatedEnvironment.projectId,
runCount: 2,
processingConcurrency: 10,
});
// Enqueue items
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 0, {
task: "test-task",
payload: JSON.stringify({ data: "item1" }),
payloadType: "application/json",
});
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 1, {
task: "test-task",
payload: JSON.stringify({ data: "item2" }),
payloadType: "application/json",
});
// Create a custom prisma client that simulates a race condition:
// When updateMany is called on batchTaskRun, it returns count: 0 (as if another request beat us)
// but the subsequent findUnique shows the batch is sealed and PROCESSING
const racingPrisma = {
...prisma,
batchTaskRun: {
...prisma.batchTaskRun,
findFirst: prisma.batchTaskRun.findFirst.bind(prisma.batchTaskRun),
updateMany: async () => {
// Simulate another request winning the race - seal the batch first
await prisma.batchTaskRun.update({
where: { id: batch.id },
data: {
sealed: true,
sealedAt: new Date(),
status: "PROCESSING",
processingStartedAt: new Date(),
},
});
// Return 0 as if the conditional update failed
return { count: 0 };
},
findUnique: prisma.batchTaskRun.findUnique.bind(prisma.batchTaskRun),
},
} as unknown as PrismaClient;
const service = new StreamBatchItemsService({
prisma: racingPrisma,
engine,
});
// Call the service - it should detect the race and return success since batch is sealed
const result = await service.call(
authenticatedEnvironment,
batch.friendlyId,
itemsToAsyncIterable([]),
{
maxItemBytes: 1024 * 1024,
}
);
// Should return sealed=true because the batch was sealed (by the "other" request)
expect(result.sealed).toBe(true);
expect(result.id).toBe(batch.friendlyId);
// Verify the batch is sealed in the database
const updatedBatch = await prisma.batchTaskRun.findUnique({
where: { id: batch.id },
});
expect(updatedBatch?.sealed).toBe(true);
expect(updatedBatch?.status).toBe("PROCESSING");
await engine.quit();
}
);
containerTest(
"should return sealed=true when batch is COMPLETED by BatchQueue before seal attempt",
async ({ prisma, redisOptions }) => {
const engine = new RunEngine({
prisma,
worker: {
redis: redisOptions,
workers: 1,
tasksPerWorker: 10,
pollIntervalMs: 100,
disabled: true,
},
queue: {
redis: redisOptions,
},
runLock: {
redis: redisOptions,
},
machines: {
defaultMachine: "small-1x",
machines: {
"small-1x": {
name: "small-1x" as const,
cpu: 0.5,
memory: 0.5,
centsPerMs: 0.0001,
},
},
baseCostInCents: 0.0005,
},
batchQueue: {
redis: redisOptions,
},
tracer: trace.getTracer("test", "0.0.0"),
});
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
// Create a batch in PENDING state
const batch = await createBatch(prisma, authenticatedEnvironment.id, {
runCount: 2,
status: "PENDING",
sealed: false,
});
// Initialize the batch in Redis
await engine.initializeBatch({
batchId: batch.id,
friendlyId: batch.friendlyId,
environmentId: authenticatedEnvironment.id,
environmentType: authenticatedEnvironment.type,
organizationId: authenticatedEnvironment.organizationId,
projectId: authenticatedEnvironment.projectId,
runCount: 2,
processingConcurrency: 10,
});
// Enqueue items - the enqueued count check passes but the seal updateMany
// will race with tryCompleteBatch moving status to COMPLETED.
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 0, {
task: "test-task",
payload: JSON.stringify({ data: "item1" }),
payloadType: "application/json",
});
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 1, {
task: "test-task",
payload: JSON.stringify({ data: "item2" }),
payloadType: "application/json",
});
// Simulate the race where BatchQueue's completionCallback runs
// tryCompleteBatch between getEnqueuedCount and the seal updateMany.
// tryCompleteBatch sets status=COMPLETED but NOT sealed=true.
const racingPrisma = {
...prisma,
batchTaskRun: {
...prisma.batchTaskRun,
findFirst: prisma.batchTaskRun.findFirst.bind(prisma.batchTaskRun),
updateMany: async () => {
await prisma.batchTaskRun.update({
where: { id: batch.id },
data: {
status: "COMPLETED",
},
});
// The conditional updateMany(where: status="PENDING") would now fail
return { count: 0 };
},
findUnique: prisma.batchTaskRun.findUnique.bind(prisma.batchTaskRun),
},
} as unknown as PrismaClient;
const service = new StreamBatchItemsService({
prisma: racingPrisma,
engine,
});
const result = await service.call(
authenticatedEnvironment,
batch.friendlyId,
itemsToAsyncIterable([]),
{
maxItemBytes: 1024 * 1024,
}
);
// The endpoint should accept the COMPLETED state as a success case so the
// SDK does not retry a batch whose child runs have already finished.
expect(result.sealed).toBe(true);
expect(result.id).toBe(batch.friendlyId);
const updatedBatch = await prisma.batchTaskRun.findUnique({
where: { id: batch.id },
});
expect(updatedBatch?.status).toBe("COMPLETED");
// sealed stays false because the BatchQueue completion path does not set
// it - that's fine, the batch is terminal.
expect(updatedBatch?.sealed).toBe(false);
await engine.quit();
}
);
containerTest(
"should throw error when race condition leaves batch in unexpected state",
async ({ prisma, redisOptions }) => {
const engine = new RunEngine({
prisma,
worker: {
redis: redisOptions,
workers: 1,
tasksPerWorker: 10,
pollIntervalMs: 100,
disabled: true,
},
queue: {
redis: redisOptions,
},
runLock: {
redis: redisOptions,
},
machines: {
defaultMachine: "small-1x",
machines: {
"small-1x": {
name: "small-1x" as const,
cpu: 0.5,
memory: 0.5,
centsPerMs: 0.0001,
},
},
baseCostInCents: 0.0005,
},
batchQueue: {
redis: redisOptions,
},
tracer: trace.getTracer("test", "0.0.0"),
});
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
// Create a batch in PENDING state
const batch = await createBatch(prisma, authenticatedEnvironment.id, {
runCount: 2,
status: "PENDING",
sealed: false,
});
// Initialize the batch in Redis
await engine.initializeBatch({
batchId: batch.id,
friendlyId: batch.friendlyId,
environmentId: authenticatedEnvironment.id,
environmentType: authenticatedEnvironment.type,
organizationId: authenticatedEnvironment.organizationId,
projectId: authenticatedEnvironment.projectId,
runCount: 2,
processingConcurrency: 10,
});
// Enqueue items
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 0, {
task: "test-task",
payload: JSON.stringify({ data: "item1" }),
payloadType: "application/json",
});
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 1, {
task: "test-task",
payload: JSON.stringify({ data: "item2" }),
payloadType: "application/json",
});
// Create a custom prisma client that simulates a race condition where
// the batch ends up in an unexpected state (ABORTED instead of PROCESSING)
const racingPrisma = {
...prisma,
batchTaskRun: {
...prisma.batchTaskRun,
findFirst: prisma.batchTaskRun.findFirst.bind(prisma.batchTaskRun),
updateMany: async () => {
// Simulate the batch being aborted by another process
await prisma.batchTaskRun.update({
where: { id: batch.id },
data: {
sealed: true,
status: "ABORTED",
},
});
// Return 0 as if the conditional update failed
return { count: 0 };
},
findUnique: prisma.batchTaskRun.findUnique.bind(prisma.batchTaskRun),
},
} as unknown as PrismaClient;
const service = new StreamBatchItemsService({
prisma: racingPrisma,
engine,
});
// Call the service - it should throw because the batch is in an unexpected state
await expect(
service.call(authenticatedEnvironment, batch.friendlyId, itemsToAsyncIterable([]), {
maxItemBytes: 1024 * 1024,
})
).rejects.toThrow(/unexpected state/);
await engine.quit();
}
);
containerTest(
"should return sealed=false when item count does not match",
async ({ prisma, redisOptions }) => {
const engine = new RunEngine({
prisma,
worker: {
redis: redisOptions,
workers: 1,
tasksPerWorker: 10,
pollIntervalMs: 100,
disabled: true,
},
queue: {
redis: redisOptions,
},
runLock: {
redis: redisOptions,
},
machines: {
defaultMachine: "small-1x",
machines: {
"small-1x": {
name: "small-1x" as const,
cpu: 0.5,
memory: 0.5,
centsPerMs: 0.0001,
},
},
baseCostInCents: 0.0005,
},
batchQueue: {
redis: redisOptions,
},
tracer: trace.getTracer("test", "0.0.0"),
});
const authenticatedEnvironment = await setupAuthenticatedEnvironment(prisma, "PRODUCTION");
// Create a batch expecting 3 items
const batch = await createBatch(prisma, authenticatedEnvironment.id, {
runCount: 3,
status: "PENDING",
sealed: false,
});
// Initialize the batch in Redis
await engine.initializeBatch({
batchId: batch.id,
friendlyId: batch.friendlyId,
environmentId: authenticatedEnvironment.id,
environmentType: authenticatedEnvironment.type,
organizationId: authenticatedEnvironment.organizationId,
projectId: authenticatedEnvironment.projectId,
runCount: 3,
processingConcurrency: 10,
});
// Only enqueue 2 items (1 short of expected)
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 0, {
task: "test-task",
payload: JSON.stringify({ data: "item1" }),
payloadType: "application/json",
});
await engine.enqueueBatchItem(batch.id, authenticatedEnvironment.id, 1, {
task: "test-task",
payload: JSON.stringify({ data: "item2" }),
payloadType: "application/json",
});
const service = new StreamBatchItemsService({
prisma,
engine,
});
const result = await service.call(
authenticatedEnvironment,
batch.friendlyId,
itemsToAsyncIterable([]),
{
maxItemBytes: 1024 * 1024,
}
);
// Should return sealed=false because item count doesn't match
expect(result.sealed).toBe(false);
expect(result.enqueuedCount).toBe(2);
expect(result.expectedCount).toBe(3);
// Verify the batch is NOT sealed in the database
const updatedBatch = await prisma.batchTaskRun.findUnique({
where: { id: batch.id },
});
expect(updatedBatch?.sealed).toBe(false);
expect(updatedBatch?.status).toBe("PENDING");
await engine.quit();
}
);
});
describe("createNdjsonParserStream", () => {
/**
* Helper to collect all items from a ReadableStream
*/
async function collectStream<T>(stream: ReadableStream<T>): Promise<T[]> {
const results: T[] = [];
for await (const item of streamToAsyncIterable(stream)) {
results.push(item);
}
return results;
}
/**
* Helper to create a ReadableStream from an array of Uint8Array chunks
*/
function chunksToStream(chunks: Uint8Array[]): ReadableStream<Uint8Array> {
let index = 0;
return new ReadableStream({
pull(controller) {
if (index < chunks.length) {
controller.enqueue(chunks[index++]);
} else {
controller.close();
}
},
});
}
it("should parse basic NDJSON correctly", async () => {
const ndjson = '{"name":"alice"}\n{"name":"bob"}\n{"name":"charlie"}\n';
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(ndjson)]);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ name: "alice" }, { name: "bob" }, { name: "charlie" }]);
});
it("should handle NDJSON without trailing newline", async () => {
const ndjson = '{"id":1}\n{"id":2}';
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(ndjson)]);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ id: 1 }, { id: 2 }]);
});
it("should handle escaped newlines in JSON string values", async () => {
// JSON.stringify escapes newlines as \n (two chars: backslash + n),
// so they don't break NDJSON line boundaries. This is the normal case
// when the SDK serializes payloads containing newlines.
const item1 = JSON.stringify({ payload: "line1\nline2\nline3" });
const item2 = JSON.stringify({ payload: "no newlines" });
const ndjson = item1 + "\n" + item2 + "\n";
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(ndjson)]);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([
{ payload: "line1\nline2\nline3" },
{ payload: "no newlines" },
]);
});
it("should skip empty lines", async () => {
const ndjson = '{"a":1}\n\n{"b":2}\n \n{"c":3}\n';
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(ndjson)]);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ a: 1 }, { b: 2 }, { c: 3 }]);
});
it("should handle chunks split mid-line", async () => {
// Split '{"split":"value"}\n' across multiple chunks
const encoder = new TextEncoder();
const chunks = [encoder.encode('{"spl'), encoder.encode('it":"va'), encoder.encode('lue"}\n')];
const stream = chunksToStream(chunks);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ split: "value" }]);
});
it("should handle multibyte UTF-8 characters split across chunks", async () => {
// Test with emoji and other multibyte characters
// The emoji "😀" is 4 bytes: 0xF0 0x9F 0x98 0x80
const json = '{"emoji":"😀"}\n';
const fullBytes = new TextEncoder().encode(json);
// Split in the middle of the emoji (between byte 2 and 3 of the 4-byte sequence)
// Find where the emoji starts
const emojiStart = fullBytes.indexOf(0xf0);
expect(emojiStart).toBeGreaterThan(0);
// Split after first 2 bytes of the emoji
const chunk1 = fullBytes.slice(0, emojiStart + 2);
const chunk2 = fullBytes.slice(emojiStart + 2);
const stream = chunksToStream([chunk1, chunk2]);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ emoji: "😀" }]);
});
it("should handle multiple multibyte characters across chunks", async () => {
// Japanese text: "こんにちは" (each hiragana is 3 bytes in UTF-8)
const json = '{"greeting":"こんにちは"}\n';
const fullBytes = new TextEncoder().encode(json);
// Split into many small chunks to stress test UTF-8 handling
const chunkSize = 3; // Deliberately misaligned with UTF-8 boundaries
const chunks: Uint8Array[] = [];
for (let i = 0; i < fullBytes.length; i += chunkSize) {
chunks.push(fullBytes.slice(i, i + chunkSize));
}
const stream = chunksToStream(chunks);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ greeting: "こんにちは" }]);
});
it("should emit OversizedItemMarker for lines exceeding maxItemBytes", async () => {
const maxBytes = 50;
// Create a line that exceeds the limit with index and task fields
const largeJson = JSON.stringify({ index: 3, task: "my-task", data: "x".repeat(100) }) + "\n";
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(largeJson)]);
const parser = createNdjsonParserStream(maxBytes);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toHaveLength(1);
const marker = results[0] as OversizedItemMarker;
expect(marker.__batchItemError).toBe("OVERSIZED");
expect(marker.index).toBe(3);
expect(marker.task).toBe("my-task");
expect(marker.maxSize).toBe(maxBytes);
expect(marker.actualSize).toBeGreaterThan(maxBytes);
});
it("should emit OversizedItemMarker for unbounded accumulation without newlines", async () => {
const maxBytes = 50;
// Send data without any newlines that exceeds the buffer limit
const encoder = new TextEncoder();
const chunks = [
encoder.encode('{"index":7,"task":"big-task","start":"'),
encoder.encode("x".repeat(60)), // This will push buffer over 50 bytes
];
const stream = chunksToStream(chunks);
const parser = createNdjsonParserStream(maxBytes);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toHaveLength(1);
const marker = results[0] as OversizedItemMarker;
expect(marker.__batchItemError).toBe("OVERSIZED");
expect(marker.index).toBe(7);
expect(marker.task).toBe("big-task");
expect(marker.maxSize).toBe(maxBytes);
});
it("should skip remaining bytes of oversized line arriving in subsequent chunks", async () => {
const maxBytes = 50;
const encoder = new TextEncoder();
// Simulate a normal item, then an oversized item split across many chunks,
// then another normal item after the newline.
// The oversized line is: {"index":1,"task":"t","data":"xxxx...120 x's...xxxx"}\n
const normalItem1 = '{"index":0,"task":"t","x":1}\n';
const oversizedStart = '{"index":1,"task":"t","data":"';
const oversizedMiddle = "x".repeat(120); // way over 50 bytes
const oversizedEnd = '"}\n';
const normalItem2 = '{"index":2,"task":"t","x":2}\n';
// Send as separate chunks to trigger Case 2 (no newline, buffer > limit)
const chunks = [
encoder.encode(normalItem1 + oversizedStart),
encoder.encode(oversizedMiddle.slice(0, 60)),
encoder.encode(oversizedMiddle.slice(60)),
encoder.encode(oversizedEnd + normalItem2),
];
const stream = chunksToStream(chunks);
const parser = createNdjsonParserStream(maxBytes);
const results = await collectStream(stream.pipeThrough(parser));
// Should get: normal item 1, oversized marker, normal item 2
expect(results).toHaveLength(3);
expect(results[0]).toEqual({ index: 0, task: "t", x: 1 });
expect((results[1] as OversizedItemMarker).__batchItemError).toBe("OVERSIZED");
expect((results[1] as OversizedItemMarker).index).toBe(1);
expect(results[2]).toEqual({ index: 2, task: "t", x: 2 });
});
it("should check byte size before decoding to prevent OOM", async () => {
// This test verifies that size is checked on raw bytes, not decoded string length
// Unicode characters like "🎉" are 4 bytes but 2 UTF-16 code units (string length 2)
const maxBytes = 30;
// Create a line with emojis - each emoji is 4 bytes
// {"e":"🎉🎉🎉🎉🎉"} = 5 + 20 (5 emojis * 4 bytes) + 2 = 27 bytes - should pass
const smallJson = '{"e":"🎉🎉🎉🎉🎉"}\n';
const smallBytes = new TextEncoder().encode(smallJson);
expect(smallBytes.length).toBeLessThan(maxBytes);
// {"e":"🎉🎉🎉🎉🎉🎉🎉"} = 7 emojis * 4 bytes + overhead = 35 bytes - should fail
const largeJson = '{"e":"🎉🎉🎉🎉🎉🎉🎉"}\n';
const largeBytes = new TextEncoder().encode(largeJson);
expect(largeBytes.length).toBeGreaterThan(maxBytes);
// Small one should succeed
const stream1 = chunksToStream([smallBytes]);
const parser1 = createNdjsonParserStream(maxBytes);
const results1 = await collectStream(stream1.pipeThrough(parser1));
expect(results1).toHaveLength(1);
// Large one should emit an OversizedItemMarker
const stream2 = chunksToStream([largeBytes]);
const parser2 = createNdjsonParserStream(maxBytes);
const results2 = await collectStream(stream2.pipeThrough(parser2));
expect(results2).toHaveLength(1);
expect((results2[0] as OversizedItemMarker).__batchItemError).toBe("OVERSIZED");
});
it("should handle final line in flush without trailing newline", async () => {
const ndjson = '{"first":1}\n{"second":2}'; // No trailing newline
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(ndjson)]);
const parser = createNdjsonParserStream(1024);
const results = await collectStream(stream.pipeThrough(parser));
expect(results).toEqual([{ first: 1 }, { second: 2 }]);
});
it("should reject invalid JSON", async () => {
const ndjson = '{"valid":true}\n{invalid json}\n';
const encoder = new TextEncoder();
const stream = chunksToStream([encoder.encode(ndjson)]);
const parser = createNdjsonParserStream(1024);
await expect(collectStream(stream.pipeThrough(parser))).rejects.toThrow(
/Invalid JSON at line 2/
);
});
it("should reject invalid UTF-8 sequences", async () => {
// Invalid UTF-8: 0xFF is never valid in UTF-8
const invalidBytes = new Uint8Array([
0x7b,
0x22,
0x78,
0x22,
0x3a,
0xff,
0x7d,
0x0a, // {"x":�}\n with invalid byte
]);
const stream = chunksToStream([invalidBytes]);
const parser = createNdjsonParserStream(1024);
await expect(collectStream(stream.pipeThrough(parser))).rejects.toThrow(/Invalid UTF-8/);
});
it("should handle many small chunks efficiently", async () => {
// Simulate streaming byte-by-byte
const json = '{"test":"value"}\n';
const bytes = new TextEncoder().encode(json);