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
|
// Copyright 2022 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/preloading/preloading_attempt_impl.h"
#include "base/containers/span.h"
#include "base/metrics/crc32.h"
#include "base/metrics/histogram_functions.h"
#include "base/state_transitions.h"
#include "base/strings/strcat.h"
#include "content/browser/preloading/preloading.h"
#include "content/browser/preloading/preloading_config.h"
#include "content/public/browser/preloading.h"
#include "services/metrics/public/cpp/metrics_utils.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "third_party/blink/public/common/features.h"
namespace content {
namespace {
void DCHECKTriggeringOutcomeTransitions(PreloadingTriggeringOutcome old_state,
PreloadingTriggeringOutcome new_state) {
#if DCHECK_IS_ON()
static const base::NoDestructor<
base::StateTransitions<PreloadingTriggeringOutcome>>
allowed_transitions(base::StateTransitions<PreloadingTriggeringOutcome>({
{PreloadingTriggeringOutcome::kUnspecified,
{PreloadingTriggeringOutcome::kDuplicate,
PreloadingTriggeringOutcome::kRunning,
PreloadingTriggeringOutcome::kReady,
PreloadingTriggeringOutcome::kSuccess,
PreloadingTriggeringOutcome::kFailure,
PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown,
PreloadingTriggeringOutcome::kTriggeredButUpgradedToPrerender,
PreloadingTriggeringOutcome::kTriggeredButPending,
PreloadingTriggeringOutcome::kNoOp}},
{PreloadingTriggeringOutcome::kDuplicate, {}},
{PreloadingTriggeringOutcome::kRunning,
{PreloadingTriggeringOutcome::kReady,
PreloadingTriggeringOutcome::kFailure,
PreloadingTriggeringOutcome::kTriggeredButUpgradedToPrerender}},
// It can be possible that the preloading attempt may end up failing
// after being ready to use, for cases where we have to cancel the
// attempt for performance and security reasons.
// The transition of kReady to kReady occurs when the main frame
// navigation is completed in a preloaded page.
{PreloadingTriggeringOutcome::kReady,
{PreloadingTriggeringOutcome::kReady,
PreloadingTriggeringOutcome::kSuccess,
PreloadingTriggeringOutcome::kFailure,
PreloadingTriggeringOutcome::kTriggeredButUpgradedToPrerender}},
{PreloadingTriggeringOutcome::kSuccess, {}},
{PreloadingTriggeringOutcome::kFailure, {}},
{PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown, {}},
{PreloadingTriggeringOutcome::kTriggeredButUpgradedToPrerender,
{PreloadingTriggeringOutcome::kFailure}},
{PreloadingTriggeringOutcome::kTriggeredButPending,
{PreloadingTriggeringOutcome::kRunning,
PreloadingTriggeringOutcome::kFailure}},
{PreloadingTriggeringOutcome::kNoOp, {}},
}));
DCHECK_STATE_TRANSITION(allowed_transitions,
/*old_state=*/old_state,
/*new_state=*/new_state);
#endif // DCHECK_IS_ON()
}
} // namespace
void PreloadingAttemptImpl::SetEligibility(PreloadingEligibility eligibility) {
// Ensure that eligiblity is only set once and that it's set before the
// holdback status and the triggering outcome.
CHECK_EQ(eligibility_, PreloadingEligibility::kUnspecified);
CHECK_EQ(holdback_status_, PreloadingHoldbackStatus::kUnspecified);
CHECK_EQ(triggering_outcome_, PreloadingTriggeringOutcome::kUnspecified);
CHECK_NE(eligibility, PreloadingEligibility::kUnspecified);
eligibility_ = eligibility;
}
// TODO(crbug.com/40275772): most call sites of this should be removed, as
// PreloadingConfig should subsume most feature-specific holdbacks that exist
// today. Some cases can remain as specific overrides of the PreloadingConfig
// logic, e.g. if DevTools is open, or for features that are still launching and
// thus have their own separate holdback feature while they ramp up.
void PreloadingAttemptImpl::SetHoldbackStatus(
PreloadingHoldbackStatus holdback_status) {
// Ensure that the holdback status is only set once and that it's set for
// eligible attempts and before the triggering outcome.
CHECK_EQ(eligibility_, PreloadingEligibility::kEligible);
CHECK_EQ(holdback_status_, PreloadingHoldbackStatus::kUnspecified);
CHECK_EQ(triggering_outcome_, PreloadingTriggeringOutcome::kUnspecified);
CHECK_NE(holdback_status, PreloadingHoldbackStatus::kUnspecified);
holdback_status_ = holdback_status;
}
bool PreloadingAttemptImpl::ShouldHoldback() {
CHECK_EQ(eligibility_, PreloadingEligibility::kEligible);
if (holdback_status_ != PreloadingHoldbackStatus::kUnspecified) {
// The holdback status has already been determined, just use that value.
return holdback_status_ == PreloadingHoldbackStatus::kHoldback;
}
bool should_holdback_due_to_preloading_config =
PreloadingConfig::GetInstance().ShouldHoldback(preloading_type_,
creating_predictor_);
bool should_holdback_due_to_autosr_holdback =
creating_predictor_ == content_preloading_predictor::
kSpeculationRulesFromAutoSpeculationRules &&
blink::features::kAutoSpeculationRulesHoldback.Get();
bool should_holdback = should_holdback_due_to_preloading_config ||
should_holdback_due_to_autosr_holdback;
if (should_holdback) {
holdback_status_ = PreloadingHoldbackStatus::kHoldback;
} else {
holdback_status_ = PreloadingHoldbackStatus::kAllowed;
}
return should_holdback;
}
void PreloadingAttemptImpl::SetTriggeringOutcome(
PreloadingTriggeringOutcome triggering_outcome) {
// Ensure that the triggering outcome is only set for eligible and
// non-holdback attempts.
CHECK_EQ(eligibility_, PreloadingEligibility::kEligible);
CHECK_EQ(holdback_status_, PreloadingHoldbackStatus::kAllowed);
// Check that we do the correct transition before setting
// `triggering_outcome_`.
DCHECKTriggeringOutcomeTransitions(/*old_state=*/triggering_outcome_,
/*new_state=*/triggering_outcome);
triggering_outcome_ = triggering_outcome;
// Set the ready time, if this attempt was not already ready.
switch (triggering_outcome_) {
// Currently only Prefetch, Prerender and NoStatePrefetch have a ready
// state. Other preloading features do not track the entire progress of the
// preloading attempt, where
// `PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown` is set for
// those other features.
case PreloadingTriggeringOutcome::kReady:
CHECK(preloading_type_ == PreloadingType::kPrefetch ||
preloading_type_ == PreloadingType::kPrerender ||
preloading_type_ == PreloadingType::kNoStatePrefetch ||
preloading_type_ == PreloadingType::kLinkPreview);
if (!ready_time_) {
ready_time_ = elapsed_timer_.Elapsed();
}
break;
default:
break;
}
}
void PreloadingAttemptImpl::SetFailureReason(PreloadingFailureReason reason) {
// Ensure that the failure reason is only set once and is only set for
// eligible and non-holdback attempts.
CHECK_EQ(eligibility_, PreloadingEligibility::kEligible);
CHECK_EQ(holdback_status_, PreloadingHoldbackStatus::kAllowed);
CHECK_EQ(failure_reason_, PreloadingFailureReason::kUnspecified);
CHECK_NE(reason, PreloadingFailureReason::kUnspecified);
// It could be possible that the TriggeringOutcome is already kFailure, when
// we try to set FailureReason after setting TriggeringOutcome to kFailure.
if (triggering_outcome_ != PreloadingTriggeringOutcome::kFailure)
SetTriggeringOutcome(PreloadingTriggeringOutcome::kFailure);
failure_reason_ = reason;
}
base::WeakPtr<PreloadingAttempt> PreloadingAttemptImpl::GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
PreloadingAttemptImpl::PreloadingAttemptImpl(
const PreloadingPredictor& creating_predictor,
const PreloadingPredictor& enacting_predictor,
PreloadingType preloading_type,
ukm::SourceId triggered_primary_page_source_id,
PreloadingURLMatchCallback url_match_predicate,
uint32_t sampling_seed)
: creating_predictor_(creating_predictor),
enacting_predictor_(enacting_predictor),
preloading_type_(preloading_type),
triggered_primary_page_source_id_(triggered_primary_page_source_id),
url_match_predicate_(std::move(url_match_predicate)),
sampling_seed_(sampling_seed) {}
PreloadingAttemptImpl::~PreloadingAttemptImpl() = default;
std::vector<PreloadingPredictor> PreloadingAttemptImpl::GetPredictors() const {
if (creating_predictor_ == enacting_predictor_) {
return {creating_predictor_};
}
return {creating_predictor_, enacting_predictor_};
}
void PreloadingAttemptImpl::RecordPreloadingAttemptMetrics(
ukm::SourceId navigated_page_source_id) {
ukm::UkmRecorder* ukm_recorder = ukm::UkmRecorder::Get();
// Ensure that when the `triggering_outcome_` is kSuccess, then the
// accurate_triggering should be true.
if (triggering_outcome_ == PreloadingTriggeringOutcome::kSuccess) {
// TODO(crbug.com/40263357): Fix PreloadingAttempt for Prefetching in
// a different WebContents. It is allowed to activate a prefetched result in
// another WebContents instance, and the WebContents that stores `this`
// instance does not have the opportunity to set the
// `is_accurate_triggering_` flag to true in this case.
if (preloading_type_ != PreloadingType::kPrefetch) {
CHECK(is_accurate_triggering_)
<< "TriggeringOutcome set to kSuccess without correct prediction\n";
}
}
// Always record UMA, regardless of sampling.
RecordPreloadingAttemptUMA();
// Check if the preloading attempt is sampled in.
// We prefer to use the UKM source ID of the triggering page for determining
// sampling, so that all preloading attempts from a given (preloading_type,
// predictor) for the same page are included (or not) together. If there is
// no source for the triggering page, fallback to the navigated-to page.
ukm::SourceId sampling_source = triggered_primary_page_source_id_;
if (sampling_source == ukm::kInvalidSourceId) {
sampling_source = navigated_page_source_id;
}
if (sampling_source == ukm::kInvalidSourceId) {
// There is no valid UKM source, so there is nothing to log.
return;
}
PreloadingConfig& config = PreloadingConfig::GetInstance();
for (const auto& predictor : GetPredictors()) {
uint32_t sampled_num = sampling_seed_;
sampled_num =
base::Crc32(sampled_num, base::byte_span_from_ref(sampling_source));
double sampling_likelihood =
config.SamplingLikelihood(preloading_type_, predictor);
if (sampled_num >
sampling_likelihood * std::numeric_limits<uint32_t>::max()) {
// PreloadingAttempt is sampled out.
continue;
}
// Turn sampling_likelihood into an int64_t for UKM logging. Multiply by one
// million to preserve accuracy.
int64_t sampling_likelihood_per_million =
static_cast<int64_t>(1'000'000 * sampling_likelihood);
if (navigated_page_source_id != ukm::kInvalidSourceId) {
ukm::builders::Preloading_Attempt builder(navigated_page_source_id);
builder.SetPreloadingType(static_cast<int64_t>(preloading_type_))
.SetPreloadingPredictor(predictor.ukm_value())
.SetEligibility(static_cast<int64_t>(eligibility_))
.SetHoldbackStatus(static_cast<int64_t>(holdback_status_))
.SetTriggeringOutcome(static_cast<int64_t>(triggering_outcome_))
.SetFailureReason(static_cast<int64_t>(failure_reason_))
.SetAccurateTriggering(is_accurate_triggering_)
.SetSamplingLikelihood(sampling_likelihood_per_million);
if (time_to_next_navigation_) {
builder.SetTimeToNextNavigation(
ukm::GetExponentialBucketMinForCounts1000(
time_to_next_navigation_->InMilliseconds()));
}
if (ready_time_) {
builder.SetReadyTime(ukm::GetExponentialBucketMinForCounts1000(
ready_time_->InMilliseconds()));
}
if (eagerness_) {
builder.SetSpeculationEagerness(
static_cast<int64_t>(eagerness_.value()));
}
if (service_worker_registered_check_) {
builder.SetPrefetchServiceWorkerRegisteredCheck(
static_cast<int64_t>(service_worker_registered_check_.value()));
}
if (service_worker_registered_check_duration_) {
builder.SetPrefetchServiceWorkerRegisteredForURLCheckDuration(
ukm::GetExponentialBucketMin(
service_worker_registered_check_duration_.value()
.InMicroseconds(),
kServiceWorkerRegisteredCheckDurationBucketSpacing));
}
builder.Record(ukm_recorder);
}
if (triggered_primary_page_source_id_ != ukm::kInvalidSourceId) {
ukm::builders::Preloading_Attempt_PreviousPrimaryPage builder(
triggered_primary_page_source_id_);
builder.SetPreloadingType(static_cast<int64_t>(preloading_type_))
.SetPreloadingPredictor(predictor.ukm_value())
.SetEligibility(static_cast<int64_t>(eligibility_))
.SetHoldbackStatus(static_cast<int64_t>(holdback_status_))
.SetTriggeringOutcome(static_cast<int64_t>(triggering_outcome_))
.SetFailureReason(static_cast<int64_t>(failure_reason_))
.SetAccurateTriggering(is_accurate_triggering_)
.SetSamplingLikelihood(sampling_likelihood_per_million);
if (time_to_next_navigation_) {
builder.SetTimeToNextNavigation(
ukm::GetExponentialBucketMinForCounts1000(
time_to_next_navigation_->InMilliseconds()));
}
if (ready_time_) {
builder.SetReadyTime(ukm::GetExponentialBucketMinForCounts1000(
ready_time_->InMilliseconds()));
}
if (eagerness_) {
builder.SetSpeculationEagerness(
static_cast<int64_t>(eagerness_.value()));
}
if (service_worker_registered_check_) {
builder.SetPrefetchServiceWorkerRegisteredCheck(
static_cast<int64_t>(service_worker_registered_check_.value()));
}
if (service_worker_registered_check_duration_) {
builder.SetPrefetchServiceWorkerRegisteredForURLCheckDuration(
ukm::GetExponentialBucketMin(
service_worker_registered_check_duration_.value()
.InMicroseconds(),
kServiceWorkerRegisteredCheckDurationBucketSpacing));
}
builder.Record(ukm_recorder);
}
}
}
void PreloadingAttemptImpl::RecordPreloadingAttemptUMA() {
// Records the triggering outcome enum. This can be used to:
// 1. Track the number of attempts;
// 2. Track the attempts' rates of various terminal status (i.e. success
// rate).
for (const auto& predictor : GetPredictors()) {
const auto uma_triggering_outcome_histogram =
base::StrCat({"Preloading.", PreloadingTypeToString(preloading_type_),
".Attempt.", predictor.name(), ".TriggeringOutcome"});
base::UmaHistogramEnumeration(std::move(uma_triggering_outcome_histogram),
triggering_outcome_);
}
}
void PreloadingAttemptImpl::SetNoVarySearchMatchPredicate(
PreloadingURLMatchCallback no_vary_search_match_predicate) {
CHECK(!no_vary_search_match_predicate_);
no_vary_search_match_predicate_ = std::move(no_vary_search_match_predicate);
}
void PreloadingAttemptImpl::SetIsAccurateTriggering(const GURL& navigated_url) {
CHECK(url_match_predicate_);
// `PreloadingAttemptImpl::SetIsAccurateTriggering` is called during
// `WCO::DidStartNavigation`.
if (!time_to_next_navigation_) {
time_to_next_navigation_ = elapsed_timer_.Elapsed();
}
// Use the predicate to match the URLs as the matching logic varies for each
// predictor.
is_accurate_triggering_ |= url_match_predicate_.Run(navigated_url);
if (no_vary_search_match_predicate_) {
is_accurate_triggering_ |=
no_vary_search_match_predicate_.Run(navigated_url);
}
}
void PreloadingAttemptImpl::SetSpeculationEagerness(
blink::mojom::SpeculationEagerness eagerness) {
CHECK(creating_predictor_ ==
content_preloading_predictor::kSpeculationRules ||
creating_predictor_ ==
content_preloading_predictor::kSpeculationRulesFromIsolatedWorld ||
creating_predictor_ == content_preloading_predictor::
kSpeculationRulesFromAutoSpeculationRules)
<< "predictor_type_: " << creating_predictor_.name()
<< " (ukm_value = " << creating_predictor_.ukm_value() << ")";
eagerness_ = eagerness;
}
void PreloadingAttemptImpl::SetServiceWorkerRegisteredCheck(
ServiceWorkerRegisteredCheck check) {
service_worker_registered_check_ = check;
}
void PreloadingAttemptImpl::SetServiceWorkerRegisteredCheckDuration(
base::TimeDelta duration) {
service_worker_registered_check_duration_ = duration;
}
// Used for StateTransitions matching.
std::ostream& operator<<(std::ostream& os,
const PreloadingTriggeringOutcome& outcome) {
switch (outcome) {
case PreloadingTriggeringOutcome::kUnspecified:
os << "Unspecified";
break;
case PreloadingTriggeringOutcome::kDuplicate:
os << "Duplicate";
break;
case PreloadingTriggeringOutcome::kRunning:
os << "Running";
break;
case PreloadingTriggeringOutcome::kReady:
os << "Ready";
break;
case PreloadingTriggeringOutcome::kSuccess:
os << "Success";
break;
case PreloadingTriggeringOutcome::kFailure:
os << "Failure";
break;
case PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown:
os << "TriggeredButOutcomeUnknown";
break;
case PreloadingTriggeringOutcome::kTriggeredButUpgradedToPrerender:
os << "TriggeredButUpgradedToPrerender";
break;
case PreloadingTriggeringOutcome::kTriggeredButPending:
os << "TriggeredButPending";
break;
case PreloadingTriggeringOutcome::kNoOp:
os << "NoOp";
break;
}
return os;
}
} // namespace content
|