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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/loader/keep_alive_url_loader.h"
#include <memory>
#include <utility>
#include <vector>
#include "base/check_is_test.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/strcat.h"
#include "base/trace_event/trace_event.h"
#include "base/trace_event/typed_macros.h"
#include "base/unguessable_token.h"
#include "content/browser/devtools/devtools_instrumentation.h"
#include "content/browser/loader/keep_alive_attribution_request_helper.h"
#include "content/browser/renderer_host/mixed_content_checker.h"
#include "content/browser/renderer_host/policy_container_host.h"
#include "content/browser/renderer_host/render_frame_host_impl.h"
#include "content/browser/web_contents/web_contents_impl.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/keep_alive_request_tracker.h"
#include "content/public/common/content_client.h"
#include "content/public/common/url_utils.h"
#include "net/base/load_flags.h"
#include "net/http/http_request_headers.h"
#include "net/http/http_response_headers.h"
#include "net/url_request/redirect_util.h"
#include "services/network/public/cpp/content_security_policy/content_security_policy.h"
#include "services/network/public/cpp/content_security_policy/csp_context.h"
#include "services/network/public/cpp/devtools_observer_util.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/url_loader_completion_status.h"
#include "services/network/public/mojom/content_security_policy.mojom.h"
#include "services/network/public/mojom/early_hints.mojom.h"
#include "services/network/public/mojom/fetch_api.mojom-shared.h"
#include "services/network/public/mojom/url_request.mojom.h"
#include "third_party/blink/public/common/features.h"
namespace features {
// See third_party/blink/renderer/core/fetch/retry_options.idl for details of
// each parameter.
// Note that we allow script to set their own policies for retry, but these
// browser-configured limits act as both lower/upper bounds and also default
// values if not set by script.
const base::FeatureParam<size_t> kMaxRetryCount{&blink::features::kFetchRetry,
"max_retry_count", 10};
const base::FeatureParam<base::TimeDelta> kMinRetryDelta{
&blink::features::kFetchRetry, "min_retry_delta", base::Milliseconds(500)};
const base::FeatureParam<double> kMinRetryBackoffFactor{
&blink::features::kFetchRetry, "min_retry_backoff", 1.0};
const base::FeatureParam<base::TimeDelta> kMaxRetryAge{
&blink::features::kFetchRetry, "max_retry_age", base::Days(1)};
} // namespace features
namespace content {
namespace {
constexpr net::NetworkTrafficAnnotationTag kKeepAliveRetryAnnotationTag =
net::DefineNetworkTrafficAnnotation("keepalive_fetch_retry", R"(
semantics {
sender: "KeepAlive Fetch Retry Mechanism"
description:
"This request is an automated retry of a fetch request that was "
"originally initiated by a website with the `keepalive: true` flag "
"and `retryOptions` specifying that retries should occur. This "
"retry is triggered by the browser process if the initial attempt or "
"a subsequent retry fails, and can occur even if the originating "
"renderer process has been closed. The purpose is to increase the "
"likelihood of successful data delivery for critical beacons, logs, "
"or other data the website intended to send reliably."
trigger:
"An initial keepalive fetch request (or a previous retry of it) "
"failed due to a network error or a specific HTTP 5xx server error "
"(if configured in RetryOptions). The RetryOptions associated with "
"the original request dictated that a retry should be attempted. "
"This specific request is triggered by an automated timer within the "
"browser process's KeepAliveURLLoader after a calculated backoff period."
data:
"The same HTTP method, URL, headers, and body as the original "
"keepalive request that is being retried. This data is determined "
"by the website that initiated the original fetch request."
destination: WEBSITE
internal {
contacts {
email: "chrome-loading@google.com"
}
}
user_data {
type: ARBITRARY_DATA
type: SENSITIVE_URL
}
last_reviewed: "2025-05-27"
}
policy {
cookies_allowed: YES
cookies_store: "Same as the original request. Governed by the "
"credentials mode ('omit', 'same-origin', 'include') "
"of the original fetch request."
setting:
"This retry mechanism is a sub-feature of the Fetch API's "
"`keepalive` and the proposed `retryOptions`. Websites enable this "
"by constructing fetch requests with these options. Users can "
"disable JavaScript or clear/block cookies for sites, which would "
"affect the original request and consequently prevent retries. "
"There isn't a separate browser setting to disable only the retry "
"aspect of keepalive fetches."
policy_exception_justification:
"This is an automated follow-up to a user-initiated (via website "
"JavaScript) keepalive request."
}
)");
// Internally enforces a limit to allow a loader outlive its renderer after
// receiving disconnection notification from the renderer.
//
// Defaults to 30s, the same as pre-migration's timeout.
constexpr base::TimeDelta kDefaultDisconnectedKeepAliveURLLoaderTimeout =
base::Seconds(30);
base::TimeDelta GetDisconnectedKeepAliveURLLoaderTimeout() {
return base::Seconds(GetFieldTrialParamByFeatureAsInt(
blink::features::kKeepAliveInBrowserMigration,
"disconnected_loader_timeout_seconds",
base::checked_cast<int32_t>(
kDefaultDisconnectedKeepAliveURLLoaderTimeout.InSeconds())));
}
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// Must remain in sync with FetchLaterBrowserMetricType in
// tools/metrics/histograms/enums.xml.
enum class FetchLaterBrowserMetricType {
kAbortedByInitiator = 0,
kStartedAfterInitiatorDisconnected = 1,
kStartedByInitiator = 2,
kCancelledAfterTimeLimit = 3,
kStartedWhenShutdown = 4,
kMaxValue = kStartedWhenShutdown,
};
void LogFetchLaterMetric(const FetchLaterBrowserMetricType& type) {
base::UmaHistogramEnumeration("FetchLater.Browser.Metrics", type);
}
// A ContentSecurityPolicy context for KeepAliveURLLoader.
class KeepAliveURLLoaderCSPContext final : public network::CSPContext {
public:
// network::CSPContext override:
void ReportContentSecurityPolicyViolation(
network::mojom::CSPViolationPtr violation_params) final {
// TODO(crbug.com/40236167): Support reporting violation w/o renderer.
}
void SanitizeDataForUseInCspViolation(
network::mojom::CSPDirectiveName directive,
GURL* blocked_url,
network::mojom::SourceLocation* source_location) const final {
// TODO(crbug.com/40236167): Support reporting violation w/o renderer.
}
};
// Checks if `url` is allowed by the set of Content-Security-Policy `policies`.
// Violation will not be reported back to renderer, as this function must be
// called after renderer is gone.
// TODO(crbug.com/40263403): Isolated world's CSP is not handled.
bool IsRedirectAllowedByCSP(
const std::vector<network::mojom::ContentSecurityPolicyPtr>& policies,
const GURL& url,
const GURL& url_before_redirects,
bool has_followed_redirect) {
// Sets the CSP Directive for fetch() requests. See
// https://w3c.github.io/webappsec-csp/#directive-connect-src
// https://fetch.spec.whatwg.org/#destination-table
auto directive = network::mojom::CSPDirectiveName::ConnectSrc;
// Sets empty as source location is only used when reporting back to renderer.
auto empty_source_location = network::mojom::SourceLocation::New();
auto disposition = network::CSPContext::CheckCSPDisposition::CHECK_ALL_CSP;
// When reaching here, renderer should have be gone, or at least
// `KeepAliveURLLoader::forwarding_client_` is disconnected.
return KeepAliveURLLoaderCSPContext()
.IsAllowedByCsp(policies, directive, url, url_before_redirects,
has_followed_redirect, empty_source_location, disposition,
/*is_form_submission=*/false)
.IsAllowed();
}
bool IsNetErrorEligibleForRetry(int net_error) {
// Check if the error we encountered is likely transient / can succeed with
// another attempt.
return // Generic transient errors.
net_error == net::ERR_TIMED_OUT ||
net_error == net::ERR_CONNECTION_TIMED_OUT ||
net_error == net::ERR_CONNECTION_CLOSED ||
net_error == net::ERR_CONNECTION_REFUSED ||
net_error == net::ERR_CONNECTION_RESET ||
net_error == net::ERR_CONNECTION_FAILED ||
net_error == net::ERR_ADDRESS_UNREACHABLE ||
net_error == net::ERR_NETWORK_CHANGED ||
// Proxy/tunnel-specific connection issues.
net_error == net::ERR_TUNNEL_CONNECTION_FAILED ||
net_error == net::ERR_PROXY_CONNECTION_FAILED ||
net_error == net::ERR_SOCKS_CONNECTION_FAILED ||
net_error == net::ERR_HTTP2_PING_FAILED ||
net_error == net::ERR_HTTP2_PROTOCOL_ERROR ||
net_error == net::ERR_QUIC_PROTOCOL_ERROR ||
// DNS failures.
net_error == net::ERR_NAME_NOT_RESOLVED ||
net_error == net::ERR_INTERNET_DISCONNECTED ||
net_error == net::ERR_NAME_RESOLUTION_FAILED;
}
bool IsServerGuaranteedToBeNotReachedYet(int net_error) {
return net_error == net::ERR_CONNECTION_REFUSED ||
net_error == net::ERR_ADDRESS_UNREACHABLE ||
net_error == net::ERR_TUNNEL_CONNECTION_FAILED ||
net_error == net::ERR_PROXY_CONNECTION_FAILED ||
net_error == net::ERR_SOCKS_CONNECTION_FAILED ||
net_error == net::ERR_NAME_NOT_RESOLVED ||
net_error == net::ERR_NAME_RESOLUTION_FAILED;
}
} // namespace
// A wrapper class around the target URLLoaderClient connected to Renderer,
// where the owning KeepAliveURLLoader forwards the network loading results to.
class KeepAliveURLLoader::ForwardingClient final
: public network::mojom::URLLoaderClient {
public:
ForwardingClient(
KeepAliveURLLoader* loader,
mojo::PendingRemote<network::mojom::URLLoaderClient> forwarding_client)
: keep_alive_url_loader_(std::move(loader)),
target_(std::move(forwarding_client)) {
CHECK(keep_alive_url_loader_);
// For FetchLater requests, `target_` is not bound to renderer.
if (target_) {
target_.set_disconnect_handler(base::BindOnce(
&ForwardingClient::OnDisconnected, base::Unretained(this)));
}
}
// Not copyable.
ForwardingClient(const ForwardingClient&) = delete;
ForwardingClient& operator=(const ForwardingClient&) = delete;
int32_t request_id() const { return keep_alive_url_loader_->request_id_; }
bool IsConnected() const { return !!target_; }
void OnDisconnected();
// network::mojom::URLLoaderClient overrides:
void OnReceiveEarlyHints(network::mojom::EarlyHintsPtr early_hints) override {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading",
"KeepAliveURLLoader::ForwardingClient::OnReceiveEarlyHints",
"request_id", request_id());
if (IsConnected()) {
// The renderer is alive, forwards the action.
target_->OnReceiveEarlyHints(std::move(early_hints));
return;
}
}
void OnUploadProgress(int64_t current_position,
int64_t total_size,
base::OnceCallback<void()> callback) override {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading",
"KeepAliveURLLoader::ForwardingClient::OnUploadProgress",
"request_id", request_id());
if (IsConnected()) {
// The renderer is alive, forwards the action.
target_->OnUploadProgress(current_position, total_size,
std::move(callback));
return;
}
}
void OnTransferSizeUpdated(int32_t transfer_size_diff) override {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading",
"KeepAliveURLLoader::ForwardingClient::OnTransferSizeUpdated",
"request_id", request_id());
if (IsConnected()) {
// The renderer is alive, forwards the action.
target_->OnTransferSizeUpdated(transfer_size_diff);
return;
}
}
void OnReceiveRedirect(const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr head) override {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CHECK(IsConnected());
target_->OnReceiveRedirect(redirect_info, std::move(head));
}
void OnReceiveResponse(
network::mojom::URLResponseHeadPtr head,
mojo::ScopedDataPipeConsumerHandle body,
std::optional<mojo_base::BigBuffer> cached_metadata) override {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CHECK(IsConnected());
target_->OnReceiveResponse(std::move(head), std::move(body),
std::move(cached_metadata));
}
void OnComplete(
const network::URLLoaderCompletionStatus& completion_status) override {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CHECK(IsConnected());
target_->OnComplete(completion_status);
}
private:
// Cannot be nullptr as it owns `this`.
const raw_ptr<KeepAliveURLLoader> keep_alive_url_loader_;
// The target where overridden the `network::mojom::URLLoaderClient` methods
// should forward to.
// Its receiver resides in the Renderer.
mojo::Remote<network::mojom::URLLoaderClient> target_;
};
// Stores the chain of redriects, response, and completion status, such that
// they can be forwarded to renderer after handled in browser first.
// See also `ForwardURLLoad()`.
struct KeepAliveURLLoader::StoredURLLoad {
StoredURLLoad() = default;
// Not copyable.
StoredURLLoad(const StoredURLLoad&) = delete;
StoredURLLoad& operator=(const StoredURLLoad&) = delete;
// Stores data for a redirect received from `OnReceiveRedirect()`.
struct RedirectData {
RedirectData(const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr response_head)
: info(redirect_info), head(std::move(response_head)) {}
// Not copyable.
RedirectData(const RedirectData&) = delete;
RedirectData& operator=(const RedirectData&) = delete;
// A copy of the RedirectInfo.
net::RedirectInfo info;
// The original URLResponseHead not yet passed to renderer.
network::mojom::URLResponseHeadPtr head;
};
// Stores data for a response received from `OnReceiveResponse()`.
struct ResponseData {
ResponseData(network::mojom::URLResponseHeadPtr response_head,
mojo::ScopedDataPipeConsumerHandle body_handle,
std::optional<mojo_base::BigBuffer> cached_metadata)
: head(std::move(response_head)),
body(std::move(body_handle)),
metadata(std::move(cached_metadata)) {}
// Not copyable.
ResponseData(const ResponseData&) = delete;
ResponseData& operator=(const ResponseData&) = delete;
// The original URLResponseHead not yet passed to renderer.
network::mojom::URLResponseHeadPtr head;
// The original body handle not yet passed to renderer.
mojo::ScopedDataPipeConsumerHandle body;
// The original cached metadata not yet passed to renderer.
std::optional<mojo_base::BigBuffer> metadata;
};
// Stores all intermediate redirect data received from `OnReceiveRedirect()`.
std::queue<std::unique_ptr<RedirectData>> redirects;
// Stores the response data received from `OnReceiveResponse()` for later use
// in renderer.
std::unique_ptr<ResponseData> response = nullptr;
// Stores the completion status received from `OnComplete()` for later use in
// renderer.
std::optional<network::URLLoaderCompletionStatus> completion_status =
std::nullopt;
// Tells whether any of the above field has been used (forwarded to renderer).
bool forwarding = false;
};
KeepAliveURLLoader::KeepAliveURLLoader(
int32_t request_id,
uint32_t options,
const network::ResourceRequest& resource_request,
mojo::PendingRemote<network::mojom::URLLoaderClient> forwarding_client,
const net::MutableNetworkTrafficAnnotationTag& traffic_annotation,
scoped_refptr<network::SharedURLLoaderFactory> network_loader_factory,
scoped_refptr<PolicyContainerHost> policy_container_host,
WeakDocumentPtr weak_document_ptr,
net::NetworkIsolationKey network_isolation_key,
std::optional<ukm::SourceId> ukm_source_id,
StoragePartitionImpl* storage_partition,
URLLoaderThrottlesGetter throttles_getter,
base::PassKey<KeepAliveURLLoaderService>,
std::unique_ptr<KeepAliveAttributionRequestHelper>
attribution_request_helper)
: request_id_(request_id),
devtools_request_id_(base::UnguessableToken::Create().ToString()),
options_(options),
resource_request_(resource_request),
forwarding_client_(
std::make_unique<ForwardingClient>(this,
std::move(forwarding_client))),
traffic_annotation_(net::NetworkTrafficAnnotationTag(traffic_annotation)),
network_loader_factory_(std::move(network_loader_factory)),
stored_url_load_(std::make_unique<StoredURLLoad>()),
policy_container_host_(std::move(policy_container_host)),
weak_document_ptr_(std::move(weak_document_ptr)),
network_isolation_key_(network_isolation_key),
ukm_source_id_(ukm_source_id),
request_tracker_(
GetContentClient()->browser()->MaybeCreateKeepAliveRequestTracker(
resource_request,
ukm_source_id,
base::BindRepeating(&KeepAliveURLLoader::IsContextDetached,
// `this` owns `request_tracker_`, so it is
// safe to use.
base::Unretained(this)))),
storage_partition_(storage_partition),
initial_url_(resource_request.url),
last_url_(resource_request.url),
throttles_getter_(throttles_getter),
attribution_request_helper_(std::move(attribution_request_helper)) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CHECK(network_loader_factory_);
CHECK(policy_container_host_);
CHECK(!resource_request.trusted_params);
CHECK(storage_partition_);
TRACE_EVENT("loading", "KeepAliveURLLoader::KeepAliveURLLoader", "request_id",
request_id_, "url", last_url_);
TRACE_EVENT_NESTABLE_ASYNC_BEGIN1("loading", "KeepAliveURLLoader",
request_id_, "url", last_url_);
original_resource_request_ = resource_request_;
LogFetchKeepAliveRequestMetric("Total");
if (IsFetchLater()) {
base::UmaHistogramBoolean("FetchLater.Browser.Total", true);
}
}
void KeepAliveURLLoader::Start() {
StartInternal(/*is_retry=*/false);
}
void KeepAliveURLLoader::StartInternal(bool is_retry) {
CHECK(!is_started_ || is_retry);
TRACE_EVENT("loading", "KeepAliveURLLoader::Start", "request_id",
request_id_);
is_started_ = true;
if (!is_retry) {
first_request_start_time_ = base::TimeTicks::Now();
}
LogFetchKeepAliveRequestMetric(is_retry ? "Retried" : "Started");
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::kRequestStarted);
}
if (IsFetchLater()) {
if (is_retry) {
base::UmaHistogramBoolean("FetchLater.Browser.Total.Retried", true);
} else {
base::UmaHistogramBoolean("FetchLater.Browser.Total.Started", true);
}
// Logs to DevTools only if the initiator is still alive.
if (RenderFrameHostImpl* rfh = GetInitiator(); rfh) {
devtools_instrumentation::OnFetchKeepAliveRequestWillBeSent(
rfh->frame_tree_node(), devtools_request_id_, resource_request_);
}
}
GetContentClient()->browser()->OnKeepaliveRequestStarted(
storage_partition_->browser_context());
// Asks the network service to create a URL loader with passed in params.
url_loader_ = blink::ThrottlingURLLoader::CreateLoaderAndStart(
network_loader_factory_, throttles_getter_.Run(), request_id_, options_,
&resource_request_, forwarding_client_.get(),
is_retry ? kKeepAliveRetryAnnotationTag : traffic_annotation_,
base::SingleThreadTaskRunner::GetCurrentDefault(),
/*cors_exempt_header_list=*/std::nullopt,
// `this`'s lifetime is at least the same as `url_loader_`.
/*client_receiver_delegate=*/this);
// `url_loader_` now re-runs a subset of throttles that have been run
// in renderer, which is necessary to handle in-browser redirects.
// There is already a similar use case that also runs throttles in browser in
// `SearchPrefetchRequest::StartPrefetchRequest()`. The review discussion in
// https://crrev.com/c/2552723/3 suggests that running them again in browser
// is fine.
}
KeepAliveURLLoader::~KeepAliveURLLoader() {
TRACE_EVENT("loading", "KeepAliveURLLoader::~KeepAliveURLLoader",
"request_id", request_id_);
TRACE_EVENT_NESTABLE_ASYNC_END0("loading", "KeepAliveURLLoader", request_id_);
// Allows logging to start as early as possible.
request_tracker_.reset();
disconnected_loader_timer_.Stop();
if (IsStarted()) {
GetContentClient()->browser()->OnKeepaliveRequestFinished();
}
}
void KeepAliveURLLoader::set_on_delete_callback(
OnDeleteCallback on_delete_callback) {
on_delete_callback_ = std::move(on_delete_callback);
}
void KeepAliveURLLoader::set_check_retry_eligibility_callback(
CheckRetryEligibilityCallback check_retry_eligibility_callback) {
check_retry_eligibility_callback_ =
std::move(check_retry_eligibility_callback);
}
void KeepAliveURLLoader::set_on_retry_scheduled_callback(
OnRetryScheduledCallback on_retry_scheduled_callback) {
on_retry_scheduled_callback_ = std::move(on_retry_scheduled_callback);
}
base::WeakPtr<KeepAliveURLLoader> KeepAliveURLLoader::GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
bool KeepAliveURLLoader::IsStarted() const {
return is_started_;
}
bool KeepAliveURLLoader::IsAttemptingRetry(bool include_failed_retry) const {
return retry_state_ != RetryState::kNotAttemptingRetry &&
(include_failed_retry || retry_state_ != RetryState::kRetryFailed);
}
RenderFrameHostImpl* KeepAliveURLLoader::GetInitiator() const {
return static_cast<RenderFrameHostImpl*>(
weak_document_ptr_.AsRenderFrameHostIfValid());
}
bool KeepAliveURLLoader::IsContextDetached() const {
return !GetInitiator();
}
void KeepAliveURLLoader::FollowRedirect(
const std::vector<std::string>& removed_headers,
const net::HttpRequestHeaders& modified_headers,
const net::HttpRequestHeaders& modified_cors_exempt_headers,
const std::optional<GURL>& new_url) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::FollowRedirect", "request_id",
request_id_, "url", new_url);
if (new_url != std::nullopt) {
mojo::ReportBadMessage(
"Unexpected `new_url` in KeepAliveURLLoader::FollowRedirect(): "
"must be null");
return;
}
if (IsRendererConnected()) {
// Continue forwarding the stored data to renderer.
// Note: we may or may not have response at this point.
ForwardURLLoad();
// DO NOT touch any members after this line. `this` may be already deleted
// if `OnComplete()` has been triggered.
return;
}
// No need to forward anymore as the target renderer is gone.
DeleteSelf();
// DO NOT touch any members after this line. `this` is deleted.
}
void KeepAliveURLLoader::SetPriority(net::RequestPriority priority,
int intra_priority_value) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::SetPriority", "request_id",
request_id_);
// Let `url_loader_` handles how to forward the action to the network service.
url_loader_->SetPriority(priority, intra_priority_value);
}
void KeepAliveURLLoader::EndReceiveRedirect(
const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr head) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
did_encounter_redirect_ = true;
CHECK_GT(redirect_limit_, 0u);
if (--redirect_limit_ == 0) {
// Don't process the redirect if we've reached our limit.
OnComplete(network::URLLoaderCompletionStatus(net::ERR_TOO_MANY_REDIRECTS));
return;
}
TRACE_EVENT("loading", "KeepAliveURLLoader::EndReceiveRedirect", "request_id",
request_id_);
if (request_tracker_) {
// Note: redirect may have been cancelled by throttle before reaching here.
request_tracker_->AdvanceToNextStage(
request_tracker_->GetNextRedirectStageType());
}
// Throttles from content-embedder has already been run for this redirect.
// See also the call sequence from renderer:
// https://docs.google.com/document/d/1ZzxMMBvpqn8VZBZKnb7Go8TWjnrGcXuLS_USwVVRUvY/edit?pli=1#heading=h.d006i46pmq9
if (IsFetchLater()) {
// Logs to DevTools only if the initiator is still alive.
if (auto* rfh = GetInitiator(); rfh) {
auto redirect_head_info = network::ExtractDevToolsInfo(*head);
std::pair<const GURL&, const network::mojom::URLResponseHeadDevToolsInfo&>
redirect_info_for_devtools{last_url_, *redirect_head_info};
devtools_instrumentation::OnFetchKeepAliveRequestWillBeSent(
rfh->frame_tree_node(), devtools_request_id_, resource_request_,
redirect_info_for_devtools);
}
}
scoped_refptr<net::HttpResponseHeaders> headers = head->headers;
// Stores the redirect data for later use by renderer.
stored_url_load_->redirects.emplace(
std::make_unique<StoredURLLoad::RedirectData>(redirect_info,
std::move(head)));
// Runs additional redirect checks before proceeding.
if (net::Error err = WillFollowRedirect(redirect_info); err != net::OK) {
OnComplete(network::URLLoaderCompletionStatus(err));
return;
}
if (attribution_request_helper_) {
attribution_request_helper_->OnReceiveRedirect(headers,
redirect_info.new_url);
}
// TODO(crbug.com/40236167): Figure out how to deal with lost
// ResourceFetcher's counter & dev console logging (renderer is dead).
resource_request_.url = redirect_info.new_url;
resource_request_.site_for_cookies = redirect_info.new_site_for_cookies;
resource_request_.referrer = GURL(redirect_info.new_referrer);
resource_request_.referrer_policy = redirect_info.new_referrer_policy;
// Ask the network service to follow the redirect.
last_url_ = GURL(redirect_info.new_url);
// TODO(crbug.com/40880984): Remove Authorization header upon cross-origin
// redirect.
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnReceiveRedirectProcessed(this);
}
// Asks `url_loader_` to directly forward the action to the network service.
// The modified headers are stored there, if exists.
//
// Note: there may be throttles running in IO thread, which may send signals
// in between `FollowRedirect()` and the next `OnReceiveRedirect()` or
// `OnReceiveResponse()`.
url_loader_->FollowRedirect(
/*removed_headers=*/{}, /*modified_headers=*/{},
/*modified_cors_exempt_headers=*/{});
}
void KeepAliveURLLoader::OnReceiveResponse(
network::mojom::URLResponseHeadPtr response,
mojo::ScopedDataPipeConsumerHandle body,
std::optional<mojo_base::BigBuffer> cached_metadata) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::OnReceiveResponse", "request_id",
request_id_, "url", last_url_);
LogFetchKeepAliveRequestMetric("Succeeded");
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::kResponseReceived);
}
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnReceiveResponse(this);
}
if (IsFetchLater()) {
// Logs to DevTools only if the initiator is still alive.
if (auto* rfh = GetInitiator(); rfh) {
devtools_instrumentation::OnFetchKeepAliveResponseReceived(
rfh->frame_tree_node(), devtools_request_id_, last_url_, *response);
}
}
if (attribution_request_helper_) {
attribution_request_helper_->OnReceiveResponse(response->headers.get());
attribution_request_helper_.reset();
}
// In case the renderer is alive, the stored response data will be forwarded
// at the end of `ForwardURLLoad()`.
stored_url_load_->response = std::make_unique<StoredURLLoad::ResponseData>(
std::move(response), std::move(body), std::move(cached_metadata));
if (IsRendererConnected()) {
// Starts to forward the stored redirects/response to renderer.
// Note that `OnComplete()` may be triggered in between the forwarding.
ForwardURLLoad();
// DO NOT touch any members after this line. `this` may be already deleted
// if `OnComplete()` has been triggered.
return;
}
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnReceiveResponseProcessed(this);
}
// When reaching here, the loader counterpart in renderer is already
// disconnected before receiving response. However, the renderer may still be
// alive, and waiting for DevTools logger to finish with `OnComplete()`. For
// examples:
// 1. Calling fetchLater(url, {activateAfter: 0}) will immediately dispose
// renderer loader, which is independent of renderer lifetime and requires
// OnComplete().
// 2. Calling fetch(url, {keepalive: true}) in unload may lead to disconnected
// renderer loader + dead renderer, which requires no OnComplete().
//
// Only for case 1, we want to wait for a limited time to allow `OnComplete()`
// to trigger, but also prevents this loader from staying alive indefinitely.
if (IsFetchLater() && !disconnected_loader_timer_.IsRunning()) {
disconnected_loader_timer_.Start(
FROM_HERE, GetDisconnectedKeepAliveURLLoaderTimeout(),
base::BindOnce(&KeepAliveURLLoader::OnDisconnectedLoaderTimerFired,
// `this` owns `disconnected_loader_timer_`.
base::Unretained(this)));
return;
}
// Otherwise, no need to wait for `OnComplete()`.
// This loader should be deleted immediately to avoid hanged requests taking
// up resources.
DeleteSelf();
// DO NOT touch any members after this line. `this` is already deleted.
}
void KeepAliveURLLoader::NotifyOnCompleteForTestAndDevTools(
const network::URLLoaderCompletionStatus& completion_status) {
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnComplete(this, completion_status);
}
if (IsFetchLater()) {
// Logs to DevTools only if the initiator is still alive.
if (RenderFrameHostImpl* rfh = GetInitiator(); rfh) {
devtools_instrumentation::OnFetchKeepAliveRequestComplete(
rfh->frame_tree_node(), devtools_request_id_, completion_status);
}
}
}
void KeepAliveURLLoader::OnComplete(
const network::URLLoaderCompletionStatus& completion_status) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::OnComplete", "request_id",
request_id_);
if (IsAttemptingRetry(/*include_failed_retry=*/false)) {
retry_state_ = RetryState::kRetryFailed;
}
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::kLoaderCompleted,
completion_status);
}
if (completion_status.error_code != net::OK) {
// If the request succeeds, it should've been logged in `OnReceiveResponse`.
LogFetchKeepAliveRequestMetric("Failed");
if (RetryOrDelayErrorIfNeeded(
completion_status,
base::BindOnce(&KeepAliveURLLoader::OnCompleteInternal,
// `this` owns `max_age_handler_timer_`.
base::Unretained(this), completion_status))) {
// Retry or delayed error processing is scheduled. Don't process the
// cancellation at this time, but still notify test observers and
// devtools.
NotifyOnCompleteForTestAndDevTools(completion_status);
return;
}
}
NotifyOnCompleteForTestAndDevTools(completion_status);
OnCompleteInternal(completion_status);
}
void KeepAliveURLLoader::OnCompleteInternal(
const network::URLLoaderCompletionStatus& completion_status) {
// Note that we don't need to reset the attribution helper if we retry.
if (completion_status.error_code != net::OK) {
if (attribution_request_helper_) {
attribution_request_helper_->OnError();
attribution_request_helper_.reset();
}
}
// In case the renderer is alive, the stored status will be forwarded
// at the end of `ForwardURLLoad()`.
stored_url_load_->completion_status = completion_status;
if (IsRendererConnected()) {
if (HasReceivedResponse()) {
// Do nothing. `completion_status` will be forwarded at the end of
// `ForwardURLLoad()`.
return;
}
// Either (1) an error happens in between redirect handling in browser, or
// (2) the redirects and response have all been forwarded.
// Starts forwarding stored redirects and the completion status to renderer.
ForwardURLLoad();
// DO NOT touch any members after this line. `this` is already deleted.
return;
}
// TODO(crbug.com/40236167): Handle in the browser process.
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnCompleteProcessed(this, completion_status);
}
DeleteSelf();
// DO NOT touch any members after this line. `this` is already deleted.
}
size_t KeepAliveURLLoader::GetMaxAttemptsForRetry() const {
CHECK(resource_request_.fetch_retry_options.has_value());
return std::min(
features::kMaxRetryCount.Get(),
static_cast<size_t>(resource_request_.fetch_retry_options->max_attempts));
}
base::TimeDelta KeepAliveURLLoader::GetMaxAgeForRetry() const {
CHECK(resource_request_.fetch_retry_options.has_value());
if (!resource_request_.fetch_retry_options->max_age.has_value()) {
return features::kMaxRetryAge.Get();
}
return std::min(features::kMaxRetryAge.Get(),
resource_request_.fetch_retry_options->max_age.value());
}
base::TimeDelta KeepAliveURLLoader::GetInitialTimeDeltaForRetry() const {
CHECK(resource_request_.fetch_retry_options.has_value());
if (!resource_request_.fetch_retry_options->initial_delay.has_value()) {
return features::kMinRetryDelta.Get();
}
return std::max(features::kMinRetryDelta.Get(),
resource_request_.fetch_retry_options->initial_delay.value());
}
double KeepAliveURLLoader::GetBackoffFactorForRetry() const {
CHECK(resource_request_.fetch_retry_options.has_value());
if (!resource_request_.fetch_retry_options->backoff_factor.has_value()) {
return features::kMinRetryBackoffFactor.Get();
}
return std::max(
features::kMinRetryBackoffFactor.Get(),
resource_request_.fetch_retry_options->backoff_factor.value());
}
base::TimeDelta KeepAliveURLLoader::UpdateNextRetryDelay() {
if (last_retry_delay_ == base::TimeDelta()) {
last_retry_delay_ = GetInitialTimeDeltaForRetry();
} else {
last_retry_delay_ *= GetBackoffFactorForRetry();
}
return last_retry_delay_;
}
bool KeepAliveURLLoader::IsEligibleForRetry(
std::optional<network::URLLoaderCompletionStatus> completion_status) const {
auto retry_options = resource_request_.fetch_retry_options;
if (!retry_options.has_value()) {
// The fetch must opt-in to retry.
return false;
}
// Don't retry if it's not HTTPs, there's already a retry scheduled, or we're
// over the limit.
if (!resource_request_.url.SchemeIs(url::kHttpsScheme) ||
retry_state_ == RetryState::kRetryScheduled ||
retry_state_ == RetryState::kWaitingForSameNetworkIsolationKeyDocument ||
retry_count_ >= GetMaxAttemptsForRetry() ||
(first_request_start_time_ != base::TimeTicks() &&
base::TimeTicks::Now() - first_request_start_time_ >
GetMaxAgeForRetry())) {
return false;
}
if (!retry_options->retry_non_idempotent &&
!net::HttpUtil::IsMethodIdempotent(resource_request_.method)) {
// Don't retry non-idempotent method unless the fetch explicitly opted-in to
// do so.
return false;
}
if (!retry_options->retry_after_unload && IsContextDetached()) {
return false;
}
CHECK(!check_retry_eligibility_callback_.is_null());
if (!check_retry_eligibility_callback_.Run()) {
return false;
}
if (HasReceivedResponse()) {
// If we've previously received and stored a response from the server, we
// can't hold on to the response pipe for too long because it might congest
// the network. So, just give up from retrying in this case.
return false;
}
if (!completion_status.has_value()) {
// No completion status. This can only happen when we hit the renderer
// disconnect timeout before getting any results. The request should be
// eligible to retry, except if explicitly opting in to retry only if the
// server is guaranteed to be not reached yet. We can't guarantee that in
// this case, because we don't know if the server has been reached yet or
// not.
return !retry_options->retry_only_if_server_unreached;
}
if (completion_status->resolve_error_info.is_secure_network_error) {
// Don't retry if the error was a secure DNS network error,
// since the retry may interfere with the captive portal probe state.
// TODO(crbug.com/40104002): Explore how to allow retries for secure
// DNS network errors without interfering with the captive portal
// probe state.
return false;
}
if (retry_options->retry_only_if_server_unreached) {
// Only retry in this case if we've never encountered redirect yet (since if
// we've been redirected, we must have reached the redirector server
// before), and the error indicates that the server is not reached yet.
return !did_encounter_redirect_ &&
IsServerGuaranteedToBeNotReachedYet(completion_status->error_code);
}
return IsNetErrorEligibleForRetry(completion_status->error_code);
}
bool KeepAliveURLLoader::MaybeScheduleRetry(
std::optional<network::URLLoaderCompletionStatus> completion_status) {
if (!IsEligibleForRetry(completion_status)) {
return false;
}
// We can retry. Reset the URLLoader to avoid scheduling another retry if we
// received another error signal after this (e.g. OnComplete with error
// happened, then the disconnection triggers CancelWithStatus).
url_loader_.reset();
// Set a timer to delete self when the max age has been reached. Note that
// we check if the timer is already set here, because it could've been set
// already by a previous retry attempt (so there's no use to set it again),
// or it was already set to process an error we encountered in a past attempt
// (which should still be kept, in case this retry attempt went past max
// age, at which point we should still send that latest error).
if (!max_age_handler_timer_.IsRunning()) {
base::TimeDelta current_age =
(base::TimeTicks::Now() - first_request_start_time_);
max_age_handler_timer_.Start(
FROM_HERE, GetMaxAgeForRetry() - current_age,
base::BindOnce(&KeepAliveURLLoader::DeleteSelf,
// `this` owns `max_age_handler_timer_`.
base::Unretained(this)));
}
// Update the retry-tracking states. Note that there's no need to reset any
// of the actual request-related state, since the retry is attempted from the
// last request attempt, and no state has been updated in response of the
// failed result yet. All states relating to previous attempts (e.g. stored
// loads storing previous redirects) only contain results from successful
// redirects/responses so there's no need to reset.
retry_count_++;
CHECK_LE(retry_count_, GetMaxAttemptsForRetry());
retry_state_ = RetryState::kRetryScheduled;
// Schedule the retry.
retry_timer_.Start(FROM_HERE, UpdateNextRetryDelay(),
base::BindOnce(&KeepAliveURLLoader::AttemptRetryIfAllowed,
base::Unretained(this)));
CHECK(!on_retry_scheduled_callback_.is_null());
on_retry_scheduled_callback_.Run();
return true;
}
void KeepAliveURLLoader::AttemptRetryIfAllowed() {
if (retry_state_ == RetryState::kRetryFailed) {
return;
}
CHECK(retry_state_ == RetryState::kRetryScheduled ||
retry_state_ == RetryState::kWaitingForSameNetworkIsolationKeyDocument);
// Don't retry when there's no active document with a same network isolation
// key as the initiator of the load, to avoid privacy concerns of revealing
// information about the user (that their browser is up, and their current
// IP address) to the destination origin, while there is no active document.
if (!storage_partition_->GetActiveDocumentCount(network_isolation_key_)) {
// No active document with the same NetworkIsolationKey exists. Wait until
// we see such a document, or delete ourselves when we can't attempt a retry
// anymore (we reached the max age of retries, which will run self-deletion
// when we first scheduled the retry attempt).
retry_state_ = RetryState::kWaitingForSameNetworkIsolationKeyDocument;
return;
}
// TODO(crbug.com/417930271): Check if we're offline, and if so, wait until
// we're online before attempting.
retry_state_ = RetryState::kRetryInProgress;
// Reset the request IDs.
request_id_ = GlobalRequestID::MakeBrowserInitiated().request_id;
devtools_request_id_ = base::UnguessableToken::Create().ToString();
// Retry using the original request, even if the failure happens after
// redirects.
resource_request_ = original_resource_request_;
// TODO(crbug.com/417930271): Track the retry as a state in the
// KeepAliveRequestTracker too.
request_tracker_ =
GetContentClient()->browser()->MaybeCreateKeepAliveRequestTracker(
resource_request_, ukm_source_id_,
base::BindRepeating(&KeepAliveURLLoader::IsContextDetached,
// `this` owns `request_tracker_`, so it is
// safe to use.
base::Unretained(this)));
StartInternal(/*is_retry=*/true);
}
void KeepAliveURLLoader::DidObserveNewlyActiveDocumentWithNIK(
const net::NetworkIsolationKey& nik) {
if (nik == network_isolation_key_ &&
retry_state_ == RetryState::kWaitingForSameNetworkIsolationKeyDocument) {
// We previously wanted to retry but couldn't due to there being no active
// document with the same Network Isolation Key. Now that we observe such a
// document, we can attempt the retry.
retry_state_ = RetryState::kRetryScheduled;
GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(&KeepAliveURLLoader::AttemptRetryIfAllowed,
base::Unretained(this)));
}
}
bool KeepAliveURLLoader::HasReceivedResponse() const {
return stored_url_load_ && stored_url_load_->response != nullptr;
}
void KeepAliveURLLoader::ForwardURLLoad() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CHECK(IsRendererConnected());
CHECK(stored_url_load_);
// Don't delete self if we need to forward response to the renderer. This is
// ok since it's either not an error, or we've already reached max age and are
// forwarding the errors.
max_age_handler_timer_.Stop();
// Forwards the redirects/response/completion in the exact sequence.
stored_url_load_->forwarding = true;
if (!stored_url_load_->redirects.empty()) {
// All redirects have been handled in the browser. However, redirects must
// also be processed by the renderer so that it knows what URL the
// response come from when parsing the response.
//
// Note: The renderer might get shut down before
// `forwarding_client_->OnReceiveRedirect()` finish all redirect handling.
// In such case, the handling will be taken over by browser from
// `OnRendererConnectionError()`.
forwarding_client_->OnReceiveRedirect(
stored_url_load_->redirects.front()->info,
std::move(stored_url_load_->redirects.front()->head));
stored_url_load_->redirects.pop();
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnReceiveRedirectForwarded(this);
}
// The rest of `stored_url_load_->redirects` will be forwarded in the next
// visit to this method when `FollowRedirect()` is called by the renderer.
return;
}
if (stored_url_load_->response) {
// Note: The receiver may fail to finish reading the entire
// `stored_url_load_->response`response`, so response caching is not
// guaranteed.
// Note: The renderer might get shut down before
// `forwarding_client_->OnReceiveResponse()` finish response handling.
// In such case, the attributionsrc handling cannot be dropped and should be
// taken over by browser in `OnRendererConnectionError().
forwarding_client_->OnReceiveResponse(
std::move(stored_url_load_->response->head),
std::move(stored_url_load_->response->body),
std::move(stored_url_load_->response->metadata));
stored_url_load_->response = nullptr;
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnReceiveResponseForwarded(this);
}
}
if (stored_url_load_->completion_status.has_value()) {
forwarding_client_->OnComplete(*(stored_url_load_->completion_status));
if (observer_for_testing_) {
CHECK_IS_TEST();
observer_for_testing_->OnCompleteForwarded(
this, *(stored_url_load_->completion_status));
}
stored_url_load_ = nullptr;
DeleteSelf();
// DO NOT touch any members after this line. `this` is already deleted.
}
}
bool KeepAliveURLLoader::IsForwardURLLoadStarted() const {
return stored_url_load_ && stored_url_load_->forwarding;
}
bool KeepAliveURLLoader::IsRendererConnected() const {
CHECK(forwarding_client_);
return forwarding_client_->IsConnected();
}
net::Error KeepAliveURLLoader::WillFollowRedirect(
const net::RedirectInfo& redirect_info) const {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
// TODO(crbug.com/40236167): Add logic to handle redirecting to extensions
// from `ChromeContentRendererClient::IsSafeRedirectTarget()`.
if (!IsSafeRedirectTarget(last_url_, redirect_info.new_url)) {
return net::ERR_UNSAFE_REDIRECT;
}
if (resource_request_.redirect_mode == network::mojom::RedirectMode::kError) {
return net::ERR_FAILED;
}
if (resource_request_.redirect_mode !=
network::mojom::RedirectMode::kManual) {
// Checks if redirecting to `redirect_info.new_url` is allowed by
// ContentSecurityPolicy from the request initiator document.
if (!IsRedirectAllowedByCSP(
policy_container_host_->policies().content_security_policies,
redirect_info.new_url, initial_url_, last_url_ != initial_url_)) {
return net::ERR_BLOCKED_BY_CSP;
}
// Checks if redirecting to `redirect_info.new_url` is allowed by
// MixedContent checker.
// TODO(crbug.com/40941240): Figure out how to check without a frame.
if (auto* rfh = GetInitiator();
rfh && MixedContentChecker::ShouldBlockFetchKeepAlive(
rfh, redirect_info.new_url,
/*for_redirect=*/true)) {
return net::ERR_FAILED;
}
}
return net::OK;
}
bool KeepAliveURLLoader::RetryOrDelayErrorIfNeeded(
const network::URLLoaderCompletionStatus& status,
base::OnceClosure closure) {
auto retry_options = resource_request_.fetch_retry_options;
if (!retry_options.has_value()) {
// Ignore fetches that do not opt-in to retry.
return false;
}
// Schedule retry if needed.
if (MaybeScheduleRetry(status)) {
return true;
}
base::TimeDelta current_age =
(base::TimeTicks::Now() - first_request_start_time_);
if (IsRendererConnected() && current_age < GetMaxAgeForRetry()) {
// A retry is not attempted, but we can only notify the renderer about the
// error when we reach the max age, to avoid exposing information about the
// error through timing. Note that we only do this when the renderer is
// still connected and waiting for the error info. If the renderer is
// already disconnected, we can just continue processing the error and free
// up resources by deleting ourself. Note also that this will replace the
// previous action set in the timer (which is either to send the error from
// a previous attempt, or to delete self, which should not take precedent
// over this).
max_age_handler_timer_.Start(FROM_HERE, GetMaxAgeForRetry() - current_age,
std::move(closure));
// Reset the URLLoader to avoid receiving another error signal after this
// (e.g. OnComplete with error happened, then the disconnection triggers
// CancelWithStatus).
url_loader_.reset();
return true;
}
return false;
}
void KeepAliveURLLoader::CancelWithStatus(
const network::URLLoaderCompletionStatus& status) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::CancelWithStatus", "request_id",
request_id_);
if (IsAttemptingRetry(/*include_failed_retry=*/false)) {
retry_state_ = RetryState::kRetryFailed;
}
if (!stored_url_load_->completion_status.has_value()) {
// Only logs if there is no error logged by `OnComplete()` yet.
LogFetchKeepAliveRequestMetric("Failed");
}
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::kRequestFailed, status);
}
if (RetryOrDelayErrorIfNeeded(
status, base::BindOnce(&KeepAliveURLLoader::CancelWithStatusInternal,
// `this` owns `max_age_handler_timer_`.
base::Unretained(this), status))) {
// Retry or delayed error processing is scheduled. Don't process the
// cancellation at this time.
return;
}
CancelWithStatusInternal(status);
}
void KeepAliveURLLoader::CancelWithStatusInternal(
const network::URLLoaderCompletionStatus& status) {
// This method can be triggered when one of the followings happen:
// 1. Network -> `url_loader_` gets disconnected.
// 2. `url_loader_` gets cancelled by throttles.
// 3. `url_loader_` terminates itself.
if (IsRendererConnected()) {
if (!IsForwardURLLoadStarted()) {
// The loader is cancelled before this loader forwards anything to
// renderer. It should make an ateempt to forward any previous loads.
ForwardURLLoad();
// DO NOT touch any members after this line. `this` may be deleted.
return;
}
// Otherwise, let `ForwardURLLoad()` continue forwarding the rest.
return;
}
// We should let the renderer know it's closed by deleting `this`.
DeleteSelf();
// DO NOT touch any members after this line. `this` is already deleted.
}
// Browser -> Renderer connection
void KeepAliveURLLoader::ForwardingClient::OnDisconnected() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::ForwardingClient::OnDisconnected",
"request_id", request_id());
// Dropping the client as renderer is gone.
target_.reset();
if (!keep_alive_url_loader_->IsForwardURLLoadStarted() &&
!keep_alive_url_loader_->HasReceivedResponse()) {
// The renderer disconnects before this loader forwards anything to it.
// But the in-browser request processing may not complete yet.
// TODO(crbug.com/40259706): Ensure that attributionsrc response handling is
// taken over by browser.
return;
}
// Renderer disconnects in-between forwarding, no need to call
// `ForwardURLLoad()` anymore.
keep_alive_url_loader_->DeleteSelf();
// DO NOT touch any members after this line. `this` is already deleted.
}
// Browser <- Renderer connection.
void KeepAliveURLLoader::OnURLLoaderDisconnected() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
TRACE_EVENT("loading", "KeepAliveURLLoader::OnURLLoaderDisconnected",
"request_id", request_id_);
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::
kLoaderDisconnectedFromRenderer);
}
if (!IsStarted()) {
// May be the last chance to start a deferred loader.
LogFetchLaterMetric(
FetchLaterBrowserMetricType::kStartedAfterInitiatorDisconnected);
Start();
}
// For other types of keepalive requests, this loader does not care about
// whether messages can be received from renderer or not.
// Prevents this loader from staying alive indefinitely.
if (!disconnected_loader_timer_.IsRunning()) {
disconnected_loader_timer_.Start(
FROM_HERE, GetDisconnectedKeepAliveURLLoaderTimeout(),
base::BindOnce(&KeepAliveURLLoader::OnDisconnectedLoaderTimerFired,
// `this` owns `disconnected_loader_timer_`.
base::Unretained(this)));
}
}
void KeepAliveURLLoader::OnDisconnectedLoaderTimerFired() {
if (IsAttemptingRetry(/*include_failed_retry=*/false)) {
retry_state_ = RetryState::kRetryFailed;
}
if (resource_request_.fetch_retry_options.has_value() &&
resource_request_.fetch_retry_options->retry_after_unload &&
(IsAttemptingRetry(/*include_failed_retry=*/false) ||
MaybeScheduleRetry(/*completion_status=*/std::nullopt))) {
// A retry is already pending or we just scheduled a retry. Don't delete
// the loader, and instead keep it around for the retry.
return;
}
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::
kRequestCancelledAfterTimeLimit);
}
if (IsFetchLater()) {
LogFetchLaterMetric(FetchLaterBrowserMetricType::kCancelledAfterTimeLimit);
}
DeleteSelf();
}
void KeepAliveURLLoader::Shutdown() {
base::UmaHistogramBoolean(
"FetchKeepAlive.Requests2.Shutdown.IsStarted.Browser", IsStarted());
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::kBrowserShutdown);
}
if (!IsStarted()) {
CHECK(IsFetchLater());
LogFetchLaterMetric(FetchLaterBrowserMetricType::kStartedWhenShutdown);
// At this point, browser is shutting down, and renderer termination has not
// reached browser. It is the last chance to start loading the request from
// here.
Start();
}
}
bool KeepAliveURLLoader::IsFetchLater() const {
return base::FeatureList::IsEnabled(blink::features::kFetchLaterAPI) &&
resource_request_.is_fetch_later_api;
}
void KeepAliveURLLoader::SendNow() {
if (!IsFetchLater()) {
mojo::ReportBadMessage("Unexpected call to KeepAliveURLLoader::SendNow()");
return;
}
LogFetchLaterMetric(FetchLaterBrowserMetricType::kStartedByInitiator);
if (!IsStarted()) {
Start();
}
}
void KeepAliveURLLoader::Cancel() {
if (!IsFetchLater()) {
mojo::ReportBadMessage("Unexpected call to KeepAliveURLLoader::Cancel()");
return;
}
if (request_tracker_) {
request_tracker_->AdvanceToNextStage(
KeepAliveRequestTracker::RequestStageType::kRequestCancelledByRenderer);
}
LogFetchLaterMetric(FetchLaterBrowserMetricType::kAbortedByInitiator);
DeleteSelf();
}
void KeepAliveURLLoader::DeleteSelf() {
CHECK(on_delete_callback_);
std::move(on_delete_callback_).Run();
}
void KeepAliveURLLoader::SetObserverForTesting(
scoped_refptr<TestObserver> observer) {
observer_for_testing_ = observer;
}
void KeepAliveURLLoader::LogFetchKeepAliveRequestMetric(
std::string_view request_state_name) {
if (IsFetchLater()) {
return;
}
auto resource_type =
static_cast<blink::mojom::ResourceType>(resource_request_.resource_type);
FetchKeepAliveRequestMetricType sample_type;
// See also blink::PopulateResourceRequest().
switch (resource_type) {
case blink::mojom::ResourceType::kXhr:
sample_type = FetchKeepAliveRequestMetricType::kFetch;
break;
// Includes BEACON/PING/ATTRIBUTION_SRC types
case blink::mojom::ResourceType::kPing:
sample_type = FetchKeepAliveRequestMetricType::kPing;
break;
case blink::mojom::ResourceType::kCspReport:
sample_type = FetchKeepAliveRequestMetricType::kReporting;
break;
case blink::mojom::ResourceType::kImage:
sample_type = FetchKeepAliveRequestMetricType::kBackgroundFetchIcon;
break;
case blink::mojom::ResourceType::kMainFrame:
case blink::mojom::ResourceType::kSubFrame:
case blink::mojom::ResourceType::kStylesheet:
case blink::mojom::ResourceType::kScript:
case blink::mojom::ResourceType::kFontResource:
case blink::mojom::ResourceType::kSubResource:
case blink::mojom::ResourceType::kObject:
case blink::mojom::ResourceType::kMedia:
case blink::mojom::ResourceType::kWorker:
case blink::mojom::ResourceType::kSharedWorker:
case blink::mojom::ResourceType::kPrefetch:
case blink::mojom::ResourceType::kFavicon:
case blink::mojom::ResourceType::kServiceWorker:
case blink::mojom::ResourceType::kPluginResource:
case blink::mojom::ResourceType::kNavigationPreloadMainFrame:
case blink::mojom::ResourceType::kNavigationPreloadSubFrame:
case blink::mojom::ResourceType::kJson:
NOTREACHED();
}
CHECK(request_state_name == "Total" || request_state_name == "Started" ||
request_state_name == "Retried" || request_state_name == "Succeeded" ||
request_state_name == "Failed");
base::UmaHistogramEnumeration(base::StrCat({"FetchKeepAlive.Requests2.",
request_state_name, ".Browser"}),
sample_type);
if (bool is_context_detached = !GetInitiator();
request_state_name == "Started" || request_state_name == "Succeeded") {
base::UmaHistogramBoolean(
base::StrCat({"FetchKeepAlive.Requests2.", request_state_name,
".IsContextDetached.Browser"}),
is_context_detached);
}
}
} // namespace content
|