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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/core/fetch/fetch_manager.h"
#include <inttypes.h>
#include <stdint.h>
#include <algorithm>
#include <optional>
#include <string_view>
#include <utility>
#include "base/check.h"
#include "base/feature_list.h"
#include "base/metrics/histogram_functions.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/strcat.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "base/unguessable_token.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/cpp/features.h"
#include "services/network/public/cpp/header_util.h"
#include "services/network/public/cpp/is_potentially_trustworthy.h"
#include "services/network/public/cpp/request_mode.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/mojom/fetch_api.mojom-blink.h"
#include "services/network/public/mojom/trust_tokens.mojom-blink.h"
#include "services/network/public/mojom/url_loader_factory.mojom-blink.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/scheme_registry.h"
#include "third_party/blink/public/mojom/fetch/fetch_api_request.mojom-blink.h"
#include "third_party/blink/public/mojom/loader/code_cache.mojom-blink.h"
#include "third_party/blink/public/mojom/loader/fetch_later.mojom-blink.h"
#include "third_party/blink/public/platform/browser_interface_broker_proxy.h"
#include "third_party/blink/public/platform/task_type.h"
#include "third_party/blink/public/platform/web_url_request.h"
#include "third_party/blink/public/platform/web_url_request_util.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_response_init.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_throw_dom_exception.h"
#include "third_party/blink/renderer/core/dom/abort_signal.h"
#include "third_party/blink/renderer/core/dom/document.h"
#include "third_party/blink/renderer/core/dom/dom_exception.h"
#include "third_party/blink/renderer/core/dom/quota_exceeded_error.h"
#include "third_party/blink/renderer/core/execution_context/execution_context.h"
#include "third_party/blink/renderer/core/fetch/body.h"
#include "third_party/blink/renderer/core/fetch/body_stream_buffer.h"
#include "third_party/blink/renderer/core/fetch/fetch_later_result.h"
#include "third_party/blink/renderer/core/fetch/fetch_later_util.h"
#include "third_party/blink/renderer/core/fetch/fetch_request_data.h"
#include "third_party/blink/renderer/core/fetch/form_data_bytes_consumer.h"
#include "third_party/blink/renderer/core/fetch/place_holder_bytes_consumer.h"
#include "third_party/blink/renderer/core/fetch/response.h"
#include "third_party/blink/renderer/core/fetch/trust_token_to_mojom.h"
#include "third_party/blink/renderer/core/fileapi/blob.h"
#include "third_party/blink/renderer/core/frame/csp/content_security_policy.h"
#include "third_party/blink/renderer/core/frame/frame.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/frame/local_frame_client.h"
#include "third_party/blink/renderer/core/inspector/console_message.h"
#include "third_party/blink/renderer/core/inspector/identifiers_factory.h"
#include "third_party/blink/renderer/core/inspector/inspector_audits_issue.h"
#include "third_party/blink/renderer/core/loader/threadable_loader.h"
#include "third_party/blink/renderer/core/loader/threadable_loader_client.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/core/probe/core_probes.h"
#include "third_party/blink/renderer/core/typed_arrays/dom_array_buffer.h"
#include "third_party/blink/renderer/core/workers/shared_worker_global_scope.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/bindings/script_forbidden_scope.h"
#include "third_party/blink/renderer/platform/bindings/script_state.h"
#include "third_party/blink/renderer/platform/bindings/thread_debugger.h"
#include "third_party/blink/renderer/platform/bindings/v8_throw_exception.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/persistent.h"
#include "third_party/blink/renderer/platform/instrumentation/use_counter.h"
#include "third_party/blink/renderer/platform/loader/cors/cors.h"
#include "third_party/blink/renderer/platform/loader/cors/cors_error_string.h"
#include "third_party/blink/renderer/platform/loader/fetch/buffering_bytes_consumer.h"
#include "third_party/blink/renderer/platform/loader/fetch/bytes_consumer.h"
#include "third_party/blink/renderer/platform/loader/fetch/cached_metadata.h"
#include "third_party/blink/renderer/platform/loader/fetch/fetch_initiator_type_names.h"
#include "third_party/blink/renderer/platform/loader/fetch/fetch_parameters.h"
#include "third_party/blink/renderer/platform/loader/fetch/fetch_utils.h"
#include "third_party/blink/renderer/platform/loader/fetch/memory_cache.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_error.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_fetcher.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_fetcher_properties.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_loader_options.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_request.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_request_utils.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_response.h"
#include "third_party/blink/renderer/platform/loader/fetch/script_cached_metadata_handler.h"
#include "third_party/blink/renderer/platform/loader/fetch/unique_identifier.h"
#include "third_party/blink/renderer/platform/loader/fetch/url_loader/request_conversion.h"
#include "third_party/blink/renderer/platform/loader/integrity_report.h"
#include "third_party/blink/renderer/platform/loader/subresource_integrity.h"
#include "third_party/blink/renderer/platform/loader/unencoded_digest.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_associated_remote.h"
#include "third_party/blink/renderer/platform/network/http_names.h"
#include "third_party/blink/renderer/platform/network/network_utils.h"
#include "third_party/blink/renderer/platform/runtime_enabled_features.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/weborigin/scheme_registry.h"
#include "third_party/blink/renderer/platform/weborigin/security_origin.h"
#include "third_party/blink/renderer/platform/weborigin/security_policy.h"
#include "third_party/blink/renderer/platform/wtf/functional.h"
#include "third_party/blink/renderer/platform/wtf/hash_set.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"
#include "v8/include/v8.h"
using network::mojom::CredentialsMode;
using network::mojom::FetchResponseType;
using network::mojom::RedirectMode;
using network::mojom::RequestMode;
namespace blink {
namespace {
constexpr TextResourceDecoderOptions::ContentType kFetchLaterContentType =
TextResourceDecoderOptions::kPlainTextContent;
constexpr net::NetworkTrafficAnnotationTag kFetchLaterTrafficAnnotationTag =
net::DefineNetworkTrafficAnnotation("blink_fetch_later_manager",
R"(
semantics {
sender: "Blink Fetch Later Manager"
description:
"This request is a website-initiated FetchLater request."
trigger:
"On document unloaded or after developer specified timeout has passed."
data: "Anything the initiator wants to send."
user_data {
type: ARBITRARY_DATA
}
destination: OTHER
internal {
contacts {
email: "pending-beacon-experiment@chromium.org"
}
}
last_reviewed: "2023-10-25"
}
policy {
cookies_allowed: YES
cookies_store: "user"
setting: "These requests cannot be fully disabled in settings. "
"Only for the requests intended to send after document in BFCache, "
"they can be disabled via the `Background Sync` section under the "
"`Privacy and security` tab in settings. "
"This feature is not yet enabled."
policy_exception_justification: "The policy for Background sync is not "
"yet implemented."
})");
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// Must remain in sync with FetchLaterRendererMetricType in
// tools/metrics/histograms/enums.xml.
enum class FetchLaterRendererMetricType {
kAbortedByUser = 0,
kContextDestroyed = 1,
kActivatedByTimeout = 2,
kActivatedOnEnteredBackForwardCache = 3,
kMaxValue = kActivatedOnEnteredBackForwardCache,
};
void LogFetchLaterMetric(const FetchLaterRendererMetricType& type) {
base::UmaHistogramEnumeration("FetchLater.Renderer.Metrics", type);
}
// Tells whether the FetchLater request should use BackgroundSync permission to
// decide whether it should send out deferred requests on entering
// BackForwardCache.
bool IsFetchLaterUseBackgroundSyncPermissionEnabled() {
return base::GetFieldTrialParamByFeatureAsBool(
features::kFetchLaterAPI, "use_background_sync_permission", true);
}
// Allows manually overriding the "send-on-enter-bfcache" behavior without
// considering BackgroundSync permission.
// Defaults to true to flush on entering BackForwardCache.
// See also
// https://github.com/WICG/pending-beacon/issues/30#issuecomment-1333869614
bool IsFetchLaterSendOnEnterBackForwardCacheEnabled() {
return base::GetFieldTrialParamByFeatureAsBool(features::kFetchLaterAPI,
"send_on_enter_bfcache", true);
}
bool HasNonEmptyLocationHeader(const FetchHeaderList* headers) {
String value;
if (!headers->Get(http_names::kLocation, value))
return false;
return !value.empty();
}
const char* SerializeTrustTokenOperationType(
network::mojom::TrustTokenOperationType operation_type) {
switch (operation_type) {
case network::mojom::blink::TrustTokenOperationType::kIssuance:
return "Issuance";
case network::mojom::blink::TrustTokenOperationType::kRedemption:
return "Redemption";
case network::mojom::blink::TrustTokenOperationType::kSigning:
return "Signing";
}
}
// Logs a net error describing why a fetch with Trust Tokens parameters
// failed. This is a temporary measure for debugging a surprisingly high
// incidence of "TypeError: Failed to fetch" when executing Trust Tokens
// issuance operations (crbug.com/1128174).
void HistogramNetErrorForTrustTokensOperation(
network::mojom::blink::TrustTokenOperationType operation_type,
int net_error) {
base::UmaHistogramSparse(
base::StrCat({"Net.TrustTokens.NetErrorForFetchFailure", ".",
SerializeTrustTokenOperationType(operation_type)}),
net_error);
}
class FetchManagerResourceRequestContext final : public ResourceRequestContext {
STACK_ALLOCATED();
public:
~FetchManagerResourceRequestContext() override = default;
// Computes the ResourceLoadPriority. This is called if the priority was not
// set.
ResourceLoadPriority ComputeLoadPriority(
const FetchParameters& params) override {
return ComputeFetchLaterLoadPriority(params);
}
void RecordTrace() override {}
};
// Stores a resolver for Response objects, and a TypeError exception to reject
// them with. The default exception is created at construction time so it has an
// appropriate JavaScript stack.
class ResponseResolver final : public GarbageCollected<ResponseResolver> {
public:
// ResponseResolver uses the ScriptState held by the ScriptPromiseResolver.
explicit ResponseResolver(ScriptPromiseResolver<Response>*);
ResponseResolver(const ResponseResolver&) = delete;
ResponseResolver& operator=(const ResponseResolver&) = delete;
// Exposed the ExecutionContext from the resolver for use by
// FetchManager::Loader.
ExecutionContext* GetExecutionContext() {
return resolver_->GetExecutionContext();
}
// The caller should clear references to this object after calling one of the
// resolve or reject methods, but just to ensure there are no mistakes this
// object clears its internal references after resolving or rejecting.
// Resolves the promise with the specified response.
void Resolve(Response* response);
// Rejects the promise with the supplied object.
void Reject(v8::Local<v8::Value> error);
void Reject(DOMException*);
// Rejects the promise with the TypeError exception created at construction
// time. Also optionally passes `devtools_request_id`, `issue_id`, and
// `issue_summary` to DevTools if they are set; this happens via a side
// channel that is inaccessible to the page (so additional information
// stored in the `issue_summary` about for example CORS policy violations
// is not leaked to the page).
void RejectBecauseFailed(std::optional<String> devtools_request_id,
std::optional<base::UnguessableToken> issue_id,
std::optional<String> issue_summary);
void Trace(Visitor* visitor) const {
visitor->Trace(resolver_);
visitor->Trace(exception_);
}
private:
// Clear all members.
void Clear();
Member<ScriptPromiseResolver<Response>> resolver_;
TraceWrapperV8Reference<v8::Value> exception_;
};
ResponseResolver::ResponseResolver(ScriptPromiseResolver<Response>* resolver)
: resolver_(resolver) {
auto* script_state = resolver_->GetScriptState();
v8::Isolate* isolate = script_state->GetIsolate();
// Only use a handle scope as we should be in the right context already.
v8::HandleScope scope(isolate);
// Create the exception at this point so we get the stack-trace that
// belongs to the fetch() call.
v8::Local<v8::Value> exception =
V8ThrowException::CreateTypeError(isolate, "Failed to fetch");
exception_.Reset(isolate, exception);
}
void ResponseResolver::Resolve(Response* response) {
CHECK(resolver_);
resolver_->Resolve(response);
Clear();
}
void ResponseResolver::Reject(v8::Local<v8::Value> error) {
CHECK(resolver_);
resolver_->Reject(error);
Clear();
}
void ResponseResolver::Reject(DOMException* dom_exception) {
CHECK(resolver_);
resolver_->Reject(dom_exception);
Clear();
}
void ResponseResolver::RejectBecauseFailed(
std::optional<String> devtools_request_id,
std::optional<base::UnguessableToken> issue_id,
std::optional<String> issue_summary) {
CHECK(resolver_);
auto* script_state = resolver_->GetScriptState();
auto* isolate = script_state->GetIsolate();
auto context = script_state->GetContext();
v8::Local<v8::Value> value = exception_.Get(isolate);
exception_.Reset();
if (devtools_request_id || issue_id || issue_summary) {
ThreadDebugger* debugger = ThreadDebugger::From(isolate);
auto* inspector = debugger->GetV8Inspector();
if (devtools_request_id) {
inspector->associateExceptionData(
context, value, V8AtomicString(isolate, "requestId"),
V8String(isolate, *devtools_request_id));
}
if (issue_id) {
inspector->associateExceptionData(
context, value, V8AtomicString(isolate, "issueId"),
V8String(isolate, IdentifiersFactory::IdFromToken(*issue_id)));
}
if (issue_summary) {
inspector->associateExceptionData(context, value,
V8AtomicString(isolate, "issueSummary"),
V8String(isolate, *issue_summary));
}
}
resolver_->Reject(value);
Clear();
}
void ResponseResolver::Clear() {
resolver_.Clear();
exception_.Clear();
}
} // namespace
// FetchLoaderBase provides common logic to prepare a blink::ResourceRequest
// from a FetchRequestData.
class FetchLoaderBase : public GarbageCollectedMixin {
public:
explicit FetchLoaderBase(ExecutionContext* ec,
FetchRequestData* data,
ScriptState* script_state,
AbortSignal* signal)
: execution_context_(ec),
fetch_request_data_(data),
script_state_(script_state),
world_(std::move(&script_state->World())),
signal_(signal),
abort_handle_(signal->AddAlgorithm(
WTF::BindOnce(&FetchLoaderBase::Abort, WrapWeakPersistent(this)))) {
CHECK(world_);
}
// Starts to perform the "Fetching" algorithm.
// https://fetch.spec.whatwg.org/#fetching
// Note that the actual loading is delegated to subclass via `CreateLoader()`,
// which may or may not start loading immediately.
void Start(ExceptionState&);
// Disposes this loader.
// The owner of this loader uses this method to notify disposing of this
// loader after removing from its container.
// Depending on how subclass is implemented, this method may be called
// multiple times before this instance is gone.
virtual void Dispose() = 0;
void Trace(Visitor* visitor) const override {
visitor->Trace(execution_context_);
visitor->Trace(fetch_request_data_);
visitor->Trace(script_state_);
visitor->Trace(signal_);
visitor->Trace(abort_handle_);
visitor->Trace(world_);
}
protected:
virtual bool IsDeferred() const = 0;
virtual void Abort() = 0;
virtual void CreateLoader(
ResourceRequest request,
const ResourceLoaderOptions& resource_loader_options) = 0;
virtual void Failed(
const String& message,
DOMException* dom_exception,
std::optional<String> devtools_request_id = std::nullopt,
std::optional<base::UnguessableToken> issue_id = std::nullopt,
std::optional<String> issue_summary = std::nullopt) = 0;
void PerformSchemeFetch(ExceptionState&);
void PerformNetworkError(
const String& issue_summary,
std::optional<base::UnguessableToken> issue_id = std::nullopt);
void FileIssueAndPerformNetworkError(RendererCorsIssueCode);
void PerformHTTPFetch(ExceptionState&);
void PerformDataFetch();
bool AddConsoleMessage(const String& message,
std::optional<base::UnguessableToken> issue_id);
ExecutionContext* GetExecutionContext() { return execution_context_.Get(); }
void SetExecutionContext(ExecutionContext* ec) { execution_context_ = ec; }
FetchRequestData* GetFetchRequestData() const {
return fetch_request_data_.Get();
}
ScriptState* GetScriptState() { return script_state_.Get(); }
const DOMWrapperWorld* World() { return world_; }
AbortSignal* Signal() { return signal_.Get(); }
private:
Member<ExecutionContext> execution_context_;
Member<FetchRequestData> fetch_request_data_;
Member<ScriptState> script_state_;
Member<const DOMWrapperWorld> world_;
Member<AbortSignal> signal_;
Member<AbortSignal::AlgorithmHandle> abort_handle_;
};
class FetchManager::Loader final
: public GarbageCollected<FetchManager::Loader>,
public FetchLoaderBase,
public ThreadableLoaderClient {
public:
Loader(ExecutionContext*,
FetchManager*,
ScriptPromiseResolver<Response>*,
FetchRequestData*,
ScriptState*,
AbortSignal*);
~Loader() override;
void Trace(Visitor*) const override;
void Dispose() override;
void LogIfKeepalive(std::string_view request_state) const;
// ThreadableLoaderClient implementation.
bool WillFollowRedirect(uint64_t,
const KURL&,
const ResourceResponse&) override;
void DidReceiveResponse(uint64_t, const ResourceResponse&) override;
void DidReceiveCachedMetadata(mojo_base::BigBuffer) override;
void DidStartLoadingResponseBody(BytesConsumer&) override;
void DidFinishLoading(uint64_t) override;
void DidFail(uint64_t, const ResourceError&) override;
void DidFailRedirectCheck(uint64_t) override;
class IntegrityVerifier final : public GarbageCollected<IntegrityVerifier>,
public BytesConsumer::Client {
public:
IntegrityVerifier(BytesConsumer* body,
PlaceHolderBytesConsumer* updater,
Response* response,
FetchManager::Loader* loader,
String integrity_metadata,
std::optional<UnencodedDigest> unencoded_digest,
const KURL& url)
: body_(body),
updater_(updater),
response_(response),
loader_(loader),
integrity_metadata_(integrity_metadata),
unencoded_digest_(unencoded_digest),
url_(url) {
// We need to have some kind of integrity metadata to check: either SRI
// metadata, or an `Unencoded-Digest` header.
DCHECK(!integrity_metadata.empty() ||
(unencoded_digest.has_value() &&
RuntimeEnabledFeatures::UnencodedDigestEnabled(
loader_->GetExecutionContext())));
body_->SetClient(this);
OnStateChange();
}
void Cancel() { body_->Cancel(); }
void OnStateChange() override {
using Result = BytesConsumer::Result;
DCHECK(loader_);
DCHECK(response_);
Result result = Result::kOk;
while (result == Result::kOk) {
base::span<const char> buffer;
result = body_->BeginRead(buffer);
if (result == Result::kOk) {
buffer_.Append(buffer);
result = body_->EndRead(buffer.size());
}
if (result == Result::kShouldWait)
return;
}
String error_message;
finished_ = true;
if (result == Result::kDone) {
bool integrity_failed = false;
if (unencoded_digest_.has_value() &&
!unencoded_digest_->DoesMatch(&buffer_)) {
integrity_failed = true;
error_message =
"The resource's `unencoded-digest` header asserted "
"a digest which does not match the resource's body.";
}
if (!integrity_failed && !integrity_metadata_.empty()) {
IntegrityReport integrity_report;
IntegrityMetadataSet metadata_set;
SubresourceIntegrity::ParseIntegrityAttribute(
integrity_metadata_, metadata_set, loader_->GetExecutionContext(),
&integrity_report);
const FetchResponseData* data = response_->GetResponse();
String raw_headers = data->InternalHeaderList()->GetAsRawString(
data->Status(), data->StatusMessage());
FetchResponseType type =
!updater_ ? FetchResponseType::kError : data->GetType();
integrity_failed = !SubresourceIntegrity::CheckSubresourceIntegrity(
metadata_set, &buffer_, url_, type, raw_headers,
loader_->GetExecutionContext(), integrity_report);
integrity_report.SendReports(loader_->GetExecutionContext());
error_message = "SRI's integrity checks failed.";
}
if (!integrity_failed) {
updater_->Update(
MakeGarbageCollected<FormDataBytesConsumer>(std::move(buffer_)));
loader_->response_resolver_->Resolve(response_);
loader_->response_resolver_.Clear();
return;
}
}
if (updater_) {
updater_->Update(
BytesConsumer::CreateErrored(BytesConsumer::Error(error_message)));
}
loader_->PerformNetworkError(error_message);
}
String DebugName() const override { return "IntegrityVerifier"; }
bool IsFinished() const { return finished_; }
void Trace(Visitor* visitor) const override {
visitor->Trace(body_);
visitor->Trace(updater_);
visitor->Trace(response_);
visitor->Trace(loader_);
}
private:
Member<BytesConsumer> body_;
Member<PlaceHolderBytesConsumer> updater_;
Member<Response> response_;
Member<FetchManager::Loader> loader_;
String integrity_metadata_;
std::optional<UnencodedDigest> unencoded_digest_;
KURL url_;
SegmentedBuffer buffer_;
bool finished_ = false;
};
private:
bool IsDeferred() const override;
void Abort() override;
void NotifyFinished();
void CreateLoader(
ResourceRequest request,
const ResourceLoaderOptions& resource_loader_options) override;
// If |dom_exception| is provided, throws the specified DOMException instead
// of the usual "Failed to fetch" TypeError.
void Failed(const String& message,
DOMException* dom_exception,
std::optional<String> devtools_request_id = std::nullopt,
std::optional<base::UnguessableToken> issue_id = std::nullopt,
std::optional<String> issue_summary = std::nullopt) override;
Member<FetchManager> fetch_manager_;
Member<ResponseResolver> response_resolver_;
Member<ThreadableLoader> threadable_loader_;
Member<PlaceHolderBytesConsumer> place_holder_body_;
bool failed_;
bool finished_;
int response_http_status_code_;
bool response_has_no_store_header_ = false;
Member<IntegrityVerifier> integrity_verifier_;
Vector<KURL> url_list_;
Member<ScriptCachedMetadataHandler> cached_metadata_handler_;
base::TimeTicks request_started_time_;
};
FetchManager::Loader::Loader(ExecutionContext* execution_context,
FetchManager* fetch_manager,
ScriptPromiseResolver<Response>* resolver,
FetchRequestData* fetch_request_data,
ScriptState* script_state,
AbortSignal* signal)
: FetchLoaderBase(execution_context,
fetch_request_data,
script_state,
signal),
fetch_manager_(fetch_manager),
response_resolver_(MakeGarbageCollected<ResponseResolver>(resolver)),
failed_(false),
finished_(false),
response_http_status_code_(0),
integrity_verifier_(nullptr),
request_started_time_(base::TimeTicks::Now()) {
DCHECK(World());
url_list_.push_back(fetch_request_data->Url());
}
FetchManager::Loader::~Loader() {
DCHECK(!threadable_loader_);
}
void FetchManager::Loader::Trace(Visitor* visitor) const {
visitor->Trace(fetch_manager_);
visitor->Trace(response_resolver_);
visitor->Trace(threadable_loader_);
visitor->Trace(place_holder_body_);
visitor->Trace(integrity_verifier_);
visitor->Trace(cached_metadata_handler_);
FetchLoaderBase::Trace(visitor);
ThreadableLoaderClient::Trace(visitor);
}
bool FetchManager::Loader::WillFollowRedirect(
uint64_t identifier,
const KURL& url,
const ResourceResponse& response) {
const auto redirect_mode = GetFetchRequestData()->Redirect();
if (redirect_mode == network::mojom::RedirectMode::kError) {
DidFailRedirectCheck(identifier);
Dispose();
return false;
}
if (redirect_mode == network::mojom::RedirectMode::kManual) {
const uint64_t unused = 0;
// There is no need to read the body of redirect response because there is
// no way to read the body of opaque-redirect filtered response's internal
// response.
// TODO(horo): If we support any API which expose the internal body, we
// will have to read the body. And also HTTPCache changes will be needed
// because it doesn't store the body of redirect responses.
DidReceiveResponse(unused, response);
DidStartLoadingResponseBody(*BytesConsumer::CreateClosed());
if (threadable_loader_)
NotifyFinished();
Dispose();
return false;
}
DCHECK_EQ(redirect_mode, network::mojom::RedirectMode::kFollow);
url_list_.push_back(url);
return true;
}
void FetchManager::Loader::DidReceiveResponse(
uint64_t,
const ResourceResponse& response) {
// Verify that we're dealing with the URL we expect (which could be an
// HTTPS-upgraded variant of `url_list_.back()`.
DCHECK(
response.CurrentRequestUrl() == url_list_.back() ||
(response.CurrentRequestUrl().ProtocolIs("https") &&
url_list_.back().ProtocolIs("http") &&
response.CurrentRequestUrl().Host() == url_list_.back().Host() &&
response.CurrentRequestUrl().GetPath() == url_list_.back().GetPath() &&
response.CurrentRequestUrl().Query() == url_list_.back().Query()));
auto response_type = response.GetType();
DCHECK_NE(response_type, FetchResponseType::kError);
LogIfKeepalive("Succeeded");
ScriptState::Scope scope(GetScriptState());
response_http_status_code_ = response.HttpStatusCode();
if (response.MimeType() == "application/wasm" &&
(response.CurrentRequestUrl().ProtocolIsInHTTPFamily() ||
CommonSchemeRegistry::IsExtensionScheme(
response.CurrentRequestUrl().Protocol().Ascii()))) {
// We create a ScriptCachedMetadataHandler for WASM modules.
cached_metadata_handler_ =
MakeGarbageCollected<ScriptCachedMetadataHandler>(
WTF::TextEncoding(),
CachedMetadataSender::Create(
response, mojom::blink::CodeCacheType::kWebAssembly,
GetExecutionContext()->GetSecurityOrigin()));
}
place_holder_body_ = MakeGarbageCollected<PlaceHolderBytesConsumer>();
FetchResponseData* response_data = FetchResponseData::CreateWithBuffer(
BodyStreamBuffer::Create(GetScriptState(), place_holder_body_, Signal(),
cached_metadata_handler_));
if (!GetExecutionContext() || GetExecutionContext()->IsContextDestroyed() ||
response.GetType() == FetchResponseType::kError) {
// BodyStreamBuffer::Create() may run scripts and cancel this request.
// Do nothing in such a case.
// See crbug.com/1373785 for more details.
return;
}
DCHECK_EQ(response_type, response.GetType());
DCHECK(!(network_utils::IsRedirectResponseCode(response_http_status_code_) &&
HasNonEmptyLocationHeader(response_data->HeaderList()) &&
GetFetchRequestData()->Redirect() != RedirectMode::kManual));
if (network_utils::IsRedirectResponseCode(response_http_status_code_) &&
GetFetchRequestData()->Redirect() == RedirectMode::kManual) {
response_type = network::mojom::FetchResponseType::kOpaqueRedirect;
}
response_data->InitFromResourceResponse(
GetExecutionContext(), response_type, url_list_,
GetFetchRequestData()->Method(), GetFetchRequestData()->Credentials(),
response);
FetchResponseData* tainted_response = nullptr;
switch (response_type) {
case FetchResponseType::kBasic:
case FetchResponseType::kDefault:
tainted_response = response_data->CreateBasicFilteredResponse();
break;
case FetchResponseType::kCors: {
HTTPHeaderSet header_names = cors::ExtractCorsExposedHeaderNamesList(
GetFetchRequestData()->Credentials(), response);
tainted_response =
response_data->CreateCorsFilteredResponse(header_names);
break;
}
case FetchResponseType::kOpaque:
tainted_response = response_data->CreateOpaqueFilteredResponse();
break;
case FetchResponseType::kOpaqueRedirect:
tainted_response = response_data->CreateOpaqueRedirectFilteredResponse();
break;
case FetchResponseType::kError:
NOTREACHED();
}
// TODO(crbug.com/1288221): Remove this once the investigation is done.
CHECK(tainted_response);
response_has_no_store_header_ = response.CacheControlContainsNoStore();
Response* r = Response::Create(response_resolver_->GetExecutionContext(),
tainted_response);
r->headers()->SetGuard(Headers::kImmutableGuard);
std::optional<UnencodedDigest> unencoded_digest =
response.UnencodedDigest(GetExecutionContext());
if (GetFetchRequestData()->Integrity().empty() &&
!unencoded_digest.has_value()) {
response_resolver_->Resolve(r);
response_resolver_.Clear();
} else {
DCHECK(!integrity_verifier_);
// We have another place holder body for integrity checks.
PlaceHolderBytesConsumer* verified = place_holder_body_;
place_holder_body_ = MakeGarbageCollected<PlaceHolderBytesConsumer>();
BytesConsumer* underlying = place_holder_body_;
integrity_verifier_ = MakeGarbageCollected<IntegrityVerifier>(
underlying, verified, r, this, GetFetchRequestData()->Integrity(),
unencoded_digest, response.CurrentRequestUrl());
}
}
void FetchManager::Loader::DidReceiveCachedMetadata(mojo_base::BigBuffer data) {
if (cached_metadata_handler_) {
cached_metadata_handler_->SetSerializedCachedMetadata(std::move(data));
}
}
void FetchManager::Loader::DidStartLoadingResponseBody(BytesConsumer& body) {
if (GetFetchRequestData()->Integrity().empty() &&
!response_has_no_store_header_) {
// BufferingBytesConsumer reads chunks from |bytes_consumer| as soon as
// they get available to relieve backpressure. Buffering starts after
// a short delay, however, to allow the Response to be drained; e.g.
// when the Response is passed to FetchEvent.respondWith(), etc.
//
// https://fetch.spec.whatwg.org/#fetching
// The user agent should ignore the suspension request if the ongoing
// fetch is updating the response in the HTTP cache for the request.
place_holder_body_->Update(BufferingBytesConsumer::CreateWithDelay(
&body, GetExecutionContext()->GetTaskRunner(TaskType::kNetworking)));
} else {
place_holder_body_->Update(&body);
}
place_holder_body_ = nullptr;
}
void FetchManager::Loader::DidFinishLoading(uint64_t) {
DCHECK(!place_holder_body_);
DCHECK(!failed_);
finished_ = true;
auto* window = DynamicTo<LocalDOMWindow>(GetExecutionContext());
if (window && window->GetFrame() &&
network::IsSuccessfulStatus(response_http_status_code_)) {
window->GetFrame()->GetPage()->GetChromeClient().AjaxSucceeded(
window->GetFrame());
}
NotifyFinished();
}
void FetchManager::Loader::DidFail(uint64_t identifier,
const ResourceError& error) {
// Record the failures for blob fetch request.
if (GetFetchRequestData() &&
GetFetchRequestData()->Url().ProtocolIs("blob")) {
base::UmaHistogramSparse("Net.BlobFetch.ResponseNetErrorCode",
-error.ErrorCode());
}
if (GetFetchRequestData() && GetFetchRequestData()->TrustTokenParams()) {
HistogramNetErrorForTrustTokensOperation(
GetFetchRequestData()->TrustTokenParams()->operation,
error.ErrorCode());
}
if (error.TrustTokenOperationError() !=
network::mojom::blink::TrustTokenOperationStatus::kOk) {
Failed(String(),
TrustTokenErrorToDOMException(error.TrustTokenOperationError()),
IdentifiersFactory::SubresourceRequestId(identifier));
return;
}
std::optional<base::UnguessableToken> issue_id;
std::optional<String> issue_summary;
if (const auto& cors_error_status = error.CorsErrorStatus()) {
issue_id = cors_error_status->issue_id;
if (base::FeatureList::IsEnabled(features::kDevToolsImprovedNetworkError)) {
issue_summary = cors::GetErrorStringForIssueSummary(
*cors_error_status, fetch_initiator_type_names::kFetch);
}
}
Failed(String(), nullptr,
IdentifiersFactory::SubresourceRequestId(identifier), issue_id,
issue_summary);
}
void FetchManager::Loader::DidFailRedirectCheck(uint64_t identifier) {
Failed(String(), nullptr,
IdentifiersFactory::SubresourceRequestId(identifier));
}
void FetchLoaderBase::Start(ExceptionState& exception_state) {
// "1. If |request|'s url contains a Known HSTS Host, modify it per the
// requirements of the 'URI [sic] Loading and Port Mapping' chapter of HTTP
// Strict Transport Security."
// FIXME: Implement this.
// "2. If |request|'s referrer is not none, set |request|'s referrer to the
// result of invoking determine |request|'s referrer."
// We set the referrer using workerGlobalScope's URL in
// WorkerThreadableLoader.
// "3. If |request|'s synchronous flag is unset and fetch is not invoked
// recursively, run the remaining steps asynchronously."
// We don't support synchronous flag.
// "4. Let response be the value corresponding to the first matching
// statement:"
// "- should fetching |request| be blocked as mixed content returns blocked"
// We do mixed content checking in ResourceFetcher.
// "- should fetching |request| be blocked as content security returns
// blocked"
CHECK(execution_context_);
if (!execution_context_->GetContentSecurityPolicyForWorld(world_.Get())
->AllowConnectToSource(fetch_request_data_->Url(),
fetch_request_data_->Url(),
RedirectStatus::kNoRedirect)) {
// "A network error."
PerformNetworkError(
"Refused to connect because it violates the document's Content "
"Security Policy.");
return;
}
const KURL& url = fetch_request_data_->Url();
// "- |request|'s url's origin is same origin with |request|'s origin,
// |request|'s tainted origin flag is unset, and the CORS flag is unset"
// Note tainted origin flag is always unset here.
// Note we don't support to call this method with |CORS flag|
// "- |request|'s current URL's scheme is |data|"
// "- |request|'s mode is |navigate| or |websocket|".
if (fetch_request_data_->Origin()->CanReadContent(url) ||
(fetch_request_data_->IsolatedWorldOrigin() &&
fetch_request_data_->IsolatedWorldOrigin()->CanReadContent(url)) ||
fetch_request_data_->Mode() == network::mojom::RequestMode::kNavigate) {
// "The result of performing a scheme fetch using request."
PerformSchemeFetch(exception_state);
return;
}
// "- |request|'s mode is |same-origin|"
if (fetch_request_data_->Mode() == RequestMode::kSameOrigin) {
// This error is so early that there isn't an identifier yet, generate one.
FileIssueAndPerformNetworkError(RendererCorsIssueCode::kDisallowedByMode);
return;
}
// "- |request|'s mode is |no CORS|"
if (fetch_request_data_->Mode() == RequestMode::kNoCors) {
// "If |request|'s redirect mode is not |follow|, then return a network
// error.
if (fetch_request_data_->Redirect() != RedirectMode::kFollow) {
// This error is so early that there isn't an identifier yet, generate
// one.
FileIssueAndPerformNetworkError(
RendererCorsIssueCode::kNoCorsRedirectModeNotFollow);
return;
}
// "Set |request|'s response tainting to |opaque|."
// Response tainting is calculated in the CORS module in the network
// service.
//
// "The result of performing a scheme fetch using |request|."
PerformSchemeFetch(exception_state);
return;
}
// "- |request|'s url's scheme is not one of 'http' and 'https'"
// This may include other HTTP-like schemes if the embedder has added them
// to SchemeRegistry::registerURLSchemeAsSupportingFetchAPI.
if (!SchemeRegistry::ShouldTreatURLSchemeAsSupportingFetchAPI(
fetch_request_data_->Url().Protocol())) {
// This error is so early that there isn't an identifier yet, generate one.
FileIssueAndPerformNetworkError(RendererCorsIssueCode::kCorsDisabledScheme);
return;
}
// "Set |request|'s response tainting to |CORS|."
// Response tainting is calculated in the CORS module in the network
// service.
// "The result of performing an HTTP fetch using |request| with the
// |CORS flag| set."
PerformHTTPFetch(exception_state);
}
void FetchManager::Loader::Dispose() {
// Prevent notification
fetch_manager_ = nullptr;
if (threadable_loader_) {
if (GetFetchRequestData()->Keepalive()) {
threadable_loader_->Detach();
} else {
threadable_loader_->Cancel();
}
threadable_loader_ = nullptr;
}
if (integrity_verifier_)
integrity_verifier_->Cancel();
SetExecutionContext(nullptr);
}
// https://fetch.spec.whatwg.org/#abort-fetch
// To abort a fetch() call with a promise, request, responseObject, and an
// error:
void FetchManager::Loader::Abort() {
ScriptState* script_state = GetScriptState();
v8::Local<v8::Value> error = Signal()->reason(script_state).V8Value();
// 1. Reject promise with error.
if (response_resolver_) {
response_resolver_->Reject(error);
response_resolver_.Clear();
}
if (threadable_loader_) {
// Prevent re-entrancy.
auto loader = threadable_loader_;
threadable_loader_ = nullptr;
loader->Cancel();
}
// 2. If request’s body is non-null and is readable, then cancel request’s
// body with error.
if (FetchRequestData* fetch_request_data = GetFetchRequestData()) {
if (BodyStreamBuffer* body_stream_buffer = fetch_request_data->Buffer()) {
if (ReadableStream* readable_stream = body_stream_buffer->Stream()) {
ReadableStream::Cancel(script_state, readable_stream, error);
}
}
}
NotifyFinished();
}
void FetchLoaderBase::PerformSchemeFetch(ExceptionState& exception_state) {
// "To perform a scheme fetch using |request|, switch on |request|'s url's
// scheme, and run the associated steps:"
if (SchemeRegistry::ShouldTreatURLSchemeAsSupportingFetchAPI(
fetch_request_data_->Url().Protocol()) ||
fetch_request_data_->Url().ProtocolIs("blob")) {
// "Return the result of performing an HTTP fetch using |request|."
PerformHTTPFetch(exception_state);
} else if (fetch_request_data_->Url().ProtocolIsData()) {
PerformDataFetch();
} else {
// FIXME: implement other protocols.
// This error is so early that there isn't an identifier yet, generate one.
FileIssueAndPerformNetworkError(RendererCorsIssueCode::kCorsDisabledScheme);
}
}
void FetchLoaderBase::FileIssueAndPerformNetworkError(
RendererCorsIssueCode network_error) {
auto issue_id = base::UnguessableToken::Create();
switch (network_error) {
case RendererCorsIssueCode::kCorsDisabledScheme: {
AuditsIssue::ReportCorsIssue(execution_context_, network_error,
fetch_request_data_->Url().GetString(),
fetch_request_data_->Origin()->ToString(),
fetch_request_data_->Url().Protocol(),
issue_id);
PerformNetworkError("URL scheme \"" +
fetch_request_data_->Url().Protocol() +
"\" is not supported.",
issue_id);
break;
}
case RendererCorsIssueCode::kDisallowedByMode: {
AuditsIssue::ReportCorsIssue(execution_context_, network_error,
fetch_request_data_->Url().GetString(),
fetch_request_data_->Origin()->ToString(),
WTF::g_empty_string, issue_id);
PerformNetworkError(
"Request mode is \"same-origin\" but the URL\'s "
"origin is not same as the request origin " +
fetch_request_data_->Origin()->ToString() + ".",
issue_id);
break;
}
case RendererCorsIssueCode::kNoCorsRedirectModeNotFollow: {
AuditsIssue::ReportCorsIssue(execution_context_, network_error,
fetch_request_data_->Url().GetString(),
fetch_request_data_->Origin()->ToString(),
WTF::g_empty_string, issue_id);
PerformNetworkError(
"Request mode is \"no-cors\" but the redirect mode "
"is not \"follow\".",
issue_id);
break;
}
}
}
void FetchLoaderBase::PerformNetworkError(
const String& issue_summary,
std::optional<base::UnguessableToken> issue_id) {
Failed("Fetch API cannot load " + fetch_request_data_->Url().ElidedString() +
". " + issue_summary,
nullptr, std::nullopt, issue_id, issue_summary);
}
void FetchLoaderBase::PerformHTTPFetch(ExceptionState& exception_state) {
// CORS preflight fetch procedure is implemented inside ThreadableLoader.
// "1. Let |HTTPRequest| be a copy of |request|, except that |HTTPRequest|'s
// body is a tee of |request|'s body."
// We use ResourceRequest class for HTTPRequest.
// FIXME: Support body.
ResourceRequest request(fetch_request_data_->Url());
request.SetRequestorOrigin(fetch_request_data_->Origin());
request.SetNavigationRedirectChain(
fetch_request_data_->NavigationRedirectChain());
request.SetIsolatedWorldOrigin(fetch_request_data_->IsolatedWorldOrigin());
request.SetRequestContext(mojom::blink::RequestContextType::FETCH);
request.SetRequestDestination(fetch_request_data_->Destination());
request.SetFetchLikeAPI(true);
request.SetHttpMethod(fetch_request_data_->Method());
request.SetFetchWindowId(fetch_request_data_->WindowId());
request.SetTrustTokenParams(fetch_request_data_->TrustTokenParams());
request.SetMode(fetch_request_data_->Mode());
request.SetTargetAddressSpace(fetch_request_data_->TargetAddressSpace());
request.SetCredentialsMode(fetch_request_data_->Credentials());
for (const auto& header : fetch_request_data_->HeaderList()->List()) {
request.AddHttpHeaderField(AtomicString(header.first),
AtomicString(header.second));
}
if (fetch_request_data_->Method() != http_names::kGET &&
fetch_request_data_->Method() != http_names::kHEAD) {
if (fetch_request_data_->Buffer()) {
scoped_refptr<EncodedFormData> form_data =
fetch_request_data_->Buffer()->DrainAsFormData(exception_state);
if (form_data) {
request.SetHttpBody(form_data);
} else if (RuntimeEnabledFeatures::FetchUploadStreamingEnabled(
execution_context_)) {
UseCounter::Count(execution_context_,
WebFeature::kFetchUploadStreaming);
DCHECK(!fetch_request_data_->Buffer()->IsStreamLocked());
mojo::PendingRemote<network::mojom::blink::ChunkedDataPipeGetter>
pending_remote;
fetch_request_data_->Buffer()->DrainAsChunkedDataPipeGetter(
script_state_, pending_remote.InitWithNewPipeAndPassReceiver(),
/*client=*/nullptr);
request.MutableBody().SetStreamBody(std::move(pending_remote));
}
}
}
request.SetCacheMode(fetch_request_data_->CacheMode());
request.SetRedirectMode(fetch_request_data_->Redirect());
request.SetFetchIntegrity(fetch_request_data_->Integrity(),
execution_context_);
request.SetFetchPriorityHint(fetch_request_data_->FetchPriorityHint());
request.SetPriority(fetch_request_data_->Priority());
request.SetUseStreamOnResponse(true);
request.SetReferrerString(fetch_request_data_->ReferrerString());
request.SetReferrerPolicy(fetch_request_data_->GetReferrerPolicy());
if (IsDeferred()) {
// https://whatpr.org/fetch/1647/9ca4bda...9994c1d.html#request-a-deferred-fetch
// "Deferred fetching"
// 4. Set request’s service-workers mode to "none".
request.SetSkipServiceWorker(true);
} else {
request.SetSkipServiceWorker(world_->IsIsolatedWorld());
}
if (fetch_request_data_->Keepalive()) {
request.SetKeepalive(true);
UseCounter::Count(execution_context_, mojom::WebFeature::kFetchKeepalive);
}
if (fetch_request_data_->HasRetryOptions()) {
request.SetFetchRetryOptions(fetch_request_data_->RetryOptions().value());
}
request.SetBrowsingTopics(fetch_request_data_->BrowsingTopics());
request.SetAdAuctionHeaders(fetch_request_data_->AdAuctionHeaders());
request.SetAttributionReportingEligibility(
fetch_request_data_->AttributionReportingEligibility());
request.SetAttributionReportingSupport(
fetch_request_data_->AttributionSupport());
request.SetSharedStorageWritableOptedIn(
fetch_request_data_->SharedStorageWritable());
request.SetOriginalDestination(fetch_request_data_->OriginalDestination());
request.SetServiceWorkerRaceNetworkRequestToken(
fetch_request_data_->ServiceWorkerRaceNetworkRequestToken());
request.SetFetchLaterAPI(IsDeferred());
if (execution_context_->IsSharedWorkerGlobalScope() &&
DynamicTo<SharedWorkerGlobalScope>(*execution_context_)
->DoesRequireCrossSiteRequestForCookies()) {
request.SetSiteForCookies(net::SiteForCookies());
}
// "3. Append `Host`, ..."
// FIXME: Implement this when the spec is fixed.
// "4.If |HTTPRequest|'s force Origin header flag is set, append `Origin`/
// |HTTPRequest|'s origin, serialized and utf-8 encoded, to |HTTPRequest|'s
// header list."
// We set Origin header in updateRequestForAccessControl() called from
// ThreadableLoader::makeCrossOriginAccessRequest
// "5. Let |credentials flag| be set if either |HTTPRequest|'s credentials
// mode is |include|, or |HTTPRequest|'s credentials mode is |same-origin|
// and the |CORS flag| is unset, and unset otherwise."
ResourceLoaderOptions resource_loader_options(world_);
resource_loader_options.initiator_info.name =
fetch_initiator_type_names::kFetch;
resource_loader_options.data_buffering_policy = kDoNotBufferData;
if (fetch_request_data_->URLLoaderFactory()) {
mojo::PendingRemote<network::mojom::blink::URLLoaderFactory> factory_clone;
fetch_request_data_->URLLoaderFactory()->Clone(
factory_clone.InitWithNewPipeAndPassReceiver());
resource_loader_options.url_loader_factory =
base::MakeRefCounted<base::RefCountedData<
mojo::PendingRemote<network::mojom::blink::URLLoaderFactory>>>(
std::move(factory_clone));
}
if (fetch_request_data_->Keepalive() && !request.IsFetchLaterAPI()) {
FetchUtils::LogFetchKeepAliveRequestMetric(
request.GetRequestContext(),
FetchUtils::FetchKeepAliveRequestState::kTotal);
}
CreateLoader(std::move(request), resource_loader_options);
}
// performDataFetch() is almost the same as performHTTPFetch(), except for:
// - We set AllowCrossOriginRequests to allow requests to data: URLs in
// 'same-origin' mode.
// - We reject non-GET method.
void FetchLoaderBase::PerformDataFetch() {
DCHECK(fetch_request_data_->Url().ProtocolIsData());
ResourceRequest request(fetch_request_data_->Url());
request.SetRequestorOrigin(fetch_request_data_->Origin());
request.SetRequestContext(mojom::blink::RequestContextType::FETCH);
request.SetRequestDestination(fetch_request_data_->Destination());
request.SetFetchLikeAPI(true);
request.SetUseStreamOnResponse(true);
request.SetHttpMethod(fetch_request_data_->Method());
request.SetCredentialsMode(network::mojom::CredentialsMode::kOmit);
request.SetRedirectMode(RedirectMode::kError);
request.SetFetchPriorityHint(fetch_request_data_->FetchPriorityHint());
request.SetPriority(fetch_request_data_->Priority());
// We intentionally skip 'setExternalRequestStateFromRequestorAddressSpace',
// as 'data:' can never be external.
ResourceLoaderOptions resource_loader_options(world_);
resource_loader_options.data_buffering_policy = kDoNotBufferData;
CreateLoader(std::move(request), resource_loader_options);
}
void FetchManager::Loader::CreateLoader(
ResourceRequest request,
const ResourceLoaderOptions& resource_loader_options) {
threadable_loader_ = MakeGarbageCollected<ThreadableLoader>(
*GetExecutionContext(), this, resource_loader_options);
threadable_loader_->Start(std::move(request));
}
bool FetchLoaderBase::AddConsoleMessage(
const String& message,
std::optional<base::UnguessableToken> issue_id) {
if (execution_context_->IsContextDestroyed())
return false;
if (!message.empty() &&
!base::FeatureList::IsEnabled(features::kDevToolsImprovedNetworkError)) {
// CORS issues are reported via network service instrumentation, with the
// exception of early errors reported in FileIssueAndPerformNetworkError.
// We suppress these console messages when the DevToolsImprovedNetworkError
// feature is enabled, see http://crbug.com/371523542 for more details.
auto* console_message = MakeGarbageCollected<ConsoleMessage>(
mojom::blink::ConsoleMessageSource::kJavaScript,
mojom::blink::ConsoleMessageLevel::kError, message);
if (issue_id) {
console_message->SetCategory(mojom::blink::ConsoleMessageCategory::Cors);
}
execution_context_->AddConsoleMessage(console_message);
}
return true;
}
void FetchManager::Loader::Failed(
const String& message,
DOMException* dom_exception,
std::optional<String> devtools_request_id,
std::optional<base::UnguessableToken> issue_id,
std::optional<String> issue_summary) {
if (failed_ || finished_) {
return;
}
failed_ = true;
if (!AddConsoleMessage(message, issue_id)) {
return;
}
if (response_resolver_) {
ScriptState::Scope scope(GetScriptState());
if (dom_exception) {
response_resolver_->Reject(dom_exception);
} else {
response_resolver_->RejectBecauseFailed(
std::move(devtools_request_id), issue_id, std::move(issue_summary));
LogIfKeepalive("Failed");
}
response_resolver_.Clear();
}
NotifyFinished();
}
void FetchManager::Loader::NotifyFinished() {
if (fetch_manager_)
fetch_manager_->OnLoaderFinished(this);
}
bool FetchManager::Loader::IsDeferred() const {
return false;
}
void FetchManager::Loader::LogIfKeepalive(
std::string_view request_state) const {
return;
CHECK(request_state == "Succeeded" || request_state == "Failed");
if (!GetFetchRequestData()->Keepalive()) {
return;
}
base::TimeDelta duration = base::TimeTicks::Now() - request_started_time_;
base::UmaHistogramMediumTimes("FetchKeepAlive.RequestDuration", duration);
base::UmaHistogramMediumTimes(
base::StrCat({"FetchKeepAlive.RequestDuration.", request_state}),
duration);
}
// A subtype of FetchLoader to handle the deferred fetching algorithm [1].
//
// This loader and FetchManager::Loader are similar that they both runs the
// fetching algorithm provided by the base class. However, this loader does not
// go down ThreadableLoader and ResourceFetcher. Rather, it creates requests via
// a similar mojo FetchLaterLoaderFactory. Other differences include:
// - `IsDeferred()` is true, which helps the base generate different requests.
// - Expect no response after `Start()` is called.
// - Support activateAfter from [2] to allow sending at specified time.
// - Support FetchLaterResult from [2].
//
// Underlying, this loader intends to create a "deferred" fetch request,
// i.e. `ResourceRequest.is_fetch_later_api` is true, when `Start()` is called.
// The request will not be sent by network service (handled via browser)
// immediately until ExecutionContext of the FetchLaterManager is destroyed.
//
// Note that this loader does not use the "defer" mechanism as described in
// `ResourcFetcher::RequestResource()` or `ResourceFetcher::StartLoad()`, as
// the latter method can only be called when ResourcFetcher is not detached.
// Plus, the browser companion must be notified when the context is still alive.
//
// [1]:
// https://whatpr.org/fetch/1647/9ca4bda...9994c1d.html#request-a-deferred-fetch
// [2]:
// https://whatpr.org/fetch/1647/9ca4bda...9994c1d.html#dom-global-fetch-later
class FetchLaterManager::DeferredLoader final
: public GarbageCollected<FetchLaterManager::DeferredLoader>,
public FetchLoaderBase {
public:
DeferredLoader(ExecutionContext* ec,
FetchLaterManager* fetch_later_manager,
FetchRequestData* fetch_request_data,
uint64_t total_request_size,
ScriptState* script_state,
AbortSignal* signal,
const std::optional<base::TimeDelta>& activate_after)
: FetchLoaderBase(ec, fetch_request_data, script_state, signal),
fetch_later_manager_(fetch_later_manager),
fetch_later_result_(MakeGarbageCollected<FetchLaterResult>()),
total_request_size_(total_request_size),
activate_after_(activate_after),
timer_(ec->GetTaskRunner(FetchLaterManager::kTaskType),
this,
&DeferredLoader::TimerFired),
loader_(ec) {
base::UmaHistogramBoolean("FetchLater.Renderer.Total", true);
// `timer_` is started in `CreateLoader()` so that it won't end before a
// request is created.
}
FetchLaterResult* fetch_later_result() { return fetch_later_result_.Get(); }
// FetchLoaderBase overrides:
void Dispose() override {
// Prevent notification
fetch_later_manager_ = nullptr;
SetExecutionContext(nullptr);
timer_.Stop();
// The browser companion will take care of the actual request sending when
// discoverying the URL loading connections from here are gone.
}
// Implements "process a deferred fetch" algorithm from
// https://whatpr.org/fetch/1647.html#process-a-deferred-fetch
void Process(const FetchLaterRendererMetricType& metric_type) {
// 1. If deferredRecord’s invoke state is not "pending", then return.
if (invoke_state_ != InvokeState::PENDING) {
return;
}
// 2. Set deferredRecord’s invoke state to "sent".
SetInvokeState(InvokeState::SENT);
// 3. Fetch deferredRecord’s request.
if (loader_) {
LogFetchLaterMetric(metric_type);
loader_->SendNow();
}
// 4. Queue a global task on the deferred fetch task source with
// deferredRecord’s request’s client’s global object to run deferredRecord’s
// notify invoked,
// which is "onActivatedWithoutTermination": "set activated to true" from
// https://whatpr.org/fetch/1647.html#ref-for-queue-a-deferred-fetch
// NOTE: Call sites are already triggered from other task queues.
SetActivated();
}
// Returns this loader's total request size if `url` is "same origin" with
// this loader's request URL.
uint64_t GetDeferredBytesForUrlOrigin(const KURL& url) const {
return SecurityOrigin::AreSameOrigin(GetFetchRequestData()->Url(), url)
? GetDeferredBytes()
: 0;
}
// Returns the total length of the request queued by this loader.
uint64_t GetDeferredBytes() const { return total_request_size_; }
void Trace(Visitor* visitor) const override {
visitor->Trace(fetch_later_manager_);
visitor->Trace(fetch_later_result_);
visitor->Trace(timer_);
visitor->Trace(loader_);
FetchLoaderBase::Trace(visitor);
}
// For testing only:
void RecreateTimerForTesting(
scoped_refptr<base::SingleThreadTaskRunner> task_runner,
const base::TickClock* tick_clock) {
timer_.Stop();
timer_.SetTaskRunnerForTesting(std::move(task_runner), tick_clock);
if (activate_after_.has_value()) {
timer_.StartOneShot(*activate_after_, FROM_HERE);
}
}
private:
enum class InvokeState {
PENDING,
SENT,
ABORTED,
};
void SetInvokeState(InvokeState state) {
switch (state) {
case InvokeState::PENDING:
UseCounter::Count(GetExecutionContext(),
WebFeature::kFetchLaterInvokeStatePending);
break;
case InvokeState::SENT:
UseCounter::Count(GetExecutionContext(),
WebFeature::kFetchLaterInvokeStateSent);
break;
case InvokeState::ABORTED:
UseCounter::Count(GetExecutionContext(),
WebFeature::kFetchLaterInvokeStateAborted);
break;
default:
NOTREACHED();
};
invoke_state_ = state;
}
void SetActivated() { fetch_later_result_->SetActivated(true); }
// FetchLoaderBase overrides:
bool IsDeferred() const override { return true; }
void Abort() override {
// https://whatpr.org/fetch/1647/9ca4bda...9994c1d.html#dom-global-fetch-later
// 10. Add the following abort steps to requestObject’s signal:
// 10-1. Set deferredRecord’s invoke state to "aborted".
SetInvokeState(InvokeState::ABORTED);
// 10-2. Remove deferredRecord from request’s client’s fetch group’s
// deferred fetch records.
if (loader_) {
LogFetchLaterMetric(FetchLaterRendererMetricType::kAbortedByUser);
loader_->Cancel();
}
NotifyFinished();
}
// Triggered after `Start()`.
void CreateLoader(
ResourceRequest request,
const ResourceLoaderOptions& resource_loader_options) override {
auto* factory = fetch_later_manager_->GetFactory();
if (!factory) {
Failed(/*message=*/String(), /*dom_exception=*/nullptr);
return;
}
std::unique_ptr<network::ResourceRequest> network_request =
fetch_later_manager_->PrepareNetworkRequest(std::move(request),
resource_loader_options);
if (!network_request) {
Failed(/*message=*/String(), /*dom_exception=*/nullptr);
return;
}
// Don't do mime sniffing for fetch (crbug.com/2016)
uint32_t url_loader_options = network::mojom::blink::kURLLoadOptionNone;
// Computes a unique request_id for this renderer process.
int request_id = GenerateRequestId();
factory->CreateFetchLaterLoader(
loader_.BindNewEndpointAndPassReceiver(
GetExecutionContext()->GetTaskRunner(FetchLaterManager::kTaskType)),
request_id, url_loader_options, *network_request,
net::MutableNetworkTrafficAnnotationTag(
kFetchLaterTrafficAnnotationTag));
CHECK(loader_.is_bound());
loader_.set_disconnect_handler(WTF::BindOnce(
&DeferredLoader::NotifyFinished, WrapWeakPersistent(this)));
// https://whatpr.org/fetch/1647.html#queue-a-deferred-fetch
// Continued with "queue a deferred fetch"
// 6. If `activate_after_` is not null, then run the following steps in
// parallel:
if (activate_after_.has_value()) {
// 6-1. The user agent should wait until any of the following conditions
// is met:
// - At least activateAfter milliseconds have passed: Implementation
// followed by `TimerFired()`.
// - The user agent has a reason to believe that it is about to lose the
// opportunity to execute scripts, e.g., when the browser is moved to
// the background, or when request’s client is a Document that had a
// "hidden" visibility state for a long period of time: Implementation
// followed by `ContextEnteredBackForwardCache()`.
timer_.StartOneShot(*activate_after_, FROM_HERE);
}
}
void Failed(const String& message,
DOMException* dom_exception,
std::optional<String> devtools_request_id = std::nullopt,
std::optional<base::UnguessableToken> issue_id = std::nullopt,
std::optional<String> issue_summary = std::nullopt) override {
AddConsoleMessage(message, issue_id);
NotifyFinished();
}
// Notifies the owner to remove `this` from its container, after which
// `Dispose()` will also be called.
void NotifyFinished() {
if (fetch_later_manager_) {
fetch_later_manager_->OnDeferredLoaderFinished(this);
}
}
// Triggered by `timer_`.
void TimerFired(TimerBase*) {
// https://whatpr.org/fetch/1647.html#queue-a-deferred-fetch
// Continued with "queue a deferred fetch":
// 6-2. If the result of calling process a deferred fetch given
// deferredRecord returns true, then queue a global task on the deferred
// fetch task source with request’s client’s global object and
// onActivatedWithoutTermination.
Process(FetchLaterRendererMetricType::kActivatedByTimeout);
NotifyFinished();
}
// A deferred fetch record's "invoke state" field.
// https://whatpr.org/fetch/1647.html#deferred-fetch-record-invoke-state
InvokeState invoke_state_ = InvokeState::PENDING;
// Owns this instance.
Member<FetchLaterManager> fetch_later_manager_;
// Retains strong reference to the returned V8 object of a FetchLater API call
// that creates this loader.
//
// The object itself may be held by a script, and may easily outlive `this` if
// the script keeps holding the object after the FetchLater request completes.
//
// This field should be updated whenever `invoke_state_` changes.
Member<FetchLaterResult> fetch_later_result_;
// The total size of the request queued by this loader.
const uint64_t total_request_size_;
// The "activateAfter" to request a deferred fetch.
// https://whatpr.org/fetch/1647.html#request-a-deferred-fetch
const std::optional<base::TimeDelta> activate_after_;
// A timer to handle `activate_after_`.
HeapTaskRunnerTimer<DeferredLoader> timer_;
// Connects to FetchLaterLoader in browser.
HeapMojoAssociatedRemote<mojom::blink::FetchLaterLoader> loader_;
};
FetchManager::FetchManager(ExecutionContext* execution_context)
: ExecutionContextLifecycleObserver(execution_context) {}
ScriptPromise<Response> FetchManager::Fetch(ScriptState* script_state,
FetchRequestData* request,
AbortSignal* signal,
ExceptionState& exception_state) {
DCHECK(signal);
if (signal->aborted()) {
return ScriptPromise<Response>::Reject(script_state,
signal->reason(script_state));
}
request->SetDestination(network::mojom::RequestDestination::kEmpty);
auto* resolver = MakeGarbageCollected<ScriptPromiseResolver<Response>>(
script_state, exception_state.GetContext());
auto promise = resolver->Promise();
auto* loader = MakeGarbageCollected<Loader>(
GetExecutionContext(), this, resolver, request, script_state, signal);
loaders_.insert(loader);
// TODO(ricea): Reject the Response body with AbortError, not TypeError.
loader->Start(exception_state);
return promise;
}
FetchLaterResult* FetchLaterManager::FetchLater(
ScriptState* script_state,
FetchRequestData* request,
AbortSignal* signal,
std::optional<DOMHighResTimeStamp> activate_after_ms,
ExceptionState& exception_state) {
// https://whatpr.org/fetch/1647.html#dom-global-fetch-later
// Continuing the fetchLater(input, init) method steps:
CHECK(signal);
// 2. If request’s signal is aborted, then throw signal’s abort reason.
if (signal->aborted()) {
exception_state.ThrowDOMException(DOMExceptionCode::kAbortError,
"The user aborted a fetchLater request.");
return nullptr;
}
std::optional<base::TimeDelta> activate_after = std::nullopt;
if (activate_after_ms.has_value()) {
activate_after = base::Milliseconds(*activate_after_ms);
// 6. If `activate_after` is less than 0 then throw a RangeError.
if (activate_after->is_negative()) {
exception_state.ThrowRangeError(
"fetchLater's activateAfter cannot be negative.");
return nullptr;
}
}
// 7. If request’s client is not a fully active Document, then throw an
// "InvalidStateError" DOMException.
if (!DomWindow() || GetExecutionContext()->is_in_back_forward_cache()) {
exception_state.ThrowDOMException(
DOMExceptionCode::kInvalidStateError,
"fetchLater can only be called from a fully active Document.");
return nullptr;
}
// 8. If request’s URL’s scheme is not an HTTPS scheme, then throw a
// TypeError.
if (!request->Url().ProtocolIs(WTF::g_https_atom)) {
exception_state.ThrowTypeError("fetchLater is only supported over HTTPS.");
return nullptr;
}
// 9. If request’s URL is not a potentially trustworthy url, then throw a
// "SecurityError" DOMException.
if (!network::IsUrlPotentiallyTrustworthy(GURL(request->Url()))) {
exception_state.ThrowSecurityError(
"fetchLater was passed an insecure URL.");
return nullptr;
}
// 10. If request’s body is not null, and request's body length is null, then
// throw a TypeError.
if (request->Buffer() && request->BufferByteLength() == 0) {
UseCounter::Count(GetExecutionContext(),
WebFeature::kFetchLaterErrorUnknownBodyLength);
exception_state.ThrowTypeError(
"fetchLater doesn't support body with unknown length.");
return nullptr;
}
CHECK(DomWindow());
// 11. If the available deferred-fetch quota given controlDocument and
// request’s URL’s origin is less than request’s total request length, then
// throw a "QuotaExceededError" DOMException.
auto available_quota = FetchLaterUtil::GetAvailableDeferredFetchQuota(
DomWindow()->GetFrame(), request->Url());
auto total_request_length = FetchLaterUtil::CalculateRequestSize(*request);
if (available_quota < total_request_length) {
UseCounter::Count(GetExecutionContext(),
WebFeature::kFetchLaterErrorQuotaExceeded);
QuotaExceededError::Throw(
exception_state,
String::Format(
"fetchLater exceeds its quota for the origin: got %" PRIu64 " "
"bytes, expected less than %" PRIu64 " bytes.",
total_request_length, available_quota));
return nullptr;
}
// 13. Let deferredRecord be the result of calling queue a deferred fetch
// given request, activateAfter, and the following step: set activated to
// true.
// "To queue a deferred fetch ..."
// https://whatpr.org/fetch/1647.html#queue-a-deferred-fetch
// 2. Set request’s service-workers mode to "none".
// NOTE: Done in `FetchLoaderBase::PerformHTTPFetch()`.
request->SetDestination(network::mojom::RequestDestination::kEmpty);
// 3. Set request’s keepalive to true.
request->SetKeepalive(true);
// 4. Let deferredRecord be a new deferred fetch record whose request is
// request, and whose notify invoked is onActivatedWithoutTermination.
auto* deferred_loader = MakeGarbageCollected<DeferredLoader>(
GetExecutionContext(), this, request, total_request_length, script_state,
signal, activate_after);
// 5. Append deferredRecord to document’s fetch group’s deferred fetch
// records.
deferred_loaders_.insert(deferred_loader);
deferred_loader->Start(exception_state);
// Continued in `DeferredLoader::CreateLoader()`.
// 15. Return a new FetchLaterResult whose activated getter steps are to
// return activated.
return deferred_loader->fetch_later_result();
}
void FetchManager::ContextDestroyed() {
// https://whatpr.org/fetch/1647/9ca4bda...7bff4de.html#concept-defer=fetch-record
// When a fetch group fetchGroup is terminated:
// 1. For each fetch record of fetchGroup's fetch records, if record's
// controller is non-null and record’s done flag is unset and keepalive is
// false, terminate the fetch record’s controller .
for (auto& loader : loaders_) {
loader->Dispose();
}
}
void FetchManager::OnLoaderFinished(Loader* loader) {
loaders_.erase(loader);
loader->Dispose();
}
void FetchManager::Trace(Visitor* visitor) const {
visitor->Trace(loaders_);
ExecutionContextLifecycleObserver::Trace(visitor);
}
FetchLaterManager::FetchLaterManager(ExecutionContext* ec)
: ExecutionContextLifecycleObserver(ec),
permission_observer_receiver_(this, ec) {
// TODO(crbug.com/1356128): FetchLater API is only supported in Document.
// Supporting it in workers is blocked by keepalive in browser migration.
CHECK(ec->IsWindow());
if (IsFetchLaterUseBackgroundSyncPermissionEnabled()) {
auto* permission_service =
DomWindow()->document()->GetPermissionService(ec);
CHECK(permission_service);
mojo::PendingRemote<mojom::blink::PermissionObserver> observer;
permission_observer_receiver_.Bind(
observer.InitWithNewPipeAndPassReceiver(),
// Same as `permission_service`'s task type.
ec->GetTaskRunner(TaskType::kPermission));
CHECK(permission_observer_receiver_.is_bound());
// Registers an observer for BackgroundSync permission.
// Cannot use `HasPermission()` as it's asynchronous. At the time the
// permission status is needed, e.g. on entering BackForwardCache, it may
// not have enough time to wait for response.
auto descriptor = mojom::blink::PermissionDescriptor::New();
descriptor->name = mojom::blink::PermissionName::BACKGROUND_SYNC;
permission_service->AddPermissionObserver(std::move(descriptor),
background_sync_permission_,
std::move(observer));
}
}
blink::ChildURLLoaderFactoryBundle* FetchLaterManager::GetFactory() {
// Do nothing if context is detached.
if (!DomWindow()) {
return nullptr;
}
return DomWindow()->GetFrame()->Client()->GetLoaderFactoryBundle();
}
void FetchLaterManager::ContextDestroyed() {
// https://whatpr.org/fetch/1647/9ca4bda...7bff4de.html#concept-defer=fetch-record
// When a fetch group fetchGroup is terminated:
// 2. process deferred fetches for fetchGroup.
// https://whatpr.org/fetch/1647/9ca4bda...9994c1d.html#process-deferred-fetches
// To process deferred fetches given a fetch group fetchGroup:
for (auto& deferred_loader : deferred_loaders_) {
// 3. For each deferred fetch record deferredRecord, process a deferred
// fetch given deferredRecord.
deferred_loader->Process(FetchLaterRendererMetricType::kContextDestroyed);
deferred_loader->Dispose();
}
// Unlike regular Fetch loaders, FetchLater loaders should be cleared
// immediately when the context is gone, as there is no work left here.
deferred_loaders_.clear();
}
void FetchLaterManager::ContextEnteredBackForwardCache() {
// TODO(crbug.com/1465781): Replace with spec once it's finalized.
// https://github.com/WICG/pending-beacon/issues/3#issuecomment-1286397825
// Sending any requests "after" the context goes into BackForwardCache
// requires BackgroundSync permission. If not granted, we should force sending
// all of them now instead of waiting until `ContextDestroyed()`.
if (IsFetchLaterSendOnEnterBackForwardCacheEnabled() ||
(IsFetchLaterUseBackgroundSyncPermissionEnabled() &&
!IsBackgroundSyncGranted())) {
for (auto& deferred_loader : deferred_loaders_) {
deferred_loader->Process(
FetchLaterRendererMetricType::kActivatedOnEnteredBackForwardCache);
deferred_loader->Dispose();
}
deferred_loaders_.clear();
}
}
void FetchLaterManager::OnDeferredLoaderFinished(
DeferredLoader* deferred_loader) {
deferred_loaders_.erase(deferred_loader);
deferred_loader->Dispose();
}
bool FetchLaterManager::IsBackgroundSyncGranted() const {
return background_sync_permission_ == mojom::blink::PermissionStatus::GRANTED;
}
void FetchLaterManager::OnPermissionStatusChange(
mojom::blink::PermissionStatus status) {
background_sync_permission_ = status;
}
size_t FetchLaterManager::NumLoadersForTesting() const {
return deferred_loaders_.size();
}
void FetchLaterManager::RecreateTimerForTesting(
scoped_refptr<base::SingleThreadTaskRunner> task_runner,
const base::TickClock* tick_clock) {
for (auto& deferred_loader : deferred_loaders_) {
deferred_loader->RecreateTimerForTesting(task_runner, tick_clock);
}
}
std::unique_ptr<network::ResourceRequest>
FetchLaterManager::PrepareNetworkRequest(
ResourceRequest request,
const ResourceLoaderOptions& options) const {
if (!GetExecutionContext()) {
// No requests if the context is destroyed.
return nullptr;
}
CHECK(DomWindow());
ResourceFetcher* fetcher = DomWindow()->Fetcher();
CHECK(fetcher);
FetchParameters params(std::move(request), options);
WebScopedVirtualTimePauser unused_virtual_time_pauser;
params.OverrideContentType(kFetchLaterContentType);
const FetchClientSettingsObject& fetch_client_settings_object =
fetcher->GetProperties().GetFetchClientSettingsObject();
FetchManagerResourceRequestContext resource_request_context;
if (PrepareResourceRequestForCacheAccess(
kFetchLaterResourceType, fetch_client_settings_object, KURL(),
resource_request_context, fetcher->Context(),
params) != std::nullopt) {
return nullptr;
}
UpgradeResourceRequestForLoader(kFetchLaterResourceType, params,
fetcher->Context(), resource_request_context,
unused_virtual_time_pauser);
// From `ResourceFetcher::StartLoad()`:
ScriptForbiddenScope script_forbidden_scope;
auto network_resource_request = std::make_unique<network::ResourceRequest>();
PopulateResourceRequest(
params.GetResourceRequest(),
std::move(params.MutableResourceRequest().MutableBody()),
network_resource_request.get());
fetcher->PopulateResourceRequestPermissionsPolicy(
network_resource_request.get());
return network_resource_request;
}
void FetchLaterManager::UpdateDeferredBytesQuota(const KURL& url,
uint64_t& quota_for_url_origin,
uint64_t& total_quota) const {
CHECK_LE(quota_for_url_origin, kMaxPerRequestOriginScheduledDeferredBytes);
CHECK_LE(total_quota, kMaxScheduledDeferredBytes);
// https://whatpr.org/fetch/1647.html#available-deferred-fetch-quota
// 8-2. For each deferred fetch record deferredRecord of controlDocument’s
// fetch group’s deferred fetch records:
for (const auto& deferred_loader : deferred_loaders_) {
if (quota_for_url_origin == 0 && total_quota == 0) {
// Early termination.
return;
}
// 8-2-1. Let requestLength be the total request length of deferredRecord’s
// request.
// 8-2-2. Decrement quota by requestLength.
total_quota -= std::min(total_quota, deferred_loader->GetDeferredBytes());
// 8-2-3. If deferredRecord’s request’s URL’s origin is same origin with
// origin, then decrement quotaForRequestOrigin by requestLength.
quota_for_url_origin -=
std::min(quota_for_url_origin,
deferred_loader->GetDeferredBytesForUrlOrigin(url));
}
}
void FetchLaterManager::Trace(Visitor* visitor) const {
visitor->Trace(deferred_loaders_);
visitor->Trace(permission_observer_receiver_);
ExecutionContextLifecycleObserver::Trace(visitor);
}
} // namespace blink
|