1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/disk_cache/sql/sql_persistent_store.h"
#include <cstdint>
#include <limits>
#include <memory>
#include <string>
#include <utility>
#include "base/containers/flat_set.h"
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_view_util.h"
#include "base/strings/stringprintf.h"
#include "base/sys_byteorder.h"
#include "base/task/thread_pool.h"
#include "base/test/bind.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/test/test_file_util.h"
#include "base/test/test_future.h"
#include "components/performance_manager/scenario_api/performance_scenario_test_support.h"
#include "net/base/cache_type.h"
#include "net/base/features.h"
#include "net/base/io_buffer.h"
#include "net/disk_cache/simple/simple_util.h"
#include "net/disk_cache/sql/cache_entry_key.h"
#include "net/disk_cache/sql/sql_backend_constants.h"
#include "sql/database.h"
#include "sql/meta_table.h"
#include "sql/statement.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using performance_scenarios::InputScenario;
using performance_scenarios::LoadingScenario;
using performance_scenarios::PerformanceScenarioTestHelper;
using performance_scenarios::ScenarioScope;
using testing::ElementsAre;
namespace disk_cache {
// Default max cache size for tests, 10 MB.
inline constexpr int64_t kDefaultMaxBytes = 10 * 1024 * 1024;
// Test fixture for SqlPersistentStore tests.
class SqlPersistentStoreTest : public testing::Test {
public:
// Sets up a temporary directory and a background task runner for each test.
void SetUp() override {
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
background_task_runners_.emplace_back(
base::ThreadPool::CreateSequencedTaskRunner({base::MayBlock()}));
}
// Cleans up the store and ensures all background tasks are completed.
void TearDown() override {
store_.reset();
// Make sure all background tasks are done before returning.
FlushPendingTask();
}
protected:
// Returns the path to the temporary directory.
base::FilePath GetTempPath() const { return temp_dir_.GetPath(); }
// Returns the full path to the SQLite database file.
base::FilePath GetDatabaseFilePath() const {
return GetTempPath().Append(kSqlBackendDatabaseShard0FileName);
}
// Creates a SqlPersistentStore instance.
void CreateStore(int64_t max_bytes = kDefaultMaxBytes) {
store_ = std::make_unique<SqlPersistentStore>(
GetTempPath(), max_bytes, net::CacheType::DISK_CACHE,
std::vector<scoped_refptr<base::SequencedTaskRunner>>(
background_task_runners_));
}
// Initializes the store and waits for the operation to complete.
SqlPersistentStore::Error Init() {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->Initialize(future.GetCallback());
return future.Get();
}
void CreateAndInitStore() {
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
}
void ClearStore() {
CHECK(store_);
store_.reset();
FlushPendingTask();
}
// Helper function to create, initialize, and then close a store.
void CreateAndCloseInitializedStore() {
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
store_.reset();
FlushPendingTask();
}
// Makes the database file unwritable to test error handling.
void MakeFileUnwritable() {
file_permissions_restorer_ =
std::make_unique<base::FilePermissionRestorer>(GetDatabaseFilePath());
ASSERT_TRUE(base::MakeFileUnwritable(GetDatabaseFilePath()));
}
bool LoadInMemoryIndex(SqlPersistentStore::Error expected_result =
SqlPersistentStore::Error::kOk) {
CHECK(store_);
base::test::TestFuture<SqlPersistentStore::Error> future;
auto ret = store_->MaybeLoadInMemoryIndex(future.GetCallback());
if (ret) {
CHECK_EQ(future.Get(), expected_result);
return true;
}
return false;
}
// Gets the entry count.
int32_t GetEntryCount() { return store_->GetEntryCount(); }
// Gets the total size of all entries.
int64_t GetSizeOfAllEntries() { return store_->GetSizeOfAllEntries(); }
// Ensures all tasks on the background thread have completed.
void FlushPendingTask() {
for (auto background_task_runner : background_task_runners_) {
base::RunLoop run_loop;
background_task_runner->PostTask(FROM_HERE, run_loop.QuitClosure());
run_loop.Run();
}
}
// Custom deleter for the unique_ptr returned by ManuallyOpenDatabase.
// It ensures that the store is re-initialized after manual DB access if it
// was open before.
struct DatabaseReopener {
void operator()(sql::Database* db) const {
delete db;
if (test_fixture_to_reinit) {
test_fixture_to_reinit->CreateAndInitStore();
}
}
// Use raw_ptr to avoid ownership cycles and for safety.
// This is null if the store doesn't need to be re-initialized.
raw_ptr<SqlPersistentStoreTest> test_fixture_to_reinit = nullptr;
};
using DatabaseHandle = std::unique_ptr<sql::Database, DatabaseReopener>;
// This will close the current store connection and automatically reopen it
// when the returned handle goes out of scope.
DatabaseHandle ManuallyOpenDatabase() {
bool should_reopen = false;
if (store_) {
ClearStore();
should_reopen = true;
}
auto db = std::make_unique<sql::Database>(
sql::DatabaseOptions()
.set_exclusive_locking(true)
#if BUILDFLAG(IS_WIN)
.set_exclusive_database_file_lock(true)
#endif // IS_WIN
.set_preload(true)
.set_wal_mode(true),
sql::Database::Tag("HttpCacheDiskCache"));
CHECK(db->Open(GetDatabaseFilePath()));
return DatabaseHandle(db.release(), {should_reopen ? this : nullptr});
}
// Manually opens the meta table within the database.
std::unique_ptr<sql::MetaTable> ManuallyOpenMetaTable(
sql::Database* db_handle) {
auto mata_table = std::make_unique<sql::MetaTable>();
CHECK(mata_table->Init(db_handle, kSqlBackendCurrentDatabaseVersion,
kSqlBackendCurrentDatabaseVersion));
return mata_table;
}
// Synchronous wrapper for CreateEntry.
SqlPersistentStore::EntryInfoOrError CreateEntry(const CacheEntryKey& key) {
base::test::TestFuture<SqlPersistentStore::EntryInfoOrError> future;
store_->CreateEntry(key, base::Time::Now(), future.GetCallback());
return future.Take();
}
// Helper to create an entry and return its ResId, asserting success.
SqlPersistentStore::ResId CreateEntryAndGetResId(const CacheEntryKey& key) {
auto create_result = CreateEntry(key);
CHECK(create_result.has_value())
<< "Failed to create entry for key: " << key.string();
return create_result->res_id;
}
// Synchronous wrapper for OpenEntry.
SqlPersistentStore::OptionalEntryInfoOrError OpenEntry(
const CacheEntryKey& key) {
base::test::TestFuture<SqlPersistentStore::OptionalEntryInfoOrError> future;
store_->OpenEntry(key, future.GetCallback());
return future.Take();
}
// Synchronous wrapper for OpenOrCreateEntry.
SqlPersistentStore::EntryInfoOrError OpenOrCreateEntry(
const CacheEntryKey& key) {
base::test::TestFuture<SqlPersistentStore::EntryInfoOrError> future;
store_->OpenOrCreateEntry(key, future.GetCallback());
return future.Take();
}
// Synchronous wrapper for DoomEntry.
SqlPersistentStore::Error DoomEntry(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->DoomEntry(key, res_id, future.GetCallback());
return future.Get();
}
// Synchronous wrapper for DeleteDoomedEntry.
SqlPersistentStore::Error DeleteDoomedEntry(
const CacheEntryKey& key,
SqlPersistentStore::ResId res_id) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->DeleteDoomedEntry(key, res_id, future.GetCallback());
return future.Get();
}
// Synchronous wrapper for DeleteLiveEntry.
SqlPersistentStore::Error DeleteLiveEntry(const CacheEntryKey& key) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->DeleteLiveEntry(key, future.GetCallback());
return future.Get();
}
// Synchronous wrapper for DeleteAllEntries.
SqlPersistentStore::Error DeleteAllEntries() {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->DeleteAllEntries(future.GetCallback());
return future.Get();
}
// Synchronous wrapper for OpenNextEntry.
SqlPersistentStore::OptionalEntryInfoWithKeyAndIterator OpenNextEntry(
const SqlPersistentStore::EntryIterator& entry_coursor) {
base::test::TestFuture<
SqlPersistentStore::OptionalEntryInfoWithKeyAndIterator>
future;
store_->OpenNextEntry(entry_coursor, future.GetCallback());
return future.Take();
}
// Synchronous wrapper for DeleteLiveEntriesBetween.
SqlPersistentStore::Error DeleteLiveEntriesBetween(
base::Time initial_time,
base::Time end_time,
std::vector<SqlPersistentStore::ResIdAndShardId> excluded_list = {}) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->DeleteLiveEntriesBetween(
initial_time, end_time, std::move(excluded_list), future.GetCallback());
return future.Get();
}
// Synchronous wrapper for UpdateEntryLastUsedByKey.
SqlPersistentStore::Error UpdateEntryLastUsedByKey(const CacheEntryKey& key,
base::Time last_used) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->UpdateEntryLastUsedByKey(key, last_used, future.GetCallback());
return future.Get();
}
// Synchronous wrapper for UpdateEntryLastUsedByResId.
SqlPersistentStore::Error UpdateEntryLastUsedByResId(
const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
base::Time last_used) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->UpdateEntryLastUsedByResId(key, res_id, last_used,
future.GetCallback());
return future.Get();
}
// Synchronous wrapper for UpdateEntryHeaderAndLastUsed.
SqlPersistentStore::Error UpdateEntryHeaderAndLastUsed(
const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
base::Time last_used,
scoped_refptr<net::IOBuffer> buffer,
int64_t header_size_delta) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->UpdateEntryHeaderAndLastUsed(
key, res_id, last_used, /*new_hints=*/std::nullopt, std::move(buffer),
header_size_delta, future.GetCallback());
return future.Get();
}
SqlPersistentStore::Error UpdateEntryHeaderAndLastUsed(
const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
base::Time last_used,
scoped_refptr<net::IOBuffer> buffer,
int64_t header_size_delta,
const std::optional<MemoryEntryDataHints>& new_hints) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->UpdateEntryHeaderAndLastUsed(key, res_id, last_used, new_hints,
std::move(buffer), header_size_delta,
future.GetCallback());
return future.Get();
}
// Synchronous wrapper for WriteEntryData.
SqlPersistentStore::Error WriteEntryData(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
int64_t old_body_end,
int64_t offset,
scoped_refptr<net::IOBuffer> buffer,
int buf_len,
bool truncate) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->WriteEntryData(key, res_id, old_body_end, offset, std::move(buffer),
buf_len, truncate, future.GetCallback());
return future.Get();
}
// Synchronous wrapper for ReadEntryData.
SqlPersistentStore::IntOrError ReadEntryData(
const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
int64_t offset,
scoped_refptr<net::IOBuffer> buffer,
int buf_len,
int64_t body_end,
bool sparse_reading) {
base::test::TestFuture<SqlPersistentStore::IntOrError> future;
store_->ReadEntryData(key, res_id, offset, std::move(buffer), buf_len,
body_end, sparse_reading, future.GetCallback());
return future.Take();
}
// Helper to write data from a string_view and assert success.
void WriteDataAndAssertSuccess(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
int64_t old_body_end,
int64_t offset,
std::string_view data,
bool truncate) {
auto buffer = base::MakeRefCounted<net::StringIOBuffer>(std::string(data));
ASSERT_EQ(WriteEntryData(key, res_id, old_body_end, offset,
std::move(buffer), data.size(), truncate),
SqlPersistentStore::Error::kOk);
}
// Helper to fill a range with a repeated character and write it to the store.
void FillDataInRange(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
int64_t old_body_end,
int64_t start,
int64_t len,
char fill_char) {
const std::string data(len, fill_char);
WriteDataAndAssertSuccess(key, res_id, old_body_end, start, data,
/*truncate=*/false);
}
// Helper to write a sequence of single-byte blobs from a string_view and
// verify the result.
void WriteAndVerifySingleByteBlobs(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
std::string_view content) {
for (size_t i = 0; i < content.size(); ++i) {
std::string data(1, content[i]);
WriteDataAndAssertSuccess(key, res_id, i, i, data,
/*truncate=*/false);
}
ReadAndVerifyData(key, res_id, 0, content.size(), content.size(), false,
std::string(content));
std::vector<BlobData> actual_blobs = GetAllBlobData(res_id);
for (size_t i = 0; i < content.size(); ++i) {
EXPECT_EQ(actual_blobs[i].start, i);
EXPECT_EQ(actual_blobs[i].end, i + 1);
ASSERT_THAT(actual_blobs[i].data, ElementsAre(content[i]));
}
}
// Synchronous wrapper for GetEntryAvailableRange.
RangeResult GetEntryAvailableRange(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
int64_t offset,
int len) {
base::test::TestFuture<const RangeResult&> future;
store_->GetEntryAvailableRange(key, res_id, offset, len,
future.GetCallback());
return future.Get();
}
// Synchronous wrapper for CalculateSizeOfEntriesBetween.
SqlPersistentStore::Int64OrError CalculateSizeOfEntriesBetween(
base::Time initial_time,
base::Time end_time) {
base::test::TestFuture<SqlPersistentStore::Int64OrError> future;
store_->CalculateSizeOfEntriesBetween(initial_time, end_time,
future.GetCallback());
return future.Take();
}
// Synchronous wrapper for StartEviction.
SqlPersistentStore::Error StartEviction(
std::vector<SqlPersistentStore::ResIdAndShardId> excluded_list,
bool is_idle_time_eviction) {
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->StartEviction(std::move(excluded_list), is_idle_time_eviction,
future.GetCallback());
return future.Take();
}
// Helper to read data and verify its content.
void ReadAndVerifyData(const CacheEntryKey& key,
SqlPersistentStore::ResId res_id,
int64_t offset,
int buffer_len,
int64_t body_end,
bool sparse_reading,
std::string_view expected_data) {
auto read_buffer = base::MakeRefCounted<net::IOBufferWithSize>(buffer_len);
auto read_result = ReadEntryData(key, res_id, offset, read_buffer,
buffer_len, body_end, sparse_reading);
ASSERT_TRUE(read_result.has_value());
EXPECT_EQ(read_result.value(), static_cast<int>(expected_data.size()));
EXPECT_EQ(std::string_view(read_buffer->data(), read_result.value()),
expected_data);
}
// Helper to count rows in the resource table.
int64_t CountResourcesTable() {
auto db_handle = ManuallyOpenDatabase();
sql::Statement s(
db_handle->GetUniqueStatement("SELECT COUNT(*) FROM resources"));
CHECK(s.Step());
return s.ColumnInt(0);
}
// Helper to count doomed rows in the resource table.
int64_t CountDoomedResourcesTable(const CacheEntryKey& key) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement s(db_handle->GetUniqueStatement(
"SELECT COUNT(*) FROM resources WHERE cache_key=? AND doomed=?"));
s.BindString(0, key.string());
s.BindBool(1, true); // doomed = true
CHECK(s.Step());
return s.ColumnInt64(0);
}
struct ResourceEntryDetails {
base::Time last_used;
int64_t bytes_usage;
std::string head_data;
bool doomed;
int64_t body_end;
};
// Helper to read entry details from the resources table.
std::optional<ResourceEntryDetails> GetResourceEntryDetails(
const CacheEntryKey& key) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement s(db_handle->GetUniqueStatement(
"SELECT last_used, bytes_usage, head, doomed, body_end "
"FROM resources WHERE cache_key=?"));
s.BindString(0, key.string());
if (s.Step()) {
ResourceEntryDetails details;
details.last_used = s.ColumnTime(0);
details.bytes_usage = s.ColumnInt64(1);
details.head_data =
std::string(reinterpret_cast<const char*>(s.ColumnBlob(2).data()),
s.ColumnBlob(2).size());
details.doomed = s.ColumnBool(3);
details.body_end = s.ColumnInt64(4);
return details;
}
return std::nullopt;
}
// Helper to read hints from the resources table.
std::optional<uint8_t> GetResourceHints(const CacheEntryKey& key) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement s(db_handle->GetUniqueStatement(
"SELECT hints FROM resources WHERE cache_key=?"));
s.BindString(0, key.string());
if (s.Step()) {
return static_cast<uint8_t>(s.ColumnInt(0));
}
return std::nullopt;
}
// Helper to verify the body_end and bytes_usage of a resource entry.
void VerifyBodyEndAndBytesUsage(const CacheEntryKey& key,
int64_t expected_body_end,
int64_t expected_bytes_usage) {
auto details = GetResourceEntryDetails(key);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->body_end, expected_body_end);
EXPECT_EQ(details->bytes_usage, expected_bytes_usage);
}
struct BlobData {
int64_t start;
int64_t end;
std::vector<uint8_t> data;
BlobData(int64_t s, int64_t e, std::vector<uint8_t> d)
: start(s), end(e), data(std::move(d)) {}
auto operator<=>(const BlobData&) const = default;
};
// Helper to create BlobData from a string_view for easier testing.
BlobData MakeBlobData(int64_t start, std::string_view data) {
return BlobData(start, start + data.size(),
std::vector<uint8_t>(data.begin(), data.end()));
}
// Helper to retrieve all blob data for a given entry res_id.
std::vector<BlobData> GetAllBlobData(SqlPersistentStore::ResId res_id) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement s(db_handle->GetUniqueStatement(
"SELECT start, end, blob FROM blobs WHERE res_id=? "
"ORDER BY start"));
s.BindInt64(0, res_id.value());
std::vector<BlobData> blobs;
while (s.Step()) {
blobs.emplace_back(
s.ColumnInt64(0), s.ColumnInt64(1),
std::vector<uint8_t>(s.ColumnBlob(2).begin(), s.ColumnBlob(2).end()));
}
return blobs;
}
// Helper to check the blob data for a given res_id.
void CheckBlobData(SqlPersistentStore::ResId res_id,
std::initializer_list<std::pair<int64_t, std::string_view>>
expected_blobs) {
std::vector<BlobData> expected;
for (const auto& blob_pair : expected_blobs) {
expected.push_back(MakeBlobData(blob_pair.first, blob_pair.second));
}
EXPECT_THAT(GetAllBlobData(res_id), testing::ElementsAreArray(expected));
}
// Helper to overwrite the blob data for a given entry_key and res_id.
void OverwriteBlobData(const CacheEntryKey& entry_key,
SqlPersistentStore::ResId res_id,
std::string_view new_data,
int32_t new_check_sum) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE blobs SET check_sum = ?, blob = ? WHERE res_id = ?"));
statement.BindInt(0, new_check_sum);
statement.BindBlob(1, base::as_byte_span(new_data));
statement.BindInt64(2, res_id.value());
ASSERT_TRUE(statement.Run());
}
// Helper to corrupt the start and end offsets for a given res_id.
void CorruptBlobRange(SqlPersistentStore::ResId res_id,
int64_t new_start,
int64_t new_end) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE blobs SET start = ?, end = ? WHERE res_id = ?"));
statement.BindInt64(0, new_start);
statement.BindInt64(1, new_end);
statement.BindInt64(2, res_id.value());
ASSERT_TRUE(statement.Run());
}
int64_t GetResourceCheckSum(SqlPersistentStore::ResId res_id) {
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"SELECT check_sum FROM resources WHERE res_id = ?"));
statement.BindInt64(0, res_id.value());
CHECK(statement.Step());
return statement.ColumnInt(0);
}
// Returns the number of writes required for a checkpoint.
int GetNumberForWritesRequiredForCheckpoint(const CacheEntryKey& entry_key,
std::string_view data);
static int32_t CalculateCheckSum(base::span<const uint8_t> data,
CacheEntryKey::Hash key_hash) {
uint32_t hash_value_net_order =
base::HostToNet32(static_cast<uint32_t>(key_hash.value()));
uint32_t crc32_value = simple_util::IncrementalCrc32(
simple_util::Crc32(data),
base::byte_span_from_ref(hash_value_net_order));
return static_cast<int32_t>(crc32_value);
}
void MaybeRunCheckpoint(bool expected_result) {
base::test::TestFuture<bool> future;
base::HistogramTester histogram_tester;
store_->MaybeRunCheckpoint(future.GetCallback());
EXPECT_EQ(future.Get(), expected_result);
histogram_tester.ExpectTotalCount(
"Net.SqlDiskCache.Backend.IdleEventCheckpoint.SuccessTime",
expected_result ? 1 : 0);
histogram_tester.ExpectTotalCount(
"Net.SqlDiskCache.Backend.IdleEventCheckpoint.SuccessPages",
expected_result ? 1 : 0);
}
void RunCleanupDoomedEntriesTest(base::OnceClosure trigger_cleanup);
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
base::ScopedTempDir temp_dir_;
std::vector<scoped_refptr<base::SequencedTaskRunner>>
background_task_runners_;
std::unique_ptr<SqlPersistentStore> store_;
std::unique_ptr<base::FilePermissionRestorer> file_permissions_restorer_;
};
// Tests that a new database is created and initialized successfully.
TEST_F(SqlPersistentStoreTest, InitNew) {
const int64_t kMaxBytes = 10 * 1024 * 1024;
CreateStore(kMaxBytes);
EXPECT_EQ(Init(), SqlPersistentStore::Error::kOk);
EXPECT_EQ(store_->MaxSize(), kMaxBytes);
EXPECT_EQ(store_->MaxFileSize(), kSqlBackendMinFileSizeLimit);
}
// Tests initialization when max_bytes is zero. This should trigger automatic
// sizing based on available disk space.
TEST_F(SqlPersistentStoreTest, InitWithZeroMaxBytes) {
CreateStore(0);
EXPECT_EQ(Init(), SqlPersistentStore::Error::kOk);
// When `max_bytes` is zero, the following values are calculated using the
// free disk space.
EXPECT_GT(store_->MaxSize(), 0);
EXPECT_GT(store_->MaxFileSize(), 0);
}
// Tests that an existing, valid database can be opened and initialized.
TEST_F(SqlPersistentStoreTest, InitExisting) {
CreateAndCloseInitializedStore();
// Create a new store with the same path, which should open the existing DB.
CreateStore();
EXPECT_EQ(Init(), SqlPersistentStore::Error::kOk);
}
// Tests that a database with a future (incompatible) version is razed
// (deleted and recreated).
TEST_F(SqlPersistentStoreTest, InitRazedTooNew) {
CreateAndCloseInitializedStore();
{
// Manually open the database and set a future version number.
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(
meta_table->SetVersionNumber(kSqlBackendCurrentDatabaseVersion + 1));
ASSERT_TRUE(meta_table->SetCompatibleVersionNumber(
kSqlBackendCurrentDatabaseVersion + 1));
// Add some data to verify it gets deleted.
meta_table->SetValue("SomeNewData", 1);
int64_t value = 0;
EXPECT_TRUE(meta_table->GetValue("SomeNewData", &value));
EXPECT_EQ(value, 1);
}
// Re-initializing the store should detect the future version and raze the DB.
CreateAndCloseInitializedStore();
// Verify that the old data is gone.
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
int64_t value = 0;
EXPECT_FALSE(meta_table->GetValue("SomeNewData", &value));
}
// Tests that initialization fails if the target directory path is obstructed
// by a file.
TEST_F(SqlPersistentStoreTest, InitFailsWithCreationDirectoryFailure) {
// Create a file where the database directory is supposed to be.
base::FilePath db_dir_path = GetTempPath().Append(FILE_PATH_LITERAL("db"));
ASSERT_TRUE(base::WriteFile(db_dir_path, ""));
store_ = std::make_unique<SqlPersistentStore>(
db_dir_path, kDefaultMaxBytes, net::CacheType::DISK_CACHE,
std::vector<scoped_refptr<base::SequencedTaskRunner>>(
background_task_runners_));
ASSERT_EQ(Init(), SqlPersistentStore::Error::kFailedToCreateDirectory);
}
// Tests that initialization fails if the database file is not writable.
TEST_F(SqlPersistentStoreTest, InitFailsWithUnwritableFile) {
CreateAndCloseInitializedStore();
// Make the database file read-only.
MakeFileUnwritable();
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kFailedToOpenDatabase);
}
// Tests the recovery mechanism when the database file is corrupted.
TEST_F(SqlPersistentStoreTest, InitWithCorruptDatabase) {
CreateAndCloseInitializedStore();
// Corrupt the database file by overwriting its header.
CHECK(sql::test::CorruptSizeInHeader(GetDatabaseFilePath()));
// Initializing again should trigger recovery, which razes and rebuilds the
// DB.
CreateStore();
EXPECT_EQ(Init(), SqlPersistentStore::Error::kOk);
}
// Verifies the logic for calculating the maximum size of individual cache files
// based on the total cache size (`max_bytes`).
TEST_F(SqlPersistentStoreTest, MaxFileSizeCalculation) {
// With a large `max_bytes`, the max file size is a fraction of the total
// size.
const int64_t large_max_bytes = 100 * 1024 * 1024;
CreateStore(large_max_bytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
EXPECT_EQ(store_->MaxSize(), large_max_bytes);
EXPECT_EQ(store_->MaxFileSize(),
large_max_bytes / kSqlBackendMaxFileRatioDenominator);
store_.reset();
// With a small `max_bytes` (20 MB), the max file size is clamped at the
// fixed value (5 MB).
const int64_t small_max_bytes = 20 * 1024 * 1024;
CreateStore(small_max_bytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
EXPECT_EQ(store_->MaxSize(), small_max_bytes);
// 20 MB / 8 (kSqlBackendMaxFileRatioDenominator) = 2.5 MB, which is less than
// the 5 MB minimum limit (kSqlBackendMinFileSizeLimit), so the result is
// clamped to the minimum.
EXPECT_EQ(store_->MaxFileSize(), kSqlBackendMinFileSizeLimit);
}
// Tests that GetEntryCount() and GetSizeOfAllEntries() return correct values
// based on the metadata stored in the database.
TEST_F(SqlPersistentStoreTest, GetEntryAndSize) {
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// A new store should have zero entries and zero total size.
EXPECT_EQ(GetEntryCount(), 0);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
// Manually set metadata.
const int64_t kTestEntryCount = 123;
const int64_t kTestTotalSize = 456789;
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyEntryCount,
kTestEntryCount));
ASSERT_TRUE(
meta_table->SetValue(kSqlBackendMetaTableKeyTotalSize, kTestTotalSize));
}
EXPECT_EQ(GetEntryCount(), kTestEntryCount);
EXPECT_EQ(GetSizeOfAllEntries(),
kTestTotalSize + kTestEntryCount * kSqlBackendStaticResourceSize);
}
// Tests that GetEntryCount() and GetSizeOfAllEntries() handle invalid
// (e.g., negative) metadata by treating it as zero.
TEST_F(SqlPersistentStoreTest, GetEntryAndSizeWithInvalidMetadata) {
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
const CacheEntryKey kKey("my-key");
const int64_t kEntrySize = kSqlBackendStaticResourceSize +
kKey.string().size() + kInitialData.size();
const auto res_id = CreateEntryAndGetResId(kKey);
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), kEntrySize);
ClearStore();
// Test with a negative entry count. The total size should still be valid.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyEntryCount, -1));
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyTotalSize, 12345));
}
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// Both the entry count and size metadata must have been recalculated.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), kEntrySize);
// Test with an entry count that exceeds the int32_t limit.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(
kSqlBackendMetaTableKeyEntryCount,
static_cast<int64_t>(std::numeric_limits<int32_t>::max()) + 1));
}
// Both the entry count and size metadata must have been recalculated.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), kEntrySize);
// Test with an entry count with the int32_t limit.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(
kSqlBackendMetaTableKeyEntryCount,
static_cast<int64_t>(std::numeric_limits<int32_t>::max())));
}
// Both the entry count and size metadata must not been recalculated.
EXPECT_EQ(GetEntryCount(), std::numeric_limits<int32_t>::max());
EXPECT_EQ(GetSizeOfAllEntries(),
static_cast<int64_t>(std::numeric_limits<int32_t>::max()) *
kSqlBackendStaticResourceSize +
kKey.string().size() + kInitialData.size());
// Test with a negative total size. The entry count should still be valid.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyEntryCount, 10));
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyTotalSize, -1));
}
// Both the entry count and size metadata must have been recalculated.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), kEntrySize);
// Test with a total size at the int64_t limit with no entries.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyEntryCount, 0));
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyTotalSize,
std::numeric_limits<int64_t>::max()));
}
// Both the entry count and size metadata must have been recalculated.
EXPECT_EQ(GetEntryCount(), 0);
EXPECT_EQ(GetSizeOfAllEntries(), std::numeric_limits<int64_t>::max());
// Test with a total size at the int64_t limit with one entry.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyEntryCount, 1));
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyTotalSize,
std::numeric_limits<int64_t>::max()));
}
EXPECT_EQ(GetEntryCount(), 1);
// Adding the static size for the one entry would overflow. The implementation
// should clamp the result at the maximum value.
EXPECT_EQ(GetSizeOfAllEntries(), std::numeric_limits<int64_t>::max());
}
TEST_F(SqlPersistentStoreTest, CreateEntry) {
CreateAndInitStore();
ASSERT_EQ(GetEntryCount(), 0);
ASSERT_EQ(GetSizeOfAllEntries(), 0);
const CacheEntryKey kKey("my-key");
auto result = CreateEntry(kKey);
ASSERT_TRUE(result.has_value());
EXPECT_FALSE(result->opened);
EXPECT_EQ(result->body_end, 0);
EXPECT_EQ(result->head, nullptr);
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
EXPECT_EQ(CountResourcesTable(), 1);
}
TEST_F(SqlPersistentStoreTest, CreateEntryAlreadyExists) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
// Create the entry for the first time.
auto first_result = CreateEntry(kKey);
ASSERT_TRUE(first_result.has_value());
ASSERT_EQ(GetEntryCount(), 1);
ASSERT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
// Attempt to create it again.
auto second_result = CreateEntry(kKey);
ASSERT_FALSE(second_result.has_value());
EXPECT_EQ(second_result.error(), SqlPersistentStore::Error::kAlreadyExists);
// The counts should not have changed.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
EXPECT_EQ(CountResourcesTable(), 1);
}
TEST_F(SqlPersistentStoreTest, OpenEntrySuccess) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto created_res_id = CreateEntryAndGetResId(kKey);
auto open_result = OpenEntry(kKey);
ASSERT_TRUE(open_result.has_value());
ASSERT_TRUE(open_result->has_value());
EXPECT_EQ((*open_result)->res_id, created_res_id);
EXPECT_TRUE((*open_result)->opened);
EXPECT_EQ((*open_result)->body_end, 0);
ASSERT_NE((*open_result)->head, nullptr);
EXPECT_EQ((*open_result)->head->size(), 0);
// Opening an entry should not change the store's stats.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
}
TEST_F(SqlPersistentStoreTest, OpenEntryNotFound) {
CreateAndInitStore();
const CacheEntryKey kKey("non-existent-key");
auto result = OpenEntry(kKey);
ASSERT_TRUE(result.has_value());
EXPECT_FALSE(result->has_value());
}
TEST_F(SqlPersistentStoreTest, OpenOrCreateEntryCreatesNew) {
CreateAndInitStore();
const CacheEntryKey kKey("new-key");
auto result = OpenOrCreateEntry(kKey);
ASSERT_TRUE(result.has_value());
EXPECT_FALSE(result->opened); // Should be like a created entry.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
}
TEST_F(SqlPersistentStoreTest, OpenOrCreateEntryOpensExisting) {
CreateAndInitStore();
const CacheEntryKey kKey("existing-key");
// Create an entry first.
const auto created_res_id = CreateEntryAndGetResId(kKey);
// Now, open it with OpenOrCreateEntry.
auto open_result = OpenOrCreateEntry(kKey);
ASSERT_TRUE(open_result.has_value());
EXPECT_EQ(open_result->res_id, created_res_id);
EXPECT_TRUE(open_result->opened); // Should be like an opened entry.
// Stats should not have changed from the initial creation.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
}
TEST_F(SqlPersistentStoreTest, DoomEntrySuccess) {
CreateAndInitStore();
const CacheEntryKey kKeyToDoom("key-to-doom");
const CacheEntryKey kKeyToKeep("key-to-keep");
const int64_t size_to_doom =
kSqlBackendStaticResourceSize + kKeyToDoom.string().size();
const int64_t size_to_keep =
kSqlBackendStaticResourceSize + kKeyToKeep.string().size();
// Create two entries.
const auto res_id_to_doom = CreateEntryAndGetResId(kKeyToDoom);
const auto res_id_to_keep = CreateEntryAndGetResId(kKeyToKeep);
ASSERT_EQ(GetEntryCount(), 2);
ASSERT_EQ(GetSizeOfAllEntries(), size_to_doom + size_to_keep);
// Doom one of the entries.
ASSERT_EQ(DoomEntry(kKeyToDoom, res_id_to_doom),
SqlPersistentStore::Error::kOk);
// Verify that the entry count and size are updated, reflecting that one entry
// was logically removed.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), size_to_keep);
// Verify the doomed entry can no longer be opened.
auto open_doomed_result = OpenEntry(kKeyToDoom);
ASSERT_TRUE(open_doomed_result.has_value());
EXPECT_FALSE(open_doomed_result->has_value());
// Verify the other entry can still be opened.
auto open_kept_result = OpenEntry(kKeyToKeep);
ASSERT_TRUE(open_kept_result.has_value());
ASSERT_TRUE(open_kept_result->has_value());
EXPECT_EQ((*open_kept_result)->res_id, res_id_to_keep);
// Verify the doomed entry still exists in the table but is marked as doomed,
// and the other entry is unaffected.
EXPECT_EQ(CountResourcesTable(), 2);
EXPECT_EQ(CountDoomedResourcesTable(kKeyToDoom), 1);
EXPECT_EQ(CountDoomedResourcesTable(kKeyToKeep), 0);
}
TEST_F(SqlPersistentStoreTest, DoomEntryFailsNotFound) {
CreateAndInitStore();
const CacheEntryKey kKey("non-existent-key");
ASSERT_EQ(GetEntryCount(), 0);
// Attempt to doom an entry that doesn't exist.
auto result = DoomEntry(kKey, SqlPersistentStore::ResId(123));
ASSERT_EQ(result, SqlPersistentStore::Error::kNotFound);
// Verify that the counts remain unchanged.
EXPECT_EQ(GetEntryCount(), 0);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
}
TEST_F(SqlPersistentStoreTest, DoomEntryFailsWrongResId) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
const int64_t size1 = kSqlBackendStaticResourceSize + kKey1.string().size();
const int64_t size2 = kSqlBackendStaticResourceSize + kKey2.string().size();
// Create two entries.
const auto res_id1 = CreateEntryAndGetResId(kKey1);
const auto res_id2 = CreateEntryAndGetResId(kKey2);
ASSERT_EQ(GetEntryCount(), 2);
// Attempt to doom key1 with an incorrect res_id.
ASSERT_EQ(DoomEntry(kKey1, SqlPersistentStore::ResId(res_id2.value() + 1)),
SqlPersistentStore::Error::kNotFound);
// Verify that the counts remain unchanged and both entries can still be
// opened.
EXPECT_EQ(GetEntryCount(), 2);
EXPECT_EQ(GetSizeOfAllEntries(), size1 + size2);
auto open_result1 = OpenEntry(kKey1);
ASSERT_TRUE(open_result1.has_value());
ASSERT_TRUE(open_result1->has_value());
EXPECT_EQ((*open_result1)->res_id, res_id1);
auto open_result2 = OpenEntry(kKey2);
ASSERT_TRUE(open_result2.has_value());
ASSERT_TRUE(open_result2->has_value());
EXPECT_EQ((*open_result2)->res_id, res_id2);
}
TEST_F(SqlPersistentStoreTest, DoomEntryWithCorruptSizeRecovers) {
CreateAndInitStore();
const CacheEntryKey kKeyToCorrupt("key-to-corrupt");
const CacheEntryKey kKeyToKeep("key-to-keep");
const int64_t keep_key_size = kKeyToKeep.string().size();
const int64_t expected_size_after_recovery =
kSqlBackendStaticResourceSize + keep_key_size;
// Create one entry to keep, and one to corrupt and doom.
const auto res_id_to_doom = CreateEntryAndGetResId(kKeyToCorrupt);
ASSERT_TRUE(CreateEntry(kKeyToKeep).has_value());
ASSERT_EQ(GetEntryCount(), 2);
// Manually open the database and corrupt the `bytes_usage` for one entry
// to an extreme value that will cause an overflow during calculation.
{
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE resources SET bytes_usage = ? WHERE cache_key = ?"));
statement.BindInt64(0, std::numeric_limits<int64_t>::min());
statement.BindString(1, kKeyToCorrupt.string());
ASSERT_TRUE(statement.Run());
}
// Doom the entry with the corrupted size. This will trigger an overflow in
// `total_size_delta`, causing `!total_size_delta.IsValid()` to be true.
// The store should recover by recalculating its state from the database.
ASSERT_EQ(DoomEntry(kKeyToCorrupt, res_id_to_doom),
SqlPersistentStore::Error::kOk);
// Verify that recovery was successful. The entry count should be 1 (for the
// entry we kept), and the total size should be correctly calculated for
// that single remaining entry, ignoring the corrupted value.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), expected_size_after_recovery);
// Verify the state on disk.
ClearStore();
// Both entries should still exist in the table.
EXPECT_EQ(CountResourcesTable(), 2);
// The corrupted entry should be marked as doomed.
EXPECT_EQ(CountDoomedResourcesTable(kKeyToCorrupt), 1);
// The other entry should be unaffected.
EXPECT_EQ(CountDoomedResourcesTable(kKeyToKeep), 0);
}
TEST_F(SqlPersistentStoreTest, DeleteDoomedEntrySuccess) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
// Create and doom an entry.
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
ASSERT_EQ(GetEntryCount(), 0);
ASSERT_EQ(CountResourcesTable(), 1);
// Delete the doomed entry.
ASSERT_EQ(DeleteDoomedEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
// Verify the entry is now physically gone from the database.
EXPECT_EQ(CountResourcesTable(), 0);
}
TEST_F(SqlPersistentStoreTest, DeleteDoomedEntryDeletesBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData = "some data";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kData, /*truncate=*/false);
CheckBlobData(res_id, {{0, kData}});
EXPECT_EQ(GetSizeOfAllEntries(), kSqlBackendStaticResourceSize +
kKey.string().size() + kData.size());
// DoomEntry is responsible for updating the total size of the cache.
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
ASSERT_EQ(DeleteDoomedEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
CheckBlobData(res_id, {});
}
TEST_F(SqlPersistentStoreTest, DeleteDoomedEntryFailsOnLiveEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
// Create a live entry.
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(GetEntryCount(), 1);
// Attempt to delete it with DeleteDoomedEntry. This should fail because the
// entry is not marked as doomed.
auto result = DeleteDoomedEntry(kKey, res_id);
ASSERT_EQ(result, SqlPersistentStore::Error::kNotFound);
// Verify the entry still exists.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(CountResourcesTable(), 1);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntrySuccess) {
CreateAndInitStore();
const CacheEntryKey kKeyToDelete("key-to-delete");
const CacheEntryKey kKeyToKeep("key-to-keep");
const int64_t size_to_delete =
kSqlBackendStaticResourceSize + kKeyToDelete.string().size();
const int64_t size_to_keep =
kSqlBackendStaticResourceSize + kKeyToKeep.string().size();
// Create two entries.
ASSERT_TRUE(CreateEntry(kKeyToDelete).has_value());
const auto res_id_to_keep = CreateEntryAndGetResId(kKeyToKeep);
ASSERT_EQ(GetEntryCount(), 2);
ASSERT_EQ(GetSizeOfAllEntries(), size_to_delete + size_to_keep);
// Delete one of the live entries.
ASSERT_EQ(DeleteLiveEntry(kKeyToDelete), SqlPersistentStore::Error::kOk);
// Verify the cache is updated correctly.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), size_to_keep);
// Verify the deleted entry cannot be opened.
auto open_deleted_result = OpenEntry(kKeyToDelete);
ASSERT_TRUE(open_deleted_result.has_value());
EXPECT_FALSE(open_deleted_result->has_value());
// Verify the other entry can still be opened.
auto open_kept_result = OpenEntry(kKeyToKeep);
ASSERT_TRUE(open_kept_result.has_value());
ASSERT_TRUE(open_kept_result->has_value());
EXPECT_EQ((*open_kept_result)->res_id, res_id_to_keep);
// Verify the entry is physically gone from the database.
EXPECT_EQ(CountResourcesTable(), 1);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntryDeletesBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData = "some data";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kData, /*truncate=*/false);
CheckBlobData(res_id, {{0, kData}});
ASSERT_EQ(DeleteLiveEntry(kKey), SqlPersistentStore::Error::kOk);
CheckBlobData(res_id, {});
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntryFailsNotFound) {
CreateAndInitStore();
const CacheEntryKey kKey("non-existent-key");
ASSERT_EQ(GetEntryCount(), 0);
// Attempt to delete an entry that doesn't exist.
auto result = DeleteLiveEntry(kKey);
ASSERT_EQ(result, SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntryFailsOnDoomedEntry) {
CreateAndInitStore();
const CacheEntryKey kDoomedKey("doomed-key");
const CacheEntryKey kLiveKey("live-key");
const int64_t live_key_size =
kSqlBackendStaticResourceSize + kLiveKey.string().size();
// Create one live entry and one entry that will be doomed.
const auto doomed_res_id = CreateEntryAndGetResId(kDoomedKey);
ASSERT_TRUE(CreateEntry(kLiveKey).has_value());
// Doom one of the entries.
ASSERT_EQ(DoomEntry(kDoomedKey, doomed_res_id),
SqlPersistentStore::Error::kOk);
// After dooming, one entry is live, one is doomed (logically removed).
ASSERT_EQ(GetEntryCount(), 1);
ASSERT_EQ(GetSizeOfAllEntries(), live_key_size);
// Attempt to delete the doomed entry with DeleteLiveEntry. This should fail
// because it's not "live".
auto result = DeleteLiveEntry(kDoomedKey);
ASSERT_EQ(result, SqlPersistentStore::Error::kNotFound);
// Verify that the live entry was not affected.
EXPECT_EQ(GetEntryCount(), 1);
auto open_live_result = OpenEntry(kLiveKey);
ASSERT_TRUE(open_live_result.has_value());
ASSERT_TRUE(open_live_result->has_value());
// Verify the doomed entry still exists in the table (as doomed), and the
// live entry is also present.
EXPECT_EQ(CountResourcesTable(), 2);
EXPECT_EQ(CountDoomedResourcesTable(kDoomedKey), 1);
EXPECT_EQ(CountDoomedResourcesTable(kLiveKey), 0);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntryNonExistentWithIndex) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
CreateEntryAndGetResId(kKey);
// Load the index.
ASSERT_TRUE(LoadInMemoryIndex());
const CacheEntryKey kNonExistentKey("non-existent-key");
// With the index loaded, this should synchronously return kNotFound without a
// DB lookup.
std::optional<SqlPersistentStore::Error> error;
store_->DeleteLiveEntry(
kNonExistentKey,
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error result) { error = result; }));
ASSERT_TRUE(error.has_value());
EXPECT_EQ(*error, SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntryWithCorruptSizeRecovers) {
CreateAndInitStore();
const CacheEntryKey kKeyToCorrupt("key-to-corrupt-size");
const CacheEntryKey kKeyToKeep("key-to-keep");
const int64_t keep_key_size = kKeyToKeep.string().size();
const int64_t expected_size_after_recovery =
kSqlBackendStaticResourceSize + keep_key_size;
// Create one entry to keep, and one to corrupt and delete.
ASSERT_TRUE(CreateEntry(kKeyToCorrupt).has_value());
ASSERT_TRUE(CreateEntry(kKeyToKeep).has_value());
ASSERT_EQ(GetEntryCount(), 2);
// Manually open the database and corrupt the `bytes_usage` for one entry
// to an extreme value that will cause an underflow during calculation.
{
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE resources SET bytes_usage = ? WHERE cache_key = ?"));
statement.BindInt64(0, std::numeric_limits<int64_t>::max());
statement.BindString(1, kKeyToCorrupt.string());
ASSERT_TRUE(statement.Run());
}
// Delete the entry with the corrupted size. This will trigger an underflow
// in `total_size_delta`, causing `!total_size_delta.IsValid()` to be true.
// The store should recover by recalculating its state from the database.
ASSERT_EQ(DeleteLiveEntry(kKeyToCorrupt), SqlPersistentStore::Error::kOk);
// Verify that recovery was successful. The entry count and total size
// should now reflect only the entry that was kept.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), expected_size_after_recovery);
// Verify the state on disk. Only the un-corrupted entry should remain.
EXPECT_EQ(CountResourcesTable(), 1);
}
TEST_F(SqlPersistentStoreTest, DeleteAllEntriesNonEmpty) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
const int64_t expected_size =
(kSqlBackendStaticResourceSize + kKey1.string().size()) +
(kSqlBackendStaticResourceSize + kKey2.string().size());
// Create two entries.
ASSERT_TRUE(CreateEntry(kKey1).has_value());
ASSERT_TRUE(CreateEntry(kKey2).has_value());
ASSERT_EQ(GetEntryCount(), 2);
ASSERT_EQ(GetSizeOfAllEntries(), expected_size);
ASSERT_EQ(CountResourcesTable(), 2);
// Delete all entries.
ASSERT_EQ(DeleteAllEntries(), SqlPersistentStore::Error::kOk);
// Verify the cache is empty.
EXPECT_EQ(GetEntryCount(), 0);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
EXPECT_EQ(CountResourcesTable(), 0);
// Verify the old entries cannot be opened.
auto open_result = OpenEntry(kKey1);
ASSERT_TRUE(open_result.has_value());
EXPECT_FALSE(open_result->has_value());
}
TEST_F(SqlPersistentStoreTest, DeleteAllEntriesDeletesBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const auto res_id1 = CreateEntryAndGetResId(kKey1);
const std::string kData1 = "data1";
WriteDataAndAssertSuccess(kKey1, res_id1, 0, 0, kData1, /*truncate=*/false);
const CacheEntryKey kKey2("key2");
const auto res_id2 = CreateEntryAndGetResId(kKey2);
const std::string kData2 = "data2";
WriteDataAndAssertSuccess(kKey2, res_id2, 0, 0, kData2, /*truncate=*/false);
CheckBlobData(res_id1, {{0, kData1}});
CheckBlobData(res_id2, {{0, kData2}});
ASSERT_EQ(DeleteAllEntries(), SqlPersistentStore::Error::kOk);
CheckBlobData(res_id1, {});
CheckBlobData(res_id2, {});
}
TEST_F(SqlPersistentStoreTest, DeleteAllEntriesEmpty) {
CreateAndInitStore();
ASSERT_EQ(GetEntryCount(), 0);
ASSERT_EQ(GetSizeOfAllEntries(), 0);
// Delete all entries from an already empty cache.
ASSERT_EQ(DeleteAllEntries(), SqlPersistentStore::Error::kOk);
// Verify the cache is still empty.
EXPECT_EQ(GetEntryCount(), 0);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
}
void SqlPersistentStoreTest::RunCleanupDoomedEntriesTest(
base::OnceClosure trigger_cleanup) {
CreateAndInitStore();
const CacheEntryKey kKeyToDoom1("key-to-doom1");
const CacheEntryKey kKeyToDoom2("key-to-doom2");
const CacheEntryKey kKeyToDoomActive("key-to-doom-active");
const CacheEntryKey kKeyToKeep("key-to-keep");
// Create entries that will be doomed.
auto create_result1 = CreateEntry(kKeyToDoom1);
ASSERT_TRUE(create_result1.has_value());
const auto res_id_to_doom1 = create_result1->res_id;
// Create entries that will be doomed.
auto create_result2 = CreateEntry(kKeyToDoom2);
ASSERT_TRUE(create_result2.has_value());
const auto res_id_to_doom2 = create_result2->res_id;
// Create an entry that will be kept.
auto create_result3 = CreateEntry(kKeyToKeep);
ASSERT_TRUE(create_result3.has_value());
const auto res_id_to_keep = create_result3->res_id;
// There should be 3 created entries.
ASSERT_EQ(GetEntryCount(), 3);
// Write data to the entries that will be doomed.
const std::string kData1 = "doomed_data1";
WriteDataAndAssertSuccess(kKeyToDoom1, res_id_to_doom1, /*old_body_end=*/0,
/*offset=*/0, kData1, /*truncate=*/false);
const std::string kData2 = "doomed_data2";
WriteDataAndAssertSuccess(kKeyToDoom2, res_id_to_doom2, /*old_body_end=*/0,
/*offset=*/0, kData2, /*truncate=*/false);
const std::string kData3 = "keep-data";
WriteDataAndAssertSuccess(kKeyToKeep, res_id_to_keep, /*old_body_end=*/0,
/*offset=*/0, kData3, /*truncate=*/false);
// Doom all the entries that will be doomed.
ASSERT_EQ(DoomEntry(kKeyToDoom1, res_id_to_doom1),
SqlPersistentStore::Error::kOk);
ASSERT_EQ(DoomEntry(kKeyToDoom2, res_id_to_doom2),
SqlPersistentStore::Error::kOk);
// The entry count after dooming 2 entries should be 1.
ASSERT_EQ(GetEntryCount(), 1);
// All resource blobs should be still available.
EXPECT_EQ(CountResourcesTable(), 3);
CheckBlobData(res_id_to_doom1, {{0, kData1}});
CheckBlobData(res_id_to_doom2, {{0, kData2}});
CheckBlobData(res_id_to_keep, {{0, kData3}});
// Reload the store and the doomed entries will be marked for deletion.
ClearStore();
CreateAndInitStore();
base::HistogramTester histogram_tester;
std::move(trigger_cleanup).Run();
// Verify that `DeleteDoomedEntriesCount` UMA was recorded in the histogram.
histogram_tester.ExpectUniqueSample(
"Net.SqlDiskCache.DeleteDoomedEntriesCount", 2, 1);
// Verify the entries for kKeyToDoom1 and kKeyToDoom2 are physically gone from
// the database.
EXPECT_EQ(CountResourcesTable(), 1);
CheckBlobData(res_id_to_doom1, {});
CheckBlobData(res_id_to_doom2, {});
CheckBlobData(res_id_to_keep, {{0, kData3}});
// Verify the live entry is still present.
auto open_result1 = OpenEntry(kKeyToKeep);
ASSERT_TRUE(open_result1.has_value());
ASSERT_TRUE(open_result1->has_value());
EXPECT_EQ(open_result1.value()->res_id, res_id_to_keep);
}
TEST_F(SqlPersistentStoreTest,
MaybeRunCleanupDoomedEntriesAfterLoadInMemoryIndex) {
RunCleanupDoomedEntriesTest(base::BindLambdaForTesting([&]() {
// Load the in-memory index to get the list of doomed entry.
EXPECT_TRUE(this->LoadInMemoryIndex());
base::test::TestFuture<SqlPersistentStore::Error> future;
EXPECT_TRUE(
this->store_->MaybeRunCleanupDoomedEntries(future.GetCallback()));
EXPECT_EQ(future.Get(), SqlPersistentStore::Error::kOk);
}));
}
TEST_F(SqlPersistentStoreTest,
MaybeRunCleanupDoomedEntriesWithLoadIndexOnInitFeature) {
base::test::ScopedFeatureList feature_list;
feature_list.InitWithFeaturesAndParameters(
{{net::features::kDiskCacheBackendExperiment,
{{net::features::kDiskCacheBackendParam.name, "sql"},
{net::features::kSqlDiskCacheLoadIndexOnInit.name, "true"}}}},
{});
RunCleanupDoomedEntriesTest(base::BindLambdaForTesting([&]() {
base::test::TestFuture<SqlPersistentStore::Error> future;
EXPECT_TRUE(
this->store_->MaybeRunCleanupDoomedEntries(future.GetCallback()));
EXPECT_EQ(future.Get(), SqlPersistentStore::Error::kOk);
}));
}
TEST_F(SqlPersistentStoreTest, MaybeRunCleanupDoomedEntriesMultipleShards) {
// Add more task runners to have more shards.
background_task_runners_.emplace_back(
base::ThreadPool::CreateSequencedTaskRunner({base::MayBlock()}));
background_task_runners_.emplace_back(
base::ThreadPool::CreateSequencedTaskRunner({base::MayBlock()}));
EXPECT_EQ(background_task_runners_.size(), 3);
CreateAndInitStore();
const CacheEntryKey kKeyToDoom1("key-to-doom1");
const auto shared1 = store_->GetShardIdForHash(kKeyToDoom1.hash());
// Find a key that belongs to a different shard.
CacheEntryKey key_to_doom_2;
for (int key_prefix = 2;; key_prefix++) {
key_to_doom_2 = CacheEntryKey(base::NumberToString(key_prefix));
if (store_->GetShardIdForHash(key_to_doom_2.hash()) != shared1) {
break;
}
}
// Create and doom the first entry.
auto create_result1 = CreateEntry(kKeyToDoom1);
ASSERT_TRUE(create_result1.has_value());
const auto res_id_to_doom1 = create_result1->res_id;
ASSERT_EQ(DoomEntry(kKeyToDoom1, res_id_to_doom1),
SqlPersistentStore::Error::kOk);
// Create and doom the second entry.
auto create_result2 = CreateEntry(key_to_doom_2);
ASSERT_TRUE(create_result2.has_value());
const auto res_id_to_doom2 = create_result2->res_id;
ASSERT_EQ(DoomEntry(key_to_doom_2, res_id_to_doom2),
SqlPersistentStore::Error::kOk);
// Reload the store and the doomed entries will be marked for deletion.
ClearStore();
CreateAndInitStore();
// Load the in-memory index to get the list of doomed entry.
EXPECT_TRUE(LoadInMemoryIndex());
// Cleanup the doomed eintries.
base::test::TestFuture<SqlPersistentStore::Error> future;
EXPECT_TRUE(store_->MaybeRunCleanupDoomedEntries(future.GetCallback()));
EXPECT_EQ(future.Get(), SqlPersistentStore::Error::kOk);
}
TEST_F(SqlPersistentStoreTest, MaybeRunCleanupDoomedEntriesNoDeletion) {
CreateAndInitStore();
// Scenario 1: No entries exist.
base::HistogramTester histogram_tester;
EXPECT_FALSE(store_->MaybeRunCleanupDoomedEntries(
base::BindOnce([](SqlPersistentStore::Error) { NOTREACHED(); })));
EXPECT_EQ(CountResourcesTable(), 0);
// Scenario 2: All entries are not doomed.
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
auto create_result1 = CreateEntry(kKey1);
ASSERT_TRUE(create_result1.has_value());
auto create_result2 = CreateEntry(kKey2);
ASSERT_TRUE(create_result2.has_value());
ASSERT_EQ(CountResourcesTable(), 2);
EXPECT_FALSE(store_->MaybeRunCleanupDoomedEntries(
base::BindOnce([](SqlPersistentStore::Error) { NOTREACHED(); })));
// Verify that no entries were deleted.
EXPECT_EQ(CountResourcesTable(), 2);
}
TEST_F(SqlPersistentStoreTest, ChangeEntryCountOverflowRecovers) {
// Create and initialize a store to have a valid DB file.
CreateAndInitStore();
// Manually set the entry count to INT32_MAX.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyEntryCount,
std::numeric_limits<int32_t>::max()));
}
// After re-openning the store. The manipulated count should be loaded.
ASSERT_EQ(GetEntryCount(), std::numeric_limits<int32_t>::max());
// Create a new entry. This will attempt to increment the counter, causing
// an overflow. The store should recover by recalculating the count from
// the `resources` table (which will be 1).
const CacheEntryKey kKey("my-key");
ASSERT_TRUE(CreateEntry(kKey).has_value());
// The new count should be 1 (the one entry we just created), not an
// overflowed value. The size should also be correct for one entry.
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
// Verify by closing and re-opening that the correct value was persisted.
CreateAndInitStore();
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
}
TEST_F(SqlPersistentStoreTest, ChangeTotalSizeOverflowRecovers) {
// Create and initialize a store.
CreateAndInitStore();
// Manually set the total size to INT64_MAX.
{
auto db_handle = ManuallyOpenDatabase();
auto meta_table = ManuallyOpenMetaTable(db_handle.get());
ASSERT_TRUE(meta_table->SetValue(kSqlBackendMetaTableKeyTotalSize,
std::numeric_limits<int64_t>::max()));
}
// Re-open the store and confirm it loaded the manipulated size.
ASSERT_EQ(GetSizeOfAllEntries(), std::numeric_limits<int64_t>::max());
ASSERT_EQ(GetEntryCount(), 0);
// Create a new entry. This will attempt to increment the total size,
// causing an overflow. The store should recover by recalculating.
const CacheEntryKey kKey("my-key");
ASSERT_TRUE(CreateEntry(kKey).has_value());
// The new total size should be just the size of the new entry.
// The entry count should have been incremented from its initial state (0).
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
// Verify that the correct values were persisted to the database.
CreateAndInitStore();
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + kKey.string().size());
}
// This test validates that the `kSqlBackendStaticResourceSize` constant
// provides a reasonable estimate for the per-entry overhead in the database. It
// creates a number of entries and compares the calculated size from the store
// with the actual size of the database file on disk.
TEST_F(SqlPersistentStoreTest, StaticResourceSizeEstimation) {
CreateAndInitStore();
const int kNumEntries = 1000;
const int kKeySize = 100;
int64_t total_key_size = 0;
for (int i = 0; i < kNumEntries; ++i) {
// Create a key of a fixed size.
std::string key_str = base::StringPrintf("key-%04d", i);
key_str.resize(kKeySize, ' ');
const CacheEntryKey key(key_str);
ASSERT_TRUE(CreateEntry(key).has_value());
total_key_size += key.string().size();
}
ASSERT_EQ(GetEntryCount(), kNumEntries);
// The size calculated by the store.
const int64_t calculated_size = GetSizeOfAllEntries();
EXPECT_EQ(calculated_size,
total_key_size + kNumEntries * kSqlBackendStaticResourceSize);
// Close the store to ensure all data is flushed to the main database file,
// making the file size measurement more stable and predictable.
ClearStore();
std::optional<int64_t> db_file_size =
base::GetFileSize(GetDatabaseFilePath());
ASSERT_TRUE(db_file_size);
// Calculate the actual overhead per entry based on the final file size.
// This includes all SQLite overhead (page headers, b-tree structures, etc.)
// for the data stored in the `resources` table, minus the raw key data.
const int64_t actual_overhead = *db_file_size - total_key_size;
ASSERT_GT(actual_overhead, 0);
const int64_t actual_overhead_per_entry = actual_overhead / kNumEntries;
LOG(INFO) << "kSqlBackendStaticResourceSize (estimate): "
<< kSqlBackendStaticResourceSize;
LOG(INFO) << "Actual overhead per entry (from file size): "
<< actual_overhead_per_entry;
// This is a loose validation. We check that our estimate is in the correct
// order of magnitude. The actual overhead can vary based on SQLite version,
// page size, and other factors.
// We expect the actual overhead to be positive.
EXPECT_GT(actual_overhead_per_entry, 0);
// A loose upper bound to catch if the overhead becomes excessively larger
// than our estimate. A factor of 4 should be sufficient.
EXPECT_LT(actual_overhead_per_entry, kSqlBackendStaticResourceSize * 4)
<< "Actual overhead is much larger than estimated. The constant might "
"need updating.";
// A loose lower bound. It's unlikely to be smaller than this.
EXPECT_GT(actual_overhead_per_entry, kSqlBackendStaticResourceSize / 8)
<< "Actual overhead is much smaller than estimated. The constant might "
"be too conservative.";
}
// Regression test for crbug.com/447751287.
TEST_F(SqlPersistentStoreTest, DeleteLiveEntriesBetweenOneEntry) {
CreateAndInitStore();
store_->EnableStrictCorruptionCheckForTesting();
const base::Time kBaseTime = base::Time::Now();
task_environment_.AdvanceClock(base::Minutes(1));
const CacheEntryKey kKey("key");
ASSERT_TRUE(CreateEntry(kKey).has_value());
task_environment_.AdvanceClock(base::Minutes(1));
ASSERT_EQ(DeleteLiveEntriesBetween(kBaseTime, base::Time::Now(), {}),
SqlPersistentStore::Error::kOk);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntriesBetween) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2-excluded");
const CacheEntryKey kKey3("key3");
const CacheEntryKey kKey4("key4-before");
const CacheEntryKey kKey5("key5-after");
const base::Time kBaseTime = base::Time::Now();
// Create entries with different last_used times.
task_environment_.AdvanceClock(base::Minutes(1));
ASSERT_TRUE(CreateEntry(kKey1).has_value());
const base::Time kTime1 = base::Time::Now();
task_environment_.AdvanceClock(base::Minutes(1));
auto create_result = CreateEntry(kKey2);
ASSERT_TRUE(create_result.has_value());
SqlPersistentStore::ResId res_id2 = create_result->res_id;
task_environment_.AdvanceClock(base::Minutes(1));
ASSERT_TRUE(CreateEntry(kKey3).has_value());
const base::Time kTime3 = base::Time::Now();
// Create kKey4 and then manually set its last_used time to kBaseTime,
// which is before kTime1.
ASSERT_TRUE(CreateEntry(kKey4).has_value());
{
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE resources SET last_used = ? WHERE cache_key = ?"));
statement.BindTime(0, kBaseTime);
statement.BindString(1, kKey4.string());
ASSERT_TRUE(statement.Run());
}
// kKey4's last_used time in DB is now kBaseTime. kBaseTime < kTime1 is true.
// Create kKey5, ensuring its time is after kTime3.
// At this point, Time::Now() is effectively kTime3.
task_environment_.AdvanceClock(base::Minutes(1));
ASSERT_TRUE(CreateEntry(kKey5).has_value());
const base::Time kTime5 = base::Time::Now();
ASSERT_GT(kTime5, kTime3);
ASSERT_EQ(GetEntryCount(), 5);
int64_t initial_total_size = GetSizeOfAllEntries();
EXPECT_TRUE(LoadInMemoryIndex());
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey3.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey4.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey5.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Delete entries between kTime1 (inclusive) and kTime3 (exclusive).
// kKey2 should be excluded.
// Expected to delete: kKey1.
// Expected to keep: kKey2, kKey3, kKey4, kKey5.
std::vector<SqlPersistentStore::ResIdAndShardId> excluded_list = {
SqlPersistentStore::ResIdAndShardId(
res_id2, store_->GetShardIdForHash(kKey2.hash()))};
ASSERT_EQ(DeleteLiveEntriesBetween(kTime1, kTime3, excluded_list),
SqlPersistentStore::Error::kOk);
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey3.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey4.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey5.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(GetEntryCount(), 4);
const int64_t expected_size_after_delete =
initial_total_size -
(kSqlBackendStaticResourceSize + kKey1.string().size());
EXPECT_EQ(GetSizeOfAllEntries(), expected_size_after_delete);
// Verify kKey1 is deleted.
auto open_key1 = OpenEntry(kKey1);
ASSERT_TRUE(open_key1.has_value());
EXPECT_FALSE(open_key1->has_value());
// Verify other keys are still present.
EXPECT_TRUE(OpenEntry(kKey2).value().has_value());
EXPECT_TRUE(OpenEntry(kKey3).value().has_value());
EXPECT_TRUE(OpenEntry(kKey4).value().has_value());
EXPECT_TRUE(OpenEntry(kKey5).value().has_value());
EXPECT_EQ(CountResourcesTable(), 4);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntriesBetweenDeletesBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const auto res_id1 = CreateEntryAndGetResId(kKey1);
const std::string kData1 = "data1";
WriteDataAndAssertSuccess(kKey1, res_id1, 0, 0, kData1, /*truncate=*/false);
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time time1 = base::Time::Now();
const CacheEntryKey kKey2("key2");
const auto res_id2 = CreateEntryAndGetResId(kKey2);
const std::string kData2 = "data2";
WriteDataAndAssertSuccess(kKey2, res_id2, 0, 0, kData2, /*truncate=*/false);
CheckBlobData(res_id1, {{0, kData1}});
CheckBlobData(res_id2, {{0, kData2}});
ASSERT_EQ(DeleteLiveEntriesBetween(time1, base::Time::Max()),
SqlPersistentStore::Error::kOk);
CheckBlobData(res_id1, {{0, kData1}}); // Should not be deleted
CheckBlobData(res_id2, {}); // Should be deleted
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntriesBetweenEmptyCache) {
CreateAndInitStore();
ASSERT_EQ(GetEntryCount(), 0);
ASSERT_EQ(GetSizeOfAllEntries(), 0);
ASSERT_EQ(DeleteLiveEntriesBetween(base::Time(), base::Time::Max()),
SqlPersistentStore::Error::kOk);
EXPECT_EQ(GetEntryCount(), 0);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntriesBetweenNoMatchingEntries) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time kTime1 = base::Time::Now();
ASSERT_TRUE(CreateEntry(kKey1).has_value());
ASSERT_EQ(GetEntryCount(), 1);
int64_t initial_total_size = GetSizeOfAllEntries();
// Delete entries in a range that doesn't include kKey1.
ASSERT_EQ(DeleteLiveEntriesBetween(kTime1 + base::Minutes(1),
kTime1 + base::Minutes(2)),
SqlPersistentStore::Error::kOk);
EXPECT_EQ(GetEntryCount(), 1);
EXPECT_EQ(GetSizeOfAllEntries(), initial_total_size);
EXPECT_TRUE(OpenEntry(kKey1).value().has_value());
}
TEST_F(SqlPersistentStoreTest, DeleteLiveEntriesBetweenWithCorruptSize) {
CreateAndInitStore();
const CacheEntryKey kKeyToCorrupt("key-to-corrupt-size");
const CacheEntryKey kKeyToKeep("key-to-keep");
// Create an entry that will be corrupted and fall within the deletion range.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time kTimeCorrupt = base::Time::Now();
ASSERT_TRUE(CreateEntry(kKeyToCorrupt).has_value());
// Create an entry that will be kept (outside the deletion range).
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time kTimeKeep = base::Time::Now();
ASSERT_TRUE(CreateEntry(kKeyToKeep).has_value());
ASSERT_EQ(GetEntryCount(), 2);
{
auto db_handle = ManuallyOpenDatabase();
// Set bytes_usage for kKeyToCorrupt to cause overflow when subtracted
// during deletion.
sql::Statement update_corrupt_stmt(db_handle->GetUniqueStatement(
"UPDATE resources SET bytes_usage=? WHERE cache_key=?"));
update_corrupt_stmt.BindInt64(0, std::numeric_limits<int64_t>::min());
update_corrupt_stmt.BindString(1, kKeyToCorrupt.string());
ASSERT_TRUE(update_corrupt_stmt.Run());
}
base::HistogramTester histogram_tester;
// Delete entries in a range that includes kKeyToCorrupt [kTimeCorrupt,
// kTimeKeep). kKeyToKeep's last_used time is kTimeKeep, so it's not <
// kTimeKeep.
ASSERT_EQ(DeleteLiveEntriesBetween(kTimeCorrupt, kTimeKeep),
SqlPersistentStore::Error::kOk);
// Verify that `ResultWithCorruption` UMA was recorded in the histogram due to
// the corrupted bytes_usage.
histogram_tester.ExpectUniqueSample(
"Net.SqlDiskCache.Backend.DeleteLiveEntriesBetween.ResultWithCorruption",
SqlPersistentStore::Error::kOk, 1);
// kKeyToCorrupt should be deleted.
// kKeyToKeep should remain.
// The store should have recovered from the size overflow.
EXPECT_EQ(GetEntryCount(), 1);
const int64_t expected_size_after_delete =
kSqlBackendStaticResourceSize + kKeyToKeep.string().size();
EXPECT_EQ(GetSizeOfAllEntries(), expected_size_after_delete);
EXPECT_FALSE(OpenEntry(kKeyToCorrupt).value().has_value());
EXPECT_TRUE(OpenEntry(kKeyToKeep).value().has_value());
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByKeySuccess) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
auto create_result = CreateEntry(kKey);
ASSERT_TRUE(create_result.has_value());
const base::Time create_time = create_result->last_used;
// Open to verify initial time.
auto open_result1 = OpenEntry(kKey);
ASSERT_TRUE(open_result1.has_value() && open_result1->has_value());
EXPECT_EQ((*open_result1)->last_used, create_time);
// Advance time and update.
task_environment_.AdvanceClock(base::Minutes(5));
const base::Time kNewTime = base::Time::Now();
ASSERT_NE(kNewTime, create_time);
ASSERT_EQ(UpdateEntryLastUsedByKey(kKey, kNewTime),
SqlPersistentStore::Error::kOk);
// Setting the same time should succeed.
ASSERT_EQ(UpdateEntryLastUsedByKey(kKey, kNewTime),
SqlPersistentStore::Error::kOk);
// Open again to verify the updated time.
auto open_result2 = OpenEntry(kKey);
ASSERT_TRUE(open_result2.has_value() && open_result2->has_value());
EXPECT_EQ((*open_result2)->last_used, kNewTime);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByKeyOnNonExistentEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("non-existent-key");
ASSERT_EQ(UpdateEntryLastUsedByKey(kKey, base::Time::Now()),
SqlPersistentStore::Error::kNotFound);
EXPECT_EQ(GetEntryCount(), 0);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByKeyOnDoomedEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("doomed-key");
// Create and then doom the entry.
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
// Attempting to update a doomed entry should fail as if it's not found.
ASSERT_EQ(UpdateEntryLastUsedByKey(kKey, base::Time::Now()),
SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByKeyNonExistentWithIndex) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
CreateEntryAndGetResId(kKey);
// Load the index.
ASSERT_TRUE(LoadInMemoryIndex());
const CacheEntryKey kNonExistentKey("non-existent-key");
// With the index loaded, this should synchronously return kNotFound without a
// DB lookup.
std::optional<SqlPersistentStore::Error> error;
store_->UpdateEntryLastUsedByKey(
kNonExistentKey, base::Time::Now(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error result) { error = result; }));
ASSERT_TRUE(error.has_value());
EXPECT_EQ(*error, SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByResIdSuccess) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
auto create_result = CreateEntry(kKey);
ASSERT_TRUE(create_result.has_value());
const base::Time create_time = create_result->last_used;
const auto res_id = create_result->res_id;
// Open to verify initial time.
auto open_result1 = OpenEntry(kKey);
ASSERT_TRUE(open_result1.has_value() && open_result1->has_value());
EXPECT_EQ((*open_result1)->last_used, create_time);
// Advance time and update.
task_environment_.AdvanceClock(base::Minutes(5));
const base::Time kNewTime = base::Time::Now();
ASSERT_NE(kNewTime, create_time);
ASSERT_EQ(UpdateEntryLastUsedByResId(kKey, res_id, kNewTime),
SqlPersistentStore::Error::kOk);
// Setting the same time should succeed.
ASSERT_EQ(UpdateEntryLastUsedByResId(kKey, res_id, kNewTime),
SqlPersistentStore::Error::kOk);
// Open again to verify the updated time.
auto open_result2 = OpenEntry(kKey);
ASSERT_TRUE(open_result2.has_value() && open_result2->has_value());
EXPECT_EQ((*open_result2)->last_used, kNewTime);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByResIdOnNonExistentEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("key");
ASSERT_EQ(UpdateEntryLastUsedByResId(kKey, SqlPersistentStore::ResId(123),
base::Time::Now()),
SqlPersistentStore::Error::kNotFound);
EXPECT_EQ(GetEntryCount(), 0);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryLastUsedByResIdOnDoomedEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("doomed-key");
// Create and then doom the entry.
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
// Attempting to update a doomed entry should fail as if it's not found.
ASSERT_EQ(UpdateEntryLastUsedByResId(kKey, res_id, base::Time::Now()),
SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryHeaderAndLastUsedSuccessInitial) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Initial bytes_usage is just the key size.
const int64_t initial_bytes_usage = kKey.string().size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + initial_bytes_usage);
// Prepare new header data.
const std::string kNewHeadData = "new_header_data";
auto buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
// Advance time for new last_used.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time new_last_used = base::Time::Now();
// Update the entry. Previous header size is 0 as it was null.
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, new_last_used, buffer,
/*header_size_delta=*/kNewHeadData.size()),
SqlPersistentStore::Error::kOk);
// Verify in-memory stats.
const int64_t expected_bytes_usage =
initial_bytes_usage + kNewHeadData.size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + expected_bytes_usage);
// Verify database content.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->last_used, new_last_used);
EXPECT_EQ(details->bytes_usage, expected_bytes_usage);
EXPECT_EQ(details->head_data, kNewHeadData);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryHeaderAndLastUsedSuccessReplace) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Initial update with some header data.
const std::string kInitialHeadData = "initial_data";
auto initial_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kInitialHeadData);
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(),
initial_buffer, kInitialHeadData.size()),
SqlPersistentStore::Error::kOk);
const int64_t initial_bytes_usage =
kKey.string().size() + kInitialHeadData.size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + initial_bytes_usage);
// Prepare new header data of the same size.
const std::string kNewHeadData = "updated_data";
ASSERT_EQ(kNewHeadData.size(), kInitialHeadData.size());
auto new_buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
// Advance time for new last_used.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time new_last_used = base::Time::Now();
// Update the entry.
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, new_last_used, new_buffer,
/*header_size_delta=*/0),
SqlPersistentStore::Error::kOk);
// Verify in-memory stats (should be unchanged as size is same).
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + initial_bytes_usage);
// Verify database content.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->last_used, new_last_used);
EXPECT_EQ(details->bytes_usage, initial_bytes_usage);
EXPECT_EQ(details->head_data, kNewHeadData);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryHeaderAndLastUsedSuccessGrow) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Initial update with some header data.
const std::string kInitialHeadData = "short";
auto initial_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kInitialHeadData);
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(),
initial_buffer, kInitialHeadData.size()),
SqlPersistentStore::Error::kOk);
const int64_t initial_bytes_usage =
kKey.string().size() + kInitialHeadData.size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + initial_bytes_usage);
// Prepare new, larger header data.
const std::string kNewHeadData = "much_longer_header_data";
ASSERT_GT(kNewHeadData.size(), kInitialHeadData.size());
auto new_buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
// Update the entry.
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(
kKey, res_id, base::Time::Now(), new_buffer,
static_cast<int64_t>(kNewHeadData.size()) - kInitialHeadData.size()),
SqlPersistentStore::Error::kOk);
// Verify in-memory stats.
const int64_t expected_bytes_usage =
kKey.string().size() + kNewHeadData.size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + expected_bytes_usage);
// Verify database content.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->bytes_usage, expected_bytes_usage);
EXPECT_EQ(details->head_data, kNewHeadData);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryHeaderAndLastUsedSuccessShrink) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Initial update with large header data.
const std::string kInitialHeadData = "much_longer_header_data";
auto initial_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kInitialHeadData);
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(),
initial_buffer, kInitialHeadData.size()),
SqlPersistentStore::Error::kOk);
const int64_t initial_bytes_usage =
kKey.string().size() + kInitialHeadData.size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + initial_bytes_usage);
// Prepare new, smaller header data.
const std::string kNewHeadData = "short";
ASSERT_LT(kNewHeadData.size(), kInitialHeadData.size());
auto new_buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
// Update the entry.
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(
kKey, res_id, base::Time::Now(), new_buffer,
static_cast<int64_t>(kNewHeadData.size()) - kInitialHeadData.size()),
SqlPersistentStore::Error::kOk);
// Verify in-memory stats.
const int64_t expected_bytes_usage =
kKey.string().size() + kNewHeadData.size();
EXPECT_EQ(GetSizeOfAllEntries(),
kSqlBackendStaticResourceSize + expected_bytes_usage);
// Verify database content.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->bytes_usage, expected_bytes_usage);
EXPECT_EQ(details->head_data, kNewHeadData);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryHeaderAndLastUsedNotFound) {
CreateAndInitStore();
const CacheEntryKey kKey("non-existent-key");
auto buffer = base::MakeRefCounted<net::StringIOBuffer>("data");
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, SqlPersistentStore::ResId(100),
base::Time::Now(), buffer, buffer->size()),
SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, UpdateEntryHeaderAndLastUsedDoomedEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("doomed-key");
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
auto buffer = base::MakeRefCounted<net::StringIOBuffer>("data");
ASSERT_EQ(UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(),
buffer, buffer->size()),
SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest,
UpdateEntryHeaderAndLastUsedCorruptionDetectedAndRolledBack) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
auto create_result = CreateEntry(kKey);
ASSERT_TRUE(create_result.has_value());
const auto res_id = create_result->res_id;
const base::Time initial_last_used = create_result->last_used;
const int64_t initial_size_of_all_entries = GetSizeOfAllEntries();
const int32_t initial_entry_count = GetEntryCount();
// Manually corrupt the bytes_usage to a very small value.
const int64_t corrupted_bytes_usage = 1;
{
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE resources SET bytes_usage = ? WHERE cache_key = ?"));
statement.BindInt64(0, corrupted_bytes_usage);
statement.BindString(1, kKey.string());
ASSERT_TRUE(statement.Run());
}
ASSERT_EQ(GetSizeOfAllEntries(), initial_size_of_all_entries);
ASSERT_EQ(GetEntryCount(), initial_entry_count);
// Prepare a new header.
const std::string kNewHeadData = "new_header_data";
auto buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
base::HistogramTester histogram_tester;
// Update the entry. This should trigger corruption detection because
// `bytes_usage` in the DB is inconsistent. The operation should fail and the
// transaction should be rolled back.
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(), buffer,
/*header_size_delta=*/buffer->size()),
SqlPersistentStore::Error::kInvalidData);
// Verify that `ResultWithCorruption` UMA was recorded in the histogram.
histogram_tester.ExpectUniqueSample(
"Net.SqlDiskCache.Backend.UpdateEntryHeaderAndLastUsed."
"ResultWithCorruption",
SqlPersistentStore::Error::kInvalidData, 1);
// Verify that the store status was NOT changed due to rollback.
EXPECT_EQ(GetEntryCount(), initial_entry_count);
EXPECT_EQ(GetSizeOfAllEntries(), initial_size_of_all_entries);
// Verify database content was rolled back to its state before the UPDATE
// call.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->last_used, initial_last_used);
EXPECT_EQ(details->bytes_usage, corrupted_bytes_usage);
EXPECT_EQ(details->head_data, ""); // Header should remain empty.
}
TEST_F(SqlPersistentStoreTest, OpenEntryCheckSumError) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
EXPECT_EQ(GetResourceCheckSum(res_id), CalculateCheckSum({}, kKey.hash()));
// Prepare header data.
const std::string kHeadData = "header_data";
auto buffer = base::MakeRefCounted<net::StringIOBuffer>(kHeadData);
// Update the entry. Previous header size is 0 as it was null.
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(), buffer,
/*header_size_delta=*/kHeadData.size()),
SqlPersistentStore::Error::kOk);
EXPECT_EQ(GetResourceCheckSum(res_id),
CalculateCheckSum(buffer->span(), kKey.hash()));
// Corrupt the head data.
{
const std::string kCorruptedData = "_corrupted_";
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"UPDATE resources SET head = ? WHERE res_id = ?"));
statement.BindBlob(0, base::as_byte_span(kCorruptedData));
statement.BindInt64(1, res_id.value());
ASSERT_TRUE(statement.Run());
}
auto result = OpenEntry(kKey);
ASSERT_FALSE(result.has_value());
EXPECT_EQ(result.error(), SqlPersistentStore::Error::kCheckSumError);
}
TEST_F(SqlPersistentStoreTest, WriteAndReadData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData = "hello world";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kData, /*truncate=*/false);
EXPECT_EQ(GetSizeOfAllEntries(), kSqlBackendStaticResourceSize +
kKey.string().size() + kData.size());
// Read data back.
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/kData.size(),
/*body_end=*/kData.size(), /*sparse_reading=*/false, kData);
// Verify blob data in the database.
CheckBlobData(res_id, {{0, kData}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, kData.size(),
kKey.string().size() + kData.size());
}
TEST_F(SqlPersistentStoreTest, BlobCheckSum) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData = "hello world";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kData, /*truncate=*/false);
{
auto db_handle = ManuallyOpenDatabase();
sql::Statement statement(db_handle->GetUniqueStatement(
"SELECT check_sum FROM blobs WHERE res_id = ?"));
statement.BindInt64(0, res_id.value());
ASSERT_TRUE(statement.Step());
EXPECT_EQ(statement.ColumnInt(0),
CalculateCheckSum(base::as_byte_span(kData), kKey.hash()));
}
}
TEST_F(SqlPersistentStoreTest, ReadEntryDataInvalidDataSizeMismatch) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob data size so it doesn't match its start/end
// offsets.
const std::string kCorruptedData = "short";
OverwriteBlobData(
kKey, res_id, kCorruptedData,
CalculateCheckSum(base::as_byte_span(kCorruptedData), kKey.hash()));
// This read will try to read the corrupted blob, which should be detected.
auto read_buffer =
base::MakeRefCounted<net::IOBufferWithSize>(kInitialData.size());
auto read_result = ReadEntryData(
kKey, res_id, /*offset=*/0, read_buffer, kInitialData.size(),
/*body_end=*/kInitialData.size(), /*sparse_reading=*/false);
ASSERT_FALSE(read_result.has_value());
EXPECT_EQ(read_result.error(), SqlPersistentStore::Error::kInvalidData);
}
TEST_F(SqlPersistentStoreTest, ReadEntryDataCheckSumError) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob data so check_sum mismatch occur
const std::string kCorruptedData = "0123456780";
OverwriteBlobData(
kKey, res_id, kCorruptedData,
CalculateCheckSum(base::as_byte_span(kInitialData), kKey.hash()));
// This read will try to read the corrupted blob, which should be detected.
auto read_buffer =
base::MakeRefCounted<net::IOBufferWithSize>(kInitialData.size());
auto read_result = ReadEntryData(
kKey, res_id, /*offset=*/0, read_buffer, kInitialData.size(),
/*body_end=*/kInitialData.size(), /*sparse_reading=*/false);
ASSERT_FALSE(read_result.has_value());
EXPECT_EQ(read_result.error(), SqlPersistentStore::Error::kCheckSumError);
}
TEST_F(SqlPersistentStoreTest, ReadEntryDataInvalidDataRangeOverflow) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob's start and end to cause an overflow.
CorruptBlobRange(res_id, std::numeric_limits<int64_t>::min(), 10);
// This read will try to read the corrupted blob, which should be detected.
auto read_buffer =
base::MakeRefCounted<net::IOBufferWithSize>(kInitialData.size());
auto read_result = ReadEntryData(
kKey, res_id, /*offset=*/0, read_buffer, kInitialData.size(),
/*body_end=*/kInitialData.size(), /*sparse_reading=*/false);
ASSERT_FALSE(read_result.has_value());
EXPECT_EQ(read_result.error(), SqlPersistentStore::Error::kInvalidData);
}
TEST_F(SqlPersistentStoreTest, TrimOverlappingBlobsInvalidDataSizeMismatch) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob data size so it doesn't match its start/end
// offsets.
const std::string kCorruptedData = "short";
OverwriteBlobData(
kKey, res_id, kCorruptedData,
CalculateCheckSum(base::as_byte_span(kCorruptedData), kKey.hash()));
// This write will overlap with the corrupted blob, triggering
// TrimOverlappingBlobs, which should detect the inconsistency.
const std::string kOverwriteData = "abc";
auto overwrite_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kOverwriteData);
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/2, overwrite_buffer,
kOverwriteData.size(), /*truncate=*/false),
SqlPersistentStore::Error::kInvalidData);
}
TEST_F(SqlPersistentStoreTest, TrimOverlappingBlobsCheckSumError) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob data so check_sum mismatch occur
const std::string kCorruptedData = "0123456780";
OverwriteBlobData(
kKey, res_id, kCorruptedData,
CalculateCheckSum(base::as_byte_span(kInitialData), kKey.hash()));
// This write will overlap with the corrupted blob, triggering
// TrimOverlappingBlobs, which should detect the inconsistency.
const std::string kOverwriteData = "abc";
auto overwrite_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kOverwriteData);
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/2, overwrite_buffer,
kOverwriteData.size(), /*truncate=*/false),
SqlPersistentStore::Error::kCheckSumError);
}
TEST_F(SqlPersistentStoreTest, TrimOverlappingBlobsInvalidDataRangeOverflow) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob's start and end to cause an overflow.
CorruptBlobRange(res_id, std::numeric_limits<int64_t>::min(), 10);
// This write will overlap with the corrupted blob, triggering
// TrimOverlappingBlobs, which should detect the overflow.
const std::string kOverwriteData = "abc";
auto overwrite_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kOverwriteData);
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/5, overwrite_buffer,
kOverwriteData.size(), /*truncate=*/false),
SqlPersistentStore::Error::kInvalidData);
}
TEST_F(SqlPersistentStoreTest, TruncateExistingBlobsInvalidDataSizeMismatch) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob data size so it doesn't match its start/end
// offsets.
const std::string kCorruptedData = "short";
OverwriteBlobData(
kKey, res_id, kCorruptedData,
CalculateCheckSum(base::as_byte_span(kCorruptedData), kKey.hash()));
// This write will truncate the entry, triggering TruncateExistingBlobs,
// which should detect the inconsistency.
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/5, /*buffer=*/nullptr, /*buf_len=*/0,
/*truncate=*/true),
SqlPersistentStore::Error::kInvalidData);
}
TEST_F(SqlPersistentStoreTest, TruncateExistingBlobsInvalidDataRangeOverflow) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to create a blob.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Manually corrupt the blob's start and end to cause an overflow.
CorruptBlobRange(res_id, std::numeric_limits<int64_t>::min(), 10);
// This write will truncate the entry, triggering TruncateExistingBlobs,
// which should detect the overflow.
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/1, /*buffer=*/nullptr, /*buf_len=*/0,
/*truncate=*/true),
SqlPersistentStore::Error::kInvalidData);
}
TEST_F(SqlPersistentStoreTest, WriteEntryDataInvalidArgument) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
auto buffer = base::MakeRefCounted<net::StringIOBuffer>("data");
const int buf_len = buffer->size();
// Test with negative old_body_end.
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/-1, /*offset=*/0,
buffer, buf_len, /*truncate=*/false),
SqlPersistentStore::Error::kInvalidArgument);
// Test with negative offset.
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/0, /*offset=*/-1,
buffer, buf_len, /*truncate=*/false),
SqlPersistentStore::Error::kInvalidArgument);
// Test with offset + buf_len overflow.
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/0,
/*offset=*/std::numeric_limits<int64_t>::max(),
buffer, buf_len, /*truncate=*/false),
SqlPersistentStore::Error::kInvalidArgument);
// Test with negative buf_len.
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
buffer, /*buf_len=*/-1, /*truncate=*/false),
SqlPersistentStore::Error::kInvalidArgument);
// Test with null buffer but positive buf_len.
EXPECT_EQ(
WriteEntryData(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
/*buffer=*/nullptr, /*buf_len=*/1, /*truncate=*/false),
SqlPersistentStore::Error::kInvalidArgument);
// Test with buf_len > buffer->size().
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
buffer, buf_len + 1, /*truncate=*/false),
SqlPersistentStore::Error::kInvalidArgument);
}
TEST_F(SqlPersistentStoreTest, WriteEntryDataInvalidDataBodyEndMismatch) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write initial data to set body_end.
const std::string kInitialData = "0123456789";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// The body_end in the database is now kInitialData.size().
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
ASSERT_EQ(details->body_end, kInitialData.size());
// Now, try to write again, but provide an incorrect old_body_end.
const std::string kOverwriteData = "abc";
auto overwrite_buffer =
base::MakeRefCounted<net::StringIOBuffer>(kOverwriteData);
EXPECT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/5, /*offset=*/8,
overwrite_buffer, kOverwriteData.size(),
/*truncate=*/false),
SqlPersistentStore::Error::kBodyEndMismatch);
}
TEST_F(SqlPersistentStoreTest, ReadEntryDataInvalidArgument) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
auto buffer = base::MakeRefCounted<net::IOBufferWithSize>(10);
const int buf_len = buffer->size();
// Test with negative offset.
auto result = ReadEntryData(kKey, res_id, /*offset=*/-1, buffer, buf_len,
/*body_end=*/10, /*sparse_reading=*/false);
ASSERT_FALSE(result.has_value());
EXPECT_EQ(result.error(), SqlPersistentStore::Error::kInvalidArgument);
// Test with negative buf_len.
result = ReadEntryData(kKey, res_id, /*offset=*/0, buffer, /*buf_len=*/-1,
/*body_end=*/10, /*sparse_reading=*/false);
ASSERT_FALSE(result.has_value());
EXPECT_EQ(result.error(), SqlPersistentStore::Error::kInvalidArgument);
// Test with null buffer.
result =
ReadEntryData(kKey, res_id, /*offset=*/0, /*buffer=*/nullptr, buf_len,
/*body_end=*/10, /*sparse_reading=*/false);
ASSERT_FALSE(result.has_value());
EXPECT_EQ(result.error(), SqlPersistentStore::Error::kInvalidArgument);
// Test with buf_len > buffer->size().
result = ReadEntryData(kKey, res_id, /*offset=*/0, buffer, buf_len + 1,
/*body_end=*/10, /*sparse_reading=*/false);
ASSERT_FALSE(result.has_value());
EXPECT_EQ(result.error(), SqlPersistentStore::Error::kInvalidArgument);
}
TEST_F(SqlPersistentStoreTest, OverwriteEntryData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
const std::string kOverwriteData = "abc";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/2, kOverwriteData, /*truncate=*/false);
// Verify size updates.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->body_end, kInitialData.size());
EXPECT_EQ(details->bytes_usage, kKey.string().size() + kInitialData.size());
// Read back and verify.
ReadAndVerifyData(
kKey, res_id, /*offset=*/0, /*buffer_len=*/kInitialData.size(),
/*body_end=*/kInitialData.size(), /*sparse_reading=*/false, "12abc67890");
// Verify blob data in the database.
CheckBlobData(res_id, {{0, "12"}, {2, "abc"}, {5, "67890"}});
}
TEST_F(SqlPersistentStoreTest, AppendEntryData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kInitialData = "initial";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
const std::string kAppendData = "-appended";
const int64_t new_body_end = kInitialData.size() + kAppendData.size();
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/kInitialData.size(), kAppendData,
/*truncate=*/false);
// Read back and verify.
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/new_body_end,
new_body_end, /*sparse_reading=*/false, "initial-appended");
// Verify blob data in the database.
CheckBlobData(res_id,
{{0, kInitialData}, {kInitialData.size(), kAppendData}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, new_body_end,
kKey.string().size() + new_body_end);
}
TEST_F(SqlPersistentStoreTest, TruncateEntryData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
const std::string kTruncateData = "abc";
const int64_t new_body_end = 2 + kTruncateData.size();
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/2, kTruncateData, /*truncate=*/true);
// Read back and verify.
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/new_body_end,
new_body_end, /*sparse_reading=*/false, "12abc");
// Verify blob data in the database.
CheckBlobData(res_id, {{0, "12"}, {2, "abc"}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, new_body_end,
kKey.string().size() + new_body_end);
}
TEST_F(SqlPersistentStoreTest, TruncateWithNullBuffer) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write some initial data.
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
VerifyBodyEndAndBytesUsage(kKey, kInitialData.size(),
kKey.string().size() + kInitialData.size());
// Now, truncate the entry to a smaller size using a null buffer.
const int64_t kTruncateOffset = 5;
ASSERT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/kTruncateOffset, /*buffer=*/nullptr,
/*buf_len=*/0, /*truncate=*/true),
SqlPersistentStore::Error::kOk);
// Read back and verify.
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/kTruncateOffset,
kTruncateOffset, /*sparse_reading=*/false, "12345");
// Verify blob data in the database.
CheckBlobData(res_id, {{0, "12345"}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, kTruncateOffset,
kKey.string().size() + kTruncateOffset);
}
TEST_F(SqlPersistentStoreTest, TruncateOverlappingMultipleBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
WriteAndVerifySingleByteBlobs(kKey, res_id, "01234");
// Overwrite with a 2-byte truncate write in the middle.
const std::string kOverwriteData = "XX";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/5, /*offset=*/1,
kOverwriteData, /*truncate=*/true);
// The new body end should be offset + length = 1 + 2 = 3.
const int64_t new_body_end = 3;
// Verify the content.
ReadAndVerifyData(kKey, res_id, 0, new_body_end, new_body_end, false, "0XX");
// Verify the underlying blobs.
// The original blob for "0" should be trimmed.
// The original blobs for "1", "2", "3", "4" should be gone.
// A new blob for "XX" should be present.
CheckBlobData(res_id, {{0, "0"}, {1, "XX"}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, new_body_end,
kKey.string().size() + new_body_end);
}
TEST_F(SqlPersistentStoreTest, TruncateMultipleBlobsWithZeroLengthWrite) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
WriteAndVerifySingleByteBlobs(kKey, res_id, "01234");
// Truncate at offset 2 with a zero-length write.
ASSERT_EQ(
WriteEntryData(kKey, res_id, /*old_body_end=*/5, /*offset=*/2,
/*buffer=*/nullptr, /*buf_len=*/0, /*truncate=*/true),
SqlPersistentStore::Error::kOk);
// The new body end should be the offset = 2.
const int64_t new_body_end = 2;
// Verify the content.
ReadAndVerifyData(kKey, res_id, 0, new_body_end, new_body_end, false, "01");
// Verify the underlying blobs.
// The original blobs for "2", "3", "4" should be gone.
// The original blob for "0" and "1" should remain.
CheckBlobData(res_id, {{0, "0"}, {1, "1"}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, new_body_end,
kKey.string().size() + new_body_end);
}
TEST_F(SqlPersistentStoreTest, OverwriteMultipleBlobsWithoutTruncate) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
WriteAndVerifySingleByteBlobs(kKey, res_id, "01234");
// Overwrite with a 2-byte write in the middle, without truncating.
const std::string kOverwriteData = "AB";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/5, /*offset=*/1,
kOverwriteData, /*truncate=*/false);
// The body end should remain 5.
const int64_t new_body_end = 5;
// Verify the content.
ReadAndVerifyData(kKey, res_id, 0, new_body_end, new_body_end, false,
"0AB34");
// Verify the underlying blobs.
CheckBlobData(res_id, {{0, "0"}, {1, "AB"}, {3, "3"}, {4, "4"}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, new_body_end,
kKey.string().size() + new_body_end);
}
TEST_F(SqlPersistentStoreTest, WriteToDoomedEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
const std::string kData = "hello world";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kData, /*truncate=*/false);
EXPECT_EQ(GetSizeOfAllEntries(), 0);
// Verify blob data in the database.
CheckBlobData(res_id, {{0, kData}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, kData.size(),
kKey.string().size() + kData.size());
}
TEST_F(SqlPersistentStoreTest, WriteEntryDataNotFound) {
CreateAndInitStore();
const CacheEntryKey kKey("non-existent-key");
auto write_buffer = base::MakeRefCounted<net::StringIOBuffer>("data");
ASSERT_EQ(WriteEntryData(kKey, SqlPersistentStore::ResId(100),
/*old_body_end=*/0, /*offset=*/0, write_buffer,
write_buffer->size(), /*truncate=*/false),
SqlPersistentStore::Error::kNotFound);
}
TEST_F(SqlPersistentStoreTest, WriteEntryDataNullBufferNoTruncate) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
CheckBlobData(res_id, {{0, kInitialData}});
const int64_t initial_body_end = kInitialData.size();
const int64_t initial_size_of_all_entries = GetSizeOfAllEntries();
// Writing a null buffer with truncate=false should be a no-op.
ASSERT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/initial_body_end,
/*offset=*/5, /*buffer=*/nullptr, /*buf_len=*/0,
/*truncate=*/false),
SqlPersistentStore::Error::kOk);
// Verify size and content are unchanged.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->body_end, initial_body_end);
EXPECT_EQ(GetSizeOfAllEntries(), initial_size_of_all_entries);
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/initial_body_end,
initial_body_end, /*sparse_reading=*/false, kInitialData);
CheckBlobData(res_id, {{0, kInitialData}});
VerifyBodyEndAndBytesUsage(kKey, kInitialData.size(),
kKey.string().size() + kInitialData.size());
}
TEST_F(SqlPersistentStoreTest, WriteEntryDataZeroLengthBufferNoTruncate) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
CheckBlobData(res_id, {{0, kInitialData}});
const int64_t initial_body_end = kInitialData.size();
const int64_t initial_size_of_all_entries = GetSizeOfAllEntries();
// Writing a zero-length buffer with truncate=false should be a no-op.
auto zero_buffer = base::MakeRefCounted<net::IOBufferWithSize>(0);
ASSERT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/initial_body_end,
/*offset=*/5, zero_buffer, /*buf_len=*/0,
/*truncate=*/false),
SqlPersistentStore::Error::kOk);
// Verify size and content are unchanged.
auto details = GetResourceEntryDetails(kKey);
ASSERT_TRUE(details.has_value());
EXPECT_EQ(details->body_end, initial_body_end);
EXPECT_EQ(GetSizeOfAllEntries(), initial_size_of_all_entries);
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/initial_body_end,
initial_body_end, /*sparse_reading=*/false, kInitialData);
CheckBlobData(res_id, {{0, kInitialData}});
VerifyBodyEndAndBytesUsage(kKey, kInitialData.size(),
kKey.string().size() + kInitialData.size());
}
TEST_F(SqlPersistentStoreTest, TruncateWithNullBufferExtendingBody) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write some initial data.
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Now, truncate the entry to a larger size using a null buffer.
const int64_t kTruncateOffset = 20;
ASSERT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/kTruncateOffset, /*buffer=*/nullptr,
/*buf_len=*/0, /*truncate=*/true),
SqlPersistentStore::Error::kOk);
// Read back and verify. The new space should be zero-filled.
std::string expected_data = kInitialData;
expected_data.append(kTruncateOffset - kInitialData.size(), '\0');
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/kTruncateOffset,
kTruncateOffset, /*sparse_reading=*/false, expected_data);
// Verify blob data in the database.
CheckBlobData(res_id, {{0, kInitialData}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, kTruncateOffset,
kKey.string().size() + kInitialData.size());
}
TEST_F(SqlPersistentStoreTest, ExtendWithNullBufferNoTruncate) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write some initial data.
const std::string kInitialData = "1234567890";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kInitialData, /*truncate=*/false);
// Now, extend the entry to a larger size using a null buffer without
// truncate.
const int64_t kExtendOffset = 20;
ASSERT_EQ(WriteEntryData(kKey, res_id, /*old_body_end=*/kInitialData.size(),
/*offset=*/kExtendOffset, /*buffer=*/nullptr,
/*buf_len=*/0, /*truncate=*/false),
SqlPersistentStore::Error::kOk);
// Read back and verify. The new space should be zero-filled.
std::string expected_data = kInitialData;
expected_data.append(kExtendOffset - kInitialData.size(), '\0');
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/kExtendOffset,
kExtendOffset, /*sparse_reading=*/false, expected_data);
// Verify blob data in the database.
CheckBlobData(res_id, {{0, kInitialData}});
// Verify size updates.
VerifyBodyEndAndBytesUsage(kKey, kExtendOffset,
kKey.string().size() + kInitialData.size());
}
TEST_F(SqlPersistentStoreTest, WriteEntryDataComplexOverlap) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// 1. Initial write.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
"0123456789", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 10, 10, false, "0123456789");
CheckBlobData(res_id, {{0, "0123456789"}});
VerifyBodyEndAndBytesUsage(kKey, 10, kKey.string().size() + 10);
// 2. Overwrite middle.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/10, /*offset=*/2,
"AAAA", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 10, 10, false, "01AAAA6789");
CheckBlobData(res_id, {{0, "01"}, {2, "AAAA"}, {6, "6789"}});
VerifyBodyEndAndBytesUsage(kKey, 10, kKey.string().size() + 10);
// 3. Overwrite end.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/10, /*offset=*/8,
"BB", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 10, 10, false, "01AAAA67BB");
CheckBlobData(res_id, {{0, "01"}, {2, "AAAA"}, {6, "67"}, {8, "BB"}});
VerifyBodyEndAndBytesUsage(kKey, 10, kKey.string().size() + 10);
// 4. Overwrite beginning.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/10, /*offset=*/0,
"C",
/*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 10, 10, false, "C1AAAA67BB");
CheckBlobData(res_id,
{{0, "C"}, {1, "1"}, {2, "AAAA"}, {6, "67"}, {8, "BB"}});
VerifyBodyEndAndBytesUsage(kKey, 10, kKey.string().size() + 10);
// 5. Overwrite all.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/10, /*offset=*/0,
"DDDDDDDDDD", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 10, 10, false, "DDDDDDDDDD");
CheckBlobData(res_id, {{0, "DDDDDDDDDD"}});
VerifyBodyEndAndBytesUsage(kKey, 10, kKey.string().size() + 10);
// 6. Append.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/10, /*offset=*/10,
"E", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 11, 11, false, "DDDDDDDDDDE");
CheckBlobData(res_id, {{0, "DDDDDDDDDD"}, {10, "E"}});
VerifyBodyEndAndBytesUsage(kKey, 11, kKey.string().size() + 11);
// 7. Sparse write.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/11, /*offset=*/12,
"F", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 13, 13, false,
base::MakeStringViewWithNulChars("DDDDDDDDDDE\0F"));
CheckBlobData(res_id, {{0, "DDDDDDDDDD"}, {10, "E"}, {12, "F"}});
VerifyBodyEndAndBytesUsage(kKey, 13, kKey.string().size() + 12);
// 8. Overwrite with truncate.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/13, /*offset=*/5,
"GG", /*truncate=*/true);
ReadAndVerifyData(kKey, res_id, 0, 7, 7, false, "DDDDDGG");
CheckBlobData(res_id, {{0, "DDDDD"}, {5, "GG"}});
VerifyBodyEndAndBytesUsage(kKey, 7, kKey.string().size() + 7);
// 9. Null buffer truncate.
ASSERT_EQ(
WriteEntryData(kKey, res_id, /*old_body_end=*/7, /*offset=*/5,
/*buffer=*/nullptr, /*buf_len=*/0, /*truncate=*/true),
SqlPersistentStore::Error::kOk);
ReadAndVerifyData(kKey, res_id, 0, 5, 5, false, "DDDDD");
CheckBlobData(res_id, {{0, "DDDDD"}});
VerifyBodyEndAndBytesUsage(kKey, 5, kKey.string().size() + 5);
// 10. Write into a sparse region.
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/5, /*offset=*/10,
"SPARSE", /*truncate=*/false);
ReadAndVerifyData(kKey, res_id, 0, 16, 16, false,
base::MakeStringViewWithNulChars("DDDDD\0\0\0\0\0SPARSE"));
CheckBlobData(res_id, {{0, "DDDDD"}, {10, "SPARSE"}});
VerifyBodyEndAndBytesUsage(kKey, 16, kKey.string().size() + 11);
}
TEST_F(SqlPersistentStoreTest, SparseRead) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData1 = "chunk1";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/0,
kData1, /*truncate=*/false);
const std::string kData2 = "chunk2";
const int64_t offset2 = 10;
const int64_t new_body_end = offset2 + kData2.size();
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/kData1.size(),
/*offset=*/offset2, kData2, /*truncate=*/false);
// Read with zero-filling.
std::string expected_data = "chunk1";
expected_data.append(offset2 - kData1.size(), '\0');
expected_data.append("chunk2");
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/new_body_end,
new_body_end, /*sparse_reading=*/false, expected_data);
// Read with sparse_reading=true.
// A sparse read that encounters a gap should stop at the end of the first
// chunk.
ReadAndVerifyData(kKey, res_id, /*offset=*/0, /*buffer_len=*/new_body_end,
new_body_end, /*sparse_reading=*/true, kData1);
// A sparse read that extends into the gap should still stop at the end of
// the first chunk.
ReadAndVerifyData(kKey, res_id, /*offset=*/0,
/*buffer_len=*/kData1.size() + 1, new_body_end,
/*sparse_reading=*/true, kData1);
// Read from the middle of chunk2.
const int64_t read_offset = offset2 + 2; // Start at 'u' in "chunk2"
const int read_len = 2;
ReadAndVerifyData(kKey, res_id, read_offset, /*buffer_len=*/read_len,
new_body_end,
/*sparse_reading=*/false, "un");
// Read from the middle of chunk2, past the end of the data.
const int long_read_len = 20;
ReadAndVerifyData(kKey, res_id, read_offset, /*buffer_len=*/long_read_len,
new_body_end, /*sparse_reading=*/false, "unk2");
// Verify blob data in the database.
CheckBlobData(res_id, {{0, kData1}, {offset2, kData2}});
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeNoData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
auto result = GetEntryAvailableRange(kKey, res_id, 0, 100);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 0);
EXPECT_EQ(result.available_len, 0);
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeNoOverlap) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData = "some data";
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/0, /*offset=*/100,
kData, /*truncate=*/false);
// Query before the data.
auto result1 = GetEntryAvailableRange(kKey, res_id, 0, 50);
EXPECT_EQ(result1.net_error, net::OK);
EXPECT_EQ(result1.start, 0);
EXPECT_EQ(result1.available_len, 0);
// Query after the data.
auto result2 = GetEntryAvailableRange(kKey, res_id, 200, 50);
EXPECT_EQ(result2.net_error, net::OK);
EXPECT_EQ(result2.start, 200);
EXPECT_EQ(result2.available_len, 0);
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeFullOverlap) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 100, 100, 'a');
auto result = GetEntryAvailableRange(kKey, res_id, 100, 100);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 100);
EXPECT_EQ(result.available_len, 100);
}
// Tests a query range that ends within the existing data.
// Query: [50, 150), Data: [100, 200) -> Overlap: [100, 150)
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeQueryEndsInData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 100, 100, 'a');
auto result = GetEntryAvailableRange(kKey, res_id, 50, 100);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 100);
EXPECT_EQ(result.available_len, 50);
}
// Tests a query range that starts within the existing data.
// Query: [150, 250), Data: [100, 200) -> Overlap: [150, 200)
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeQueryStartsInData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 100, 100, 'a');
auto result = GetEntryAvailableRange(kKey, res_id, 150, 100);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 150);
EXPECT_EQ(result.available_len, 50);
}
// Tests a query range that fully contains the existing data.
// Query: [50, 250), Data: [100, 200) -> Overlap: [100, 200)
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeQueryContainsData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 100, 100, 'a');
auto result = GetEntryAvailableRange(kKey, res_id, 50, 200);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 100);
EXPECT_EQ(result.available_len, 100);
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeContained) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 50, 200, 'a');
auto result = GetEntryAvailableRange(kKey, res_id, 100, 100);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 100);
EXPECT_EQ(result.available_len, 100);
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeContiguousBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 100, 100, 'a');
FillDataInRange(kKey, res_id, /*old_body_end=*/200, 200, 100, 'b');
auto result = GetEntryAvailableRange(kKey, res_id, 100, 200);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 100);
EXPECT_EQ(result.available_len, 200);
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeNonContiguousBlobs) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
FillDataInRange(kKey, res_id, /*old_body_end=*/0, 100, 100, 'a');
FillDataInRange(kKey, res_id, /*old_body_end=*/200, 300, 100, 'b');
auto result = GetEntryAvailableRange(kKey, res_id, 100, 300);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 100);
EXPECT_EQ(result.available_len, 100);
}
TEST_F(SqlPersistentStoreTest, GetEntryAvailableRangeMultipleBlobsStopsAtGap) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// Write three blobs: [100, 200), [200, 300), [400, 500)
FillDataInRange(kKey, res_id, 0, 100, 100, 'a');
FillDataInRange(kKey, res_id, 200, 200, 100, 'a');
FillDataInRange(kKey, res_id, 300, 400, 100, 'a');
// Query for [150, 450). Should return [150, 300), which has length 150.
auto result = GetEntryAvailableRange(kKey, res_id, 150, 300);
EXPECT_EQ(result.net_error, net::OK);
EXPECT_EQ(result.start, 150);
EXPECT_EQ(result.available_len, 150);
}
TEST_F(SqlPersistentStoreTest, OpenNextEntryEmptyCache) {
CreateAndInitStore();
auto result = OpenNextEntry(SqlPersistentStore::EntryIterator());
EXPECT_FALSE(result.has_value());
}
TEST_F(SqlPersistentStoreTest, OpenNextEntrySingleEntry) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto created_res_id = CreateEntryAndGetResId(kKey);
// Open the first (and only) entry.
auto next_result1 = OpenNextEntry(SqlPersistentStore::EntryIterator());
ASSERT_TRUE(next_result1.has_value());
EXPECT_EQ(next_result1->key, kKey);
EXPECT_EQ(next_result1->info.res_id, created_res_id);
EXPECT_TRUE(next_result1->info.opened);
EXPECT_EQ(next_result1->info.body_end, 0);
ASSERT_NE(next_result1->info.head, nullptr);
EXPECT_EQ(next_result1->info.head->size(), 0);
// Try to open again, should be no more entries.
auto next_result2 = OpenNextEntry(next_result1->iterator);
EXPECT_FALSE(next_result2.has_value());
}
TEST_F(SqlPersistentStoreTest, OpenNextEntryMultipleEntries) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
const CacheEntryKey kKey3("key3");
const auto res_id1 = CreateEntryAndGetResId(kKey1);
const auto res_id2 = CreateEntryAndGetResId(kKey2);
const auto res_id3 = CreateEntryAndGetResId(kKey3);
// Entries should be returned in reverse order of creation (descending
// res_id).
auto next_result = OpenNextEntry(SqlPersistentStore::EntryIterator());
ASSERT_TRUE(next_result.has_value());
EXPECT_EQ(next_result->key, kKey3);
EXPECT_EQ(next_result->info.res_id, res_id3);
next_result = OpenNextEntry(next_result->iterator);
ASSERT_TRUE(next_result.has_value());
EXPECT_EQ(next_result->key, kKey2);
EXPECT_EQ(next_result->info.res_id, res_id2);
next_result = OpenNextEntry(next_result->iterator);
ASSERT_TRUE(next_result.has_value());
EXPECT_EQ(next_result->key, kKey1);
EXPECT_EQ(next_result->info.res_id, res_id1);
next_result = OpenNextEntry(next_result->iterator);
EXPECT_FALSE(next_result.has_value());
}
TEST_F(SqlPersistentStoreTest, OpenNextEntrySkipsDoomed) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKeyToDoom("key-to-doom");
const CacheEntryKey kKey3("key3");
ASSERT_TRUE(CreateEntry(kKey1).has_value());
const auto res_id_to_doom = CreateEntryAndGetResId(kKeyToDoom);
ASSERT_TRUE(CreateEntry(kKey3).has_value());
// Doom the middle entry.
ASSERT_EQ(DoomEntry(kKeyToDoom, res_id_to_doom),
SqlPersistentStore::Error::kOk);
// OpenNextEntry should skip the doomed entry.
auto next_result = OpenNextEntry(SqlPersistentStore::EntryIterator());
ASSERT_TRUE(next_result.has_value());
EXPECT_EQ(next_result->key, kKey3); // Should be kKey3
next_result = OpenNextEntry(next_result->iterator);
ASSERT_TRUE(next_result.has_value());
EXPECT_EQ(next_result->key, kKey1); // Should skip kKeyToDoom and get kKey1
next_result = OpenNextEntry(next_result->iterator);
EXPECT_FALSE(next_result.has_value());
}
TEST_F(SqlPersistentStoreTest, InitializeCallbackNotRunOnStoreDestruction) {
CreateStore();
bool callback_run = false;
store_->Initialize(base::BindLambdaForTesting(
[&](SqlPersistentStore::Error result) { callback_run = true; }));
// Destroy the store, which invalidates the WeakPtr.
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, CreateEntryCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
bool callback_run = false;
store_->CreateEntry(
kKey, base::Time::Now(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::EntryInfoOrError) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, OpenEntryCallbackNotRunOnStoreDestruction) {
const CacheEntryKey kKey("my-key");
CreateAndInitStore();
ASSERT_TRUE(CreateEntry(kKey).has_value());
ClearStore();
CreateAndInitStore();
bool callback_run = false;
store_->OpenEntry(kKey,
base::BindLambdaForTesting(
[&](SqlPersistentStore::OptionalEntryInfoOrError) {
callback_run = true;
}));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
OpenOrCreateEntryCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
bool callback_run = false;
store_->OpenOrCreateEntry(
kKey,
base::BindLambdaForTesting(
[&](SqlPersistentStore::EntryInfoOrError) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, DoomEntryCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
bool callback_run = false;
store_->DoomEntry(kKey, res_id,
base::BindLambdaForTesting([&](SqlPersistentStore::Error) {
callback_run = true;
}));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
DeleteDoomedEntryCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
bool callback_run = false;
store_->DeleteDoomedEntry(
kKey, res_id, base::BindLambdaForTesting([&](SqlPersistentStore::Error) {
callback_run = true;
}));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
DeleteLiveEntryCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
ASSERT_TRUE(CreateEntry(kKey).has_value());
bool callback_run = false;
store_->DeleteLiveEntry(
kKey, base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
DeleteAllEntriesCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
bool callback_run = false;
store_->DeleteAllEntries(base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, OpenNextEntryCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
bool callback_run = false;
store_->OpenNextEntry(
SqlPersistentStore::EntryIterator(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::OptionalEntryInfoWithKeyAndIterator) {
callback_run = true;
}));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
DeleteLiveEntriesBetweenCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
bool callback_run = false;
store_->DeleteLiveEntriesBetween(
base::Time(), base::Time::Max(), {},
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
UpdateEntryLastUsedByKeyCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
ASSERT_TRUE(CreateEntry(kKey).has_value());
bool callback_run = false;
store_->UpdateEntryLastUsedByKey(
kKey, base::Time::Now(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
UpdateEntryLastUsedByResIdCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
bool callback_run = false;
store_->UpdateEntryLastUsedByResId(
kKey, res_id, base::Time::Now(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
UpdateEntryHeaderAndLastUsedCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
bool callback_run = false;
auto buffer = base::MakeRefCounted<net::StringIOBuffer>("data");
store_->UpdateEntryHeaderAndLastUsed(
kKey, res_id, base::Time::Now(), /*new_hints=*/std::nullopt, buffer,
buffer->size(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, WriteDataCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
const std::string kData = "hello world";
auto write_buffer = base::MakeRefCounted<net::StringIOBuffer>(kData);
bool callback_run = false;
store_->WriteEntryData(
kKey, res_id, /*old_body_end=*/0, /*offset=*/0, write_buffer,
kData.size(),
/*truncate=*/false,
base::BindLambdaForTesting(
[&](SqlPersistentStore::Error) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, ReadDataCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
auto read_buffer = base::MakeRefCounted<net::IOBufferWithSize>(10);
bool callback_run = false;
store_->ReadEntryData(
kKey, res_id, /*offset=*/0, read_buffer, read_buffer->size(),
/*body_end=*/10, /*sparse_reading=*/false,
base::BindLambdaForTesting(
[&](SqlPersistentStore::IntOrError) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest, CalculateSizeOfEntriesBetween) {
CreateAndInitStore();
// Empty cache.
auto result =
CalculateSizeOfEntriesBetween(base::Time::Min(), base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), 0);
const CacheEntryKey kKey1("key1");
const std::string kData1 = "apple";
const CacheEntryKey kKey2("key2");
const std::string kData2 = "orange";
const CacheEntryKey kKey3("key3");
const std::string kData3 = "pineapple";
const int64_t size1 =
kSqlBackendStaticResourceSize + kKey1.string().size() + kData1.size();
const int64_t size2 =
kSqlBackendStaticResourceSize + kKey2.string().size() + kData2.size();
const int64_t size3 =
kSqlBackendStaticResourceSize + kKey3.string().size() + kData3.size();
// Create entry 1.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time time1 = base::Time::Now();
const auto res_id1 = CreateEntryAndGetResId(kKey1);
WriteDataAndAssertSuccess(kKey1, res_id1, 0, 0, kData1, /*truncate=*/false);
// Create entry 2.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time time2 = base::Time::Now();
const auto res_id2 = CreateEntryAndGetResId(kKey2);
WriteDataAndAssertSuccess(kKey2, res_id2, 0, 0, kData2, /*truncate=*/false);
// Create entry 3.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time time3 = base::Time::Now();
const auto res_id3 = CreateEntryAndGetResId(kKey3);
WriteDataAndAssertSuccess(kKey3, res_id3, 0, 0, kData3, /*truncate=*/false);
// Total size.
EXPECT_EQ(GetSizeOfAllEntries(), size1 + size2 + size3);
// All entries (fast path).
result = CalculateSizeOfEntriesBetween(base::Time::Min(), base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size1 + size2 + size3);
// All entries (regular path).
result = CalculateSizeOfEntriesBetween(base::Time::Min(),
base::Time::Max() - base::Seconds(1));
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size1 + size2 + size3);
// Only entry 2.
result = CalculateSizeOfEntriesBetween(time2, time3);
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size2);
// Entries 1 and 2.
result = CalculateSizeOfEntriesBetween(time1, time3);
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size1 + size2);
// Entries 2 and 3.
result = CalculateSizeOfEntriesBetween(time2, base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size2 + size3);
// No entries.
result = CalculateSizeOfEntriesBetween(time3 + base::Minutes(1),
base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), 0);
}
TEST_F(SqlPersistentStoreTest, CalculateSizeOfEntriesBetweenOverflow) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
const base::Time time1 = base::Time::Now();
task_environment_.AdvanceClock(base::Minutes(1));
ASSERT_TRUE(CreateEntry(kKey1).has_value());
task_environment_.AdvanceClock(base::Minutes(1));
ASSERT_TRUE(CreateEntry(kKey2).has_value());
task_environment_.AdvanceClock(base::Minutes(1));
// Manually set bytes_usage to large values for both entries.
{
auto db_handle = ManuallyOpenDatabase();
sql::Statement update_stmt(db_handle->GetUniqueStatement(
"UPDATE resources SET bytes_usage = ? WHERE cache_key = ?"));
update_stmt.BindInt64(0, std::numeric_limits<int64_t>::max() / 2);
update_stmt.BindString(1, kKey1.string());
ASSERT_TRUE(update_stmt.Run());
update_stmt.Reset(/*clear_bound_vars=*/true);
update_stmt.BindInt64(0, std::numeric_limits<int64_t>::max() / 2 + 100);
update_stmt.BindString(1, kKey2.string());
ASSERT_TRUE(update_stmt.Run());
}
// The sum of bytes_usage for both entries plus the static overhead will
// overflow int64_t. The ClampedNumeric should saturate at max().
auto result = CalculateSizeOfEntriesBetween(time1, base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), std::numeric_limits<int64_t>::max());
}
TEST_F(SqlPersistentStoreTest, CalculateSizeOfEntriesBetweenExcludesDoomed) {
CreateAndInitStore();
const CacheEntryKey kKey1("key1");
const std::string kData1 = "apple";
const CacheEntryKey kKey2("key2");
const std::string kData2 = "orange";
const int64_t size2 =
kSqlBackendStaticResourceSize + kKey2.string().size() + kData2.size();
// Create entry 1.
task_environment_.AdvanceClock(base::Minutes(1));
const base::Time time1 = base::Time::Now();
const auto res_id1 = CreateEntryAndGetResId(kKey1);
WriteDataAndAssertSuccess(kKey1, res_id1, 0, 0, kData1, /*truncate=*/false);
// Create entry 2.
task_environment_.AdvanceClock(base::Minutes(1));
const auto res_id2 = CreateEntryAndGetResId(kKey2);
WriteDataAndAssertSuccess(kKey2, res_id2, 0, 0, kData2, /*truncate=*/false);
// Doom entry 1.
ASSERT_EQ(DoomEntry(kKey1, res_id1), SqlPersistentStore::Error::kOk);
// Calculate size of all entries. Should only include entry 2.
auto result =
CalculateSizeOfEntriesBetween(base::Time::Min(), base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size2);
// Calculate the size of the range, including the doomed entry, but the result
// should not include the doomed entry.
result = CalculateSizeOfEntriesBetween(time1, base::Time::Max());
ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value(), size2);
}
TEST_F(SqlPersistentStoreTest,
GetEntryAvailableRangeCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
bool callback_run = false;
store_->GetEntryAvailableRange(
kKey, res_id, 0, 100, base::BindLambdaForTesting([&](const RangeResult&) {
callback_run = true;
}));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
CalculateSizeOfEntriesBetweenCallbackNotRunOnStoreDestruction) {
CreateAndInitStore();
bool callback_run = false;
store_->CalculateSizeOfEntriesBetween(
base::Time(), base::Time::Max(),
base::BindLambdaForTesting(
[&](SqlPersistentStore::Int64OrError) { callback_run = true; }));
store_.reset();
FlushPendingTask();
EXPECT_FALSE(callback_run);
}
TEST_F(SqlPersistentStoreTest,
ShouldStartEvictionReturnsTrueWhenSizeExceedsHighWatermark) {
// Use a small max_bytes to make it easy to cross the high watermark.
const int64_t kMaxBytes = 10000;
const int64_t kHighWatermark =
kMaxBytes * kSqlBackendEvictionHighWaterMarkPermille / 1000; // 9500
CreateStore(kMaxBytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
// Add entries until the size is just over the high watermark.
int i = 0;
while (GetSizeOfAllEntries() <= kHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
// Before the size exceeds the watermark, ShouldStartEviction should be
// false.
if (GetSizeOfAllEntries() <= kHighWatermark) {
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
}
// The last CreateEntry() pushed the size over the high watermark.
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
TEST_F(SqlPersistentStoreTest, StartEvictionReducesSizeToLowWatermark) {
const int64_t kMaxBytes = 10000;
const int64_t kHighWatermark =
kMaxBytes * kSqlBackendEvictionHighWaterMarkPermille / 1000; // 9500
const int64_t kLowWatermark =
kMaxBytes * kSqlBackendEvictionLowWaterMarkPermille / 1000; // 9000
CreateStore(kMaxBytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// Load the in memory index to make GetIndexStateForHash() work.
EXPECT_TRUE(LoadInMemoryIndex());
// Add entries until size > high watermark.
std::vector<CacheEntryKey> keys;
int i = 0;
while (GetSizeOfAllEntries() <= kHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
keys.push_back(key);
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
task_environment_.AdvanceClock(
base::Seconds(1)); // To distinguish last_used
}
const int64_t size_before_eviction = GetSizeOfAllEntries();
const int32_t count_before_eviction = GetEntryCount();
EXPECT_GT(size_before_eviction, kHighWatermark);
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
// Start eviction.
ASSERT_EQ(StartEviction({}, /*is_idle_time_eviction=*/false),
SqlPersistentStore::Error::kOk);
// After eviction, size should be <= low watermark.
const int64_t size_after_eviction = GetSizeOfAllEntries();
const int32_t count_after_eviction = GetEntryCount();
EXPECT_LE(size_after_eviction, kLowWatermark);
EXPECT_LT(count_after_eviction, count_before_eviction);
// Verify oldest entries are gone.
int evicted_count = count_before_eviction - count_after_eviction;
for (int j = 0; j < evicted_count; ++j) {
EXPECT_EQ(store_->GetIndexStateForHash(keys[j].hash()),
SqlPersistentStore::IndexState::kHashNotFound);
auto result = OpenEntry(keys[j]);
ASSERT_TRUE(result.has_value());
EXPECT_FALSE(result->has_value());
}
// Verify newest entries are still there.
for (size_t j = evicted_count; j < keys.size(); ++j) {
EXPECT_EQ(store_->GetIndexStateForHash(keys[j].hash()),
SqlPersistentStore::IndexState::kHashFound);
auto result = OpenEntry(keys[j]);
ASSERT_TRUE(result.has_value());
EXPECT_TRUE(result->has_value());
}
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
TEST_F(SqlPersistentStoreTest, StartEvictionExcludesGivenKeys) {
const int64_t kMaxBytes = 10000;
const int64_t kHighWatermark =
kMaxBytes * kSqlBackendEvictionHighWaterMarkPermille / 1000; // 9500
const int64_t kLowWatermark =
kMaxBytes * kSqlBackendEvictionLowWaterMarkPermille / 1000; // 9000
CreateStore(kMaxBytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// Add entries until size > high watermark.
std::vector<CacheEntryKey> keys;
std::optional<SqlPersistentStore::ResId> first_res_id;
int i = 0;
while (GetSizeOfAllEntries() <= kHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
keys.push_back(key);
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
if (!first_res_id.has_value()) {
first_res_id = create_result->res_id;
}
task_environment_.AdvanceClock(
base::Seconds(1)); // To distinguish last_used
}
const int64_t size_before_eviction = GetSizeOfAllEntries();
const int32_t count_before_eviction = GetEntryCount();
EXPECT_GT(size_before_eviction, kHighWatermark);
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
// Exclude the oldest entry.
std::vector<SqlPersistentStore::ResIdAndShardId> excluded_list = {
SqlPersistentStore::ResIdAndShardId(
*first_res_id,
store_->GetShardIdForHash(CacheEntryKey("key0").hash()))};
// Start eviction.
ASSERT_EQ(StartEviction(std::move(excluded_list),
/*is_idle_time_eviction=*/false),
SqlPersistentStore::Error::kOk);
// After eviction, size should be <= low watermark.
const int64_t size_after_eviction = GetSizeOfAllEntries();
const int32_t count_after_eviction = GetEntryCount();
EXPECT_LE(size_after_eviction, kLowWatermark);
EXPECT_LT(count_after_eviction, count_before_eviction);
// Verify the excluded entry is still there.
auto result = OpenEntry(keys[0]);
ASSERT_TRUE(result.has_value());
EXPECT_TRUE(result->has_value());
// Verify some other old entries are gone.
// The number of evicted entries will be different now.
int evicted_count = count_before_eviction - count_after_eviction;
// keys[0] was not evicted. So keys[1]...keys[evicted_count] should be
// evicted.
for (int j = 1; j <= evicted_count; ++j) {
result = OpenEntry(keys[j]);
ASSERT_TRUE(result.has_value());
EXPECT_FALSE(result->has_value());
}
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
TEST_F(SqlPersistentStoreTest, ShouldStartEvictionReturnsFalseWhileInProgress) {
const int64_t kMaxBytes = 10000;
const int64_t kHighWatermark =
kMaxBytes * kSqlBackendEvictionHighWaterMarkPermille / 1000; // 9500
CreateStore(kMaxBytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// Add entries until size > high watermark.
int i = 0;
while (GetSizeOfAllEntries() <= kHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
}
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->StartEviction({}, /*is_idle_time_eviction=*/false,
future.GetCallback());
// While eviction is in progress, ShouldStartEviction should return false.
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
// Let eviction finish.
ASSERT_EQ(future.Get(), SqlPersistentStore::Error::kOk);
// After eviction, size is below watermark, so it should still be false.
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
int64_t CheckedGetFileSize(const base::FilePath& file_path) {
return base::GetFileSize(file_path).value();
}
int SqlPersistentStoreTest::GetNumberForWritesRequiredForCheckpoint(
const CacheEntryKey& entry_key,
std::string_view data) {
base::ScopedTempDir temp_dir;
CHECK(temp_dir.CreateUniqueTempDir());
store_ = std::make_unique<SqlPersistentStore>(
temp_dir.GetPath(), kDefaultMaxBytes, net::CacheType::DISK_CACHE,
std::vector<scoped_refptr<base::SequencedTaskRunner>>(
background_task_runners_));
CHECK_EQ(Init(), SqlPersistentStore::Error::kOk);
const base::FilePath db_path =
temp_dir.GetPath().Append(kSqlBackendDatabaseShard0FileName);
const base::FilePath wal_path = sql::Database::WriteAheadLogPath(db_path);
int64_t db_size = CheckedGetFileSize(db_path);
int64_t previous_db_size = db_size;
int64_t wal_size = CheckedGetFileSize(wal_path);
int64_t previous_wal_size = wal_size;
int number_of_writes = 0;
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
while (true) {
WriteDataAndAssertSuccess(entry_key, res_id,
/*old_body_end=*/number_of_writes,
/*offset=*/number_of_writes, data,
/*truncate=*/false);
number_of_writes++;
FlushPendingTask();
db_size = CheckedGetFileSize(db_path);
wal_size = CheckedGetFileSize(wal_path);
if (db_size != previous_db_size) {
// Checkpoint has been executed
EXPECT_GT(db_size, previous_db_size);
break;
}
// Until the checkpoint is executed, the wal size should monotonically
// increase.
EXPECT_GT(wal_size, previous_wal_size);
previous_wal_size = wal_size;
}
store_.reset();
FlushPendingTask();
return number_of_writes;
}
TEST_F(SqlPersistentStoreTest, WalCheckpoint) {
// Set small thresholds to shorten the test execution time.
base::test::ScopedFeatureList feature_list;
feature_list.InitWithFeaturesAndParameters(
{{net::features::kDiskCacheBackendExperiment,
{{net::features::kDiskCacheBackendParam.name, "sql"},
{net::features::kSqlDiskCacheForceCheckpointThreshold.name, "200"},
{net::features::kSqlDiskCacheIdleCheckpointThreshold.name, "100"}}}},
{});
auto test_helper = PerformanceScenarioTestHelper::Create();
// Set the state to idle.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kNoPageLoading);
test_helper->SetInputScenario(ScenarioScope::kGlobal,
InputScenario::kNoInput);
const CacheEntryKey kKey("my-key");
const std::string_view kData = "a";
int idle_checkpoint_write_count = 0;
int non_idle_checkpoint_write_count = 0;
{
base::HistogramTester histogram_tester;
idle_checkpoint_write_count =
GetNumberForWritesRequiredForCheckpoint(kKey, kData);
histogram_tester.ExpectTotalCount(
"Net.SqlDiskCache.Backend.IdleCheckpoint.SuccessTime", 1);
histogram_tester.ExpectTotalCount(
"Net.SqlDiskCache.Backend.IdleCheckpoint.SuccessPages", 1);
}
// Set the state to non-idle.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kVisiblePageLoading);
{
base::HistogramTester histogram_tester;
non_idle_checkpoint_write_count =
GetNumberForWritesRequiredForCheckpoint(kKey, kData);
histogram_tester.ExpectTotalCount(
"Net.SqlDiskCache.Backend.ForceCheckpoint.SuccessTime", 1);
histogram_tester.ExpectTotalCount(
"Net.SqlDiskCache.Backend.ForceCheckpoint.SuccessPages", 1);
}
// The number of writes required for a checkpoint in a non-idle state is
// greater than in an idle state.
EXPECT_GT(non_idle_checkpoint_write_count, idle_checkpoint_write_count);
store_ = std::make_unique<SqlPersistentStore>(
GetTempPath(), kDefaultMaxBytes, net::CacheType::DISK_CACHE,
std::vector<scoped_refptr<base::SequencedTaskRunner>>(
background_task_runners_));
CHECK_EQ(Init(), SqlPersistentStore::Error::kOk);
const base::FilePath db_path = GetDatabaseFilePath();
int64_t previous_db_size = CheckedGetFileSize(db_path);
const auto res_id = CreateEntryAndGetResId(kKey);
// Write one less time than the number of writes required to trigger a
// checkpoint in the idle state.
for (int i = 0; i < idle_checkpoint_write_count - 1; ++i) {
WriteDataAndAssertSuccess(kKey, res_id, /*old_body_end=*/i,
/*offset=*/i, kData,
/*truncate=*/false);
FlushPendingTask();
ASSERT_EQ(CheckedGetFileSize(db_path), previous_db_size);
}
// Calling MaybeRunCheckpoint should not trigger a checkpoint.
MaybeRunCheckpoint(/*expected_result=*/false);
// Even in an idle state, calling MaybeRunCheckpoint should not trigger a
// checkpoint.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kNoPageLoading);
MaybeRunCheckpoint(/*expected_result=*/false);
// Set the state to non-idle.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kVisiblePageLoading);
// Write data again. This exceeds the number of writes required for a
// checkpoint in the idle state.
WriteDataAndAssertSuccess(kKey, res_id,
/*old_body_end=*/idle_checkpoint_write_count - 1,
/*offset=*/idle_checkpoint_write_count - 1, kData,
/*truncate=*/false);
FlushPendingTask();
// Since it's in a non-idle state, a checkpoint is not yet performed.
ASSERT_EQ(CheckedGetFileSize(db_path), previous_db_size);
// Calling MaybeRunCheckpoint should not trigger a checkpoint.
MaybeRunCheckpoint(/*expected_result=*/false);
// After setting the state to idle, calling MaybeRunCheckpoint should
// trigger a checkpoint.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kNoPageLoading);
MaybeRunCheckpoint(/*expected_result=*/true);
}
TEST_F(SqlPersistentStoreTest, IndexState) {
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
CreateStore();
// Before initialization, index is not ready.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kNotReady);
base::test::TestFuture<SqlPersistentStore::Error> future;
store_->Initialize(future.GetCallback());
// During initialization, index is not ready.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kNotReady);
ASSERT_EQ(future.Get(), SqlPersistentStore::Error::kOk);
// Even after the initialization finished, index is not ready.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kNotReady);
// Load the in memory index.
EXPECT_TRUE(LoadInMemoryIndex());
// In memory index load process should not be triggered twice.
EXPECT_FALSE(LoadInMemoryIndex());
// After loading the in memory index, returns kHashNotFound.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// Create an entry.
SqlPersistentStore::EntryInfoOrError result = this->CreateEntry(kKey1);
ASSERT_TRUE(result.has_value());
SqlPersistentStore::ResId res_id1 = result->res_id;
// Now the hash for key1 should be found.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Key2 should still not be found.
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// Create another entry.
result = this->CreateEntry(kKey2);
ASSERT_TRUE(result.has_value());
// Both hashes should be found.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Doom the first entry.
ASSERT_EQ(SqlPersistentStore::Error::kOk, this->DoomEntry(kKey1, res_id1));
// The hash for the doomed entry should be removed from the index.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Delete the second entry.
ASSERT_EQ(SqlPersistentStore::Error::kOk, this->DeleteLiveEntry(kKey2));
// The hash for the deleted entry should be removed.
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// Re-create entry for key1.
result = this->CreateEntry(kKey1);
ASSERT_TRUE(result.has_value());
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Delete all entries.
ASSERT_EQ(SqlPersistentStore::Error::kOk, this->DeleteAllEntries());
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
}
// Test index reloading from a non-empty database.
TEST_F(SqlPersistentStoreTest, IndexReloads) {
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
CreateAndInitStore();
// Load the in memory index.
EXPECT_TRUE(LoadInMemoryIndex());
// Create two entries.
ASSERT_TRUE(this->CreateEntry(kKey1).has_value());
ASSERT_TRUE(this->CreateEntry(kKey2).has_value());
// The hashes should be found.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Close and reopen the store.
ClearStore();
CreateAndInitStore();
// Load the in memory index.
EXPECT_TRUE(LoadInMemoryIndex());
// The index should be re-populated.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(CacheEntryKey("other").hash()),
SqlPersistentStore::IndexState::kHashNotFound);
}
TEST_F(SqlPersistentStoreTest, LoadIndexOnInitFeature) {
base::test::ScopedFeatureList feature_list;
feature_list.InitWithFeaturesAndParameters(
{{net::features::kDiskCacheBackendExperiment,
{{net::features::kDiskCacheBackendParam.name, "sql"},
{net::features::kSqlDiskCacheLoadIndexOnInit.name, "true"}}}},
{});
const CacheEntryKey kKey1("key1");
const CacheEntryKey kKey2("key2");
CreateAndInitStore();
// Create two entries.
ASSERT_TRUE(this->CreateEntry(kKey1).has_value());
ASSERT_TRUE(this->CreateEntry(kKey2).has_value());
// Close and reopen the store.
ClearStore();
CreateStore();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// The index should be loaded on init.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(CacheEntryKey("other").hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// MaybeLoadInMemoryIndex() should do nothing.
EXPECT_FALSE(LoadInMemoryIndex());
}
TEST_F(SqlPersistentStoreTest, IndexLoadNotInitializedFailure) {
CreateStore();
EXPECT_TRUE(LoadInMemoryIndex(SqlPersistentStore::Error::kNotInitialized));
}
TEST_F(SqlPersistentStoreTest, SimulateDbFailureInitializationFailure) {
CreateStore();
store_->SetSimulateDbFailureForTesting(true);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kFailedForTesting);
}
TEST_F(SqlPersistentStoreTest, SimulateDbFailure) {
CreateAndInitStore();
store_->SetSimulateDbFailureForTesting(true);
const CacheEntryKey kKey("my-key");
auto create_result = CreateEntry(kKey);
ASSERT_FALSE(create_result.has_value());
EXPECT_EQ(create_result.error(),
SqlPersistentStore::Error::kFailedForTesting);
auto open_result = OpenEntry(kKey);
ASSERT_FALSE(open_result.has_value());
EXPECT_EQ(open_result.error(), SqlPersistentStore::Error::kFailedForTesting);
auto open_or_create_result = OpenOrCreateEntry(kKey);
ASSERT_FALSE(open_or_create_result.has_value());
EXPECT_EQ(open_or_create_result.error(),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(DoomEntry(kKey, SqlPersistentStore::ResId(1)),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(DeleteDoomedEntry(kKey, SqlPersistentStore::ResId(1)),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(DeleteLiveEntry(kKey),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(DeleteAllEntries(), SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(DeleteLiveEntriesBetween(base::Time::Now(),
base::Time::Now() + base::Seconds(1), {}),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(UpdateEntryLastUsedByKey(kKey, base::Time::Now()),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(UpdateEntryLastUsedByResId(kKey, SqlPersistentStore::ResId(1),
base::Time::Now()),
SqlPersistentStore::Error::kFailedForTesting);
// Prepare new header data.
const std::string kNewHeadData = "new_header_data";
auto buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
EXPECT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, SqlPersistentStore::ResId(1),
base::Time::Now(), buffer, buffer->size()),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(WriteEntryData(kKey, SqlPersistentStore::ResId(1), 0, 0, buffer, 0,
false),
SqlPersistentStore::Error::kFailedForTesting);
auto read_data_result =
ReadEntryData(kKey, SqlPersistentStore::ResId(1), 0, buffer, 0, 0, false);
ASSERT_FALSE(read_data_result.has_value());
EXPECT_EQ(read_data_result.error(),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(GetEntryAvailableRange(kKey, SqlPersistentStore::ResId(1), 0, 100)
.net_error,
net::Error::ERR_FAILED);
EXPECT_EQ(CalculateSizeOfEntriesBetween(base::Time::Now(),
base::Time::Now() + base::Seconds(1))
.error(),
SqlPersistentStore::Error::kFailedForTesting);
EXPECT_EQ(StartEviction({}, /*is_idle_time_eviction=*/false),
SqlPersistentStore::Error::kOk);
EXPECT_FALSE(OpenNextEntry(SqlPersistentStore::EntryIterator()).has_value());
EXPECT_TRUE(LoadInMemoryIndex(SqlPersistentStore::Error::kFailedForTesting));
store_->SetSimulateDbFailureForTesting(false);
create_result = CreateEntry(kKey);
ASSERT_TRUE(create_result.has_value());
open_result = OpenEntry(kKey);
ASSERT_TRUE(open_result.has_value());
ASSERT_TRUE(open_result->has_value());
}
TEST_F(SqlPersistentStoreTest, AfterRazeAndPoisoned) {
CreateAndInitStore();
store_->RazeAndPoisonForTesting();
const CacheEntryKey kKey("my-key");
auto create_result = CreateEntry(kKey);
ASSERT_FALSE(create_result.has_value());
EXPECT_EQ(create_result.error(), SqlPersistentStore::Error::kDatabaseClosed);
auto open_result = OpenEntry(kKey);
ASSERT_FALSE(open_result.has_value());
EXPECT_EQ(open_result.error(), SqlPersistentStore::Error::kDatabaseClosed);
auto open_or_create_result = OpenOrCreateEntry(kKey);
ASSERT_FALSE(open_or_create_result.has_value());
EXPECT_EQ(open_or_create_result.error(),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(DoomEntry(kKey, SqlPersistentStore::ResId(1)),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(DeleteDoomedEntry(kKey, SqlPersistentStore::ResId(1)),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(DeleteLiveEntry(kKey), SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(DeleteAllEntries(), SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(DeleteLiveEntriesBetween(base::Time::Now(),
base::Time::Now() + base::Seconds(1), {}),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(UpdateEntryLastUsedByKey(kKey, base::Time::Now()),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(UpdateEntryLastUsedByResId(kKey, SqlPersistentStore::ResId(1),
base::Time::Now()),
SqlPersistentStore::Error::kDatabaseClosed);
// Prepare new header data.
const std::string kNewHeadData = "new_header_data";
auto buffer = base::MakeRefCounted<net::StringIOBuffer>(kNewHeadData);
EXPECT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, SqlPersistentStore::ResId(1),
base::Time::Now(), buffer, buffer->size()),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(WriteEntryData(kKey, SqlPersistentStore::ResId(1), 0, 0, buffer, 0,
false),
SqlPersistentStore::Error::kDatabaseClosed);
auto read_data_result =
ReadEntryData(kKey, SqlPersistentStore::ResId(1), 0, buffer, 0, 0, false);
ASSERT_FALSE(read_data_result.has_value());
EXPECT_EQ(read_data_result.error(),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_EQ(GetEntryAvailableRange(kKey, SqlPersistentStore::ResId(1), 0, 100)
.net_error,
net::Error::ERR_FAILED);
EXPECT_EQ(CalculateSizeOfEntriesBetween(base::Time::Now(),
base::Time::Now() + base::Seconds(1))
.error(),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_FALSE(OpenNextEntry(SqlPersistentStore::EntryIterator()).has_value());
EXPECT_EQ(StartEviction({}, /*is_idle_time_eviction=*/false),
SqlPersistentStore::Error::kOk);
EXPECT_TRUE(LoadInMemoryIndex(SqlPersistentStore::Error::kDatabaseClosed));
}
TEST_F(SqlPersistentStoreTest,
ShouldStartEvictionReturnsFalseAfterRazeAndPoisoned) {
// Use a small max_bytes to make it easy to cross the high watermark.
const int64_t kMaxBytes = 10000;
CreateStore(kMaxBytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
// Add entries until the size is just over the high watermark.
int i = 0;
while (store_->GetEvictionUrgency() !=
SqlPersistentStore::EvictionUrgency::kNeeded) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
}
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
store_->RazeAndPoisonForTesting();
EXPECT_EQ(CreateEntry(CacheEntryKey("test")).error(),
SqlPersistentStore::Error::kDatabaseClosed);
EXPECT_NE(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
TEST_F(SqlPersistentStoreTest, GetEvictionUrgency) {
const int64_t kMaxBytes = 10000;
const int64_t kHighWatermark =
kMaxBytes * kSqlBackendEvictionHighWaterMarkPermille / 1000; // 9500
const int64_t kIdleTimeHighWatermark =
kMaxBytes * kSqlBackendIdleTimeEvictionHighWaterMarkPermille /
1000; // 9250
CreateStore(kMaxBytes);
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNotNeeded);
// Add entries until the size is just over the idle time high watermark.
int i = 0;
while (GetSizeOfAllEntries() <= kIdleTimeHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
}
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kIdleTime);
// Add more entries until the size is just over the high watermark.
while (GetSizeOfAllEntries() <= kHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
}
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kNeeded);
}
TEST_F(SqlPersistentStoreTest, IdleTimeEviction) {
const int64_t kMaxBytes = 10000;
const int64_t kIdleTimeHighWatermark =
kMaxBytes * kSqlBackendIdleTimeEvictionHighWaterMarkPermille /
1000; // 9250
CreateStore(kMaxBytes);
store_->EnableStrictCorruptionCheckForTesting();
ASSERT_EQ(Init(), SqlPersistentStore::Error::kOk);
// Add entries to trigger idle time eviction.
int i = 0;
while (GetSizeOfAllEntries() <= kIdleTimeHighWatermark) {
const CacheEntryKey key(base::StringPrintf("key%d", i++));
auto create_result = CreateEntry(key);
ASSERT_TRUE(create_result.has_value());
}
EXPECT_EQ(store_->GetEvictionUrgency(),
SqlPersistentStore::EvictionUrgency::kIdleTime);
auto test_helper = PerformanceScenarioTestHelper::Create();
// Set the state to non-idle.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kVisiblePageLoading);
test_helper->SetInputScenario(ScenarioScope::kGlobal,
InputScenario::kNoInput);
// Idle time eviction should be aborted
ASSERT_EQ(StartEviction({}, /*is_idle_time_eviction=*/true),
SqlPersistentStore::Error::kAbortedDueToBrowserActivity);
// Set the state to idle.
test_helper->SetLoadingScenario(ScenarioScope::kGlobal,
LoadingScenario::kNoPageLoading);
test_helper->SetInputScenario(ScenarioScope::kGlobal,
InputScenario::kNoInput);
// Start idle time eviction.
ASSERT_EQ(StartEviction({}, /*is_idle_time_eviction=*/true),
SqlPersistentStore::Error::kOk);
// Eviction should have run and reduced the size.
const int64_t kLowWatermark =
kMaxBytes * kSqlBackendEvictionLowWaterMarkPermille / 1000; // 9000
EXPECT_LE(GetSizeOfAllEntries(), kLowWatermark);
}
TEST_F(SqlPersistentStoreTest, DoomEntryWhileIndexLoading) {
CreateAndInitStore();
const CacheEntryKey kKey1("my-key1");
const CacheEntryKey kKey2("my-key2");
const CacheEntryKey kKey3("my-key3");
// 1. Create three entries.
SqlPersistentStore::ResId res_id1 = CreateEntryAndGetResId(kKey1);
SqlPersistentStore::ResId res_id2 = CreateEntryAndGetResId(kKey2);
SqlPersistentStore::ResId res_id3 = CreateEntryAndGetResId(kKey3);
// 2. Ensure index is not loaded.
ASSERT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kNotReady);
ASSERT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kNotReady);
ASSERT_EQ(store_->GetIndexStateForHash(kKey3.hash()),
SqlPersistentStore::IndexState::kNotReady);
// 3. Start loading the index.
base::test::TestFuture<SqlPersistentStore::Error> load_index_future;
ASSERT_TRUE(store_->MaybeLoadInMemoryIndex(load_index_future.GetCallback()));
// 4. Doom two entries while index loading is in flight.
base::test::TestFuture<SqlPersistentStore::Error> doom_future1;
store_->DoomEntry(kKey1, res_id1, doom_future1.GetCallback());
base::test::TestFuture<SqlPersistentStore::Error> doom_future3;
store_->DoomEntry(kKey3, res_id3, doom_future3.GetCallback());
// 5. Wait for index loading to complete.
EXPECT_EQ(load_index_future.Get(), SqlPersistentStore::Error::kOk);
// 6. The index is now loaded. The doomed entries should not be in the index
// because they were added to `pending_doomed_res_ids_` and removed after
// the index was loaded.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey3.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// 7. Wait for the doom operations to complete.
EXPECT_EQ(doom_future1.Get(), SqlPersistentStore::Error::kOk);
EXPECT_EQ(doom_future3.Get(), SqlPersistentStore::Error::kOk);
// 8. The index state should remain the same.
EXPECT_EQ(store_->GetIndexStateForHash(kKey1.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey2.hash()),
SqlPersistentStore::IndexState::kHashFound);
EXPECT_EQ(store_->GetIndexStateForHash(kKey3.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// 9. Verify that the doomed entries are gone and the other entry is still
// accessible.
auto open_result1 = OpenEntry(kKey1);
ASSERT_TRUE(open_result1.has_value());
EXPECT_FALSE(open_result1->has_value());
auto open_result2 = OpenEntry(kKey2);
ASSERT_TRUE(open_result2.has_value());
ASSERT_TRUE(open_result2->has_value());
EXPECT_EQ((*open_result2)->res_id, res_id2);
auto open_result3 = OpenEntry(kKey3);
ASSERT_TRUE(open_result3.has_value());
EXPECT_FALSE(open_result3->has_value());
}
TEST_F(SqlPersistentStoreTest, DoomEntryRecoversIndexOnDbFailure) {
CreateAndInitStore();
// Load the in-memory index, which is necessary for the index recovery
// mechanism.
ASSERT_TRUE(LoadInMemoryIndex());
const CacheEntryKey kKey("my-key");
const auto res_id = CreateEntryAndGetResId(kKey);
// The entry should be in the index.
EXPECT_EQ(store_->GetIndexStateForHash(kKey.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Simulate a database failure.
store_->SetSimulateDbFailureForTesting(true);
// Try to doom the entry. The database operation will fail.
ASSERT_EQ(DoomEntry(kKey, res_id),
SqlPersistentStore::Error::kFailedForTesting);
// Because the DB operation failed, the entry should have been re-added to
// the in-memory index.
EXPECT_EQ(store_->GetIndexStateForHash(kKey.hash()),
SqlPersistentStore::IndexState::kHashFound);
// Disable the failure simulation.
store_->SetSimulateDbFailureForTesting(false);
// The entry should still be openable.
auto open_result = OpenEntry(kKey);
ASSERT_TRUE(open_result.has_value());
ASSERT_TRUE(open_result->has_value());
EXPECT_EQ(open_result.value()->res_id, res_id);
// Doom the entry again. This time it should succeed.
ASSERT_EQ(DoomEntry(kKey, res_id), SqlPersistentStore::Error::kOk);
// The entry should now be gone from the index.
EXPECT_EQ(store_->GetIndexStateForHash(kKey.hash()),
SqlPersistentStore::IndexState::kHashNotFound);
// The entry should not be openable.
open_result = OpenEntry(kKey);
ASSERT_TRUE(open_result.has_value());
EXPECT_FALSE(open_result->has_value());
}
TEST_F(SqlPersistentStoreTest, SetAndGetEntryInMemoryData) {
CreateAndInitStore();
const CacheEntryKey kKey("my-key");
// 1. Create a new entry.
auto res_id = CreateEntryAndGetResId(kKey);
// 2. Load the index.
EXPECT_TRUE(LoadInMemoryIndex());
// 3. Set in-memory data hints.
const uint8_t hints_value = 42;
store_->SetInMemoryEntryDataHints(kKey.hash(), res_id,
MemoryEntryDataHints(hints_value));
// 4. Get the hints and verify.
auto hints = store_->GetInMemoryEntryDataHints(kKey.hash());
ASSERT_TRUE(hints.has_value());
EXPECT_EQ(hints->value(), hints_value);
// 5. Persist the hints to the database.
auto buffer = base::MakeRefCounted<net::StringIOBuffer>("");
ASSERT_EQ(
UpdateEntryHeaderAndLastUsed(kKey, res_id, base::Time::Now(), buffer, 0,
MemoryEntryDataHints(hints_value)),
SqlPersistentStore::Error::kOk);
// Verify hints are in the database.
auto db_hints = GetResourceHints(kKey);
ASSERT_TRUE(db_hints.has_value());
EXPECT_EQ(*db_hints, hints_value);
// 6. Close and re-open the store.
ClearStore();
CreateAndInitStore();
EXPECT_TRUE(LoadInMemoryIndex());
// 7. Get the hints again and verify they were loaded from the DB.
auto reloaded_hints = store_->GetInMemoryEntryDataHints(kKey.hash());
ASSERT_TRUE(reloaded_hints.has_value());
EXPECT_EQ(reloaded_hints->value(), hints_value);
}
} // namespace disk_cache
|