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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
use std::collections::{HashMap, HashSet};
use std::pin::Pin;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, OnceLock, Weak};
use std::time::Instant;
use async_trait::async_trait;
use dashmap::{DashMap, DashSet};
use futures::future::BoxFuture;
use opentelemetry::trace::TraceContextExt;
use tokio::sync::{broadcast, mpsc, Notify, RwLock};
use tokio_stream::Stream;
use tracing::instrument;
use tracing_opentelemetry::OpenTelemetrySpanExt;
use crate::config::ShardingConfig;
use crate::detachment::{DetachedState, DetachmentReason};
use crate::durable::{WorkflowEngine, WorkflowStorage, INTERRUPT_SIGNAL};
use crate::entity::Entity;
use crate::entity_client::EntityClient;
use crate::entity_manager::EntityManager;
use crate::entity_reaper::EntityReaper;
use crate::envelope::{AckChunk, Envelope, EnvelopeRequest, Interrupt};
use crate::error::ClusterError;
use crate::hash::shard_for_entity;
use crate::message::{IncomingMessage, ReplyReceiver};
use crate::message_storage::{MessageStorage, SaveResult};
use crate::metrics::ClusterMetrics;
use crate::reply::{
dead_letter_reply_id, fallback_reply_id, ExitResult, Reply, ReplyWithExit, EXIT_SEQUENCE,
};
use crate::runner::Runner;
use crate::runner_health::RunnerHealth;
use crate::runner_storage::{LeaseHealth, RunnerStorage};
use crate::runners::Runners;
use crate::shard_assigner::ShardAssigner;
use crate::sharding::{Sharding, ShardingRegistrationEvent};
use crate::singleton::SingletonContext;
use crate::snowflake::{Snowflake, SnowflakeGenerator};
use crate::types::{EntityId, EntityType, RunnerAddress, ShardId};
/// Implementation of the core sharding orchestrator.
///
/// Manages shard ownership, entity lifecycle, and message routing.
/// Supports two modes:
/// - **Single-node**: Call `acquire_all_shards()` to immediately own all shards.
/// - **Multi-runner**: Call `start().await` to begin the shard acquisition loop with
/// HashRing-based assignment, lock refresh, and remote routing via `Runners`.
pub struct ShardingImpl {
config: Arc<ShardingConfig>,
snowflake: Arc<SnowflakeGenerator>,
runners: Arc<dyn Runners>,
runner_storage: Option<Arc<dyn RunnerStorage>>,
runner_health: Option<Arc<dyn RunnerHealth>>,
message_storage: Option<Arc<dyn MessageStorage>>,
/// Optional key-value storage for persisted entity state.
state_storage: Option<Arc<dyn WorkflowStorage>>,
/// Optional workflow engine for durable context support.
workflow_engine: Option<Arc<dyn WorkflowEngine>>,
metrics: Arc<ClusterMetrics>,
/// Entity managers keyed by entity type name.
entity_managers: Arc<DashMap<EntityType, Arc<EntityManager>>>,
/// Set of shard IDs currently owned (acquired) by this runner.
owned_shards: Arc<RwLock<HashSet<ShardId>>>,
/// Shard-to-runner assignments computed from HashRing.
/// Updated by the shard acquisition loop. Empty in single-node mode.
shard_assignments: RwLock<HashMap<ShardId, RunnerAddress>>,
/// Shards currently being released (prevents re-acquisition during release).
releasing_shards: RwLock<HashSet<ShardId>>,
/// Entity reaper for idle cleanup.
reaper: Arc<EntityReaper>,
/// Registration event broadcaster.
event_tx: broadcast::Sender<ShardingRegistrationEvent>,
/// Singleton registry: name -> (cancel token, run factory).
/// In multi-runner mode, singletons are stored here but only spawned
/// when their computed shard is owned by this runner.
singletons: DashMap<String, SingletonEntry>,
/// Whether shutdown has been initiated.
shutdown: AtomicBool,
/// Cancellation for background tasks.
cancel: tokio_util::sync::CancellationToken,
/// Notifier to trigger storage polling.
storage_poll_notify: Arc<Notify>,
/// Serializes storage polls to prevent concurrent dispatch from the
/// background poll loop and explicit `poll_storage` calls.
storage_poll_lock: tokio::sync::Mutex<()>,
/// Notifier signalled when a new entity type is registered.
/// Used by `route_local` to wait for late entity registrations during startup.
entity_registration_notify: Notify,
/// JoinHandles for background tasks, awaited during shutdown.
background_tasks: tokio::sync::Mutex<Vec<tokio::task::JoinHandle<()>>>,
/// Semaphore (permits=1) coordinating storage poll and resumption tasks.
/// The poll loop acquires this during dispatch, and resumption tasks acquire
/// it when checking if remaining == 0 before exiting. This prevents the race
/// where a poll adds a new message to `resumption_unprocessed` between the
/// resumption task's emptiness check and its exit, which would orphan the message.
/// Matches the TS `storageReadLock` (Sharding.ts).
storage_read_lock: Arc<tokio::sync::Semaphore>,
/// Per-entity resumption state: tracks request IDs that encountered MailboxFull
/// during storage polling. A dedicated resumption task per entity re-fetches
/// and retries delivery with backoff.
resumption_unprocessed:
Arc<DashMap<crate::types::EntityAddress, DashSet<crate::snowflake::Snowflake>>>,
/// Tracks which entity addresses have an active resumption task running.
/// Prevents spawning duplicate resumption tasks for the same entity.
resumption_active: Arc<DashSet<crate::types::EntityAddress>>,
/// JoinHandles for per-entity resumption tasks, awaited during shutdown.
resumption_handles: Arc<DashMap<crate::types::EntityAddress, tokio::task::JoinHandle<()>>>,
/// Tracks first-seen time for unprocessed messages with unregistered entity types.
/// After `entity_registration_timeout` elapses, a failure reply is saved to storage
/// to prevent permanent message accumulation for removed or mistyped entity types.
/// Key is (entity_type, request_id) to deduplicate per-message tracking.
unregistered_first_seen: DashMap<(EntityType, crate::snowflake::Snowflake), Instant>,
/// Serializes `sync_singletons` and `register_singleton` to prevent races where
/// concurrent execution can cause missed spawns or brief double-runs.
/// Matches the TS `withSingletonLock` semaphore (Sharding.ts).
singleton_lock: tokio::sync::Mutex<()>,
/// Self-reference for passing to entity managers.
///
/// Initialized immediately after Arc construction. Allows entities to get
/// access to the sharding interface for inter-entity communication and
/// scheduled messages.
self_ref: OnceLock<Weak<ShardingImpl>>,
/// Detachment state tracking for storage connectivity.
///
/// When detached, the runner clears owned shards and pauses acquisition/refresh
/// loops to prevent split-brain scenarios where multiple runners execute the
/// same shard concurrently.
detached_state: Arc<DetachedState>,
}
/// A reusable singleton factory function that can be called multiple times
/// to (re)start the singleton after shard round-trips.
///
/// The factory receives a [`SingletonContext`] containing a cancellation token
/// for graceful shutdown.
type SingletonFactory =
Arc<dyn Fn(SingletonContext) -> BoxFuture<'static, Result<(), ClusterError>> + Send + Sync>;
/// A registered singleton entry.
struct SingletonEntry {
/// Cancellation token for the running singleton task (if any).
cancel: tokio_util::sync::CancellationToken,
/// Whether this singleton is currently running.
running: Arc<std::sync::atomic::AtomicBool>,
/// The factory to spawn the singleton. Reusable across re-spawns.
factory: SingletonFactory,
/// JoinHandle for the running singleton task (if any).
/// Used during shutdown to await task completion.
handle: Option<tokio::task::JoinHandle<()>>,
/// Shard group for this singleton. Defaults to "default".
/// Used to compute the shard ID directly via `shard_for_entity(name, shards_per_group)`
/// without going through entity manager lookup.
shard_group: String,
/// Number of consecutive failures (Err or panic) without a successful run.
/// Used for exponential backoff before re-spawning failed singletons.
/// Shared with the spawned task so it can increment on failure.
consecutive_failures: Arc<std::sync::atomic::AtomicU32>,
/// Epoch millis of the last failure. 0 = no failure recorded.
/// Shared with the spawned task so it can record failure time.
last_failure_ms: Arc<std::sync::atomic::AtomicU64>,
/// Whether the singleton has opted in to manage its own cancellation.
/// Shared with the spawned task's SingletonContext.
/// If true, sync_singletons will await the handle when cancelling.
managed: Arc<std::sync::atomic::AtomicBool>,
}
impl ShardingImpl {
/// Create a new ShardingImpl.
///
/// For a single-node setup (e.g. testing), call `acquire_all_shards()` after creation
/// to immediately own all configured shards.
///
/// For multi-runner mode, provide `runner_storage` and call `start().await` to begin
/// the shard acquisition loop.
pub fn new(
config: Arc<ShardingConfig>,
runners: Arc<dyn Runners>,
runner_storage: Option<Arc<dyn RunnerStorage>>,
runner_health: Option<Arc<dyn RunnerHealth>>,
message_storage: Option<Arc<dyn MessageStorage>>,
metrics: Arc<ClusterMetrics>,
) -> Result<Arc<Self>, ClusterError> {
Self::new_with_engines(
config,
runners,
runner_storage,
runner_health,
message_storage,
None,
None,
metrics,
)
}
/// Create a new ShardingImpl with optional workflow engine and state storage.
///
/// Use this when you need durable context support or persisted entity state.
#[allow(clippy::too_many_arguments)]
pub fn new_with_engines(
config: Arc<ShardingConfig>,
runners: Arc<dyn Runners>,
runner_storage: Option<Arc<dyn RunnerStorage>>,
runner_health: Option<Arc<dyn RunnerHealth>>,
message_storage: Option<Arc<dyn MessageStorage>>,
state_storage: Option<Arc<dyn WorkflowStorage>>,
workflow_engine: Option<Arc<dyn WorkflowEngine>>,
metrics: Arc<ClusterMetrics>,
) -> Result<Arc<Self>, ClusterError> {
config.validate()?;
if let Some(storage) = message_storage.as_ref() {
storage.set_max_retries(config.storage_message_max_retries);
}
let (event_tx, _) = broadcast::channel(64);
let snowflake = Arc::new(SnowflakeGenerator::new());
let cancel = tokio_util::sync::CancellationToken::new();
let reaper = Arc::new(EntityReaper::new(cancel.clone()));
let detached_state = Arc::new(DetachedState::new(config.detachment_recover_window));
let this = Arc::new(Self {
config,
snowflake,
runners,
runner_storage,
runner_health,
message_storage,
state_storage,
workflow_engine,
metrics,
entity_managers: Arc::new(DashMap::new()),
owned_shards: Arc::new(RwLock::new(HashSet::new())),
shard_assignments: RwLock::new(HashMap::new()),
releasing_shards: RwLock::new(HashSet::new()),
reaper,
event_tx,
singletons: DashMap::new(),
shutdown: AtomicBool::new(false),
cancel,
storage_poll_notify: Arc::new(Notify::new()),
entity_registration_notify: Notify::new(),
background_tasks: tokio::sync::Mutex::new(Vec::new()),
storage_read_lock: Arc::new(tokio::sync::Semaphore::new(1)),
storage_poll_lock: tokio::sync::Mutex::new(()),
resumption_unprocessed: Arc::new(DashMap::new()),
resumption_active: Arc::new(DashSet::new()),
resumption_handles: Arc::new(DashMap::new()),
unregistered_first_seen: DashMap::new(),
singleton_lock: tokio::sync::Mutex::new(()),
self_ref: OnceLock::new(),
detached_state,
});
// Initialize self-reference for entity managers to access sharding.
// Ignore error since OnceLock is newly created and cannot fail.
let _ = this.self_ref.set(Arc::downgrade(&this));
// Start reaper background task.
// The reaper dynamically adapts its check interval to the shortest registered
// idle time (floored at 5s), matching TS entityReaper.ts behavior.
let reaper_clone = Arc::clone(&this.reaper);
let reaper_handle = tokio::spawn(async move {
reaper_clone.run().await;
});
// Store handle. try_lock cannot fail here — we just created the mutex and hold the
// only Arc, so there is no contention. Using expect() instead of silently dropping.
this.background_tasks
.try_lock()
.expect("background_tasks lock should be uncontested during initialization")
.push(reaper_handle);
if this.runner_storage.is_none() && this.message_storage.is_some() {
let this_clone = Arc::clone(&this);
let poll_handle = tokio::spawn(async move {
this_clone.storage_poll_loop().await;
});
this.background_tasks
.try_lock()
.expect("background_tasks lock should be uncontested during initialization")
.push(poll_handle);
}
Ok(this)
}
/// Start multi-runner background loops:
/// - Shard acquisition loop (watches runners, computes HashRing, acquires/releases shards)
/// - Lock refresh loop (periodically refreshes shard lock TTLs)
/// - Storage polling loop (polls for unprocessed persisted messages)
///
/// Requires `runner_storage` to be provided at construction.
/// For single-node mode, use `acquire_all_shards()` instead.
#[instrument(skip(self))]
pub async fn start(self: &Arc<Self>) -> Result<(), ClusterError> {
let runner_storage = match &self.runner_storage {
Some(storage) => Arc::clone(storage),
None => {
tracing::warn!(
"start() called without runner_storage; no background loops will run"
);
return Ok(());
}
};
let runner = Runner::new(
self.config.runner_address.clone(),
self.config.runner_weight,
);
let machine_id = runner_storage.register(&runner).await?;
self.snowflake.set_machine_id(machine_id);
tracing::info!(
runner = %self.config.runner_address,
machine_id = %machine_id,
"registered runner"
);
// Start shard acquisition loop
let this = Arc::clone(self);
let h1 = tokio::spawn(async move {
this.shard_acquisition_loop().await;
});
// Start lock refresh loop
let this = Arc::clone(self);
let h2 = tokio::spawn(async move {
this.lock_refresh_loop().await;
});
// Start storage polling loop
let this = Arc::clone(self);
let h3 = tokio::spawn(async move {
this.storage_poll_loop().await;
});
// Store background task handles for graceful shutdown.
{
let mut tasks = self.background_tasks.try_lock()
.expect("background_tasks lock uncontested during start() — called immediately after construction");
tasks.push(h1);
tasks.push(h2);
tasks.push(h3);
}
// Start lease health monitoring loop if storage supports it.
if let Some(health_rx) = runner_storage.lease_health_receiver() {
let this = Arc::clone(self);
let h4 = tokio::spawn(async move {
this.lease_health_loop(health_rx).await;
});
self.background_tasks
.try_lock()
.expect("background_tasks lock uncontested during start()")
.push(h4);
tracing::info!("started lease health monitoring loop");
}
// Register runner health loop as a cluster singleton so only one runner
// in the cluster performs health checks at a time (matches TS source:
// "effect/cluster/Sharding/RunnerHealth" singleton in Sharding.ts:1339).
if self.runner_health.is_some() {
let this = Arc::clone(self);
// We cannot call async register_singleton from a sync fn, so insert directly.
let cancel = tokio_util::sync::CancellationToken::new();
let factory: SingletonFactory = Arc::new(move |ctx| {
let this = Arc::clone(&this);
let cancel = ctx.cancellation();
Box::pin(async move { this.runner_health_loop(cancel).await })
});
self.singletons.insert(
"cluster/RunnerHealth".to_string(),
SingletonEntry {
cancel,
running: Arc::new(std::sync::atomic::AtomicBool::new(false)),
factory,
handle: None,
shard_group: "default".to_string(),
consecutive_failures: Arc::new(std::sync::atomic::AtomicU32::new(0)),
last_failure_ms: Arc::new(std::sync::atomic::AtomicU64::new(0)),
managed: Arc::new(std::sync::atomic::AtomicBool::new(false)),
},
);
// sync_singletons() will spawn it when the appropriate shard is acquired.
tracing::info!("registered runner health loop as singleton");
}
Ok(())
}
/// Immediately claim ownership of all shards for all configured shard groups.
/// This is used for single-node / test scenarios.
pub async fn acquire_all_shards(&self) {
let mut owned = self.owned_shards.write().await;
for group in &self.config.shard_groups {
for id in 0..self.config.shards_per_group {
owned.insert(ShardId::new(group, id));
}
}
self.metrics.shards.set(owned.len() as i64);
}
/// Check if a shard is locally owned (non-async version using try_read).
///
/// Returns `false` during lock contention (e.g., during rebalance writes).
/// This is a transient false-negative that self-heals on the next poll cycle.
///
/// This method is only used by the sync `Sharding::has_shard_id` trait method.
/// All hot-path routing code uses `has_shard_async()` instead, so false negatives
/// here only affect external callers of the sync trait method.
fn has_shard_sync(&self, shard_id: &ShardId) -> bool {
match self.owned_shards.try_read() {
Ok(guard) => guard.contains(shard_id),
Err(_) => {
tracing::trace!(shard_id = ?shard_id, "owned_shards lock contended in has_shard_sync, returning false");
false
}
}
}
/// Check if a shard is locally owned (async version, blocks until lock available).
async fn has_shard_async(&self, shard_id: &ShardId) -> bool {
self.owned_shards.read().await.contains(shard_id)
}
/// Look up the runner that owns a shard (async version, blocks until lock available).
async fn get_shard_owner_async(&self, shard_id: &ShardId) -> Option<RunnerAddress> {
self.shard_assignments.read().await.get(shard_id).cloned()
}
/// Returns the number of shards currently owned by this runner.
pub async fn owned_shard_count(&self) -> usize {
self.owned_shards.read().await.len()
}
/// Check whether this runner currently owns the given shard.
pub async fn owns_shard(&self, shard_id: &ShardId) -> bool {
self.owned_shards.read().await.contains(shard_id)
}
// -------------------------------------------------------------------------
// Detachment API
// -------------------------------------------------------------------------
/// Check if the runner is currently detached from the cluster.
///
/// When detached, the runner should not execute shard entities and should
/// pause acquisition/refresh loops.
#[inline]
pub fn is_detached(&self) -> bool {
self.config.detachment_enabled && self.detached_state.is_detached()
}
/// Detach from the cluster with the given reason.
///
/// This clears owned shards and interrupts all entities to prevent split-brain.
/// Returns `true` if this call caused the transition from attached to detached.
#[instrument(skip(self))]
pub async fn detach(&self, reason: DetachmentReason) {
if !self.config.detachment_enabled {
tracing::debug!(
reason = %reason,
"detachment triggered but detachment_enabled=false, ignoring"
);
return;
}
let transitioned = self.detached_state.detach(reason);
if transitioned {
self.handle_detachment().await;
}
}
/// Signal that a healthy storage operation was observed.
///
/// If detached, this may trigger re-attachment if the recovery window has
/// elapsed with sustained healthy status.
pub fn signal_healthy(&self) {
if !self.config.detachment_enabled {
return;
}
if self.detached_state.maybe_reattach() {
self.metrics.sharding_detached.set(0);
}
}
/// Signal that an unhealthy storage operation was observed while detached.
///
/// This resets the recovery window, requiring another full recovery period
/// before re-attachment can occur.
pub fn signal_unhealthy(&self) {
if self.config.detachment_enabled {
self.detached_state.reset_healthy_since();
}
}
/// Handle the transition to detached state.
///
/// Clears owned shards and interrupts all entities to prevent split-brain.
#[instrument(level = "debug", skip(self))]
async fn handle_detachment(&self) {
self.metrics.sharding_detached.set(1);
// Clear owned shards
let shards_to_interrupt: Vec<ShardId> = {
let mut owned = self.owned_shards.write().await;
let shards: Vec<_> = owned.drain().collect();
self.metrics.shards.set(0);
shards
};
// Interrupt all entities on the cleared shards
for shard_id in &shards_to_interrupt {
for entry in self.entity_managers.iter() {
entry.value().interrupt_shard(shard_id).await;
}
}
// Sync singletons to stop any running (shards are now empty)
self.sync_singletons().await;
tracing::warn!(
shards_interrupted = shards_to_interrupt.len(),
"detachment complete: cleared owned shards and interrupted entities"
);
}
/// Whether an error is retryable during shard rebalancing.
/// `EntityNotAssignedToRunner` and `RunnerUnavailable` are transient
/// routing failures that may resolve after shards are reassigned.
fn is_retryable(err: &ClusterError) -> bool {
matches!(
err,
ClusterError::EntityNotAssignedToRunner { .. } | ClusterError::RunnerUnavailable { .. }
)
}
/// Route a message locally to the appropriate entity manager.
///
/// If the entity type is not yet registered, waits up to
/// `entity_registration_timeout` for it to appear (matching the TS
/// `waitForEntityManager` pattern in `Sharding.ts:440-476`).
#[instrument(skip(self, envelope, reply_tx), fields(
entity_type = %envelope.address.entity_type,
entity_id = %envelope.address.entity_id,
request_id = %envelope.request_id,
))]
async fn route_local(
&self,
envelope: EnvelopeRequest,
reply_tx: Option<mpsc::Sender<crate::reply::Reply>>,
) -> Result<(), ClusterError> {
let entity_type = &envelope.address.entity_type;
let manager = match self.entity_managers.get(entity_type) {
Some(m) => m,
None => {
// Wait for entity registration with timeout
let timeout = self.config.entity_registration_timeout;
tracing::debug!(
%entity_type,
?timeout,
"entity type not registered, waiting for registration"
);
let deadline = tokio::time::Instant::now() + timeout;
loop {
let notified = self.entity_registration_notify.notified();
// Re-check before awaiting (avoid missed notification)
if let Some(m) = self.entity_managers.get(entity_type) {
break m;
}
if tokio::time::timeout_at(deadline, notified).await.is_err() {
return Err(ClusterError::MalformedMessage {
reason: format!(
"no entity registered for type: {entity_type} (waited {timeout:?})"
),
source: None,
});
}
// Notification received — check again (might be a different entity type)
if let Some(m) = self.entity_managers.get(entity_type) {
break m;
}
}
}
};
let msg = match reply_tx {
Some(tx) => IncomingMessage::Request {
request: envelope,
reply_tx: tx,
},
None => IncomingMessage::Envelope { envelope },
};
manager.send_local(msg).await
}
#[instrument(level = "debug", skip(self, interrupt), fields(
entity_address = %interrupt.address,
request_id = %interrupt.request_id,
))]
async fn handle_interrupt_local(&self, interrupt: &Interrupt) {
if let Some(engine) = &self.workflow_engine {
if let Err(e) = engine
.resolve_deferred(
&interrupt.address.entity_type.0,
&interrupt.address.entity_id.0,
INTERRUPT_SIGNAL,
Vec::new(),
)
.await
{
tracing::warn!(
request_id = %interrupt.request_id,
entity_address = %interrupt.address,
error = %e,
"failed to resolve interrupt signal"
);
}
}
if let Some(manager) = self.entity_managers.get(&interrupt.address.entity_type) {
manager.interrupt_entity(&interrupt.address).await;
}
}
/// Background loop that watches for runner changes and rebalances shards.
///
/// Uses `shard_rebalance_retry_interval` as the normal polling interval.
/// When a rebalance actually acquires or releases shards, applies
/// `shard_rebalance_debounce` as an additional delay before the next
/// rebalance cycle to avoid thrashing during rapid topology changes.
async fn shard_acquisition_loop(&self) {
let runner_storage = match &self.runner_storage {
Some(s) => Arc::clone(s),
None => return,
};
loop {
if self.cancel.is_cancelled() {
break;
}
// Short-circuit while detached — no point in rebalancing when we can't
// safely execute shards. Sleep and wait for re-attachment.
if self.is_detached() {
tracing::trace!("shard_acquisition_loop: detached, skipping rebalance");
tokio::select! {
_ = self.cancel.cancelled() => break,
_ = tokio::time::sleep(self.config.shard_rebalance_retry_interval) => {},
}
continue;
}
let changed = match self.rebalance_shards(&runner_storage).await {
Ok(changed) => changed,
Err(e) => {
tracing::error!(error = %e, "shard rebalance failed");
false
}
};
// If shards changed, apply debounce delay to avoid thrashing
// during rapid runner topology changes (e.g., rolling restarts).
let sleep_duration = if changed {
self.config.shard_rebalance_debounce
} else {
self.config.shard_rebalance_retry_interval
};
tokio::select! {
_ = self.cancel.cancelled() => break,
_ = tokio::time::sleep(sleep_duration) => {},
}
}
}
/// Perform one round of shard rebalancing.
///
/// Returns `true` if any shards were acquired or released during this cycle.
/// Rebalance shard ownership based on the current set of healthy runners.
///
/// Lock ordering invariant (all sequential, never nested):
/// 1. `shard_assignments` (write) — update routing table
/// 2. `owned_shards` (read) — compute diff
/// 3. `releasing_shards` (write) → entity interrupt → `owned_shards` (write) → `releasing_shards` (write) — release phase
/// 4. `releasing_shards` (read) → `owned_shards` (write) — acquire phase
///
/// This method is only called from the single-threaded `shard_acquisition_loop`,
/// so there is no risk of concurrent invocations causing deadlocks.
#[instrument(level = "debug", skip(self, runner_storage))]
async fn rebalance_shards(
&self,
runner_storage: &Arc<dyn RunnerStorage>,
) -> Result<bool, ClusterError> {
// Check cancellation before doing any work
if self.cancel.is_cancelled() {
return Ok(false);
}
// 1. Get current runners (with cancellation support)
let runners = tokio::select! {
biased;
_ = self.cancel.cancelled() => {
tracing::debug!("rebalance_shards cancelled during get_runners");
return Ok(false);
}
result = runner_storage.get_runners() => {
match result {
Ok(r) => {
// Successful storage call - signal healthy for re-attachment
self.signal_healthy();
r
}
Err(e) => {
// Storage error during get_runners - trigger detachment
tracing::error!(error = %e, "get_runners failed, triggering detachment");
self.detach(DetachmentReason::StorageError(format!(
"get_runners failed: {}", e
))).await;
return Ok(false);
}
}
},
};
self.metrics.runners.set(runners.len() as i64);
self.metrics
.runners_healthy
.set(runners.iter().filter(|r| r.healthy).count() as i64);
// 2. Compute desired assignments via configured strategy
let desired = ShardAssigner::compute_assignments(
&runners,
&self.config.shard_groups,
self.config.shards_per_group,
&self.config.shard_assignment_strategy,
);
// Update shard assignments map (used for remote routing)
{
let mut assignments = self.shard_assignments.write().await;
*assignments = desired.clone();
}
// 3. Compute diff
let current_owned = self.owned_shards.read().await.clone();
let (to_acquire, to_release) =
ShardAssigner::compute_diff(&desired, ¤t_owned, &self.config.runner_address);
// 4. Release phase: release shards no longer assigned to us
for shard_id in &to_release {
// Check cancellation before each shard release
if self.cancel.is_cancelled() {
tracing::debug!("rebalance_shards cancelled during release phase");
return Ok(false);
}
// Mark as releasing to prevent re-acquisition
self.releasing_shards.write().await.insert(shard_id.clone());
// Interrupt entities on this shard
for entry in self.entity_managers.iter() {
entry.value().interrupt_shard(shard_id).await;
}
// Release lock in storage (with cancellation support)
let release_result = tokio::select! {
biased;
_ = self.cancel.cancelled() => {
tracing::debug!("rebalance_shards cancelled during shard release");
return Ok(false);
}
result = runner_storage.release(shard_id, &self.config.runner_address) => result,
};
if let Err(e) = release_result {
tracing::warn!(shard_id = %shard_id, error = %e, "failed to release shard lock, keeping shard in owned set for retry");
// Keep shard in owned_shards so the next rebalance cycle retries the release.
// Remove from releasing set so it can be re-added to to_release next cycle.
self.releasing_shards.write().await.remove(shard_id);
continue;
}
// Remove from owned and releasing sets
self.owned_shards.write().await.remove(shard_id);
self.releasing_shards.write().await.remove(shard_id);
tracing::debug!(shard_id = %shard_id, "released shard");
}
// Check cancellation before acquire phase
if self.cancel.is_cancelled() {
tracing::debug!("rebalance_shards cancelled before acquire phase");
return Ok(!to_release.is_empty());
}
// 5. Acquire phase: batch acquire newly assigned shards with retry
// Filter out shards currently being released
let releasing = self.releasing_shards.read().await;
let pending_acquire: Vec<ShardId> = to_acquire
.iter()
.filter(|s| !releasing.contains(s))
.cloned()
.collect();
drop(releasing);
let mut all_newly_acquired = Vec::new();
// Single acquire attempt per rebalance cycle. Shards held by other
// runners will be retried on the next rebalance cycle (every
// shard_rebalance_retry_interval). Since shard assignment is
// deterministic, we WILL eventually acquire all our shards once the
// previous owner's lease expires.
if !pending_acquire.is_empty() {
// Check cancellation before attempting
if self.cancel.is_cancelled() {
tracing::debug!("rebalance_shards cancelled during acquire_batch");
return Ok(!to_release.is_empty());
}
// Acquire shards (with cancellation support)
let batch_result = tokio::select! {
biased;
_ = self.cancel.cancelled() => {
tracing::debug!("rebalance_shards cancelled during acquire_batch");
return Ok(!to_release.is_empty());
}
result = runner_storage.acquire_batch(&pending_acquire, &self.config.runner_address) => {
match result {
Ok(r) => r,
Err(e) => {
// Storage error during acquire_batch - trigger detachment
tracing::error!(error = %e, "acquire_batch failed, triggering detachment");
self.detach(DetachmentReason::StorageError(format!(
"acquire_batch failed: {}", e
))).await;
return Ok(!to_release.is_empty());
}
}
},
};
// Handle storage errors for individual shards
if !batch_result.failures.is_empty() {
tracing::warn!(
failure_count = batch_result.failures.len(),
"some shards failed to acquire due to storage errors"
);
}
// Add acquired shards to owned_shards
{
let mut owned = self.owned_shards.write().await;
for shard_id in &batch_result.acquired {
owned.insert(shard_id.clone());
tracing::debug!(shard_id = %shard_id, "acquired shard");
}
}
all_newly_acquired.extend(batch_result.acquired.clone());
// Log shards still pending (held by other runners)
let remaining =
pending_acquire.len() - batch_result.acquired.len() - batch_result.failures.len();
if remaining > 0 {
tracing::info!(
acquired = batch_result.acquired.len(),
remaining,
"shards held by other runners, will retry next rebalance cycle"
);
}
}
// Update metrics
let owned_count = self.owned_shards.read().await.len();
self.metrics.shards.set(owned_count as i64);
let newly_acquired = all_newly_acquired;
// 6. If we acquired new shards, reset them in message storage and trigger poll
if !newly_acquired.is_empty() && !self.cancel.is_cancelled() {
if let Some(ref storage) = self.message_storage {
if let Err(e) = storage.reset_shards(&newly_acquired).await {
tracing::warn!(error = %e, "failed to reset shards in message storage");
}
}
self.storage_poll_notify.notify_one();
self.sync_singletons().await;
}
// Also sync singletons if shards were released (skip if cancelled)
if !to_release.is_empty() && !self.cancel.is_cancelled() {
self.sync_singletons().await;
}
let changed = !newly_acquired.is_empty() || !to_release.is_empty();
Ok(changed)
}
/// Background loop that periodically refreshes shard lock TTLs.
///
/// Tracks consecutive refresh failures per shard. When a shard exceeds
/// `shard_lock_refresh_max_failures` consecutive failures, it is removed
/// from owned shards and its entities are interrupted to prevent split-brain
/// (another runner may have already acquired the expired lock).
async fn lock_refresh_loop(&self) {
let runner_storage = match &self.runner_storage {
Some(s) => Arc::clone(s),
None => return,
};
let max_failures = self.config.shard_lock_refresh_max_failures;
let mut failure_counts: HashMap<ShardId, u32> = HashMap::new();
loop {
tokio::select! {
_ = self.cancel.cancelled() => break,
_ = tokio::time::sleep(self.config.runner_lock_refresh_interval) => {},
}
// Check cancellation after waking up
if self.cancel.is_cancelled() {
break;
}
// Short-circuit while detached — owned_shards is empty and we shouldn't
// be refreshing locks when we can't safely execute shards.
if self.is_detached() {
tracing::trace!("lock_refresh_loop: detached, skipping refresh");
continue;
}
let owned: std::collections::HashSet<ShardId> =
self.owned_shards.read().await.iter().cloned().collect();
let releasing: std::collections::HashSet<ShardId> =
self.releasing_shards.read().await.iter().cloned().collect();
// Clean up failure counts for shards we no longer own.
failure_counts.retain(|s, _| owned.contains(s));
// Refresh both owned and releasing shards. Releasing shards still have
// entities running on them; if their lock expires before release completes,
// another runner can acquire the shard while this runner still has entities
// on it, causing split-brain.
let all_shards: std::collections::HashSet<ShardId> =
owned.union(&releasing).cloned().collect();
// Batch refresh all shards in a single storage round-trip (or single
// mutex hold for etcd), avoiding N sequential network calls.
let all_shard_vec: Vec<ShardId> = all_shards.iter().cloned().collect();
let batch_result = tokio::select! {
biased;
_ = self.cancel.cancelled() => {
tracing::debug!("lock_refresh_loop cancelled during refresh_batch");
break;
}
result = runner_storage.refresh_batch(&all_shard_vec, &self.config.runner_address) => {
match result {
Ok(r) => r,
Err(e) => {
// Top-level storage error - trigger detachment and return early
tracing::error!(error = %e, "batch refresh failed entirely, triggering detachment");
self.detach(DetachmentReason::StorageError(format!(
"refresh_batch failed: {}", e
))).await;
continue;
}
}
}
};
// Successful storage call - signal healthy for re-attachment
self.signal_healthy();
// Process successfully refreshed shards — reset failure counts.
for shard_id in &batch_result.refreshed {
if !releasing.contains(shard_id) {
failure_counts.remove(shard_id);
}
}
// Process lost locks (skip if cancelled)
for shard_id in &batch_result.lost {
if self.cancel.is_cancelled() {
break;
}
if releasing.contains(shard_id) {
tracing::warn!(shard_id = %shard_id, "releasing shard lock lost during refresh");
continue;
}
tracing::warn!(shard_id = %shard_id, "shard lock lost during refresh");
failure_counts.remove(shard_id);
{
let mut owned_shards = self.owned_shards.write().await;
owned_shards.remove(shard_id);
self.metrics.shards.set(owned_shards.len() as i64);
}
for entry in self.entity_managers.iter() {
entry.value().interrupt_shard(shard_id).await;
}
self.sync_singletons().await;
}
// Process per-shard errors (skip if cancelled)
for (shard_id, e) in &batch_result.failures {
if self.cancel.is_cancelled() {
break;
}
if releasing.contains(shard_id) {
tracing::warn!(
shard_id = %shard_id,
error = %e,
"failed to refresh releasing shard lock"
);
continue;
}
let count = failure_counts.entry(shard_id.clone()).or_insert(0);
*count += 1;
tracing::warn!(
shard_id = %shard_id,
error = %e,
consecutive_failures = *count,
max_failures = max_failures,
"failed to refresh shard lock"
);
if *count >= max_failures {
tracing::error!(
shard_id = %shard_id,
consecutive_failures = *count,
"shard lock refresh failed {} consecutive times, releasing shard to prevent split-brain",
*count,
);
failure_counts.remove(shard_id);
{
let mut owned_shards = self.owned_shards.write().await;
owned_shards.remove(shard_id);
self.metrics.shards.set(owned_shards.len() as i64);
}
for entry in self.entity_managers.iter() {
entry.value().interrupt_shard(shard_id).await;
}
self.sync_singletons().await;
}
}
// Periodically re-sync singletons so that normally-completed singletons
// are re-spawned without waiting for a shard topology change (skip if cancelled)
if !self.cancel.is_cancelled() {
self.sync_singletons().await;
}
}
}
/// Background loop that monitors lease health and triggers detachment.
///
/// Listens to `LeaseHealth` updates from the runner storage and triggers
/// detachment when the failure streak exceeds `keepalive_failure_threshold`.
async fn lease_health_loop(
&self,
mut health_rx: tokio::sync::broadcast::Receiver<LeaseHealth>,
) {
loop {
tokio::select! {
_ = self.cancel.cancelled() => break,
result = health_rx.recv() => {
match result {
Ok(health) => {
// Update metrics.
self.metrics.lease_keepalive_failure_streak.set(health.failure_streak as i64);
if !health.healthy {
self.metrics.lease_keepalive_failures.inc();
}
if health.healthy {
// Signal healthy for re-attachment.
self.signal_healthy();
} else {
// Check if failure streak exceeds threshold.
if health.failure_streak >= self.config.keepalive_failure_threshold {
tracing::warn!(
failure_streak = health.failure_streak,
threshold = self.config.keepalive_failure_threshold,
"keep-alive failure streak exceeded threshold, triggering detachment"
);
self.detach(DetachmentReason::KeepAliveFailure {
consecutive_failures: health.failure_streak,
}).await;
} else {
// Signal unhealthy to reset recovery window.
self.signal_unhealthy();
}
}
}
Err(tokio::sync::broadcast::error::RecvError::Lagged(count)) => {
// We missed some messages due to slow processing. This is
// generally fine — we'll catch up on the next message.
tracing::debug!(
missed_count = count,
"lease health receiver lagged, missed some updates"
);
}
Err(tokio::sync::broadcast::error::RecvError::Closed) => {
// Sender closed — runner storage is shutting down.
tracing::info!("lease health channel closed, stopping monitoring loop");
break;
}
}
}
}
}
}
/// Background loop that polls message storage for unprocessed messages.
async fn storage_poll_loop(&self) {
loop {
tokio::select! {
_ = self.cancel.cancelled() => break,
_ = self.storage_poll_notify.notified() => {},
_ = tokio::time::sleep(self.config.storage_poll_interval) => {},
}
// Check cancellation after waking up
if self.cancel.is_cancelled() {
break;
}
if let Err(e) = self.poll_storage_inner().await {
tracing::warn!(error = %e, "storage poll failed");
}
}
}
/// Internal implementation of storage polling.
#[instrument(level = "debug", skip(self))]
async fn poll_storage_inner(&self) -> Result<(), ClusterError> {
// Check cancellation early
if self.cancel.is_cancelled() {
return Ok(());
}
let _poll_lock = self.storage_poll_lock.lock().await;
let storage = match &self.message_storage {
Some(s) => s,
None => return Ok(()),
};
let shard_ids: Vec<ShardId> = {
let owned = self.owned_shards.read().await;
owned.iter().cloned().collect()
};
if shard_ids.is_empty() {
return Ok(());
}
// Clear processed request ID sets before polling so that
// messages not yet marked processed in storage can be re-fetched.
// The dedup set in each EntityManager prevents double-dispatch within
// a single poll cycle.
for manager in self.entity_managers.iter() {
manager.value().clear_processed();
}
let mut messages = storage.unprocessed_messages(&shard_ids).await?;
// Limit the number of messages dispatched per poll cycle to avoid
// overwhelming entity mailboxes. Remaining messages will be picked
// up in subsequent poll cycles.
if self.config.storage_inbox_size > 0 {
messages.truncate(self.config.storage_inbox_size);
}
// Acquire storage_read_lock during dispatch to coordinate with resumption
// tasks. This prevents the race where a resumption task checks remaining == 0
// and exits, while we're about to add new MailboxFull entries for the same entity.
let _lock = self
.storage_read_lock
.acquire()
.await
.expect("semaphore not closed");
for envelope in messages {
// Check cancellation during message dispatch
if self.cancel.is_cancelled() {
break;
}
let entity_type = &envelope.address.entity_type;
let manager = match self.entity_managers.get(entity_type) {
Some(m) => {
// Entity type is registered — clean up any first-seen tracking
self.unregistered_first_seen
.remove(&(entity_type.clone(), envelope.request_id));
m
}
None => {
let key = (entity_type.clone(), envelope.request_id);
let first_seen = *self
.unregistered_first_seen
.entry(key.clone())
.or_insert_with(Instant::now);
let elapsed = first_seen.elapsed();
if elapsed >= self.config.entity_registration_timeout {
// Timeout exceeded — save a failure reply to storage so the
// message is marked processed and callers get a clear error
// instead of the message being re-polled forever.
tracing::error!(
entity_type = %entity_type,
request_id = %envelope.request_id,
elapsed_ms = elapsed.as_millis() as u64,
"poll_storage: entity type not registered after timeout, saving failure reply"
);
let reply_id = match self.snowflake.next_async().await {
Ok(id) => id,
Err(e) => {
tracing::error!(
request_id = %envelope.request_id,
error = %e,
"poll_storage: snowflake generation failed, using fallback reply id"
);
fallback_reply_id(envelope.request_id, EXIT_SEQUENCE)
}
};
let reply = Reply::WithExit(ReplyWithExit {
request_id: envelope.request_id,
id: reply_id,
exit: ExitResult::Failure(format!(
"entity type '{}' not registered after {}ms",
entity_type,
self.config.entity_registration_timeout.as_millis()
)),
});
if let Err(e) = storage.save_reply(&reply).await {
tracing::warn!(
request_id = %envelope.request_id,
error = %e,
"poll_storage: failed to save failure reply for unregistered entity type"
);
}
self.unregistered_first_seen.remove(&key);
} else {
tracing::warn!(
entity_type = %entity_type,
request_id = %envelope.request_id,
elapsed_ms = elapsed.as_millis() as u64,
timeout_ms = self.config.entity_registration_timeout.as_millis() as u64,
"poll_storage: skipping message for unregistered entity type (waiting for registration)"
);
}
continue;
}
};
if !self.has_shard_async(&envelope.address.shard_id).await {
continue;
}
let address = envelope.address.clone();
let request_id = envelope.request_id;
let msg = IncomingMessage::Envelope { envelope };
match manager.send_local(msg).await {
Ok(()) => {}
Err(ClusterError::MailboxFull { .. }) => {
// Track for resumption — a dedicated per-entity task will retry.
let entry = self
.resumption_unprocessed
.entry(address.clone())
.or_default();
entry.value().insert(request_id);
// Spawn a resumption task if one isn't already running for this entity.
if self.resumption_active.insert(address.clone()) {
self.spawn_resumption_task(address);
}
}
Err(e) => {
tracing::warn!(error = %e, "poll_storage: failed to dispatch message");
}
}
}
drop(_lock);
Ok(())
}
/// Spawn a per-entity resumption task that retries delivering messages
/// that encountered `MailboxFull` during storage polling.
///
/// Matches the TS `resumeEntityFromStorageImpl` (Sharding.ts:612-710):
/// - Takes batches of unprocessed request IDs for the entity
/// - Re-fetches messages from storage by ID
/// - Retries delivery with `send_retry_interval` backoff on `MailboxFull`
/// - Stops when all tracked IDs are delivered or the shard is no longer owned
fn spawn_resumption_task(&self, address: crate::types::EntityAddress) {
let storage = match &self.message_storage {
Some(s) => Arc::clone(s),
None => {
self.resumption_active.remove(&address);
return;
}
};
let entity_managers = Arc::clone(&self.entity_managers);
let owned_shards = Arc::clone(&self.owned_shards);
let cancel = self.cancel.clone();
let retry_interval = self.config.send_retry_interval;
let max_retries = self.config.storage_resumption_max_retries;
let resumption_unprocessed = Arc::clone(&self.resumption_unprocessed);
let resumption_active = Arc::clone(&self.resumption_active);
let resumption_handles = Arc::clone(&self.resumption_handles);
let addr_clone = address.clone();
let storage_read_lock = Arc::clone(&self.storage_read_lock);
let handle = tokio::spawn(async move {
let result = Self::run_resumption(
&address,
&storage,
&entity_managers,
&owned_shards,
&cancel,
retry_interval,
max_retries,
&resumption_unprocessed,
&storage_read_lock,
)
.await;
if let Err(e) = result {
tracing::warn!(
error = %e,
entity_address = %address,
"resumption task failed"
);
}
// Always clean up
resumption_unprocessed.remove(&address);
resumption_active.remove(&address);
resumption_handles.remove(&address);
});
self.resumption_handles.insert(addr_clone, handle);
}
/// Internal resumption loop for a single entity.
#[allow(clippy::too_many_arguments)]
#[instrument(level = "debug", skip_all, fields(entity_address = %address))]
async fn run_resumption(
address: &crate::types::EntityAddress,
storage: &Arc<dyn MessageStorage>,
entity_managers: &Arc<DashMap<EntityType, Arc<EntityManager>>>,
owned_shards: &Arc<RwLock<HashSet<ShardId>>>,
cancel: &tokio_util::sync::CancellationToken,
retry_interval: std::time::Duration,
max_retries: u32,
resumption_unprocessed: &DashMap<
crate::types::EntityAddress,
DashSet<crate::snowflake::Snowflake>,
>,
storage_read_lock: &tokio::sync::Semaphore,
) -> Result<(), ClusterError> {
loop {
// Check if shard is still owned
{
let owned = owned_shards.read().await;
if !owned.contains(&address.shard_id) {
tracing::debug!(
entity_address = %address,
"resumption: shard no longer owned, stopping"
);
return Ok(());
}
}
if cancel.is_cancelled() {
return Ok(());
}
// Take a batch of unprocessed IDs (up to 1024)
let ids: Vec<crate::snowflake::Snowflake> = {
let entry = match resumption_unprocessed.get(address) {
Some(e) => e,
None => return Ok(()),
};
entry.value().iter().take(1024).map(|r| *r).collect()
};
if ids.is_empty() {
return Ok(());
}
// Re-fetch from storage
let messages = match storage.unprocessed_messages_by_id(&ids).await {
Ok(msgs) => msgs,
Err(e) => {
tracing::warn!(
error = %e,
entity_address = %address,
"resumption: failed to fetch messages, retrying"
);
tokio::time::sleep(retry_interval).await;
continue;
}
};
if messages.is_empty() {
// Messages may have been processed by another mechanism
tokio::time::sleep(retry_interval).await;
// Remove the IDs we tried — they're no longer unprocessed
if let Some(entry) = resumption_unprocessed.get(address) {
for id in &ids {
entry.value().remove(id);
}
}
continue;
}
// Try to deliver each message
for envelope in messages {
let request_id = envelope.request_id;
let entity_type = &envelope.address.entity_type;
let manager = match entity_managers.get(entity_type) {
Some(m) => m,
None => {
if let Some(entry) = resumption_unprocessed.get(address) {
entry.value().remove(&request_id);
}
continue;
}
};
// Retry loop for this specific message
let mut attempts: u32 = 0;
loop {
if cancel.is_cancelled() {
return Ok(());
}
let msg = IncomingMessage::Envelope {
envelope: envelope.clone(),
};
match manager.send_local(msg).await {
Ok(()) => {
if let Some(entry) = resumption_unprocessed.get(address) {
entry.value().remove(&request_id);
}
break;
}
Err(ClusterError::MailboxFull { .. }) => {
attempts += 1;
if max_retries > 0 && attempts >= max_retries {
tracing::error!(
request_id = %request_id,
entity_address = %address,
attempts = attempts,
max_retries = max_retries,
"resumption: MailboxFull retry limit exhausted, dead-lettering message"
);
// Save a failure reply to storage so the message is marked processed
let failure_reply =
crate::reply::Reply::WithExit(crate::reply::ReplyWithExit {
request_id,
id: dead_letter_reply_id(request_id),
exit: crate::reply::ExitResult::Failure(
"resumption: MailboxFull retry limit exhausted"
.to_string(),
),
});
if let Err(e) = storage.save_reply(&failure_reply).await {
tracing::warn!(
error = %e,
request_id = %request_id,
"resumption: failed to save dead-letter reply"
);
}
if let Some(entry) = resumption_unprocessed.get(address) {
entry.value().remove(&request_id);
}
break;
}
tokio::time::sleep(retry_interval).await;
}
Err(ClusterError::EntityNotAssignedToRunner { .. }) => {
return Ok(());
}
Err(e) => {
tracing::warn!(
error = %e,
request_id = %request_id,
entity_address = %address,
"resumption: delivery failed, giving up on message"
);
if let Some(entry) = resumption_unprocessed.get(address) {
entry.value().remove(&request_id);
}
break;
}
}
}
}
// Acquire storage_read_lock before checking remaining. This ensures
// the poll loop can't add new MailboxFull entries between our check
// and our return. Without this lock, the sequence:
// 1. resumption checks remaining == 0
// 2. poll_storage adds new entry for same entity
// 3. resumption exits — new entry is orphaned
// is possible. The lock serializes step 1 with step 2.
let _lock = storage_read_lock
.acquire()
.await
.expect("semaphore not closed");
let remaining = resumption_unprocessed
.get(address)
.map(|e| e.value().len())
.unwrap_or(0);
if remaining == 0 {
return Ok(());
}
drop(_lock);
}
}
/// Background loop that periodically checks runner health and updates status.
///
/// Registered as a cluster singleton (`"cluster/RunnerHealth"`) in `start()`,
/// so only one runner in the cluster performs health checks at a time.
/// The singleton is managed by `sync_singletons()` which spawns/cancels it
/// based on shard ownership. It:
/// - Iterates all runners with a concurrency limit of 10
/// - Calls `runner_health.is_alive()` for each
/// - Updates `runner_storage.set_runner_health()`
/// - Never marks the last healthy runner as unhealthy (prevents deadlock)
/// - If zero healthy runners: force-marks self as healthy
async fn runner_health_loop(
&self,
cancel: tokio_util::sync::CancellationToken,
) -> Result<(), ClusterError> {
let runner_storage = match &self.runner_storage {
Some(s) => Arc::clone(s),
None => return Ok(()),
};
let runner_health = match &self.runner_health {
Some(h) => Arc::clone(h),
None => return Ok(()),
};
loop {
tokio::select! {
biased;
_ = cancel.cancelled() => break,
_ = tokio::time::sleep(self.config.runner_poll_interval) => {},
}
// Check cancellation after waking up
if cancel.is_cancelled() {
break;
}
if let Err(e) = self
.check_runner_health(&runner_storage, &runner_health, &cancel)
.await
{
tracing::warn!(error = %e, "runner health check failed");
}
}
Ok(())
}
/// Perform one round of runner health checks.
#[instrument(level = "debug", skip(self, runner_storage, runner_health, cancel))]
async fn check_runner_health(
&self,
runner_storage: &Arc<dyn RunnerStorage>,
runner_health: &Arc<dyn RunnerHealth>,
cancel: &tokio_util::sync::CancellationToken,
) -> Result<(), ClusterError> {
use futures::stream::StreamExt;
// Check cancellation early
if cancel.is_cancelled() {
return Ok(());
}
let runners = tokio::select! {
biased;
_ = cancel.cancelled() => return Ok(()),
result = runner_storage.get_runners() => result?,
};
if runners.is_empty() {
return Ok(());
}
// Check health with concurrency limit of 10 (with cancellation support)
let cancel_clone = cancel.clone();
let checks: Vec<_> = runners
.iter()
.map(|runner| {
let addr = runner.address.clone();
let health = Arc::clone(runner_health);
let cancel = cancel_clone.clone();
async move {
// Check cancellation before each health check
if cancel.is_cancelled() {
return None;
}
let alive = match health.is_alive(&addr).await {
Ok(alive) => alive,
Err(e) => {
tracing::warn!(runner = %addr, error = %e, "health check error");
false
}
};
Some((addr, alive))
}
})
.collect();
let health_results: Vec<_> = futures::stream::iter(checks)
.buffer_unordered(10)
.filter_map(|x| async { x })
.collect()
.await;
// Check cancellation after health checks
if cancel.is_cancelled() {
return Ok(());
}
// Apply health updates with the "last healthy runner" guard.
// Track runners marked unhealthy in this iteration so each successive
// decision reflects prior decisions in the same loop.
let mut marked_unhealthy_this_cycle: Vec<&RunnerAddress> = Vec::new();
for (addr, alive) in &health_results {
// Check cancellation before each update
if cancel.is_cancelled() {
return Ok(());
}
let runner = runners.iter().find(|r| &r.address == addr);
let was_healthy = runner.map(|r| r.healthy).unwrap_or(false);
if was_healthy && !alive {
// About to mark a healthy runner as unhealthy.
// Count how many would remain healthy after this change,
// accounting for runners already marked unhealthy in this cycle.
let healthy_after: usize = health_results
.iter()
.filter(|(a, is_alive)| {
if a == addr || marked_unhealthy_this_cycle.contains(&a) {
// This runner would be (or was already) marked unhealthy
false
} else {
// Use the new health result
*is_alive
}
})
.count();
if healthy_after == 0 {
tracing::warn!(
runner = %addr,
"skipping health update: would leave zero healthy runners"
);
continue;
}
}
if was_healthy != *alive {
if let Err(e) = runner_storage.set_runner_health(addr, *alive).await {
tracing::warn!(runner = %addr, error = %e, "failed to update runner health");
} else {
tracing::info!(runner = %addr, alive = %alive, "updated runner health");
if !alive {
marked_unhealthy_this_cycle.push(addr);
}
}
}
}
// If zero runners are healthy, force-mark self as healthy
let any_healthy = health_results.iter().any(|(_, alive)| *alive);
if !any_healthy {
tracing::warn!("no healthy runners detected, force-marking self as healthy");
if let Err(e) = runner_storage
.set_runner_health(&self.config.runner_address, true)
.await
{
tracing::warn!(error = %e, "failed to force-mark self as healthy");
}
}
Ok(())
}
#[allow(clippy::too_many_arguments)]
fn spawn_singleton_task(
&self,
name: String,
cancel: tokio_util::sync::CancellationToken,
factory: SingletonFactory,
running_flag: Arc<std::sync::atomic::AtomicBool>,
failure_count: Arc<std::sync::atomic::AtomicU32>,
failure_time: Arc<std::sync::atomic::AtomicU64>,
managed: Arc<std::sync::atomic::AtomicBool>,
) -> tokio::task::JoinHandle<()> {
running_flag.store(true, std::sync::atomic::Ordering::SeqCst);
// Reset managed flag for this spawn cycle
managed.store(false, std::sync::atomic::Ordering::Release);
let managed_clone = managed.clone();
tokio::spawn(async move {
use futures::FutureExt;
use std::sync::atomic::Ordering;
// Create context with cancellation token for graceful shutdown.
// The managed flag is shared with SingletonEntry so sync_singletons
// can check if the singleton opted in to manage cancellation.
let ctx = SingletonContext::new(cancel.clone(), managed_clone);
let managed = ctx.managed.clone();
// Spawn the factory in a separate task so we can choose to abort or await it
let mut factory_handle = tokio::spawn(
std::panic::AssertUnwindSafe(async move { (factory)(ctx).await }).catch_unwind(),
);
// Result type: Option<Result<Result<(), ClusterError>, Box<dyn Any + Send>>>
// None = force-cancelled, Some(...) = completed or panicked
let result: Option<Result<Result<(), ClusterError>, Box<dyn std::any::Any + Send>>> = tokio::select! {
_ = cancel.cancelled() => {
// Cancellation triggered - check if singleton is managing it
if managed.load(Ordering::Acquire) {
// Singleton opted in - wait for it to finish gracefully
tracing::debug!(name = %name, "singleton managing cancellation, waiting for graceful shutdown");
match factory_handle.await {
Ok(result) => Some(result),
Err(join_err) => {
tracing::error!(name = %name, "singleton task join error: {}", join_err);
None
}
}
} else {
// Singleton didn't opt in - force cancel it
tracing::debug!(name = %name, "singleton not managing cancellation, force-cancelling");
factory_handle.abort();
None // Force-cancelled, treat as success
}
}
join_result = &mut factory_handle => {
// Factory completed before cancellation
match join_result {
Ok(result) => Some(result),
Err(join_err) => {
tracing::error!(name = %name, "singleton task join error: {}", join_err);
None
}
}
}
};
// Handle the result
let mut failed = false;
match result {
Some(Ok(Ok(()))) | None => {
tracing::debug!(name = %name, "singleton completed normally");
failure_count.store(0, Ordering::Release);
}
Some(Ok(Err(e))) => {
tracing::error!(name = %name, error = %e, "singleton failed");
failed = true;
}
Some(Err(_panic)) => {
tracing::error!(name = %name, "singleton panicked");
failed = true;
}
}
if failed {
failure_count.fetch_add(1, Ordering::Release);
let now_ms = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.expect("system clock before Unix epoch")
.as_millis() as u64;
failure_time.store(now_ms, Ordering::Release);
}
running_flag.store(false, Ordering::SeqCst);
})
}
/// Synchronize singleton execution based on current shard ownership.
///
/// Each singleton is assigned to a shard by hashing its name.
/// Only the runner owning that shard should run the singleton.
///
/// This method snapshots singleton state first (without holding DashMap locks),
/// then performs async shard ownership checks, and finally re-acquires per-entry
/// mutable access to apply state changes. This avoids holding DashMap shard locks
/// across `.await` points which would cause contention with concurrent
/// `register_singleton`, `shutdown`, or other `sync_singletons` calls.
#[instrument(level = "debug", skip(self))]
async fn sync_singletons(&self) {
// Check cancellation early
if self.cancel.is_cancelled() {
return;
}
// Serialize with register_singleton to prevent races.
// Matches the TS `withSingletonLock` (Sharding.ts).
let _singleton_guard = self.singleton_lock.lock().await;
// Phase 1: Snapshot singleton state without holding mutable locks.
struct SingletonSnapshot {
name: String,
shard_id: ShardId,
is_running: bool,
is_cancelled: bool,
consecutive_failures: u32,
last_failure_ms: u64,
}
let snapshots: Vec<SingletonSnapshot> = self
.singletons
.iter()
.map(|entry| {
let name = entry.key().clone();
let singleton = entry.value();
// Compute shard ID directly from singleton name and shard group,
// bypassing entity manager lookup. This matches the TS source
// (Sharding.ts:1189) which uses getShardId(makeEntityId(name), shardGroup).
let shard = crate::hash::shard_for_entity(&name, self.config.shards_per_group);
let shard_id = ShardId::new(&singleton.shard_group, shard);
let is_running = singleton.running.load(std::sync::atomic::Ordering::SeqCst);
let is_cancelled = singleton.cancel.is_cancelled();
let consecutive_failures = singleton
.consecutive_failures
.load(std::sync::atomic::Ordering::Acquire);
let last_failure_ms = singleton
.last_failure_ms
.load(std::sync::atomic::Ordering::Acquire);
SingletonSnapshot {
name,
shard_id,
is_running,
is_cancelled,
consecutive_failures,
last_failure_ms,
}
})
.collect();
// DashMap read locks are now fully released.
// Phase 2: Check shard ownership (async) and apply state changes per-entry.
for snap in &snapshots {
let should_run = self.has_shard_async(&snap.shard_id).await;
let is_cancelling = snap.is_cancelled && snap.is_running;
if should_run && !snap.is_running && !is_cancelling {
// Apply exponential backoff for failed singletons.
if snap.consecutive_failures > 0 && snap.last_failure_ms > 0 {
let backoff_base = self.config.singleton_crash_backoff_base;
let exponent = std::cmp::min(snap.consecutive_failures.saturating_sub(1), 10);
let backoff = backoff_base.saturating_mul(1u32 << exponent);
let now_ms = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.expect("system clock before Unix epoch")
.as_millis() as u64;
let elapsed_ms = now_ms.saturating_sub(snap.last_failure_ms);
if elapsed_ms < backoff.as_millis() as u64 {
tracing::debug!(
name = %snap.name,
consecutive_failures = snap.consecutive_failures,
backoff_ms = backoff.as_millis() as u64,
elapsed_ms,
"singleton respawn delayed by crash backoff"
);
continue;
}
}
// Re-acquire mutable access and re-verify state hasn't changed.
if let Some(mut entry) = self.singletons.get_mut(&snap.name) {
let singleton = entry.value_mut();
let current_running =
singleton.running.load(std::sync::atomic::Ordering::SeqCst);
let current_cancelling = singleton.cancel.is_cancelled() && current_running;
if current_running || current_cancelling {
// State changed between snapshot and now — skip.
continue;
}
// Should run — clone the reusable factory and spawn.
// Create a fresh CancellationToken for this spawn cycle.
let new_cancel = tokio_util::sync::CancellationToken::new();
singleton.cancel = new_cancel.clone();
let factory = Arc::clone(&singleton.factory);
let name_clone = snap.name.clone();
let running_flag = Arc::clone(&singleton.running);
let failure_count = Arc::clone(&singleton.consecutive_failures);
let failure_time = Arc::clone(&singleton.last_failure_ms);
let managed_flag = Arc::clone(&singleton.managed);
let handle = self.spawn_singleton_task(
name_clone,
new_cancel,
factory,
running_flag,
failure_count,
failure_time,
managed_flag,
);
singleton.handle = Some(handle);
tracing::info!(name = %snap.name, "started singleton (shard acquired)");
}
} else if should_run && is_cancelling {
tracing::debug!(name = %snap.name, "singleton still shutting down, will respawn on next sync");
} else if !should_run && snap.is_running && !is_cancelling {
// Re-acquire and re-verify before cancelling.
// If the singleton is managing cancellation, we need to await its handle
// to ensure it finishes gracefully before another runner starts a new instance.
let (should_cancel, is_managed, handle) =
if let Some(mut entry) = self.singletons.get_mut(&snap.name) {
let singleton = entry.value_mut();
let current_running =
singleton.running.load(std::sync::atomic::Ordering::SeqCst);
if current_running && !singleton.cancel.is_cancelled() {
singleton.cancel.cancel();
let is_managed =
singleton.managed.load(std::sync::atomic::Ordering::Acquire);
let handle = if is_managed {
singleton.handle.take()
} else {
None
};
(true, is_managed, handle)
} else {
(false, false, None)
}
} else {
(false, false, None)
};
if should_cancel {
if is_managed {
if let Some(handle) = handle {
tracing::info!(name = %snap.name, "waiting for managed singleton to shut down gracefully (shard no longer owned)");
// Await the handle - the singleton will observe cancellation and return
let _ = handle.await;
tracing::info!(name = %snap.name, "managed singleton shut down gracefully");
}
} else {
tracing::info!(name = %snap.name, "cancelled singleton (shard no longer owned)");
}
}
}
}
self.metrics.singletons.set(
self.singletons
.iter()
.filter(|e| e.value().running.load(std::sync::atomic::Ordering::SeqCst))
.count() as i64,
);
}
/// Poll storage for a reply to a persisted message.
///
/// This is used as a fallback when the gRPC streaming connection to the
/// remote node fails. The message was already saved to storage, so another
/// node may process it and save the reply there.
///
/// Polls at `storage_poll_interval` until an exit reply is found.
#[instrument(level = "debug", skip(self))]
async fn reply_from_storage(
&self,
request_id: Snowflake,
) -> Result<ReplyReceiver, ClusterError> {
let storage =
self.message_storage
.as_ref()
.ok_or_else(|| ClusterError::PersistenceError {
reason: "no message storage configured for reply polling".into(),
source: None,
})?;
let poll_interval = self.config.storage_poll_interval;
let (tx, rx) = mpsc::channel(16);
let storage = Arc::clone(storage);
let cancel = self.cancel.clone();
tokio::spawn(async move {
loop {
tokio::select! {
_ = cancel.cancelled() => {
tracing::debug!(request_id = request_id.0, "reply_from_storage: cancelled");
break;
}
_ = tokio::time::sleep(poll_interval) => {}
}
match storage.replies_for(request_id).await {
Ok(replies) => {
for reply in replies {
let is_exit = matches!(reply, Reply::WithExit(_));
if tx.send(reply).await.is_err() {
// Receiver dropped
return;
}
if is_exit {
tracing::debug!(
request_id = request_id.0,
"reply_from_storage: delivered exit reply"
);
return;
}
}
}
Err(e) => {
tracing::warn!(
request_id = request_id.0,
error = %e,
"reply_from_storage: failed to poll replies"
);
}
}
}
});
Ok(rx)
}
}
#[async_trait]
impl Sharding for ShardingImpl {
fn get_shard_id(&self, entity_type: &EntityType, entity_id: &EntityId) -> ShardId {
let shard = shard_for_entity(entity_id.as_ref(), self.config.shards_per_group);
// Resolve shard group from the registered entity's shard_group_for() method,
// falling back to the first configured shard group or "default".
let group = self
.entity_managers
.get(entity_type)
.map(|manager| manager.entity().shard_group_for(entity_id).to_string())
.unwrap_or_else(|| {
if let Some(group) = self.config.shard_groups.first() {
group.clone()
} else {
tracing::warn!(
entity_type = %entity_type,
"no entity manager registered and shard_groups config is empty, \
falling back to hardcoded \"default\" shard group"
);
"default".to_string()
}
});
ShardId::new(&group, shard)
}
fn has_shard_id(&self, shard_id: &ShardId) -> bool {
self.has_shard_sync(shard_id)
}
fn snowflake(&self) -> &SnowflakeGenerator {
&self.snowflake
}
fn is_shutdown(&self) -> bool {
self.shutdown.load(Ordering::Acquire)
}
#[instrument(skip(self, entity), fields(entity_type))]
async fn register_entity(&self, entity: Arc<dyn Entity>) -> Result<(), ClusterError> {
let entity_type = entity.entity_type();
tracing::Span::current().record("entity_type", tracing::field::display(&entity_type));
let max_idle = entity
.max_idle_time()
.unwrap_or(self.config.entity_max_idle_time);
// Get Arc<dyn Sharding> from self_ref for entity inter-entity communication.
let sharding: Option<Arc<dyn Sharding>> = self
.self_ref
.get()
.and_then(|weak| weak.upgrade())
.map(|arc| arc as Arc<dyn Sharding>);
let manager = Arc::new(EntityManager::with_sharding(
Arc::clone(&entity),
Arc::clone(&self.config),
self.config.runner_address.clone(),
Arc::clone(&self.snowflake),
self.message_storage.clone(),
self.state_storage.clone(),
self.workflow_engine.clone(),
sharding,
));
self.reaper.register(Arc::clone(&manager), max_idle).await;
// If an entity type was already registered, interrupt its active entities
// before replacing the manager to avoid orphaned entity instances.
if let Some((_key, old_manager)) = self.entity_managers.remove(&entity_type) {
tracing::warn!(%entity_type, "replacing existing entity registration, interrupting active entities");
// Interrupt all shards for the old manager
let owned_shards = self.owned_shards.read().await;
for shard_id in owned_shards.iter() {
old_manager.interrupt_shard(shard_id).await;
}
}
// Acquire storage_read_lock before inserting the entity manager to ensure
// no storage poll is running concurrently. This matches the TS behavior
// where `registerEntity` acquires `withStorageReadLock` (Sharding.ts:1296-1302)
// to prevent races where messages are half-dispatched during registration.
let _storage_lock = self
.storage_read_lock
.acquire()
.await
.expect("semaphore not closed");
self.entity_managers.insert(entity_type.clone(), manager);
drop(_storage_lock);
// Clean up any first-seen tracking for this entity type now that it's registered.
self.unregistered_first_seen
.retain(|(et, _), _| et != &entity_type);
// Wake any route_local calls waiting for this entity type.
self.entity_registration_notify.notify_waiters();
let _ = self
.event_tx
.send(ShardingRegistrationEvent::EntityRegistered {
entity_type: entity_type.clone(),
});
self.metrics.entities.set(self.entity_managers.len() as i64);
tracing::info!(%entity_type, "registered entity type");
Ok(())
}
#[instrument(skip(self, run))]
async fn register_singleton(
&self,
name: &str,
shard_group: Option<&str>,
run: Arc<
dyn Fn(SingletonContext) -> BoxFuture<'static, Result<(), ClusterError>> + Send + Sync,
>,
) -> Result<(), ClusterError> {
// Serialize with sync_singletons to prevent races.
// Matches the TS `withSingletonLock` (Sharding.ts).
let _singleton_guard = self.singleton_lock.lock().await;
// Cancel any previously registered singleton with the same name
// to avoid orphaned tasks that can't be tracked or stopped.
// We must abort the old JoinHandle in addition to cancelling the token,
// because the factory may ignore the cancellation token.
if let Some((_, mut old)) = self.singletons.remove(name) {
old.cancel.cancel();
if let Some(h) = old.handle.take() {
h.abort();
}
tracing::info!(name, "cancelled previously registered singleton");
}
let cancel = tokio_util::sync::CancellationToken::new();
// Compute shard ID directly from singleton name, bypassing entity manager lookup.
// This matches the TS source (Sharding.ts:1189): options?.shardGroup ?? "default".
let shard_group = shard_group.unwrap_or("default").to_string();
let shard = crate::hash::shard_for_entity(name, self.config.shards_per_group);
let shard_id = ShardId::new(&shard_group, shard);
// In single-node mode (no runner_storage), always spawn immediately.
// In multi-runner mode, only spawn if the computed shard is owned.
let should_run = if self.runner_storage.is_none() {
true
} else {
self.has_shard_async(&shard_id).await
};
let running = Arc::new(std::sync::atomic::AtomicBool::new(should_run));
let consecutive_failures = Arc::new(std::sync::atomic::AtomicU32::new(0));
let last_failure_ms = Arc::new(std::sync::atomic::AtomicU64::new(0));
let managed = Arc::new(std::sync::atomic::AtomicBool::new(false));
let mut handle: Option<tokio::task::JoinHandle<()>> = None;
if should_run {
// Shard is owned — spawn now.
let cancel_clone = cancel.clone();
let name_owned = name.to_string();
let factory = Arc::clone(&run);
let running_flag = Arc::clone(&running);
let failure_count = Arc::clone(&consecutive_failures);
let failure_time = Arc::clone(&last_failure_ms);
let managed_flag = Arc::clone(&managed);
handle = Some(self.spawn_singleton_task(
name_owned,
cancel_clone,
factory,
running_flag,
failure_count,
failure_time,
managed_flag,
));
}
self.singletons.insert(
name.to_string(),
SingletonEntry {
cancel,
running,
factory: run,
handle,
shard_group,
consecutive_failures,
last_failure_ms,
managed,
},
);
let _ = self
.event_tx
.send(ShardingRegistrationEvent::SingletonRegistered {
name: name.to_string(),
});
self.metrics.singletons.set(
self.singletons
.iter()
.filter(|e| e.value().running.load(std::sync::atomic::Ordering::SeqCst))
.count() as i64,
);
tracing::info!(name, "registered singleton");
Ok(())
}
fn make_client(self: Arc<Self>, entity_type: EntityType) -> EntityClient {
EntityClient::new(self, entity_type)
}
#[instrument(name = "route", skip(self, envelope), fields(
entity_type = %envelope.address.entity_type,
entity_id = %envelope.address.entity_id,
shard_id = %envelope.address.shard_id,
request_id = %envelope.request_id,
tag = %envelope.tag,
))]
async fn send(&self, mut envelope: EnvelopeRequest) -> Result<ReplyReceiver, ClusterError> {
// Stamp OTel trace context from the current (route) span so that the
// receiver's handle_message_with_recovery becomes a child of route.
{
let context = tracing::Span::current().context();
let span_ref = context.span();
let sc = span_ref.span_context();
if sc.is_valid() {
envelope.trace_id = Some(sc.trace_id().to_string());
envelope.span_id = Some(sc.span_id().to_string());
envelope.sampled = Some(sc.trace_flags().is_sampled());
}
}
if self.is_shutdown() {
return Err(ClusterError::ShuttingDown);
}
let shard_id = envelope.address.shard_id.clone();
// For persisted messages, save to storage before routing.
// If duplicate, return the existing reply immediately.
if envelope.persisted {
let storage = match &self.message_storage {
Some(storage) => storage,
None => {
return Err(ClusterError::PersistenceError {
reason: "persisted messages require message storage".to_string(),
source: None,
})
}
};
match storage.save_request(&envelope).await? {
SaveResult::Success => {}
SaveResult::Duplicate { existing_reply } => {
// Return the existing reply if available, otherwise register a handler.
let (tx, rx) = mpsc::channel(16);
if let Some(reply) = existing_reply {
let _ = tx.send(reply).await;
return Ok(rx);
}
storage.register_reply_handler(envelope.request_id, tx);
self.storage_poll_notify.notify_one();
return Ok(rx);
}
}
}
let max_retries = self.config.send_retry_count;
let retry_interval = self.config.send_retry_interval;
let mut last_err = None;
for attempt in 0..=max_retries {
if attempt > 0 {
tokio::time::sleep(retry_interval).await;
if self.is_shutdown() {
return Err(ClusterError::ShuttingDown);
}
}
let is_last = attempt == max_retries;
let has_local = self.has_shard_async(&shard_id).await;
let owner = self.get_shard_owner_async(&shard_id).await;
if has_local {
if envelope.persisted {
// Persisted messages are dispatched via the storage poll path.
let (tx, rx) = mpsc::channel(16);
if let Some(ref storage) = self.message_storage {
storage.register_reply_handler(envelope.request_id, tx);
}
self.storage_poll_notify.notify_one();
return Ok(rx);
}
// Local delivery
let (tx, rx) = mpsc::channel(16);
match self.route_local(envelope.clone(), Some(tx)).await {
Ok(()) => return Ok(rx),
Err(e) if Self::is_retryable(&e) && !is_last => {
tracing::debug!(attempt, error = %e, "send: retryable error, will retry");
last_err = Some(e);
continue;
}
Err(e) => return Err(e),
}
} else if let Some(owner) = owner {
// Self-send guard: if the shard owner is ourselves but has_shard_async
// returned false, the shard is being acquired or was lost. Do NOT make
// a gRPC call to ourselves — that causes infinite recursion and OOM.
// Instead, route locally since the assignment says we own this shard.
if owner == self.config.runner_address {
if envelope.persisted {
let (tx, rx) = mpsc::channel(16);
if let Some(ref storage) = self.message_storage {
storage.register_reply_handler(envelope.request_id, tx);
}
self.storage_poll_notify.notify_one();
return Ok(rx);
}
let (tx, rx) = mpsc::channel(16);
match self.route_local(envelope.clone(), Some(tx)).await {
Ok(()) => return Ok(rx),
Err(e) if Self::is_retryable(&e) && !is_last => {
tracing::debug!(attempt, error = %e, "send: retryable error (self-routed), will retry");
last_err = Some(e);
continue;
}
Err(e) => return Err(e),
}
}
// Remote delivery via the Runners transport.
// Use send() to get streaming replies from the remote node.
match self.runners.send(&owner, envelope.clone()).await {
Ok(rx) => return Ok(rx),
Err(e) if envelope.persisted => {
// For persisted messages, fall back to polling storage for replies.
// The message was already saved to storage, so another node may
// process it and save the reply there.
tracing::debug!(
attempt,
error = %e,
"send: remote send failed for persisted message, falling back to storage polling"
);
return self.reply_from_storage(envelope.request_id).await;
}
Err(e) if Self::is_retryable(&e) && !is_last => {
tracing::debug!(attempt, error = %e, "send: retryable error on remote, will retry");
last_err = Some(e);
continue;
}
Err(e) => return Err(e),
}
} else {
// No runner assigned for this shard
if !is_last {
tracing::debug!(attempt, "send: shard not assigned, will retry");
last_err = Some(ClusterError::EntityNotAssignedToRunner {
entity_type: envelope.address.entity_type.clone(),
entity_id: envelope.address.entity_id.clone(),
});
continue;
}
return Err(ClusterError::EntityNotAssignedToRunner {
entity_type: envelope.address.entity_type,
entity_id: envelope.address.entity_id,
});
}
}
Err(
last_err.unwrap_or_else(|| ClusterError::EntityNotAssignedToRunner {
entity_type: envelope.address.entity_type,
entity_id: envelope.address.entity_id,
}),
)
}
#[instrument(skip(self, envelope), fields(
entity_type = %envelope.address.entity_type,
entity_id = %envelope.address.entity_id,
shard_id = %envelope.address.shard_id,
tag = %envelope.tag,
))]
async fn notify(&self, envelope: EnvelopeRequest) -> Result<(), ClusterError> {
if self.is_shutdown() {
return Err(ClusterError::ShuttingDown);
}
let shard_id = envelope.address.shard_id.clone();
// For persisted messages, save to storage before routing.
if envelope.persisted {
let storage = match &self.message_storage {
Some(storage) => storage,
None => {
return Err(ClusterError::PersistenceError {
reason: "persisted messages require message storage".to_string(),
source: None,
})
}
};
match storage.save_envelope(&envelope).await? {
SaveResult::Success => {}
SaveResult::Duplicate { .. } => {
// Already saved, nothing more to do for fire-and-forget.
return Ok(());
}
}
}
let max_retries = self.config.send_retry_count;
let retry_interval = self.config.send_retry_interval;
let mut last_err = None;
for attempt in 0..=max_retries {
if attempt > 0 {
tokio::time::sleep(retry_interval).await;
if self.is_shutdown() {
return Err(ClusterError::ShuttingDown);
}
}
let is_last = attempt == max_retries;
if self.has_shard_async(&shard_id).await {
if envelope.persisted {
// Persisted notifications are delivered via storage polling.
self.storage_poll_notify.notify_one();
return Ok(());
}
match self.route_local(envelope.clone(), None).await {
Ok(()) => return Ok(()),
Err(e) if Self::is_retryable(&e) && !is_last => {
tracing::debug!(attempt, error = %e, "notify: retryable error, will retry");
last_err = Some(e);
continue;
}
Err(e) => return Err(e),
}
} else if let Some(owner) = self.get_shard_owner_async(&shard_id).await {
// Self-send guard: same as in send() — prevent infinite recursion
if owner == self.config.runner_address {
if envelope.persisted {
self.storage_poll_notify.notify_one();
return Ok(());
}
match self.route_local(envelope.clone(), None).await {
Ok(()) => return Ok(()),
Err(e) if Self::is_retryable(&e) && !is_last => {
tracing::debug!(attempt, error = %e, "notify: retryable error (self-routed), will retry");
last_err = Some(e);
continue;
}
Err(e) => return Err(e),
}
}
match self
.runners
.notify(&owner, Envelope::Request(envelope.clone()))
.await
{
Ok(()) => return Ok(()),
Err(e) if Self::is_retryable(&e) && !is_last => {
tracing::debug!(attempt, error = %e, "notify: retryable error on remote, will retry");
last_err = Some(e);
continue;
}
Err(e) => return Err(e),
}
} else {
if !is_last {
tracing::debug!(attempt, "notify: shard not assigned, will retry");
last_err = Some(ClusterError::EntityNotAssignedToRunner {
entity_type: envelope.address.entity_type.clone(),
entity_id: envelope.address.entity_id.clone(),
});
continue;
}
return Err(ClusterError::EntityNotAssignedToRunner {
entity_type: envelope.address.entity_type,
entity_id: envelope.address.entity_id,
});
}
}
Err(
last_err.unwrap_or_else(|| ClusterError::EntityNotAssignedToRunner {
entity_type: envelope.address.entity_type,
entity_id: envelope.address.entity_id,
}),
)
}
#[instrument(level = "debug", skip(self, ack), fields(request_id = %ack.request_id, sequence = ack.sequence))]
async fn ack_chunk(&self, ack: AckChunk) -> Result<(), ClusterError> {
if self.is_shutdown() {
return Err(ClusterError::ShuttingDown);
}
let storage = match &self.message_storage {
Some(storage) => storage,
None => {
return Err(ClusterError::PersistenceError {
reason: "ack requires message storage".to_string(),
source: None,
})
}
};
storage.ack_chunk(&ack).await
}
#[instrument(skip(self, interrupt), fields(
entity_type = %interrupt.address.entity_type,
entity_id = %interrupt.address.entity_id,
shard_id = %interrupt.address.shard_id,
request_id = %interrupt.request_id,
))]
async fn interrupt(&self, interrupt: Interrupt) -> Result<(), ClusterError> {
if self.is_shutdown() {
return Err(ClusterError::ShuttingDown);
}
let shard_id = interrupt.address.shard_id.clone();
let entity_type = interrupt.address.entity_type.clone();
let entity_id = interrupt.address.entity_id.clone();
if self.has_shard_async(&shard_id).await {
self.handle_interrupt_local(&interrupt).await;
return Ok(());
}
if let Some(owner) = self.get_shard_owner_async(&shard_id).await {
// Self-send guard: same as in send() — prevent infinite recursion
if owner == self.config.runner_address {
self.handle_interrupt_local(&interrupt).await;
return Ok(());
}
return self
.runners
.notify(&owner, Envelope::Interrupt(interrupt))
.await;
}
Err(ClusterError::EntityNotAssignedToRunner {
entity_type,
entity_id,
})
}
async fn poll_storage(&self) -> Result<(), ClusterError> {
self.poll_storage_inner().await
}
fn active_entity_count(&self) -> usize {
self.entity_managers
.iter()
.map(|entry| entry.value().active_count())
.sum()
}
async fn registration_events(
&self,
) -> Pin<Box<dyn Stream<Item = ShardingRegistrationEvent> + Send>> {
use tokio_stream::StreamExt;
let rx = self.event_tx.subscribe();
let stream = tokio_stream::wrappers::BroadcastStream::new(rx);
Box::pin(
stream.filter_map(|r: Result<ShardingRegistrationEvent, _>| match r {
Ok(event) => Some(event),
Err(tokio_stream::wrappers::errors::BroadcastStreamRecvError::Lagged(count)) => {
tracing::warn!(
lagged_count = count,
"registration_events subscriber lagged, {} events dropped",
count
);
None
}
}),
)
}
#[instrument(level = "debug", skip(self))]
async fn replies_for(&self, request_id: Snowflake) -> Result<Vec<Reply>, ClusterError> {
match &self.message_storage {
Some(storage) => storage.replies_for(request_id).await,
None => Ok(vec![]),
}
}
#[instrument(level = "debug", skip(self))]
async fn await_reply(&self, request_id: Snowflake) -> Result<ReplyReceiver, ClusterError> {
let storage =
self.message_storage
.as_ref()
.ok_or_else(|| ClusterError::PersistenceError {
reason: "await_reply requires message storage".into(),
source: None,
})?;
let (tx, rx) = mpsc::channel(16);
// Check if the reply already exists in storage.
let replies = storage.replies_for(request_id).await?;
for reply in replies {
let is_exit = matches!(reply, Reply::WithExit(_));
let _ = tx.send(reply).await;
if is_exit {
return Ok(rx);
}
}
// Reply not yet available — register a live handler so that when
// `save_reply` is called for this request_id, the reply is pushed
// through the channel in real-time.
storage.register_reply_handler(request_id, tx);
Ok(rx)
}
#[instrument(skip(self))]
async fn shutdown(&self) -> Result<(), ClusterError> {
self.shutdown.store(true, Ordering::Release);
self.cancel.cancel();
// Cancel all singletons and collect their JoinHandles for awaiting.
let mut singleton_handles: Vec<tokio::task::JoinHandle<()>> = Vec::new();
for mut entry in self.singletons.iter_mut() {
entry.value().cancel.cancel();
if let Some(h) = entry.value_mut().handle.take() {
singleton_handles.push(h);
}
}
// Transition all entity managers to "closing" state before interrupting.
// In closing state, new Request messages are rejected but Envelope messages
// (fire-and-forget, ack, interrupt) are still accepted, allowing in-flight
// operations to complete. Matches TS Sharding.ts:1286 (alive → closing → closed).
for entry in self.entity_managers.iter() {
entry.value().set_closing();
}
// Interrupt all entities on all owned shards
let owned = self.owned_shards.read().await.clone();
for shard_id in &owned {
for entry in self.entity_managers.iter() {
entry.value().interrupt_shard(shard_id).await;
}
}
// Collect resumption task handles.
let resumption_handles: Vec<_> = self
.resumption_handles
.iter()
.map(|r| r.key().clone())
.collect::<Vec<_>>()
.into_iter()
.filter_map(|k| self.resumption_handles.remove(&k).map(|(_, h)| h))
.collect();
// Wait for background tasks to stop FIRST, before releasing shard locks.
// This ensures no concurrent etcd operations from rebalance/refresh loops.
let handles: Vec<_> = {
let mut tasks = self.background_tasks.lock().await;
let mut all = tasks.drain(..).collect::<Vec<_>>();
all.extend(singleton_handles);
all.extend(resumption_handles);
all
};
let total = handles.len();
for (i, handle) in handles.into_iter().enumerate() {
match tokio::time::timeout(self.config.entity_termination_timeout, handle).await {
Ok(Ok(())) => {}
Ok(Err(join_error)) => {
if join_error.is_panic() {
let panic_payload = join_error.into_panic();
let msg = if let Some(s) = panic_payload.downcast_ref::<&str>() {
(*s).to_string()
} else if let Some(s) = panic_payload.downcast_ref::<String>() {
s.clone()
} else {
"unknown panic".to_string()
};
tracing::error!(
task_index = i,
task_count = total,
panic_message = %msg,
"background task panicked during shutdown"
);
} else {
tracing::warn!(
task_index = i,
task_count = total,
error = %join_error,
"background task failed during shutdown"
);
}
}
Err(_timeout) => {
tracing::warn!(
task_index = i,
task_count = total,
timeout_secs = self.config.entity_termination_timeout.as_secs_f64(),
"background task did not complete within shutdown timeout"
);
}
}
}
// Release all shard locks in storage AFTER background tasks have stopped.
// This prevents concurrent etcd operations from rebalance/refresh loops.
if let Some(ref runner_storage) = self.runner_storage {
if let Err(e) = runner_storage
.release_all(&self.config.runner_address)
.await
{
tracing::warn!(error = %e, "failed to release all shard locks during shutdown");
}
}
// Clear owned shards
self.owned_shards.write().await.clear();
self.metrics.shards.set(0);
tracing::info!("sharding shut down");
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::entity::{Entity, EntityContext, EntityHandler};
use crate::reply::{ExitResult, Reply};
use crate::snowflake::Snowflake;
use crate::storage::noop_runners::NoopRunners;
use crate::types::{EntityAddress, EntityId};
use async_trait::async_trait;
use std::collections::HashMap;
use std::sync::Mutex;
struct EchoEntity;
#[async_trait]
impl Entity for EchoEntity {
fn entity_type(&self) -> EntityType {
EntityType::new("Echo")
}
async fn spawn(&self, _ctx: EntityContext) -> Result<Box<dyn EntityHandler>, ClusterError> {
Ok(Box::new(EchoHandler))
}
}
struct EchoHandler;
#[async_trait]
impl EntityHandler for EchoHandler {
async fn handle_request(
&self,
_tag: &str,
payload: &[u8],
_headers: &HashMap<String, String>,
) -> Result<Vec<u8>, ClusterError> {
Ok(payload.to_vec())
}
}
#[derive(Default, Clone)]
struct RecordingWorkflowEngine {
resolved: Arc<Mutex<Vec<(String, String, String)>>>,
}
#[async_trait]
impl WorkflowEngine for RecordingWorkflowEngine {
async fn sleep(
&self,
_workflow_name: &str,
_execution_id: &str,
_name: &str,
_duration: std::time::Duration,
) -> Result<(), ClusterError> {
Ok(())
}
async fn await_deferred(
&self,
_workflow_name: &str,
_execution_id: &str,
_name: &str,
) -> Result<Vec<u8>, ClusterError> {
Ok(Vec::new())
}
async fn resolve_deferred(
&self,
workflow_name: &str,
execution_id: &str,
name: &str,
_value: Vec<u8>,
) -> Result<(), ClusterError> {
self.resolved.lock().unwrap().push((
workflow_name.to_string(),
execution_id.to_string(),
name.to_string(),
));
Ok(())
}
async fn on_interrupt(
&self,
_workflow_name: &str,
_execution_id: &str,
) -> Result<(), ClusterError> {
Ok(())
}
}
fn make_sharding() -> Arc<ShardingImpl> {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
ShardingImpl::new(config, runners, None, None, None, metrics).unwrap()
}
#[tokio::test]
async fn interrupt_resolves_workflow_signal_locally() {
let resolved = Arc::new(Mutex::new(Vec::new()));
let engine = Arc::new(RecordingWorkflowEngine {
resolved: Arc::clone(&resolved),
});
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let sharding = ShardingImpl::new_with_engines(
config,
runners,
None,
None,
None,
None,
Some(engine),
metrics,
)
.unwrap();
sharding.acquire_all_shards().await;
let address = EntityAddress {
shard_id: ShardId::new("default", 0),
entity_type: EntityType::new("Echo"),
entity_id: EntityId::new("e-1"),
};
let interrupt = Interrupt {
request_id: Snowflake(1),
address,
};
sharding.interrupt(interrupt).await.unwrap();
let resolved = resolved.lock().unwrap();
assert_eq!(resolved.len(), 1);
assert_eq!(resolved[0].0, "Echo");
assert_eq!(resolved[0].1, "e-1");
assert_eq!(resolved[0].2, INTERRUPT_SIGNAL);
}
struct CustomGroupEntity;
#[async_trait]
impl Entity for CustomGroupEntity {
fn entity_type(&self) -> EntityType {
EntityType::new("CustomGroup")
}
fn shard_group(&self) -> &str {
"premium"
}
async fn spawn(&self, _ctx: EntityContext) -> Result<Box<dyn EntityHandler>, ClusterError> {
Ok(Box::new(EchoHandler))
}
}
/// Entity with per-ID shard group resolution.
struct PerIdGroupEntity;
#[async_trait]
impl Entity for PerIdGroupEntity {
fn entity_type(&self) -> EntityType {
EntityType::new("PerIdGroup")
}
fn shard_group_for(&self, entity_id: &EntityId) -> &str {
if entity_id.as_ref().starts_with("vip-") {
"premium"
} else {
"default"
}
}
async fn spawn(&self, _ctx: EntityContext) -> Result<Box<dyn EntityHandler>, ClusterError> {
Ok(Box::new(EchoHandler))
}
}
#[tokio::test]
async fn get_shard_id_is_deterministic() {
let s = make_sharding();
let et = EntityType::new("Test");
let eid = EntityId::new("abc");
let s1 = s.get_shard_id(&et, &eid);
let s2 = s.get_shard_id(&et, &eid);
assert_eq!(s1, s2);
}
#[tokio::test]
async fn get_shard_id_in_range() {
let s = make_sharding();
let et = EntityType::new("Test");
for i in 0..100 {
let eid = EntityId::new(format!("id-{i}"));
let shard = s.get_shard_id(&et, &eid);
assert!(shard.id >= 0 && shard.id < 10);
assert_eq!(shard.group, "default");
}
}
#[tokio::test]
async fn has_shard_id_after_acquire() {
let s = make_sharding();
let shard = ShardId::new("default", 0);
assert!(!s.has_shard_id(&shard));
s.acquire_all_shards().await;
assert!(s.has_shard_id(&shard));
}
#[tokio::test]
async fn register_entity_and_send_locally() {
let s = make_sharding();
s.acquire_all_shards().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let eid = EntityId::new("e-1");
let shard = s.get_shard_id(&EntityType::new("Echo"), &eid);
let payload = rmp_serde::to_vec(&42i32).unwrap();
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: shard,
entity_type: EntityType::new("Echo"),
entity_id: eid,
},
tag: "echo".into(),
payload: payload.clone(),
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
let mut rx = s.send(envelope).await.unwrap();
let reply = rx.recv().await.unwrap();
match reply {
Reply::WithExit(r) => match r.exit {
ExitResult::Success(bytes) => assert_eq!(bytes, payload),
ExitResult::Failure(msg) => panic!("unexpected failure: {msg}"),
},
Reply::Chunk(_) => panic!("unexpected chunk"),
}
}
#[tokio::test]
async fn notify_locally() {
let s = make_sharding();
s.acquire_all_shards().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let eid = EntityId::new("e-1");
let shard = s.get_shard_id(&EntityType::new("Echo"), &eid);
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: shard,
entity_type: EntityType::new("Echo"),
entity_id: eid,
},
tag: "ping".into(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
s.notify(envelope).await.unwrap();
// Give time for processing
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
assert!(s.active_entity_count() > 0);
}
#[tokio::test]
async fn send_to_unowned_shard_fails() {
let s = make_sharding();
// Don't acquire shards
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: ShardId::new("default", 0),
entity_type: EntityType::new("Echo"),
entity_id: EntityId::new("e-1"),
},
tag: "echo".into(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
let result = s.send(envelope).await;
assert!(result.is_err());
}
#[tokio::test]
async fn send_to_unregistered_entity_fails() {
let s = make_sharding();
s.acquire_all_shards().await;
// Don't register any entity
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: ShardId::new("default", 0),
entity_type: EntityType::new("NonExistent"),
entity_id: EntityId::new("e-1"),
},
tag: "x".into(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
let result = s.send(envelope).await;
assert!(result.is_err());
}
#[tokio::test]
async fn make_client_works() {
let s = make_sharding();
s.acquire_all_shards().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let client = Arc::clone(&s).make_client(EntityType::new("Echo"));
assert_eq!(client.entity_type(), &EntityType::new("Echo"));
}
#[tokio::test]
async fn shutdown_sets_flag() {
let s = make_sharding();
assert!(!s.is_shutdown());
s.shutdown().await.unwrap();
assert!(s.is_shutdown());
}
#[tokio::test]
async fn active_entity_count_reflects_spawned() {
let s = make_sharding();
s.acquire_all_shards().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
assert_eq!(s.active_entity_count(), 0);
// Send a message to spawn an entity
let eid = EntityId::new("e-1");
let shard = s.get_shard_id(&EntityType::new("Echo"), &eid);
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: shard,
entity_type: EntityType::new("Echo"),
entity_id: eid,
},
tag: "echo".into(),
payload: vec![1],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
let mut rx = s.send(envelope).await.unwrap();
rx.recv().await.unwrap();
assert!(s.active_entity_count() > 0);
}
#[tokio::test]
async fn registration_events_emitted() {
use tokio_stream::StreamExt;
let s = make_sharding();
let mut events = s.registration_events().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let event = tokio::time::timeout(std::time::Duration::from_millis(100), events.next())
.await
.unwrap()
.unwrap();
assert!(matches!(
event,
ShardingRegistrationEvent::EntityRegistered { .. }
));
}
#[tokio::test]
async fn singleton_registration() {
let s = make_sharding();
let (tx, mut rx) = tokio::sync::oneshot::channel::<()>();
let tx = Arc::new(std::sync::Mutex::new(Some(tx)));
s.register_singleton(
"test-singleton",
None,
Arc::new(move |_ctx| {
let tx = tx.clone();
Box::pin(async move {
if let Some(tx) = tx.lock().unwrap().take() {
let _ = tx.send(());
}
Ok(())
})
}),
)
.await
.unwrap();
// The singleton should run
tokio::time::timeout(std::time::Duration::from_millis(100), &mut rx)
.await
.unwrap()
.unwrap();
}
#[tokio::test]
async fn shutdown_cancels_singletons() {
let s = make_sharding();
let (tx, mut rx) = tokio::sync::oneshot::channel::<&'static str>();
let tx = Arc::new(std::sync::Mutex::new(Some(tx)));
s.register_singleton(
"long-singleton",
None,
Arc::new(move |_ctx| {
let tx = tx.clone();
Box::pin(async move {
// This would run forever, but shutdown should cancel it
tokio::time::sleep(std::time::Duration::from_secs(3600)).await;
if let Some(tx) = tx.lock().unwrap().take() {
let _ = tx.send("completed");
}
Ok(())
})
}),
)
.await
.unwrap();
tokio::time::sleep(std::time::Duration::from_millis(10)).await;
s.shutdown().await.unwrap();
// The singleton should have been cancelled, so rx should be dropped
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
assert!(rx.try_recv().is_err());
}
#[tokio::test]
async fn get_shard_id_uses_entity_shard_group() {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string(), "premium".to_string()],
shards_per_group: 10,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
// Before registration, falls back to first config group
let eid = EntityId::new("abc");
let shard = s.get_shard_id(&EntityType::new("CustomGroup"), &eid);
assert_eq!(shard.group, "default");
// After registration, uses entity's shard_group_for()
s.register_entity(Arc::new(CustomGroupEntity))
.await
.unwrap();
let shard = s.get_shard_id(&EntityType::new("CustomGroup"), &eid);
assert_eq!(shard.group, "premium");
}
#[tokio::test]
async fn get_shard_id_per_entity_id_group_resolution() {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string(), "premium".to_string()],
shards_per_group: 10,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
s.register_entity(Arc::new(PerIdGroupEntity)).await.unwrap();
let regular = EntityId::new("user-123");
let vip = EntityId::new("vip-456");
let shard_regular = s.get_shard_id(&EntityType::new("PerIdGroup"), ®ular);
let shard_vip = s.get_shard_id(&EntityType::new("PerIdGroup"), &vip);
assert_eq!(shard_regular.group, "default");
assert_eq!(shard_vip.group, "premium");
}
#[tokio::test]
async fn persisted_send_without_storage_returns_error() {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
s.acquire_all_shards().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let eid = EntityId::new("e-no-storage");
let shard = s.get_shard_id(&EntityType::new("Echo"), &eid);
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: shard.clone(),
entity_type: EntityType::new("Echo"),
entity_id: eid,
},
tag: "echo".into(),
payload: vec![1],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: true,
uninterruptible: Default::default(),
deliver_at: None,
};
let err = s.send(envelope).await.unwrap_err();
match err {
ClusterError::PersistenceError { reason, .. } => {
assert!(reason.contains("message storage"));
}
other => panic!("unexpected error: {other:?}"),
}
}
#[tokio::test]
async fn persisted_notify_without_storage_returns_error() {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
s.acquire_all_shards().await;
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
let eid = EntityId::new("e-no-storage-notify");
let shard = s.get_shard_id(&EntityType::new("Echo"), &eid);
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id: shard.clone(),
entity_type: EntityType::new("Echo"),
entity_id: eid,
},
tag: "ping".into(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: true,
uninterruptible: Default::default(),
deliver_at: None,
};
let err = s.notify(envelope).await.unwrap_err();
match err {
ClusterError::PersistenceError { reason, .. } => {
assert!(reason.contains("message storage"));
}
other => panic!("unexpected error: {other:?}"),
}
}
#[tokio::test]
async fn poll_storage_no_op_without_storage() {
let s = make_sharding();
s.acquire_all_shards().await;
// No storage configured — should return Ok without error
s.poll_storage().await.unwrap();
}
#[tokio::test]
async fn singleton_custom_shard_group_uses_specified_group() {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string(), "custom".to_string()],
shards_per_group: 10,
..Default::default()
});
let s = ShardingImpl::new(
config,
Arc::new(NoopRunners),
None,
None,
None,
Arc::new(ClusterMetrics::unregistered()),
)
.unwrap();
s.acquire_all_shards().await;
let executed = Arc::new(std::sync::atomic::AtomicBool::new(false));
let executed_clone = Arc::clone(&executed);
// Register with a custom shard group
s.register_singleton(
"custom-group-singleton",
Some("custom"),
Arc::new(move |_ctx| {
let e = executed_clone.clone();
Box::pin(async move {
e.store(true, std::sync::atomic::Ordering::SeqCst);
Ok(())
})
}),
)
.await
.unwrap();
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
// Singleton should have executed (all shards owned in single-node mode)
assert!(
executed.load(std::sync::atomic::Ordering::SeqCst),
"singleton with custom shard group should have executed"
);
// Verify the shard_group is stored correctly
let entry = s.singletons.get("custom-group-singleton").unwrap();
assert_eq!(entry.shard_group, "custom");
}
#[tokio::test]
async fn metrics_updated_on_registration() {
let metrics = Arc::new(ClusterMetrics::unregistered());
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
..Default::default()
});
let s = ShardingImpl::new(
config,
Arc::new(NoopRunners),
None,
None,
None,
Arc::clone(&metrics),
)
.unwrap();
s.acquire_all_shards().await;
assert_eq!(metrics.shards.get(), 10);
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
assert_eq!(metrics.entities.get(), 1);
}
#[tokio::test]
async fn route_local_waits_for_late_entity_registration() {
use std::time::Duration;
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
entity_registration_timeout: Duration::from_secs(2),
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
s.acquire_all_shards().await;
// Build an envelope targeting an "Echo" entity (not yet registered).
let entity_id = EntityId::new("test-1");
let shard_id = s.get_shard_id(&EntityType::new("Echo"), &entity_id);
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id,
entity_type: EntityType::new("Echo"),
entity_id,
},
tag: "ping".to_string(),
payload: vec![1, 2, 3],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
let (reply_tx, mut reply_rx) = mpsc::channel(1);
// Spawn route_local — it should wait for entity registration.
let s_clone = Arc::clone(&s);
let envelope_clone = envelope.clone();
let route_handle =
tokio::spawn(async move { s_clone.route_local(envelope_clone, Some(reply_tx)).await });
// Give the route a moment to enter the wait state.
tokio::time::sleep(Duration::from_millis(50)).await;
assert!(!route_handle.is_finished(), "route_local should be waiting");
// Register the entity — should unblock route_local.
s.register_entity(Arc::new(EchoEntity)).await.unwrap();
// route_local should succeed.
let result = tokio::time::timeout(Duration::from_secs(1), route_handle)
.await
.expect("route_local should complete")
.expect("task should not panic");
assert!(result.is_ok(), "route_local should succeed: {result:?}");
// Should receive a reply from the echo handler.
let reply = tokio::time::timeout(Duration::from_secs(1), reply_rx.recv())
.await
.expect("should receive reply")
.expect("reply channel should not be closed");
match reply {
Reply::WithExit(r) => match r.exit {
ExitResult::Success(data) => assert_eq!(data, vec![1, 2, 3]),
ExitResult::Failure(e) => panic!("unexpected failure: {e}"),
},
_ => panic!("expected WithExit reply"),
}
}
#[tokio::test]
async fn route_local_times_out_for_unregistered_entity() {
use std::time::Duration;
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
entity_registration_timeout: Duration::from_millis(100),
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
s.acquire_all_shards().await;
let entity_id = EntityId::new("test-1");
let shard_id = s.get_shard_id(&EntityType::new("Unknown"), &entity_id);
let envelope = EnvelopeRequest {
request_id: s.snowflake().next_async().await.unwrap(),
address: crate::types::EntityAddress {
shard_id,
entity_type: EntityType::new("Unknown"),
entity_id,
},
tag: "ping".to_string(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: Default::default(),
deliver_at: None,
};
let result = s.route_local(envelope, None).await;
assert!(result.is_err());
let err = result.unwrap_err();
match &err {
ClusterError::MalformedMessage { reason, .. } => {
assert!(
reason.contains("waited"),
"error should mention wait: {reason}"
);
}
_ => panic!("expected MalformedMessage, got: {err}"),
}
}
#[tokio::test]
async fn singleton_crash_backoff_delays_respawn() {
use std::sync::atomic::{AtomicU32, Ordering};
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
// Use a short backoff base for testing
singleton_crash_backoff_base: std::time::Duration::from_millis(500),
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
s.acquire_all_shards().await;
let call_count = Arc::new(AtomicU32::new(0));
let call_count_clone = Arc::clone(&call_count);
// Register a singleton that always fails
s.register_singleton(
"failing-singleton",
None,
Arc::new(move |_ctx| {
let cc = call_count_clone.clone();
Box::pin(async move {
cc.fetch_add(1, Ordering::SeqCst);
Err(ClusterError::PersistenceError {
reason: "test failure".into(),
source: None,
})
})
}),
)
.await
.unwrap();
// Wait for the first run to complete (it will fail)
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
assert_eq!(call_count.load(Ordering::SeqCst), 1, "should have run once");
// The singleton should not be running now (it failed)
let entry = s.singletons.get("failing-singleton").unwrap();
assert!(!entry.running.load(Ordering::SeqCst));
assert_eq!(
entry.consecutive_failures.load(Ordering::Acquire),
1,
"should have 1 consecutive failure"
);
assert!(
entry.last_failure_ms.load(Ordering::Acquire) > 0,
"should have recorded failure time"
);
drop(entry);
// Call sync_singletons immediately — should NOT respawn due to backoff (500ms base)
s.sync_singletons().await;
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
assert_eq!(
call_count.load(Ordering::SeqCst),
1,
"should not have respawned yet due to backoff"
);
// Wait for backoff to expire (500ms base * 2^0 = 500ms)
tokio::time::sleep(std::time::Duration::from_millis(500)).await;
// Now sync_singletons should respawn
s.sync_singletons().await;
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
assert_eq!(
call_count.load(Ordering::SeqCst),
2,
"should have respawned after backoff expired"
);
// After 2nd failure, backoff is 500ms * 2^1 = 1000ms — sync should NOT respawn
s.sync_singletons().await;
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
assert_eq!(
call_count.load(Ordering::SeqCst),
2,
"should not have respawned — 2nd backoff not expired"
);
}
#[tokio::test]
async fn send_retries_on_entity_not_assigned() {
// Create a sharding instance with no shards owned and send_retry_count = 2.
// send() should retry and eventually return EntityNotAssignedToRunner.
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
send_retry_count: 2,
send_retry_interval: std::time::Duration::from_millis(10),
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
// Don't acquire any shards — all sends should fail
let envelope = EnvelopeRequest {
request_id: s.snowflake().next().unwrap(),
address: EntityAddress {
shard_id: ShardId::new("default", 0),
entity_type: EntityType::new("Test"),
entity_id: EntityId::new("1"),
},
tag: "test".to_string(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: crate::schema::Uninterruptible::No,
deliver_at: None,
};
let start = std::time::Instant::now();
let result = s.send(envelope).await;
let elapsed = start.elapsed();
assert!(result.is_err());
assert!(
matches!(
result.unwrap_err(),
ClusterError::EntityNotAssignedToRunner { .. }
),
"expected EntityNotAssignedToRunner"
);
// Should have taken at least 2 retry intervals (2 * 10ms = 20ms)
assert!(
elapsed >= std::time::Duration::from_millis(15),
"expected retries to take at least 15ms, got {:?}",
elapsed
);
}
#[tokio::test]
async fn send_retry_count_zero_no_retries() {
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
send_retry_count: 0,
..Default::default()
});
let runners: Arc<dyn Runners> = Arc::new(NoopRunners);
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(config, runners, None, None, None, metrics).unwrap();
let envelope = EnvelopeRequest {
request_id: s.snowflake().next().unwrap(),
address: EntityAddress {
shard_id: ShardId::new("default", 0),
entity_type: EntityType::new("Test"),
entity_id: EntityId::new("1"),
},
tag: "test".to_string(),
payload: vec![],
headers: HashMap::new(),
span_id: None,
trace_id: None,
sampled: None,
persisted: false,
uninterruptible: crate::schema::Uninterruptible::No,
deliver_at: None,
};
let start = std::time::Instant::now();
let result = s.send(envelope).await;
let elapsed = start.elapsed();
assert!(result.is_err());
// With 0 retries, should fail almost immediately
assert!(
elapsed < std::time::Duration::from_millis(50),
"expected no retries, got {:?}",
elapsed
);
}
// -------------------------------------------------------------------------
// Detachment Tests
// -------------------------------------------------------------------------
#[tokio::test]
async fn detach_on_keepalive_failure_streak() {
use std::time::Duration;
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
detachment_enabled: true,
detachment_recover_window: Duration::from_millis(100),
keepalive_failure_threshold: 3,
..Default::default()
});
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(
config,
Arc::new(NoopRunners),
None,
None,
None,
metrics.clone(),
)
.unwrap();
// Acquire some shards
s.acquire_all_shards().await;
assert!(!s.owned_shards.read().await.is_empty());
assert!(!s.is_detached());
// Create a lease health channel to simulate keep-alive updates
let (health_tx, health_rx) = tokio::sync::broadcast::channel::<LeaseHealth>(16);
// Start the lease health loop
let s_clone = Arc::clone(&s);
let handle = tokio::spawn(async move {
s_clone.lease_health_loop(health_rx).await;
});
// Send healthy signals first
health_tx
.send(LeaseHealth {
healthy: true,
failure_streak: 0,
})
.unwrap();
tokio::time::sleep(Duration::from_millis(10)).await;
assert!(!s.is_detached());
// Send failures below threshold
health_tx
.send(LeaseHealth {
healthy: false,
failure_streak: 2,
})
.unwrap();
tokio::time::sleep(Duration::from_millis(10)).await;
assert!(!s.is_detached(), "should not detach below threshold");
// Send failure at threshold
health_tx
.send(LeaseHealth {
healthy: false,
failure_streak: 3,
})
.unwrap();
tokio::time::sleep(Duration::from_millis(10)).await;
assert!(
s.is_detached(),
"should be detached after failure streak exceeds threshold"
);
assert!(
s.owned_shards.read().await.is_empty(),
"owned_shards should be cleared on detachment"
);
// Verify metrics
assert_eq!(metrics.lease_keepalive_failure_streak.get(), 3);
s.cancel.cancel();
let _ = handle.await;
}
#[tokio::test]
async fn reattach_after_recovery_window() {
use std::time::Duration;
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
detachment_enabled: true,
detachment_recover_window: Duration::from_millis(50),
..Default::default()
});
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(
config,
Arc::new(NoopRunners),
None,
None,
None,
metrics.clone(),
)
.unwrap();
// Detach
s.detach(DetachmentReason::Manual).await;
assert!(s.is_detached());
assert_eq!(metrics.sharding_detached.get(), 1);
// First healthy signal starts recovery window
s.signal_healthy();
assert!(
s.is_detached(),
"should still be detached immediately after first healthy signal"
);
// Wait for recovery window to elapse
tokio::time::sleep(Duration::from_millis(60)).await;
// Another healthy signal should trigger re-attachment
s.signal_healthy();
assert!(
!s.is_detached(),
"should be re-attached after recovery window"
);
assert_eq!(metrics.sharding_detached.get(), 0);
}
#[tokio::test]
async fn unhealthy_signal_resets_recovery_window() {
use std::time::Duration;
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
detachment_enabled: true,
detachment_recover_window: Duration::from_millis(100),
..Default::default()
});
let metrics = Arc::new(ClusterMetrics::unregistered());
let s =
ShardingImpl::new(config, Arc::new(NoopRunners), None, None, None, metrics).unwrap();
// Detach
s.detach(DetachmentReason::Manual).await;
assert!(s.is_detached());
// Start recovery
s.signal_healthy();
// Wait partway through recovery window
tokio::time::sleep(Duration::from_millis(50)).await;
// Signal unhealthy - resets recovery
s.signal_unhealthy();
// Wait a bit more (would have exceeded window if not reset)
tokio::time::sleep(Duration::from_millis(60)).await;
// Should still be detached because recovery was reset
s.signal_healthy();
assert!(
s.is_detached(),
"should still be detached after recovery reset"
);
// Now wait for full recovery window
tokio::time::sleep(Duration::from_millis(110)).await;
s.signal_healthy();
assert!(
!s.is_detached(),
"should be re-attached after full recovery window"
);
}
#[tokio::test]
async fn detachment_disabled_ignores_detach_calls() {
use std::time::Duration;
let config = Arc::new(ShardingConfig {
shard_groups: vec!["default".to_string()],
shards_per_group: 10,
detachment_enabled: false, // Disabled!
detachment_recover_window: Duration::from_millis(50),
..Default::default()
});
let metrics = Arc::new(ClusterMetrics::unregistered());
let s = ShardingImpl::new(
config,
Arc::new(NoopRunners),
None,
None,
None,
metrics.clone(),
)
.unwrap();
// Acquire shards
s.acquire_all_shards().await;
let shard_count = s.owned_shards.read().await.len();
assert!(shard_count > 0);
// Try to detach
s.detach(DetachmentReason::Manual).await;
// Should NOT be detached (feature disabled)
assert!(
!s.is_detached(),
"should not detach when detachment_enabled=false"
);
assert_eq!(
s.owned_shards.read().await.len(),
shard_count,
"owned_shards should not be cleared when detachment is disabled"
);
assert_eq!(
metrics.sharding_detached.get(),
0,
"detachment metric should not change when disabled"
);
}
}