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
// Copyright (c) 2025 moshpit developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.
use std::{
collections::{BTreeMap, HashMap},
io::Cursor,
net::SocketAddr,
process,
sync::{
Arc, Mutex,
atomic::{AtomicU64, Ordering},
},
time::{Duration, Instant, SystemTime, UNIX_EPOCH},
};
use ansi_control_codes::{
c0, c1,
parser::{Token, TokenStream},
};
use anyhow::Result;
use aws_lc_rs::{aead::LessSafeKey, hmac::Key};
use bon::Builder;
use bytes::BytesMut;
use tokio::{
net::UdpSocket,
select,
sync::{mpsc::Sender, oneshot},
time::{Instant as TokioInstant, sleep, sleep_until},
};
use tokio_util::sync::CancellationToken;
use tracing::{debug, error, info, warn};
use uuid::Uuid;
use zstd::decode_all;
use super::DiffMode;
use crate::{
Emulator, EncryptedFrame, MoshpitError, PredictionEngine, Renderer, TerminalMessage,
UuidWrapper, paint_overlays_to_ansi, udp::sender::RETRANSMIT_WINDOW, utils::is_exit_title,
};
/// Floor for the adaptive NAK check interval. On LAN paths where `nak_timeout`
/// converges to [`MIN_NAK_TIMEOUT`] (20 ms), the check fires every 5 ms; on
/// high-latency paths (500 ms) it fires every 125 ms, saving CPU and state-machine
/// churn. Formula: `max(nak_timeout / 4, MIN_NAK_CHECK_INTERVAL)`.
const MIN_NAK_CHECK_INTERVAL: Duration = Duration::from_millis(5);
/// Minimum delay before requesting retransmission of a missing packet.
const NAK_TIMEOUT: Duration = Duration::from_millis(50);
/// Maximum backoff cap for repeated NAK retries (50 * 2^4 = 800 ms).
const NAK_BACKOFF_MAX_SHIFT: u32 = 4;
/// Maximum number of NAK retries before giving up on a permanently lost packet.
const MAX_NAK_RETRIES: u32 = 4;
/// Number of NAK retries after which the client sends a [`EncryptedFrame::RepaintRequest`]
/// to the server. Fires exactly once per gap (when retry count reaches this value),
/// asking for an out-of-band full-screen snapshot to unblock the display without waiting
/// for retransmit to succeed or retry exhaustion.
const REPAINT_REQUEST_THRESHOLD: u32 = 1;
/// Number of frames buffered out-of-order before an immediate [`EncryptedFrame::RepaintRequest`]
/// is sent. A large `recv_buffer` means many gaps exist simultaneously — the display is
/// stalled. Firing early skips waiting for the first NAK retry cycle (~50 ms).
/// Set to 5 so that high-output programs (htop, vim) trigger fast repaint recovery
/// before a large backlog accumulates; at 1200 bytes/frame, 5 frames ≈ 6 KB of stall.
const RECV_BUFFER_REPAINT_THRESHOLD: usize = 5;
/// Maximum sequence jump allowed before dropping the frame to prevent `DoS`.
const MAX_SEQ_JUMP: u64 = 1024;
/// Floor for the adaptive NAK timeout EWMA estimate.
const MIN_NAK_TIMEOUT: Duration = Duration::from_millis(20);
/// Ceiling for the adaptive NAK timeout EWMA estimate.
const MAX_NAK_TIMEOUT: Duration = Duration::from_millis(500);
/// UDP reader for encrypted frames
#[derive(Builder, Debug)]
pub struct UdpReader {
/// Underlying UDP socket
socket: Arc<UdpSocket>,
/// Client UUID
id: Uuid,
/// Key for decrypting UDP packets
rnk: LessSafeKey,
/// Key for verifying UDP packet HMAC
hmac: Key,
/// Byte length of the MAC tag written by the peer's HMAC algorithm.
/// 64 for HMAC-SHA512 (default), 32 for HMAC-SHA256.
#[builder(default = 64)]
mac_tag_len: usize,
/// Injects NAK frames into the outbound stream when gaps are detected
nak_out_tx: Option<Sender<EncryptedFrame>>,
/// Tells the local sender to retransmit when a NAK from the peer is received
retransmit_tx: Option<Sender<Vec<u64>>>,
/// Next expected sequence number
#[builder(default)]
next_seq: u64,
/// Out-of-order frames waiting for missing predecessors
#[builder(default)]
recv_buffer: BTreeMap<u64, EncryptedFrame>,
/// Tracks when each gap was first detected for NAK timeout
#[builder(default)]
gap_first_seen: HashMap<u64, Instant>,
/// Number of NAK retries per gap, used to give up on permanently lost packets
#[builder(default)]
gap_nak_count: HashMap<u64, u32>,
/// Per-gap NAK send timestamps for RTT measurement. Populated when a NAK is
/// sent; consumed when the gap closes to produce a round-trip sample for the
/// adaptive EWMA.
#[builder(default)]
gap_nak_sent_at: HashMap<u64, Instant>,
/// Highest sequence number ever received (excluding duplicates).
/// Used to detect when a gap has fallen outside the sender's retransmit
/// window so the client can give up immediately instead of waiting for
/// [`MAX_NAK_RETRIES`] retries.
#[builder(default)]
highest_seq_seen: u64,
/// Jacobson-Karels smoothed RTT (SRTT), RFC 6298 §2.
/// `None` until the first NAK round-trip sample is observed.
srtt: Option<Duration>,
/// Jacobson-Karels RTT variance (RTTVAR), RFC 6298 §2.
/// `None` until the first NAK round-trip sample is observed.
rttvar: Option<Duration>,
/// Retransmission timeout (RTO) derived from the Jacobson-Karels estimator:
/// `RTO = SRTT + 4 × RTTVAR`, clamped to [`MIN_NAK_TIMEOUT`]..=[`MAX_NAK_TIMEOUT`].
/// `None` falls back to [`NAK_TIMEOUT`] (50 ms).
nak_timeout: Option<Duration>,
/// If no frame is received within this duration the server is assumed unreachable.
/// Triggers reconnect via [`reconnect_tx`](Self::reconnect_tx) when set, otherwise calls
/// [`process::exit`].
silence_timeout: Option<Duration>,
/// Signals the caller that the server connection was lost and a reconnect should
/// be attempted. When absent, connection loss falls back to [`process::exit`].
reconnect_tx: Option<Sender<()>>,
/// Used by the client to send immediate responses to terminal queries (DSR/DA)
/// that arrive from the server, without routing them through the local terminal.
/// Prevents latency-induced query responses from appearing as keyboard input.
query_response_tx: Option<Sender<EncryptedFrame>>,
/// Foreground color returned for OSC 10 queries from the server shell.
/// Format: `rgb:RRRR/GGGG/BBBB`. Defaults to a light-gray when `None`.
terminal_fg_color: Option<String>,
/// Background color returned for OSC 11 queries from the server shell.
/// Format: `rgb:RRRR/GGGG/BBBB`. Defaults to a dark background when `None`.
terminal_bg_color: Option<String>,
/// Oneshot sender fired after the server has discovered the client's real post-NAT
/// address via the first `recv_from`. Carries the initial peer `SocketAddr` so
/// that [`UdpSender`](crate::UdpSender) knows where to send before any roam event.
peer_discovered_tx: Option<oneshot::Sender<SocketAddr>>,
/// Signals mid-session NAT roam events to [`UdpSender`](crate::UdpSender).
/// Sent whenever an authenticated packet arrives from a new source address.
peer_addr_tx: Option<Sender<SocketAddr>>,
/// Fired by the server's [`server_frame_loop`](Self::server_frame_loop) when a
/// [`EncryptedFrame::RepaintRequest`] arrives from the client. The paired receiver
/// is held by a task in `moshpits` that responds with an immediate
/// [`EncryptedFrame::ScreenState`].
repaint_tx: Option<Sender<()>>,
/// Running count of [`EncryptedFrame::Nak`] frames received from the client
/// (server mode only). The proactive-repaint watchdog in `moshpits` polls this
/// counter every 200 ms; when the delta exceeds the saturation threshold a full
/// [`EncryptedFrame::ScreenStateCompressed`] is pushed without waiting for an
/// explicit [`EncryptedFrame::RepaintRequest`] that might itself be lost.
nak_received_count: Option<Arc<AtomicU64>>,
/// UDP diff transport mode for this session.
/// In `Datagram` or `StateSync` mode the reorder buffer, gap tracking, and NAK
/// sending are all disabled — frames are delivered immediately in arrival order.
#[builder(default)]
diff_mode: DiffMode,
/// Client-mode `StateSync` state: the `contents_formatted()` snapshot of the
/// client's screen at the point the last `StateSyncDiff` was applied.
/// Empty before any diff is applied.
#[builder(default)]
ack_state: Vec<u8>,
/// The `diff_id` of the last `StateSyncDiff` the client successfully applied.
/// Zero before any diff is applied. Used to validate incoming `base_id` fields.
#[builder(default)]
ack_state_seq: u64,
/// Count of consecutive `StateSyncDiff` frames discarded due to `base_id` mismatch.
/// When this reaches 3, the client sends a `RepaintRequest` and the counter resets.
#[builder(default)]
statesync_mismatch_count: u32,
/// True once the client has received and processed the first complete full-state push
/// (`ScreenStateCompressed` or a complete `StateChunk` assembly) in `StateSync` mode.
/// Guards `StateSyncDiff` from being applied to a blank initial state when the initial
/// full-state push is dropped by a NAT device.
#[builder(default)]
initial_state_received: bool,
/// Total chunk count for the in-progress `StateChunk` assembly. Zero = no assembly active.
#[builder(default)]
pending_chunk_total: u16,
/// Next expected `seq` value for the in-progress `StateChunk` assembly.
#[builder(default)]
pending_chunk_seq: u16,
/// Accumulated payload bytes from the in-progress `StateChunk` assembly.
#[builder(default)]
pending_chunk_data: Vec<u8>,
/// Server-mode: channel for forwarding `ClientAck(diff_id)` values from the UDP
/// receive loop to the state-sync task in `moshpits/src/runtime.rs`, which uses
/// them to advance the server's ack baseline.
client_ack_tx: Option<Sender<u64>>,
/// Timestamp (µs since UNIX epoch) of the last authenticated UDP frame received from
/// the peer. Updated on every successful parse in server mode. The server-side silence
/// watchdog in `moshpits` polls this counter and cancels zombie connections after 30 s
/// of client silence.
last_rx_us: Option<Arc<AtomicU64>>,
}
/// Current time as microseconds since the UNIX epoch, used for keepalive RTT timestamps.
fn now_micros() -> u64 {
u64::try_from(
SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap_or_default()
.as_micros(),
)
.unwrap_or(0)
}
impl UdpReader {
/// Return a clone of the shared last-receive-time counter, if set.
#[must_use]
pub fn last_rx_us(&self) -> Option<Arc<AtomicU64>> {
self.last_rx_us.clone()
}
/// Signal the reconnect channel if set; otherwise exit the process.
fn signal_reconnect_or_exit(&self, code: i32) {
if let Some(ref tx) = self.reconnect_tx {
let _ = tx.try_send(());
} else {
process::exit(code);
}
}
/// Feed a NAK→retransmit round-trip sample into the Jacobson-Karels estimator
/// (RFC 6298 §2) and update the derived RTO.
///
/// **First measurement:**
/// - `SRTT = sample`
/// - `RTTVAR = sample / 2`
///
/// **Subsequent measurements:**
/// - `RTTVAR = (3/4) × RTTVAR + (1/4) × |SRTT − sample|`
/// - `SRTT = (7/8) × SRTT + (1/8) × sample`
///
/// **RTO** (stored as `nak_timeout`):
/// - `RTO = SRTT + 4 × RTTVAR`, clamped to
/// [`MIN_NAK_TIMEOUT`]..=[`MAX_NAK_TIMEOUT`].
///
/// Also derives an updated [`Self::silence_timeout`] from the new RTO when
/// one was previously set (client mode). Formula:
/// `max(rto × 30, 9 s)` — with a 3 s server keepalive this guarantees ≥ 3
/// keepalives arrive before the silence window closes.
fn update_rtt_estimate(&mut self, sample: Duration) {
// Clamp samples that exceed 8× the current RTO to the ceiling value rather
// than discarding them outright. Pure discard causes a death spiral when
// nak_timeout has converged to MIN_NAK_TIMEOUT (20 ms → ceiling = 160 ms):
// every congestion-induced RTT spike is rejected, the estimator stays stuck at
// the minimum, and aggressive 20 ms NAKs worsen NAT congestion indefinitely.
// Clamping feeds a bounded signal into the estimator so nak_timeout can grow
// upward and the system self-heals within 2–3 keepalive intervals.
let ceiling = self.nak_timeout.unwrap_or(NAK_TIMEOUT) * 8;
let sample = if sample > ceiling {
debug!(
"NAK RTT sample {:?} exceeds outlier ceiling {:?} — clamping",
sample, ceiling
);
ceiling
} else {
sample
};
let (new_srtt, new_rttvar) = match (self.srtt, self.rttvar) {
// First measurement (RFC 6298 §2.2).
(None, _) | (_, None) => (sample, sample / 2),
// Subsequent measurements (RFC 6298 §2.3).
(Some(srtt), Some(rttvar)) => {
let diff = srtt
.checked_sub(sample)
.unwrap_or_else(|| sample.checked_sub(srtt).unwrap_or_default());
let new_rttvar = rttvar.saturating_sub(rttvar / 4) + diff / 4;
let new_srtt = srtt.saturating_sub(srtt / 8) + sample / 8;
(new_srtt, new_rttvar)
}
};
// RTO = SRTT + 4 × RTTVAR, clamped to the allowed range.
let rto = (new_srtt + new_rttvar * 4).clamp(MIN_NAK_TIMEOUT, MAX_NAK_TIMEOUT);
debug!(
"NAK RTT sample {:?} → srtt {:?} rttvar {:?} rto {:?}",
sample, new_srtt, new_rttvar, rto
);
self.srtt = Some(new_srtt);
self.rttvar = Some(new_rttvar);
self.nak_timeout = Some(rto);
// Only update silence_timeout when it was explicitly initialised
// (client mode). Servers leave it None so this remains a no-op there.
if self.silence_timeout.is_some() {
self.silence_timeout = Some((rto * 30).max(Duration::from_secs(9)));
}
}
/// Compute the adaptive NAK check interval from the current RTT estimate.
///
/// Formula: `max(nak_timeout / 4, MIN_NAK_CHECK_INTERVAL)`.
fn nak_check_interval(&self) -> Duration {
(self.nak_timeout.unwrap_or(NAK_TIMEOUT) / 4).max(MIN_NAK_CHECK_INTERVAL)
}
/// Intercept terminal queries in bytes arriving from the server, respond
/// immediately via [`Self::query_response_tx`], and strip them from stdout.
///
/// Intercepted CSI queries: DSR (`ESC[6n`), Primary/Secondary/Tertiary DA.
/// Intercepted OSC queries: color queries 10, 11, 12 (`ESC]N;?ST`).
///
/// Also normalises VT (0x0B) and FF (0x0C) to CR+LF.
fn intercept_queries(&self, bytes: &[u8], emulator: &Arc<Mutex<Emulator>>) -> Vec<u8> {
if !bytes.contains(&0x1b) && !bytes.contains(&0x0b) && !bytes.contains(&0x0c) {
return bytes.to_vec();
}
let fg = self
.terminal_fg_color
.as_deref()
.unwrap_or("rgb:d0d0/d0d0/d0d0");
let bg = self
.terminal_bg_color
.as_deref()
.unwrap_or("rgb:1c1c/1c1c/1c1c");
let mut out = Vec::with_capacity(bytes.len());
let mut i = 0;
while i < bytes.len() {
if bytes[i] == 0x0b || bytes[i] == 0x0c {
out.push(b'\r');
out.push(b'\n');
i += 1;
continue;
}
if bytes[i] != 0x1b || i + 1 >= bytes.len() {
out.push(bytes[i]);
i += 1;
continue;
}
match bytes[i + 1] {
b'[' => self.handle_csi(bytes, &mut i, &mut out, emulator),
b']' => self.handle_osc(bytes, &mut i, &mut out, fg, bg),
_ => {
out.push(bytes[i]);
i += 1;
}
}
}
out
}
/// Handle one CSI sequence starting at `bytes[*i]` (`ESC [`).
/// Advances `*i` past the sequence; appends passthrough bytes to `out`;
/// sends recognised query responses via `query_response_tx`.
fn handle_csi(
&self,
bytes: &[u8],
i: &mut usize,
out: &mut Vec<u8>,
emulator: &Arc<Mutex<Emulator>>,
) {
let seq_start = *i;
*i += 2; // consume ESC [
let marker = if *i < bytes.len() && matches!(bytes[*i], b'?' | b'>' | b'=') {
let m = bytes[*i];
*i += 1;
Some(m)
} else {
None
};
let param_start = *i;
while *i < bytes.len() && (bytes[*i].is_ascii_digit() || bytes[*i] == b';') {
*i += 1;
}
let params = &bytes[param_start..*i];
if *i >= bytes.len() {
out.extend_from_slice(&bytes[seq_start..*i]);
return;
}
let terminator = bytes[*i];
*i += 1;
let response: Option<Vec<u8>> = match (marker, params, terminator) {
(None | Some(b'?'), b"6", b'n') => {
let (row, col) = emulator
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner)
.screen()
.cursor_position();
Some(format!("\x1b[{};{}R", row + 1, col + 1).into_bytes())
}
(None, b"" | b"0", b'c') => Some(b"\x1b[?62c".to_vec()),
(Some(b'>'), b"" | b"0", b'c') => Some(b"\x1b[>1;10;0c".to_vec()),
(Some(b'='), b"" | b"0", b'c') => Some(b"\x1bP!|00000000\x1b\\".to_vec()),
_ => {
out.extend_from_slice(&bytes[seq_start..*i]);
None
}
};
if let Some(resp) = response
&& let Some(ref tx) = self.query_response_tx
{
let frame = EncryptedFrame::Bytes((UuidWrapper::new(self.id), resp));
if let Err(e) = tx.try_send(frame) {
warn!("Failed to send CSI query response: {e}");
}
}
}
/// Handle one OSC sequence starting at `bytes[*i]` (`ESC ]`).
/// Intercepts OSC 10/11/12 color queries and responds with BEL-terminated
/// canned color strings. All other OSC sequences pass through unchanged.
///
/// **BEL termination** (`\x07`) is used deliberately instead of ST (`\e\\`).
/// When the response is forwarded to the remote shell's stdin, fish's readline
/// would otherwise consume the `\e` of `\e\\` as the start of an escape
/// sequence and leave the trailing `\` as a literal character in the input
/// buffer — causing it to appear before the next key typed (e.g. `\p`).
fn handle_osc(&self, bytes: &[u8], i: &mut usize, out: &mut Vec<u8>, fg: &str, bg: &str) {
let seq_start = *i;
*i += 2; // consume ESC ]
let param_start = *i;
let mut osc_params: Option<&[u8]> = None;
while *i < bytes.len() {
if bytes[*i] == 0x07 {
osc_params = Some(&bytes[param_start..*i]);
*i += 1;
break;
}
if bytes[*i] == 0x1b && *i + 1 < bytes.len() && bytes[*i + 1] == b'\\' {
osc_params = Some(&bytes[param_start..*i]);
*i += 2;
break;
}
*i += 1;
}
let Some(params) = osc_params else {
out.extend_from_slice(&bytes[seq_start..*i]);
return;
};
let response: Option<Vec<u8>> = params.strip_suffix(b";?").and_then(|cmd| match cmd {
b"10" => Some(format!("\x1b]10;{fg}\x07").into_bytes()),
b"11" => Some(format!("\x1b]11;{bg}\x07").into_bytes()),
b"12" => Some(format!("\x1b]12;{fg}\x07").into_bytes()),
_ => None,
});
match response {
Some(resp) => {
if let Some(ref tx) = self.query_response_tx {
let frame = EncryptedFrame::Bytes((UuidWrapper::new(self.id), resp));
if let Err(e) = tx.try_send(frame) {
warn!("Failed to send OSC query response: {e}");
}
}
}
None => out.extend_from_slice(&bytes[seq_start..*i]),
}
}
/// Buffer an arrived `(frame, seq)` pair and return any frames now ready to deliver
/// in order. NAK frames are routed to the retransmit channel inline and are not
/// included in the returned `Vec`; they still participate in sequence tracking.
#[cfg_attr(nightly, allow(clippy::too_many_lines))]
fn handle_arrival(&mut self, frame: EncryptedFrame, seq: u64) -> Vec<EncryptedFrame> {
// Duplicate or replay
if seq < self.next_seq {
return vec![];
}
// In Datagram or StateSync mode: skip reorder buffering and gap tracking
// entirely. Deliver the frame immediately regardless of arrival order,
// advance next_seq past any gap, and never send NAKs or RepaintRequests.
// ScreenState frames are still delivered through the fast path below.
if self.diff_mode == DiffMode::Datagram || self.diff_mode == DiffMode::StateSync {
self.next_seq = seq + 1;
return self.route_or_deliver(frame).into_iter().collect();
}
// Prevent DoS memory exhaustion from an adversarial massive sequence jump.
if seq > self.next_seq + MAX_SEQ_JUMP {
warn!(
"Dropping frame with sequence {seq} jumping too far ahead of {}",
self.next_seq
);
return vec![];
}
// Track the furthest sequence we have ever seen. Used by
// check_nak_timeouts to detect when a gap has fallen outside the
// sender's retransmit window.
if seq > self.highest_seq_seen {
self.highest_seq_seen = seq;
}
if seq == self.next_seq {
self.next_seq += 1;
let _removed = self.gap_first_seen.remove(&seq);
let _removed = self.gap_nak_count.remove(&seq);
if let Some(t) = self.gap_nak_sent_at.remove(&seq) {
self.update_rtt_estimate(t.elapsed());
}
let mut ready = Vec::new();
// NAK frames are consumed inline; all others are returned to the caller.
if let Some(f) = self.route_or_deliver(frame) {
ready.push(f);
}
// Drain consecutive buffered frames
while let Some(buffered) = self.recv_buffer.remove(&self.next_seq) {
let _removed = self.gap_first_seen.remove(&self.next_seq);
let _removed = self.gap_nak_count.remove(&self.next_seq);
if let Some(t) = self.gap_nak_sent_at.remove(&self.next_seq) {
self.update_rtt_estimate(t.elapsed());
}
self.next_seq += 1;
if let Some(f) = self.route_or_deliver(buffered) {
ready.push(f);
}
}
ready
} else {
// A ScreenState is a complete screen snapshot — it obsoletes every
// preceding diff. Deliver it immediately by discarding all pending
// gaps and buffered frames with sequence numbers below `seq`, then
// drain any already-buffered frames that follow it in order.
if matches!(
frame,
EncryptedFrame::ScreenState(_) | EncryptedFrame::ScreenStateCompressed(_)
) {
for obsolete in self.next_seq..seq {
let _removed = self.recv_buffer.remove(&obsolete);
let _removed = self.gap_first_seen.remove(&obsolete);
let _removed = self.gap_nak_count.remove(&obsolete);
let _removed = self.gap_nak_sent_at.remove(&obsolete);
}
let _removed = self.gap_first_seen.remove(&seq);
let _removed = self.gap_nak_count.remove(&seq);
let _removed = self.gap_nak_sent_at.remove(&seq);
self.next_seq = seq + 1;
let mut ready = Vec::new();
if let Some(f) = self.route_or_deliver(frame) {
ready.push(f);
}
while let Some(buffered) = self.recv_buffer.remove(&self.next_seq) {
let _removed = self.gap_first_seen.remove(&self.next_seq);
let _removed = self.gap_nak_count.remove(&self.next_seq);
if let Some(t) = self.gap_nak_sent_at.remove(&self.next_seq) {
self.update_rtt_estimate(t.elapsed());
}
self.next_seq += 1;
if let Some(f) = self.route_or_deliver(buffered) {
ready.push(f);
}
}
return ready;
}
// Out of order: buffer the frame and record any new gaps.
//
// The arriving packet is no longer missing — remove it from gap
// tracking in case it was recorded as a false gap by an earlier
// out-of-order arrival.
let _prev = self.recv_buffer.insert(seq, frame);
let _removed = self.gap_first_seen.remove(&seq);
let _removed = self.gap_nak_count.remove(&seq);
// If the buffer has grown large, the display is stalled behind many simultaneous
// gaps. Send an immediate RepaintRequest instead of waiting for the first NAK
// retry cycle to elapse (~50 ms).
if self.recv_buffer.len() >= RECV_BUFFER_REPAINT_THRESHOLD
&& let Some(ref tx) = self.nak_out_tx
&& let Err(e) = tx.try_send(EncryptedFrame::RepaintRequest)
{
warn!("Failed to send early RepaintRequest: {e}");
}
// Only register positions that are genuinely absent — positions
// already in recv_buffer will be delivered automatically once the
// earlier gap is filled, so NAKing for them wastes bandwidth and
// generates misleading "giving up" warnings.
let now = Instant::now();
let mut new_gaps = Vec::new();
for missing in self.next_seq..seq {
if !self.recv_buffer.contains_key(&missing) {
match self.gap_first_seen.entry(missing) {
std::collections::hash_map::Entry::Vacant(e) => {
let _ = e.insert(now);
new_gaps.push(missing);
}
std::collections::hash_map::Entry::Occupied(_) => {}
}
}
}
// Send an immediate NAK for newly-discovered gaps without waiting for the
// periodic check interval. Retries and backoff are still managed by
// check_nak_timeouts; this only eliminates the first-NAK delay (up to
// NAK_CHECK_INTERVAL + nak_timeout ≈ 70 ms on the default config).
//
// Also send a RepaintRequest alongside the NAK when recv_buffer already
// holds frames (len > 1 because we just inserted the current frame):
// for high-output programs (htop, top, vim) a single lost chunk blocks
// the entire remaining burst in recv_buffer. Retransmit alone costs
// nak_timeout (20–500 ms) before the first retry fires. The
// RepaintRequest lets the server bypass the gap with a fresh
// ScreenStateCompressed within one RTT instead. The recv_buffer guard
// avoids triggering on a lone reorder that resolves without intervention.
if !new_gaps.is_empty() {
for &s in &new_gaps {
let _prev = self.gap_nak_sent_at.insert(s, now);
}
if let Some(ref tx) = self.nak_out_tx {
if let Err(e) = tx.try_send(EncryptedFrame::Nak(new_gaps)) {
warn!("Failed to send immediate NAK for new gaps: {e}");
}
if self.recv_buffer.len() > 1
&& let Err(e) = tx.try_send(EncryptedFrame::RepaintRequest)
{
warn!("Failed to send burst-gap RepaintRequest: {e}");
}
}
}
vec![]
}
}
/// Route a NAK frame to the retransmit channel (consuming it and returning
/// `None`), or pass any other frame through as `Some(frame)`.
///
/// Centralising routing here means NAK frames always participate in the
/// normal sequence-ordering logic — the original bug was that `handle_arrival`
/// returned early for NAKs before incrementing `next_seq`, creating a
/// permanent false gap at the NAK's sequence position and a NAK storm.
fn route_or_deliver(&self, frame: EncryptedFrame) -> Option<EncryptedFrame> {
if let EncryptedFrame::Nak(ref seqs) = frame {
if let Some(ref tx) = self.retransmit_tx
&& let Err(e) = tx.try_send(seqs.clone())
{
warn!("Failed to forward retransmit request: {e}");
}
if let Some(ref counter) = self.nak_received_count {
let _ = counter.fetch_add(1, Ordering::Relaxed);
}
return None;
}
Some(frame)
}
/// Collect sequences to give up on (exceeded retries or outside retransmit window),
/// remove their tracking state, advance `next_seq` past them, and return any frames
/// that become deliverable as a result.
fn drain_given_up_seqs(&mut self) -> Vec<EncryptedFrame> {
let retry_give_up = self
.gap_nak_count
.iter()
.filter_map(|(&seq, &count)| (count >= MAX_NAK_RETRIES).then_some(seq));
// When the server has sent RETRANSMIT_WINDOW more packets past a gap it has
// already evicted the lost packet; retransmit requests will silently fail.
let window_give_up = self
.gap_first_seen
.keys()
.filter(|&&seq| self.highest_seq_seen.saturating_sub(seq) > RETRANSMIT_WINDOW)
.copied();
let give_up_set: std::collections::HashSet<u64> =
retry_give_up.chain(window_give_up).collect();
if give_up_set.is_empty() {
return vec![];
}
for &seq in &give_up_set {
if self
.gap_nak_count
.get(&seq)
.is_some_and(|&c| c >= MAX_NAK_RETRIES)
{
warn!("Giving up on packet {seq} after {MAX_NAK_RETRIES} NAK retries");
} else {
warn!(
"Giving up on packet {seq}: outside sender retransmit window \
(highest_seen={})",
self.highest_seq_seen
);
}
let _r = self.gap_first_seen.remove(&seq);
let _r = self.gap_nak_count.remove(&seq);
let _r = self.gap_nak_sent_at.remove(&seq);
}
let mut delivered = vec![];
loop {
if give_up_set.contains(&self.next_seq) {
self.next_seq += 1;
} else if let Some(buffered) = self.recv_buffer.remove(&self.next_seq) {
let _r = self.gap_first_seen.remove(&self.next_seq);
let _r = self.gap_nak_count.remove(&self.next_seq);
let _r = self.gap_nak_sent_at.remove(&self.next_seq);
self.next_seq += 1;
if let Some(f) = self.route_or_deliver(buffered) {
delivered.push(f);
}
} else {
break;
}
}
delivered
}
/// Send NAKs for gaps whose timeout has elapsed, reset their timer for potential re-NAK,
/// and skip any gaps that have exceeded the maximum retry count or the sender's retransmit
/// window. Returns frames from `recv_buffer` that become deliverable after skipping
/// permanently lost packets.
fn check_nak_timeouts(&mut self) -> Vec<EncryptedFrame> {
if self.diff_mode != DiffMode::Reliable {
return vec![];
}
let now = Instant::now();
let delivered = self.drain_given_up_seqs();
// Request retransmission for recent gaps using exponential backoff:
// timeout = base * 2^retry_count (capped at base * 2^NAK_BACKOFF_MAX_SHIFT).
let base_nak_timeout = self.nak_timeout.unwrap_or(NAK_TIMEOUT);
let timed_out: Vec<u64> = self
.gap_first_seen
.iter()
.filter_map(|(&seq, &t)| {
let retries = self.gap_nak_count.get(&seq).copied().unwrap_or(0);
let shift = retries.min(NAK_BACKOFF_MAX_SHIFT);
let backoff = base_nak_timeout * (1u32 << shift);
(now.duration_since(t) >= backoff).then_some(seq)
})
.collect();
if !timed_out.is_empty() {
let mut send_repaint_request = false;
for &seq in &timed_out {
if let Some(t) = self.gap_first_seen.get_mut(&seq) {
*t = now;
}
let count = self.gap_nak_count.entry(seq).or_insert(0);
*count += 1;
if *count == REPAINT_REQUEST_THRESHOLD {
send_repaint_request = true;
}
let _prev = self.gap_nak_sent_at.insert(seq, now);
}
if let Some(ref tx) = self.nak_out_tx
&& let Err(e) = tx.try_send(EncryptedFrame::Nak(timed_out))
{
warn!("Failed to send NAK: {e}");
}
// When any gap reaches the repaint threshold, ask the server for an immediate
// full-screen snapshot.
if send_repaint_request
&& let Some(ref tx) = self.nak_out_tx
&& let Err(e) = tx.try_send(EncryptedFrame::RepaintRequest)
{
warn!("Failed to send RepaintRequest: {e}");
}
}
delivered
}
/// Run the server frame reading loop
///
/// # Errors
/// * I/O error.
/// * Frame parsing error.
///
#[cfg_attr(nightly, allow(clippy::too_many_lines))]
pub async fn server_frame_loop(
&mut self,
token: CancellationToken,
term_tx: Sender<TerminalMessage>,
) -> Result<()> {
// Wait for the first UDP datagram from the client to discover its real
// post-NAT address. The socket is intentionally NOT connected — it stays
// unconnected for the session lifetime so that packets arriving from a new
// address after a NAT rebind are not silently dropped by the OS.
let mut current_peer: SocketAddr = {
let mut buf = vec![0u8; 65535];
let (first_len, peer_addr) = self.socket.recv_from(&mut buf).await?;
if let Some(tx) = self.peer_discovered_tx.take() {
let _ = tx.send(peer_addr);
}
// Process the first packet through the normal pipeline.
let mut first_buf = BytesMut::from(&buf[..first_len]);
match self.parse_encrypted_frame(&mut first_buf) {
Ok(Some((frame, seq))) => {
if let Some(ref counter) = self.last_rx_us {
counter.store(now_micros(), Ordering::Relaxed);
}
for ready in self.handle_arrival(frame, seq) {
match ready {
EncryptedFrame::Bytes((_id, message)) => {
term_tx.send(TerminalMessage::Input(message)).await?;
}
EncryptedFrame::Resize((_id, columns, rows)) => {
term_tx
.send(TerminalMessage::Resize { rows, columns })
.await?;
}
EncryptedFrame::RepaintRequest => {
if let Some(ref tx) = self.repaint_tx
&& let Err(e) = tx.try_send(())
{
warn!("Failed to signal repaint request: {e}");
}
}
EncryptedFrame::Keepalive(ts) => {
let rtt_us = now_micros().saturating_sub(ts);
if rtt_us > 0 && rtt_us < 30_000_000 {
self.update_rtt_estimate(Duration::from_micros(rtt_us));
}
}
EncryptedFrame::Nak(_)
| EncryptedFrame::Shutdown
| EncryptedFrame::ScrollbackStart
| EncryptedFrame::ScrollbackEnd
| EncryptedFrame::ScreenState(_)
| EncryptedFrame::ScreenStateCompressed(_)
| EncryptedFrame::CompressedBytes(_)
| EncryptedFrame::StateSyncDiff(_)
| EncryptedFrame::PtyExit
| EncryptedFrame::StateChunk(_) => {}
EncryptedFrame::ClientAck(diff_id) => {
if let Some(ref tx) = self.client_ack_tx
&& let Err(e) = tx.try_send(diff_id)
{
warn!("Failed to forward ClientAck: {e}");
}
}
}
}
}
Ok(None) => {}
Err(e) => {
warn!("Failed to parse first UDP frame from client: {e}");
}
}
peer_addr
};
let mut nak_check_deadline = TokioInstant::now() + self.nak_check_interval();
loop {
select! {
() = token.cancelled() => break,
() = sleep_until(nak_check_deadline) => {
for ready in self.check_nak_timeouts() {
match ready {
EncryptedFrame::Bytes((_id, message)) => {
term_tx.send(TerminalMessage::Input(message)).await?;
}
EncryptedFrame::Resize((_id, columns, rows)) => {
term_tx.send(TerminalMessage::Resize { rows, columns }).await?;
}
EncryptedFrame::RepaintRequest => {
if let Some(ref tx) = self.repaint_tx
&& let Err(e) = tx.try_send(())
{
warn!("Failed to signal repaint request: {e}");
}
}
EncryptedFrame::Keepalive(ts) => {
let rtt_us = now_micros().saturating_sub(ts);
if rtt_us > 0 && rtt_us < 30_000_000 {
self.update_rtt_estimate(Duration::from_micros(rtt_us));
}
}
EncryptedFrame::Nak(_)
| EncryptedFrame::Shutdown
| EncryptedFrame::ScrollbackStart
| EncryptedFrame::ScrollbackEnd
| EncryptedFrame::ScreenState(_)
| EncryptedFrame::ScreenStateCompressed(_)
| EncryptedFrame::CompressedBytes(_)
| EncryptedFrame::StateSyncDiff(_)
| EncryptedFrame::PtyExit
| EncryptedFrame::StateChunk(_)
| EncryptedFrame::ClientAck(_) => {}
}
}
nak_check_deadline = TokioInstant::now() + self.nak_check_interval();
},
frame_res = self.recv_frame_from() => {
match frame_res {
Ok(Some((frame, seq, src_addr))) => {
if let Some(ref counter) = self.last_rx_us {
counter.store(now_micros(), Ordering::Relaxed);
}
if src_addr != current_peer {
info!("NAT roam: peer {} → {}", current_peer, src_addr);
current_peer = src_addr;
if let Some(ref tx) = self.peer_addr_tx
&& let Err(e) = tx.try_send(src_addr)
{
warn!("Failed to signal NAT roam: {e}");
}
}
for ready in self.handle_arrival(frame, seq) {
match ready {
EncryptedFrame::Bytes((_id, message)) => {
term_tx.send(TerminalMessage::Input(message)).await?;
}
EncryptedFrame::Resize((_id, columns, rows)) => {
term_tx.send(TerminalMessage::Resize { rows, columns }).await?;
}
EncryptedFrame::RepaintRequest => {
if let Some(ref tx) = self.repaint_tx
&& let Err(e) = tx.try_send(())
{
warn!("Failed to signal repaint request: {e}");
}
}
EncryptedFrame::Keepalive(ts) => {
let rtt_us = now_micros().saturating_sub(ts);
if rtt_us > 0 && rtt_us < 30_000_000 {
self.update_rtt_estimate(Duration::from_micros(rtt_us));
}
}
EncryptedFrame::Nak(_)
| EncryptedFrame::Shutdown
| EncryptedFrame::ScrollbackStart
| EncryptedFrame::ScrollbackEnd
| EncryptedFrame::ScreenState(_)
| EncryptedFrame::ScreenStateCompressed(_)
| EncryptedFrame::CompressedBytes(_)
| EncryptedFrame::StateSyncDiff(_)
| EncryptedFrame::PtyExit
| EncryptedFrame::StateChunk(_) => {}
EncryptedFrame::ClientAck(diff_id) => {
if let Some(ref tx) = self.client_ack_tx
&& let Err(e) = tx.try_send(diff_id)
{
warn!("Failed to forward ClientAck: {e}");
}
}
}
}
}
Ok(None) => break,
Err(e) => {
error!("udp read error, client likely disconnected: {e}");
break;
}
}
}
}
}
Ok(())
}
/// Process one `StateChunk` frame in `StateSync` client mode.
///
/// Accumulates chunks in order. When the assembly is complete the combined payload
/// is processed identically to a [`EncryptedFrame::ScreenStateCompressed`] frame:
/// decompressed, fed into a scratch [`vt100::Parser`], ack state reset, and rendered
/// via the shared renderer. Out-of-order chunks trigger a [`EncryptedFrame::RepaintRequest`].
async fn handle_state_chunk(
&mut self,
seq: u16,
total: u16,
data: Vec<u8>,
emulator: &Arc<Mutex<Emulator>>,
renderer: &Arc<Mutex<Renderer>>,
stdout_tx: &Sender<Vec<u8>>,
) {
if seq == 0 {
self.pending_chunk_total = total;
self.pending_chunk_seq = 0;
self.pending_chunk_data = data;
} else if seq == self.pending_chunk_seq && total == self.pending_chunk_total {
self.pending_chunk_data.extend_from_slice(&data);
} else {
// Out-of-order or stale chunk — discard assembly and request a fresh push.
self.pending_chunk_total = 0;
self.pending_chunk_seq = 0;
self.pending_chunk_data.clear();
if let Some(ref tx) = self.nak_out_tx {
drop(tx.try_send(EncryptedFrame::RepaintRequest));
}
return;
}
self.pending_chunk_seq += 1;
if self.pending_chunk_seq == self.pending_chunk_total {
// Assembly complete — process as ScreenStateCompressed.
let payload_compressed = std::mem::take(&mut self.pending_chunk_data);
self.pending_chunk_seq = 0;
self.pending_chunk_total = 0;
match decode_all(payload_compressed.as_slice()) {
Ok(payload) => {
let (rows, cols) = {
let emu = emulator
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner);
emu.screen().size()
};
let mut tmp = vt100::Parser::new(rows, cols, 0);
tmp.process(&payload);
if self.diff_mode == DiffMode::StateSync {
let is_alt = tmp.screen().alternate_screen();
let mut ack = tmp.screen().contents_formatted();
if is_alt {
let mut prefixed = b"\x1b[?1049h".to_vec();
prefixed.extend_from_slice(&ack);
ack = prefixed;
}
self.ack_state = ack;
self.ack_state_seq = 0;
self.statesync_mismatch_count = 0;
self.initial_state_received = true;
}
let repaint = {
let mut rend = renderer
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(tmp.screen(), &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await
{
error!("Error sending StateChunk repaint to stdout channel: {e}");
}
}
Err(e) => {
error!("Failed to decompress StateChunk assembly: {e}");
}
}
}
}
/// Run the client frame reading loop
///
/// # Errors
/// * I/O error.
/// * Frame parsing error.
///
/// # Panics
/// Panics if the `emulator`, `prediction`, or `renderer` mutex is poisoned.
///
/// # Parameters
/// * `token` – cancellation token for the session.
/// * `stdout_tx` – channel to the persistent stdout writer thread.
/// * `emulator` – shared terminal emulator state; fed server bytes and
/// queried by the prediction engine.
/// * `prediction` – shared prediction engine; culled after server bytes
/// arrive so that confirmed/invalidated overlays are reconciled.
/// * `renderer` – differential renderer; used to emit a single clean
/// repaint after a scrollback replay block completes.
#[cfg_attr(nightly, allow(clippy::too_many_lines))]
pub async fn client_frame_loop(
&mut self,
token: CancellationToken,
exit_token: CancellationToken,
stdout_tx: Sender<Vec<u8>>,
emulator: Arc<Mutex<Emulator>>,
prediction: Arc<Mutex<PredictionEngine>>,
renderer: Arc<Mutex<Renderer>>,
) {
let mut prev_bytes = BytesMut::with_capacity(1024);
let mut osc_started = false;
// In Datagram and StateSync modes the NAK timer is never actually used
// (check_nak_timeouts returns immediately), so we park the deadline far in
// the future to keep the select! branch from firing on every loop iteration.
let nak_park = Duration::from_hours(24);
let mut nak_check_deadline = TokioInstant::now()
+ if self.diff_mode == DiffMode::Reliable {
self.nak_check_interval()
} else {
nak_park
};
// When true, raw bytes are fed into the emulator only — not sent to
// stdout. Set by ScrollbackStart, cleared by ScrollbackEnd.
let mut scrollback_mode = false;
// Deadline after which silence is treated as a server disconnect.
let mut silence_deadline: Option<TokioInstant> =
self.silence_timeout.map(|d| TokioInstant::now() + d);
'session: loop {
select! {
() = token.cancelled() => process::exit(0),
() = sleep_until(nak_check_deadline) => {
for ready in self.check_nak_timeouts() {
match ready {
EncryptedFrame::Bytes((_id, message)) => {
let message = self.intercept_queries(&message, &emulator);
process_bytes_with_prediction(
message,
&mut prev_bytes,
&mut osc_started,
&stdout_tx,
scrollback_mode,
&token,
&emulator,
&prediction,
)
.await;
}
EncryptedFrame::Resize(_) => {
error!("Received Resize frame on client, which is unexpected");
}
EncryptedFrame::Keepalive(ts) => {
if let Some(ref tx) = self.nak_out_tx
&& let Err(e) = tx.try_send(EncryptedFrame::Keepalive(ts))
{
warn!("Failed to echo keepalive: {e}");
}
}
EncryptedFrame::Nak(_)
| EncryptedFrame::RepaintRequest
| EncryptedFrame::StateSyncDiff(_)
| EncryptedFrame::ClientAck(_) => {}
EncryptedFrame::Shutdown => {
info!("Server is shutting down, reconnecting");
self.signal_reconnect_or_exit(0);
break 'session;
}
EncryptedFrame::ScrollbackStart => {
scrollback_mode = true;
}
EncryptedFrame::ScrollbackEnd => {
scrollback_mode = false;
let repaint = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
let screen = emu.screen();
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(screen, &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await {
error!("Error sending repaint to stdout channel: {e}");
}
}
EncryptedFrame::ScreenState(payload) => {
let (rows, cols) = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
emu.screen().size()
};
let mut tmp = vt100::Parser::new(rows, cols, 0);
tmp.process(&payload);
let repaint = {
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(tmp.screen(), &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await
{
error!("Error sending ScreenState repaint to stdout channel: {e}");
}
}
EncryptedFrame::ScreenStateCompressed(compressed) => {
match decode_all(compressed.as_slice()) {
Ok(payload) => {
let (rows, cols) = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
emu.screen().size()
};
let mut tmp = vt100::Parser::new(rows, cols, 0);
tmp.process(&payload);
if self.diff_mode == DiffMode::StateSync {
let is_alt = tmp.screen().alternate_screen();
let mut ack = tmp.screen().contents_formatted();
if is_alt {
let mut prefixed = b"\x1b[?1049h".to_vec();
prefixed.extend_from_slice(&ack);
ack = prefixed;
}
self.ack_state = ack;
self.ack_state_seq = 0;
self.statesync_mismatch_count = 0;
self.initial_state_received = true;
}
let repaint = {
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(tmp.screen(), &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await
{
error!("Error sending ScreenStateCompressed repaint to stdout channel: {e}");
}
}
Err(e) => {
error!("Failed to decompress ScreenStateCompressed: {e}");
}
}
}
EncryptedFrame::PtyExit => {
let msg = b"\r\n\x1b[0m[moshpit] Remote session ended.\r\n";
drop(stdout_tx.send(msg.to_vec()).await);
exit_token.cancel();
break 'session;
}
EncryptedFrame::StateChunk((seq, total, data)) => {
self.handle_state_chunk(
seq,
total,
data,
&emulator,
&renderer,
&stdout_tx,
)
.await;
}
EncryptedFrame::CompressedBytes((_id, compressed)) => {
match decode_all(compressed.as_slice()) {
Ok(decompressed) => {
let message =
self.intercept_queries(&decompressed, &emulator);
process_bytes_with_prediction(
message,
&mut prev_bytes,
&mut osc_started,
&stdout_tx,
scrollback_mode,
&token,
&emulator,
&prediction,
)
.await;
}
Err(e) => {
error!("Failed to decompress CompressedBytes: {e}");
}
}
}
}
}
nak_check_deadline = TokioInstant::now()
+ if self.diff_mode == DiffMode::Reliable {
self.nak_check_interval()
} else {
nak_park
};
},
// Silence timeout: no frame received within `silence_timeout`.
() = async {
match silence_deadline {
Some(dl) => sleep_until(dl).await,
None => std::future::pending().await,
}
} => {
info!("Server not responding, signalling reconnect");
self.signal_reconnect_or_exit(1);
break;
},
frame_res = self.read_encrypted_frame() => {
// Reset silence deadline on every received frame.
if let Some(timeout) = self.silence_timeout {
silence_deadline = Some(TokioInstant::now() + timeout);
}
match frame_res {
Ok(Some((frame, seq))) => {
for ready in self.handle_arrival(frame, seq) {
match ready {
EncryptedFrame::Resize(_) => {
error!("Received Resize frame on client, which is unexpected");
}
EncryptedFrame::Keepalive(ts) => {
if let Some(ref tx) = self.nak_out_tx
&& let Err(e) =
tx.try_send(EncryptedFrame::Keepalive(ts))
{
warn!("Failed to echo keepalive: {e}");
}
}
EncryptedFrame::Nak(_)
| EncryptedFrame::RepaintRequest
| EncryptedFrame::ClientAck(_) => {}
EncryptedFrame::Shutdown => {
info!("Server is shutting down, reconnecting");
self.signal_reconnect_or_exit(0);
break 'session;
}
EncryptedFrame::ScrollbackStart => {
scrollback_mode = true;
}
EncryptedFrame::ScrollbackEnd => {
scrollback_mode = false;
let repaint = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
let screen = emu.screen();
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(screen, &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await {
error!("Error sending repaint to stdout channel: {e}");
}
}
EncryptedFrame::ScreenState(payload) => {
let (rows, cols) = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
emu.screen().size()
};
let mut tmp = vt100::Parser::new(rows, cols, 0);
tmp.process(&payload);
let repaint = {
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(tmp.screen(), &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await
{
error!("Error sending ScreenState repaint to stdout channel: {e}");
}
}
EncryptedFrame::ScreenStateCompressed(compressed) => {
match decode_all(compressed.as_slice()) {
Ok(payload) => {
let (rows, cols) = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
emu.screen().size()
};
let mut tmp = vt100::Parser::new(rows, cols, 0);
tmp.process(&payload);
if self.diff_mode == DiffMode::StateSync {
let is_alt = tmp.screen().alternate_screen();
let mut ack = tmp.screen().contents_formatted();
if is_alt {
let mut prefixed = b"\x1b[?1049h".to_vec();
prefixed.extend_from_slice(&ack);
ack = prefixed;
}
self.ack_state = ack;
self.ack_state_seq = 0;
self.statesync_mismatch_count = 0;
self.initial_state_received = true;
}
let repaint = {
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.invalidate();
rend.render(tmp.screen(), &[], None)
};
if !repaint.is_empty()
&& let Err(e) = stdout_tx.send(repaint).await
{
error!("Error sending ScreenStateCompressed repaint to stdout channel: {e}");
}
}
Err(e) => {
error!("Failed to decompress ScreenStateCompressed: {e}");
}
}
}
EncryptedFrame::CompressedBytes((_id, compressed)) => {
match decode_all(compressed.as_slice()) {
Ok(decompressed) => {
let message = self
.intercept_queries(&decompressed, &emulator);
process_bytes_with_prediction(
message,
&mut prev_bytes,
&mut osc_started,
&stdout_tx,
scrollback_mode,
&token,
&emulator,
&prediction,
)
.await;
}
Err(e) => {
error!("Failed to decompress CompressedBytes: {e}");
}
}
}
EncryptedFrame::Bytes((_id, message)) => {
let message =
self.intercept_queries(&message, &emulator);
process_bytes_with_prediction(
message,
&mut prev_bytes,
&mut osc_started,
&stdout_tx,
scrollback_mode,
&token,
&emulator,
&prediction,
)
.await;
}
EncryptedFrame::StateSyncDiff((base_id, diff_id, compressed)) => {
if !self.initial_state_received {
// Full state not yet received — discard and trigger a push.
if let Some(ref tx) = self.nak_out_tx {
drop(tx.try_send(EncryptedFrame::RepaintRequest));
}
} else if base_id == self.ack_state_seq {
self.statesync_mismatch_count = 0;
match decode_all(compressed.as_slice()) {
Ok(diff_bytes) => {
let (rows, cols) = {
let emu = emulator.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
emu.screen().size()
};
let mut tmp = vt100::Parser::new(rows, cols, 0);
if !self.ack_state.is_empty() {
tmp.process(&self.ack_state);
}
tmp.process(&diff_bytes);
let is_alt = tmp.screen().alternate_screen();
let mut new_ack = tmp.screen().contents_formatted();
if is_alt {
let mut prefixed = b"\x1b[?1049h".to_vec();
prefixed.extend_from_slice(&new_ack);
new_ack = prefixed;
}
self.ack_state = new_ack;
self.ack_state_seq = diff_id;
// Route through the renderer so displayed tracks
// alt-screen state and ScreenStateCompressed
// repaints compute correct diffs afterward.
let repaint = {
let mut rend = renderer.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
rend.render(tmp.screen(), &[], None)
};
if let Err(e) = stdout_tx.send(repaint).await {
error!("Error sending StateSyncDiff to stdout channel: {e}");
}
if let Some(ref tx) = self.nak_out_tx
&& let Err(e) = tx.try_send(EncryptedFrame::ClientAck(diff_id))
{
warn!("Failed to send ClientAck: {e}");
}
}
Err(e) => {
error!("Failed to decompress StateSyncDiff: {e}");
}
}
} else {
self.statesync_mismatch_count += 1;
if self.statesync_mismatch_count >= 3 {
self.statesync_mismatch_count = 0;
if let Some(ref tx) = self.nak_out_tx
&& let Err(e) = tx.try_send(EncryptedFrame::RepaintRequest)
{
warn!("Failed to send StateSync desync RepaintRequest: {e}");
}
}
}
}
EncryptedFrame::PtyExit => {
let msg = b"\r\n\x1b[0m[moshpit] Remote session ended.\r\n";
drop(stdout_tx.send(msg.to_vec()).await);
exit_token.cancel();
break 'session;
}
EncryptedFrame::StateChunk((seq, total, data)) => {
self.handle_state_chunk(
seq,
total,
data,
&emulator,
&renderer,
&stdout_tx,
)
.await;
}
}
}
}
Ok(None) => {
info!("server closed UDP connection");
self.signal_reconnect_or_exit(0);
break;
}
Err(e) => {
error!("udp read error, server likely disconnected: {e}");
self.signal_reconnect_or_exit(1);
break;
}
}
}
}
}
}
}
/// Feed server bytes through the prediction pipeline and write output to
/// the stdout channel.
///
/// Pipeline:
/// 1. Detect shell-exit via OSC title.
/// 2. Forward raw bytes to stdout unchanged (preserves normal terminal
/// rendering exactly as before prediction was added).
/// 3. Feed raw bytes into the terminal emulator (for prediction state).
/// 4. Cull confirmed/invalid predictions against the new screen state.
/// 5. Paint any active prediction overlays on top via ANSI sequences.
#[cfg_attr(nightly, allow(clippy::too_many_arguments))]
async fn process_bytes_with_prediction(
raw: Vec<u8>,
prev_bytes: &mut BytesMut,
osc_started: &mut bool,
stdout_tx: &Sender<Vec<u8>>,
// When true, raw bytes are silently fed into the emulator only; no stdout output is produced.
scrollback_mode: bool,
token: &CancellationToken,
emulator: &Arc<Mutex<Emulator>>,
prediction: &Arc<Mutex<PredictionEngine>>,
) {
// ── 1. OSC exit detection ─────────────────────────────────────────────
let message = if prev_bytes.is_empty() {
raw.clone()
} else {
let mut combined = BytesMut::with_capacity(prev_bytes.len() + raw.len());
combined.extend_from_slice(prev_bytes);
combined.extend_from_slice(&raw);
prev_bytes.clear();
combined.freeze().to_vec()
};
prev_bytes.clear();
let mut valid_utf8 = String::new();
for chunk in message.utf8_chunks() {
valid_utf8.push_str(chunk.valid());
if !chunk.invalid().is_empty() {
prev_bytes.extend_from_slice(chunk.invalid());
}
}
let result = TokenStream::from(&valid_utf8).collect::<Vec<Token<'_>>>();
for part in &result {
match part {
Token::String(osc_cmd_string) => {
if *osc_started && is_exit_title(osc_cmd_string, false) {
sleep(Duration::from_millis(500)).await;
token.cancel();
}
}
Token::ControlFunction(control_function) => {
if *osc_started && (*control_function == c1::ST || *control_function == c0::BEL) {
*osc_started = false;
} else if *control_function == c1::OSC && !*osc_started {
*osc_started = true;
}
}
}
}
// ── 2. Forward raw bytes to stdout ───────────────────────────────────
// The physical terminal drives its own display from the server's PTY
// bytes. We do not replace them with a computed representation; the
// emulator is used only to track screen state for the prediction engine.
// In scrollback_mode the bytes are absorbed silently — the renderer will
// emit a single clean repaint when ScrollbackEnd arrives.
if !scrollback_mode && let Err(e) = stdout_tx.send(raw.clone()).await {
error!("Error sending to stdout channel: {e}");
return;
}
// ── 3. Feed raw bytes into the emulator ──────────────────────────────
{
let mut emu = emulator
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner);
emu.process(&raw);
}
// ── 4+5. Cull predictions and paint overlays ─────────────────────────
// Skip overlay painting while absorbing scrollback — there are no active
// predictions during reconnect and we do not want flickering output.
if !scrollback_mode {
let (overlays, cursor) = {
let emu = emulator
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner);
let screen = emu.screen();
let mut pred = prediction
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner);
pred.cull(screen);
pred.apply(screen)
};
let overlay_out = paint_overlays_to_ansi(&overlays, cursor);
if !overlay_out.is_empty()
&& let Err(e) = stdout_tx.send(overlay_out).await
{
error!("Error sending overlays to stdout channel: {e}");
}
}
}
impl UdpReader {
/// Read a single `Frame` value from the underlying stream.
///
/// The function waits until it has retrieved enough data to parse a frame.
/// Any data remaining in the read buffer after the frame has been parsed is
/// kept there for the next call to `read_frame`.
///
/// # Returns
///
/// On success, the received frame is returned. If the `TcpStream`
/// is closed in a way that doesn't break a frame in half, it returns
/// `None`. Otherwise, an error is returned.
///
/// # Errors
/// * Connection reset by peer.
/// * I/O error.
/// * Frame parsing error.
///
pub async fn read_encrypted_frame(&mut self) -> Result<Option<(EncryptedFrame, u64)>> {
loop {
let mut buffer = BytesMut::with_capacity(8192);
let len = self.socket.recv_buf(&mut buffer).await?;
if len == 0 {
// The remote closed the connection. For this to be a clean
// shutdown, there should be no data in the read buffer. If
// there is, this means that the peer closed the socket while
// sending a frame.
if buffer.is_empty() {
info!("empty buffer after 0 bytes read, returning None");
return Ok(None);
}
return Err(MoshpitError::ConnectionResetByPeer.into());
}
// Attempt to parse a frame from the buffered data. If enough data
// has been buffered, the frame is returned.
match self.parse_encrypted_frame(&mut buffer) {
Ok(Some((frame, seq))) => return Ok(Some((frame, seq))),
Ok(None) => {
// Not enough data has been buffered yet to parse a full
// frame. Continue the loop to read more data from the socket.
}
Err(err) => {
warn!("Failed to parse encrypted frame: {err}");
}
}
}
}
/// Receives one UDP datagram via `recv_from`, parses and authenticates it, and
/// returns the decoded frame, its sequence number, and the sender's address.
/// Used by `server_frame_loop` so that the source address of every packet is
/// visible for NAT roam detection without connecting the socket.
async fn recv_frame_from(&self) -> Result<Option<(EncryptedFrame, u64, SocketAddr)>> {
let mut buf = vec![0u8; 65535];
loop {
let (len, src) = self.socket.recv_from(&mut buf).await?;
if len == 0 {
return Ok(None);
}
let mut buffer = BytesMut::from(&buf[..len]);
match self.parse_encrypted_frame(&mut buffer) {
Ok(Some((frame, seq))) => return Ok(Some((frame, seq, src))),
Ok(None) => {}
Err(e) => {
warn!("Failed to parse UDP frame from {src}: {e}");
}
}
}
}
/// Tries to parse a frame from the buffer. Returns the frame and its sequence number on
/// success, `Ok(None)` when the buffer has insufficient data, or `Err` on a bad frame.
fn parse_encrypted_frame(
&self,
buffer: &mut BytesMut,
) -> Result<Option<(EncryptedFrame, u64)>> {
let mut buf = Cursor::new(&buffer[..]);
buf.set_position(0);
match EncryptedFrame::parse(&mut buf, self.id, &self.hmac, &self.rnk, self.mac_tag_len) {
Ok(Some((frame, seq))) => {
buffer.clear();
Ok(Some((frame, seq)))
}
Ok(None) => Ok(None),
Err(err) => Err(err),
}
}
}
#[cfg(test)]
mod tests {
use aws_lc_rs::{
aead::{AES_256_GCM_SIV, UnboundKey},
hmac::HMAC_SHA512,
};
use super::*;
#[tokio::test]
async fn test_handle_arrival_seq_jump() {
// Build a minimal UdpReader
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build();
// First packet arrives normally
let frame1 = EncryptedFrame::Keepalive(0);
let ready1 = reader.handle_arrival(frame1, 0);
assert_eq!(ready1.len(), 1);
assert_eq!(reader.next_seq, 1);
assert!(reader.gap_first_seen.is_empty());
// Massive sequence jump
let oversized_jump_seq = 1 + MAX_SEQ_JUMP + 10;
let frame2 = EncryptedFrame::Keepalive(0);
let ready2 = reader.handle_arrival(frame2, oversized_jump_seq);
// Should drop the frame
assert!(ready2.is_empty());
assert_eq!(reader.next_seq, 1); // Unchanged
assert!(reader.gap_first_seen.is_empty()); // No gaps recorded!
// Small sequence jump (within limits)
let frame3 = EncryptedFrame::Keepalive(0);
let ready3 = reader.handle_arrival(frame3, 3);
// Should buffer the frame and record gaps for 1 and 2
assert!(ready3.is_empty());
assert_eq!(reader.next_seq, 1);
assert_eq!(reader.gap_first_seen.len(), 2);
assert!(reader.gap_first_seen.contains_key(&1));
assert!(reader.gap_first_seen.contains_key(&2));
}
// -----------------------------------------------------------------------
// Property tests (proptest)
// -----------------------------------------------------------------------
use proptest::prelude::*;
fn make_reader_sync() -> UdpReader {
// Build a UdpReader synchronously using a blocking socket creation.
// proptest strategy closures cannot be async, so we use a blocking handle.
let rt = tokio::runtime::Runtime::new().unwrap();
let socket = rt.block_on(async { UdpSocket::bind("127.0.0.1:0").await.unwrap() });
UdpReader::builder()
.socket(Arc::new(socket))
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build()
}
proptest! {
/// For any sequence of in-order frames `[0..N]`, every frame is delivered
/// exactly once and in order.
#[test]
fn prop_in_order_delivery(n in 1u64..64u64) {
let mut reader = make_reader_sync();
let mut delivered = Vec::new();
for seq in 0..n {
let ready = reader.handle_arrival(EncryptedFrame::Keepalive(0), seq);
delivered.extend(ready);
}
// All N frames should have been delivered immediately.
prop_assert_eq!(delivered.len() as u64, n);
prop_assert_eq!(reader.next_seq, n);
}
/// A single out-of-order pair (seq+1 arrives before seq) is reordered
/// correctly: after the gap is filled both frames are delivered.
#[test]
fn prop_single_gap_reorder(base in 0u64..1000u64) {
let mut reader = make_reader_sync();
// Deliver base first so next_seq = base+1 is established.
if base > 0 {
for s in 0..base {
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), s));
}
}
// Deliver base+1 (out of order — gap at `base` if base==0 else at base).
// Simplified: just send seq=1 before seq=0 from a fresh reader.
let mut reader2 = make_reader_sync();
let late = reader2.handle_arrival(EncryptedFrame::Keepalive(0), 1);
// seq=1 arrives before seq=0 — buffered, none delivered yet.
prop_assert!(late.is_empty(), "frame buffered, not delivered yet");
prop_assert_eq!(reader2.next_seq, 0);
// Now deliver the missing seq=0.
let flushed = reader2.handle_arrival(EncryptedFrame::Keepalive(0), 0);
// Both seq=0 and the buffered seq=1 should now be delivered.
prop_assert_eq!(flushed.len(), 2);
prop_assert_eq!(reader2.next_seq, 2);
}
/// Any frame whose seq exceeds next_seq + MAX_SEQ_JUMP is dropped.
/// `next_seq` and gap tracking must be unchanged.
#[test]
fn prop_seq_jump_rejected(jump in (MAX_SEQ_JUMP + 1)..(MAX_SEQ_JUMP * 4)) {
let mut reader = make_reader_sync();
let seq = reader.next_seq + jump;
let ready = reader.handle_arrival(EncryptedFrame::Keepalive(0), seq);
prop_assert!(ready.is_empty(), "oversized seq-jump frame must be dropped");
prop_assert_eq!(reader.next_seq, 0, "next_seq must be unchanged");
prop_assert!(reader.gap_first_seen.is_empty(), "no gap state must be recorded");
prop_assert!(reader.recv_buffer.is_empty(), "no buffer entry must be created");
}
/// A frame with a seq < next_seq is a replay/duplicate — must be discarded.
#[test]
fn prop_replay_rejected(n in 2u64..32u64) {
let mut reader = make_reader_sync();
// Deliver n frames in order to advance next_seq to n.
for seq in 0..n {
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), seq));
}
prop_assert_eq!(reader.next_seq, n);
// Now re-deliver any already-seen sequence number.
for old_seq in 0..n {
let ready = reader.handle_arrival(EncryptedFrame::Keepalive(0), old_seq);
prop_assert!(ready.is_empty(), "replayed frame {old_seq} must be discarded");
}
prop_assert_eq!(reader.next_seq, n, "next_seq must be unchanged after replays");
}
/// Under arbitrary reordering within the allowed window, recv_buffer
/// never grows beyond MAX_SEQ_JUMP entries.
#[test]
fn prop_recv_buffer_bounded(seqs in proptest::collection::vec(0u64..MAX_SEQ_JUMP, 0..128)) {
let mut reader = make_reader_sync();
for seq in seqs {
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), seq));
prop_assert!(
reader.recv_buffer.len() as u64 <= MAX_SEQ_JUMP,
"recv_buffer must stay bounded: len={}", reader.recv_buffer.len()
);
}
}
}
// ── Phase 1: intercept_queries ─────────────────────────────────────────────
/// Build a `UdpReader` wired with a `query_response_tx` so CSI/OSC responses
/// can be observed in tests.
async fn make_reader_with_response_rx()
-> (UdpReader, tokio::sync::mpsc::Receiver<EncryptedFrame>) {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (tx, rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(16);
let reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.query_response_tx(tx)
.build();
(reader, rx)
}
fn make_emulator() -> Arc<Mutex<Emulator>> {
Arc::new(Mutex::new(Emulator::new(24, 80)))
}
// --- plain bytes passthrough ---
#[tokio::test]
async fn intercept_queries_plain_bytes_passthrough() {
let (reader, _rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let input = b"hello world";
let out = reader.intercept_queries(input, &emu);
assert_eq!(out, input);
}
#[tokio::test]
async fn intercept_queries_empty_passthrough() {
let (reader, _rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"", &emu);
assert!(out.is_empty());
}
// --- VT (0x0B) and FF (0x0C) normalisation to CR+LF ---
#[tokio::test]
async fn intercept_queries_vt_normalized_to_crlf() {
let (reader, _rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x0b", &emu);
assert_eq!(out, b"\r\n");
}
#[tokio::test]
async fn intercept_queries_ff_normalized_to_crlf() {
let (reader, _rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x0c", &emu);
assert_eq!(out, b"\r\n");
}
#[tokio::test]
async fn intercept_queries_multiple_vt_ff() {
let (reader, _rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x0ba\x0c", &emu);
assert_eq!(out, b"\r\na\r\n");
}
// --- unknown ESC sequence passes through unchanged ---
#[tokio::test]
async fn intercept_queries_unknown_esc_passthrough() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
// ESC M (reverse index) — not a CSI or OSC, passes through unchanged
let input = b"\x1bM";
let out = reader.intercept_queries(input, &emu);
// Unknown ESC sequences pass through unmodified
assert_eq!(out, input);
assert!(rx.try_recv().is_err(), "no response frame for unknown ESC");
}
// --- CSI queries: intercept DSR (ESC[6n) ---
#[tokio::test]
async fn intercept_queries_csi_dsr_sends_response_and_strips_from_stdout() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
// DSR: ESC [ 6 n
let out = reader.intercept_queries(b"\x1b[6n", &emu);
// The query should be stripped from output
assert!(out.is_empty(), "DSR query must not pass through to stdout");
// A response frame should have been sent
let frame = rx.try_recv().expect("expected a response frame");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame, got {frame:?}");
};
// Response format: ESC [ row ; col R
let s = String::from_utf8(resp).unwrap();
assert!(s.starts_with("\x1b["), "response must start with ESC [");
assert!(s.ends_with('R'), "response must end with R");
}
// --- CSI DA1 (ESC[0c) ---
#[tokio::test]
async fn intercept_queries_csi_da1_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x1b[0c", &emu);
assert!(out.is_empty(), "DA1 query must not pass through");
let frame = rx.try_recv().expect("expected response for DA1");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
assert_eq!(resp, b"\x1b[?62c");
}
// --- CSI DA1 with empty param (ESC[c) ---
#[tokio::test]
async fn intercept_queries_csi_da1_empty_param_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x1b[c", &emu);
assert!(
out.is_empty(),
"DA1 (empty param) query must not pass through"
);
let frame = rx
.try_recv()
.expect("expected response for DA1 empty param");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
assert_eq!(resp, b"\x1b[?62c");
}
// --- CSI DA2 (ESC[>0c) ---
#[tokio::test]
async fn intercept_queries_csi_da2_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x1b[>0c", &emu);
assert!(out.is_empty(), "DA2 query must not pass through");
let frame = rx.try_recv().expect("expected response for DA2");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
assert_eq!(resp, b"\x1b[>1;10;0c");
}
// --- CSI DA3 (ESC[=0c) ---
#[tokio::test]
async fn intercept_queries_csi_da3_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x1b[=0c", &emu);
assert!(out.is_empty(), "DA3 query must not pass through");
let frame = rx.try_recv().expect("expected response for DA3");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
assert_eq!(resp, b"\x1bP!|00000000\x1b\\");
}
// --- unrecognised CSI passes through ---
#[tokio::test]
async fn intercept_queries_csi_unrecognised_passes_through() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
// ESC [ 2 J (erase screen) — not a recognised query
let input = b"\x1b[2J";
let out = reader.intercept_queries(input, &emu);
assert_eq!(out, input, "unrecognised CSI must pass through unchanged");
assert!(rx.try_recv().is_err(), "no response frame expected");
}
// --- OSC 10 color query (foreground) ---
#[tokio::test]
async fn intercept_queries_osc10_fg_color_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
// OSC 10 ;? BEL — foreground color query
let out = reader.intercept_queries(b"\x1b]10;?\x07", &emu);
assert!(out.is_empty(), "OSC 10 query must not pass through");
let frame = rx.try_recv().expect("expected OSC 10 response");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
let s = String::from_utf8(resp).unwrap();
assert!(s.starts_with("\x1b]10;"), "response must be OSC 10");
assert!(s.ends_with('\x07'), "response must be BEL-terminated");
}
// --- OSC 11 color query (background) ---
#[tokio::test]
async fn intercept_queries_osc11_bg_color_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x1b]11;?\x07", &emu);
assert!(out.is_empty(), "OSC 11 query must not pass through");
let frame = rx.try_recv().expect("expected OSC 11 response");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
let s = String::from_utf8(resp).unwrap();
assert!(s.starts_with("\x1b]11;"), "response must be OSC 11");
}
// --- OSC 12 color query (cursor color) ---
#[tokio::test]
async fn intercept_queries_osc12_cursor_color_sends_response() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
let out = reader.intercept_queries(b"\x1b]12;?\x07", &emu);
assert!(out.is_empty(), "OSC 12 query must not pass through");
let frame = rx.try_recv().expect("expected OSC 12 response");
let EncryptedFrame::Bytes((_id, resp)) = frame else {
panic!("expected Bytes frame");
};
let s = String::from_utf8(resp).unwrap();
assert!(s.starts_with("\x1b]12;"));
}
// --- unrecognised OSC passes through ---
#[tokio::test]
async fn intercept_queries_osc_unrecognised_passes_through() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
// OSC 0 (title) — not a color query
let input = b"\x1b]0;title\x07";
let out = reader.intercept_queries(input, &emu);
assert_eq!(out, input, "unrecognised OSC must pass through unchanged");
assert!(rx.try_recv().is_err(), "no response frame expected");
}
// --- OSC with ST terminator (ESC \) ---
#[tokio::test]
async fn intercept_queries_osc_st_terminator_recognized() {
let (reader, mut rx) = make_reader_with_response_rx().await;
let emu = make_emulator();
// OSC 10 ;? ST (ST = ESC \)
let out = reader.intercept_queries(b"\x1b]10;?\x1b\\", &emu);
assert!(
out.is_empty(),
"OSC 10 with ST terminator must not pass through"
);
let frame = rx.try_recv().expect("expected OSC 10 response");
assert!(matches!(frame, EncryptedFrame::Bytes(_)));
}
// --- NAK routing via handle_arrival ---
#[tokio::test]
async fn handle_arrival_nak_routed_to_retransmit_tx() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (retransmit_tx, mut retransmit_rx) = tokio::sync::mpsc::channel::<Vec<u64>>(4);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.retransmit_tx(retransmit_tx)
.build();
let nak_frame = EncryptedFrame::Nak(vec![5, 6, 7]);
let ready = reader.handle_arrival(nak_frame, 0);
// NAK frames are consumed; not delivered to the caller
assert!(
ready.is_empty(),
"NAK frames must not be returned from handle_arrival"
);
// Retransmit request must have been forwarded
let seqs = retransmit_rx
.try_recv()
.expect("expected retransmit request");
assert_eq!(seqs, vec![5, 6, 7]);
}
// --- window give-up path in check_nak_timeouts ---
#[tokio::test]
async fn check_nak_timeouts_window_give_up_advances_next_seq() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build();
// Simulate a gap at seq=0: record it in gap_first_seen
let _ = reader.gap_first_seen.insert(0, Instant::now());
// Set highest_seq_seen so that seq=0 is outside the retransmit window
reader.highest_seq_seen = RETRANSMIT_WINDOW + 1;
// next_seq is still 0
assert_eq!(reader.next_seq, 0);
let delivered = reader.check_nak_timeouts();
// Gap is given up on — next_seq should advance past it
assert_eq!(
reader.next_seq, 1,
"next_seq must advance past given-up gap"
);
assert!(reader.gap_first_seen.is_empty(), "gap must be cleared");
assert!(delivered.is_empty(), "no buffered frames to deliver");
}
// ── Option A + Option D ────────────────────────────────────────────────────
#[test]
fn repaint_request_threshold_is_one() {
assert_eq!(REPAINT_REQUEST_THRESHOLD, 1);
}
#[test]
fn update_rtt_estimate_first_sample_jacobson_karels() {
let mut reader = make_reader_sync();
// First measurement: SRTT = 100ms, RTTVAR = 50ms, RTO = 100 + 4*50 = 300ms.
reader.update_rtt_estimate(Duration::from_millis(100));
assert_eq!(reader.srtt, Some(Duration::from_millis(100)));
assert_eq!(reader.rttvar, Some(Duration::from_millis(50)));
let rto = reader.nak_timeout.unwrap();
assert_eq!(
rto,
Duration::from_millis(300),
"first-sample RTO = srtt + 4*rttvar"
);
}
#[test]
fn update_rtt_estimate_second_sample_updates_variance() {
let mut reader = make_reader_sync();
// First: SRTT=100ms, RTTVAR=50ms, RTO=300ms.
reader.update_rtt_estimate(Duration::from_millis(100));
// Second: sample=200ms, |SRTT - sample| = 100ms.
// Duration arithmetic uses nanosecond precision:
// RTTVAR = 50ms - 50ms/4 + 100ms/4 = 50 - 12.5 + 25 = 62.5ms.
// SRTT = 100ms - 100ms/8 + 200ms/8 = 100 - 12.5 + 25 = 112.5ms.
// RTO = 112.5 + 4*62.5 = 112.5 + 250 = 362.5ms.
reader.update_rtt_estimate(Duration::from_millis(200));
let srtt = reader.srtt.unwrap();
let rttvar = reader.rttvar.unwrap();
let rto = reader.nak_timeout.unwrap();
assert_eq!(
srtt,
Duration::from_micros(112_500),
"SRTT after second sample"
);
assert_eq!(
rttvar,
Duration::from_micros(62_500),
"RTTVAR after second sample"
);
assert_eq!(rto, Duration::from_micros(362_500), "RTO = srtt + 4*rttvar");
}
#[test]
fn update_rtt_estimate_low_jitter_path_converges_rto_down() {
let mut reader = make_reader_sync();
// Drive the estimator with repeated 20ms samples (LAN path).
// RTTVAR should converge to near-zero and RTO should converge toward
// MIN_NAK_TIMEOUT (20ms).
for _ in 0..64 {
reader.update_rtt_estimate(Duration::from_millis(20));
}
let rto = reader.nak_timeout.unwrap();
assert!(
rto <= Duration::from_millis(60),
"low-jitter LAN path RTO must converge toward MIN: got {rto:?}"
);
}
#[test]
fn update_rtt_estimate_high_jitter_inflates_rto() {
let mut reader = make_reader_sync();
// Alternate between 10ms and 200ms to simulate high jitter.
for i in 0..8 {
let sample = if i % 2 == 0 { 10 } else { 200 };
reader.update_rtt_estimate(Duration::from_millis(sample));
}
let rto = reader.nak_timeout.unwrap();
// With high jitter, RTTVAR grows large, pushing RTO up.
assert!(
rto > Duration::from_millis(100),
"high-jitter path RTO must be inflated: got {rto:?}"
);
}
#[test]
fn update_rtt_estimate_clamped_to_min() {
let mut reader = make_reader_sync();
reader.nak_timeout = Some(Duration::from_millis(25));
reader.update_rtt_estimate(Duration::from_millis(1));
assert!(reader.nak_timeout.unwrap() >= MIN_NAK_TIMEOUT);
}
#[test]
fn update_rtt_estimate_clamped_to_max() {
let mut reader = make_reader_sync();
reader.nak_timeout = Some(Duration::from_millis(490));
reader.update_rtt_estimate(Duration::from_secs(2));
assert!(reader.nak_timeout.unwrap() <= MAX_NAK_TIMEOUT);
}
#[test]
fn handle_arrival_measures_rtt_on_gap_close() {
let mut reader = make_reader_sync();
// Inject a NAK timestamp as if we NAKed for seq=0 ~50 ms ago.
let sent = Instant::now()
.checked_sub(Duration::from_millis(50))
.unwrap();
let _prev = reader.gap_nak_sent_at.insert(0, sent);
// Deliver seq=0 in order — gap closes, RTT sample taken.
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 0));
assert!(reader.nak_timeout.is_some(), "nak_timeout must be updated");
assert!(reader.gap_nak_sent_at.is_empty(), "entry must be consumed");
}
#[tokio::test]
async fn handle_arrival_sends_immediate_nak_for_new_gaps() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (nak_tx, mut nak_rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(16);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_out_tx(nak_tx)
.build();
// seq=2 arrives out of order — gaps 0 and 1 are newly discovered.
let ready = reader.handle_arrival(EncryptedFrame::Keepalive(0), 2);
assert!(ready.is_empty(), "out-of-order frame must be buffered");
assert_eq!(reader.gap_first_seen.len(), 2);
// An immediate NAK must fire without waiting for the poll tick.
let frame = nak_rx.try_recv().expect("expected immediate NAK");
let EncryptedFrame::Nak(mut seqs) = frame else {
panic!("expected Nak frame, got {frame:?}");
};
seqs.sort_unstable();
assert_eq!(seqs, vec![0, 1]);
assert_eq!(
reader.gap_nak_sent_at.len(),
2,
"RTT timestamps must be set"
);
// seq=4 arrives — gap 3 is new; gaps 0 and 1 are already tracked.
let ready2 = reader.handle_arrival(EncryptedFrame::Keepalive(0), 4);
assert!(ready2.is_empty());
let frame2 = nak_rx
.try_recv()
.expect("expected NAK for newly-discovered gap 3");
let EncryptedFrame::Nak(seqs2) = frame2 else {
panic!("expected Nak frame");
};
assert_eq!(
seqs2,
vec![3],
"only the newly-discovered gap must be NAKed"
);
}
#[tokio::test]
async fn handle_arrival_no_duplicate_immediate_nak_for_known_gaps() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (nak_tx, mut nak_rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(16);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_out_tx(nak_tx)
.build();
// seq=2 arrives — creates gaps 0 and 1, immediate NAK fires.
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 2));
drop(nak_rx.try_recv().expect("first immediate NAK"));
// seq=3 arrives — gaps 0 and 1 are already known (in gap_first_seen);
// gap 2 is in recv_buffer and excluded. No new gaps → no NAK.
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 3));
assert!(
nak_rx.try_recv().is_err(),
"no immediate NAK when all gaps are already tracked"
);
}
#[test]
fn check_nak_timeouts_give_up_clears_gap_nak_sent_at() {
let mut reader = make_reader_sync();
let _prev = reader.gap_first_seen.insert(0, Instant::now());
let _prev = reader.gap_nak_count.insert(0, MAX_NAK_RETRIES);
let _prev = reader.gap_nak_sent_at.insert(0, Instant::now());
drop(reader.check_nak_timeouts());
assert!(
reader.gap_nak_sent_at.is_empty(),
"give-up must clear gap_nak_sent_at"
);
}
#[test]
fn update_rtt_estimate_updates_silence_timeout_when_set() {
let mut reader = make_reader_sync();
// Simulate client mode: silence_timeout was set.
reader.silence_timeout = Some(Duration::from_secs(15));
reader.update_rtt_estimate(Duration::from_millis(100));
let nak = reader.nak_timeout.unwrap();
let silence = reader.silence_timeout.unwrap();
assert_eq!(silence, (nak * 30).max(Duration::from_secs(9)));
}
#[test]
fn update_rtt_estimate_leaves_silence_timeout_none_when_unset() {
let mut reader = make_reader_sync();
// Simulate server mode: silence_timeout was never set.
assert!(reader.silence_timeout.is_none());
reader.update_rtt_estimate(Duration::from_millis(100));
assert!(
reader.silence_timeout.is_none(),
"server-mode reader must not acquire a silence_timeout"
);
}
#[test]
fn nak_check_interval_default_uses_nak_timeout_quarter() {
let reader = make_reader_sync();
// nak_timeout = None → falls back to NAK_TIMEOUT (50 ms); interval = max(50/4, 5) = 12.5 ms
// Duration division truncates to nanoseconds: 50_000_000 ns / 4 = 12_500_000 ns = 12.5 ms.
let interval = reader.nak_check_interval();
assert_eq!(interval, Duration::from_micros(12_500));
}
#[test]
fn nak_check_interval_scales_with_nak_timeout() {
let mut reader = make_reader_sync();
reader.nak_timeout = Some(MAX_NAK_TIMEOUT); // 500 ms → interval = max(125, 5) = 125 ms
assert_eq!(reader.nak_check_interval(), Duration::from_millis(125));
}
#[tokio::test]
async fn route_or_deliver_nak_increments_received_count() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let counter = Arc::new(AtomicU64::new(0));
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_received_count(counter.clone())
.build();
// Deliver a NAK frame — the counter must be incremented exactly once.
let nak = EncryptedFrame::Nak(vec![0, 1]);
let result = reader.handle_arrival(nak, 0);
assert!(result.is_empty(), "NAK frames must not be returned");
assert_eq!(
counter.load(Ordering::Relaxed),
1,
"counter must be incremented when a NAK is routed"
);
// Non-NAK frames must not increment.
let keepalive = EncryptedFrame::Keepalive(0);
drop(reader.handle_arrival(keepalive, 1));
assert_eq!(
counter.load(Ordering::Relaxed),
1,
"non-NAK frames must not increment the counter"
);
}
#[test]
fn nak_check_interval_clamped_to_min() {
let mut reader = make_reader_sync();
reader.nak_timeout = Some(MIN_NAK_TIMEOUT); // 20 ms → 20/4 = 5 ms = MIN_NAK_CHECK_INTERVAL
assert_eq!(reader.nak_check_interval(), MIN_NAK_CHECK_INTERVAL);
}
// ── Outlier RTT clamping ──────────────────────────────────────────────────
#[test]
fn update_rtt_estimate_clamps_outlier_to_ceiling() {
let mut reader = make_reader_sync();
// Default ceiling = NAK_TIMEOUT × 8 = 50 ms × 8 = 400 ms.
// A 7-second sample is clamped to 400 ms, which IS fed into the estimator.
// This breaks the "stuck at MIN" death spiral: the clamped value raises
// nak_timeout so the next real spike can pass through the larger ceiling.
reader.update_rtt_estimate(Duration::from_secs(7));
assert!(
reader.nak_timeout.is_some(),
"clamped outlier must still update nak_timeout"
);
// The effective sample was 400 ms (ceiling), not 7 s.
// First measurement: SRTT=400ms, RTTVAR=200ms, RTO=400+800=1200ms → MAX=500ms.
assert_eq!(reader.nak_timeout.unwrap(), MAX_NAK_TIMEOUT);
}
#[test]
fn update_rtt_estimate_accepts_sample_just_within_ceiling() {
let mut reader = make_reader_sync();
// Ceiling = 50 ms × 8 = 400 ms. A 399 ms sample is below ceiling, no clamp.
reader.update_rtt_estimate(Duration::from_millis(399));
assert!(
reader.nak_timeout.is_some(),
"sample within ceiling must update nak_timeout"
);
}
#[test]
fn update_rtt_estimate_ceiling_scales_with_current_nak_timeout() {
let mut reader = make_reader_sync();
// Set nak_timeout to 25 ms → ceiling = 25 × 8 = 200 ms.
reader.nak_timeout = Some(Duration::from_millis(25));
reader.srtt = Some(Duration::from_millis(25));
reader.rttvar = Some(Duration::from_millis(12));
// 300 ms exceeds ceiling (200 ms) → clamped to 200 ms, not discarded.
// nak_timeout must grow upward (out of the MIN neighbourhood).
reader.update_rtt_estimate(Duration::from_millis(300));
assert!(
reader.nak_timeout.unwrap() > Duration::from_millis(25),
"clamped sample must grow nak_timeout above the prior value"
);
}
/// Regression test for the "stuck at MIN" NAT death spiral.
/// When `nak_timeout` converges to MIN (20 ms), ceiling = 160 ms.
/// A 7 s congestion spike must be clamped — not discarded — so the estimator
/// can grow `nak_timeout` upward and break the death spiral.
#[test]
fn update_rtt_estimate_nat_death_spiral_self_heals() {
let mut reader = make_reader_sync();
// Drive the estimator to MIN by feeding repeated fast samples.
for _ in 0..64 {
reader.update_rtt_estimate(Duration::from_millis(5));
}
assert_eq!(
reader.nak_timeout.unwrap(),
MIN_NAK_TIMEOUT,
"setup: nak_timeout must be at MIN before the spike"
);
// Inject a 7 s NAT congestion spike. With pure discard this would leave
// nak_timeout stuck at 20 ms. With clamping it must grow.
reader.update_rtt_estimate(Duration::from_secs(7));
assert!(
reader.nak_timeout.unwrap() > MIN_NAK_TIMEOUT,
"clamped spike must grow nak_timeout above MIN — death spiral broken"
);
}
// ── handle_arrival: ScreenState obsoletes prior gaps ─────────────────────
#[tokio::test]
async fn handle_arrival_screen_state_obsoletes_gaps() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build();
// seq 0 delivered normally
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 0));
// Seq 3 arrives out-of-order → gaps 1 and 2 recorded
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 3));
assert_eq!(reader.gap_first_seen.len(), 2);
// ScreenState at seq 5 must discard gaps 1, 2, 3 and deliver itself
let ready = reader.handle_arrival(EncryptedFrame::ScreenState(vec![]), 5);
assert!(
ready
.iter()
.any(|f| matches!(f, EncryptedFrame::ScreenState(_))),
"ScreenState must be in the returned ready list"
);
assert!(
reader.gap_first_seen.is_empty(),
"all gaps must be discarded after ScreenState"
);
assert_eq!(reader.next_seq, 6);
}
#[tokio::test]
async fn handle_arrival_screen_state_drains_following_buffered_frames() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build();
// seq 0 delivered
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 0));
// Pre-buffer seq 6 (next after the upcoming ScreenState at 5)
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 6));
// ScreenState at seq 5 — should deliver itself AND drain buffered seq 6
let ready = reader.handle_arrival(EncryptedFrame::ScreenState(vec![]), 5);
assert_eq!(
ready.len(),
2,
"ready must contain the ScreenState and the following buffered frame"
);
assert_eq!(reader.next_seq, 7);
assert!(reader.recv_buffer.is_empty());
}
#[tokio::test]
async fn handle_arrival_screen_state_compressed_also_obsoletes_gaps() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build();
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 0));
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 3));
assert!(!reader.gap_first_seen.is_empty());
let ready = reader.handle_arrival(EncryptedFrame::ScreenStateCompressed(vec![]), 5);
assert!(
ready
.iter()
.any(|f| matches!(f, EncryptedFrame::ScreenStateCompressed(_))),
);
assert!(reader.gap_first_seen.is_empty());
}
// ── handle_arrival: burst gap threshold + immediate NAK ──────────────────
#[tokio::test]
async fn handle_arrival_burst_triggers_repaint_request_at_threshold() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (nak_tx, mut nak_rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(32);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_out_tx(nak_tx)
.build();
// Deliver frames out-of-order to fill recv_buffer to RECV_BUFFER_REPAINT_THRESHOLD.
// next_seq starts at 0; deliver seq RECV_BUFFER_REPAINT_THRESHOLD through
// RECV_BUFFER_REPAINT_THRESHOLD * 2 so there are that many frames in the buffer.
let threshold = RECV_BUFFER_REPAINT_THRESHOLD;
for i in 0..=threshold {
let seq = u64::try_from(threshold + 1 + i).unwrap();
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), seq));
}
// Drain NAK frames; verify at least one RepaintRequest was sent.
let mut saw_repaint = false;
while let Ok(frame) = nak_rx.try_recv() {
if matches!(frame, EncryptedFrame::RepaintRequest) {
saw_repaint = true;
}
}
assert!(
saw_repaint,
"expected RepaintRequest when recv_buffer reaches threshold"
);
}
#[tokio::test]
async fn handle_arrival_new_gap_triggers_immediate_nak() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (nak_tx, mut nak_rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(32);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_out_tx(nak_tx)
.build();
// seq=5 arrives when next_seq=0 → gaps 0..4 are new → immediate NAK
drop(reader.handle_arrival(EncryptedFrame::Keepalive(0), 5));
let frame = nak_rx.try_recv().expect("expected an immediate NAK frame");
let EncryptedFrame::Nak(seqs) = frame else {
panic!("expected Nak frame, got {frame:?}");
};
assert_eq!(seqs.len(), 5, "expected gaps 0..4 in NAK");
for i in 0u64..5 {
assert!(seqs.contains(&i), "gap {i} missing from NAK");
}
}
// ── drain_given_up_seqs: consecutive give-ups with buffered frames ────────
#[test]
fn drain_given_up_seqs_consecutive_give_ups_with_buffered_frames() {
let mut reader = make_reader_sync();
// Set up: seq 0 and seq 2 are given up (retry count at MAX), seq 1 is buffered.
let past = Instant::now().checked_sub(Duration::from_mins(1)).unwrap();
let _r = reader.gap_first_seen.insert(0, past);
let _r = reader.gap_nak_count.insert(0, MAX_NAK_RETRIES);
let _r = reader.recv_buffer.insert(1, EncryptedFrame::Keepalive(0));
let _r = reader.gap_first_seen.insert(2, past);
let _r = reader.gap_nak_count.insert(2, MAX_NAK_RETRIES);
let _r = reader.recv_buffer.insert(3, EncryptedFrame::Keepalive(0));
let delivered = reader.drain_given_up_seqs();
// seq 1 and 3 (buffered after the give-ups) should be delivered
assert_eq!(
delivered.len(),
2,
"buffered frames after give-ups should be delivered"
);
assert_eq!(reader.next_seq, 4);
assert!(reader.gap_first_seen.is_empty());
assert!(reader.gap_nak_count.is_empty());
}
// ── check_nak_timeouts: multiple timed-out gaps send a single Nak ─────────
#[tokio::test]
async fn check_nak_timeouts_multiple_gaps_sends_single_nak() {
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (nak_tx, mut nak_rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(16);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_out_tx(nak_tx)
.build();
// Insert 3 gaps with an old timestamp so they all time out immediately.
let past = Instant::now().checked_sub(Duration::from_secs(10)).unwrap();
for seq in [1u64, 3, 5] {
let _r = reader.gap_first_seen.insert(seq, past);
let _r = reader.gap_nak_count.insert(seq, 0);
}
drop(reader.check_nak_timeouts());
// Collect all frames sent by check_nak_timeouts (Nak + optional RepaintRequest).
let mut frames = Vec::new();
while let Ok(f) = nak_rx.try_recv() {
frames.push(f);
}
let nak_frame = frames
.into_iter()
.find(|f| matches!(f, EncryptedFrame::Nak(_)))
.expect("expected a Nak frame");
let EncryptedFrame::Nak(seqs) = nak_frame else {
unreachable!()
};
assert_eq!(seqs.len(), 3, "all 3 gaps should appear in a single NAK");
for s in [1u64, 3, 5] {
assert!(seqs.contains(&s), "gap {s} missing from NAK");
}
}
// ── RTT: ceiling exact boundary ───────────────────────────────────────────
#[test]
fn update_rtt_estimate_sample_at_exact_ceiling_is_not_clamped() {
let mut reader = make_reader_sync();
// Default ceiling = NAK_TIMEOUT (50ms) × 8 = 400ms.
// A sample exactly at 400ms must NOT be clamped (condition is `> ceiling`).
reader.update_rtt_estimate(Duration::from_millis(400));
// The estimator should have used 400ms directly (not clamped), producing
// SRTT=400ms → nak_timeout = MAX (500ms).
assert_eq!(
reader.nak_timeout.unwrap(),
MAX_NAK_TIMEOUT,
"sample equal to ceiling should not be clamped and should raise nak_timeout"
);
}
// ── handle_state_chunk ────────────────────────────────────────────────────
#[tokio::test]
async fn handle_state_chunk_single_chunk_completes_assembly() {
use std::sync::Mutex as StdMutex;
use zstd::encode_all;
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.build();
let emulator = Arc::new(StdMutex::new(Emulator::new(24, 80)));
let renderer = Arc::new(StdMutex::new(Renderer::new(24, 80)));
let (stdout_tx, _stdout_rx) = tokio::sync::mpsc::channel::<Vec<u8>>(8);
let raw = b"hello";
let compressed = encode_all(raw.as_slice(), 0).unwrap();
// Single-chunk assembly: seq=0, total=1
reader
.handle_state_chunk(0, 1, compressed, &emulator, &renderer, &stdout_tx)
.await;
// After completion the assembly state must be reset
assert_eq!(reader.pending_chunk_seq, 0);
assert_eq!(reader.pending_chunk_total, 0);
assert!(reader.pending_chunk_data.is_empty());
}
#[tokio::test]
async fn handle_state_chunk_out_of_order_clears_and_requests_repaint() {
use std::sync::Mutex as StdMutex;
let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap());
let (nak_tx, mut nak_rx) = tokio::sync::mpsc::channel::<EncryptedFrame>(8);
let mut reader = UdpReader::builder()
.socket(socket)
.id(Uuid::new_v4())
.rnk(LessSafeKey::new(
UnboundKey::new(&AES_256_GCM_SIV, &[0u8; 32]).unwrap(),
))
.hmac(Key::new(HMAC_SHA512, &[0u8; 64]))
.nak_out_tx(nak_tx)
.build();
let emulator = Arc::new(StdMutex::new(Emulator::new(24, 80)));
let renderer = Arc::new(StdMutex::new(Renderer::new(24, 80)));
let (stdout_tx, _stdout_rx) = tokio::sync::mpsc::channel::<Vec<u8>>(8);
// Start assembly: seq=0, total=3
reader
.handle_state_chunk(0, 3, vec![0xAA; 10], &emulator, &renderer, &stdout_tx)
.await;
// Out-of-order: seq=2 (skipping seq=1) → discard and send RepaintRequest
reader
.handle_state_chunk(2, 3, vec![0xBB; 10], &emulator, &renderer, &stdout_tx)
.await;
assert!(
reader.pending_chunk_data.is_empty(),
"assembly must be cleared"
);
let frame = nak_rx.try_recv().expect("expected RepaintRequest");
assert!(
matches!(frame, EncryptedFrame::RepaintRequest),
"expected RepaintRequest after out-of-order chunk"
);
}
}