-
Notifications
You must be signed in to change notification settings - Fork 333
/
Copy pathproving_broker.test.ts
1114 lines (933 loc) · 35.3 KB
/
proving_broker.test.ts
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 {
ProvingRequestType,
type V2ProofOutput,
type V2ProvingJob,
type V2ProvingJobId,
makePublicInputsAndRecursiveProof,
} from '@aztec/circuit-types';
import { RECURSIVE_PROOF_LENGTH, VerificationKeyData, makeRecursiveProof } from '@aztec/circuits.js';
import {
makeBaseOrMergeRollupPublicInputs,
makeBaseParityInputs,
makeParityPublicInputs,
makePrivateBaseRollupInputs,
makeRootParityInputs,
} from '@aztec/circuits.js/testing';
import { randomBytes } from '@aztec/foundation/crypto';
import { AztecLmdbStore } from '@aztec/kv-store/lmdb';
import { jest } from '@jest/globals';
import { ProvingBroker } from './proving_broker.js';
import { type ProvingJobDatabase } from './proving_job_database.js';
import { InMemoryDatabase } from './proving_job_database/memory.js';
import { PersistedProvingJobDatabase } from './proving_job_database/persisted.js';
beforeAll(() => {
jest.useFakeTimers();
});
describe.each([
() => ({ database: new InMemoryDatabase(), cleanup: undefined }),
() => {
const store = AztecLmdbStore.open(undefined, true);
const database = new PersistedProvingJobDatabase(store);
const cleanup = () => store.close();
return { database, cleanup };
},
])('ProvingBroker', createDb => {
let broker: ProvingBroker;
let jobTimeoutSec: number;
let maxRetries: number;
let database: ProvingJobDatabase;
let cleanup: undefined | (() => Promise<void> | void);
const now = () => Math.floor(Date.now() / 1000);
beforeEach(() => {
jobTimeoutSec = 10;
maxRetries = 2;
({ database, cleanup } = createDb());
broker = new ProvingBroker(database, {
jobTimeoutSec: jobTimeoutSec,
timeoutIntervalSec: jobTimeoutSec / 4,
maxRetries,
});
});
afterEach(async () => {
if (cleanup) {
await cleanup();
}
});
describe('Producer API', () => {
beforeEach(async () => {
await broker.start();
});
afterEach(async () => {
await broker.stop();
});
it('enqueues jobs', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
blockNumber: 1,
type: ProvingRequestType.BASE_PARITY,
inputs: makeBaseParityInputs(),
});
expect(await broker.getProvingJobStatus(id)).toEqual({ status: 'in-queue' });
const id2 = makeProvingJobId();
await broker.enqueueProvingJob({
id: id2,
blockNumber: 1,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
inputs: makePrivateBaseRollupInputs(),
});
expect(await broker.getProvingJobStatus(id2)).toEqual({ status: 'in-queue' });
});
it('ignores duplicate jobs', async () => {
const provingJob: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(provingJob);
await expect(broker.enqueueProvingJob(provingJob)).resolves.toBeUndefined();
await expect(broker.getProvingJobStatus(provingJob.id)).resolves.toEqual({ status: 'in-queue' });
});
it('throws an error in case of duplicate job IDs', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
blockNumber: 1,
type: ProvingRequestType.BASE_PARITY,
inputs: makeBaseParityInputs(1),
});
await expect(
broker.enqueueProvingJob({
id,
blockNumber: 1,
type: ProvingRequestType.BASE_PARITY,
inputs: makeBaseParityInputs(2),
}),
).rejects.toThrow('Duplicate proving job ID');
});
it('returns not-found status for non-existing jobs', async () => {
const status = await broker.getProvingJobStatus(makeProvingJobId());
expect(status).toEqual({ status: 'not-found' });
});
it('cancels jobs in queue', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
blockNumber: 1,
type: ProvingRequestType.BASE_PARITY,
inputs: makeBaseParityInputs(),
});
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({ status: 'in-queue' });
await broker.removeAndCancelProvingJob(id);
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({ status: 'not-found' });
});
it('cancels jobs in-progress', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
blockNumber: 1,
type: ProvingRequestType.BASE_PARITY,
inputs: makeBaseParityInputs(),
});
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({ status: 'in-queue' });
await broker.getProvingJob();
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({ status: 'in-progress' });
await broker.removeAndCancelProvingJob(id);
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({ status: 'not-found' });
});
it('returns job result if successful', async () => {
const provingJob: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(provingJob);
const value = makePublicInputsAndRecursiveProof(
makeParityPublicInputs(RECURSIVE_PROOF_LENGTH),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
);
await broker.reportProvingJobSuccess(provingJob.id, { type: ProvingRequestType.BASE_PARITY, value });
const status = await broker.getProvingJobStatus(provingJob.id);
expect(status).toEqual({ status: 'resolved', value: { type: ProvingRequestType.BASE_PARITY, value } });
});
it('returns job error if failed', async () => {
const provingJob: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(provingJob);
const error = new Error('test error');
await broker.reportProvingJobError(provingJob.id, error);
const status = await broker.getProvingJobStatus(provingJob.id);
expect(status).toEqual({ status: 'rejected', error: String(error) });
});
});
describe('Consumer API', () => {
beforeEach(async () => {
await broker.start();
});
afterEach(async () => {
await broker.stop();
});
it('returns undefined if no jobs are available', async () => {
const provingJob = await broker.getProvingJob({ allowList: [ProvingRequestType.BASE_PARITY] });
expect(provingJob).toBeUndefined();
});
it('returns jobs in priority order', async () => {
const provingJob1: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
const provingJob2: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 2,
inputs: makeBaseParityInputs(),
};
const provingJob3: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 3,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(provingJob2);
await broker.enqueueProvingJob(provingJob3);
await broker.enqueueProvingJob(provingJob1);
await getAndAssertNextJobId(provingJob1.id, ProvingRequestType.BASE_PARITY);
});
it('returns undefined if no jobs are available for the given allowList', async () => {
await broker.enqueueProvingJob({
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await expect(
broker.getProvingJob({ allowList: [ProvingRequestType.PRIVATE_BASE_ROLLUP] }),
).resolves.toBeUndefined();
});
it('returns a job if it is in the allowList', async () => {
const baseParity1 = makeProvingJobId();
await broker.enqueueProvingJob({
id: baseParity1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
const baseRollup1 = makeProvingJobId();
await broker.enqueueProvingJob({
id: baseRollup1,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 1,
inputs: makePrivateBaseRollupInputs(),
});
const baseRollup2 = makeProvingJobId();
await broker.enqueueProvingJob({
id: baseRollup2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: makePrivateBaseRollupInputs(),
});
const rootParity1 = makeProvingJobId();
await broker.enqueueProvingJob({
id: rootParity1,
type: ProvingRequestType.ROOT_PARITY,
blockNumber: 1,
inputs: makeRootParityInputs(),
});
await getAndAssertNextJobId(baseParity1, ProvingRequestType.BASE_PARITY);
});
it('returns the most important job if it is in the allowList', async () => {
const baseParity1 = makeProvingJobId();
await broker.enqueueProvingJob({
id: baseParity1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
const baseRollup1 = makeProvingJobId();
await broker.enqueueProvingJob({
id: baseRollup1,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 1,
inputs: makePrivateBaseRollupInputs(),
});
const baseRollup2 = makeProvingJobId();
await broker.enqueueProvingJob({
id: baseRollup2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: makePrivateBaseRollupInputs(),
});
const rootParity1 = makeProvingJobId();
await broker.enqueueProvingJob({
id: rootParity1,
type: ProvingRequestType.ROOT_PARITY,
blockNumber: 1,
inputs: makeRootParityInputs(),
});
await getAndAssertNextJobId(
baseRollup1,
ProvingRequestType.BASE_PARITY,
ProvingRequestType.PRIVATE_BASE_ROLLUP,
ProvingRequestType.ROOT_PARITY,
);
});
it('returns a new job when reporting progress if current one is cancelled', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await broker.getProvingJob();
await assertJobStatus(id, 'in-progress');
await broker.removeAndCancelProvingJob(id);
await assertJobStatus(id, 'not-found');
const id2 = makeProvingJobId();
await broker.enqueueProvingJob({
id: id2,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await expect(
broker.reportProvingJobProgress(id, now(), { allowList: [ProvingRequestType.BASE_PARITY] }),
).resolves.toEqual({ job: expect.objectContaining({ id: id2 }), time: expect.any(Number) });
});
it('returns a new job if job is already in progress elsewhere', async () => {
// this test simulates the broker crashing and when it comes back online it has two agents working the same job
const job1: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
const job2: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 2,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(job1);
await broker.enqueueProvingJob(job2);
const { job: firstAgentJob, time: firstAgentStartedAt } = (await broker.getProvingJob({
allowList: [ProvingRequestType.BASE_PARITY],
}))!;
expect(firstAgentJob).toEqual(job1);
await assertJobStatus(job1.id, 'in-progress');
await jest.advanceTimersByTimeAsync(jobTimeoutSec / 2);
await expect(
broker.reportProvingJobProgress(job1.id, firstAgentStartedAt, {
allowList: [ProvingRequestType.BASE_PARITY],
}),
).resolves.toBeUndefined();
// restart the broker!
await broker.stop();
// fake some time passing while the broker restarts
await jest.advanceTimersByTimeAsync(10_000);
broker = new ProvingBroker(database);
await broker.start();
await assertJobStatus(job1.id, 'in-queue');
const { job: secondAgentJob, time: secondAgentStartedAt } = (await broker.getProvingJob({
allowList: [ProvingRequestType.BASE_PARITY],
}))!;
// should be the same job!
expect(secondAgentJob).toEqual(job1);
await assertJobStatus(job1.id, 'in-progress');
// original agent should still be able to report progress
// and it should take over the job from the second agent
await expect(
broker.reportProvingJobProgress(job1.id, firstAgentStartedAt, {
allowList: [ProvingRequestType.BASE_PARITY],
}),
).resolves.toBeUndefined();
// second agent should get a new job now
await expect(
broker.reportProvingJobProgress(job1.id, secondAgentStartedAt, {
allowList: [ProvingRequestType.BASE_PARITY],
}),
).resolves.toEqual({ job: job2, time: expect.any(Number) });
});
it('avoids sending the same job to a new agent after a restart', async () => {
// this test simulates the broker crashing and when it comes back online it has two agents working the same job
const job1: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
const job2: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 2,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(job1);
await broker.enqueueProvingJob(job2);
const { job: firstAgentJob, time: firstAgentStartedAt } = (await broker.getProvingJob({
allowList: [ProvingRequestType.BASE_PARITY],
}))!;
expect(firstAgentJob).toEqual(job1);
await assertJobStatus(job1.id, 'in-progress');
// restart the broker!
await broker.stop();
// fake some time passing while the broker restarts
await jest.advanceTimersByTimeAsync(10_000);
broker = new ProvingBroker(database);
await broker.start();
await assertJobStatus(job1.id, 'in-queue');
// original agent should still be able to report progress
// and it should take over the job from the second agent
await expect(
broker.reportProvingJobProgress(job1.id, firstAgentStartedAt, {
allowList: [ProvingRequestType.BASE_PARITY],
}),
).resolves.toBeUndefined();
const { job: secondAgentJob } = (await broker.getProvingJob({
allowList: [ProvingRequestType.BASE_PARITY],
}))!;
// should be the same job!
expect(secondAgentJob).toEqual(job2);
await assertJobStatus(job1.id, 'in-progress');
await assertJobStatus(job2.id, 'in-progress');
});
it('avoids sending a completed job to a new agent after a restart', async () => {
// this test simulates the broker crashing and when it comes back online it has two agents working the same job
const job1: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
const job2: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 2,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(job1);
await broker.enqueueProvingJob(job2);
await getAndAssertNextJobId(job1.id);
await assertJobStatus(job1.id, 'in-progress');
// restart the broker!
await broker.stop();
// fake some time passing while the broker restarts
await jest.advanceTimersByTimeAsync(100 * jobTimeoutSec * 1000);
broker = new ProvingBroker(database);
await broker.start();
await assertJobStatus(job1.id, 'in-queue');
// after the restart the new broker thinks job1 is available
// inform the agent of the job completion
await expect(
broker.reportProvingJobSuccess(job1.id, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
}),
).resolves.toBeUndefined();
await assertJobStatus(job1.id, 'resolved');
// make sure the the broker sends the next job to the agent
await getAndAssertNextJobId(job2.id);
await assertJobStatus(job1.id, 'resolved');
await assertJobStatus(job2.id, 'in-progress');
});
it('tracks job result if in progress', async () => {
const id1 = makeProvingJobId();
const id2 = makeProvingJobId();
await broker.enqueueProvingJob({
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await broker.enqueueProvingJob({
id: id2,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 2,
inputs: makeBaseParityInputs(),
});
await getAndAssertNextJobId(id1);
await assertJobStatus(id1, 'in-progress');
await broker.reportProvingJobSuccess(id1, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
await assertJobStatus(id1, 'resolved');
await getAndAssertNextJobId(id2);
await assertJobStatus(id2, 'in-progress');
await broker.reportProvingJobError(id2, new Error('test error'));
await assertJobStatus(id2, 'rejected');
});
it('tracks job result even if job is in queue', async () => {
const id1 = makeProvingJobId();
const id2 = makeProvingJobId();
await broker.enqueueProvingJob({
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await broker.enqueueProvingJob({
id: id2,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 2,
inputs: makeBaseParityInputs(),
});
await broker.reportProvingJobSuccess(id1, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
await assertJobStatus(id1, 'resolved');
await broker.reportProvingJobError(id2, new Error('test error'));
await assertJobStatus(id2, 'rejected');
});
it('ignores reported job error if unknown job', async () => {
const id = makeProvingJobId();
await assertJobStatus(id, 'not-found');
await broker.reportProvingJobError(id, new Error('test error'));
await assertJobStatus(id, 'not-found');
});
it('ignores job result if unknown job', async () => {
const id = makeProvingJobId();
await assertJobStatus(id, 'not-found');
await broker.reportProvingJobSuccess(id, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
await assertJobStatus(id, 'not-found');
});
});
describe('Timeouts', () => {
beforeEach(async () => {
await broker.start();
});
afterEach(async () => {
await broker.stop();
});
it('tracks in progress jobs', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await assertJobStatus(id, 'in-queue');
await getAndAssertNextJobId(id);
await assertJobStatus(id, 'in-progress');
});
it('re-enqueues jobs that time out', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await assertJobStatus(id, 'in-queue');
await getAndAssertNextJobId(id);
await assertJobStatus(id, 'in-progress');
// advance time so job times out because of no heartbeats
await jest.advanceTimersByTimeAsync(jobTimeoutSec * 1000);
// should be back in the queue now
await assertJobStatus(id, 'in-queue');
});
it('keeps the jobs in progress while it is alive', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await assertJobStatus(id, 'in-queue');
const { job, time } = (await broker.getProvingJob())!;
expect(job.id).toEqual(id);
await assertJobStatus(id, 'in-progress');
// advance the time slightly, not enough for the request to timeout
await jest.advanceTimersByTimeAsync((jobTimeoutSec * 1000) / 2);
await assertJobStatus(id, 'in-progress');
// send a heartbeat
await broker.reportProvingJobProgress(id, time);
// advance the time again
await jest.advanceTimersByTimeAsync((jobTimeoutSec * 1000) / 2);
// should still be our request to process
await assertJobStatus(id, 'in-progress');
// advance the time again and lose the request
await jest.advanceTimersByTimeAsync(jobTimeoutSec * 1000);
await assertJobStatus(id, 'in-queue');
});
});
describe('Retries', () => {
it('retries jobs', async () => {
const provingJob: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
await broker.enqueueProvingJob(provingJob);
await expect(broker.getProvingJobStatus(provingJob.id)).resolves.toEqual({
status: 'in-queue',
});
await expect(broker.getProvingJob()).resolves.toEqual({ job: provingJob, time: expect.any(Number) });
await expect(broker.getProvingJobStatus(provingJob.id)).resolves.toEqual({
status: 'in-progress',
});
await broker.reportProvingJobError(provingJob.id, new Error('test error'), true);
await expect(broker.getProvingJobStatus(provingJob.id)).resolves.toEqual({
status: 'in-queue',
});
});
it('retries up to a maximum number of times', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
for (let i = 0; i < maxRetries; i++) {
await assertJobStatus(id, 'in-queue');
await getAndAssertNextJobId(id);
await assertJobStatus(id, 'in-progress');
await broker.reportProvingJobError(id, new Error('test error'), true);
}
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({
status: 'rejected',
error: String(new Error('test error')),
});
});
it('passing retry=false does not retry', async () => {
const id = makeProvingJobId();
await broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await getAndAssertNextJobId(id);
await assertJobStatus(id, 'in-progress');
await broker.reportProvingJobError(id, new Error('test error'), false);
await expect(broker.getProvingJobStatus(id)).resolves.toEqual({
status: 'rejected',
error: String(new Error('test error')),
});
});
});
describe('Database management', () => {
afterEach(async () => {
await broker.stop();
});
it('re-enqueues proof requests on start', async () => {
const id1 = makeProvingJobId();
await database.addProvingJob({
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
const id2 = makeProvingJobId();
await database.addProvingJob({
id: id2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: makePrivateBaseRollupInputs(),
});
await broker.start();
await expect(broker.getProvingJobStatus(id1)).resolves.toEqual({ status: 'in-queue' });
await expect(broker.getProvingJobStatus(id2)).resolves.toEqual({ status: 'in-queue' });
await expect(broker.getProvingJob({ allowList: [ProvingRequestType.BASE_PARITY] })).resolves.toEqual({
job: {
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: expect.any(Object),
},
time: expect.any(Number),
});
await expect(broker.getProvingJob()).resolves.toEqual({
job: {
id: id2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: expect.any(Object),
},
time: expect.any(Number),
});
await expect(broker.getProvingJobStatus(id1)).resolves.toEqual({
status: 'in-progress',
});
await expect(broker.getProvingJobStatus(id2)).resolves.toEqual({
status: 'in-progress',
});
});
it('restores proof results on start', async () => {
const id1 = makeProvingJobId();
await database.addProvingJob({
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
const id2 = makeProvingJobId();
await database.addProvingJob({
id: id2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: makePrivateBaseRollupInputs(),
});
await database.setProvingJobResult(id1, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(RECURSIVE_PROOF_LENGTH),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
await database.setProvingJobResult(id2, {
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
value: makePublicInputsAndRecursiveProof(
makeBaseOrMergeRollupPublicInputs(),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
await broker.start();
await expect(broker.getProvingJobStatus(id1)).resolves.toEqual({
status: 'resolved',
value: expect.any(Object),
});
await expect(broker.getProvingJobStatus(id2)).resolves.toEqual({
status: 'resolved',
value: expect.any(Object),
});
});
it('only re-enqueues unfinished jobs', async () => {
const id1 = makeProvingJobId();
await database.addProvingJob({
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await database.setProvingJobResult(id1, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(RECURSIVE_PROOF_LENGTH),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
const id2 = makeProvingJobId();
await database.addProvingJob({
id: id2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: makePrivateBaseRollupInputs(),
});
await broker.start();
await expect(broker.getProvingJobStatus(id1)).resolves.toEqual({
status: 'resolved',
value: expect.any(Object),
});
await expect(broker.getProvingJobStatus(id2)).resolves.toEqual({ status: 'in-queue' });
await getAndAssertNextJobId(id2);
});
it('clears job state when job is removed', async () => {
const id1 = makeProvingJobId();
await database.addProvingJob({
id: id1,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
});
await database.setProvingJobResult(id1, {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(RECURSIVE_PROOF_LENGTH),
makeRecursiveProof(RECURSIVE_PROOF_LENGTH),
VerificationKeyData.makeFake(),
),
});
const id2 = makeProvingJobId();
await database.addProvingJob({
id: id2,
type: ProvingRequestType.PRIVATE_BASE_ROLLUP,
blockNumber: 2,
inputs: makePrivateBaseRollupInputs(),
});
await broker.start();
await expect(broker.getProvingJobStatus(id1)).resolves.toEqual({
status: 'resolved',
value: expect.any(Object),
});
await expect(broker.getProvingJobStatus(id2)).resolves.toEqual({ status: 'in-queue' });
jest.spyOn(database, 'deleteProvingJobAndResult');
await broker.removeAndCancelProvingJob(id1);
await broker.removeAndCancelProvingJob(id2);
expect(database.deleteProvingJobAndResult).toHaveBeenCalledWith(id1);
expect(database.deleteProvingJobAndResult).toHaveBeenCalledWith(id2);
await expect(broker.getProvingJobStatus(id1)).resolves.toEqual({ status: 'not-found' });
await expect(broker.getProvingJobStatus(id2)).resolves.toEqual({ status: 'not-found' });
});
it('saves job when enqueued', async () => {
await broker.start();
const job: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
jest.spyOn(database, 'addProvingJob');
await broker.enqueueProvingJob(job);
expect(database.addProvingJob).toHaveBeenCalledWith(job);
});
it('does not retain job if database fails to save', async () => {
await broker.start();
jest.spyOn(database, 'addProvingJob').mockRejectedValue(new Error('db error'));
const id = makeProvingJobId();
await expect(
broker.enqueueProvingJob({
id,
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
}),
).rejects.toThrow(new Error('db error'));
await assertJobStatus(id, 'not-found');
});
it('saves job result', async () => {
await broker.start();
const job: V2ProvingJob = {
id: makeProvingJobId(),
type: ProvingRequestType.BASE_PARITY,
blockNumber: 1,
inputs: makeBaseParityInputs(),
};
jest.spyOn(database, 'setProvingJobResult');
await broker.enqueueProvingJob(job);
const result: V2ProofOutput = {
type: ProvingRequestType.BASE_PARITY,
value: makePublicInputsAndRecursiveProof(
makeParityPublicInputs(RECURSIVE_PROOF_LENGTH),