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
|
// 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.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif
#include "components/variations/service/variations_field_trial_creator_base.h"
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <cstdint>
#include <memory>
#include <set>
#include <utility>
#include "base/base64.h"
#include "base/base_switches.h"
#include "base/command_line.h"
#include "base/debug/dump_without_crashing.h"
#include "base/files/file_path.h"
#include "base/functional/bind.h"
#include "base/json/json_file_value_serializer.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/process/process.h"
#include "base/sequence_checker.h"
#include "base/strings/pattern.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/system/sys_info.h"
#include "base/trace_event/trace_event.h"
#include "base/version.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "components/metrics/metrics_state_manager.h"
#include "components/prefs/pref_service.h"
#include "components/variations/active_field_trials.h"
#include "components/variations/entropy_provider.h"
#include "components/variations/field_trial_config/field_trial_util.h"
#include "components/variations/platform_field_trials.h"
#include "components/variations/pref_names.h"
#include "components/variations/proto/variations_seed.pb.h"
#include "components/variations/service/buildflags.h"
#include "components/variations/service/limited_entropy_randomization.h"
#include "components/variations/service/safe_seed_manager.h"
#include "components/variations/service/variations_service_client.h"
#include "components/variations/service/variations_service_utils.h"
#include "components/variations/variations_ids_provider.h"
#include "components/variations/variations_layers.h"
#include "components/variations/variations_seed_processor.h"
#include "components/variations/variations_switches.h"
#include "components/version_info/version_info.h"
#include "ui/base/device_form_factor.h"
namespace variations {
namespace {
// Records the loaded seed's expiry status.
void RecordSeedExpiry(bool is_safe_seed, VariationsSeedExpiry seed_expiry) {
const std::string histogram_name =
is_safe_seed ? "Variations.SafeMode.CreateTrials.SeedExpiry"
: "Variations.CreateTrials.SeedExpiry";
base::UmaHistogramEnumeration(histogram_name, seed_expiry);
}
// Records the loaded seed's age.
void RecordSeedFreshness(base::TimeDelta seed_age) {
UMA_HISTOGRAM_CUSTOM_COUNTS("Variations.SeedFreshness", seed_age.InMinutes(),
1, base::Days(30).InMinutes(), 50);
}
// Records details about Chrome's attempt to apply a variations seed.
void RecordVariationsSeedUsage(SeedUsage usage) {
VLOG(1) << "VariationsSeedUsage:" << static_cast<int>(usage);
base::UmaHistogramEnumeration("Variations.SeedUsage", usage);
}
// If an invalid command-line to force field trials was specified, exit the
// browser with a helpful error message, so that the user can correct their
// mistake.
void ExitWithMessage(const std::string& message) {
puts(message.c_str());
exit(1);
}
// Retrieves the value of the policy converted to the RestrictionPolicyValues.
RestrictionPolicy GetVariationPolicyRestriction(PrefService* local_state) {
int value = local_state->GetInteger(prefs::kVariationsRestrictionsByPolicy);
// If the value form the pref is invalid use the default value.
if (value < 0 || value > static_cast<int>(RestrictionPolicy::kMaxValue)) {
return RestrictionPolicy::NO_RESTRICTIONS;
}
return static_cast<RestrictionPolicy>(value);
}
Study::CpuArchitecture GetCurrentCpuArchitecture() {
std::string process_arch = base::SysInfo::ProcessCPUArchitecture();
if (process_arch == "ARM_64") {
return Study::ARM64;
}
if (process_arch == "ARM") {
return Study::ARM32;
}
if (process_arch == "x86") {
return Study::X86_32;
}
if (process_arch == "PPC_64") {
return Study::PPC64;
}
if (process_arch == "x86_64") {
std::string os_arch = base::SysInfo::OperatingSystemArchitecture();
if (base::StartsWith(os_arch, "arm",
base::CompareCase::INSENSITIVE_ASCII) ||
base::EqualsCaseInsensitiveASCII(os_arch, "aarch64")) {
// x86-64 binary running on an arm64 host via the Rosetta 2 binary
// translator.
return Study::TRANSLATED_X86_64;
}
return Study::X86_64;
}
NOTREACHED();
}
#if BUILDFLAG(FIELDTRIAL_TESTING_ENABLED)
// Determines whether the field trial testing config defined in
// testing/variations/fieldtrial_testing_config.json should be applied. If the
// "disable_fieldtrial_testing_config" GN flag is set to true, then the testing
// config should never be applied. Otherwise, if the build is a Chrome-branded
// build, then the testing config should only be applied if either the
// "--enable-field-trial-config" or
// "--enable-benchmarking=enable-field-trial-config" switch is passed. For
// non-Chrome branded builds, by default, the testing config is applied, unless
// the "--disable-field-trial-config" and/or "--variations-server-url" switches
// are passed and no enabling switches are set.
bool ShouldUseFieldTrialTestingConfig(const base::CommandLine* command_line) {
bool is_enable_switch_set =
command_line->HasSwitch(switches::kEnableFieldTrialTestingConfig) ||
command_line->GetSwitchValueASCII(
variations::switches::kEnableBenchmarking) ==
switches::kEnableFieldTrialTestingConfig;
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
return is_enable_switch_set;
#else
return is_enable_switch_set ||
(!command_line->HasSwitch(switches::kDisableFieldTrialTestingConfig) &&
!command_line->HasSwitch(switches::kVariationsServerURL));
#endif // BUILDFLAG(GOOGLE_CHROME_BRANDING)
}
#endif // BUILDFLAG(FIELDTRIAL_TESTING_ENABLED)
// Causes Chrome to start watching for browser crashes if the following
// conditions are met:
// 1. This is not a background session.
// 2. Extended Variations Safe Mode is supported on this platform.
void MaybeExtendVariationsSafeMode(
metrics::MetricsStateManager* metrics_state_manager) {
if (metrics_state_manager->is_background_session()) {
// If the session is expected to be a background session, then do not start
// watching for browser crashes here. This monitoring is not desired in
// background sessions, whose terminations should never be considered
// crashes.
return;
}
if (!metrics_state_manager->IsExtendedSafeModeSupported()) {
return;
}
metrics_state_manager->LogHasSessionShutdownCleanly(
/*has_session_shutdown_cleanly=*/false,
/*is_extended_safe_mode=*/true);
}
} // namespace
BASE_FEATURE(kForceFieldTrialSetupCrashForTesting,
"ForceFieldTrialSetupCrashForTesting",
base::FEATURE_DISABLED_BY_DEFAULT);
Study::Channel ConvertProductChannelToStudyChannel(
version_info::Channel product_channel) {
switch (product_channel) {
case version_info::Channel::CANARY:
return Study::CANARY;
case version_info::Channel::DEV:
return Study::DEV;
case version_info::Channel::BETA:
return Study::BETA;
case version_info::Channel::STABLE:
return Study::STABLE;
case version_info::Channel::UNKNOWN:
return Study::UNKNOWN;
}
NOTREACHED();
}
VariationsFieldTrialCreatorBase::VariationsFieldTrialCreatorBase(
VariationsServiceClient* client,
std::unique_ptr<VariationsSeedStore> seed_store,
base::OnceCallback<std::string(PrefService*)> locale_cb)
: client_(client),
seed_store_(std::move(seed_store)),
application_locale_(
std::move(locale_cb).Run(seed_store_->local_state())) {}
VariationsFieldTrialCreatorBase::~VariationsFieldTrialCreatorBase() = default;
std::string VariationsFieldTrialCreatorBase::GetLatestCountry() const {
const std::string override_country = base::ToLowerASCII(
base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
switches::kVariationsOverrideCountry));
return !override_country.empty()
? override_country
: local_state()->GetString(prefs::kVariationsCountry);
}
bool VariationsFieldTrialCreatorBase::SetUpFieldTrials(
const std::vector<std::string>& variation_ids,
const std::string& command_line_variation_ids,
const std::vector<base::FeatureList::FeatureOverrideInfo>& extra_overrides,
std::unique_ptr<base::FeatureList> feature_list,
metrics::MetricsStateManager* metrics_state_manager,
PlatformFieldTrials* platform_field_trials,
SafeSeedManagerBase* safe_seed_manager,
bool add_entropy_source_to_variations_ids,
const EntropyProviders& entropy_providers) {
DCHECK(feature_list);
DCHECK(metrics_state_manager);
DCHECK(platform_field_trials);
DCHECK(safe_seed_manager);
CHECK(client_);
MaybeExtendVariationsSafeMode(metrics_state_manager);
// TODO(crbug.com/40796250): Some FieldTrial-setup-related code is here and
// some is in MetricsStateManager::InstantiateFieldTrialList(). It's not ideal
// that it's in two places.
VariationsIdsProvider* http_header_provider =
VariationsIdsProvider::GetInstance();
if (add_entropy_source_to_variations_ids) {
http_header_provider->SetLowEntropySourceValue(
metrics_state_manager->GetLowEntropySource());
}
// Force the variation ids selected in chrome://flags and/or specified using
// the command-line flag.
auto result = http_header_provider->ForceVariationIds(
variation_ids, command_line_variation_ids);
switch (result) {
case VariationsIdsProvider::ForceIdsResult::INVALID_SWITCH_ENTRY:
ExitWithMessage(base::StringPrintf("Invalid --%s list specified.",
switches::kForceVariationIds));
break;
case VariationsIdsProvider::ForceIdsResult::INVALID_VECTOR_ENTRY:
// It should not be possible to have invalid variation ids from the
// vector param (which corresponds to chrome://flags).
NOTREACHED();
case VariationsIdsProvider::ForceIdsResult::SUCCESS:
break;
}
const base::CommandLine* command_line =
base::CommandLine::ForCurrentProcess();
bool success = http_header_provider->ForceDisableVariationIds(
command_line->GetSwitchValueASCII(switches::kForceDisableVariationIds));
if (!success) {
ExitWithMessage(base::StringPrintf("Invalid --%s list specified.",
switches::kForceDisableVariationIds));
}
feature_list->InitFromCommandLine(
command_line->GetSwitchValueASCII(::switches::kEnableFeatures),
command_line->GetSwitchValueASCII(::switches::kDisableFeatures));
// This needs to happen here: After the InitFromCommandLine() call,
// because the explicit cmdline --disable-features and --enable-features
// should take precedence over these extra overrides. Before the call to
// SetInstance(), because overrides cannot be registered after the FeatureList
// instance is set.
feature_list->RegisterExtraFeatureOverrides(extra_overrides);
bool used_testing_config = false;
// TODO(crbug.com/40230862): Remove this code path.
#if BUILDFLAG(FIELDTRIAL_TESTING_ENABLED)
if (ShouldUseFieldTrialTestingConfig(command_line)) {
ApplyFieldTrialTestingConfig(feature_list.get());
used_testing_config = true;
}
#else
if (command_line->HasSwitch(switches::kEnableFieldTrialTestingConfig)) {
ExitWithMessage(
base::StringPrintf("--%s was passed, but the field trial testing "
"config was excluded from the build.",
switches::kEnableFieldTrialTestingConfig));
}
#endif // BUILDFLAG(FIELDTRIAL_TESTING_ENABLED)
if (command_line->HasSwitch(switches::kVariationsTestSeedJsonPath)) {
LoadSeedFromJsonFile(command_line->GetSwitchValuePath(
switches::kVariationsTestSeedJsonPath));
}
// Get client filterable state to be used by CreateTrialsFromSeed()
std::unique_ptr<ClientFilterableState> client_filterable_state = nullptr;
const base::Version& current_version = version_info::GetVersion();
if (current_version.IsValid()) {
client_filterable_state =
GetClientFilterableStateForVersion(current_version);
}
CreateTrialsResult create_trials_result = {.applied_seed = false};
if (!used_testing_config && client_filterable_state) {
create_trials_result = CreateTrialsFromSeed(
entropy_providers, feature_list.get(), safe_seed_manager,
std::move(client_filterable_state));
}
platform_field_trials->SetUpClientSideFieldTrials(
create_trials_result.applied_seed, entropy_providers, feature_list.get());
platform_field_trials->RegisterFeatureOverrides(feature_list.get());
base::FeatureList::SetInstance(std::move(feature_list));
// For testing Variations Safe Mode, maybe crash here.
if (base::FeatureList::IsEnabled(kForceFieldTrialSetupCrashForTesting)) {
// Terminate with a custom exit test code. See
// VariationsSafeModeEndToEndBrowserTest.ExtendedSafeSeedEndToEnd.
base::Process::TerminateCurrentProcessImmediately(0x7E57C0D3);
}
// This must be called after |local_state_| is initialized.
platform_field_trials->OnVariationsSetupComplete();
VLOG(1) << "VariationsSetupComplete";
return create_trials_result.applied_seed;
}
std::unique_ptr<ClientFilterableState>
VariationsFieldTrialCreatorBase::GetClientFilterableStateForVersion(
const base::Version& version) {
// Note that passing base::Unretained(client_) is safe here because |client_|
// lives until Chrome exits.
auto IsEnterpriseCallback = base::BindRepeating(
&VariationsServiceClient::IsEnterprise, base::Unretained(client_));
auto GoogleGroupsCallback = base::BindRepeating(
&VariationsFieldTrialCreatorBase::GetGoogleGroupsFromPrefs,
base::Unretained(this));
std::unique_ptr<ClientFilterableState> state =
std::make_unique<ClientFilterableState>(IsEnterpriseCallback,
GoogleGroupsCallback);
state->locale = application_locale_;
state->reference_date = GetSeedStore()->GetTimeForStudyDateChecks(
/*is_safe_seed=*/false);
state->version = version;
state->os_version = ClientFilterableState::GetOSVersion();
state->channel =
ConvertProductChannelToStudyChannel(client_->GetChannelForVariations());
state->form_factor = GetCurrentFormFactor();
state->cpu_architecture = GetCurrentCpuArchitecture();
state->platform = GetPlatform();
state->hardware_class = ClientFilterableState::GetHardwareClass();
#if BUILDFLAG(IS_ANDROID)
// This is set on Android only currently, because the IsLowEndDevice() API
// on other platforms has no intrinsic meaning outside of a field trial that
// controls its value. Since this is before server-side field trials are
// evaluated, that field trial would not be able to apply for this case.
state->is_low_end_device = base::SysInfo::IsLowEndDevice();
#endif
state->session_consistency_country = GetLatestCountry();
state->permanent_consistency_country = LoadPermanentConsistencyCountry(
version, state->session_consistency_country);
// Update the stored permanent consistency country
permanent_consistency_country_ = state->permanent_consistency_country;
permanent_consistency_country_initialized_ = true;
state->policy_restriction = GetVariationPolicyRestriction(local_state());
return state;
}
std::string VariationsFieldTrialCreatorBase::LoadPermanentConsistencyCountry(
const base::Version& version,
const std::string& latest_country) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(version.IsValid());
const std::string override_country = base::ToLowerASCII(
base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
switches::kVariationsOverrideCountry));
if (!override_country.empty()) {
return override_country;
}
const std::string permanent_overridden_country =
local_state()->GetString(prefs::kVariationsPermanentOverriddenCountry);
if (!permanent_overridden_country.empty()) {
base::UmaHistogramEnumeration(
"Variations.LoadPermanentConsistencyCountryResult",
LOAD_COUNTRY_HAS_PERMANENT_OVERRIDDEN_COUNTRY, LOAD_COUNTRY_MAX);
return permanent_overridden_country;
}
const base::Value::List& list_value =
local_state()->GetList(prefs::kVariationsPermanentConsistencyCountry);
const std::string* stored_version_string = nullptr;
const std::string* stored_country = nullptr;
// Determine if the saved pref value is present and valid.
const bool is_pref_empty = list_value.empty();
const bool is_pref_valid =
list_value.size() == 2 &&
(stored_version_string = list_value[0].GetIfString()) &&
(stored_country = list_value[1].GetIfString()) &&
base::Version(*stored_version_string).IsValid();
// Determine if the version from the saved pref matches |version|.
const bool does_version_match =
is_pref_valid && version == base::Version(*stored_version_string);
// Determine if the country in the saved pref matches the country in
// |latest_country|.
const bool does_country_match = is_pref_valid && !latest_country.empty() &&
*stored_country == latest_country;
// Record a histogram for how the saved pref value compares to the current
// version and the country code in the variations seed.
LoadPermanentConsistencyCountryResult result;
if (is_pref_empty) {
result = !latest_country.empty() ? LOAD_COUNTRY_NO_PREF_HAS_SEED
: LOAD_COUNTRY_NO_PREF_NO_SEED;
} else if (!is_pref_valid) {
result = !latest_country.empty() ? LOAD_COUNTRY_INVALID_PREF_HAS_SEED
: LOAD_COUNTRY_INVALID_PREF_NO_SEED;
} else if (latest_country.empty()) {
result = does_version_match ? LOAD_COUNTRY_HAS_PREF_NO_SEED_VERSION_EQ
: LOAD_COUNTRY_HAS_PREF_NO_SEED_VERSION_NEQ;
} else if (does_version_match) {
result = does_country_match ? LOAD_COUNTRY_HAS_BOTH_VERSION_EQ_COUNTRY_EQ
: LOAD_COUNTRY_HAS_BOTH_VERSION_EQ_COUNTRY_NEQ;
} else {
result = does_country_match ? LOAD_COUNTRY_HAS_BOTH_VERSION_NEQ_COUNTRY_EQ
: LOAD_COUNTRY_HAS_BOTH_VERSION_NEQ_COUNTRY_NEQ;
}
UMA_HISTOGRAM_ENUMERATION("Variations.LoadPermanentConsistencyCountryResult",
result, LOAD_COUNTRY_MAX);
// Use the stored country if one is available and was fetched since the last
// time Chrome was updated.
if (does_version_match) {
return *stored_country;
}
if (latest_country.empty()) {
if (!is_pref_valid) {
local_state()->ClearPref(prefs::kVariationsPermanentConsistencyCountry);
}
// If we've never received a country code from the server, use an empty
// country so that it won't pass any filters that specifically include
// countries, but so that it will pass any filters that specifically exclude
// countries.
return std::string();
}
// Otherwise, update the pref with the current Chrome version and country.
StorePermanentCountry(version, latest_country);
return latest_country;
}
std::string VariationsFieldTrialCreatorBase::GetPermanentConsistencyCountry()
const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(permanent_consistency_country_initialized_);
return permanent_consistency_country_;
}
void VariationsFieldTrialCreatorBase::StorePermanentCountry(
const base::Version& version,
const std::string& country) {
base::Value::List new_list_value;
new_list_value.Append(version.GetString());
new_list_value.Append(country);
local_state()->SetList(prefs::kVariationsPermanentConsistencyCountry,
std::move(new_list_value));
}
void VariationsFieldTrialCreatorBase::StoreVariationsOverriddenCountry(
const std::string& country) {
local_state()->SetString(prefs::kVariationsPermanentOverriddenCountry,
country);
permanent_consistency_country_ = country;
permanent_consistency_country_initialized_ = true;
}
void VariationsFieldTrialCreatorBase::OverrideVariationsPlatform(
Study::Platform platform_override) {
platform_override_ = platform_override;
}
Study::Platform VariationsFieldTrialCreatorBase::GetPlatform() {
if (platform_override_.has_value()) {
return platform_override_.value();
}
return ClientFilterableState::GetCurrentPlatform();
}
Study::FormFactor VariationsFieldTrialCreatorBase::GetCurrentFormFactor() {
return client_->GetCurrentFormFactor();
}
#if BUILDFLAG(FIELDTRIAL_TESTING_ENABLED)
void VariationsFieldTrialCreatorBase::ApplyFieldTrialTestingConfig(
base::FeatureList* feature_list) {
VLOG(1) << "Applying FieldTrialTestingConfig";
// Note that passing base::Unretained(this) below is safe because the callback
// is executed synchronously.
AssociateDefaultFieldTrialConfig(
base::BindRepeating(&VariationsFieldTrialCreatorBase::OverrideUIString,
base::Unretained(this)),
GetPlatform(), GetCurrentFormFactor(), feature_list);
}
#endif // BUILDFLAG(FIELDTRIAL_TESTING_ENABLED)
base::Time VariationsFieldTrialCreatorBase::GetSeedFetchTime() {
// TODO(crbug.com/40274989): Consider comparing the server-provided fetch time
// with the network time.
return seed_type_ == SeedType::kSafeSeed
? GetSeedStore()->GetSafeSeedFetchTime()
: GetSeedStore()->GetLatestSeedFetchTime();
}
bool VariationsFieldTrialCreatorBase::HasSeedExpired() {
const base::Time fetch_time = GetSeedFetchTime();
// If the fetch time is null, skip the expiry check. If the seed is a regular
// seed (i.e. not a safe seed) and the fetch time is missing, then this must
// be the first run of Chrome. If the seed is a safe seed, the fetch time may
// be missing because the pref was added about a milestone later than most of
// the other safe seed prefs.
if (fetch_time.is_null()) {
RecordSeedExpiry(seed_type_ == SeedType::kSafeSeed,
VariationsSeedExpiry::kFetchTimeMissing);
if (seed_type_ != SeedType::kSafeSeed) {
// Store the current time as the last fetch time for Chrome's first run.
GetSeedStore()->RecordLastFetchTime(base::Time::Now());
// Record freshness of "0", since we expect a first run seed to be fresh.
RecordSeedFreshness(base::TimeDelta());
}
return false;
}
bool has_seed_expired = HasSeedExpiredSinceTime(fetch_time);
if (!has_seed_expired) {
RecordSeedFreshness(base::Time::Now() - fetch_time);
}
RecordSeedExpiry(seed_type_ == SeedType::kSafeSeed,
has_seed_expired ? VariationsSeedExpiry::kExpired
: VariationsSeedExpiry::kNotExpired);
return has_seed_expired;
}
bool VariationsFieldTrialCreatorBase::IsSeedForFutureMilestone(
bool is_safe_seed) {
int seed_milestone = is_safe_seed ? GetSeedStore()->GetSafeSeedMilestone()
: GetSeedStore()->GetLatestMilestone();
// The regular and safe seed milestone prefs were added in M97, so the prefs
// are not populated for seeds stored before then.
if (!seed_milestone) {
return false;
}
int client_milestone = version_info::GetMajorVersionNumberAsInt();
return seed_milestone > client_milestone;
}
base::flat_set<uint64_t>
VariationsFieldTrialCreatorBase::GetGoogleGroupsFromPrefs() {
// Before using Google groups information, ensure that there any information
// for already-deleted profiles has been removed.
//
// TODO(b/264838828): move this call to be done in SetUpFieldTrials(). The
// reason it is currently done here is simply to allow a safer gradual
// rollout of the initial feature, as this code is only run if there is at
// least one study that filters by Google group membership.
client_->RemoveGoogleGroupsFromPrefsForDeletedProfiles(local_state());
base::flat_set<uint64_t> groups = base::flat_set<uint64_t>();
const base::Value::Dict& profiles_dict =
local_state()->GetDict(prefs::kVariationsGoogleGroups);
for (const auto profile : profiles_dict) {
const base::Value::List& profile_groups = profile.second.GetList();
for (const auto& group_value : profile_groups) {
const std::string* group = group_value.GetIfString();
if (!group || group->empty()) {
continue;
}
uint64_t group_id;
if (!base::StringToUint64(*group, &group_id)) {
continue;
}
groups.insert(group_id);
}
}
return groups;
}
CreateTrialsResult VariationsFieldTrialCreatorBase::CreateTrialsFromSeed(
const EntropyProviders& entropy_providers,
base::FeatureList* feature_list,
SafeSeedManagerBase* safe_seed_manager,
std::unique_ptr<ClientFilterableState> client_state) {
// This histogram name uses "VariationsFieldTrialCreator" rather than
// "VariationsFieldTrialCreatorBase" for consistency with historical data
TRACE_EVENT0("startup", "VariationsFieldTrialCreator::CreateTrialsFromSeed");
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(!create_trials_from_seed_called_);
CHECK(client_);
create_trials_from_seed_called_ = true;
base::TimeTicks start_time = base::TimeTicks::Now();
base::UmaHistogramSparse("Variations.UserChannel", client_state->channel);
base::UmaHistogramEnumeration("Variations.PolicyRestriction",
client_state->policy_restriction);
seed_type_ = safe_seed_manager->GetSeedType();
// If we have tried safe seed and we still get crashes, try null seed.
if (seed_type_ == SeedType::kNullSeed) {
RecordVariationsSeedUsage(SeedUsage::kNullSeedUsed);
return CreateTrialsResult{.applied_seed = false};
}
VariationsSeed seed;
std::string seed_data; // Only set if not in safe mode.
std::string base64_seed_signature; // Only set if not in safe mode.
const bool run_in_safe_mode = seed_type_ == SeedType::kSafeSeed;
const bool seed_loaded =
run_in_safe_mode
? GetSeedStore()->LoadSafeSeed(&seed, client_state.get())
: GetSeedStore()->LoadSeed(&seed, &seed_data, &base64_seed_signature);
if (!seed_loaded) {
// If Chrome should run in safe mode but the safe seed was not successfully
// loaded, then do not apply a seed. Fall back to client-side defaults.
RecordVariationsSeedUsage(run_in_safe_mode
? SeedUsage::kUnloadableSafeSeedNotUsed
: SeedUsage::kUnloadableRegularSeedNotUsed);
return CreateTrialsResult{.applied_seed = false};
}
if (HasSeedExpired()) {
RecordVariationsSeedUsage(run_in_safe_mode
? SeedUsage::kExpiredSafeSeedNotUsed
: SeedUsage::kExpiredRegularSeedNotUsed);
return CreateTrialsResult{.applied_seed = false};
}
if (IsSeedForFutureMilestone(/*is_safe_seed=*/run_in_safe_mode)) {
RecordVariationsSeedUsage(
run_in_safe_mode ? SeedUsage::kSafeSeedForFutureMilestoneNotUsed
: SeedUsage::kRegularSeedForFutureMilestoneNotUsed);
return CreateTrialsResult{.applied_seed = false};
}
RecordVariationsSeedUsage(run_in_safe_mode ? SeedUsage::kSafeSeedUsed
: SeedUsage::kRegularSeedUsed);
SetSeedVersion(seed.version());
VariationsLayers layers(seed, entropy_providers);
// The server is not expected to send a seed with misconfigured entropy. Just
// in case there is an unexpected server-side bug and the entropy is
// misconfigured, return early to skip assigning any trials from the seed.
// Also, generate a crash report, so that the misconfigured seed can be
// identified and rolled back.
//
// Note that `VariationsLayers` ensures that no limited-entropy-mode layer
// is marked as active for clients without a limited entropy provider, which
// is the case for clients on platforms, like Android WebView, that do not
// support limited entropy randomization. For such clients,
// `SeedHasMisconfiguredEntropy()`is always false.
if (SeedHasMisconfiguredEntropy(layers, seed)) {
base::debug::DumpWithoutCrashing();
return CreateTrialsResult{
.applied_seed = false,
.seed_has_limited_layer = layers.seed_has_limited_layer()};
}
// Note that passing base::Unretained(this) below is safe because the callback
// is executed synchronously. It is not possible to pass UIStringOverrider
// directly to VariationsSeedProcessor (which is in components/variations and
// not components/variations/service) as the variations component should not
// depend on //ui/base.
VariationsSeedProcessor().CreateTrialsFromSeed(
seed, *client_state,
base::BindRepeating(&VariationsFieldTrialCreatorBase::OverrideUIString,
base::Unretained(this)),
entropy_providers, layers, feature_list);
VLOG(1) << "CreateTrialsFromSeed complete with "
<< "seed.version='" << seed.version() << "'";
// Store into the |safe_seed_manager| the combined server and client data used
// to create the field trials. But, as an optimization, skip this step when
// running in safe mode – once running in safe mode, there can never be a need
// to save the active state to the safe seed prefs.
if (!run_in_safe_mode) {
safe_seed_manager->SetActiveSeedState(
seed_data, base64_seed_signature,
local_state()->GetInteger(prefs::kVariationsSeedMilestone),
std::move(client_state), seed_store_->GetLatestSeedFetchTime());
}
base::UmaHistogramCounts1M("Variations.AppliedSeed.Size", seed_data.size());
#if BUILDFLAG(IS_WIN)
base::UmaHistogramCounts10M("Variations.AppliedSeed.Size.V2",
seed_data.size());
#endif // BUILDFLAG(IS_WIN)
base::UmaHistogramTimes("Variations.SeedProcessingTime",
base::TimeTicks::Now() - start_time);
return CreateTrialsResult{
.applied_seed = true,
.seed_has_limited_layer = layers.seed_has_limited_layer()};
}
void VariationsFieldTrialCreatorBase::LoadSeedFromJsonFile(
const base::FilePath& json_seed_path) {
VLOG(1) << "Loading seed from JSON file:" << json_seed_path;
JSONFileValueDeserializer file_deserializer(json_seed_path);
int error_code;
std::string error_message;
std::unique_ptr<base::Value> json_contents =
file_deserializer.Deserialize(&error_code, &error_message);
if (!json_contents) {
ExitWithMessage(base::StringPrintf("Failed to load \"%s\" %s (%i)",
json_seed_path.AsUTF8Unsafe().c_str(),
error_message.c_str(), error_code));
}
const base::Value* seed_data =
json_contents->GetDict().Find(prefs::kVariationsCompressedSeed);
const base::Value* seed_signature =
json_contents->GetDict().Find(prefs::kVariationsSeedSignature);
if (!seed_data || !seed_data->is_string()) {
ExitWithMessage(
base::StrCat({"Missing or invalid seed data in contents of \"",
json_seed_path.AsUTF8Unsafe(), "\""}));
}
if (!seed_signature || !seed_signature->is_string()) {
ExitWithMessage(
base::StrCat({"Missing or invalid seed signature in contents of \"",
json_seed_path.AsUTF8Unsafe(), "\""}));
}
// Set fail counters to 0 to make sure Chrome doesn't run in variations safe
// mode. This ensures that Chrome won't use the safe seed.
local_state()->SetInteger(prefs::kVariationsCrashStreak, 0);
local_state()->SetInteger(prefs::kVariationsFailedToFetchSeedStreak, 0);
// Override Local State seed prefs.
std::string decoded_seed;
if (!base::Base64Decode(seed_data->GetString(), &decoded_seed)) {
ExitWithMessage(
base::StrCat({"Failed to decode seed data in contents of \"",
json_seed_path.AsUTF8Unsafe(), "\""}));
}
seed_store_->StoreSeedData(decoded_seed, seed_signature->GetString(),
/*country_code=*/"",
/*date_fetched=*/base::Time(),
/*is_delta_compressed=*/false,
/*is_gzip_compressed=*/true,
/*done_callback=*/base::DoNothing(),
/*require_synchronous=*/true);
}
VariationsSeedStore* VariationsFieldTrialCreatorBase::GetSeedStore() {
return seed_store_.get();
}
base::Time VariationsFieldTrialCreatorBase::GetLatestSeedFetchTime() {
return GetSeedStore()->GetLatestSeedFetchTime();
}
} // namespace variations
|