Repository navigation
Expand file tree
/
Copy pathexpected-mapspec.sequence.json
More file actions
788 lines (788 loc) · 26.4 KB
/
Copy pathexpected-mapspec.sequence.json
File metadata and controls
788 lines (788 loc) · 26.4 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
{
"schemaVersion": 1,
"meta": {
"title": "Coffee counter order call sequence",
"question": "Who calls whom, in what order, from order submission through payment branches into asynchronous fulfillment and the ready-notification model — including the planned plain-text export?",
"scope": "The seven JavaScript modules under sample-repo read as one call sequence (four synchronous order modules plus the fulfillment queue, runner, and counter notifier); the counter caller itself lives outside the sample repository.",
"languageProfile": "javascript-esm",
"uiLocale": "en",
"diagramKind": "sequence",
"summary": "The sequence companion to the flowchart demo: the same sample repository read as a call order, in two phases. Synchronously, the counter caller (inferred — the caller lives outside the repository) hands the order to the order service, which normalizes items; the rest of the synchronous chain lives inside the reservation-succeeded condition because a failed reservation or a rejected charge propagates the error straight to the caller — within it, the charge splits into exclusive accepted/guard-error branches, and only an accepted charge reaches the receipt step and the asynchronous hand-off to the fulfillment queue (inferred wiring). Asynchronously, a runner claims the job only when one is queued, honors the three-attempt limit, calls the notifier to build the counter-display notification model, and marks the job fulfilled, reporting the outcome back. Every verified claim cites inspected lines of the sample repository; inferred claims mark wiring the repository implies but does not contain, and the planned plain-text export stays unconfirmed. Guard calls are drawn without activation bars because a thrown error ends the exchange on that path."
},
"participants": [
{
"id": "counter",
"title": "Counter caller",
"claimState": "inferred",
"evidence": [
{
"path": "order-service.js",
"lineStart": 5,
"lineEnd": 5,
"symbol": "createOrder",
"note": "The exported orchestration entry implies an outside caller, but no caller code exists in the sample repository.",
"state": "inferred"
}
]
},
{
"id": "order",
"title": "Order service",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 5,
"lineEnd": 13,
"symbol": "createOrder",
"note": "The orchestrator resolves collaborators, normalizes items, reserves inventory, charges, and builds the receipt — with no try/catch, so a thrown guard error ends the exchange before the receipt step.",
"state": "verified"
}
],
"detail": {
"summary": "The orchestration function drives the synchronous exchange; a failed reservation or charge propagates uncaught, and only an accepted charge reaches the receipt step.",
"segments": [
{
"kind": "value",
"title": "Execution sequence",
"subtitle": "createOrder :5-13",
"headers": [
"Step",
"Call",
"Why it matters"
],
"rows": [
[
"1",
"Resolve collaborators",
"Injected dependencies override the imported defaults for tests"
],
[
"2",
"normalizeItems",
"Guarantees a stable sku / quantity / unitCents shape"
],
[
"3",
"reserveIngredients",
"Throws on unavailable items; otherwise returns totalCents"
],
[
"4",
"chargeCard",
"Throws on guard failures; otherwise returns the accepted result"
],
[
"5",
"makeReceipt",
"Reached only after both guards passed"
]
]
}
]
}
},
{
"id": "inventory",
"title": "Inventory checker",
"claimState": "verified",
"evidence": [
{
"path": "inventory-checker.js",
"lineStart": 7,
"lineEnd": 18,
"symbol": "reserveIngredients",
"note": "Decrements catalog availability and returns the reserved total in minor units; an unavailable item throws before any charge.",
"state": "verified"
}
]
},
{
"id": "payment",
"title": "Payment gateway",
"claimState": "verified",
"evidence": [
{
"path": "payment-gateway.js",
"lineStart": 1,
"lineEnd": 12,
"symbol": "chargeCard",
"note": "Synchronous guards first, then an accepted result with a demo reference.",
"state": "verified"
}
]
},
{
"id": "receipt",
"title": "Receipt renderer",
"claimState": "verified",
"evidence": [
{
"path": "receipt-renderer.js",
"lineStart": 1,
"lineEnd": 9,
"symbol": "makeReceipt",
"note": "Assembles the final receipt model from order id, items, and payment result.",
"state": "verified"
}
],
"detail": {
"summary": "The receipt model is the single return value of the synchronous exchange.",
"segments": [
{
"kind": "schema",
"title": "Receipt shape",
"subtitle": "makeReceipt :1-9",
"headers": [
"Field",
"Source",
"Role"
],
"rows": [
[
"orderId",
"input.orderId",
"Carries the caller's reference unchanged"
],
[
"lines",
"items",
"One 'quantity × sku' line per normalized item"
],
[
"paymentStatus",
"payment.status",
"Mirrors the charge outcome branch"
],
[
"paymentReference",
"payment.reference",
"Demo reference returned by the gateway"
]
]
}
]
}
},
{
"id": "runner",
"title": "Fulfillment runner",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 1,
"lineEnd": 16,
"symbol": "runDueFulfillment",
"note": "Imports the queue and notifier, polls, returns null on an empty queue, claims, notifies, and marks the job fulfilled.",
"state": "verified"
}
]
},
{
"id": "queue",
"title": "Fulfillment queue",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 4,
"lineEnd": 28,
"symbol": "enqueueFulfillment",
"note": "Holds queued jobs, enforces the three-attempt claim limit, and records the fulfilled state.",
"state": "verified"
}
]
},
{
"id": "notifier",
"title": "Counter notifier",
"claimState": "verified",
"evidence": [
{
"path": "barista-notifier.js",
"lineStart": 1,
"lineEnd": 12,
"symbol": "notifyCustomer",
"note": "Builds the counter-display notification model and offers a separate acknowledge helper that this call chain does not use. The sample contains no actual delivery or pickup confirmation.",
"state": "verified"
}
]
}
],
"messages": [
{
"from": "counter",
"to": "order",
"label": "Submit counter order",
"claimState": "inferred",
"evidence": [
{
"path": "order-service.js",
"lineStart": 5,
"lineEnd": 5,
"symbol": "createOrder",
"note": "The entry point exists and is exported; which caller invokes it is inferred, since the sample repository has no caller code.",
"state": "inferred"
}
]
},
{
"from": "order",
"to": "order",
"label": "normalizeItems",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 9,
"lineEnd": 9,
"symbol": "createOrder",
"note": "The orchestrator normalizes items before any reservation.",
"state": "verified"
},
{
"path": "order-service.js",
"lineStart": 15,
"lineEnd": 21,
"symbol": "normalizeItems",
"note": "Skus become strings, quantities clamp to at least 1, unit amounts coerce to numbers.",
"state": "verified"
}
]
},
{
"from": "order",
"to": "inventory",
"label": "reserveIngredients",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 10,
"lineEnd": 10,
"symbol": "createOrder",
"note": "Reservation runs on the normalized items.",
"state": "verified"
},
{
"path": "inventory-checker.js",
"lineStart": 7,
"lineEnd": 18,
"symbol": "reserveIngredients",
"note": "A catalog hit with sufficient available quantity decrements availability; a hit with insufficient stock also throws before any charge.",
"state": "verified"
}
]
},
{
"frame": true,
"kind": "opt",
"label": "Reservation succeeded",
"messages": [
{
"from": "inventory",
"to": "order",
"label": "return totalCents",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "inventory-checker.js",
"lineStart": 17,
"lineEnd": 17,
"symbol": "reserveIngredients",
"note": "The reservation object with the total in minor units is the return value; an unavailable item throws instead and the sequence ends at the caller.",
"state": "verified"
}
]
},
{
"from": "order",
"to": "payment",
"label": "chargeCard with amountCents",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 11,
"lineEnd": 11,
"symbol": "createOrder",
"note": "The charge uses the caller's payment token and the reserved total.",
"state": "verified"
},
{
"path": "payment-gateway.js",
"lineStart": 1,
"lineEnd": 12,
"symbol": "chargeCard",
"note": "Guard checks run before the accepted result is built.",
"state": "verified"
}
],
"detail": {
"summary": "The charge call is fully synchronous and its guards decide the exclusive alt branches.",
"segments": [
{
"kind": "value",
"title": "Guard contract",
"subtitle": "chargeCard :1-12",
"headers": [
"Input",
"Outcome",
"Line"
],
"rows": [
[
"Missing payment token",
"Throws 'A payment token is required'",
":2-4"
],
[
"amountCents <= 0",
"Throws 'The charge amount must be positive'",
":5-7"
],
[
"Both guards pass",
"Returns status accepted with a demo reference",
":8-11"
]
]
}
]
}
},
{
"frame": true,
"kind": "alt",
"branches": [
{
"label": "Payment guards passed",
"messages": [
{
"from": "payment",
"to": "order",
"label": "accepted with reference",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "payment-gateway.js",
"lineStart": 8,
"lineEnd": 11,
"symbol": "chargeCard",
"note": "The accepted status and the demo reference flow into the receipt.",
"state": "verified"
}
]
}
]
},
{
"label": "Token missing or amount invalid",
"messages": [
{
"from": "payment",
"to": "order",
"label": "throw guard error",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "payment-gateway.js",
"lineStart": 2,
"lineEnd": 7,
"symbol": "chargeCard",
"note": "Both guards throw synchronously.",
"state": "verified"
}
]
},
{
"from": "order",
"to": "counter",
"label": "error propagates, no receipt",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 11,
"lineEnd": 11,
"symbol": "createOrder",
"note": "createOrder has no try/catch, so the guard error propagates to the caller and the receipt step at :12 never runs.",
"state": "verified"
}
]
}
]
}
]
},
{
"frame": true,
"kind": "opt",
"label": "Charge accepted",
"messages": [
{
"from": "order",
"to": "receipt",
"label": "makeReceipt",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 12,
"lineEnd": 12,
"symbol": "createOrder",
"note": "The receipt builder runs only after both guards passed.",
"state": "verified"
},
{
"path": "receipt-renderer.js",
"lineStart": 1,
"lineEnd": 9,
"symbol": "makeReceipt",
"note": "Builds the receipt model in one synchronous pass.",
"state": "verified"
}
]
},
{
"from": "receipt",
"to": "order",
"label": "receipt with payment status",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "receipt-renderer.js",
"lineStart": 3,
"lineEnd": 8,
"symbol": "makeReceipt",
"note": "The returned model mirrors the payment status and reference.",
"state": "verified"
}
]
},
{
"from": "order",
"to": "counter",
"label": "return finalized receipt",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "order-service.js",
"lineStart": 12,
"lineEnd": 12,
"symbol": "createOrder",
"note": "The receipt is the return value; the synchronous exchange closes here.",
"state": "verified"
}
]
},
{
"from": "order",
"to": "queue",
"label": "enqueueFulfillment",
"claimState": "inferred",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 4,
"lineEnd": 8,
"symbol": "enqueueFulfillment",
"note": "The exported enqueue API exists; calling it from createOrder after the receipt is reasonable wiring the sample repository does not yet contain.",
"state": "inferred"
}
],
"detail": {
"summary": "Inferred wiring: the sample repository only contains the exported enqueue API — the order service never calls it. This edge shows the planned full chain.",
"segments": []
}
},
{
"from": "queue",
"to": "order",
"label": "job queued",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 7,
"lineEnd": 7,
"symbol": "enqueueFulfillment",
"note": "The queued job object is the return value.",
"state": "verified"
}
]
}
]
}
]
},
{
"from": "counter",
"to": "runner",
"label": "runDueFulfillment",
"claimState": "inferred",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 4,
"lineEnd": 16,
"symbol": "runDueFulfillment",
"note": "The exported runner entry exists; a counter-side trigger is reasonable wiring the sample repository does not contain.",
"state": "inferred"
}
]
},
{
"from": "runner",
"to": "queue",
"label": "pollNextJob",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 5,
"lineEnd": 5,
"symbol": "runDueFulfillment",
"note": "The runner polls the queue before claiming.",
"state": "verified"
},
{
"path": "fulfillment-queue.js",
"lineStart": 10,
"lineEnd": 12,
"symbol": "pollNextJob",
"note": "Returns the first queued job or null.",
"state": "verified"
}
]
},
{
"from": "queue",
"to": "runner",
"label": "queued job or null",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 11,
"lineEnd": 11,
"symbol": "pollNextJob",
"note": "The find result is the poll answer.",
"state": "verified"
}
]
},
{
"frame": true,
"kind": "opt",
"label": "Queued job exists",
"messages": [
{
"from": "runner",
"to": "queue",
"label": "claimJob",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 6,
"lineEnd": 9,
"symbol": "runDueFulfillment",
"note": "A null poll result returns early at :6-8; only a queued job reaches the claim at :9.",
"state": "verified"
},
{
"path": "fulfillment-queue.js",
"lineStart": 14,
"lineEnd": 22,
"symbol": "claimJob",
"note": "Increments attempts; the three-attempt limit decides claimed versus blocked.",
"state": "verified"
}
]
},
{
"frame": true,
"kind": "alt",
"branches": [
{
"label": "Within attempt limit",
"messages": [
{
"from": "queue",
"to": "runner",
"label": "claimed",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 20,
"lineEnd": 21,
"symbol": "claimJob",
"note": "Below the limit the job is marked claimed and the flag returns true.",
"state": "verified"
}
]
},
{
"from": "runner",
"to": "notifier",
"label": "notifyCustomer",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 13,
"lineEnd": 13,
"symbol": "runDueFulfillment",
"note": "After a successful claim, the runner calls notifyCustomer to build the customer notification model.",
"state": "verified"
},
{
"path": "barista-notifier.js",
"lineStart": 1,
"lineEnd": 8,
"symbol": "notifyCustomer",
"note": "Builds the counter-display notification for the order.",
"state": "verified"
}
]
},
{
"from": "notifier",
"to": "runner",
"label": "notification for counter display",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "barista-notifier.js",
"lineStart": 2,
"lineEnd": 7,
"symbol": "notifyCustomer",
"note": "The notification model carries orderId, receipt reference, and the counter-display channel.",
"state": "verified"
}
]
},
{
"from": "runner",
"to": "queue",
"label": "markFulfilled",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 14,
"lineEnd": 14,
"symbol": "runDueFulfillment",
"note": "After building the notification model, the runner closes the job as fulfilled.",
"state": "verified"
},
{
"path": "fulfillment-queue.js",
"lineStart": 24,
"lineEnd": 28,
"symbol": "markFulfilled",
"note": "Records the fulfilled status and the receipt reference.",
"state": "verified"
}
]
},
{
"from": "queue",
"to": "runner",
"label": "fulfilled job",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 25,
"lineEnd": 27,
"symbol": "markFulfilled",
"note": "The updated job object is the return value.",
"state": "verified"
}
]
}
]
},
{
"label": "Attempt limit exhausted",
"messages": [
{
"from": "queue",
"to": "runner",
"label": "blocked after three attempts",
"arrowKind": "dashed",
"claimState": "verified",
"evidence": [
{
"path": "fulfillment-queue.js",
"lineStart": 16,
"lineEnd": 19,
"symbol": "claimJob",
"note": "At the limit the job is marked blocked and the flag returns false.",
"state": "verified"
}
]
}
]
}
]
},
{
"from": "runner",
"to": "counter",
"label": "fulfillment outcome",
"arrowKind": "dashed",
"claimState": "inferred",
"evidence": [
{
"path": "fulfillment-runner.js",
"lineStart": 15,
"lineEnd": 15,
"symbol": "runDueFulfillment",
"note": "The runner returns the outcome object; delivering it to the counter surface is reasonable wiring the sample repository does not contain.",
"state": "inferred"
}
]
}
]
},
{
"frame": true,
"kind": "opt",
"label": "Plain-text receipt export (planned)",
"messages": [
{
"from": "order",
"to": "counter",
"label": "send toPlainText export",
"claimState": "unconfirmed",
"evidence": [
{
"path": "receipt-renderer.js",
"lineStart": 11,
"lineEnd": 13,
"symbol": "toPlainText",
"note": "The export helper exists in the code, but the orchestrator never calls it; the planned wiring is unconfirmed.",
"state": "unconfirmed"
}
]
}
]
}
]
}