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
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/segmentation_platform/segmentation_platform_service_factory.h"
#include <memory>
#include "base/containers/span.h"
#include "base/files/file_path.h"
#include "base/hash/hash.h"
#include "base/no_destructor.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "base/time/default_clock.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/commerce/shopping_service_factory.h"
#include "chrome/browser/history/history_service_factory.h"
#include "chrome/browser/optimization_guide/optimization_guide_keyed_service.h"
#include "chrome/browser/optimization_guide/optimization_guide_keyed_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/segmentation_platform/client_util/local_tab_handler.h"
#include "chrome/browser/segmentation_platform/segmentation_platform_config.h"
#include "chrome/browser/segmentation_platform/segmentation_platform_profile_observer.h"
#include "chrome/browser/segmentation_platform/ukm_database_client.h"
#include "chrome/browser/sync/device_info_sync_service_factory.h"
#include "chrome/browser/sync/session_sync_service_factory.h"
#include "chrome/browser/sync/sync_service_factory.h"
#include "chrome/common/chrome_constants.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/segmentation_platform/embedder/default_model/device_switcher_result_dispatcher.h"
#include "components/segmentation_platform/embedder/home_modules/home_modules_card_registry.h"
#include "components/segmentation_platform/embedder/input_delegate/shopping_service_input_delegate.h"
#include "components/segmentation_platform/embedder/input_delegate/tab_rank_dispatcher.h"
#include "components/segmentation_platform/embedder/input_delegate/tab_session_source.h"
#include "components/segmentation_platform/embedder/model_provider_factory_impl.h"
#include "components/segmentation_platform/embedder/tab_fetcher.h"
#include "components/segmentation_platform/internal/dummy_segmentation_platform_service.h"
#include "components/segmentation_platform/internal/segmentation_platform_service_impl.h"
#include "components/segmentation_platform/internal/ukm_data_manager.h"
#include "components/segmentation_platform/public/config.h"
#include "components/segmentation_platform/public/features.h"
#include "components/segmentation_platform/public/model_provider.h"
#include "components/segmentation_platform/public/proto/model_metadata.pb.h"
#include "components/sync_device_info/device_info_sync_service.h"
#include "components/sync_sessions/session_sync_service.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/browser/web_contents.h"
#if BUILDFLAG(IS_ANDROID)
#include "chrome/browser/segmentation_platform/client_util/tab_data_collection_util.h"
#endif
namespace segmentation_platform {
namespace {
const char kSegmentationPlatformProfileObserverKey[] =
"segmentation_platform_profile_observer";
const char kSegmentationDeviceSwitcherUserDataKey[] =
"segmentation_device_switcher_data";
const char kSegmentationTabRankDispatcherUserDataKey[] =
"segmentation_tab_rank_dispatcher_data";
const char kSegmentationHomeModulesCardRegistryDataKey[] =
"segmentation_home_modules_card_registry";
std::unique_ptr<processing::InputDelegateHolder> SetUpInputDelegates(
std::vector<std::unique_ptr<Config>>& configs,
sync_sessions::SessionSyncService* session_sync_service,
TabFetcher* tab_fetcher) {
auto input_delegate_holder =
std::make_unique<processing::InputDelegateHolder>();
for (auto& config : configs) {
for (auto& id : config->input_delegates) {
input_delegate_holder->SetDelegate(id.first, std::move(id.second));
}
}
input_delegate_holder->SetDelegate(
proto::CustomInput::FILL_TAB_METRICS,
std::make_unique<segmentation_platform::processing::LocalTabSource>(
session_sync_service, tab_fetcher));
// Input delegates that are shared by multiple models.are added here.
return input_delegate_holder;
}
void InitTabDataCollection(
SegmentationPlatformService* service,
sync_sessions::SessionSyncService* session_sync_service,
std::unique_ptr<TabFetcher> tab_fetcher) {
auto rank_dispatcher = std::make_unique<TabRankDispatcher>(
service, session_sync_service, std::move(tab_fetcher));
#if BUILDFLAG(IS_ANDROID)
if (base::FeatureList::IsEnabled(
features::kSegmentationPlatformCollectTabRankData)) {
const char kSegmentationTabDataCollectionUtilUserDataKey[] =
"segmentation_tab_tab_data_collection_util";
auto tab_collection_util =
std::make_unique<TabDataCollectionUtil>(service, rank_dispatcher.get());
service->SetUserData(kSegmentationTabDataCollectionUtilUserDataKey,
std::move(tab_collection_util));
}
#endif
service->SetUserData(kSegmentationTabRankDispatcherUserDataKey,
std::move(rank_dispatcher));
}
void InitializeUkmDatabaseIfNeeded(Profile* profile) {
// The client is initialized in
// `ChromeBrowserMainExtraPartsSegmentationPlatform::PreProfileInit()` for
// production scenarios. But unit tests do not initialize the browser process,
// so this code path initializes the UKM client. Use in-memory since only
// tests should use this path.
UkmDatabaseClientHolder::GetClientInstance(profile).PreProfileInit(
/*in_memory_database=*/true);
}
} // namespace
// static
SegmentationPlatformServiceFactory*
SegmentationPlatformServiceFactory::GetInstance() {
static base::NoDestructor<SegmentationPlatformServiceFactory> instance;
return instance.get();
}
// static
SegmentationPlatformService* SegmentationPlatformServiceFactory::GetForProfile(
Profile* profile) {
return static_cast<SegmentationPlatformService*>(
GetInstance()->GetServiceForBrowserContext(profile, true));
}
SegmentationPlatformServiceFactory::SegmentationPlatformServiceFactory()
: ProfileKeyedServiceFactory(
"SegmentationPlatformService",
ProfileSelections::Builder()
.WithRegular(ProfileSelection::kOriginalOnly)
// TODO(crbug.com/40257657): Check if this service is needed in
// Guest mode.
.WithGuest(ProfileSelection::kOriginalOnly)
// TODO(crbug.com/41488885): Check if this service is needed for
// Ash Internals.
.WithAshInternals(ProfileSelection::kOriginalOnly)
.Build()) {
DependsOn(OptimizationGuideKeyedServiceFactory::GetInstance());
DependsOn(HistoryServiceFactory::GetInstance());
DependsOn(DeviceInfoSyncServiceFactory::GetInstance());
DependsOn(SyncServiceFactory::GetInstance());
DependsOn(SessionSyncServiceFactory::GetInstance());
}
SegmentationPlatformServiceFactory::~SegmentationPlatformServiceFactory() =
default;
void SegmentationPlatformServiceFactory::RegisterProfilePrefs(
user_prefs::PrefRegistrySyncable* registry) {
home_modules::HomeModulesCardRegistry::RegisterProfilePrefs(registry);
}
std::unique_ptr<KeyedService>
SegmentationPlatformServiceFactory::BuildServiceInstanceForBrowserContext(
content::BrowserContext* context) const {
if (context->IsOffTheRecord())
return nullptr;
if (!base::FeatureList::IsEnabled(features::kSegmentationPlatformFeature))
return std::make_unique<DummySegmentationPlatformService>();
Profile* profile = Profile::FromBrowserContext(context);
OptimizationGuideKeyedService* optimization_guide =
OptimizationGuideKeyedServiceFactory::GetForProfile(profile);
sync_sessions::SessionSyncService* session_sync_service =
SessionSyncServiceFactory::GetForProfile(profile);
auto tab_fetcher = std::make_unique<processing::LocalTabHandler>(
session_sync_service, profile);
auto home_modules_card_registry =
std::make_unique<home_modules::HomeModulesCardRegistry>(
profile->GetPrefs());
InitializeUkmDatabaseIfNeeded(profile);
auto params = std::make_unique<SegmentationPlatformServiceImpl::InitParams>();
auto profile_path = profile->GetPath().value();
params->profile_id = base::NumberToString(
base::PersistentHash(base::as_byte_span(profile_path)));
params->history_service = HistoryServiceFactory::GetForProfile(
profile, ServiceAccessType::IMPLICIT_ACCESS);
base::TaskPriority priority = base::TaskPriority::BEST_EFFORT;
if (base::FeatureList::IsEnabled(features::kSegmentationPlatformUserVisibleTaskRunner)) {
priority = base::TaskPriority::USER_VISIBLE;
}
params->task_runner = base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), priority});
params->storage_dir =
profile->GetPath().Append(chrome::kSegmentationPlatformStorageDirName);
params->db_provider =
profile->GetDefaultStoragePartition()->GetProtoDatabaseProvider();
params->clock = base::DefaultClock::GetInstance();
params->ukm_data_manager =
UkmDatabaseClientHolder::GetClientInstance(profile).GetUkmDataManager();
params->profile_prefs = profile->GetPrefs();
params->configs =
GetSegmentationPlatformConfig(context, home_modules_card_registry.get());
params->input_delegate_holder = SetUpInputDelegates(
params->configs, session_sync_service, tab_fetcher.get());
params->field_trial_register = std::make_unique<FieldTrialRegisterImpl>();
raw_ptr<FieldTrialRegister> field_trial_register =
params->field_trial_register.get();
params->model_provider = std::make_unique<ModelProviderFactoryImpl>(
optimization_guide, params->configs, params->task_runner);
// Guaranteed to outlive the SegmentationPlatformService, which depends on the
// DeviceInfoSynceService.
params->device_info_tracker =
DeviceInfoSyncServiceFactory::GetForProfile(profile)
->GetDeviceInfoTracker();
// Set up Shopping Service input delegate.
auto shopping_service_callback = base::BindRepeating(
[](base::WeakPtr<content::BrowserContext> context) -> ShoppingService* {
content::BrowserContext* context_ptr = context.get();
if (!context_ptr) {
return nullptr;
}
return commerce::ShoppingServiceFactory::GetForBrowserContextIfExists(
context_ptr);
},
context->GetWeakPtr());
params->input_delegate_holder->SetDelegate(
proto::CustomInput::FILL_FROM_SHOPPING_SERVICE,
std::make_unique<ShoppingServiceInputDelegate>(
shopping_service_callback));
std::unique_ptr<SegmentationPlatformServiceImpl> service =
std::make_unique<SegmentationPlatformServiceImpl>(std::move(params));
// Profile manager can be null in unit tests.
if (g_browser_process->profile_manager()) {
service->SetUserData(
kSegmentationPlatformProfileObserverKey,
std::make_unique<SegmentationPlatformProfileObserver>(
service.get(), g_browser_process->profile_manager()));
}
service->SetUserData(kSegmentationDeviceSwitcherUserDataKey,
std::make_unique<DeviceSwitcherResultDispatcher>(
service.get(),
DeviceInfoSyncServiceFactory::GetForProfile(profile)
->GetDeviceInfoTracker(),
profile->GetPrefs(), field_trial_register));
service->SetUserData(kSegmentationHomeModulesCardRegistryDataKey,
std::move(home_modules_card_registry));
InitTabDataCollection(service.get(), session_sync_service,
std::move(tab_fetcher));
return service;
}
// static
home_modules::HomeModulesCardRegistry*
SegmentationPlatformServiceFactory::GetHomeModulesCardRegistry(
content::BrowserContext* context) {
CHECK(!context->IsOffTheRecord());
Profile* profile = Profile::FromBrowserContext(context);
SegmentationPlatformService* service = GetForProfile(profile);
if (!service) {
return nullptr;
}
return static_cast<
segmentation_platform::home_modules::HomeModulesCardRegistry*>(
service->GetUserData(kSegmentationHomeModulesCardRegistryDataKey));
}
} // namespace segmentation_platform
|