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
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
//! Consumer group coordination.
//!
//! This module provides consumer group coordination primitives including:
//! - [`ConsumerGroup`] state machine for group coordination
//! - [`GroupCoordinator`] for managing group membership and heartbeats
//! - [`MemberAssignment`] for tracking partition assignments
//! - [`PartitionAssignor`] trait and implementations for partition assignment strategies
//! - [`ConsumerRebalanceListener`] trait for rebalance callbacks
use std::collections::{HashMap, HashSet};
use std::sync::Arc;
use std::time::Duration;
use bytes::{Buf, BufMut, Bytes, BytesMut};
use tokio::sync::{RwLock, mpsc};
use tracing::{debug, error, info, warn};
use crate::PartitionId;
use crate::error::{ErrorCode, KrafkaError, ProtocolErrorKind, Result};
use crate::metadata::ClusterMetadata;
use crate::network::{BrokerConnection, ConnectionPool};
use crate::protocol::{
ApiKey, ConsumerGroupHeartbeatRequest, ConsumerGroupHeartbeatResponse,
ConsumerGroupTopicPartitions, FindCoordinatorRequest, FindCoordinatorResponse,
HeartbeatRequest, HeartbeatResponse, JoinGroupRequest, JoinGroupRequestProtocol,
JoinGroupResponse, JoinGroupResponseMember, LeaveGroupMember, LeaveGroupRequest,
LeaveGroupResponse, ListOffsetsRequest, ListOffsetsRequestPartition, ListOffsetsRequestTopic,
ListOffsetsResponse, MAX_DECODE_ARRAY_LEN, OffsetCommitRequest, OffsetCommitRequestPartition,
OffsetCommitRequestTopic, OffsetCommitResponse, OffsetFetchRequest, OffsetFetchRequestTopic,
OffsetFetchResponse, SyncGroupRequest, SyncGroupRequestAssignment, SyncGroupResponse,
VersionedDecode, VersionedEncode,
versions::{
CONSUMER_GROUP_HEARTBEAT_MAX, CONSUMER_GROUP_HEARTBEAT_MIN, FIND_COORDINATOR_MAX,
FIND_COORDINATOR_MIN, HEARTBEAT_MAX, HEARTBEAT_MIN, JOIN_GROUP_MAX, JOIN_GROUP_MIN,
LEAVE_GROUP_MAX, LEAVE_GROUP_MIN, LIST_OFFSETS_MAX, LIST_OFFSETS_MIN, OFFSET_COMMIT_MAX,
OFFSET_COMMIT_MIN, OFFSET_FETCH_MAX, OFFSET_FETCH_MIN, SYNC_GROUP_MAX, SYNC_GROUP_MIN,
},
};
/// Callback interface for partition rebalance events.
///
/// Implement this trait to receive notifications when the consumer's
/// partition assignment changes during a rebalance.
///
/// # Synchronous execution contract
///
/// All methods are **synchronous** and are invoked on the consumer's
/// poll/rebalance task. The consumer **blocks** until the callback
/// returns, so:
///
/// - Do **not** spawn detached async tasks that race with the
/// rebalance (e.g., committing offsets in a `tokio::spawn`). The
/// consumer will continue reassigning partitions immediately after
/// the callback returns, and the spawned task may see stale state.
/// - Blocking I/O (e.g., offset commits) is safe to issue here when
/// wrapped in `tokio::task::block_in_place` or by using a
/// synchronous Kafka commit helper.
/// - Keep callbacks fast. Long-running work should be deferred to a
/// separate channel that the application drains at its own pace.
///
/// If you need **async** work inside a callback, block on it using
/// `tokio::task::block_in_place` so it completes before the callback
/// returns. `block_in_place` requires Tokio's multi-thread runtime;
/// on a current-thread runtime, use a dedicated thread and a channel
/// to synchronously bridge async work. Do **not** call
/// `Handle::current().block_on(...)` directly — that panics when called
/// from inside a Tokio worker thread.
///
/// ```rust,ignore
/// use tokio::runtime::Handle;
///
/// fn on_partitions_revoked(&self, partitions: &[TopicPartition]) {
/// // Multi-thread runtime only:
/// tokio::task::block_in_place(|| {
/// Handle::current().block_on(async {
/// // e.g., commit offsets synchronously
/// });
/// });
///
/// // Current-thread runtime alternative:
/// // let handle = Handle::current();
/// // let (tx, rx) = std::sync::mpsc::channel();
/// // std::thread::spawn(move || {
/// // let result = handle.block_on(async { Ok::<_, ()>(()) });
/// // let _ = tx.send(result);
/// // });
/// // let _ = rx.recv();
/// }
/// ```
///
/// # Example
///
/// ```rust,ignore
/// use krafka::consumer::{ConsumerRebalanceListener, TopicPartition};
///
/// struct MyListener;
///
/// impl ConsumerRebalanceListener for MyListener {
/// fn on_partitions_assigned(&self, partitions: &[TopicPartition]) {
/// println!("Assigned: {:?}", partitions);
/// }
///
/// fn on_partitions_revoked(&self, partitions: &[TopicPartition]) {
/// println!("Revoked: {:?}", partitions);
/// // Commit offsets before losing partitions
/// }
/// }
/// ```
///
/// # See also
///
/// [`AsyncConsumerRebalanceListener`] — the async variant of this trait.
/// Prefer it when rebalance callbacks need to await async operations
/// (e.g., offset commits, cache flushes) without blocking a Tokio worker.
pub trait ConsumerRebalanceListener: Send + Sync {
/// Called after partitions have been assigned to this consumer.
///
/// The `partitions` slice contains the **newly added** partitions for this
/// rebalance round. The semantics match the Java client:
///
/// | Rebalance protocol | `partitions` contains |
/// |---|---|
/// | Initial join (first poll after subscribe) | all assigned partitions |
/// | Eager rebalance (classic protocol) | all assigned partitions (entire set is new after revoke-all) |
/// | Cooperative rebalance (KIP-429) | **only newly added** partitions (delta vs previous round) |
/// | KIP-848 / new consumer protocol | **only newly added** partitions (diff-based) |
///
/// For the cooperative and KIP-848 paths the slice may be empty if
/// the rebalance left this consumer's assignment unchanged. To obtain
/// the **full** post-rebalance assignment call
/// [`crate::consumer::Consumer::assignment`]
/// from inside the callback.
///
/// **Must complete synchronously** — see the [trait-level docs](ConsumerRebalanceListener)
/// for the execution contract.
fn on_partitions_assigned(&self, partitions: &[crate::consumer::TopicPartition]);
/// Called before partitions are revoked from this consumer.
///
/// This is triggered during a rebalance before the consumer loses
/// its current partitions. Use this to commit offsets synchronously
/// if needed.
///
/// **Must complete synchronously** — see the [trait-level docs](ConsumerRebalanceListener)
/// for the execution contract.
fn on_partitions_revoked(&self, partitions: &[crate::consumer::TopicPartition]);
/// Called when partitions are lost due to an unclean shutdown.
///
/// This is called when the consumer unexpectedly loses its partition
/// assignment (e.g., session timeout). Unlike `on_partitions_revoked`,
/// **the consumer has likely already been fenced** and another consumer
/// may have taken ownership of these partitions. Committing offsets here
/// may silently overwrite offsets already committed by the new owner.
///
/// **Do not commit offsets** inside `on_partitions_lost`. The default
/// implementation is a no-op for this reason. Override it to add
/// loss-specific cleanup logic (e.g., invalidating local caches).
///
/// **Must complete synchronously** — see the [trait-level docs](ConsumerRebalanceListener)
/// for the execution contract.
fn on_partitions_lost(&self, _partitions: &[crate::consumer::TopicPartition]) {
// Default: no-op.
//
// Deliberately does NOT call `on_partitions_revoked`. Lost partitions
// mean the coordinator has already fenced this consumer; any offset
// commit at this point will either fail with `UNKNOWN_MEMBER_ID` /
// `ILLEGAL_GENERATION` or silently overwrite offsets committed by the
// new partition owner. Implementations that need loss-specific cleanup
// should override this method directly.
}
}
/// A no-op rebalance listener that does nothing on rebalance events.
#[derive(Debug, Clone, Copy, Default)]
pub struct NoOpRebalanceListener;
impl ConsumerRebalanceListener for NoOpRebalanceListener {
fn on_partitions_assigned(&self, _partitions: &[crate::consumer::TopicPartition]) {}
fn on_partitions_revoked(&self, _partitions: &[crate::consumer::TopicPartition]) {}
}
/// Async variant of [`ConsumerRebalanceListener`].
///
/// Implementations may perform async I/O (offset commits, cache flushes, …)
/// directly inside the callbacks without blocking a thread.
///
/// A blanket implementation is provided for every `T: ConsumerRebalanceListener`,
/// so existing sync listeners work wherever an `AsyncConsumerRebalanceListener`
/// is expected.
///
/// # Example
///
/// ```ignore
/// use krafka::consumer::{AsyncConsumerRebalanceListener, TopicPartition};
///
/// struct FlushingListener;
///
/// impl AsyncConsumerRebalanceListener for FlushingListener {
/// async fn on_partitions_assigned(&self, partitions: &[TopicPartition]) { /* … */ }
/// async fn on_partitions_revoked(&self, partitions: &[TopicPartition]) { /* flush */ }
/// async fn on_partitions_lost(&self, partitions: &[TopicPartition]) { /* … */ }
/// }
/// ```
pub trait AsyncConsumerRebalanceListener: Send + Sync {
/// Called after partitions have been assigned to this consumer.
///
/// Contains only **newly added** partitions for cooperative and KIP-848 rebalances.
/// See [`ConsumerRebalanceListener::on_partitions_assigned`] for full semantics.
fn on_partitions_assigned(
&self,
partitions: &[crate::consumer::TopicPartition],
) -> impl std::future::Future<Output = ()> + Send;
/// Called before partitions are revoked from this consumer.
fn on_partitions_revoked(
&self,
partitions: &[crate::consumer::TopicPartition],
) -> impl std::future::Future<Output = ()> + Send;
/// Called when partitions are lost due to an unclean shutdown.
///
/// Default implementation is a no-op. **Do not commit offsets** here —
/// the consumer has likely been fenced already.
fn on_partitions_lost(
&self,
_partitions: &[crate::consumer::TopicPartition],
) -> impl std::future::Future<Output = ()> + Send {
std::future::ready(())
}
}
impl<T: ConsumerRebalanceListener> AsyncConsumerRebalanceListener for T {
async fn on_partitions_assigned(&self, partitions: &[crate::consumer::TopicPartition]) {
ConsumerRebalanceListener::on_partitions_assigned(self, partitions);
}
async fn on_partitions_revoked(&self, partitions: &[crate::consumer::TopicPartition]) {
ConsumerRebalanceListener::on_partitions_revoked(self, partitions);
}
async fn on_partitions_lost(&self, partitions: &[crate::consumer::TopicPartition]) {
ConsumerRebalanceListener::on_partitions_lost(self, partitions);
}
}
/// Consumer group state.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum GroupState {
/// Not yet joined.
#[default]
Unjoined,
/// Joining the group.
Joining,
/// Awaiting sync.
AwaitingSync,
/// Stable and consuming.
Stable,
/// Preparing to rebalance.
PreparingRebalance,
/// Leaving the group.
Leaving,
/// Dead.
Dead,
}
impl std::fmt::Display for GroupState {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(match self {
Self::Unjoined => "Unjoined",
Self::Joining => "Joining",
Self::AwaitingSync => "AwaitingSync",
Self::Stable => "Stable",
Self::PreparingRebalance => "PreparingRebalance",
Self::Leaving => "Leaving",
Self::Dead => "Dead",
})
}
}
/// Member assignment in a consumer group.
#[non_exhaustive]
#[derive(Debug, Clone, Default)]
pub struct MemberAssignment {
/// Assigned partitions per topic.
pub partitions: HashMap<String, Vec<PartitionId>>,
}
impl MemberAssignment {
/// Create an empty assignment.
pub fn empty() -> Self {
Self::default()
}
/// Add partitions for a topic.
pub fn add(&mut self, topic: impl Into<String>, partitions: Vec<PartitionId>) {
self.partitions.insert(topic.into(), partitions);
}
/// Get partitions for a topic.
pub fn get(&self, topic: &str) -> Option<&[PartitionId]> {
self.partitions.get(topic).map(|v| v.as_slice())
}
/// Get all assigned topic-partitions.
pub fn all_partitions(&self) -> impl Iterator<Item = (&str, PartitionId)> + '_ {
self.partitions
.iter()
.flat_map(|(topic, partitions)| partitions.iter().map(move |&p| (topic.as_str(), p)))
}
/// Check if empty.
#[inline]
pub fn is_empty(&self) -> bool {
self.partitions.is_empty()
}
}
/// A consumer group member.
#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct GroupMember {
/// Member ID assigned by the coordinator.
pub member_id: String,
/// Client ID.
pub client_id: String,
/// Client host.
pub client_host: String,
/// Member metadata.
pub metadata: Bytes,
/// Member assignment.
pub assignment: Bytes,
}
/// Consumer group coordinator.
#[derive(Debug)]
pub struct ConsumerGroup {
/// Group ID.
group_id: String,
/// Member ID (assigned by coordinator).
member_id: Arc<RwLock<Option<String>>>,
/// Generation ID.
generation_id: Arc<RwLock<i32>>,
/// Current state.
state: Arc<RwLock<GroupState>>,
/// Current assignment.
assignment: Arc<RwLock<MemberAssignment>>,
/// Coordinator broker ID.
coordinator_id: Arc<RwLock<Option<i32>>>,
/// Session timeout.
session_timeout: Duration,
/// Heartbeat interval.
heartbeat_interval: Duration,
/// Rebalance timeout.
rebalance_timeout: Duration,
}
impl ConsumerGroup {
/// Create a new consumer group.
pub fn new(
group_id: impl Into<String>,
session_timeout: Duration,
heartbeat_interval: Duration,
) -> Self {
Self {
group_id: group_id.into(),
member_id: Arc::new(RwLock::new(None)),
generation_id: Arc::new(RwLock::new(-1)),
state: Arc::new(RwLock::new(GroupState::Unjoined)),
assignment: Arc::new(RwLock::new(MemberAssignment::empty())),
coordinator_id: Arc::new(RwLock::new(None)),
session_timeout,
heartbeat_interval,
rebalance_timeout: session_timeout,
}
}
/// Get the group ID.
pub fn group_id(&self) -> &str {
&self.group_id
}
/// Get the session timeout.
pub fn session_timeout(&self) -> Duration {
self.session_timeout
}
/// Get the heartbeat interval.
pub fn heartbeat_interval(&self) -> Duration {
self.heartbeat_interval
}
/// Get the rebalance timeout.
pub fn rebalance_timeout(&self) -> Duration {
self.rebalance_timeout
}
/// Get the current state.
pub async fn state(&self) -> GroupState {
*self.state.read().await
}
/// Get the member ID.
pub async fn member_id(&self) -> Option<String> {
self.member_id.read().await.clone()
}
/// Get the generation ID.
pub async fn generation_id(&self) -> i32 {
*self.generation_id.read().await
}
/// Get the current assignment.
pub async fn assignment(&self) -> MemberAssignment {
self.assignment.read().await.clone()
}
/// Get the coordinator broker ID.
pub async fn coordinator_id(&self) -> Option<i32> {
*self.coordinator_id.read().await
}
/// Set the coordinator broker ID.
pub async fn set_coordinator(&self, broker_id: i32) {
*self.coordinator_id.write().await = Some(broker_id);
}
/// Set the state.
pub async fn set_state(&self, state: GroupState) {
*self.state.write().await = state;
}
/// Update member ID and generation after joining.
pub async fn join_complete(&self, member_id: String, generation_id: i32) {
*self.member_id.write().await = Some(member_id);
*self.generation_id.write().await = generation_id;
}
/// Update assignment after sync.
pub async fn sync_complete(&self, assignment: MemberAssignment) {
*self.assignment.write().await = assignment;
*self.state.write().await = GroupState::Stable;
}
/// Reset group state on error or leave.
pub async fn reset(&self) {
*self.member_id.write().await = None;
*self.generation_id.write().await = -1;
*self.state.write().await = GroupState::Unjoined;
*self.assignment.write().await = MemberAssignment::empty();
}
/// Check if a rebalance is needed.
pub async fn needs_rejoin(&self) -> bool {
matches!(
*self.state.read().await,
GroupState::Unjoined | GroupState::PreparingRebalance
)
}
/// Validate we're in a valid state to commit.
pub async fn validate_for_commit(&self) -> Result<()> {
let state = *self.state.read().await;
match state {
GroupState::Stable => Ok(()),
GroupState::Unjoined => Err(KrafkaError::invalid_state(
"cannot commit: not part of a group",
)),
GroupState::PreparingRebalance | GroupState::AwaitingSync => Err(
KrafkaError::invalid_state("cannot commit: rebalance in progress"),
),
_ => Err(KrafkaError::invalid_state(format!(
"cannot commit in state: {state:?}",
))),
}
}
}
/// Partition assignment strategy.
pub trait PartitionAssignor: Send + Sync {
/// Strategy name.
fn name(&self) -> &str;
/// Assign partitions to members.
fn assign(
&self,
topics: &[String],
partitions: &HashMap<String, Vec<PartitionId>>,
members: &[GroupMember],
) -> HashMap<String, MemberAssignment>;
}
/// Range partition assignor (default).
#[derive(Debug, Default)]
pub struct RangeAssignor;
impl PartitionAssignor for RangeAssignor {
fn name(&self) -> &str {
"range"
}
fn assign(
&self,
topics: &[String],
partitions: &HashMap<String, Vec<PartitionId>>,
members: &[GroupMember],
) -> HashMap<String, MemberAssignment> {
let mut assignments: HashMap<String, MemberAssignment> = HashMap::new();
// Initialize assignments for all members
for member in members {
assignments.insert(member.member_id.clone(), MemberAssignment::empty());
}
// Assign partitions for each topic
for topic in topics {
if let Some(topic_partitions) = partitions.get(topic) {
let mut sorted_partitions = topic_partitions.clone();
sorted_partitions.sort();
let num_partitions = sorted_partitions.len();
let num_members = members.len();
if num_members == 0 {
continue;
}
let partitions_per_member = num_partitions / num_members;
let extra = num_partitions % num_members;
let mut partition_idx = 0;
for (member_idx, member) in members.iter().enumerate() {
let count = partitions_per_member + if member_idx < extra { 1 } else { 0 };
let member_partitions: Vec<PartitionId> =
sorted_partitions[partition_idx..partition_idx + count].to_vec();
partition_idx += count;
if !member_partitions.is_empty()
&& let Some(assignment) = assignments.get_mut(&member.member_id)
{
assignment.add(topic.clone(), member_partitions);
}
}
}
}
assignments
}
}
/// Round-robin partition assignor.
#[derive(Debug, Default)]
pub struct RoundRobinAssignor;
impl PartitionAssignor for RoundRobinAssignor {
fn name(&self) -> &str {
"roundrobin"
}
fn assign(
&self,
topics: &[String],
partitions: &HashMap<String, Vec<PartitionId>>,
members: &[GroupMember],
) -> HashMap<String, MemberAssignment> {
let mut assignments: HashMap<String, MemberAssignment> = HashMap::new();
// Initialize assignments for all members
for member in members {
assignments.insert(member.member_id.clone(), MemberAssignment::empty());
}
if members.is_empty() {
return assignments;
}
// Collect all topic-partitions
let mut all_partitions: Vec<(String, PartitionId)> = Vec::new();
for topic in topics {
if let Some(topic_partitions) = partitions.get(topic) {
for &partition in topic_partitions {
all_partitions.push((topic.clone(), partition));
}
}
}
// Sort by topic then partition
all_partitions.sort();
// Track partitions per topic per member
let mut member_topic_partitions: HashMap<String, HashMap<String, Vec<PartitionId>>> =
HashMap::new();
for member in members {
member_topic_partitions.insert(member.member_id.clone(), HashMap::new());
}
// Round-robin assign
for (idx, (topic, partition)) in all_partitions.into_iter().enumerate() {
let member = &members[idx % members.len()];
let Some(member_topics) = member_topic_partitions.get_mut(&member.member_id) else {
unreachable!("member must exist in pre-populated map");
};
member_topics.entry(topic).or_default().push(partition);
}
// Build final assignments
for (member_id, topic_partitions) in member_topic_partitions {
let mut assignment = MemberAssignment::empty();
for (topic, partitions) in topic_partitions {
assignment.add(topic, partitions);
}
assignments.insert(member_id, assignment);
}
assignments
}
}
/// Cooperative sticky partition assignor.
///
/// This assignor implements the cooperative rebalance protocol which minimizes
/// partition movement during rebalances. It maintains "stickiness" by trying to
/// keep partitions with their current owners while ensuring fair distribution.
///
/// Key features:
/// - Minimizes partition movement during rebalances
/// - Maintains balanced partition distribution
/// - Supports incremental cooperative rebalancing
///
/// # Example
///
/// ```
/// use krafka::consumer::{CooperativeStickyAssignor, PartitionAssignor};
///
/// let assignor = CooperativeStickyAssignor::new();
/// assert_eq!(assignor.name(), "cooperative-sticky");
/// ```
#[derive(Debug, Default)]
pub struct CooperativeStickyAssignor {
/// Previous assignments for stickiness (member_id -> (topic, partitions))
previous_assignments: parking_lot::RwLock<HashMap<String, HashMap<String, Vec<PartitionId>>>>,
}
impl CooperativeStickyAssignor {
/// Create a new cooperative sticky assignor.
pub fn new() -> Self {
Self::default()
}
/// Record the current assignments for future stickiness.
pub fn record_assignment(&self, member_id: &str, assignment: &MemberAssignment) {
let mut prev = self.previous_assignments.write();
prev.insert(member_id.to_string(), assignment.partitions.clone());
}
/// Clear previous assignment for a member that left.
pub fn clear_member(&self, member_id: &str) {
self.previous_assignments.write().remove(member_id);
}
/// Retain only the given member IDs, removing stale entries.
pub(crate) fn retain_members(&self, member_ids: &HashSet<&str>) {
self.previous_assignments
.write()
.retain(|k, _| member_ids.contains(k.as_str()));
}
/// Get partitions that should be revoked (for incremental rebalance).
pub fn get_partitions_to_revoke(
&self,
member_id: &str,
new_assignment: &MemberAssignment,
) -> Vec<(String, PartitionId)> {
let prev = self.previous_assignments.read();
let mut revoked = Vec::new();
if let Some(old_partitions) = prev.get(member_id) {
for (topic, old_parts) in old_partitions {
let new_parts = new_assignment.get(topic).unwrap_or(&[]);
for &old_part in old_parts {
if !new_parts.contains(&old_part) {
revoked.push((topic.clone(), old_part));
}
}
}
}
revoked
}
}
impl PartitionAssignor for CooperativeStickyAssignor {
fn name(&self) -> &str {
"cooperative-sticky"
}
fn assign(
&self,
topics: &[String],
partitions: &HashMap<String, Vec<PartitionId>>,
members: &[GroupMember],
) -> HashMap<String, MemberAssignment> {
let mut assignments: HashMap<String, MemberAssignment> = HashMap::new();
// Initialize assignments for all members
for member in members {
assignments.insert(member.member_id.clone(), MemberAssignment::empty());
}
if members.is_empty() {
return assignments;
}
// Collect all topic-partitions
let mut all_partitions: Vec<(String, PartitionId)> = Vec::new();
for topic in topics {
if let Some(topic_partitions) = partitions.get(topic) {
for &partition in topic_partitions {
all_partitions.push((topic.clone(), partition));
}
}
}
// Get previous assignments for stickiness.
let prev_guard = self.previous_assignments.read();
let prev_assignments = &*prev_guard;
// Track which partitions are already assigned (sticky)
let mut sticky_assignments: HashMap<(String, PartitionId), String> = HashMap::new();
let mut member_partition_counts: HashMap<String, usize> = HashMap::new();
// First pass: honor previous assignments (stickiness)
for member in members {
let mid = member.member_id.clone();
member_partition_counts.entry(mid.clone()).or_insert(0);
if let Some(prev) = prev_assignments.get(&member.member_id) {
for (topic, prev_parts) in prev {
// Only keep partitions that are still available
if let Some(available_parts) = partitions.get(topic) {
for &part in prev_parts {
if available_parts.contains(&part) {
let key = (topic.clone(), part);
if let std::collections::hash_map::Entry::Vacant(e) =
sticky_assignments.entry(key)
{
e.insert(mid.clone());
*member_partition_counts.entry(mid.clone()).or_insert(0) += 1;
}
}
}
}
}
}
}
// Calculate target partitions per member for balance
let total_partitions = all_partitions.len();
let num_members = members.len();
let min_per_member = total_partitions / num_members;
let extra = total_partitions % num_members;
// Second pass: assign unassigned partitions while maintaining balance
for (topic, partition) in &all_partitions {
let key = (topic.clone(), *partition);
if sticky_assignments.contains_key(&key) {
continue; // Already assigned via stickiness
}
// Find member with fewest partitions that needs more
let mut best_member: Option<&str> = None;
let mut min_count = usize::MAX;
for (idx, member) in members.iter().enumerate() {
let target = min_per_member + if idx < extra { 1 } else { 0 };
let current = *member_partition_counts.get(&member.member_id).unwrap_or(&0);
if current < target && current < min_count {
min_count = current;
best_member = Some(&member.member_id);
}
}
// If everyone is at target, find anyone below max
if best_member.is_none() {
for member in members {
let current = *member_partition_counts.get(&member.member_id).unwrap_or(&0);
if current < min_count {
min_count = current;
best_member = Some(&member.member_id);
}
}
}
if let Some(member_id) = best_member {
let member_id = member_id.to_string();
*member_partition_counts
.entry(member_id.clone())
.or_insert(0) += 1;
sticky_assignments.insert(key, member_id);
}
}
// Third pass: rebalance if needed (steal from overloaded members)
// This ensures no member has more than ceil(total/members) partitions
let max_per_member = total_partitions.div_ceil(num_members);
loop {
let mut moved = false;
// Find overloaded and underloaded members
let mut overloaded: Vec<String> = Vec::new();
let mut underloaded: Vec<String> = Vec::new();
for member in members {
let count = *member_partition_counts.get(&member.member_id).unwrap_or(&0);
if count > max_per_member {
overloaded.push(member.member_id.clone());
} else if count < max_per_member {
// use max_per_member (ceil) as the underloaded threshold.
// Using min_per_member (floor) left members that could accept more
// partitions undetected, causing unbalanced 3-1-1 distributions
// instead of balanced 2-2-1.
underloaded.push(member.member_id.clone());
}
}
if overloaded.is_empty() || underloaded.is_empty() {
break;
}
// Move one partition from overloaded to underloaded
'outer: for over_member in &overloaded {
for under_member in &underloaded {
// Find a partition to move
for (_key, owner) in sticky_assignments.iter_mut() {
if owner == over_member {
*owner = under_member.clone();
if let Some(count) = member_partition_counts.get_mut(over_member) {
*count = count.saturating_sub(1);
}
*member_partition_counts
.entry(under_member.clone())
.or_insert(0) += 1;
moved = true;
break 'outer;
}
}
}
}
if !moved {
break;
}
}
// Build final assignments from sticky_assignments
for ((topic, partition), member_id) in sticky_assignments {
if let Some(assignment) = assignments.get_mut(&member_id) {
assignment
.partitions
.entry(topic)
.or_default()
.push(partition);
}
}
// Sort partitions within each topic for consistency
for assignment in assignments.values_mut() {
for parts in assignment.partitions.values_mut() {
parts.sort();
}
}
assignments
}
}
/// Controller for managing periodic heartbeat tasks.
///
/// The heartbeat controller sends heartbeats at a configurable interval
/// to keep the consumer alive in its group. It tracks the last heartbeat
/// time and can detect session timeouts.
#[derive(Debug)]
pub struct HeartbeatController {
/// Heartbeat interval.
interval: Duration,
/// Session timeout.
session_timeout: Duration,
/// Last successful heartbeat time (nanos-level precision, sync access).
last_heartbeat: Arc<parking_lot::Mutex<Option<std::time::Instant>>>,
/// Whether the controller is running.
running: Arc<std::sync::atomic::AtomicBool>,
/// Whether a rebalance has been detected by the heartbeat task.
rebalance_needed: Arc<std::sync::atomic::AtomicBool>,
/// Whether the member session has been invalidated by a heartbeat error
/// (UNKNOWN_MEMBER_ID, ILLEGAL_GENERATION, SESSION_TIMEOUT).
/// When set, needs_rejoin() will clear member_id and generation_id
/// in addition to triggering a rebalance.
member_invalidated: Arc<std::sync::atomic::AtomicBool>,
}
impl HeartbeatController {
/// Create a new heartbeat controller.
pub fn new(interval: Duration, session_timeout: Duration) -> Self {
Self {
interval,
session_timeout,
last_heartbeat: Arc::new(parking_lot::Mutex::new(None)),
running: Arc::new(std::sync::atomic::AtomicBool::new(false)),
rebalance_needed: Arc::new(std::sync::atomic::AtomicBool::new(false)),
member_invalidated: Arc::new(std::sync::atomic::AtomicBool::new(false)),
}
}
/// Get the heartbeat interval.
#[inline]
pub fn interval(&self) -> Duration {
self.interval
}
/// Get the session timeout.
#[inline]
pub fn session_timeout(&self) -> Duration {
self.session_timeout
}
/// Check if the controller is running.
#[inline]
pub fn is_running(&self) -> bool {
self.running.load(std::sync::atomic::Ordering::Acquire)
}
/// Start the heartbeat controller.
pub fn start(&self) {
self.running
.store(true, std::sync::atomic::Ordering::Release);
}
/// Stop the heartbeat controller.
pub fn stop(&self) {
self.running
.store(false, std::sync::atomic::Ordering::Release);
}
/// Signal that a rebalance is needed (called from heartbeat task).
pub fn signal_rebalance(&self) {
self.rebalance_needed
.store(true, std::sync::atomic::Ordering::Release);
}
/// Check and clear the rebalance-needed flag.
pub fn take_rebalance_needed(&self) -> bool {
self.rebalance_needed
.swap(false, std::sync::atomic::Ordering::AcqRel)
}
/// Signal that the member session has been invalidated
/// (UNKNOWN_MEMBER_ID, ILLEGAL_GENERATION, or session timeout).
/// Also sets the rebalance_needed flag.
pub fn signal_member_invalidated(&self) {
self.member_invalidated
.store(true, std::sync::atomic::Ordering::Release);
self.rebalance_needed
.store(true, std::sync::atomic::Ordering::Release);
}
/// Check and clear the member-invalidated flag.
pub fn take_member_invalidated(&self) -> bool {
self.member_invalidated
.swap(false, std::sync::atomic::Ordering::AcqRel)
}
/// Record a successful heartbeat.
pub fn heartbeat_success(&self) {
*self.last_heartbeat.lock() = Some(std::time::Instant::now());
}
/// Get the time since the last heartbeat.
pub fn time_since_last_heartbeat(&self) -> Option<Duration> {
(*self.last_heartbeat.lock()).map(|t| t.elapsed())
}
/// Check if the session may have timed out.
pub fn may_have_timed_out(&self) -> bool {
self.time_since_last_heartbeat()
.is_some_and(|elapsed| elapsed > self.session_timeout)
}
/// Wait for the next heartbeat interval.
///
/// This is a convenience method for use in heartbeat loops.
pub async fn wait_for_next_interval(&self) {
tokio::time::sleep(self.interval).await;
}
}
/// Heartbeat response status from the coordinator.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum HeartbeatStatus {
/// Heartbeat accepted, continue normally.
Ok,
/// Rebalance in progress, rejoin required.
RebalanceNeeded,
/// Unknown member, rejoin required.
UnknownMember,
/// Illegal generation, rejoin required.
IllegalGeneration,
/// Session timed out, rejoin required.
SessionTimeout,
/// Fatal error, leave group.
FatalError,
}
impl HeartbeatStatus {
/// Whether a rejoin is required based on this status.
#[inline]
pub fn requires_rejoin(&self) -> bool {
matches!(
self,
Self::RebalanceNeeded
| Self::UnknownMember
| Self::IllegalGeneration
| Self::SessionTimeout
)
}
/// Whether this is a fatal error requiring group leave.
#[inline]
pub fn is_fatal(&self) -> bool {
matches!(self, Self::FatalError)
}
/// Whether this status indicates the member session has been invalidated
/// (as opposed to a simple rebalance-in-progress).
#[inline]
pub fn is_session_invalidating(&self) -> bool {
matches!(
self,
Self::UnknownMember | Self::IllegalGeneration | Self::SessionTimeout
)
}
/// Convert from an ErrorCode.
pub fn from_error_code(code: ErrorCode) -> Self {
match code {
ErrorCode::None => Self::Ok,
ErrorCode::RebalanceInProgress => Self::RebalanceNeeded,
ErrorCode::UnknownMemberId => Self::UnknownMember,
ErrorCode::IllegalGeneration => Self::IllegalGeneration,
ErrorCode::CoordinatorNotAvailable
| ErrorCode::NotCoordinator
| ErrorCode::CoordinatorLoadInProgress => Self::SessionTimeout,
_ => Self::FatalError,
}
}
}
// ============================================================================
// Group Coordinator
// ============================================================================
/// Commands for the heartbeat background task.
#[derive(Debug)]
#[non_exhaustive]
pub enum HeartbeatCommand {
/// Stop the heartbeat task.
Stop,
/// Trigger a rejoin.
Rejoin,
/// Send an immediate heartbeat with current owned partitions to
/// acknowledge a revocation (KIP-848 §revocation-ack).
AcknowledgeRevocation,
}
/// Group coordinator that manages group membership, heartbeats, and offset commits.
///
/// This struct encapsulates all the logic for consumer group protocol:
/// - Finding the group coordinator broker
/// - Joining and syncing with the group
/// - Sending periodic heartbeats in a background task
/// - Committing offsets to the coordinator
///
/// # Example
///
/// ```rust,ignore
/// use krafka::consumer::GroupCoordinator;
///
/// let coordinator = GroupCoordinator::new(
/// group_id,
/// pool,
/// metadata,
/// session_timeout,
/// heartbeat_interval,
/// rebalance_timeout,
/// );
///
/// // Find coordinator and join group
/// let topics = vec!["topic1".to_string()];
/// let (assignment, joined) = coordinator.ensure_active_membership(&topics).await?;
///
/// // Commit offsets
/// coordinator.commit_offsets(&offsets).await?;
/// ```
/// Rebalance-coordinated state for the group.
///
/// All four fields are updated atomically so readers can never observe a
/// mismatched generation: `state == Stable` with an empty `assignment`, or
/// `generation_id` from one epoch with `member_id` from another.
#[derive(Debug)]
struct GroupInner {
/// Member ID assigned by the coordinator. Empty string before join.
member_id: String,
/// Generation ID (-1 before first join).
generation_id: i32,
/// Current group state.
state: GroupState,
/// Current partition assignment.
assignment: MemberAssignment,
}
impl GroupInner {
fn initial() -> Self {
Self {
member_id: String::new(),
generation_id: -1,
state: GroupState::Unjoined,
assignment: MemberAssignment::empty(),
}
}
}
/// Manages the consumer group lifecycle: join, sync, heartbeat, and leave.
///
/// Communicates with the group coordinator broker via the Kafka group management
/// protocol (KIP-848 new consumer protocol when supported, classic protocol as
/// fallback). Drives membership, partition assignment, and offset commit/fetch
/// on behalf of a [`Consumer`](super::Consumer).
pub struct GroupCoordinator {
/// Group ID.
group_id: String,
/// Connection pool.
pool: Arc<ConnectionPool>,
/// Cluster metadata.
metadata: Arc<ClusterMetadata>,
/// Session timeout.
session_timeout: Duration,
/// Heartbeat interval.
heartbeat_interval: Duration,
/// Rebalance timeout.
rebalance_timeout: Duration,
/// Coordinator connection.
coordinator_conn: Arc<RwLock<Option<Arc<BrokerConnection>>>>,
/// Coordinator node ID.
coordinator_id: RwLock<Option<i32>>,
/// Rebalance-coordinated state (member_id, generation_id, state, assignment)
/// consolidated under a single lock for atomic updates across rebalances.
inner: Arc<RwLock<GroupInner>>,
/// Heartbeat controller.
heartbeat_controller: Arc<HeartbeatController>,
/// Channel to control heartbeat task.
heartbeat_cmd_tx: RwLock<Option<mpsc::Sender<HeartbeatCommand>>>,
/// Subscribed topics.
subscribed_topics: RwLock<Vec<String>>,
/// Protocol type (always "consumer").
protocol_type: String,
/// Partition assignment strategy.
assignment_strategy: crate::consumer::config::PartitionAssignmentStrategy,
/// Partition assignor name.
assignor_name: String,
/// Static group membership instance ID (KIP-345).
group_instance_id: Option<String>,
/// Client rack ID for closest-replica fetching and server-side rack-aware
/// assignment (KIP-392 / KIP-848). Sent in every ConsumerGroupHeartbeat
/// request so the coordinator can place the member on a rack-local replica.
client_rack: Option<String>,
/// Persistent sticky assignor (retains previous assignments across rebalances).
sticky_assignor: CooperativeStickyAssignor,
/// Transaction isolation level (0 = read_uncommitted, 1 = read_committed).
isolation_level: i8,
/// Group protocol selection (KIP-848).
group_protocol: crate::consumer::config::GroupProtocol,
/// Member epoch for the KIP-848 consumer protocol.
///
/// Replaces `generation_id` semantics: 0 = join, -1 = leave,
/// -2 = static member temporary leave.
member_epoch: Arc<RwLock<i32>>,
/// Raw target assignment received from the KIP-848 coordinator (topic UUIDs
/// and partition lists). Stored so that unresolved UUIDs can be re-resolved
/// on the next metadata refresh instead of being permanently lost.
target_assignment: Arc<RwLock<Vec<ConsumerGroupTopicPartitions>>>,
/// Local cache of topic UUID → name mappings discovered during assignment
/// resolution. Serves as a fallback when the metadata cache is flushed
/// (e.g. during a full refresh). Mirrors the Java client's
/// `assignedTopicNamesCache`. Cleared on leave/reset/fencing.
topic_names_cache: Arc<RwLock<HashMap<[u8; 16], String>>>,
}
impl GroupCoordinator {
/// Create a new group coordinator.
pub fn new(
group_id: impl Into<String>,
pool: Arc<ConnectionPool>,
metadata: Arc<ClusterMetadata>,
session_timeout: Duration,
heartbeat_interval: Duration,
rebalance_timeout: Duration,
) -> Self {
Self {
group_id: group_id.into(),
pool,
metadata,
session_timeout,
heartbeat_interval,
rebalance_timeout,
coordinator_conn: Arc::new(RwLock::new(None)),
coordinator_id: RwLock::new(None),
inner: Arc::new(RwLock::new(GroupInner::initial())),
heartbeat_controller: Arc::new(HeartbeatController::new(
heartbeat_interval,
session_timeout,
)),
heartbeat_cmd_tx: RwLock::new(None),
subscribed_topics: RwLock::new(Vec::new()),
protocol_type: "consumer".to_string(),
assignment_strategy: crate::consumer::config::PartitionAssignmentStrategy::Range,
assignor_name: "range".to_string(),
group_instance_id: None,
client_rack: None,
sticky_assignor: CooperativeStickyAssignor::new(),
isolation_level: 0,
group_protocol: crate::consumer::config::GroupProtocol::Classic,
member_epoch: Arc::new(RwLock::new(0)),
target_assignment: Arc::new(RwLock::new(Vec::new())),
topic_names_cache: Arc::new(RwLock::new(HashMap::new())),
}
}
/// Set the partition assignment strategy (builder pattern).
pub fn with_assignor_strategy(
mut self,
strategy: crate::consumer::config::PartitionAssignmentStrategy,
) -> Self {
self.assignor_name = strategy.protocol_name().to_string();
self.assignment_strategy = strategy;
self
}
/// Set the static group membership instance ID (KIP-345, builder pattern).
pub fn with_group_instance_id(mut self, id: Option<String>) -> Self {
self.group_instance_id = id;
self
}
/// Set the client rack ID for KIP-392 rack-aware assignment (builder pattern).
///
/// When set, the value is sent in every `ConsumerGroupHeartbeat` request
/// so that the KIP-848 coordinator can place the member on a rack-local
/// replica, reducing cross-rack traffic in multi-AZ deployments.
pub fn with_client_rack(mut self, rack: Option<String>) -> Self {
self.client_rack = rack;
self
}
/// Set the transaction isolation level (builder pattern).
pub fn with_isolation_level(mut self, level: i8) -> Self {
self.isolation_level = level;
self
}
/// Set the group protocol (KIP-848, builder pattern).
pub fn with_group_protocol(mut self, protocol: crate::consumer::config::GroupProtocol) -> Self {
self.group_protocol = protocol;
self
}
/// Whether the current assignment strategy is cooperative.
///
/// Always returns `false` for the KIP-848 consumer protocol, which uses
/// server-side assignment and does not use JoinGroup/SyncGroup semantics.
pub fn is_cooperative(&self) -> bool {
!self.is_consumer_protocol()
&& self.assignment_strategy
== crate::consumer::config::PartitionAssignmentStrategy::CooperativeSticky
}
/// Whether the consumer uses the KIP-848 consumer group protocol.
pub fn is_consumer_protocol(&self) -> bool {
self.group_protocol == crate::consumer::config::GroupProtocol::Consumer
}
/// Get the group ID.
pub fn group_id(&self) -> &str {
&self.group_id
}
/// Get the current state.
pub async fn state(&self) -> GroupState {
self.inner.read().await.state
}
/// Get the member ID.
pub async fn member_id(&self) -> String {
self.inner.read().await.member_id.clone()
}
/// Get the generation ID.
pub async fn generation_id(&self) -> i32 {
self.inner.read().await.generation_id
}
/// Get the current assignment.
pub async fn assignment(&self) -> MemberAssignment {
self.inner.read().await.assignment.clone()
}
/// Get the current subscribed topics.
pub async fn subscribed_topics(&self) -> Vec<String> {
self.subscribed_topics.read().await.clone()
}
/// Set the subscribed topics.
pub async fn set_subscribed_topics(&self, topics: Vec<String>) {
*self.subscribed_topics.write().await = topics;
}
/// Check if the group needs to rejoin.
pub async fn needs_rejoin(&self) -> bool {
// Check heartbeat controller's rebalance flag first (immediate detection from R8.3)
if self.heartbeat_controller.take_rebalance_needed() {
// If the heartbeat detected a session-invalidating error
// (UNKNOWN_MEMBER_ID, ILLEGAL_GENERATION, session timeout),
// clear the member identity so the next join_group() sends
// a fresh empty member_id. This must happen here (not in
// the heartbeat task) because we need access to sticky_assignor.
if self.heartbeat_controller.take_member_invalidated() {
if self.is_consumer_protocol() {
// KIP-848: preserve member_id — spec requires fenced
// members to "rejoin with the same member id and
// epoch 0". Reset epoch and assignment state but
// keep the member identity for re-registration.
self.reset_for_kip848_fencing().await;
return true;
}
self.reset_member_identity().await;
}
// For KIP-848: the heartbeat task signals rebalance when a new
// assignment arrives and sets the state to Stable. Don't
// downgrade Stable → PreparingRebalance — the consumer just
// needs to process the assignment diff without re-joining.
if !(self.is_consumer_protocol()
&& matches!(self.inner.read().await.state, GroupState::Stable))
{
self.inner.write().await.state = GroupState::PreparingRebalance;
}
return true;
}
matches!(
self.inner.read().await.state,
GroupState::Unjoined | GroupState::PreparingRebalance
)
}
/// Find the group coordinator broker.
pub async fn find_coordinator(&self) -> Result<()> {
debug!("Finding coordinator for group '{}'", self.group_id);
// Get a connection to any broker
let conn = self.get_any_connection().await?;
// Send FindCoordinator request with version negotiation.
// Fall back to v0 when ApiVersions is unavailable — v0 is sufficient
// for group coordinator lookup and compatible with all brokers.
let request = FindCoordinatorRequest::for_group(&self.group_id);
let fc_version = conn
.negotiate_api_version(
ApiKey::FindCoordinator,
FIND_COORDINATOR_MAX,
FIND_COORDINATOR_MIN,
)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support FindCoordinator v{}-v{}",
FIND_COORDINATOR_MIN, FIND_COORDINATOR_MAX,
),
)
})?;
let response = conn
.send_request(ApiKey::FindCoordinator, fc_version, |buf| {
request.encode_versioned(fc_version, buf)
})
.await?;
let mut buf = response;
let find_response = FindCoordinatorResponse::decode_versioned(fc_version, &mut buf)?;
if !find_response.error_code.is_ok() {
return Err(KrafkaError::broker(
find_response.error_code,
format!(
"Failed to find coordinator: {:?}",
find_response.error_message
),
));
}
// Connect to the coordinator
let coordinator_addr = format!("{}:{}", find_response.host, find_response.port);
let coordinator_conn = self.pool.get_connection(&coordinator_addr).await?;
*self.coordinator_conn.write().await = Some(coordinator_conn);
*self.coordinator_id.write().await = Some(find_response.node_id);
info!(
"Found coordinator for group '{}': node {} at {}",
self.group_id, find_response.node_id, coordinator_addr
);
Ok(())
}
/// Get the coordinator connection, finding it if necessary.
/// Checks liveness and SASL session expiry of cached connections and re-discovers if unusable.
async fn get_coordinator_connection(&self) -> Result<Arc<BrokerConnection>> {
{
let conn = self.coordinator_conn.read().await;
if let Some(ref c) = *conn {
if c.is_usable() {
return Ok(c.clone());
}
// Connection is dead or SASL session expired, clear it and re-discover
drop(conn);
*self.coordinator_conn.write().await = None;
debug!("Coordinator connection is unusable, re-discovering");
}
}
self.find_coordinator().await?;
let conn = self.coordinator_conn.read().await;
conn.clone()
.ok_or_else(|| KrafkaError::invalid_state("coordinator not found"))
}
/// Get any available broker connection.
async fn get_any_connection(&self) -> Result<Arc<BrokerConnection>> {
// Try cached brokers first
let brokers = self.metadata.brokers();
for broker in brokers {
if let Ok(conn) = self.pool.get_connection(broker.address()).await {
return Ok(conn);
}
}
// Fall back to bootstrap servers
for server in &self.metadata.bootstrap_servers() {
if let Ok(conn) = self.pool.get_connection(server).await {
return Ok(conn);
}
}
Err(KrafkaError::invalid_state("no available brokers"))
}
/// Join the consumer group.
pub async fn join_group(&self) -> Result<JoinGroupResponse> {
let conn = self.get_coordinator_connection().await?;
let member_id = self.inner.read().await.member_id.clone();
let topics = self.subscribed_topics.read().await.clone();
let owned_partitions = if self.is_cooperative() {
self.sticky_assignor
.previous_assignments
.read()
.get(&member_id)
.cloned()
.unwrap_or_default()
} else {
HashMap::new()
};
// Build consumer protocol metadata
let metadata = self.encode_consumer_metadata(&topics, &owned_partitions)?;
let request = JoinGroupRequest {
group_id: self.group_id.clone(),
session_timeout_ms: crate::util::duration_to_millis_i32(self.session_timeout),
rebalance_timeout_ms: crate::util::duration_to_millis_i32(self.rebalance_timeout),
member_id: member_id.clone(),
group_instance_id: self.group_instance_id.clone(),
protocol_type: self.protocol_type.clone(),
protocols: vec![JoinGroupRequestProtocol {
name: self.assignor_name.clone(),
metadata: metadata.freeze(),
}],
reason: None,
};
debug!(
"Joining group '{}' with member_id '{}'",
self.group_id, member_id
);
self.inner.write().await.state = GroupState::Joining;
// Negotiate JoinGroup version. Static membership (group_instance_id)
// requires v5+ where the GroupInstanceId field is available.
let join_group_min = if self.group_instance_id.is_some() {
5
} else {
JOIN_GROUP_MIN
};
let jg_version = conn
.negotiate_api_version(ApiKey::JoinGroup, JOIN_GROUP_MAX, join_group_min)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support JoinGroup v{}-v{}",
join_group_min, JOIN_GROUP_MAX,
),
)
})?;
let response = conn
.send_request(ApiKey::JoinGroup, jg_version, |buf| {
request.encode_versioned(jg_version, buf)
})
.await?;
let mut buf = response;
let mut join_response = JoinGroupResponse::decode_versioned(jg_version, &mut buf)?;
// KIP-394 (v4+): broker returns MemberIdRequired with a newly
// assigned member_id. Save the id and retry the JoinGroup request
// exactly once, which is the expected two-step join handshake.
if join_response.error_code == ErrorCode::MemberIdRequired {
debug!(
"Received MemberIdRequired for group '{}', retrying with assigned member_id '{}'",
self.group_id, join_response.member_id
);
// Persist the broker-assigned member_id.
self.inner.write().await.member_id = join_response.member_id.clone();
// Rebuild the request with the assigned member_id.
let retry_request = JoinGroupRequest {
member_id: join_response.member_id.clone(),
..request.clone()
};
let retry_response = conn
.send_request(ApiKey::JoinGroup, jg_version, |buf| {
retry_request.encode_versioned(jg_version, buf)
})
.await?;
let mut retry_buf = retry_response;
join_response = JoinGroupResponse::decode_versioned(jg_version, &mut retry_buf)?;
}
if !join_response.error_code.is_ok() {
// Reset member identity on session-invalidating errors so the
// next rejoin attempt sends an empty member_id (fresh registration)
// instead of the dead one. Matches the Java client's behavior in
// AbstractCoordinator.resetStateOnResponseError().
if join_response.error_code == ErrorCode::UnknownMemberId
|| join_response.error_code == ErrorCode::IllegalGeneration
{
self.reset_member_identity().await;
}
self.inner.write().await.state = GroupState::Unjoined;
return Err(KrafkaError::broker(
join_response.error_code,
"Failed to join group",
));
}
// Update member ID and generation.
// If the broker assigned a different member_id (e.g., first join
// with empty id, or broker-side reassignment), clear the old
// entry from sticky_assignor to prevent unbounded accumulation
// of orphaned previous_assignments keyed by stale member IDs.
{
let old_member_id = self.inner.read().await.member_id.clone();
if !old_member_id.is_empty() && old_member_id != join_response.member_id {
self.sticky_assignor.clear_member(&old_member_id);
}
}
{
let mut inner = self.inner.write().await;
inner.member_id = join_response.member_id.clone();
inner.generation_id = join_response.generation_id;
inner.state = GroupState::AwaitingSync;
}
info!(
"Joined group '{}': member_id='{}', generation={}, is_leader={}",
self.group_id,
join_response.member_id,
join_response.generation_id,
join_response.is_leader()
);
Ok(join_response)
}
/// Sync with the group after joining.
pub async fn sync_group(&self, join_response: &JoinGroupResponse) -> Result<MemberAssignment> {
let conn = self.get_coordinator_connection().await?;
let (member_id, generation_id) = {
let inner = self.inner.read().await;
(inner.member_id.clone(), inner.generation_id)
};
let topics = self.subscribed_topics.read().await.clone();
// If we're the leader, compute assignments
let assignments = if join_response.is_leader() {
self.compute_assignments(&topics, &join_response.members)
.await?
} else {
Vec::new()
};
let request = SyncGroupRequest {
group_id: self.group_id.clone(),
generation_id,
member_id: member_id.clone(),
group_instance_id: self.group_instance_id.clone(),
protocol_type: Some(self.protocol_type.clone()),
protocol_name: join_response.protocol_name.clone(),
assignments,
};
debug!(
"Syncing group '{}': generation={}, is_leader={}",
self.group_id,
generation_id,
join_response.is_leader()
);
// Negotiate SyncGroup version — v3+ required (KIP-345 static membership).
let sg_version = conn
.negotiate_api_version(ApiKey::SyncGroup, SYNC_GROUP_MAX, SYNC_GROUP_MIN)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support SyncGroup v{}-v{}",
SYNC_GROUP_MIN, SYNC_GROUP_MAX,
),
)
})?;
let response = conn
.send_request(ApiKey::SyncGroup, sg_version, |buf| {
request.encode_versioned(sg_version, buf)
})
.await?;
let mut buf = response;
let sync_response = SyncGroupResponse::decode_versioned(sg_version, &mut buf)?;
if !sync_response.error_code.is_ok() {
// Reset member identity on session-invalidating errors.
// After a failed sync with UNKNOWN_MEMBER_ID or ILLEGAL_GENERATION,
// the broker no longer recognizes our member_id + generation_id pair.
// Clearing them ensures the next rejoin sends a fresh empty
// member_id for re-registration.
// REBALANCE_IN_PROGRESS means the session is still valid but the
// group is rebalancing — keep member_id so we can rejoin faster.
if sync_response.error_code == ErrorCode::UnknownMemberId
|| sync_response.error_code == ErrorCode::IllegalGeneration
{
self.reset_member_identity().await;
}
self.inner.write().await.state = GroupState::Unjoined;
return Err(KrafkaError::broker(
sync_response.error_code,
"Failed to sync group",
));
}
// Decode the assignment
let assignment = self.decode_consumer_assignment(&sync_response.assignment)?;
// Note: for cooperative mode, record_assignment() is NOT called here.
// The poll loop defers it until after get_partitions_to_revoke() has
// compared old vs new, so the previous-assignment baseline stays intact.
// Update state
{
let mut inner = self.inner.write().await;
inner.assignment = assignment.clone();
inner.state = GroupState::Stable;
}
info!(
"Synced group '{}': received {} topic assignments",
self.group_id,
assignment.partitions.len()
);
for (topic, partitions) in &assignment.partitions {
debug!(" {} -> {:?}", topic, partitions);
}
Ok(assignment)
}
/// Ensure active group membership, joining/rejoining as needed.
///
/// Returns `(assignment, joined)` where `joined` is `true` when an actual
/// JoinGroup/SyncGroup round-trip occurred (first join or topic change).
/// When the group is already Stable with unchanged topics, returns the
/// cached assignment with `joined = false`.
///
/// For eager (non-cooperative) protocols, performs a single join+sync.
/// For cooperative protocols, the caller should use
/// `perform_cooperative_join_and_sync` instead for the two-phase flow.
pub async fn ensure_active_membership(
&self,
topics: &[String],
) -> Result<(MemberAssignment, bool)> {
// Dispatch based on group protocol
if self.is_consumer_protocol() {
return self.ensure_active_membership_consumer(topics).await;
}
// Classic protocol: JoinGroup/SyncGroup/Heartbeat
// Detect topic changes: if the subscription changed while Stable,
// force a rejoin so the broker learns the new subscription.
let new_topics = topics.to_vec();
{
let state = self.inner.read().await.state;
if state == GroupState::Stable {
let old_topics = self.subscribed_topics.read().await;
let mut old_sorted = old_topics.clone();
drop(old_topics);
old_sorted.sort();
let mut new_sorted = new_topics.clone();
new_sorted.sort();
if old_sorted != new_sorted {
// Topics changed — must rejoin to update broker subscription.
// Use set_preparing_rebalance (not trigger_rejoin) so the
// heartbeat task keeps running while perform_join_and_sync
// does the actual rejoin below.
self.set_preparing_rebalance().await;
}
}
}
// Update subscribed topics
self.set_subscribed_topics(new_topics).await;
let inner = self.inner.read().await;
if inner.state == GroupState::Stable {
// Already stable with same topics, return current assignment
Ok((inner.assignment.clone(), false))
} else {
drop(inner);
// Need to join/rejoin
let assignment = self.perform_join_and_sync().await?;
Ok((assignment, true))
}
}
/// Perform the full join and sync sequence.
async fn perform_join_and_sync(&self) -> Result<MemberAssignment> {
// Find coordinator if needed
if self.coordinator_conn.read().await.is_none() {
self.find_coordinator().await?;
}
// Join group
let join_response = self.join_group().await?;
// Sync group
let assignment = self.sync_group(&join_response).await?;
// Start heartbeat task
self.start_heartbeat_task().await;
Ok(assignment)
}
/// Perform cooperative incremental rebalance (KIP-429).
///
/// Two-phase protocol:
/// 1. Join/sync to get the new target assignment
/// 2. Compute which partitions to revoke (old - new)
/// 3. If revocations are needed, return them so the caller can
/// revoke and then trigger a second rejoin
/// 4. If no revocations, the assignment is final
///
/// Returns `(assignment, partitions_to_revoke)`. If `partitions_to_revoke`
/// is non-empty, the caller must revoke those partitions and call this
/// method again.
pub async fn perform_cooperative_join_and_sync(
&self,
) -> Result<(MemberAssignment, Vec<(String, PartitionId)>)> {
// Find coordinator if needed
if self.coordinator_conn.read().await.is_none() {
self.find_coordinator().await?;
}
// Join group
let join_response = self.join_group().await?;
// Sync group to get new target assignment
let new_assignment = self.sync_group(&join_response).await?;
// Compute what needs to be revoked
let member_id = self.inner.read().await.member_id.clone();
let to_revoke = self
.sticky_assignor
.get_partitions_to_revoke(&member_id, &new_assignment);
if to_revoke.is_empty() {
// No revocations needed — assignment is final
self.start_heartbeat_task().await;
Ok((new_assignment, Vec::new()))
} else {
info!(
"Cooperative rebalance: revoking {} partition(s) before second rejoin",
to_revoke.len()
);
// Don't start heartbeat yet — we need another rejoin after revocation.
// The caller (e.g. the poll loop) will update the owned-partitions baseline
// in sticky_assignor after applying these revocations and finalizing the assignment.
Ok((new_assignment, to_revoke))
}
}
/// Start the background heartbeat task.
pub(crate) async fn start_heartbeat_task(&self) {
// Stop existing task if any
self.stop_heartbeat_task().await;
// Clear any stale rebalance/invalidation signals from the previous
// heartbeat task. Between sending the Stop command and the old task
// terminating, it may have received REBALANCE_IN_PROGRESS or a
// session-invalidating error. Those signals are now stale — we just
// completed a successful join/sync.
self.heartbeat_controller.take_rebalance_needed();
self.heartbeat_controller.take_member_invalidated();
let (cmd_tx, mut cmd_rx) = mpsc::channel::<HeartbeatCommand>(10);
*self.heartbeat_cmd_tx.write().await = Some(cmd_tx);
let group_id = self.group_id.clone();
let heartbeat_interval = self.heartbeat_interval;
let heartbeat_controller = self.heartbeat_controller.clone();
// Clone Arc references so the task reads current values on each heartbeat
let inner_ref = self.inner.clone();
let coordinator_conn_ref = self.coordinator_conn.clone();
let group_instance_id = self.group_instance_id.clone();
// start() before spawn is safe here — the classic task has no early-return
// paths before the loop. KIP-848's task calls start() *inside* spawn after
// version negotiation to avoid marking running=true on negotiation failure.
heartbeat_controller.start();
tokio::spawn(async move {
debug!("Starting heartbeat task for group '{}'", group_id);
let mut interval = tokio::time::interval(heartbeat_interval);
interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
// Cache the negotiated heartbeat version per coordinator connection.
// The version is stable for a given connection (API versions don't
// change until reconnect), so we only re-negotiate when the
// connection identity changes. Storing both fields as a single
// Option ensures they are always set and cleared atomically.
let mut cached_hb: Option<(usize, i16)> = None;
loop {
tokio::select! {
_ = interval.tick() => {
if !heartbeat_controller.is_running() {
break;
}
// Read current values on each heartbeat (not stale copies)
let coordinator_conn = coordinator_conn_ref.read().await.clone();
let inner = inner_ref.read().await;
let member_id = inner.member_id.clone();
let generation_id = inner.generation_id;
drop(inner);
// Send heartbeat
if let Some(ref conn) = coordinator_conn {
// Re-negotiate only when the coordinator connection changes.
let conn_id = std::sync::Arc::as_ptr(conn) as usize;
let hb_version = match cached_hb {
Some((id, v)) if id == conn_id => v,
_ => match conn
.negotiate_api_version(
ApiKey::Heartbeat,
HEARTBEAT_MAX,
HEARTBEAT_MIN,
)
.await
{
Some(v) => {
cached_hb = Some((conn_id, v));
v
}
None => {
warn!(
"Broker does not support Heartbeat v{}-v{} for group '{}', triggering rebalance",
HEARTBEAT_MIN, HEARTBEAT_MAX, group_id
);
*coordinator_conn_ref.write().await = None;
heartbeat_controller.signal_rebalance();
heartbeat_controller.stop();
break;
}
},
};
let request = HeartbeatRequest {
group_id: group_id.clone(),
generation_id,
member_id: member_id.clone(),
group_instance_id: group_instance_id.clone(),
};
let send_result = conn
.send_request(ApiKey::Heartbeat, hb_version, |buf| {
request.encode_versioned(hb_version, buf)
})
.await;
match send_result
{
Ok(response) => {
let mut buf = response;
let decode_result = HeartbeatResponse::decode_versioned(hb_version, &mut buf);
if let Ok(hb_response) = decode_result {
let status = HeartbeatStatus::from_error_code(hb_response.error_code);
match status {
HeartbeatStatus::Ok => {
heartbeat_controller.heartbeat_success();
debug!("Heartbeat successful for group '{}'", group_id);
}
HeartbeatStatus::RebalanceNeeded => {
warn!("Rebalance needed for group '{}', stopping heartbeat", group_id);
heartbeat_controller.signal_rebalance();
heartbeat_controller.stop();
break;
}
status if status.requires_rejoin() => {
warn!("Heartbeat status {:?} requires rejoin for group '{}'", status, group_id);
// This arm only fires for session-invalidating
// errors (UnknownMember, IllegalGeneration,
// SessionTimeout) — RebalanceNeeded is handled
// above. Signal that member identity must be
// cleared. The actual cleanup (sticky_assignor +
// member_id + generation_id) happens in
// needs_rejoin() which has full access to the
// coordinator.
heartbeat_controller.signal_member_invalidated();
heartbeat_controller.stop();
break;
}
HeartbeatStatus::FatalError => {
error!("Fatal heartbeat error for group '{}'", group_id);
heartbeat_controller.stop();
break;
}
_ => {}
}
}
}
Err(e) => {
warn!("Heartbeat failed for group '{}': {}", group_id, e);
// Network error — the coordinator connection
// may be dead. Clear it and exit the heartbeat
// loop so the consumer poll loop can rediscover
// the coordinator and rejoin.
*coordinator_conn_ref.write().await = None;
heartbeat_controller.signal_rebalance();
heartbeat_controller.stop();
break;
}
}
}
}
cmd = cmd_rx.recv() => {
match cmd {
Some(HeartbeatCommand::Stop) | None => {
debug!("Stopping heartbeat task for group '{}'", group_id);
heartbeat_controller.stop();
break;
}
Some(HeartbeatCommand::Rejoin) => {
debug!("Rejoin requested for group '{}'", group_id);
heartbeat_controller.stop();
break;
}
Some(HeartbeatCommand::AcknowledgeRevocation) => {
// Not applicable to the classic protocol — ignore.
}
}
}
}
}
debug!("Heartbeat task ended for group '{}'", group_id);
});
}
/// Stop the background heartbeat task.
pub async fn stop_heartbeat_task(&self) {
let tx = self.heartbeat_cmd_tx.write().await.take();
if let Some(tx) = tx {
let _ = tx.send(HeartbeatCommand::Stop).await;
}
self.heartbeat_controller.stop();
}
/// Trigger a rejoin.
pub async fn trigger_rejoin(&self) {
self.inner.write().await.state = GroupState::PreparingRebalance;
let tx = self.heartbeat_cmd_tx.read().await.clone();
if let Some(tx) = tx {
let _ = tx.send(HeartbeatCommand::Rejoin).await;
}
}
/// Signal the heartbeat task to send an immediate full heartbeat with
/// the current owned partitions, acknowledging a revocation (KIP-848).
pub async fn acknowledge_revocation(&self) {
let tx = self.heartbeat_cmd_tx.read().await.clone();
if let Some(tx) = tx {
let _ = tx.send(HeartbeatCommand::AcknowledgeRevocation).await;
}
}
/// Mark state as PreparingRebalance without stopping the heartbeat task.
/// Used when we want the next poll to re-enter rebalance but need the
/// background heartbeat to keep running (e.g., round-limit deferral).
pub async fn set_preparing_rebalance(&self) {
self.inner.write().await.state = GroupState::PreparingRebalance;
}
/// Record owned partitions in the sticky assignor for the next rebalance.
/// The poll loop calls this after applying revocations or finalizing assignment
/// so that the next join_group metadata reports the correct owned state.
pub fn record_owned_partitions(&self, member_id: &str, assignment: &MemberAssignment) {
self.sticky_assignor
.record_assignment(member_id, assignment);
}
/// Send a KIP-848 ConsumerGroupHeartbeat (API key 68).
///
/// This is the sole membership and assignment API for the new consumer
/// protocol. It replaces JoinGroup + SyncGroup + Heartbeat + LeaveGroup.
///
/// - `member_epoch = 0` → join the group
/// - `member_epoch = -1` → leave the group
/// - `member_epoch = -2` → static member temporary leave
///
/// Returns the decoded response. The caller is responsible for updating
/// local state (member_epoch, assignment, heartbeat interval) from the
/// response.
pub async fn consumer_group_heartbeat(
&self,
subscribed_topic_names: Option<Vec<String>>,
topic_partitions: Option<Vec<ConsumerGroupTopicPartitions>>,
) -> Result<ConsumerGroupHeartbeatResponse> {
let conn = self.get_coordinator_connection().await?;
// KIP-1082 (v1+): member ID must be client-generated. Generate a
// UUID on the first heartbeat and persist it for the member lifetime.
// Use a single write lock to avoid a TOCTOU race where two concurrent
// callers could both see an empty ID and both generate a UUID.
let member_id = {
let mut inner = self.inner.write().await;
if inner.member_id.is_empty() {
inner.member_id = crate::util::random_uuid_v4();
}
inner.member_id.clone()
};
let member_epoch = *self.member_epoch.read().await;
let request = ConsumerGroupHeartbeatRequest {
group_id: self.group_id.clone(),
member_id: member_id.clone(),
member_epoch,
instance_id: self.group_instance_id.clone(),
rack_id: self.client_rack.clone(),
rebalance_timeout_ms: crate::util::duration_to_millis_i32(self.rebalance_timeout),
subscribed_topic_names,
subscribed_topic_regex: None,
server_assignor: None,
topic_partitions,
};
debug!(
"Sending ConsumerGroupHeartbeat for group '{}': member_id='{}', epoch={}",
self.group_id, member_id, member_epoch
);
let Some(hb_version) = conn
.negotiate_api_version(
ApiKey::ConsumerGroupHeartbeat,
CONSUMER_GROUP_HEARTBEAT_MAX,
CONSUMER_GROUP_HEARTBEAT_MIN,
)
.await
else {
return Err(KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
"ConsumerGroupHeartbeat is unsupported by the broker; \
KIP-848/GroupProtocol::Consumer cannot be used on this cluster",
));
};
let response = conn
.send_request(ApiKey::ConsumerGroupHeartbeat, hb_version, |buf| {
request.encode_versioned(hb_version, buf)
})
.await?;
let mut buf = response;
let hb_response = ConsumerGroupHeartbeatResponse::decode_versioned(hb_version, &mut buf)?;
if !hb_response.error_code.is_ok() {
// StaleMemberEpoch: our epoch is behind. The response carries the
// correct epoch — update local state and fall through to the
// normal state-update path so the next heartbeat uses the fresh
// epoch. This is recoverable and should not be surfaced as an error.
if hb_response.error_code == ErrorCode::StaleMemberEpoch {
debug!(
"ConsumerGroupHeartbeat StaleMemberEpoch for group '{}' — \
updating epoch to {}",
self.group_id, hb_response.member_epoch
);
*self.member_epoch.write().await = hb_response.member_epoch;
// Fall through — the rest of the method updates member_id,
// assignment, etc. from this same response.
} else {
// Handle fencing and unknown member errors
if hb_response.error_code == ErrorCode::UnknownMemberId
|| hb_response.error_code == ErrorCode::FencedMemberEpoch
|| hb_response.error_code == ErrorCode::UnreleasedInstanceId
{
warn!(
"ConsumerGroupHeartbeat error for group '{}': {:?} — resetting member state",
self.group_id, hb_response.error_code
);
if self.is_consumer_protocol() {
// KIP-848: preserve member_id for re-registration.
*self.member_epoch.write().await = 0;
} else {
self.reset_member_identity().await;
}
}
return Err(KrafkaError::broker(
hb_response.error_code,
format!(
"ConsumerGroupHeartbeat failed: {}",
hb_response
.error_message
.as_deref()
.unwrap_or("unknown error")
),
));
}
}
// Update member state from the response
if let Some(ref new_member_id) = hb_response.member_id {
let mut inner = self.inner.write().await;
if inner.member_id != *new_member_id {
if !inner.member_id.is_empty() {
self.sticky_assignor.clear_member(&inner.member_id);
}
inner.member_id = new_member_id.clone();
}
}
*self.member_epoch.write().await = hb_response.member_epoch;
// Update assignment if the coordinator provided one
if let Some(ref assignment) = hb_response.assignment {
// Store the raw target for re-resolution on future metadata refreshes.
*self.target_assignment.write().await = assignment.topic_partitions.clone();
let (new_assignment, has_unresolved) = Self::resolve_assignment(
&self.metadata,
&self.topic_names_cache,
&assignment.topic_partitions,
)
.await;
{
let mut inner = self.inner.write().await;
inner.assignment = new_assignment;
inner.state = GroupState::Stable;
}
if has_unresolved {
debug!(
"Triggering metadata refresh to resolve unresolved topic UUIDs for group '{}'",
self.group_id
);
if let Err(e) = self.metadata.refresh().await {
warn!(
"Metadata refresh for UUID resolution failed for group '{}': {}",
self.group_id, e
);
// Continue with stale metadata — the background heartbeat
// task re-resolves UUIDs on every tick, so unresolved
// partitions will be picked up on the next successful
// metadata refresh.
}
// Re-resolve after refresh. If topic UUIDs are still
// unresolved, KIP-848 cannot operate because UUID→name
// mappings require Metadata v10+.
// Fail fast with a clear error rather
// than silently keeping an empty/partial assignment.
let target = self.target_assignment.read().await.clone();
let (resolved, still_unresolved) =
Self::resolve_assignment(&self.metadata, &self.topic_names_cache, &target)
.await;
self.inner.write().await.assignment = resolved;
if still_unresolved {
return Err(KrafkaError::protocol_kind(
ProtocolErrorKind::Malformed,
"ConsumerGroupHeartbeat assignment contains topic UUIDs that could not \
be resolved after metadata refresh. KIP-848 requires Metadata v10+ \
to map topic IDs to names.",
));
}
}
}
info!(
"ConsumerGroupHeartbeat OK for group '{}': member_id='{}', epoch={}, interval={}ms",
self.group_id,
hb_response.member_id.as_deref().unwrap_or(""),
hb_response.member_epoch,
hb_response.heartbeat_interval_ms
);
Ok(hb_response)
}
/// Resolve topic UUIDs from a heartbeat assignment to topic names.
///
/// Resolution order (mirrors the Java client's two-level lookup):
/// 1. Cluster metadata cache (populated from metadata v10+ responses).
/// 2. Local topic names cache (survives metadata cache flushes).
///
/// Successfully resolved names are inserted into `topic_names_cache`.
/// Returns `(assignment, has_unresolved)`. When `has_unresolved` is
/// `true`, the caller should trigger a metadata refresh and store the
/// raw target assignment for later re-resolution.
async fn resolve_assignment(
metadata: &Arc<ClusterMetadata>,
topic_names_cache: &Arc<RwLock<HashMap<[u8; 16], String>>>,
topic_partitions: &[ConsumerGroupTopicPartitions],
) -> (MemberAssignment, bool) {
let mut assignment = MemberAssignment::empty();
let mut has_unresolved = false;
let mut cache = topic_names_cache.write().await;
for tp in topic_partitions {
// 1. Try the global metadata cache.
if let Some(name) = metadata.topic_name_for_id(&tp.topic_id) {
cache.insert(tp.topic_id, name.clone());
assignment.add(name, tp.partitions.clone());
continue;
}
// 2. Fallback to the local names cache.
if let Some(name) = cache.get(&tp.topic_id) {
assignment.add(name.clone(), tp.partitions.clone());
continue;
}
warn!(
"Cannot resolve topic UUID {:02x?} to a name — \
will retry after next metadata refresh. \
Partitions {:?} skipped for now.",
tp.topic_id, tp.partitions
);
has_unresolved = true;
}
(assignment, has_unresolved)
}
/// Ensure active membership using the KIP-848 consumer protocol.
///
/// For the initial join, sends a heartbeat with epoch 0 and subscribed
/// topics. For subsequent heartbeats, sends the current epoch.
async fn ensure_active_membership_consumer(
&self,
topics: &[String],
) -> Result<(MemberAssignment, bool)> {
let new_topics = topics.to_vec();
let state = self.inner.read().await.state;
match state {
GroupState::Stable => {
// Already stable — check if topics changed
let old_topics = self.subscribed_topics.read().await.clone();
let mut old_sorted = old_topics;
old_sorted.sort();
let mut new_sorted = new_topics.clone();
new_sorted.sort();
if old_sorted == new_sorted {
return Ok((self.inner.read().await.assignment.clone(), false));
}
// Topics changed — send heartbeat with new subscription
}
GroupState::Unjoined if self.coordinator_conn.read().await.is_none() => {
// Need to find coordinator first
self.find_coordinator().await?;
}
GroupState::Unjoined => {}
GroupState::Leaving | GroupState::Dead => {
return Err(KrafkaError::invalid_state(format!(
"Cannot send consumer heartbeat: group state is {state:?}"
)));
}
// PreparingRebalance / Joining / AwaitingSync: proceed to
// send a heartbeat — for KIP-848, heartbeat is the sole
// communication channel and sending one is always valid.
_ => {}
}
let subscribed = Some(new_topics.clone());
self.set_subscribed_topics(new_topics).await;
let resp = self.consumer_group_heartbeat(subscribed, None).await?;
// Start heartbeat task for KIP-848
self.start_consumer_heartbeat_task(resp.heartbeat_interval_ms)
.await;
let inner = self.inner.read().await;
let joined = matches!(inner.state, GroupState::Stable);
let assignment = inner.assignment.clone();
Ok((assignment, joined))
}
/// Start a background heartbeat task for the KIP-848 consumer protocol.
///
/// Unlike the classic protocol, the KIP-848 heartbeat is the sole
/// communication channel — it carries assignment updates and error codes.
async fn start_consumer_heartbeat_task(&self, interval_ms: i32) {
// Stop existing task if any
self.stop_heartbeat_task().await;
self.heartbeat_controller.take_rebalance_needed();
self.heartbeat_controller.take_member_invalidated();
let (cmd_tx, mut cmd_rx) = mpsc::channel::<HeartbeatCommand>(10);
*self.heartbeat_cmd_tx.write().await = Some(cmd_tx);
let group_id = self.group_id.clone();
let interval = Duration::from_millis(interval_ms.max(1000) as u64);
let heartbeat_controller = self.heartbeat_controller.clone();
let inner_ref = self.inner.clone();
let member_epoch_ref = self.member_epoch.clone();
let coordinator_conn_ref = self.coordinator_conn.clone();
let group_instance_id = self.group_instance_id.clone();
let client_rack = self.client_rack.clone();
let metadata_ref = self.metadata.clone();
let target_assignment_ref = self.target_assignment.clone();
let topic_names_cache_ref = self.topic_names_cache.clone();
let subscribed_topics_snapshot = self.subscribed_topics.read().await.clone();
let rebalance_timeout = self.rebalance_timeout;
tokio::spawn(async move {
debug!(
"Starting KIP-848 heartbeat task for group '{}' (interval={:?})",
group_id, interval
);
// Negotiate the ConsumerGroupHeartbeat version once at task start.
// Only mark the controller as running after successful negotiation
// so that early-return paths don't leave it stuck in a running state.
let hb_version = {
let coordinator_conn = coordinator_conn_ref.read().await.clone();
if let Some(ref conn) = coordinator_conn {
match conn
.negotiate_api_version(
ApiKey::ConsumerGroupHeartbeat,
CONSUMER_GROUP_HEARTBEAT_MAX,
CONSUMER_GROUP_HEARTBEAT_MIN,
)
.await
{
Some(v) => v,
None => {
error!(
"ConsumerGroupHeartbeat unsupported by broker; \
KIP-848 heartbeat task for group '{}' cannot run",
group_id
);
return;
}
}
} else {
error!(
"No coordinator connection for KIP-848 heartbeat task (group '{}')",
group_id
);
return;
}
};
heartbeat_controller.start();
let mut tick = tokio::time::interval(interval);
tick.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
// Track the current interval in ms so we can compare against broker-provided
// updates. Use the clamped value derived from interval_ms to stay consistent.
let mut current_interval_ms = interval_ms.max(1000);
// KIP-848 spec: "The member must set all (top-level) fields when
// it joins for the first time or when an error/timeout occurs."
// Start `true` so the very first tick sends a full heartbeat.
let mut send_full_heartbeat = true;
loop {
tokio::select! {
_ = tick.tick() => {
if !heartbeat_controller.is_running() {
break;
}
let coordinator_conn = coordinator_conn_ref.read().await.clone();
let member_id = inner_ref.read().await.member_id.clone();
let epoch = *member_epoch_ref.read().await;
if let Some(ref conn) = coordinator_conn {
// Build owned-partition snapshot from target
// assignment for revocation acknowledgment.
let owned_partitions = {
let ta = target_assignment_ref.read().await;
if ta.is_empty() { None } else { Some(ta.clone()) }
};
let (sub_names, rebal_timeout_ms, topic_parts) = if send_full_heartbeat {
(
Some(subscribed_topics_snapshot.clone()),
crate::util::duration_to_millis_i32(rebalance_timeout),
owned_partitions,
)
} else {
(None, -1, None)
};
let request = ConsumerGroupHeartbeatRequest {
group_id: group_id.clone(),
member_id,
member_epoch: epoch,
instance_id: group_instance_id.clone(),
rack_id: client_rack.clone(),
rebalance_timeout_ms: rebal_timeout_ms,
subscribed_topic_names: sub_names,
subscribed_topic_regex: None,
server_assignor: None,
topic_partitions: topic_parts,
};
match conn.send_request(
ApiKey::ConsumerGroupHeartbeat,
hb_version,
|buf| request.encode_versioned(hb_version, buf),
).await {
Ok(response_bytes) => {
let mut buf = response_bytes;
match ConsumerGroupHeartbeatResponse::decode_versioned(hb_version, &mut buf) {
Ok(resp) => {
if resp.error_code.is_ok() {
*member_epoch_ref.write().await = resp.member_epoch;
// Update assignment if the coordinator sent one.
if let Some(ref new_assign) = resp.assignment {
*target_assignment_ref.write().await =
new_assign.topic_partitions.clone();
let (resolved, has_unresolved) =
Self::resolve_assignment(
&metadata_ref,
&topic_names_cache_ref,
&new_assign.topic_partitions,
)
.await;
{
let mut inner = inner_ref.write().await;
inner.assignment = resolved;
inner.state = GroupState::Stable;
}
// Signal rebalance so the Consumer layer
// picks up the new assignment, fires
// callbacks, and starts fetching.
heartbeat_controller.signal_rebalance();
if has_unresolved {
debug!(
"Triggering metadata refresh for unresolved UUIDs in group '{}'",
group_id
);
if let Err(e) = metadata_ref.refresh().await {
warn!(
"Metadata refresh for UUID resolution failed for group '{}': {}",
group_id, e
);
}
// Re-resolve with updated metadata.
let target = target_assignment_ref.read().await.clone();
let (re_resolved, still_unresolved) =
Self::resolve_assignment(
&metadata_ref,
&topic_names_cache_ref,
&target,
)
.await;
inner_ref.write().await.assignment = re_resolved;
if still_unresolved {
warn!(
"KIP-848 topic UUIDs still unresolved after metadata refresh \
for group '{}'. Metadata v10+ is required to map topic IDs \
to names.",
group_id
);
}
}
} else {
// No new assignment — re-resolve target in
// case a metadata refresh filled in UUIDs.
let target = target_assignment_ref.read().await.clone();
if !target.is_empty() {
let (resolved, still_unresolved) =
Self::resolve_assignment(
&metadata_ref,
&topic_names_cache_ref,
&target,
)
.await;
inner_ref.write().await.assignment = resolved;
if still_unresolved {
warn!(
"KIP-848 topic UUIDs still unresolved \
for group '{}'. Metadata v10+ is required \
to map topic IDs to names.",
group_id
);
}
}
}
heartbeat_controller.heartbeat_success();
send_full_heartbeat = false;
// Update interval if the coordinator changed it.
let new_ms = resp.heartbeat_interval_ms.max(1000);
if new_ms != current_interval_ms {
debug!(
"KIP-848 heartbeat interval changed for '{}': {}ms → {}ms",
group_id, current_interval_ms, new_ms
);
current_interval_ms = new_ms;
let new_dur = Duration::from_millis(new_ms as u64);
tick = tokio::time::interval(new_dur);
tick.set_missed_tick_behavior(
tokio::time::MissedTickBehavior::Delay,
);
// Consume the immediate first tick.
tick.tick().await;
}
} else if resp.error_code == ErrorCode::RebalanceInProgress {
send_full_heartbeat = true;
heartbeat_controller.signal_rebalance();
} else if resp.error_code == ErrorCode::StaleMemberEpoch {
// Stale epoch: our epoch is behind.
// The coordinator includes the current
// epoch in the response, so update local
// state before the next heartbeat to
// avoid retrying indefinitely with a
// stale value.
*member_epoch_ref.write().await = resp.member_epoch;
debug!(
"KIP-848 StaleMemberEpoch for '{}' — \
updated epoch to {}, will retry on next heartbeat",
group_id, resp.member_epoch
);
send_full_heartbeat = true;
heartbeat_controller.heartbeat_success();
} else if resp.error_code == ErrorCode::UnknownMemberId
|| resp.error_code == ErrorCode::FencedMemberEpoch
|| resp.error_code == ErrorCode::UnreleasedInstanceId
{
warn!(
"KIP-848 heartbeat error for '{}': {:?}",
group_id, resp.error_code
);
heartbeat_controller.signal_member_invalidated();
heartbeat_controller.signal_rebalance();
// Stop the task — the consumer poll loop will
// detect the fencing via needs_rejoin(), perform
// a KIP-848 fencing reset, and restart the task
// with a full heartbeat (all top-level fields)
// via ensure_active_membership().
break;
} else if resp.error_code == ErrorCode::UnsupportedAssignor
{
warn!(
"KIP-848 unsupported assignor for '{}': {:?}",
group_id, resp.error_message
);
send_full_heartbeat = true;
heartbeat_controller.signal_rebalance();
} else if resp.error_code
== ErrorCode::InvalidRegularExpression
{
error!(
"KIP-848 invalid regex subscription for '{}': {:?}",
group_id, resp.error_message
);
// Fatal configuration error — don't retry.
break;
} else if resp.error_code == ErrorCode::NotCoordinator
|| resp.error_code
== ErrorCode::CoordinatorNotAvailable
{
warn!(
"KIP-848 coordinator stale for '{}': {:?}",
group_id, resp.error_code
);
// Clear cached coordinator so the next
// get_coordinator_connection() triggers
// rediscovery.
*coordinator_conn_ref.write().await = None;
heartbeat_controller.signal_rebalance();
// Stop the task — the consumer poll loop
// will rediscover the coordinator and
// restart the task via
// ensure_active_membership().
break;
} else if resp.error_code
== ErrorCode::CoordinatorLoadInProgress
{
// Transient: coordinator is loading state.
// Keep the connection and retry on the
// next heartbeat tick.
send_full_heartbeat = true;
debug!(
"KIP-848 coordinator loading for '{}', will retry",
group_id
);
} else {
send_full_heartbeat = true;
warn!(
"KIP-848 heartbeat error for '{}': {:?}",
group_id, resp.error_code
);
}
}
Err(e) => {
send_full_heartbeat = true;
warn!(
"Failed to decode KIP-848 heartbeat response for '{}': {}",
group_id, e
);
}
}
}
Err(e) => {
warn!(
"Failed to send KIP-848 heartbeat for '{}': {}",
group_id, e
);
// Network error — the coordinator connection
// may be dead. Clear it and exit the heartbeat
// loop so the consumer poll loop can rediscover
// the coordinator and rejoin via
// ensure_active_membership().
*coordinator_conn_ref.write().await = None;
heartbeat_controller.signal_rebalance();
break;
}
}
}
}
cmd = cmd_rx.recv() => {
match cmd {
Some(HeartbeatCommand::Stop) | None => break,
Some(HeartbeatCommand::Rejoin) => break,
Some(HeartbeatCommand::AcknowledgeRevocation) => {
// KIP-848 §revocation-ack: after the consumer
// layer processes revocations, send an immediate
// heartbeat with the updated owned partitions so
// the coordinator can proceed.
send_full_heartbeat = true;
tick.reset();
// The next tick fires immediately because we
// just reset the interval, which means the
// loop will go around and send the full HB.
}
}
}
}
}
heartbeat_controller.stop();
debug!("KIP-848 heartbeat task ended for group '{}'", group_id);
});
}
/// Send a single heartbeat (for inline heartbeat during poll).
pub async fn send_heartbeat(&self) -> Result<HeartbeatStatus> {
let conn = self.get_coordinator_connection().await?;
let (member_id, generation_id) = {
let inner = self.inner.read().await;
(inner.member_id.clone(), inner.generation_id)
};
let request = HeartbeatRequest {
group_id: self.group_id.clone(),
generation_id,
member_id,
group_instance_id: self.group_instance_id.clone(),
};
// Negotiate heartbeat version with broker (MIN=3, KIP-345 static membership).
let hb_version = conn
.negotiate_api_version(ApiKey::Heartbeat, HEARTBEAT_MAX, HEARTBEAT_MIN)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support Heartbeat v{}-v{}",
HEARTBEAT_MIN, HEARTBEAT_MAX,
),
)
})?;
let response = conn
.send_request(ApiKey::Heartbeat, hb_version, |buf| {
request.encode_versioned(hb_version, buf)
})
.await?;
let mut buf = response;
let hb_response = HeartbeatResponse::decode_versioned(hb_version, &mut buf)?;
let status = HeartbeatStatus::from_error_code(hb_response.error_code);
if status == HeartbeatStatus::Ok {
self.heartbeat_controller.heartbeat_success();
}
Ok(status)
}
/// Handle inline heartbeat status by clearing member identity for
/// session-invalidating errors before triggering a rejoin.
///
/// Returns `true` if a rejoin was triggered and the caller should
/// abort the current rebalance phase (return early from poll).
pub async fn handle_inline_heartbeat_status(&self, status: HeartbeatStatus) -> bool {
if status.requires_rejoin() {
if status.is_session_invalidating() {
self.reset_member_identity().await;
}
self.trigger_rejoin().await;
true
} else {
false
}
}
/// Commit offsets to the coordinator.
pub async fn commit_offsets(
&self,
offsets: &HashMap<(String, PartitionId), (i64, Option<String>)>,
) -> Result<()> {
if offsets.is_empty() {
return Ok(());
}
// Validate state
let state = self.inner.read().await.state;
if state != GroupState::Stable {
return Err(KrafkaError::invalid_state(format!(
"cannot commit offsets: group state is {:?}",
state
)));
}
let conn = self.get_coordinator_connection().await?;
let oc_version = conn
.negotiate_api_version(ApiKey::OffsetCommit, OFFSET_COMMIT_MAX, OFFSET_COMMIT_MIN)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support OffsetCommit v{}-v{}",
OFFSET_COMMIT_MIN, OFFSET_COMMIT_MAX,
),
)
})?;
let member_id = self.inner.read().await.member_id.clone();
// carries the member epoch instead of the classic generation ID.
// This semantic overload is only valid from v9+ — at earlier versions
// the broker strictly validates against the classic group generation,
// so we fall back to the classic generation_id.
let generation_id = if self.is_consumer_protocol() && oc_version >= 9 {
*self.member_epoch.read().await
} else {
self.inner.read().await.generation_id
};
// Group offsets by topic
let mut topics_map: HashMap<String, Vec<OffsetCommitRequestPartition>> = HashMap::new();
for ((topic, partition), (offset, metadata)) in offsets {
topics_map
.entry(topic.clone())
.or_default()
.push(OffsetCommitRequestPartition {
partition_index: *partition,
committed_offset: *offset,
committed_leader_epoch: -1,
commit_timestamp: -1,
committed_metadata: metadata.clone(),
});
}
let mut topics: Vec<OffsetCommitRequestTopic> = topics_map
.into_iter()
.map(|(name, partitions)| OffsetCommitRequestTopic {
name,
topic_id: None,
partitions,
})
.collect();
// KIP-848 v10+: replace topic name with topic_id on the wire.
// Fall back to v9 if any UUID is missing from the metadata cache.
let oc_version = if oc_version >= 10 {
let all_known = topics.iter_mut().all(|t| {
if let Some(id) = self.metadata.topic_id_for_name(&t.name) {
t.topic_id = Some(id);
true
} else {
false
}
});
if all_known { oc_version } else { 9 }
} else {
oc_version
};
let request = OffsetCommitRequest {
group_id: self.group_id.clone(),
generation_id,
member_id,
group_instance_id: self.group_instance_id.clone(),
retention_time_ms: -1,
topics,
};
debug!(
"Committing {} offsets for group '{}'",
offsets.len(),
self.group_id
);
let response = conn
.send_request(ApiKey::OffsetCommit, oc_version, |buf| {
request.encode_versioned(oc_version, buf)
})
.await?;
let mut buf = response;
let mut commit_response = OffsetCommitResponse::decode_versioned(oc_version, &mut buf)?;
// KIP-848 v10: response topics carry topic_id instead of name —
// resolve back to name for downstream error messages.
if oc_version >= 10 {
for t in &mut commit_response.topics {
if t.name.is_empty()
&& let Some(id) = t.topic_id
&& let Some(name) = self.metadata.topic_name_for_id(&id)
{
t.name = name;
}
}
}
// Check for errors
for topic in &commit_response.topics {
for partition in &topic.partitions {
if !partition.error_code.is_ok() {
// For KIP-848, StaleMemberEpoch is transient — the
// background heartbeat task will update our epoch.
// Don't trigger a rebalance; let the caller retry.
if self.is_consumer_protocol()
&& partition.error_code == ErrorCode::StaleMemberEpoch
{
return Err(KrafkaError::broker(
partition.error_code,
format!(
"Offset commit failed for {}-{}: stale epoch, retry after heartbeat",
topic.name, partition.partition_index
),
));
}
// Handle rebalance errors specially
if partition.error_code == ErrorCode::RebalanceInProgress
|| partition.error_code == ErrorCode::IllegalGeneration
|| partition.error_code == ErrorCode::UnknownMemberId
|| partition.error_code == ErrorCode::FencedMemberEpoch
|| partition.error_code == ErrorCode::StaleMemberEpoch
{
self.inner.write().await.state = GroupState::PreparingRebalance;
return Err(KrafkaError::broker(
partition.error_code,
format!(
"Offset commit failed for {}-{}: rebalance needed",
topic.name, partition.partition_index
),
));
}
// Stale coordinator — clear cached connection for rediscovery.
if partition.error_code == ErrorCode::NotCoordinator
|| partition.error_code == ErrorCode::CoordinatorNotAvailable
{
*self.coordinator_conn.write().await = None;
}
return Err(KrafkaError::broker(
partition.error_code,
format!(
"Offset commit failed for {}-{}",
topic.name, partition.partition_index
),
));
}
}
}
info!(
"Committed {} offsets for group '{}'",
offsets.len(),
self.group_id
);
Ok(())
}
/// Fetch committed offsets from the coordinator.
///
/// Returns the committed offset for each topic-partition, or `None` if
/// no offset has been committed for that partition.
pub async fn fetch_committed_offsets(
&self,
partitions: &HashMap<String, Vec<crate::PartitionId>>,
) -> Result<HashMap<(String, crate::PartitionId), i64>> {
if partitions.is_empty() {
return Ok(HashMap::new());
}
let conn = self.get_coordinator_connection().await?;
let mut topics: Vec<OffsetFetchRequestTopic> = partitions
.iter()
.map(|(topic, parts)| OffsetFetchRequestTopic {
name: topic.clone(),
topic_id: None,
partition_indexes: parts.clone(),
})
.collect();
// Negotiate version: v0 returns UNKNOWN_TOPIC_OR_PARTITION on modern
// brokers, so we floor at v1. At v6+ the wire switches to flexible
// encoding, v8+ uses the batched Groups format (KIP-709), and v9
// adds MemberId/MemberEpoch for KIP-848 epoch validation,
// v10 KIP-848 topic_id replaces topic name on the wire.
let of_version = conn
.negotiate_api_version(ApiKey::OffsetFetch, OFFSET_FETCH_MAX, OFFSET_FETCH_MIN)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support OffsetFetch v{}-v{}",
OFFSET_FETCH_MIN, OFFSET_FETCH_MAX,
),
)
})?;
// KIP-848 v10+: replace topic name with topic_id on the wire.
// Fall back to v9 if any UUID is missing from the metadata cache.
let of_version = if of_version >= 10 {
let all_known = topics.iter_mut().all(|t| {
if let Some(id) = self.metadata.topic_id_for_name(&t.name) {
t.topic_id = Some(id);
true
} else {
false
}
});
if all_known { of_version } else { 9 }
} else {
of_version
};
// For KIP-848, populate MemberId/MemberEpoch so the broker can validate
// membership and surface STALE_MEMBER_EPOCH when appropriate.
// These fields only exist on the wire from v9+; at earlier versions
// the encode path ignores them, so we leave defaults.
let (offset_fetch_member_id, offset_fetch_member_epoch) =
if self.is_consumer_protocol() && of_version >= 9 {
(
Some(self.inner.read().await.member_id.clone()),
*self.member_epoch.read().await,
)
} else {
(None, -1)
};
let request = OffsetFetchRequest {
group_id: self.group_id.clone(),
topics: Some(topics),
require_stable: false,
member_id: offset_fetch_member_id,
member_epoch: offset_fetch_member_epoch,
};
debug!(
"Fetching committed offsets for group '{}' ({} topics)",
self.group_id,
partitions.len()
);
let response = conn
.send_request(ApiKey::OffsetFetch, of_version, |buf| {
request.encode_versioned(of_version, buf)
})
.await?;
let mut buf = response;
let mut offset_response = OffsetFetchResponse::decode_versioned(of_version, &mut buf)?;
// KIP-848 v10: response topics carry topic_id instead of name —
// resolve back to name for downstream result map keys.
if of_version >= 10 {
for t in &mut offset_response.topics {
if t.name.is_empty()
&& let Some(id) = t.topic_id
&& let Some(name) = self.metadata.topic_name_for_id(&id)
{
t.name = name;
}
}
}
// Check group-level error (v2+ top-level ErrorCode, v8+ per-group ErrorCode).
// Errors like NOT_COORDINATOR, STALE_MEMBER_EPOCH, or UNKNOWN_MEMBER_ID
// appear here and must be surfaced before iterating partitions.
if !offset_response.error_code.is_ok() {
if offset_response.error_code == ErrorCode::StaleMemberEpoch
|| offset_response.error_code == ErrorCode::UnknownMemberId
|| offset_response.error_code == ErrorCode::FencedMemberEpoch
{
self.inner.write().await.state = GroupState::PreparingRebalance;
} else if offset_response.error_code == ErrorCode::NotCoordinator
|| offset_response.error_code == ErrorCode::CoordinatorNotAvailable
{
// Stale coordinator — clear the cached connection so the next
// call to get_coordinator_connection() triggers rediscovery.
*self.coordinator_conn.write().await = None;
}
return Err(KrafkaError::broker(
offset_response.error_code,
format!("OffsetFetch failed for group '{}'", self.group_id),
));
}
let mut result = HashMap::new();
for topic in &offset_response.topics {
for partition in &topic.partitions {
if partition.error_code.is_ok() && partition.committed_offset >= 0 {
result.insert(
(topic.name.clone(), partition.partition_index),
partition.committed_offset,
);
}
}
}
info!(
"Fetched {} committed offsets for group '{}'",
result.len(),
self.group_id
);
Ok(result)
}
/// List offsets (earliest/latest) for the given partitions.
///
/// `timestamp` should be -1 for latest or -2 for earliest.
pub async fn list_offsets(
&self,
partitions: &HashMap<String, Vec<crate::PartitionId>>,
timestamp: i64,
) -> Result<HashMap<(String, crate::PartitionId), i64>> {
if partitions.is_empty() {
return Ok(HashMap::new());
}
// We need to send ListOffsets to the leader of each partition
let mut result = HashMap::new();
// Group by leader
let mut partitions_by_leader: HashMap<crate::BrokerId, Vec<(String, crate::PartitionId)>> =
HashMap::new();
let mut leaderless: Vec<(String, crate::PartitionId)> = Vec::new();
for (topic, parts) in partitions {
for &partition in parts {
if let Some(leader_id) = self.metadata.leader(topic, partition) {
partitions_by_leader
.entry(leader_id)
.or_default()
.push((topic.clone(), partition));
} else {
leaderless.push((topic.clone(), partition));
}
}
}
// Warn about leaderless partitions and try after a metadata refresh
if !leaderless.is_empty() {
warn!(
"No leader found for {} partition(s), refreshing metadata: {:?}",
leaderless.len(),
leaderless
);
let topics: Vec<&str> = leaderless.iter().map(|(t, _)| t.as_str()).collect();
if let Err(refresh_err) = self.metadata.refresh_for_topics(Some(&topics)).await {
debug!(error = %refresh_err, "Metadata refresh failed for leaderless partitions");
}
// Retry resolution after refresh
for (topic, partition) in leaderless {
if let Some(leader_id) = self.metadata.leader(&topic, partition) {
partitions_by_leader
.entry(leader_id)
.or_default()
.push((topic, partition));
} else {
warn!(
"Still no leader for {}-{} after metadata refresh, skipping",
topic, partition
);
}
}
}
for (leader_id, leader_partitions) in &partitions_by_leader {
// Group partitions by topic
let mut topics_map: HashMap<String, Vec<ListOffsetsRequestPartition>> = HashMap::new();
for (topic, partition) in leader_partitions {
topics_map
.entry(topic.clone())
.or_default()
.push(ListOffsetsRequestPartition {
partition_index: *partition,
current_leader_epoch: -1,
timestamp,
});
}
let topics: Vec<ListOffsetsRequestTopic> = topics_map
.into_iter()
.map(|(name, parts)| ListOffsetsRequestTopic {
name,
partitions: parts,
})
.collect();
let request = ListOffsetsRequest {
replica_id: -1,
isolation_level: self.isolation_level,
topics,
timeout_ms: None,
};
// Get connection to this leader directly by ID
let conn = self.metadata.get_broker_connection(*leader_id).await?;
let lo_version = conn
.negotiate_api_version(ApiKey::ListOffsets, LIST_OFFSETS_MAX, LIST_OFFSETS_MIN)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support ListOffsets v{}-v{}",
LIST_OFFSETS_MIN, LIST_OFFSETS_MAX,
),
)
})?;
let response = conn
.send_request(ApiKey::ListOffsets, lo_version, |buf| {
request.encode_versioned(lo_version, buf)
})
.await?;
let mut buf = response;
let list_response = ListOffsetsResponse::decode_versioned(lo_version, &mut buf)?;
for topic_resp in &list_response.topics {
for part_resp in &topic_resp.partitions {
if part_resp.error_code.is_ok() {
result.insert(
(topic_resp.name.clone(), part_resp.partition_index),
part_resp.offset,
);
} else {
// Log partition-level errors instead of silently
// dropping them. Callers should handle missing partitions.
warn!(
"ListOffsets error for {}-{}: {:?}",
topic_resp.name, part_resp.partition_index, part_resp.error_code
);
}
}
}
}
Ok(result)
}
/// Leave the consumer group.
pub async fn leave_group(&self) -> Result<()> {
let state = self.inner.read().await.state;
if state == GroupState::Unjoined || state == GroupState::Dead {
return Ok(());
}
// KIP-848: stop heartbeat first (prevent normal heartbeat from
// racing with the leave-epoch heartbeat), then send the leave.
if self.is_consumer_protocol() {
self.stop_heartbeat_task().await;
return self.leave_group_consumer().await;
}
// Classic protocol: send LeaveGroup while heartbeat still keeps the
// member alive on the broker, then stop heartbeat afterward.
let conn = match self.get_coordinator_connection().await {
Ok(c) => c,
Err(_) => {
// If we can't get a connection, just stop heartbeat and reset state
self.stop_heartbeat_task().await;
self.reset().await;
return Ok(());
}
};
let member_id = self.inner.read().await.member_id.clone();
self.inner.write().await.state = GroupState::Leaving;
// v3+ uses only the `members` array; the top-level `member_id`
// must be empty to avoid ambiguous single-vs-batch leave semantics.
let request = LeaveGroupRequest {
group_id: self.group_id.clone(),
member_id: String::new(),
members: vec![LeaveGroupMember {
member_id: member_id.clone(),
group_instance_id: self.group_instance_id.clone(),
reason: None,
}],
};
debug!(
"Leaving group '{}', member_id='{}'",
self.group_id, member_id
);
// Send leave group request (don't wait too long)
// Negotiate version with broker (MIN=3, KIP-345 batch leave).
let lg_version = conn
.negotiate_api_version(ApiKey::LeaveGroup, LEAVE_GROUP_MAX, LEAVE_GROUP_MIN)
.await
.ok_or_else(|| {
KrafkaError::protocol_kind(
ProtocolErrorKind::UnknownApiVersion,
format!(
"broker does not support LeaveGroup v{}-v{}",
LEAVE_GROUP_MIN, LEAVE_GROUP_MAX,
),
)
})?;
let result = tokio::time::timeout(
Duration::from_secs(5),
conn.send_request(ApiKey::LeaveGroup, lg_version, |buf| {
request.encode_versioned(lg_version, buf)
}),
)
.await;
// Decode the response and check for errors
match result {
Ok(Ok(response_bytes)) => {
let mut buf = response_bytes;
let decode_result = LeaveGroupResponse::decode_versioned(lg_version, &mut buf);
match decode_result {
Ok(r) if r.error_code.is_ok() => {
// Check per-member errors (v3 batch leave)
for member in &r.members {
if !member.error_code.is_ok() {
warn!(
"LeaveGroup per-member error for '{}' (member '{}'): {:?}",
self.group_id, member.member_id, member.error_code
);
}
}
info!("Left group '{}'", self.group_id);
}
Ok(r) => {
warn!(
"LeaveGroup error for '{}': {:?}",
self.group_id, r.error_code
);
}
Err(e) => {
warn!(
"Failed to decode LeaveGroup response for '{}': {}",
self.group_id, e
);
}
}
}
Ok(Err(e)) => {
warn!(
"Failed to send LeaveGroup request for '{}': {}",
self.group_id, e
);
}
Err(_) => {
warn!("LeaveGroup request timed out for '{}'", self.group_id);
}
}
self.stop_heartbeat_task().await;
self.reset().await;
Ok(())
}
/// Leave the group using the KIP-848 consumer protocol.
///
/// Sends a ConsumerGroupHeartbeat with `member_epoch = -1` for dynamic
/// members (permanent leave) or `-2` for static members (temporary leave,
/// broker keeps assignment for session-timeout window so the instance can
/// rejoin quickly).
async fn leave_group_consumer(&self) -> Result<()> {
let conn = match self.get_coordinator_connection().await {
Ok(c) => c,
Err(_) => {
self.reset().await;
return Ok(());
}
};
// KIP-848: -1 = permanent leave, -2 = static-member temporary leave.
let leave_epoch: i32 = if self.group_instance_id.is_some() {
-2
} else {
-1
};
let member_id = self.inner.read().await.member_id.clone();
self.inner.write().await.state = GroupState::Leaving;
*self.member_epoch.write().await = leave_epoch;
let request = ConsumerGroupHeartbeatRequest {
group_id: self.group_id.clone(),
member_id: member_id.clone(),
member_epoch: leave_epoch,
instance_id: self.group_instance_id.clone(),
rack_id: self.client_rack.clone(),
rebalance_timeout_ms: -1,
subscribed_topic_names: None,
subscribed_topic_regex: None,
server_assignor: None,
topic_partitions: None,
};
debug!(
"Leaving group '{}' via KIP-848 heartbeat, member_id='{}', epoch={}",
self.group_id, member_id, leave_epoch
);
let Some(hb_version) = conn
.negotiate_api_version(
ApiKey::ConsumerGroupHeartbeat,
CONSUMER_GROUP_HEARTBEAT_MAX,
CONSUMER_GROUP_HEARTBEAT_MIN,
)
.await
else {
warn!(
"ConsumerGroupHeartbeat unsupported; cannot send KIP-848 leave for '{}'",
self.group_id
);
return Ok(());
};
let result = tokio::time::timeout(
Duration::from_secs(5),
conn.send_request(ApiKey::ConsumerGroupHeartbeat, hb_version, |buf| {
request.encode_versioned(hb_version, buf)
}),
)
.await;
match result {
Ok(Ok(response_bytes)) => {
let mut buf = response_bytes;
match ConsumerGroupHeartbeatResponse::decode_versioned(hb_version, &mut buf) {
Ok(resp) if resp.error_code.is_ok() => {
info!("Left group '{}' via KIP-848", self.group_id);
}
Ok(resp) => {
warn!(
"KIP-848 LeaveGroup error for '{}': {:?}",
self.group_id, resp.error_code
);
}
Err(e) => {
warn!(
"Failed to decode KIP-848 leave response for '{}': {}",
self.group_id, e
);
}
}
}
Ok(Err(e)) => {
warn!(
"Failed to send KIP-848 leave for '{}': {}",
self.group_id, e
);
}
Err(_) => {
warn!("KIP-848 leave request timed out for '{}'", self.group_id);
}
}
self.reset().await;
Ok(())
}
/// Reset coordinator state.
async fn reset(&self) {
self.reset_member_identity().await;
{
let mut inner = self.inner.write().await;
inner.state = GroupState::Unjoined;
inner.assignment = MemberAssignment::empty();
}
self.target_assignment.write().await.clear();
self.topic_names_cache.write().await.clear();
*self.coordinator_conn.write().await = None;
*self.coordinator_id.write().await = None;
}
/// Reset group state for KIP-848 fencing errors (FencedMemberEpoch,
/// UnknownMemberId, UnreleasedInstanceId).
///
/// Unlike [`reset_member_identity`], this preserves `member_id`:
/// KIP-848 requires fenced members to "rejoin with the same member id
/// and epoch 0". Sticky assignor, assignment, and target state are
/// cleared because the coordinator revoked all partitions on fencing.
async fn reset_for_kip848_fencing(&self) {
let member_id = self.inner.read().await.member_id.clone();
if !member_id.is_empty() {
self.sticky_assignor.clear_member(&member_id);
}
*self.member_epoch.write().await = 0;
{
let mut inner = self.inner.write().await;
inner.generation_id = -1;
inner.state = GroupState::Unjoined;
inner.assignment = MemberAssignment::empty();
}
self.target_assignment.write().await.clear();
self.topic_names_cache.write().await.clear();
}
/// Clear member identity (member_id, generation_id) and any associated
/// sticky assignor state.
///
/// Called on session-invalidating errors (UNKNOWN_MEMBER_ID,
/// ILLEGAL_GENERATION, session timeout) so the next join_group() sends
/// a fresh empty member_id for re-registration. Also called by reset()
/// during leave_group/close to prevent orphaned previous_assignments.
async fn reset_member_identity(&self) {
let mut inner = self.inner.write().await;
if !inner.member_id.is_empty() {
self.sticky_assignor.clear_member(&inner.member_id);
}
inner.member_id.clear();
inner.generation_id = -1;
drop(inner);
*self.member_epoch.write().await = 0;
}
/// Encode consumer protocol metadata.
///
/// For cooperative-sticky, encodes version 1 metadata which includes owned
/// partitions. This allows the leader to know each member's current assignment
/// for computing incremental revocations.
fn encode_consumer_metadata(
&self,
topics: &[String],
owned_partitions: &HashMap<String, Vec<PartitionId>>,
) -> Result<BytesMut> {
let mut buf = BytesMut::new();
if self.is_cooperative() {
// Version 1: includes owned partitions for cooperative protocol
buf.put_i16(1);
} else {
// Version 0: topics only
buf.put_i16(0);
}
// Topics array — sorted for deterministic encoding so the broker
// does not detect spurious metadata changes between generations.
let mut sorted_topics: Vec<&String> = topics.iter().collect();
sorted_topics.sort();
buf.put_i32(crate::protocol::array_len_i32(sorted_topics.len())?);
for topic in &sorted_topics {
let topic_len = i16::try_from(topic.len()).map_err(|_| {
KrafkaError::protocol_kind(
ProtocolErrorKind::InvalidLength,
format!(
"topic name '{}' exceeds Kafka i16 length limit ({} bytes)",
topic,
topic.len()
),
)
})?;
buf.put_i16(topic_len);
buf.put_slice(topic.as_bytes());
}
// User data (empty)
buf.put_i32(-1);
if self.is_cooperative() {
// Owned partitions (version 1+) — sorted for deterministic encoding.
let mut sorted_owned: Vec<(&String, &Vec<PartitionId>)> =
owned_partitions.iter().collect();
sorted_owned.sort_by_key(|(topic, _)| topic.as_str());
buf.put_i32(crate::protocol::array_len_i32(sorted_owned.len())?);
for (topic, partitions) in &sorted_owned {
let topic_len = i16::try_from(topic.len()).map_err(|_| {
KrafkaError::protocol_kind(
ProtocolErrorKind::InvalidLength,
format!("topic name '{}' exceeds Kafka i16 length limit", topic),
)
})?;
buf.put_i16(topic_len);
buf.put_slice(topic.as_bytes());
let mut sorted_parts = partitions.to_vec();
sorted_parts.sort();
buf.put_i32(crate::protocol::array_len_i32(sorted_parts.len())?);
for &p in &sorted_parts {
buf.put_i32(p);
}
}
}
Ok(buf)
}
/// Decode consumer protocol metadata from JoinGroup member metadata.
///
/// Returns the subscribed topics and, for version >= 1, the owned partitions.
fn decode_consumer_metadata(data: &[u8]) -> (Vec<String>, HashMap<String, Vec<PartitionId>>) {
if data.len() < 2 {
return (Vec::new(), HashMap::new());
}
let mut buf = data;
let version = buf.get_i16();
// Decode topics
let mut topics = Vec::new();
if buf.remaining() >= 4 {
let topic_count = buf.get_i32();
let count = topic_count.max(0) as usize;
if count > 10_000 {
warn!(
"decode_consumer_metadata: topic count {} exceeds cap, returning early",
count
);
return (topics, HashMap::new());
}
let safe_count = count.min(buf.remaining() / 2);
for _ in 0..safe_count {
if buf.remaining() < 2 {
return (topics, HashMap::new());
}
let len = buf.get_i16();
if len < 0 || buf.remaining() < len as usize {
return (topics, HashMap::new());
}
match String::from_utf8(buf.copy_to_bytes(len as usize).to_vec()) {
Ok(t) => topics.push(t),
Err(e) => {
warn!("decode_consumer_metadata: invalid UTF-8 in topic name: {e}");
return (topics, HashMap::new());
}
}
}
}
// Skip user_data
if buf.remaining() >= 4 {
let user_data_len = buf.get_i32();
if user_data_len > 0 {
if buf.remaining() < user_data_len as usize {
return (topics, HashMap::new());
}
buf.advance(user_data_len as usize);
}
}
// Decode owned partitions (version 1+)
let mut owned = HashMap::new();
if version >= 1 && buf.remaining() >= 4 {
let topic_count = buf.get_i32();
let count = topic_count.max(0) as usize;
if count > 10_000 {
warn!(
"decode_consumer_metadata: owned topic count {} exceeds cap, returning early",
count
);
return (topics, owned);
}
let safe_topic_count = count.min(buf.remaining() / 6);
for _ in 0..safe_topic_count {
if buf.remaining() < 2 {
return (topics, owned);
}
let len = buf.get_i16();
if len < 0 || buf.remaining() < len as usize {
return (topics, owned);
}
let topic = match String::from_utf8(buf.copy_to_bytes(len as usize).to_vec()) {
Ok(t) => t,
Err(e) => {
warn!("decode_consumer_metadata: invalid UTF-8 in owned topic name: {e}");
return (topics, owned);
}
};
if buf.remaining() < 4 {
return (topics, owned);
}
let part_count = buf.get_i32();
let pcount = part_count.max(0) as usize;
if pcount > 10_000 {
warn!(
"decode_consumer_metadata: partition count {} for '{}' exceeds cap, returning early",
pcount, topic
);
return (topics, owned);
}
let safe_part_count = pcount.min(buf.remaining() / 4);
let mut parts = Vec::with_capacity(safe_part_count);
for _ in 0..safe_part_count {
if buf.remaining() < 4 {
return (topics, owned);
}
parts.push(buf.get_i32());
}
owned.insert(topic, parts);
}
}
(topics, owned)
}
/// Decode consumer assignment from SyncGroup response.
fn decode_consumer_assignment(&self, data: &Bytes) -> Result<MemberAssignment> {
if data.is_empty() {
return Ok(MemberAssignment::empty());
}
let mut buf = data.clone();
if buf.remaining() < 2 {
return Ok(MemberAssignment::empty());
}
// Version
let _version = buf.get_i16();
// Topics array
if buf.remaining() < 4 {
return Ok(MemberAssignment::empty());
}
let topic_count = buf.get_i32();
if topic_count < 0 {
return Ok(MemberAssignment::empty());
}
// Cap iteration by max array length and remaining buffer to prevent allocation DoS
let safe_topic_count = (topic_count as usize)
.min(MAX_DECODE_ARRAY_LEN)
.min(buf.remaining() / 6);
if safe_topic_count < topic_count as usize {
warn!(
"assignment topic count {} exceeds buffer capacity, decoding {} topics",
topic_count, safe_topic_count
);
}
let mut assignment = MemberAssignment::empty();
for _ in 0..safe_topic_count {
if buf.remaining() < 2 {
break;
}
let topic_len_i16 = buf.get_i16();
if topic_len_i16 < 0 {
break;
}
let topic_len = topic_len_i16 as usize;
if buf.remaining() < topic_len {
break;
}
let topic = String::from_utf8(buf.copy_to_bytes(topic_len).to_vec()).map_err(|e| {
KrafkaError::protocol_kind(
ProtocolErrorKind::InvalidUtf8,
format!("invalid UTF-8 in assignment topic name: {e}"),
)
})?;
if buf.remaining() < 4 {
break;
}
let partition_count = buf.get_i32();
if partition_count < 0 {
break;
}
let safe_partition_count = (partition_count as usize)
.min(MAX_DECODE_ARRAY_LEN)
.min(buf.remaining() / 4);
if safe_partition_count < partition_count as usize {
warn!(
"assignment partition count {} for '{}' exceeds buffer/cap, decoding {}",
partition_count, topic, safe_partition_count
);
}
let mut partitions = Vec::with_capacity(safe_partition_count);
for _ in 0..safe_partition_count {
if buf.remaining() < 4 {
break;
}
partitions.push(buf.get_i32());
}
assignment.add(topic, partitions);
}
Ok(assignment)
}
/// Compute assignments when we are the group leader.
async fn compute_assignments(
&self,
topics: &[String],
members: &[JoinGroupResponseMember],
) -> Result<Vec<SyncGroupRequestAssignment>> {
// Get partition info for all topics
let mut topic_partitions: HashMap<String, Vec<PartitionId>> = HashMap::new();
for topic in topics {
if let Some(topic_info) = self.metadata.topic(topic) {
let partitions: Vec<_> = topic_info
.partitions
.values()
.map(|p| p.partition)
.collect();
topic_partitions.insert(topic.clone(), partitions);
}
}
// For cooperative protocol, decode member metadata to extract owned partitions
// and feed them into the sticky assignor before computing new assignments.
// Prune stale members first to prevent unbounded growth of previous_assignments.
if self.is_cooperative() {
let current_member_ids: HashSet<&str> =
members.iter().map(|m| m.member_id.as_str()).collect();
self.sticky_assignor.retain_members(¤t_member_ids);
for m in members {
let (_member_topics, owned) = Self::decode_consumer_metadata(&m.metadata);
let assignment = MemberAssignment { partitions: owned };
self.sticky_assignor
.record_assignment(&m.member_id, &assignment);
}
}
// Convert to GroupMember for assignor
let group_members: Vec<GroupMember> = members
.iter()
.map(|m| GroupMember {
member_id: m.member_id.clone(),
client_id: String::new(),
client_host: String::new(),
metadata: m.metadata.clone(),
assignment: Bytes::new(),
})
.collect();
// Use configured assignor strategy
let assignments = match self.assignment_strategy {
crate::consumer::config::PartitionAssignmentStrategy::Range => {
let assignor = RangeAssignor;
assignor.assign(topics, &topic_partitions, &group_members)
}
crate::consumer::config::PartitionAssignmentStrategy::RoundRobin => {
let assignor = RoundRobinAssignor;
assignor.assign(topics, &topic_partitions, &group_members)
}
crate::consumer::config::PartitionAssignmentStrategy::CooperativeSticky => self
.sticky_assignor
.assign(topics, &topic_partitions, &group_members),
};
// Encode assignments
let mut result = Vec::with_capacity(members.len());
for member in members {
let member_assignment = assignments
.get(&member.member_id)
.cloned()
.unwrap_or_else(MemberAssignment::empty);
let encoded = self.encode_consumer_assignment(&member_assignment)?;
result.push(SyncGroupRequestAssignment {
member_id: member.member_id.clone(),
assignment: encoded.freeze(),
});
}
Ok(result)
}
/// Encode consumer assignment for SyncGroup request.
fn encode_consumer_assignment(&self, assignment: &MemberAssignment) -> Result<BytesMut> {
let mut buf = BytesMut::new();
// Version
buf.put_i16(0);
// Topics array
buf.put_i32(crate::protocol::array_len_i32(assignment.partitions.len())?);
for (topic, partitions) in &assignment.partitions {
let topic_len = i16::try_from(topic.len()).map_err(|_| {
KrafkaError::protocol_kind(
ProtocolErrorKind::InvalidLength,
format!(
"topic name '{}' exceeds Kafka i16 length limit ({} bytes)",
topic,
topic.len()
),
)
})?;
buf.put_i16(topic_len);
buf.put_slice(topic.as_bytes());
buf.put_i32(crate::protocol::array_len_i32(partitions.len())?);
for &partition in partitions {
buf.put_i32(partition);
}
}
// User data (empty)
buf.put_i32(-1);
Ok(buf)
}
/// Check if heartbeat is overdue (for inline heartbeat during poll).
pub async fn is_heartbeat_overdue(&self) -> bool {
if let Some(elapsed) = self.heartbeat_controller.time_since_last_heartbeat() {
elapsed > self.heartbeat_interval
} else {
// No heartbeat recorded yet, should send one
self.inner.read().await.state == GroupState::Stable
}
}
}
impl std::fmt::Debug for GroupCoordinator {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("GroupCoordinator")
.field("group_id", &self.group_id)
.field("session_timeout", &self.session_timeout)
.field("heartbeat_interval", &self.heartbeat_interval)
.finish()
}
}
#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
mod tests {
use super::*;
fn test_coordinator(
strategy: crate::consumer::config::PartitionAssignmentStrategy,
) -> GroupCoordinator {
let pool = Arc::new(ConnectionPool::new(
crate::network::ConnectionConfig::default(),
));
GroupCoordinator::new(
"test-group",
pool.clone(),
Arc::new(ClusterMetadata::new(
vec!["localhost:9092".to_string()],
pool,
Duration::from_secs(300),
)),
Duration::from_secs(10),
Duration::from_secs(3),
Duration::from_secs(30),
)
.with_assignor_strategy(strategy)
}
#[test]
fn test_member_assignment() {
let mut assignment = MemberAssignment::empty();
assert!(assignment.is_empty());
assignment.add("topic1", vec![0, 1, 2]);
assignment.add("topic2", vec![0, 1]);
assert!(!assignment.is_empty());
assert_eq!(assignment.get("topic1"), Some(vec![0, 1, 2].as_slice()));
assert_eq!(assignment.all_partitions().count(), 5);
}
#[tokio::test]
async fn test_consumer_group_state() {
let group = ConsumerGroup::new(
"test-group",
Duration::from_secs(10),
Duration::from_secs(3),
);
assert_eq!(group.state().await, GroupState::Unjoined);
assert!(group.member_id().await.is_none());
assert_eq!(group.generation_id().await, -1);
group.join_complete("member-1".to_string(), 1).await;
assert_eq!(group.member_id().await, Some("member-1".to_string()));
assert_eq!(group.generation_id().await, 1);
}
#[tokio::test]
async fn test_consumer_group_reset() {
let group = ConsumerGroup::new(
"test-group",
Duration::from_secs(10),
Duration::from_secs(3),
);
group.join_complete("member-1".to_string(), 1).await;
group.set_state(GroupState::Stable).await;
group.reset().await;
assert_eq!(group.state().await, GroupState::Unjoined);
assert!(group.member_id().await.is_none());
}
#[tokio::test]
async fn test_kip848_fencing_reset_clears_sticky_assignor_state() {
let coordinator = test_coordinator(
crate::consumer::config::PartitionAssignmentStrategy::CooperativeSticky,
)
.with_group_protocol(crate::consumer::config::GroupProtocol::Consumer);
{
let mut inner = coordinator.inner.write().await;
inner.member_id = "member-1".to_string();
inner.generation_id = 42;
inner.state = GroupState::Stable;
}
*coordinator.member_epoch.write().await = 7;
let mut assignment = MemberAssignment::empty();
assignment.add("topic-a", vec![0, 1]);
coordinator.inner.write().await.assignment = assignment.clone();
coordinator
.sticky_assignor
.record_assignment("member-1", &assignment);
coordinator
.target_assignment
.write()
.await
.push(ConsumerGroupTopicPartitions {
topic_id: [1; 16],
partitions: vec![0, 1],
});
coordinator
.topic_names_cache
.write()
.await
.insert([1; 16], "topic-a".to_string());
coordinator.reset_for_kip848_fencing().await;
assert_eq!(coordinator.inner.read().await.member_id, "member-1");
assert_eq!(*coordinator.member_epoch.read().await, 0);
assert_eq!(coordinator.inner.read().await.generation_id, -1);
assert_eq!(coordinator.inner.read().await.state, GroupState::Unjoined);
assert!(coordinator.inner.read().await.assignment.is_empty());
assert!(coordinator.target_assignment.read().await.is_empty());
assert!(coordinator.topic_names_cache.read().await.is_empty());
assert!(
!coordinator
.sticky_assignor
.previous_assignments
.read()
.contains_key("member-1")
);
assert!(
coordinator
.sticky_assignor
.get_partitions_to_revoke("member-1", &MemberAssignment::empty())
.is_empty(),
"fencing reset should clear preserved sticky assignments for the fenced member"
);
}
#[test]
fn test_range_assignor() {
let assignor = RangeAssignor;
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2]);
let members = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "host1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "host2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let assignments = assignor.assign(&topics, &partitions, &members);
// m1 should get 2 partitions (0, 1), m2 should get 1 partition (2)
let m1_assignment = assignments.get("m1").unwrap();
let m2_assignment = assignments.get("m2").unwrap();
assert_eq!(m1_assignment.get("topic1"), Some(vec![0, 1].as_slice()));
assert_eq!(m2_assignment.get("topic1"), Some(vec![2].as_slice()));
}
#[test]
fn test_roundrobin_assignor() {
let assignor = RoundRobinAssignor;
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3]);
let members = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "host1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "host2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let assignments = assignor.assign(&topics, &partitions, &members);
// m1 gets 0, 2; m2 gets 1, 3
let m1_partitions = assignments.get("m1").unwrap().get("topic1").unwrap();
let m2_partitions = assignments.get("m2").unwrap().get("topic1").unwrap();
assert_eq!(m1_partitions.len(), 2);
assert_eq!(m2_partitions.len(), 2);
}
#[test]
fn test_noop_rebalance_listener() {
use crate::consumer::TopicPartition;
let listener = NoOpRebalanceListener;
// All methods should be no-ops (not panic)
let partitions = vec![
TopicPartition::new("topic1", 0),
TopicPartition::new("topic2", 1),
];
// These should all be no-ops and not panic
ConsumerRebalanceListener::on_partitions_assigned(&listener, &partitions);
ConsumerRebalanceListener::on_partitions_revoked(&listener, &partitions);
ConsumerRebalanceListener::on_partitions_lost(&listener, &partitions);
}
#[test]
fn test_rebalance_listener_trait_bounds() {
// Ensure trait bounds are satisfied for async contexts
fn assert_send_sync<T: Send + Sync>() {}
assert_send_sync::<NoOpRebalanceListener>();
}
#[test]
fn test_custom_rebalance_listener() {
use crate::consumer::TopicPartition;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
struct CountingListener {
assigned_count: AtomicUsize,
revoked_count: AtomicUsize,
lost_count: AtomicUsize,
}
impl ConsumerRebalanceListener for CountingListener {
fn on_partitions_assigned(&self, partitions: &[TopicPartition]) {
self.assigned_count
.fetch_add(partitions.len(), Ordering::Relaxed);
}
fn on_partitions_revoked(&self, partitions: &[TopicPartition]) {
self.revoked_count
.fetch_add(partitions.len(), Ordering::Relaxed);
}
fn on_partitions_lost(&self, partitions: &[TopicPartition]) {
self.lost_count
.fetch_add(partitions.len(), Ordering::Relaxed);
}
}
let listener = Arc::new(CountingListener {
assigned_count: AtomicUsize::new(0),
revoked_count: AtomicUsize::new(0),
lost_count: AtomicUsize::new(0),
});
let partitions = vec![
TopicPartition::new("topic1", 0),
TopicPartition::new("topic1", 1),
TopicPartition::new("topic2", 0),
];
ConsumerRebalanceListener::on_partitions_assigned(&*listener, &partitions);
assert_eq!(listener.assigned_count.load(Ordering::Relaxed), 3);
ConsumerRebalanceListener::on_partitions_revoked(&*listener, &partitions[..2]);
assert_eq!(listener.revoked_count.load(Ordering::Relaxed), 2);
ConsumerRebalanceListener::on_partitions_lost(&*listener, &partitions[..1]);
assert_eq!(listener.lost_count.load(Ordering::Relaxed), 1);
}
#[test]
fn test_heartbeat_controller_creation() {
let controller = HeartbeatController::new(Duration::from_secs(3), Duration::from_secs(30));
assert_eq!(controller.interval(), Duration::from_secs(3));
assert_eq!(controller.session_timeout(), Duration::from_secs(30));
assert!(!controller.is_running());
}
#[test]
fn test_heartbeat_controller_start_stop() {
let controller = HeartbeatController::new(Duration::from_secs(3), Duration::from_secs(30));
assert!(!controller.is_running());
controller.start();
assert!(controller.is_running());
controller.stop();
assert!(!controller.is_running());
}
#[test]
fn test_heartbeat_controller_success() {
let controller = HeartbeatController::new(Duration::from_secs(3), Duration::from_secs(30));
// Initially, no heartbeat recorded
assert!(controller.time_since_last_heartbeat().is_none());
assert!(!controller.may_have_timed_out());
// Record a heartbeat
controller.heartbeat_success();
// Now we should have a recent heartbeat
let elapsed = controller.time_since_last_heartbeat().unwrap();
assert!(elapsed < Duration::from_secs(1));
assert!(!controller.may_have_timed_out());
}
#[test]
fn test_heartbeat_status_requires_rejoin() {
assert!(!HeartbeatStatus::Ok.requires_rejoin());
assert!(HeartbeatStatus::RebalanceNeeded.requires_rejoin());
assert!(HeartbeatStatus::UnknownMember.requires_rejoin());
assert!(HeartbeatStatus::IllegalGeneration.requires_rejoin());
assert!(HeartbeatStatus::SessionTimeout.requires_rejoin());
assert!(!HeartbeatStatus::FatalError.requires_rejoin());
}
#[test]
fn test_heartbeat_status_is_fatal() {
assert!(!HeartbeatStatus::Ok.is_fatal());
assert!(!HeartbeatStatus::RebalanceNeeded.is_fatal());
assert!(HeartbeatStatus::FatalError.is_fatal());
}
#[test]
fn test_heartbeat_status_is_session_invalidating() {
assert!(!HeartbeatStatus::Ok.is_session_invalidating());
assert!(!HeartbeatStatus::RebalanceNeeded.is_session_invalidating());
assert!(HeartbeatStatus::UnknownMember.is_session_invalidating());
assert!(HeartbeatStatus::IllegalGeneration.is_session_invalidating());
assert!(HeartbeatStatus::SessionTimeout.is_session_invalidating());
assert!(!HeartbeatStatus::FatalError.is_session_invalidating());
}
#[test]
fn test_cooperative_sticky_assignor_basic() {
let assignor = CooperativeStickyAssignor::new();
assert_eq!(assignor.name(), "cooperative-sticky");
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3]);
let members = vec![
GroupMember {
member_id: "member-1".to_string(),
client_id: "client-1".to_string(),
client_host: "host-1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "member-2".to_string(),
client_id: "client-2".to_string(),
client_host: "host-2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let assignments = assignor.assign(&topics, &partitions, &members);
assert_eq!(assignments.len(), 2);
let member1_parts: Vec<_> = assignments
.get("member-1")
.unwrap()
.all_partitions()
.collect();
let member2_parts: Vec<_> = assignments
.get("member-2")
.unwrap()
.all_partitions()
.collect();
// Each member should have 2 partitions (4 total / 2 members)
assert_eq!(member1_parts.len(), 2);
assert_eq!(member2_parts.len(), 2);
}
#[test]
fn test_cooperative_sticky_assignor_stickiness() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3]);
let members = vec![
GroupMember {
member_id: "member-1".to_string(),
client_id: "client-1".to_string(),
client_host: "host-1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "member-2".to_string(),
client_id: "client-2".to_string(),
client_host: "host-2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
// First assignment
let assignments = assignor.assign(&topics, &partitions, &members);
// Record assignments for stickiness
for (member_id, assignment) in &assignments {
assignor.record_assignment(member_id, assignment);
}
// Assign again with same members - should maintain stickiness
let second_assignments = assignor.assign(&topics, &partitions, &members);
// Assignments should be identical (sticky)
for member_id in ["member-1", "member-2"] {
let first = assignments.get(member_id).unwrap();
let second = second_assignments.get(member_id).unwrap();
assert_eq!(first.partitions, second.partitions);
}
}
#[test]
fn test_cooperative_sticky_assignor_new_member() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3, 4, 5]);
// Initially 2 members
let members_initial = vec![
GroupMember {
member_id: "member-1".to_string(),
client_id: "client-1".to_string(),
client_host: "host-1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "member-2".to_string(),
client_id: "client-2".to_string(),
client_host: "host-2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let initial_assignments = assignor.assign(&topics, &partitions, &members_initial);
// Record assignments
for (member_id, assignment) in &initial_assignments {
assignor.record_assignment(member_id, assignment);
}
// Add a third member
let members_new = vec![
GroupMember {
member_id: "member-1".to_string(),
client_id: "client-1".to_string(),
client_host: "host-1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "member-2".to_string(),
client_id: "client-2".to_string(),
client_host: "host-2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "member-3".to_string(),
client_id: "client-3".to_string(),
client_host: "host-3".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let new_assignments = assignor.assign(&topics, &partitions, &members_new);
// All 3 members should get 2 partitions each (6 / 3 = 2)
for member_id in ["member-1", "member-2", "member-3"] {
let part_count = new_assignments
.get(member_id)
.unwrap()
.all_partitions()
.count();
assert_eq!(part_count, 2, "Member {member_id} should have 2 partitions");
}
}
#[test]
fn test_cooperative_sticky_get_partitions_to_revoke() {
let assignor = CooperativeStickyAssignor::new();
// Record old assignment
let mut old_assignment = MemberAssignment::empty();
old_assignment.add("topic1", vec![0, 1, 2]);
assignor.record_assignment("member-1", &old_assignment);
// New assignment loses partition 2
let mut new_assignment = MemberAssignment::empty();
new_assignment.add("topic1", vec![0, 1]);
let revoked = assignor.get_partitions_to_revoke("member-1", &new_assignment);
assert_eq!(revoked.len(), 1);
assert_eq!(revoked[0], ("topic1".to_string(), 2));
}
#[test]
fn test_heartbeat_controller_signal_rebalance() {
let controller = HeartbeatController::new(Duration::from_secs(3), Duration::from_secs(30));
// Initially no rebalance needed
assert!(
!controller.take_rebalance_needed(),
"initially rebalance_needed should be false"
);
// Signal rebalance
controller.signal_rebalance();
// Flag should now be true
assert!(
controller.take_rebalance_needed(),
"after signal_rebalance(), take_rebalance_needed should return true"
);
}
#[test]
fn test_heartbeat_controller_take_rebalance_needed_resets() {
let controller = HeartbeatController::new(Duration::from_secs(3), Duration::from_secs(30));
controller.signal_rebalance();
// First take should return true
assert!(
controller.take_rebalance_needed(),
"first take_rebalance_needed after signal should return true"
);
// Second take should return false (flag was reset)
assert!(
!controller.take_rebalance_needed(),
"second take_rebalance_needed should return false after reset"
);
// Signal again and verify it works again
controller.signal_rebalance();
assert!(
controller.take_rebalance_needed(),
"take_rebalance_needed should return true again after another signal"
);
}
/// CooperativeSticky rebalancing with uneven partition count.
///
/// With 5 partitions and 3 members, the correct distribution is 2-2-1.
/// Before the fix, stickiness could produce 3-1-1 because the underloaded
/// threshold used min_per_member (floor=1) instead of max_per_member (ceil=2).
#[test]
fn test_cooperative_sticky_uneven_partitions() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3, 4]);
let members = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m3".to_string(),
client_id: "c3".to_string(),
client_host: "h3".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
// Pre-seed sticky assignment to create an imbalanced state:
// m1 has 3 partitions (0,1,2), m2 has 1 (3), m3 has 1 (4)
let mut m1_assignment = MemberAssignment::empty();
m1_assignment.add("topic1", vec![0, 1, 2]);
assignor.record_assignment("m1", &m1_assignment);
let mut m2_assignment = MemberAssignment::empty();
m2_assignment.add("topic1", vec![3]);
assignor.record_assignment("m2", &m2_assignment);
let mut m3_assignment = MemberAssignment::empty();
m3_assignment.add("topic1", vec![4]);
assignor.record_assignment("m3", &m3_assignment);
let assignments = assignor.assign(&topics, &partitions, &members);
// With fix, no member should have more than ceil(5/3) = 2 partitions
for member_id in ["m1", "m2", "m3"] {
let count = assignments.get(member_id).unwrap().all_partitions().count();
assert!(
count <= 2,
"Member {member_id} has {count} partitions, max should be 2"
);
}
// Total partitions should still be 5
let total: usize = ["m1", "m2", "m3"]
.iter()
.map(|m| assignments.get(*m).unwrap().all_partitions().count())
.sum();
assert_eq!(total, 5, "Total partitions should be 5");
}
/// CooperativeSticky with exactly even partition count.
#[test]
fn test_cooperative_sticky_even_partitions() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3, 4, 5]);
let members = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m3".to_string(),
client_id: "c3".to_string(),
client_host: "h3".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let assignments = assignor.assign(&topics, &partitions, &members);
// Each member should have exactly 2 partitions (6/3 = 2)
for member_id in ["m1", "m2", "m3"] {
let count = assignments.get(member_id).unwrap().all_partitions().count();
assert_eq!(
count, 2,
"Member {member_id} should have exactly 2 partitions"
);
}
}
#[test]
fn test_encode_decode_consumer_metadata_v0() {
let coordinator =
test_coordinator(crate::consumer::config::PartitionAssignmentStrategy::Range);
let topics = vec!["topic1".to_string(), "topic2".to_string()];
let owned = HashMap::new();
let encoded = coordinator
.encode_consumer_metadata(&topics, &owned)
.unwrap();
let (decoded_topics, decoded_owned) = GroupCoordinator::decode_consumer_metadata(&encoded);
assert_eq!(decoded_topics, topics);
assert!(decoded_owned.is_empty());
}
#[test]
fn test_encode_decode_consumer_metadata_v1_with_owned() {
let coordinator = test_coordinator(
crate::consumer::config::PartitionAssignmentStrategy::CooperativeSticky,
);
let topics = vec!["topic1".to_string(), "topic2".to_string()];
let mut owned = HashMap::new();
owned.insert("topic1".to_string(), vec![0, 1, 2]);
owned.insert("topic2".to_string(), vec![0]);
let encoded = coordinator
.encode_consumer_metadata(&topics, &owned)
.unwrap();
let (decoded_topics, decoded_owned) = GroupCoordinator::decode_consumer_metadata(&encoded);
assert_eq!(decoded_topics, topics);
assert_eq!(decoded_owned.len(), 2);
assert_eq!(decoded_owned.get("topic1").unwrap(), &vec![0, 1, 2]);
assert_eq!(decoded_owned.get("topic2").unwrap(), &vec![0]);
}
#[test]
fn test_encode_decode_consumer_metadata_v1_empty_owned() {
let coordinator = test_coordinator(
crate::consumer::config::PartitionAssignmentStrategy::CooperativeSticky,
);
let topics = vec!["topic1".to_string()];
let owned = HashMap::new();
let encoded = coordinator
.encode_consumer_metadata(&topics, &owned)
.unwrap();
let (decoded_topics, decoded_owned) = GroupCoordinator::decode_consumer_metadata(&encoded);
assert_eq!(decoded_topics, vec!["topic1".to_string()]);
assert!(decoded_owned.is_empty());
}
#[test]
fn test_decode_consumer_metadata_empty() {
let (topics, owned) = GroupCoordinator::decode_consumer_metadata(&[]);
assert!(topics.is_empty());
assert!(owned.is_empty());
}
#[test]
fn test_decode_consumer_metadata_truncated() {
// Only version byte, no topics
let (topics, owned) = GroupCoordinator::decode_consumer_metadata(&[0, 0]);
assert!(topics.is_empty());
assert!(owned.is_empty());
}
#[test]
fn test_cooperative_sticky_record_and_revoke_across_rebalances() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3, 4, 5]);
// Round 1: 2 members
let members = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let round1 = assignor.assign(&topics, &partitions, &members);
for (mid, assignment) in &round1 {
assignor.record_assignment(mid, assignment);
}
// Each member gets 3 partitions
assert_eq!(round1.get("m1").unwrap().all_partitions().count(), 3);
assert_eq!(round1.get("m2").unwrap().all_partitions().count(), 3);
// Round 2: 3 members (m3 joins)
let members3 = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m3".to_string(),
client_id: "c3".to_string(),
client_host: "h3".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let round2 = assignor.assign(&topics, &partitions, &members3);
// Each member gets 2 partitions (6/3)
for mid in ["m1", "m2", "m3"] {
assert_eq!(
round2.get(mid).unwrap().all_partitions().count(),
2,
"Member {mid} should have 2 partitions after rebalance"
);
}
// m1 and m2 should have been revoked 1 partition each
let m1_revoke = assignor.get_partitions_to_revoke("m1", round2.get("m1").unwrap());
let m2_revoke = assignor.get_partitions_to_revoke("m2", round2.get("m2").unwrap());
assert_eq!(m1_revoke.len(), 1, "m1 should revoke 1 partition");
assert_eq!(m2_revoke.len(), 1, "m2 should revoke 1 partition");
}
#[test]
fn test_cooperative_sticky_member_leaves() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["topic1".to_string()];
let mut partitions = HashMap::new();
partitions.insert("topic1".to_string(), vec![0, 1, 2, 3, 4, 5]);
// Round 1: 3 members
let members3 = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m3".to_string(),
client_id: "c3".to_string(),
client_host: "h3".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let round1 = assignor.assign(&topics, &partitions, &members3);
for (mid, a) in &round1 {
assignor.record_assignment(mid, a);
}
// 2 each
for mid in ["m1", "m2", "m3"] {
assert_eq!(round1.get(mid).unwrap().all_partitions().count(), 2);
}
// m3 leaves
assignor.clear_member("m3");
let members2 = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let round2 = assignor.assign(&topics, &partitions, &members2);
// Each remaining member gets 3 (6/2)
assert_eq!(round2.get("m1").unwrap().all_partitions().count(), 3);
assert_eq!(round2.get("m2").unwrap().all_partitions().count(), 3);
// m1 should NOT have any revocations (only gains)
let m1_revoke = assignor.get_partitions_to_revoke("m1", round2.get("m1").unwrap());
assert!(
m1_revoke.is_empty(),
"m1 should not revoke anything when gaining partitions"
);
}
#[test]
fn test_cooperative_sticky_no_revocations_same_assignment() {
let assignor = CooperativeStickyAssignor::new();
let mut assignment = MemberAssignment::empty();
assignment.add("topic1", vec![0, 1]);
assignor.record_assignment("m1", &assignment);
// Same assignment → no revocations
let to_revoke = assignor.get_partitions_to_revoke("m1", &assignment);
assert!(to_revoke.is_empty());
}
#[test]
fn test_cooperative_sticky_revoke_unknown_member() {
let assignor = CooperativeStickyAssignor::new();
let assignment = MemberAssignment::empty();
let to_revoke = assignor.get_partitions_to_revoke("unknown", &assignment);
assert!(to_revoke.is_empty());
}
#[test]
fn test_is_cooperative() {
let range = test_coordinator(crate::consumer::config::PartitionAssignmentStrategy::Range);
assert!(!range.is_cooperative());
let cooperative = test_coordinator(
crate::consumer::config::PartitionAssignmentStrategy::CooperativeSticky,
);
assert!(cooperative.is_cooperative());
}
#[test]
fn test_cooperative_sticky_multi_topic_assignment() {
let assignor = CooperativeStickyAssignor::new();
let topics = vec!["t1".to_string(), "t2".to_string()];
let mut partitions = HashMap::new();
partitions.insert("t1".to_string(), vec![0, 1, 2]);
partitions.insert("t2".to_string(), vec![0, 1, 2]);
let members = vec![
GroupMember {
member_id: "m1".to_string(),
client_id: "c1".to_string(),
client_host: "h1".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
GroupMember {
member_id: "m2".to_string(),
client_id: "c2".to_string(),
client_host: "h2".to_string(),
metadata: bytes::Bytes::new(),
assignment: bytes::Bytes::new(),
},
];
let assignments = assignor.assign(&topics, &partitions, &members);
// 6 total partitions / 2 members = 3 each
let m1_total = assignments.get("m1").unwrap().all_partitions().count();
let m2_total = assignments.get("m2").unwrap().all_partitions().count();
assert_eq!(m1_total, 3);
assert_eq!(m2_total, 3);
assert_eq!(m1_total + m2_total, 6);
}
#[test]
fn test_cooperative_sticky_revoke_across_topics() {
let assignor = CooperativeStickyAssignor::new();
// Old assignment: m1 has t1-[0,1] and t2-[0]
let mut old = MemberAssignment::empty();
old.add("t1", vec![0, 1]);
old.add("t2", vec![0]);
assignor.record_assignment("m1", &old);
// New assignment: m1 only has t1-[0]
let mut new_a = MemberAssignment::empty();
new_a.add("t1", vec![0]);
let revoked = assignor.get_partitions_to_revoke("m1", &new_a);
assert_eq!(revoked.len(), 2);
let mut sorted = revoked.clone();
sorted.sort();
assert!(sorted.contains(&("t1".to_string(), 1)));
assert!(sorted.contains(&("t2".to_string(), 0)));
}
#[test]
fn test_decode_consumer_metadata_overcounted_partitions() {
// Build v1 metadata where owned partitions claim 5000 entries
// but only 3 fit in the buffer. The safe loop bound must cap iteration
// based on remaining bytes (5000 is within the hard cap of 10,000).
let mut buf = BytesMut::new();
buf.put_i16(1); // version 1
buf.put_i32(1); // 1 subscribed topic
let topic = b"sub";
buf.put_i16(i16::try_from(topic.len()).unwrap());
buf.put_slice(topic);
buf.put_i32(-1); // no user data
// Owned partitions section
buf.put_i32(1); // 1 owned topic
let owned_topic = b"test";
buf.put_i16(i16::try_from(owned_topic.len()).unwrap());
buf.put_slice(owned_topic);
buf.put_i32(5_000); // claim 5000 partitions
buf.put_i32(0); // only 3 actual partition values
buf.put_i32(1);
buf.put_i32(2);
let (topics, owned) = GroupCoordinator::decode_consumer_metadata(&buf);
assert_eq!(topics, vec!["sub".to_string()]);
// Should decode only the 3 partitions that fit, not spin 1M times
let parts = owned.get("test").unwrap();
assert_eq!(parts, &[0, 1, 2]);
}
#[test]
fn test_cooperative_sticky_record_after_no_revocation_rebalance() {
// Simulates the no-revocation path: after sync, the caller records
// the final assignment. Verify that the next get_partitions_to_revoke
// uses it correctly.
let assignor = CooperativeStickyAssignor::new();
// Simulate first rebalance result (no prior state)
let mut first = MemberAssignment::empty();
first.add("t1", vec![0, 1, 2]);
// Caller records final assignment (as the poll loop now does)
assignor.record_assignment("m1", &first);
// Verify owned state was persisted
let prev = assignor.previous_assignments.read();
assert_eq!(prev.get("m1").unwrap().get("t1").unwrap(), &vec![0, 1, 2]);
drop(prev);
// Second rebalance: some partitions moved away
let mut second = MemberAssignment::empty();
second.add("t1", vec![0, 1]); // partition 2 moved
let revoked = assignor.get_partitions_to_revoke("m1", &second);
assert_eq!(revoked, vec![("t1".to_string(), 2)]);
}
}