matrix_sdk/sliding_sync/mod.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
// Copyright 2022-2023 Benjamin Kampmann
// Copyright 2022 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for that specific language governing permissions and
// limitations under the License.
#![doc = include_str!("README.md")]
mod builder;
mod cache;
mod client;
mod error;
mod list;
mod room;
mod sticky_parameters;
mod utils;
use std::{
collections::{btree_map::Entry, BTreeMap, HashSet},
fmt::Debug,
future::Future,
sync::{Arc, RwLock as StdRwLock},
time::Duration,
};
use async_stream::stream;
pub use client::{Version, VersionBuilder};
use futures_core::stream::Stream;
pub use matrix_sdk_base::sliding_sync::http;
use matrix_sdk_common::{deserialized_responses::SyncTimelineEvent, timer};
use ruma::{
api::{client::error::ErrorKind, OutgoingRequest},
assign, OwnedEventId, OwnedRoomId, RoomId,
};
use serde::{Deserialize, Serialize};
use tokio::{
select, spawn,
sync::{broadcast::Sender, Mutex as AsyncMutex, OwnedMutexGuard, RwLock as AsyncRwLock},
};
use tracing::{debug, error, info, instrument, trace, warn, Instrument, Span};
#[cfg(feature = "e2e-encryption")]
use self::utils::JoinHandleExt as _;
pub use self::{builder::*, client::VersionBuilderError, error::*, list::*, room::*};
use self::{
cache::restore_sliding_sync_state,
client::SlidingSyncResponseProcessor,
sticky_parameters::{LazyTransactionId, SlidingSyncStickyManager, StickyData},
};
use crate::{config::RequestConfig, Client, HttpError, Result};
/// The Sliding Sync instance.
///
/// It is OK to clone this type as much as you need: cloning it is cheap.
#[derive(Clone, Debug)]
pub struct SlidingSync {
/// The Sliding Sync data.
inner: Arc<SlidingSyncInner>,
}
#[derive(Debug)]
pub(super) struct SlidingSyncInner {
/// A unique identifier for this instance of sliding sync.
///
/// Used to distinguish different connections to the sliding sync proxy.
id: String,
/// Either an overridden sliding sync [`Version`], or one inherited from the
/// client.
version: Version,
/// The HTTP Matrix client.
client: Client,
/// Long-polling timeout that appears the sliding sync proxy request.
poll_timeout: Duration,
/// Extra duration for the sliding sync request to timeout. This is added to
/// the [`Self::proxy_timeout`].
network_timeout: Duration,
/// The storage key to keep this cache at and load it from.
storage_key: String,
/// Should this sliding sync instance try to restore its sync position
/// from the database?
///
/// Note: in non-cfg(e2e-encryption) builds, it's always set to false. We
/// keep it even so, to avoid sparkling cfg statements everywhere
/// throughout this file.
share_pos: bool,
/// Position markers.
///
/// The `pos` marker represents a progression when exchanging requests and
/// responses with the server: the server acknowledges the request by
/// responding with a new `pos`. If the client sends two non-necessarily
/// consecutive requests with the same `pos`, the server has to reply with
/// the same identical response.
///
/// `position` is behind a mutex so that a new request starts after the
/// previous request trip has fully ended (successfully or not). This
/// mechanism exists to wait for the response to be handled and to see the
/// `position` being updated, before sending a new request.
position: Arc<AsyncMutex<SlidingSyncPositionMarkers>>,
/// The lists of this Sliding Sync instance.
lists: AsyncRwLock<BTreeMap<String, SlidingSyncList>>,
/// All the rooms synced with Sliding Sync.
rooms: AsyncRwLock<BTreeMap<OwnedRoomId, SlidingSyncRoom>>,
/// Request parameters that are sticky.
sticky: StdRwLock<SlidingSyncStickyManager<SlidingSyncStickyParameters>>,
/// Internal channel used to pass messages between Sliding Sync and other
/// types.
internal_channel: Sender<SlidingSyncInternalMessage>,
}
impl SlidingSync {
pub(super) fn new(inner: SlidingSyncInner) -> Self {
Self { inner: Arc::new(inner) }
}
async fn cache_to_storage(&self, position: &SlidingSyncPositionMarkers) -> Result<()> {
cache::store_sliding_sync_state(self, position).await
}
/// Create a new [`SlidingSyncBuilder`].
pub fn builder(id: String, client: Client) -> Result<SlidingSyncBuilder, Error> {
SlidingSyncBuilder::new(id, client)
}
/// Subscribe to many rooms.
///
/// If the associated `Room`s exist, it will be marked as
/// members are missing, so that it ensures to re-fetch all members.
///
/// A subscription to an already subscribed room is ignored.
pub fn subscribe_to_rooms(
&self,
room_ids: &[&RoomId],
settings: Option<http::request::RoomSubscription>,
cancel_in_flight_request: bool,
) {
let settings = settings.unwrap_or_default();
let mut sticky = self.inner.sticky.write().unwrap();
let room_subscriptions = &mut sticky.data_mut().room_subscriptions;
let mut skip_over_current_sync_loop_iteration = false;
for room_id in room_ids {
// If the room subscription already exists, let's not
// override it with a new one. First, it would reset its
// state (`RoomSubscriptionState`), and second it would try to
// re-subscribe with the next request. We don't want that. A room
// subscription should happen once, and next subscriptions should
// be ignored.
if let Entry::Vacant(entry) = room_subscriptions.entry((*room_id).to_owned()) {
if let Some(room) = self.inner.client.get_room(room_id) {
room.mark_members_missing();
}
entry.insert((RoomSubscriptionState::default(), settings.clone()));
skip_over_current_sync_loop_iteration = true;
}
}
if cancel_in_flight_request && skip_over_current_sync_loop_iteration {
self.inner.internal_channel_send_if_possible(
SlidingSyncInternalMessage::SyncLoopSkipOverCurrentIteration,
);
}
}
/// Lookup a specific room
pub async fn get_room(&self, room_id: &RoomId) -> Option<SlidingSyncRoom> {
self.inner.rooms.read().await.get(room_id).cloned()
}
/// Check the number of rooms.
pub fn get_number_of_rooms(&self) -> usize {
self.inner.rooms.blocking_read().len()
}
/// Find a list by its name, and do something on it if it exists.
pub async fn on_list<Function, FunctionOutput, R>(
&self,
list_name: &str,
function: Function,
) -> Option<R>
where
Function: FnOnce(&SlidingSyncList) -> FunctionOutput,
FunctionOutput: Future<Output = R>,
{
let lists = self.inner.lists.read().await;
match lists.get(list_name) {
Some(list) => Some(function(list).await),
None => None,
}
}
/// Add the list to the list of lists.
///
/// As lists need to have a unique `.name`, if a list with the same name
/// is found the new list will replace the old one and the return it or
/// `None`.
pub async fn add_list(
&self,
list_builder: SlidingSyncListBuilder,
) -> Result<Option<SlidingSyncList>> {
let list = list_builder.build(self.inner.internal_channel.clone());
let old_list = self.inner.lists.write().await.insert(list.name().to_owned(), list);
self.inner.internal_channel_send_if_possible(
SlidingSyncInternalMessage::SyncLoopSkipOverCurrentIteration,
);
Ok(old_list)
}
/// Add a list that will be cached and reloaded from the cache.
///
/// This will raise an error if a storage key was not set, or if there
/// was a I/O error reading from the cache.
///
/// The rest of the semantics is the same as [`Self::add_list`].
pub async fn add_cached_list(
&self,
mut list_builder: SlidingSyncListBuilder,
) -> Result<Option<SlidingSyncList>> {
let _timer = timer!(format!("restoring (loading+processing) list {}", list_builder.name));
list_builder.set_cached_and_reload(&self.inner.client, &self.inner.storage_key).await?;
self.add_list(list_builder).await
}
/// Lookup a set of rooms
pub async fn get_rooms<I: Iterator<Item = OwnedRoomId>>(
&self,
room_ids: I,
) -> Vec<Option<SlidingSyncRoom>> {
let rooms = self.inner.rooms.read().await;
room_ids.map(|room_id| rooms.get(&room_id).cloned()).collect()
}
/// Get all rooms.
pub async fn get_all_rooms(&self) -> Vec<SlidingSyncRoom> {
self.inner.rooms.read().await.values().cloned().collect()
}
/// Handle the HTTP response.
#[instrument(skip_all)]
async fn handle_response(
&self,
mut sliding_sync_response: http::Response,
position: &mut SlidingSyncPositionMarkers,
) -> Result<UpdateSummary, crate::Error> {
let pos = Some(sliding_sync_response.pos.clone());
let must_process_rooms_response = self.must_process_rooms_response().await;
trace!(yes = must_process_rooms_response, "Must process rooms response?");
// Compute `limited` for the SS proxy only, if we're interested in a room list
// query.
if !self.inner.version.is_native() && must_process_rooms_response {
let known_rooms = self.inner.rooms.read().await;
compute_limited(&known_rooms, &mut sliding_sync_response.rooms);
}
// Transform a Sliding Sync Response to a `SyncResponse`.
//
// We may not need the `sync_response` in the future (once `SyncResponse` will
// move to Sliding Sync, i.e. to `http::Response`), but processing the
// `sliding_sync_response` is vital, so it must be done somewhere; for now it
// happens here.
let mut sync_response = {
// Take the lock to avoid concurrent sliding syncs overwriting each other's room
// infos.
let _sync_lock = self.inner.client.base_client().sync_lock().lock().await;
let rooms = &*self.inner.rooms.read().await;
let mut response_processor =
SlidingSyncResponseProcessor::new(self.inner.client.clone(), rooms);
#[cfg(feature = "e2e-encryption")]
if self.is_e2ee_enabled() {
response_processor.handle_encryption(&sliding_sync_response.extensions).await?
}
// Only handle the room's subsection of the response, if this sliding sync was
// configured to do so. That's because even when not requesting it,
// sometimes the current (2023-07-20) proxy will forward room events
// unrelated to the current connection's parameters.
//
// NOTE: SS proxy workaround.
if must_process_rooms_response {
response_processor
.handle_room_response(&sliding_sync_response, self.inner.version.is_native())
.await?;
}
response_processor.process_and_take_response().await?
};
debug!(?sync_response, "Sliding Sync response has been handled by the client");
// Commit sticky parameters, if needed.
if let Some(ref txn_id) = sliding_sync_response.txn_id {
let txn_id = txn_id.as_str().into();
self.inner.sticky.write().unwrap().maybe_commit(txn_id);
let mut lists = self.inner.lists.write().await;
lists.values_mut().for_each(|list| list.maybe_commit_sticky(txn_id));
}
let update_summary = {
// Update the rooms.
let updated_rooms = {
let mut rooms_map = self.inner.rooms.write().await;
let mut updated_rooms = Vec::with_capacity(sync_response.rooms.join.len());
for (room_id, mut room_data) in sliding_sync_response.rooms.into_iter() {
// `sync_response` contains the rooms with decrypted events if any, so look at
// the timeline events here first if the room exists.
// Otherwise, let's look at the timeline inside the `sliding_sync_response`.
let timeline =
if let Some(joined_room) = sync_response.rooms.join.remove(&room_id) {
joined_room.timeline.events
} else {
room_data.timeline.drain(..).map(SyncTimelineEvent::new).collect()
};
match rooms_map.get_mut(&room_id) {
// The room existed before, let's update it.
Some(room) => {
room.update(room_data, timeline);
}
// First time we need this room, let's create it.
None => {
rooms_map.insert(
room_id.clone(),
SlidingSyncRoom::new(
self.inner.client.clone(),
room_id.clone(),
room_data.prev_batch,
timeline,
),
);
}
}
updated_rooms.push(room_id);
}
// There might be other rooms that were only mentioned in the sliding sync
// extensions part of the response, and thus would result in rooms present in
// the `sync_response.join`. Mark them as updated too.
//
// Since we've removed rooms that were in the room subsection from
// `sync_response.rooms.join`, the remaining ones aren't already present in
// `updated_rooms` and wouldn't cause any duplicates.
updated_rooms.extend(sync_response.rooms.join.keys().cloned());
updated_rooms
};
// Update the lists.
let updated_lists = {
debug!(
lists = ?sliding_sync_response.lists,
"Update lists"
);
let mut updated_lists = Vec::with_capacity(sliding_sync_response.lists.len());
let mut lists = self.inner.lists.write().await;
// Iterate on known lists, not on lists in the response. Rooms may have been
// updated that were not involved in any list update.
for (name, list) in lists.iter_mut() {
if let Some(updates) = sliding_sync_response.lists.get(name) {
let maximum_number_of_rooms: u32 =
updates.count.try_into().expect("failed to convert `count` to `u32`");
if list.update(Some(maximum_number_of_rooms))? {
updated_lists.push(name.clone());
}
} else if list.update(None)? {
updated_lists.push(name.clone());
}
}
// Report about unknown lists.
for name in sliding_sync_response.lists.keys() {
if !lists.contains_key(name) {
error!("Response for list `{name}` - unknown to us; skipping");
}
}
updated_lists
};
UpdateSummary { lists: updated_lists, rooms: updated_rooms }
};
// Everything went well, we can update the position markers.
//
// Save the new position markers.
position.pos = pos;
Ok(update_summary)
}
async fn generate_sync_request(
&self,
txn_id: &mut LazyTransactionId,
) -> Result<(http::Request, RequestConfig, OwnedMutexGuard<SlidingSyncPositionMarkers>)> {
// Collect requests for lists.
let mut requests_lists = BTreeMap::new();
let require_timeout = {
let lists = self.inner.lists.read().await;
// Start at `true` in case there is zero list.
let mut require_timeout = true;
for (name, list) in lists.iter() {
requests_lists.insert(name.clone(), list.next_request(txn_id)?);
require_timeout = require_timeout && list.requires_timeout();
}
require_timeout
};
// Collect the `pos`.
//
// Wait on the `position` mutex to be available. It means no request nor
// response is running. The `position` mutex is released whether the response
// has been fully handled successfully, in this case the `pos` is updated, or
// the response handling has failed, in this case the `pos` hasn't been updated
// and the same `pos` will be used for this new request.
let mut position_guard = self.inner.position.clone().lock_owned().await;
let to_device_enabled =
self.inner.sticky.read().unwrap().data().extensions.to_device.enabled == Some(true);
let restored_fields = if self.inner.share_pos || to_device_enabled {
let lists = self.inner.lists.read().await;
restore_sliding_sync_state(&self.inner.client, &self.inner.storage_key, &lists).await?
} else {
None
};
// Update pos: either the one restored from the database, if any and the sliding
// sync was configured so, or read it from the memory cache.
let pos = if self.inner.share_pos {
if let Some(fields) = &restored_fields {
// Override the memory one with the database one, for consistency.
if fields.pos != position_guard.pos {
info!(
"Pos from previous request ('{:?}') was different from \
pos in database ('{:?}').",
position_guard.pos, fields.pos
);
position_guard.pos = fields.pos.clone();
}
fields.pos.clone()
} else {
position_guard.pos.clone()
}
} else {
position_guard.pos.clone()
};
Span::current().record("pos", &pos);
// There is a non-negligible difference MSC3575 and MSC4186 in how
// the `e2ee` extension works. When the client sends a request with
// no `pos`:
//
// * MSC3575 returns all device lists updates since the last request from the
// device that asked for device lists (this works similarly to to-device
// message handling),
// * MSC4186 returns no device lists updates, as it only returns changes since
// the provided `pos` (which is `null` in this case); this is in line with
// sync v2.
//
// Therefore, with MSC4186, the device list cache must be marked as to be
// re-downloaded if the `since` token is `None`, otherwise it's easy to miss
// device lists updates that happened between the previous request and the new
// “initial” request.
#[cfg(feature = "e2e-encryption")]
if pos.is_none() && self.inner.version.is_native() && self.is_e2ee_enabled() {
info!("Marking all tracked users as dirty");
let olm_machine = self.inner.client.olm_machine().await;
let olm_machine = olm_machine.as_ref().ok_or(Error::NoOlmMachine)?;
olm_machine.mark_all_tracked_users_as_dirty().await?;
}
// Configure the timeout.
//
// The `timeout` query is necessary when all lists require it. Please see
// [`SlidingSyncList::requires_timeout`].
let timeout = require_timeout.then(|| self.inner.poll_timeout);
let mut request = assign!(http::Request::new(), {
conn_id: Some(self.inner.id.clone()),
pos,
timeout,
lists: requests_lists,
});
// Apply sticky parameters, if needs be.
self.inner.sticky.write().unwrap().maybe_apply(&mut request, txn_id);
// Extensions are now applied (via sticky parameters).
//
// Override the to-device token if the extension is enabled.
if to_device_enabled {
request.extensions.to_device.since =
restored_fields.and_then(|fields| fields.to_device_token);
}
// Apply the transaction id if one was generated.
if let Some(txn_id) = txn_id.get() {
request.txn_id = Some(txn_id.to_string());
}
Ok((
// The request itself.
request,
// Configure long-polling. We need some time for the long-poll itself,
// and extra time for the network delays.
RequestConfig::default().timeout(self.inner.poll_timeout + self.inner.network_timeout),
position_guard,
))
}
/// Send a sliding sync request.
///
/// This method contains the sending logic. It takes a generic `Request`
/// because it can be an MSC4186 or an MSC3575 `Request`.
async fn send_sync_request<Request>(
&self,
request: Request,
request_config: RequestConfig,
mut position_guard: OwnedMutexGuard<SlidingSyncPositionMarkers>,
) -> Result<UpdateSummary>
where
Request: OutgoingRequest + Clone + Debug + Send + Sync + 'static,
Request::IncomingResponse: Send
+ Sync
+
// This is required to get back an MSC4186 `Response` whatever the
// `Request` type.
Into<http::Response>,
HttpError: From<ruma::api::error::FromHttpResponseError<Request::EndpointError>>,
{
debug!("Sending request");
// Prepare the request.
let request = self
.inner
.client
.send(request)
.with_request_config(request_config)
.with_homeserver_override(self.inner.version.overriding_url().map(ToString::to_string));
// Send the request and get a response with end-to-end encryption support.
//
// Sending the `/sync` request out when end-to-end encryption is enabled means
// that we need to also send out any outgoing e2ee related request out
// coming from the `OlmMachine::outgoing_requests()` method.
#[cfg(feature = "e2e-encryption")]
let response = {
if self.is_e2ee_enabled() {
// Here, we need to run 2 things:
//
// 1. Send the sliding sync request and get a response,
// 2. Send the E2EE requests.
//
// We don't want to use a `join` or `try_join` because we want to fail if and
// only if sending the sliding sync request fails. Failing to send the E2EE
// requests should just result in a log.
//
// We also want to give the priority to sliding sync request. E2EE requests are
// sent concurrently to the sliding sync request, but the priority is on waiting
// a sliding sync response.
//
// If sending sliding sync request fails, the sending of E2EE requests must be
// aborted as soon as possible.
let client = self.inner.client.clone();
let e2ee_uploads = spawn(async move {
if let Err(error) = client.send_outgoing_requests().await {
error!(?error, "Error while sending outgoing E2EE requests");
}
})
// Ensure that the task is not running in detached mode. It is aborted when it's
// dropped.
.abort_on_drop();
// Wait on the sliding sync request success or failure early.
let response = request.await?;
// At this point, if `request` has been resolved successfully, we wait on
// `e2ee_uploads`. It did run concurrently, so it should not be blocking for too
// long. Otherwise —if `request` has failed— `e2ee_uploads` has
// been dropped, so aborted.
e2ee_uploads.await.map_err(|error| Error::JoinError {
task_description: "e2ee_uploads".to_owned(),
error,
})?;
response
} else {
request.await?
}
};
// Send the request and get a response _without_ end-to-end encryption support.
#[cfg(not(feature = "e2e-encryption"))]
let response = request.await?;
// The code manipulates `Request` and `Response` from MSC4186 because it's the
// future standard. But this function may have received a `Request` from MSC4186
// or MSC3575. We need to get back an MSC4186 `Response`.
let response = Into::<http::msc4186::Response>::into(response);
debug!("Received response");
// At this point, the request has been sent, and a response has been received.
//
// We must ensure the handling of the response cannot be stopped/
// cancelled. It must be done entirely, otherwise we can have
// corrupted/incomplete states for Sliding Sync and other parts of
// the code.
//
// That's why we are running the handling of the response in a spawned
// future that cannot be cancelled by anything.
let this = self.clone();
// Spawn a new future to ensure that the code inside this future cannot be
// cancelled if this method is cancelled.
let future = async move {
debug!("Start handling response");
// In case the task running this future is detached, we must
// ensure responses are handled one at a time. At this point we still own
// `position_guard`, so we're fine.
// Handle the response.
let updates = this.handle_response(response, &mut position_guard).await?;
this.cache_to_storage(&position_guard).await?;
// Release the position guard lock.
// It means that other responses can be generated and then handled later.
drop(position_guard);
debug!("Done handling response");
Ok(updates)
};
spawn(future.instrument(Span::current())).await.unwrap()
}
/// Is the e2ee extension enabled for this sliding sync instance?
#[cfg(feature = "e2e-encryption")]
fn is_e2ee_enabled(&self) -> bool {
self.inner.sticky.read().unwrap().data().extensions.e2ee.enabled == Some(true)
}
#[cfg(not(feature = "e2e-encryption"))]
fn is_e2ee_enabled(&self) -> bool {
false
}
/// Should we process the room's subpart of a response?
async fn must_process_rooms_response(&self) -> bool {
// We consider that we must, if there's any room subscription or there's any
// list.
!self.inner.sticky.read().unwrap().data().room_subscriptions.is_empty()
|| !self.inner.lists.read().await.is_empty()
}
#[instrument(skip_all, fields(pos, conn_id = self.inner.id))]
async fn sync_once(&self) -> Result<UpdateSummary> {
let (request, request_config, position_guard) =
self.generate_sync_request(&mut LazyTransactionId::new()).await?;
// The code manipulates `Request` and `Response` from MSC4186 because it's
// the future standard (at the time of writing: 2024-09-09). Let's check if
// the generated request must be transformed into an MSC3575 `Request`.
let summaries = if !self.inner.version.is_native() {
self.send_sync_request(
Into::<http::msc3575::Request>::into(request),
request_config,
position_guard,
)
.await?
} else {
self.send_sync_request(request, request_config, position_guard).await?
};
// Notify a new sync was received
self.inner.client.inner.sync_beat.notify(usize::MAX);
Ok(summaries)
}
/// Create a _new_ Sliding Sync sync loop.
///
/// This method returns a `Stream`, which will send requests and will handle
/// responses automatically. Lists and rooms are updated automatically.
///
/// This function returns `Ok(…)` if everything went well, otherwise it will
/// return `Err(…)`. An `Err` will _always_ lead to the `Stream`
/// termination.
#[allow(unknown_lints, clippy::let_with_type_underscore)] // triggered by instrument macro
#[instrument(name = "sync_stream", skip_all, fields(conn_id = self.inner.id, with_e2ee = self.is_e2ee_enabled()))]
pub fn sync(&self) -> impl Stream<Item = Result<UpdateSummary, crate::Error>> + '_ {
debug!("Starting sync stream");
let mut internal_channel_receiver = self.inner.internal_channel.subscribe();
stream! {
loop {
debug!("Sync stream is running");
select! {
biased;
internal_message = internal_channel_receiver.recv() => {
use SlidingSyncInternalMessage::*;
debug!(?internal_message, "Sync stream has received an internal message");
match internal_message {
Err(_) | Ok(SyncLoopStop) => {
break;
}
Ok(SyncLoopSkipOverCurrentIteration) => {
continue;
}
}
}
update_summary = self.sync_once() => {
match update_summary {
Ok(updates) => {
yield Ok(updates);
}
// Here, errors we **cannot** ignore, and that must stop the sync loop.
Err(error) => {
if error.client_api_error_kind() == Some(&ErrorKind::UnknownPos) {
// The Sliding Sync session has expired. Let's reset `pos` and sticky parameters.
self.expire_session().await;
}
yield Err(error);
// Terminates the loop, and terminates the stream.
break;
}
}
}
}
}
debug!("Sync stream has exited.");
}
}
/// Force to stop the sync loop ([`Self::sync`]) if it's running.
///
/// Usually, dropping the `Stream` returned by [`Self::sync`] should be
/// enough to “stop” it, but depending of how this `Stream` is used, it
/// might not be obvious to drop it immediately (thinking of using this API
/// over FFI; the foreign-language might not be able to drop a value
/// immediately). Thus, calling this method will ensure that the sync loop
/// stops gracefully and as soon as it returns.
pub fn stop_sync(&self) -> Result<()> {
Ok(self.inner.internal_channel_send(SlidingSyncInternalMessage::SyncLoopStop)?)
}
/// Expire the current Sliding Sync session on the client-side.
///
/// Expiring a Sliding Sync session means: resetting `pos`. It also resets
/// sticky parameters.
///
/// This should only be used when it's clear that this session was about to
/// expire anyways, and should be used only in very specific cases (e.g.
/// multiple sliding syncs being run in parallel, and one of them has
/// expired).
///
/// This method **MUST** be called when the sync loop is stopped.
#[doc(hidden)]
pub async fn expire_session(&self) {
info!("Session expired; resetting `pos` and sticky parameters");
{
let mut position = self.inner.position.lock().await;
position.pos = None;
if let Err(err) = self.cache_to_storage(&position).await {
error!(
"couldn't invalidate sliding sync frozen state when expiring session: {err}"
);
}
}
{
let mut sticky = self.inner.sticky.write().unwrap();
// Clear all room subscriptions: we don't want to resend all room subscriptions
// when the session will restart.
sticky.data_mut().room_subscriptions.clear();
}
self.inner.lists.read().await.values().for_each(|list| list.invalidate_sticky_data());
}
}
impl SlidingSyncInner {
/// Send a message over the internal channel.
#[instrument]
fn internal_channel_send(&self, message: SlidingSyncInternalMessage) -> Result<(), Error> {
self.internal_channel.send(message).map(|_| ()).map_err(|_| Error::InternalChannelIsBroken)
}
/// Send a message over the internal channel if there is a receiver, i.e. if
/// the sync loop is running.
#[instrument]
fn internal_channel_send_if_possible(&self, message: SlidingSyncInternalMessage) {
// If there is no receiver, the send will fail, but that's OK here.
let _ = self.internal_channel.send(message);
}
}
#[derive(Copy, Clone, Debug, PartialEq)]
enum SlidingSyncInternalMessage {
/// Instruct the sync loop to stop.
SyncLoopStop,
/// Instruct the sync loop to skip over any remaining work in its iteration,
/// and to jump to the next iteration.
SyncLoopSkipOverCurrentIteration,
}
#[cfg(any(test, feature = "testing"))]
impl SlidingSync {
/// Set a new value for `pos`.
pub async fn set_pos(&self, new_pos: String) {
let mut position_lock = self.inner.position.lock().await;
position_lock.pos = Some(new_pos);
}
/// Get the sliding sync version used by this instance.
pub fn version(&self) -> &Version {
&self.inner.version
}
/// Read the static extension configuration for this Sliding Sync.
///
/// Note: this is not the next content of the sticky parameters, but rightly
/// the static configuration that was set during creation of this
/// Sliding Sync.
pub fn extensions_config(&self) -> http::request::Extensions {
let sticky = self.inner.sticky.read().unwrap();
sticky.data().extensions.clone()
}
}
#[derive(Clone, Debug)]
pub(super) struct SlidingSyncPositionMarkers {
/// An ephemeral position in the current stream, as received from the
/// previous `/sync` response, or `None` for the first request.
///
/// Should not be persisted.
pos: Option<String>,
}
/// Frozen bits of a Sliding Sync that are stored in the *state* store.
#[derive(Debug, Serialize, Deserialize)]
struct FrozenSlidingSync {
/// Deprecated: prefer storing in the crypto store.
#[serde(skip_serializing_if = "Option::is_none")]
to_device_since: Option<String>,
#[serde(default, skip_serializing_if = "Vec::is_empty")]
rooms: Vec<FrozenSlidingSyncRoom>,
}
impl FrozenSlidingSync {
fn new(rooms: &BTreeMap<OwnedRoomId, SlidingSyncRoom>) -> Self {
// The to-device token must be saved in the `FrozenCryptoSlidingSync` now.
Self {
to_device_since: None,
rooms: rooms
.iter()
.map(|(_room_id, sliding_sync_room)| FrozenSlidingSyncRoom::from(sliding_sync_room))
.collect::<Vec<_>>(),
}
}
}
#[derive(Serialize, Deserialize)]
struct FrozenSlidingSyncPos {
#[serde(skip_serializing_if = "Option::is_none")]
pos: Option<String>,
}
/// A summary of the updates received after a sync (like in
/// [`SlidingSync::sync`]).
#[derive(Debug, Clone)]
pub struct UpdateSummary {
/// The names of the lists that have seen an update.
pub lists: Vec<String>,
/// The rooms that have seen updates
pub rooms: Vec<OwnedRoomId>,
}
/// A very basic bool-ish enum to represent the state of a
/// [`http::request::RoomSubscription`]. A `RoomSubscription` that has been sent
/// once should ideally not being sent again, to mostly save bandwidth.
#[derive(Debug, Default)]
enum RoomSubscriptionState {
/// The `RoomSubscription` has not been sent or received correctly from the
/// server, i.e. the `RoomSubscription` —which is part of the sticky
/// parameters— has not been committed.
#[default]
Pending,
/// The `RoomSubscription` has been sent and received correctly by the
/// server.
Applied,
}
/// The set of sticky parameters owned by the `SlidingSyncInner` instance, and
/// sent in the request.
#[derive(Debug)]
pub(super) struct SlidingSyncStickyParameters {
/// Room subscriptions, i.e. rooms that may be out-of-scope of all lists
/// but one wants to receive updates.
room_subscriptions:
BTreeMap<OwnedRoomId, (RoomSubscriptionState, http::request::RoomSubscription)>,
/// The intended state of the extensions being supplied to sliding /sync
/// calls.
extensions: http::request::Extensions,
}
impl SlidingSyncStickyParameters {
/// Create a new set of sticky parameters.
pub fn new(
room_subscriptions: BTreeMap<OwnedRoomId, http::request::RoomSubscription>,
extensions: http::request::Extensions,
) -> Self {
Self {
room_subscriptions: room_subscriptions
.into_iter()
.map(|(room_id, room_subscription)| {
(room_id, (RoomSubscriptionState::Pending, room_subscription))
})
.collect(),
extensions,
}
}
}
impl StickyData for SlidingSyncStickyParameters {
type Request = http::Request;
fn apply(&self, request: &mut Self::Request) {
request.room_subscriptions = self
.room_subscriptions
.iter()
.filter(|(_, (state, _))| matches!(state, RoomSubscriptionState::Pending))
.map(|(room_id, (_, room_subscription))| (room_id.clone(), room_subscription.clone()))
.collect();
request.extensions = self.extensions.clone();
}
fn on_commit(&mut self) {
// All room subscriptions are marked as `Applied`.
for (state, _room_subscription) in self.room_subscriptions.values_mut() {
if matches!(state, RoomSubscriptionState::Pending) {
*state = RoomSubscriptionState::Applied;
}
}
}
}
/// As of 2023-07-13, the sliding sync proxy doesn't provide us with `limited`
/// correctly, so we cheat and "correct" it using heuristics here.
/// TODO remove this workaround as soon as support of the `limited` flag is
/// properly implemented in the open-source proxy: https://github.com/matrix-org/sliding-sync/issues/197
// NOTE: SS proxy workaround.
fn compute_limited(
local_rooms: &BTreeMap<OwnedRoomId, SlidingSyncRoom>,
remote_rooms: &mut BTreeMap<OwnedRoomId, http::response::Room>,
) {
for (room_id, remote_room) in remote_rooms {
// Only rooms marked as initially loaded are subject to the fixup.
let initial = remote_room.initial.unwrap_or(false);
if !initial {
continue;
}
if remote_room.limited {
// If the room was already marked as limited, the server knew more than we do.
continue;
}
let remote_events = &remote_room.timeline;
if remote_events.is_empty() {
trace!(?room_id, "no timeline updates in the response => not limited");
continue;
}
let Some(local_room) = local_rooms.get(room_id) else {
trace!(?room_id, "room isn't known locally => not limited");
continue;
};
let local_events = local_room.timeline_queue();
if local_events.is_empty() {
trace!(?room_id, "local timeline had no events => not limited");
continue;
}
// If the local room had some timeline events, consider it's a `limited` if
// there's absolutely no overlap between the known events and the new
// events in the timeline.
// Gather all the known event IDs. Ignore events that don't have an event ID.
let num_local_events = local_events.len();
let local_events_with_ids: HashSet<OwnedEventId> =
HashSet::from_iter(local_events.into_iter().filter_map(|event| event.event_id()));
// There's overlap if, and only if, there's at least one event in the response's
// timeline that matches an event id we've seen before.
let mut num_remote_events_missing_ids = 0;
let overlap = remote_events.iter().any(|remote_event| {
if let Some(remote_event_id) =
remote_event.get_field::<OwnedEventId>("event_id").ok().flatten()
{
local_events_with_ids.contains(&remote_event_id)
} else {
num_remote_events_missing_ids += 1;
false
}
});
remote_room.limited = !overlap;
trace!(
?room_id,
num_events_response = remote_events.len(),
num_local_events,
num_local_events_with_ids = local_events_with_ids.len(),
num_remote_events_missing_ids,
room_limited = remote_room.limited,
"done"
);
}
}
#[cfg(test)]
#[allow(clippy::dbg_macro)]
mod tests {
use std::{
collections::BTreeMap,
future::ready,
ops::Not,
sync::{Arc, Mutex},
time::Duration,
};
use assert_matches::assert_matches;
use event_listener::Listener;
use futures_util::{future::join_all, pin_mut, StreamExt};
use matrix_sdk_common::deserialized_responses::SyncTimelineEvent;
use matrix_sdk_test::async_test;
use ruma::{
api::client::error::ErrorKind, assign, owned_room_id, room_id, serde::Raw, uint,
OwnedRoomId, TransactionId,
};
use serde::Deserialize;
use serde_json::json;
use url::Url;
use wiremock::{http::Method, Match, Mock, MockServer, Request, ResponseTemplate};
use super::{
compute_limited, http,
sticky_parameters::{LazyTransactionId, SlidingSyncStickyManager},
FrozenSlidingSync, SlidingSync, SlidingSyncList, SlidingSyncListBuilder, SlidingSyncMode,
SlidingSyncRoom, SlidingSyncStickyParameters, Version,
};
use crate::{
sliding_sync::cache::restore_sliding_sync_state, test_utils::logged_in_client, Result,
};
#[derive(Copy, Clone)]
struct SlidingSyncMatcher;
impl Match for SlidingSyncMatcher {
fn matches(&self, request: &Request) -> bool {
request.url.path() == "/_matrix/client/unstable/org.matrix.simplified_msc3575/sync"
&& request.method == Method::POST
}
}
async fn new_sliding_sync(
lists: Vec<SlidingSyncListBuilder>,
) -> Result<(MockServer, SlidingSync)> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let mut sliding_sync_builder = client.sliding_sync("test-slidingsync")?;
for list in lists {
sliding_sync_builder = sliding_sync_builder.add_list(list);
}
let sliding_sync = sliding_sync_builder.build().await?;
Ok((server, sliding_sync))
}
#[async_test]
async fn test_subscribe_to_rooms() -> Result<()> {
let (server, sliding_sync) = new_sliding_sync(vec![SlidingSyncList::builder("foo")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10))])
.await?;
let stream = sliding_sync.sync();
pin_mut!(stream);
let room_id_0 = room_id!("!r0:bar.org");
let room_id_1 = room_id!("!r1:bar.org");
let room_id_2 = room_id!("!r2:bar.org");
{
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(ResponseTemplate::new(200).set_body_json(json!({
"pos": "1",
"lists": {},
"rooms": {
room_id_0: {
"name": "Room #0",
"initial": true,
},
room_id_1: {
"name": "Room #1",
"initial": true,
},
room_id_2: {
"name": "Room #2",
"initial": true,
},
}
})))
.mount_as_scoped(&server)
.await;
let _ = stream.next().await.unwrap()?;
}
let room0 = sliding_sync.inner.client.get_room(room_id_0).unwrap();
// Members aren't synced.
// We need to make them synced, so that we can test that subscribing to a room
// make members not synced. That's a desired feature.
assert!(room0.are_members_synced().not());
{
struct MemberMatcher(OwnedRoomId);
impl Match for MemberMatcher {
fn matches(&self, request: &Request) -> bool {
request.url.path()
== format!("/_matrix/client/r0/rooms/{room_id}/members", room_id = self.0)
&& request.method == Method::GET
}
}
let _mock_guard = Mock::given(MemberMatcher(room_id_0.to_owned()))
.respond_with(ResponseTemplate::new(200).set_body_json(json!({
"chunk": [],
})))
.mount_as_scoped(&server)
.await;
assert_matches!(room0.request_members().await, Ok(()));
}
// Members are now synced! We can start subscribing and see how it goes.
assert!(room0.are_members_synced());
sliding_sync.subscribe_to_rooms(&[room_id_0, room_id_1], None, true);
// OK, we have subscribed to some rooms. Let's check on `room0` if members are
// now marked as not synced.
assert!(room0.are_members_synced().not());
{
let sticky = sliding_sync.inner.sticky.read().unwrap();
let room_subscriptions = &sticky.data().room_subscriptions;
assert!(room_subscriptions.contains_key(room_id_0));
assert!(room_subscriptions.contains_key(room_id_1));
assert!(!room_subscriptions.contains_key(room_id_2));
}
// Subscribing to the same room doesn't reset the member sync state.
{
struct MemberMatcher(OwnedRoomId);
impl Match for MemberMatcher {
fn matches(&self, request: &Request) -> bool {
request.url.path()
== format!("/_matrix/client/r0/rooms/{room_id}/members", room_id = self.0)
&& request.method == Method::GET
}
}
let _mock_guard = Mock::given(MemberMatcher(room_id_0.to_owned()))
.respond_with(ResponseTemplate::new(200).set_body_json(json!({
"chunk": [],
})))
.mount_as_scoped(&server)
.await;
assert_matches!(room0.request_members().await, Ok(()));
}
// Members are synced, good, good.
assert!(room0.are_members_synced());
sliding_sync.subscribe_to_rooms(&[room_id_0], None, false);
// Members are still synced: because we have already subscribed to the
// room, the members aren't marked as unsynced.
assert!(room0.are_members_synced());
Ok(())
}
#[async_test]
async fn test_room_subscriptions_are_reset_when_session_expires() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![SlidingSyncList::builder("foo")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10))])
.await?;
let room_id_0 = room_id!("!r0:bar.org");
let room_id_1 = room_id!("!r1:bar.org");
let room_id_2 = room_id!("!r2:bar.org");
// Subscribe to two rooms.
sliding_sync.subscribe_to_rooms(&[room_id_0, room_id_1], None, false);
{
let sticky = sliding_sync.inner.sticky.read().unwrap();
let room_subscriptions = &sticky.data().room_subscriptions;
assert!(room_subscriptions.contains_key(room_id_0));
assert!(room_subscriptions.contains_key(room_id_1));
assert!(room_subscriptions.contains_key(room_id_2).not());
}
// Subscribe to one more room.
sliding_sync.subscribe_to_rooms(&[room_id_2], None, false);
{
let sticky = sliding_sync.inner.sticky.read().unwrap();
let room_subscriptions = &sticky.data().room_subscriptions;
assert!(room_subscriptions.contains_key(room_id_0));
assert!(room_subscriptions.contains_key(room_id_1));
assert!(room_subscriptions.contains_key(room_id_2));
}
// Suddenly, the session expires!
sliding_sync.expire_session().await;
{
let sticky = sliding_sync.inner.sticky.read().unwrap();
let room_subscriptions = &sticky.data().room_subscriptions;
assert!(room_subscriptions.is_empty());
}
// Subscribe to one room again.
sliding_sync.subscribe_to_rooms(&[room_id_2], None, false);
{
let sticky = sliding_sync.inner.sticky.read().unwrap();
let room_subscriptions = &sticky.data().room_subscriptions;
assert!(room_subscriptions.contains_key(room_id_0).not());
assert!(room_subscriptions.contains_key(room_id_1).not());
assert!(room_subscriptions.contains_key(room_id_2));
}
Ok(())
}
#[async_test]
async fn test_to_device_token_properly_cached() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![SlidingSyncList::builder("foo")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10))])
.await?;
// FrozenSlidingSync doesn't contain the to_device_token anymore, as it's saved
// in the crypto store since PR #2323.
let frozen = FrozenSlidingSync::new(&*sliding_sync.inner.rooms.read().await);
assert!(frozen.to_device_since.is_none());
Ok(())
}
#[async_test]
async fn test_add_list() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![SlidingSyncList::builder("foo")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10))])
.await?;
let _stream = sliding_sync.sync();
pin_mut!(_stream);
sliding_sync
.add_list(
SlidingSyncList::builder("bar")
.sync_mode(SlidingSyncMode::new_selective().add_range(50..=60)),
)
.await?;
let lists = sliding_sync.inner.lists.read().await;
assert!(lists.contains_key("foo"));
assert!(lists.contains_key("bar"));
// this test also ensures that Tokio is not panicking when calling `add_list`.
Ok(())
}
#[test]
fn test_sticky_parameters_api_invalidated_flow() {
let r0 = room_id!("!r0.matrix.org");
let r1 = room_id!("!r1:matrix.org");
let mut room_subscriptions = BTreeMap::new();
room_subscriptions.insert(r0.to_owned(), Default::default());
// At first it's invalidated.
let mut sticky = SlidingSyncStickyManager::new(SlidingSyncStickyParameters::new(
room_subscriptions,
Default::default(),
));
assert!(sticky.is_invalidated());
// Then when we create a request, the sticky parameters are applied.
let txn_id: &TransactionId = "tid123".into();
let mut request = http::Request::default();
request.txn_id = Some(txn_id.to_string());
sticky.maybe_apply(&mut request, &mut LazyTransactionId::from_owned(txn_id.to_owned()));
assert!(request.txn_id.is_some());
assert_eq!(request.room_subscriptions.len(), 1);
assert!(request.room_subscriptions.contains_key(r0));
let tid = request.txn_id.unwrap();
sticky.maybe_commit(tid.as_str().into());
assert!(!sticky.is_invalidated());
// Applying new parameters will invalidate again.
sticky
.data_mut()
.room_subscriptions
.insert(r1.to_owned(), (Default::default(), Default::default()));
assert!(sticky.is_invalidated());
// Committing with the wrong transaction id will keep it invalidated.
sticky.maybe_commit("wrong tid today, my love has gone away 🎵".into());
assert!(sticky.is_invalidated());
// Restarting a request will only remember the last generated transaction id.
let txn_id1: &TransactionId = "tid456".into();
let mut request1 = http::Request::default();
request1.txn_id = Some(txn_id1.to_string());
sticky.maybe_apply(&mut request1, &mut LazyTransactionId::from_owned(txn_id1.to_owned()));
assert!(sticky.is_invalidated());
// The first room subscription has been applied to `request`, so it's not
// reapplied here. It's a particular logic of `room_subscriptions`, it's not
// related to the sticky design.
assert_eq!(request1.room_subscriptions.len(), 1);
assert!(request1.room_subscriptions.contains_key(r1));
let txn_id2: &TransactionId = "tid789".into();
let mut request2 = http::Request::default();
request2.txn_id = Some(txn_id2.to_string());
sticky.maybe_apply(&mut request2, &mut LazyTransactionId::from_owned(txn_id2.to_owned()));
assert!(sticky.is_invalidated());
// `request2` contains `r1` because the sticky parameters have not been
// committed, so it's still marked as pending.
assert_eq!(request2.room_subscriptions.len(), 1);
assert!(request2.room_subscriptions.contains_key(r1));
// Here we commit with the not most-recent TID, so it keeps the invalidated
// status.
sticky.maybe_commit(txn_id1);
assert!(sticky.is_invalidated());
// But here we use the latest TID, so the commit is effective.
sticky.maybe_commit(txn_id2);
assert!(!sticky.is_invalidated());
}
#[test]
fn test_room_subscriptions_are_sticky() {
let r0 = room_id!("!r0.matrix.org");
let r1 = room_id!("!r1:matrix.org");
let mut sticky = SlidingSyncStickyManager::new(SlidingSyncStickyParameters::new(
BTreeMap::new(),
Default::default(),
));
// A room subscription is added, applied, and committed.
{
// Insert `r0`.
sticky
.data_mut()
.room_subscriptions
.insert(r0.to_owned(), (Default::default(), Default::default()));
// Then the sticky parameters are applied.
let txn_id: &TransactionId = "tid0".into();
let mut request = http::Request::default();
request.txn_id = Some(txn_id.to_string());
sticky.maybe_apply(&mut request, &mut LazyTransactionId::from_owned(txn_id.to_owned()));
assert!(request.txn_id.is_some());
assert_eq!(request.room_subscriptions.len(), 1);
assert!(request.room_subscriptions.contains_key(r0));
// Then the sticky parameters are committed.
let tid = request.txn_id.unwrap();
sticky.maybe_commit(tid.as_str().into());
}
// A room subscription is added, applied, but NOT committed.
{
// Insert `r1`.
sticky
.data_mut()
.room_subscriptions
.insert(r1.to_owned(), (Default::default(), Default::default()));
// Then the sticky parameters are applied.
let txn_id: &TransactionId = "tid1".into();
let mut request = http::Request::default();
request.txn_id = Some(txn_id.to_string());
sticky.maybe_apply(&mut request, &mut LazyTransactionId::from_owned(txn_id.to_owned()));
assert!(request.txn_id.is_some());
assert_eq!(request.room_subscriptions.len(), 1);
// `r0` is not present, it's only `r1`.
assert!(request.room_subscriptions.contains_key(r1));
// Then the sticky parameters are NOT committed.
// It can happen if the request has failed to be sent for example,
// or if the response didn't match.
}
// A previously added room subscription is re-added, applied, and committed.
{
// Then the sticky parameters are applied.
let txn_id: &TransactionId = "tid2".into();
let mut request = http::Request::default();
request.txn_id = Some(txn_id.to_string());
sticky.maybe_apply(&mut request, &mut LazyTransactionId::from_owned(txn_id.to_owned()));
assert!(request.txn_id.is_some());
assert_eq!(request.room_subscriptions.len(), 1);
// `r0` is not present, it's only `r1`.
assert!(request.room_subscriptions.contains_key(r1));
// Then the sticky parameters are committed.
let tid = request.txn_id.unwrap();
sticky.maybe_commit(tid.as_str().into());
}
// All room subscriptions have been committed.
{
// Then the sticky parameters are applied.
let txn_id: &TransactionId = "tid3".into();
let mut request = http::Request::default();
request.txn_id = Some(txn_id.to_string());
sticky.maybe_apply(&mut request, &mut LazyTransactionId::from_owned(txn_id.to_owned()));
assert!(request.txn_id.is_some());
// All room subscriptions have been sent.
assert!(request.room_subscriptions.is_empty());
}
}
#[test]
fn test_extensions_are_sticky() {
let mut extensions = http::request::Extensions::default();
extensions.account_data.enabled = Some(true);
// At first it's invalidated.
let mut sticky = SlidingSyncStickyManager::new(SlidingSyncStickyParameters::new(
Default::default(),
extensions,
));
assert!(sticky.is_invalidated(), "invalidated because of non default parameters");
// `StickyParameters::new` follows its caller's intent when it comes to e2ee and
// to-device.
let extensions = &sticky.data().extensions;
assert_eq!(extensions.e2ee.enabled, None);
assert_eq!(extensions.to_device.enabled, None);
assert_eq!(extensions.to_device.since, None);
// What the user explicitly enabled is… enabled.
assert_eq!(extensions.account_data.enabled, Some(true));
let txn_id: &TransactionId = "tid123".into();
let mut request = http::Request::default();
request.txn_id = Some(txn_id.to_string());
sticky.maybe_apply(&mut request, &mut LazyTransactionId::from_owned(txn_id.to_owned()));
assert!(sticky.is_invalidated());
assert_eq!(request.extensions.to_device.enabled, None);
assert_eq!(request.extensions.to_device.since, None);
assert_eq!(request.extensions.e2ee.enabled, None);
assert_eq!(request.extensions.account_data.enabled, Some(true));
}
#[async_test]
async fn test_sticky_extensions_plus_since() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let sync = client
.sliding_sync("test-slidingsync")?
.add_list(SlidingSyncList::builder("new_list"))
.build()
.await?;
// No extensions have been explicitly enabled here.
assert_eq!(sync.inner.sticky.read().unwrap().data().extensions.to_device.enabled, None);
assert_eq!(sync.inner.sticky.read().unwrap().data().extensions.e2ee.enabled, None);
assert_eq!(sync.inner.sticky.read().unwrap().data().extensions.account_data.enabled, None);
// Now enable e2ee and to-device.
let sync = client
.sliding_sync("test-slidingsync")?
.add_list(SlidingSyncList::builder("new_list"))
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true)}),
)
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
// Even without a since token, the first request will contain the extensions
// configuration, at least.
let txn_id = TransactionId::new();
let (request, _, _) = sync
.generate_sync_request(&mut LazyTransactionId::from_owned(txn_id.to_owned()))
.await?;
assert_eq!(request.extensions.e2ee.enabled, Some(true));
assert_eq!(request.extensions.to_device.enabled, Some(true));
assert!(request.extensions.to_device.since.is_none());
{
// Committing with another transaction id doesn't validate anything.
let mut sticky = sync.inner.sticky.write().unwrap();
assert!(sticky.is_invalidated());
sticky.maybe_commit(
"hopefully the rng won't generate this very specific transaction id".into(),
);
assert!(sticky.is_invalidated());
}
// Regenerating a request will yield the same one.
let txn_id2 = TransactionId::new();
let (request, _, _) = sync
.generate_sync_request(&mut LazyTransactionId::from_owned(txn_id2.to_owned()))
.await?;
assert_eq!(request.extensions.e2ee.enabled, Some(true));
assert_eq!(request.extensions.to_device.enabled, Some(true));
assert!(request.extensions.to_device.since.is_none());
assert!(txn_id != txn_id2, "the two requests must not share the same transaction id");
{
// Committing with the expected transaction id will validate it.
let mut sticky = sync.inner.sticky.write().unwrap();
assert!(sticky.is_invalidated());
sticky.maybe_commit(txn_id2.as_str().into());
assert!(!sticky.is_invalidated());
}
// The next request should contain no sticky parameters.
let txn_id = TransactionId::new();
let (request, _, _) = sync
.generate_sync_request(&mut LazyTransactionId::from_owned(txn_id.to_owned()))
.await?;
assert!(request.extensions.e2ee.enabled.is_none());
assert!(request.extensions.to_device.enabled.is_none());
assert!(request.extensions.to_device.since.is_none());
// If there's a to-device `since` token, we make sure we put the token
// into the extension config. The rest doesn't need to be re-enabled due to
// stickiness.
let _since_token = "since";
#[cfg(feature = "e2e-encryption")]
{
use matrix_sdk_base::crypto::store::Changes;
if let Some(olm_machine) = &*client.olm_machine().await {
olm_machine
.store()
.save_changes(Changes {
next_batch_token: Some(_since_token.to_owned()),
..Default::default()
})
.await?;
}
}
let txn_id = TransactionId::new();
let (request, _, _) = sync
.generate_sync_request(&mut LazyTransactionId::from_owned(txn_id.to_owned()))
.await?;
assert!(request.extensions.e2ee.enabled.is_none());
assert!(request.extensions.to_device.enabled.is_none());
#[cfg(feature = "e2e-encryption")]
assert_eq!(request.extensions.to_device.since.as_deref(), Some(_since_token));
Ok(())
}
// With MSC4186, with the `e2ee` extension enabled, if a request has no `pos`,
// all the tracked users by the `OlmMachine` must be marked as dirty, i.e.
// `/key/query` requests must be sent. See the code to see the details.
//
// This test is asserting that.
#[async_test]
#[cfg(feature = "e2e-encryption")]
async fn test_no_pos_with_e2ee_marks_all_tracked_users_as_dirty() -> anyhow::Result<()> {
use matrix_sdk_base::crypto::types::requests::{AnyIncomingResponse, AnyOutgoingRequest};
use matrix_sdk_test::ruma_response_from_json;
use ruma::user_id;
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let alice = user_id!("@alice:localhost");
let bob = user_id!("@bob:localhost");
let me = user_id!("@example:localhost");
// Track and mark users are not dirty, so that we can check they are “dirty”
// after that. Dirty here means that a `/key/query` must be sent.
{
let olm_machine = client.olm_machine().await;
let olm_machine = olm_machine.as_ref().unwrap();
olm_machine.update_tracked_users([alice, bob]).await?;
// Assert requests.
let outgoing_requests = olm_machine.outgoing_requests().await?;
assert_eq!(outgoing_requests.len(), 2);
assert_matches!(outgoing_requests[0].request(), AnyOutgoingRequest::KeysUpload(_));
assert_matches!(outgoing_requests[1].request(), AnyOutgoingRequest::KeysQuery(_));
// Fake responses.
olm_machine
.mark_request_as_sent(
outgoing_requests[0].request_id(),
AnyIncomingResponse::KeysUpload(&ruma_response_from_json(&json!({
"one_time_key_counts": {}
}))),
)
.await?;
olm_machine
.mark_request_as_sent(
outgoing_requests[1].request_id(),
AnyIncomingResponse::KeysQuery(&ruma_response_from_json(&json!({
"device_keys": {
alice: {},
bob: {},
}
}))),
)
.await?;
// Once more.
let outgoing_requests = olm_machine.outgoing_requests().await?;
assert_eq!(outgoing_requests.len(), 1);
assert_matches!(outgoing_requests[0].request(), AnyOutgoingRequest::KeysQuery(_));
olm_machine
.mark_request_as_sent(
outgoing_requests[0].request_id(),
AnyIncomingResponse::KeysQuery(&ruma_response_from_json(&json!({
"device_keys": {
me: {},
}
}))),
)
.await?;
// No more.
let outgoing_requests = olm_machine.outgoing_requests().await?;
assert!(outgoing_requests.is_empty());
}
let sync = client
.sliding_sync("test-slidingsync")?
.add_list(SlidingSyncList::builder("new_list"))
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
// First request: no `pos`.
let txn_id = TransactionId::new();
let (_request, _, _) = sync
.generate_sync_request(&mut LazyTransactionId::from_owned(txn_id.to_owned()))
.await?;
// Now, tracked users must be dirty.
{
let olm_machine = client.olm_machine().await;
let olm_machine = olm_machine.as_ref().unwrap();
// Assert requests.
let outgoing_requests = olm_machine.outgoing_requests().await?;
assert_eq!(outgoing_requests.len(), 1);
assert_matches!(
outgoing_requests[0].request(),
AnyOutgoingRequest::KeysQuery(request) => {
assert!(request.device_keys.contains_key(alice));
assert!(request.device_keys.contains_key(bob));
assert!(request.device_keys.contains_key(me));
}
);
// Fake responses.
olm_machine
.mark_request_as_sent(
outgoing_requests[0].request_id(),
AnyIncomingResponse::KeysQuery(&ruma_response_from_json(&json!({
"device_keys": {
alice: {},
bob: {},
me: {},
}
}))),
)
.await?;
}
// Second request: with a `pos` this time.
sync.set_pos("chocolat".to_owned()).await;
let txn_id = TransactionId::new();
let (_request, _, _) = sync
.generate_sync_request(&mut LazyTransactionId::from_owned(txn_id.to_owned()))
.await?;
// Tracked users are not marked as dirty.
{
let olm_machine = client.olm_machine().await;
let olm_machine = olm_machine.as_ref().unwrap();
// Assert requests.
let outgoing_requests = olm_machine.outgoing_requests().await?;
assert!(outgoing_requests.is_empty());
}
Ok(())
}
#[async_test]
async fn test_unknown_pos_resets_pos_and_sticky_parameters() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client
.sliding_sync("test-slidingsync")?
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true) }),
)
.build()
.await?;
// First request asks to enable the extension.
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.extensions.to_device.enabled.is_some());
let sync = sliding_sync.sync();
pin_mut!(sync);
// `pos` is `None` to start with.
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
#[derive(Deserialize)]
struct PartialRequest {
txn_id: Option<String>,
}
{
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(|request: &Request| {
// Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap();
ResponseTemplate::new(200).set_body_json(json!({
"txn_id": request.txn_id,
"pos": "0",
}))
})
.mount_as_scoped(&server)
.await;
let next = sync.next().await;
assert_matches!(next, Some(Ok(_update_summary)));
// `pos` has been updated.
assert_eq!(sliding_sync.inner.position.lock().await.pos, Some("0".to_owned()));
}
// Next request doesn't ask to enable the extension.
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.extensions.to_device.enabled.is_none());
// Next request is successful.
{
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(|request: &Request| {
// Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap();
ResponseTemplate::new(200).set_body_json(json!({
"txn_id": request.txn_id,
"pos": "1",
}))
})
.mount_as_scoped(&server)
.await;
let next = sync.next().await;
assert_matches!(next, Some(Ok(_update_summary)));
// `pos` has been updated.
assert_eq!(sliding_sync.inner.position.lock().await.pos, Some("1".to_owned()));
}
// Next request is successful despite it receives an already
// received `pos` from the server.
{
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(|request: &Request| {
// Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap();
ResponseTemplate::new(200).set_body_json(json!({
"txn_id": request.txn_id,
"pos": "0", // <- already received!
}))
})
.up_to_n_times(1) // run this mock only once.
.mount_as_scoped(&server)
.await;
let next = sync.next().await;
assert_matches!(next, Some(Ok(_update_summary)));
// `pos` has been updated.
assert_eq!(sliding_sync.inner.position.lock().await.pos, Some("0".to_owned()));
}
// Stop responding with successful requests!
//
// When responding with `M_UNKNOWN_POS`, that regenerates the sticky parameters,
// so they're reset. It also resets the `pos`.
{
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(ResponseTemplate::new(400).set_body_json(json!({
"error": "foo",
"errcode": "M_UNKNOWN_POS",
})))
.mount_as_scoped(&server)
.await;
let next = sync.next().await;
// The expected error is returned.
assert_matches!(next, Some(Err(err)) if err.client_api_error_kind() == Some(&ErrorKind::UnknownPos));
// `pos` has been reset.
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
// Next request asks to enable the extension again.
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.extensions.to_device.enabled.is_some());
// `sync` has been stopped.
assert!(sync.next().await.is_none());
}
Ok(())
}
#[cfg(feature = "e2e-encryption")]
#[async_test]
async fn test_sliding_sync_doesnt_remember_pos() -> Result<()> {
let server = MockServer::start().await;
#[derive(Deserialize)]
struct PartialRequest {
txn_id: Option<String>,
}
let server_pos = Arc::new(Mutex::new(0));
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(move |request: &Request| {
// Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap();
let pos = {
let mut pos = server_pos.lock().unwrap();
let prev = *pos;
*pos += 1;
prev
};
ResponseTemplate::new(200).set_body_json(json!({
"txn_id": request.txn_id,
"pos": pos.to_string(),
}))
})
.mount_as_scoped(&server)
.await;
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client.sliding_sync("forgetful-sync")?.build().await?;
// `pos` is `None` to start with.
{
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.pos.is_none());
}
let sync = sliding_sync.sync();
pin_mut!(sync);
// Sync goes well, and then the position is saved both into the internal memory
// and the database.
let next = sync.next().await;
assert_matches!(next, Some(Ok(_update_summary)));
assert_eq!(sliding_sync.inner.position.lock().await.pos.as_deref(), Some("0"));
let restored_fields = restore_sliding_sync_state(
&client,
&sliding_sync.inner.storage_key,
&*sliding_sync.inner.lists.read().await,
)
.await?
.expect("must have restored fields");
// While it has been saved into the database, it's not necessarily going to be
// used later!
assert_eq!(restored_fields.pos.as_deref(), Some("0"));
// Now, even if we mess with the position stored in the database, the sliding
// sync instance isn't configured to reload the stream position from the
// database, so it won't be changed.
{
let other_sync = client.sliding_sync("forgetful-sync")?.build().await?;
let mut position_guard = other_sync.inner.position.lock().await;
position_guard.pos = Some("yolo".to_owned());
other_sync.cache_to_storage(&position_guard).await?;
}
// It's still 0, not "yolo".
{
assert_eq!(sliding_sync.inner.position.lock().await.pos.as_deref(), Some("0"));
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert_eq!(request.pos.as_deref(), Some("0"));
}
// Recreating a sliding sync with the same ID doesn't preload the pos, if not
// asked to.
{
let sliding_sync = client.sliding_sync("forgetful-sync")?.build().await?;
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
}
Ok(())
}
#[cfg(feature = "e2e-encryption")]
#[async_test]
async fn test_sliding_sync_does_remember_pos() -> Result<()> {
let server = MockServer::start().await;
#[derive(Deserialize)]
struct PartialRequest {
txn_id: Option<String>,
}
let server_pos = Arc::new(Mutex::new(0));
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(move |request: &Request| {
// Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap();
let pos = {
let mut pos = server_pos.lock().unwrap();
let prev = *pos;
*pos += 1;
prev
};
ResponseTemplate::new(200).set_body_json(json!({
"txn_id": request.txn_id,
"pos": pos.to_string(),
}))
})
.mount_as_scoped(&server)
.await;
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client.sliding_sync("elephant-sync")?.share_pos().build().await?;
// `pos` is `None` to start with.
{
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.pos.is_none());
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
}
let sync = sliding_sync.sync();
pin_mut!(sync);
// Sync goes well, and then the position is saved both into the internal memory
// and the database.
let next = sync.next().await;
assert_matches!(next, Some(Ok(_update_summary)));
assert_eq!(sliding_sync.inner.position.lock().await.pos, Some("0".to_owned()));
let restored_fields = restore_sliding_sync_state(
&client,
&sliding_sync.inner.storage_key,
&*sliding_sync.inner.lists.read().await,
)
.await?
.expect("must have restored fields");
// While it has been saved into the database, it's not necessarily going to be
// used later!
assert_eq!(restored_fields.pos.as_deref(), Some("0"));
// Another process modifies the stream position under our feet...
{
let other_sync = client.sliding_sync("elephant-sync")?.build().await?;
let mut position_guard = other_sync.inner.position.lock().await;
position_guard.pos = Some("42".to_owned());
other_sync.cache_to_storage(&position_guard).await?;
}
// It's alright, the next request will load it from the database.
{
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert_eq!(request.pos.as_deref(), Some("42"));
assert_eq!(sliding_sync.inner.position.lock().await.pos.as_deref(), Some("42"));
}
// Recreating a sliding sync with the same ID will reload it too.
{
let sliding_sync = client.sliding_sync("elephant-sync")?.share_pos().build().await?;
assert_eq!(sliding_sync.inner.position.lock().await.pos.as_deref(), Some("42"));
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert_eq!(request.pos.as_deref(), Some("42"));
}
// Invalidating the session will remove the in-memory value AND the database
// value.
sliding_sync.expire_session().await;
{
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.pos.is_none());
}
// And new sliding syncs with the same ID won't find it either.
{
let sliding_sync = client.sliding_sync("elephant-sync")?.share_pos().build().await?;
assert!(sliding_sync.inner.position.lock().await.pos.is_none());
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
assert!(request.pos.is_none());
}
Ok(())
}
#[async_test]
async fn test_stop_sync_loop() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![SlidingSyncList::builder("foo")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10))])
.await?;
// Start the sync loop.
let stream = sliding_sync.sync();
pin_mut!(stream);
// The sync loop is actually running.
assert!(stream.next().await.is_some());
// Stop the sync loop.
sliding_sync.stop_sync()?;
// The sync loop is actually stopped.
assert!(stream.next().await.is_none());
// Start a new sync loop.
let stream = sliding_sync.sync();
pin_mut!(stream);
// The sync loop is actually running.
assert!(stream.next().await.is_some());
Ok(())
}
#[async_test]
async fn test_sliding_sync_version() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
// By default, sliding sync inherits its version from the client, which is
// `Native`.
{
let sync = client.sliding_sync("default")?.build().await?;
assert_matches!(sync.version(), Version::Native);
}
// Sliding sync can override the configuration from the client.
{
let url = Url::parse("https://bar.matrix/").unwrap();
let sync = client
.sliding_sync("own-proxy")?
.version(Version::Proxy { url: url.clone() })
.build()
.await?;
assert_matches!(
sync.version(),
Version::Proxy { url: given_url } => {
assert_eq!(&url, given_url);
}
);
}
// Sliding sync inherits from the client…
let url = Url::parse("https://foo.matrix/").unwrap();
client.set_sliding_sync_version(Version::Proxy { url: url.clone() });
{
// The sliding sync inherits the client's sliding sync proxy URL.
let sync = client.sliding_sync("client-proxy")?.build().await?;
assert_matches!(
sync.version(),
Version::Proxy { url: given_url } => {
assert_eq!(&url, given_url);
}
);
}
{
// …unless we override it afterwards.
let sync = client.sliding_sync("own-proxy")?.version(Version::Native).build().await?;
assert_matches!(sync.version(), Version::Native);
}
Ok(())
}
#[async_test]
async fn test_limited_flag_computation() {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let make_event = |event_id: &str| -> SyncTimelineEvent {
SyncTimelineEvent::new(
Raw::from_json_string(
json!({
"event_id": event_id,
"sender": "@johnmastodon:example.org",
"origin_server_ts": 1337424242,
"type": "m.room.message",
"room_id": "!meaningless:example.org",
"content": {
"body": "Hello, world!",
"msgtype": "m.text"
},
})
.to_string(),
)
.unwrap(),
)
};
let event_a = make_event("$a");
let event_b = make_event("$b");
let event_c = make_event("$c");
let event_d = make_event("$d");
let not_initial = room_id!("!croissant:example.org");
let no_overlap = room_id!("!omelette:example.org");
let partial_overlap = room_id!("!fromage:example.org");
let complete_overlap = room_id!("!baguette:example.org");
let no_remote_events = room_id!("!pain:example.org");
let no_local_events = room_id!("!crepe:example.org");
let already_limited = room_id!("!paris:example.org");
let response_timeline = vec![event_c.raw().clone(), event_d.raw().clone()];
let local_rooms = BTreeMap::from_iter([
(
// This has no events overlapping with the response timeline, hence limited, but
// it's not marked as initial in the response.
not_initial.to_owned(),
SlidingSyncRoom::new(
client.clone(),
no_overlap.to_owned(),
None,
vec![event_a.clone(), event_b.clone()],
),
),
(
// This has no events overlapping with the response timeline, hence limited.
no_overlap.to_owned(),
SlidingSyncRoom::new(
client.clone(),
no_overlap.to_owned(),
None,
vec![event_a.clone(), event_b.clone()],
),
),
(
// This has event_c in common with the response timeline.
partial_overlap.to_owned(),
SlidingSyncRoom::new(
client.clone(),
partial_overlap.to_owned(),
None,
vec![event_a.clone(), event_b.clone(), event_c.clone()],
),
),
(
// This has all events in common with the response timeline.
complete_overlap.to_owned(),
SlidingSyncRoom::new(
client.clone(),
partial_overlap.to_owned(),
None,
vec![event_c.clone(), event_d.clone()],
),
),
(
// We locally have events for this room, and receive none in the response: not
// limited.
no_remote_events.to_owned(),
SlidingSyncRoom::new(
client.clone(),
no_remote_events.to_owned(),
None,
vec![event_c.clone(), event_d.clone()],
),
),
(
// We don't have events for this room locally, and even if the remote room contains
// some events, it's not a limited sync.
no_local_events.to_owned(),
SlidingSyncRoom::new(client.clone(), no_local_events.to_owned(), None, vec![]),
),
(
// Already limited, but would be marked limited if the flag wasn't ignored (same as
// partial overlap).
already_limited.to_owned(),
SlidingSyncRoom::new(
client,
already_limited.to_owned(),
None,
vec![event_a, event_b, event_c.clone()],
),
),
]);
let mut remote_rooms = BTreeMap::from_iter([
(
not_initial.to_owned(),
assign!(http::response::Room::default(), { timeline: response_timeline }),
),
(
no_overlap.to_owned(),
assign!(http::response::Room::default(), {
initial: Some(true),
timeline: vec![event_c.raw().clone(), event_d.raw().clone()],
}),
),
(
partial_overlap.to_owned(),
assign!(http::response::Room::default(), {
initial: Some(true),
timeline: vec![event_c.raw().clone(), event_d.raw().clone()],
}),
),
(
complete_overlap.to_owned(),
assign!(http::response::Room::default(), {
initial: Some(true),
timeline: vec![event_c.raw().clone(), event_d.raw().clone()],
}),
),
(
no_remote_events.to_owned(),
assign!(http::response::Room::default(), {
initial: Some(true),
timeline: vec![],
}),
),
(
no_local_events.to_owned(),
assign!(http::response::Room::default(), {
initial: Some(true),
timeline: vec![event_c.raw().clone(), event_d.raw().clone()],
}),
),
(
already_limited.to_owned(),
assign!(http::response::Room::default(), {
initial: Some(true),
limited: true,
timeline: vec![event_c.into_raw(), event_d.into_raw()],
}),
),
]);
compute_limited(&local_rooms, &mut remote_rooms);
assert!(!remote_rooms.get(not_initial).unwrap().limited);
assert!(remote_rooms.get(no_overlap).unwrap().limited);
assert!(!remote_rooms.get(partial_overlap).unwrap().limited);
assert!(!remote_rooms.get(complete_overlap).unwrap().limited);
assert!(!remote_rooms.get(no_remote_events).unwrap().limited);
assert!(!remote_rooms.get(no_local_events).unwrap().limited);
assert!(remote_rooms.get(already_limited).unwrap().limited);
}
#[async_test]
async fn test_process_read_receipts() -> Result<()> {
let room = owned_room_id!("!pony:example.org");
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client
.sliding_sync("test")?
.with_receipt_extension(
assign!(http::request::Receipts::default(), { enabled: Some(true) }),
)
.add_list(
SlidingSyncList::builder("all")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=100)),
)
.build()
.await?;
// Initial state.
{
let server_response = assign!(http::Response::new("0".to_owned()), {
rooms: BTreeMap::from([(
room.clone(),
http::response::Room::default(),
)])
});
let _summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
}
let server_response = assign!(http::Response::new("1".to_owned()), {
extensions: assign!(http::response::Extensions::default(), {
receipts: assign!(http::response::Receipts::default(), {
rooms: BTreeMap::from([
(
room.clone(),
Raw::from_json_string(
json!({
"room_id": room,
"type": "m.receipt",
"content": {
"$event:bar.org": {
"m.read": {
client.user_id().unwrap(): {
"ts": 1436451550,
}
}
}
}
})
.to_string(),
).unwrap()
)
])
})
})
});
let summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
assert!(summary.rooms.contains(&room));
Ok(())
}
#[async_test]
async fn test_process_marked_unread_room_account_data() -> Result<()> {
let room_id = owned_room_id!("!unicorn:example.org");
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
// Setup sliding sync with with one room and one list
let sliding_sync = client
.sliding_sync("test")?
.with_account_data_extension(
assign!(http::request::AccountData::default(), { enabled: Some(true) }),
)
.add_list(
SlidingSyncList::builder("all")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=100)),
)
.build()
.await?;
// Initial state.
{
let server_response = assign!(http::Response::new("0".to_owned()), {
rooms: BTreeMap::from([(
room_id.clone(),
http::response::Room::default(),
)])
});
let _summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
}
// Simulate a response that only changes the marked unread state of the room to
// true
let server_response = make_mark_unread_response("1", room_id.clone(), true, false);
let update_summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
// Check that the list list and entry received the update
assert!(update_summary.rooms.contains(&room_id));
let room = client.get_room(&room_id).unwrap();
// Check the actual room data, this powers RoomInfo
assert!(room.is_marked_unread());
// Change it back to false and check if it updates
let server_response = make_mark_unread_response("2", room_id.clone(), false, true);
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?;
let room = client.get_room(&room_id).unwrap();
assert!(!room.is_marked_unread());
Ok(())
}
fn make_mark_unread_response(
response_number: &str,
room_id: OwnedRoomId,
unread: bool,
add_rooms_section: bool,
) -> http::Response {
let rooms = if add_rooms_section {
BTreeMap::from([(room_id.clone(), http::response::Room::default())])
} else {
BTreeMap::new()
};
let extensions = assign!(http::response::Extensions::default(), {
account_data: assign!(http::response::AccountData::default(), {
rooms: BTreeMap::from([
(
room_id,
vec![
Raw::from_json_string(
json!({
"content": {
"unread": unread
},
"type": "com.famedly.marked_unread"
})
.to_string(),
).unwrap()
]
)
])
})
});
assign!(http::Response::new(response_number.to_owned()), { rooms: rooms, extensions: extensions })
}
#[async_test]
async fn test_process_rooms_account_data() -> Result<()> {
let room = owned_room_id!("!pony:example.org");
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client
.sliding_sync("test")?
.with_account_data_extension(
assign!(http::request::AccountData::default(), { enabled: Some(true) }),
)
.add_list(
SlidingSyncList::builder("all")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=100)),
)
.build()
.await?;
// Initial state.
{
let server_response = assign!(http::Response::new("0".to_owned()), {
rooms: BTreeMap::from([(
room.clone(),
http::response::Room::default(),
)])
});
let _summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
}
let server_response = assign!(http::Response::new("1".to_owned()), {
extensions: assign!(http::response::Extensions::default(), {
account_data: assign!(http::response::AccountData::default(), {
rooms: BTreeMap::from([
(
room.clone(),
vec![
Raw::from_json_string(
json!({
"content": {
"tags": {
"u.work": {
"order": 0.9
}
}
},
"type": "m.tag"
})
.to_string(),
).unwrap()
]
)
])
})
})
});
let summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
assert!(summary.rooms.contains(&room));
Ok(())
}
#[async_test]
#[cfg(feature = "e2e-encryption")]
async fn test_process_only_encryption_events() -> Result<()> {
use ruma::OneTimeKeyAlgorithm;
let room = owned_room_id!("!croissant:example.org");
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let server_response = assign!(http::Response::new("0".to_owned()), {
rooms: BTreeMap::from([(
room.clone(),
assign!(http::response::Room::default(), {
name: Some("Croissants lovers".to_owned()),
timeline: Vec::new(),
}),
)]),
extensions: assign!(http::response::Extensions::default(), {
e2ee: assign!(http::response::E2EE::default(), {
device_one_time_keys_count: BTreeMap::from([(OneTimeKeyAlgorithm::SignedCurve25519, uint!(42))])
}),
to_device: Some(assign!(http::response::ToDevice::default(), {
next_batch: "to-device-token".to_owned(),
})),
})
});
// Don't process non-encryption events if the sliding sync is configured for
// encryption only.
let sliding_sync = client
.sliding_sync("test")?
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true)}),
)
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
{
let mut position_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut position_guard).await?;
}
// E2EE has been properly handled.
let uploaded_key_count = client.encryption().uploaded_key_count().await?;
assert_eq!(uploaded_key_count, 42);
{
let olm_machine = &*client.olm_machine_for_testing().await;
assert_eq!(
olm_machine.as_ref().unwrap().store().next_batch_token().await?.as_deref(),
Some("to-device-token")
);
}
// Room events haven't.
assert!(client.get_room(&room).is_none());
// Conversely, only process room lists events if the sliding sync was configured
// as so.
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client
.sliding_sync("test")?
.add_list(SlidingSyncList::builder("thelist"))
.build()
.await?;
{
let mut position_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut position_guard).await?;
}
// E2EE response has been ignored.
let uploaded_key_count = client.encryption().uploaded_key_count().await?;
assert_eq!(uploaded_key_count, 0);
{
let olm_machine = &*client.olm_machine_for_testing().await;
assert_eq!(
olm_machine.as_ref().unwrap().store().next_batch_token().await?.as_deref(),
None
);
}
// The room is now known.
assert!(client.get_room(&room).is_some());
// And it's also possible to set up both.
let client = logged_in_client(Some(server.uri())).await;
let sliding_sync = client
.sliding_sync("test")?
.add_list(SlidingSyncList::builder("thelist"))
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true)}),
)
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
{
let mut position_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut position_guard).await?;
}
// E2EE has been properly handled.
let uploaded_key_count = client.encryption().uploaded_key_count().await?;
assert_eq!(uploaded_key_count, 42);
{
let olm_machine = &*client.olm_machine_for_testing().await;
assert_eq!(
olm_machine.as_ref().unwrap().store().next_batch_token().await?.as_deref(),
Some("to-device-token")
);
}
// The room is now known.
assert!(client.get_room(&room).is_some());
Ok(())
}
#[async_test]
async fn test_lock_multiple_requests() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let pos = Arc::new(Mutex::new(0));
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(move |_: &Request| {
let mut pos = pos.lock().unwrap();
*pos += 1;
ResponseTemplate::new(200).set_body_json(json!({
"pos": pos.to_string(),
"lists": {},
"rooms": {}
}))
})
.mount_as_scoped(&server)
.await;
let sliding_sync = client
.sliding_sync("test")?
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true)}),
)
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
// Spawn two requests in parallel. Before #2430, this lead to a deadlock and the
// test would never terminate.
let requests = join_all([sliding_sync.sync_once(), sliding_sync.sync_once()]);
for result in requests.await {
result?;
}
Ok(())
}
#[cfg(not(target_arch = "wasm32"))] // b/o tokio::time::sleep
#[async_test]
async fn test_aborted_request_doesnt_update_future_requests() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let pos = Arc::new(Mutex::new(0));
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(move |_: &Request| {
let mut pos = pos.lock().unwrap();
*pos += 1;
// Respond slowly enough that we can skip one iteration.
ResponseTemplate::new(200)
.set_body_json(json!({
"pos": pos.to_string(),
"lists": {},
"rooms": {}
}))
.set_delay(Duration::from_secs(2))
})
.mount_as_scoped(&server)
.await;
let sliding_sync =
client
.sliding_sync("test")?
.add_list(SlidingSyncList::builder("room-list").sync_mode(
SlidingSyncMode::new_growing(10).maximum_number_of_rooms_to_fetch(100),
))
.add_list(
SlidingSyncList::builder("another-list")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10)),
)
.build()
.await?;
let stream = sliding_sync.sync();
pin_mut!(stream);
let cloned_sync = sliding_sync.clone();
tokio::spawn(async move {
tokio::time::sleep(Duration::from_millis(100)).await;
cloned_sync
.on_list("another-list", |list| {
list.set_sync_mode(SlidingSyncMode::new_selective().add_range(10..=20));
ready(())
})
.await;
});
assert_matches!(stream.next().await, Some(Ok(_)));
sliding_sync.stop_sync().unwrap();
assert_matches!(stream.next().await, None);
let mut num_requests = 0;
for request in server.received_requests().await.unwrap() {
if !SlidingSyncMatcher.matches(&request) {
continue;
}
let another_list_ranges = if num_requests == 0 {
// First request
json!([[0, 10]])
} else {
// Second request
json!([[10, 20]])
};
num_requests += 1;
assert!(num_requests <= 2, "more than one request hit the server");
let json_value = serde_json::from_slice::<serde_json::Value>(&request.body).unwrap();
if let Err(err) = assert_json_diff::assert_json_matches_no_panic(
&json_value,
&json!({
"conn_id": "test",
"lists": {
"room-list": {
"ranges": [[0, 9]],
"required_state": [
["m.room.encryption", ""],
["m.room.tombstone", ""]
],
},
"another-list": {
"ranges": another_list_ranges,
"required_state": [
["m.room.encryption", ""],
["m.room.tombstone", ""]
],
},
}
}),
assert_json_diff::Config::new(assert_json_diff::CompareMode::Inclusive),
) {
dbg!(json_value);
panic!("json differ: {err}");
}
}
assert_eq!(num_requests, 2);
Ok(())
}
#[async_test]
async fn test_timeout_zero_list() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![]).await?;
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
// Zero list means sliding sync is fully loaded, so there is a timeout to wait
// on new update to pop.
assert!(request.timeout.is_some());
Ok(())
}
#[async_test]
async fn test_timeout_one_list() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![
SlidingSyncList::builder("foo").sync_mode(SlidingSyncMode::new_growing(10))
])
.await?;
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
// The list does not require a timeout.
assert!(request.timeout.is_none());
// Simulate a response.
{
let server_response = assign!(http::Response::new("0".to_owned()), {
lists: BTreeMap::from([(
"foo".to_owned(),
assign!(http::response::List::default(), {
count: uint!(7),
})
)])
});
let _summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
}
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
// The list is now fully loaded, so it requires a timeout.
assert!(request.timeout.is_some());
Ok(())
}
#[async_test]
async fn test_timeout_three_lists() -> Result<()> {
let (_server, sliding_sync) = new_sliding_sync(vec![
SlidingSyncList::builder("foo").sync_mode(SlidingSyncMode::new_growing(10)),
SlidingSyncList::builder("bar").sync_mode(SlidingSyncMode::new_paging(10)),
SlidingSyncList::builder("baz")
.sync_mode(SlidingSyncMode::new_selective().add_range(0..=10)),
])
.await?;
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
// Two lists don't require a timeout.
assert!(request.timeout.is_none());
// Simulate a response.
{
let server_response = assign!(http::Response::new("0".to_owned()), {
lists: BTreeMap::from([(
"foo".to_owned(),
assign!(http::response::List::default(), {
count: uint!(7),
})
)])
});
let _summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
}
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
// One don't require a timeout.
assert!(request.timeout.is_none());
// Simulate a response.
{
let server_response = assign!(http::Response::new("1".to_owned()), {
lists: BTreeMap::from([(
"bar".to_owned(),
assign!(http::response::List::default(), {
count: uint!(7),
})
)])
});
let _summary = {
let mut pos_guard = sliding_sync.inner.position.clone().lock_owned().await;
sliding_sync.handle_response(server_response.clone(), &mut pos_guard).await?
};
}
let (request, _, _) =
sliding_sync.generate_sync_request(&mut LazyTransactionId::new()).await?;
// All lists require a timeout.
assert!(request.timeout.is_some());
Ok(())
}
#[async_test]
async fn test_sync_beat_is_notified_on_sync_response() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(ResponseTemplate::new(200).set_body_json(json!({
"pos": "0",
"lists": {},
"rooms": {}
})))
.mount_as_scoped(&server)
.await;
let sliding_sync = client
.sliding_sync("test")?
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true)}),
)
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
let sliding_sync = Arc::new(sliding_sync);
// Create the listener and perform a sync request
let sync_beat_listener = client.inner.sync_beat.listen();
sliding_sync.sync_once().await?;
// The sync beat listener should be notified shortly after
assert!(sync_beat_listener.wait_timeout(Duration::from_secs(1)).is_some());
Ok(())
}
#[async_test]
async fn test_sync_beat_is_not_notified_on_sync_failure() -> Result<()> {
let server = MockServer::start().await;
let client = logged_in_client(Some(server.uri())).await;
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(ResponseTemplate::new(404))
.mount_as_scoped(&server)
.await;
let sliding_sync = client
.sliding_sync("test")?
.with_to_device_extension(
assign!(http::request::ToDevice::default(), { enabled: Some(true)}),
)
.with_e2ee_extension(assign!(http::request::E2EE::default(), { enabled: Some(true)}))
.build()
.await?;
let sliding_sync = Arc::new(sliding_sync);
// Create the listener and perform a sync request
let sync_beat_listener = client.inner.sync_beat.listen();
let sync_result = sliding_sync.sync_once().await;
assert!(sync_result.is_err());
// The sync beat listener won't be notified in this case
assert!(sync_beat_listener.wait_timeout(Duration::from_secs(1)).is_none());
Ok(())
}
}