sync_api_component_factory_impl.cc 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
  1. // Copyright (c) 2012 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "components/browser_sync/sync_api_component_factory_impl.h"
  5. #include <utility>
  6. #include "base/bind.h"
  7. #include "base/feature_list.h"
  8. #include "base/memory/ref_counted.h"
  9. #include "base/task/task_traits.h"
  10. #include "base/task/thread_pool.h"
  11. #include "base/time/default_clock.h"
  12. #include "build/build_config.h"
  13. #include "build/chromeos_buildflags.h"
  14. #include "components/autofill/core/browser/payments/autofill_wallet_model_type_controller.h"
  15. #include "components/autofill/core/browser/webdata/autocomplete_sync_bridge.h"
  16. #include "components/autofill/core/browser/webdata/autofill_profile_sync_bridge.h"
  17. #include "components/autofill/core/browser/webdata/autofill_wallet_metadata_sync_bridge.h"
  18. #include "components/autofill/core/browser/webdata/autofill_wallet_offer_sync_bridge.h"
  19. #include "components/autofill/core/browser/webdata/autofill_wallet_sync_bridge.h"
  20. #include "components/autofill/core/browser/webdata/autofill_webdata_service.h"
  21. #include "components/browser_sync/active_devices_provider_impl.h"
  22. #include "components/browser_sync/browser_sync_client.h"
  23. #include "components/history/core/browser/sync/history_delete_directives_model_type_controller.h"
  24. #include "components/history/core/browser/sync/history_model_type_controller.h"
  25. #include "components/history/core/common/pref_names.h"
  26. #include "components/password_manager/core/browser/password_store_interface.h"
  27. #include "components/password_manager/core/browser/sync/password_model_type_controller.h"
  28. #include "components/prefs/pref_service.h"
  29. #include "components/reading_list/features/reading_list_switches.h"
  30. #include "components/send_tab_to_self/features.h"
  31. #include "components/send_tab_to_self/send_tab_to_self_model_type_controller.h"
  32. #include "components/send_tab_to_self/send_tab_to_self_sync_service.h"
  33. #include "components/sync/base/features.h"
  34. #include "components/sync/base/legacy_directory_deletion.h"
  35. #include "components/sync/base/report_unrecoverable_error.h"
  36. #include "components/sync/base/sync_prefs.h"
  37. #include "components/sync/driver/data_type_manager_impl.h"
  38. #include "components/sync/driver/glue/sync_engine_impl.h"
  39. #include "components/sync/driver/glue/sync_transport_data_prefs.h"
  40. #include "components/sync/driver/model_type_controller.h"
  41. #include "components/sync/driver/syncable_service_based_model_type_controller.h"
  42. #include "components/sync/engine/sync_engine.h"
  43. #include "components/sync/invalidations/sync_invalidations_service.h"
  44. #include "components/sync/model/forwarding_model_type_controller_delegate.h"
  45. #include "components/sync/model/proxy_model_type_controller_delegate.h"
  46. #include "components/sync_bookmarks/bookmark_sync_service.h"
  47. #include "components/sync_device_info/device_info_sync_service.h"
  48. #include "components/sync_preferences/pref_service_syncable.h"
  49. #include "components/sync_sessions/proxy_tabs_data_type_controller.h"
  50. #include "components/sync_sessions/session_model_type_controller.h"
  51. #include "components/sync_sessions/session_sync_service.h"
  52. #include "components/sync_user_events/user_event_model_type_controller.h"
  53. #if BUILDFLAG(IS_CHROMEOS_ASH)
  54. #include "ash/constants/ash_features.h"
  55. #endif
  56. using syncer::DataTypeController;
  57. using syncer::DataTypeManager;
  58. using syncer::DataTypeManagerImpl;
  59. using syncer::DataTypeManagerObserver;
  60. using syncer::ModelTypeController;
  61. using syncer::SyncableServiceBasedModelTypeController;
  62. namespace browser_sync {
  63. namespace {
  64. // These helper functions only wrap the factory functions of the bridges. This
  65. // way, it simplifies life for the compiler which cannot directly cast
  66. // "WeakPtr<ModelTypeSyncBridge> (AutofillWebDataService*)" to
  67. // "WeakPtr<ModelTypeControllerDelegate> (AutofillWebDataService*)".
  68. base::WeakPtr<syncer::ModelTypeControllerDelegate>
  69. AutocompleteDelegateFromDataService(autofill::AutofillWebDataService* service) {
  70. return autofill::AutocompleteSyncBridge::FromWebDataService(service)
  71. ->change_processor()
  72. ->GetControllerDelegate();
  73. }
  74. base::WeakPtr<syncer::ModelTypeControllerDelegate>
  75. AutofillProfileDelegateFromDataService(
  76. autofill::AutofillWebDataService* service) {
  77. return autofill::AutofillProfileSyncBridge::FromWebDataService(service)
  78. ->change_processor()
  79. ->GetControllerDelegate();
  80. }
  81. base::WeakPtr<syncer::ModelTypeControllerDelegate>
  82. AutofillWalletDelegateFromDataService(
  83. autofill::AutofillWebDataService* service) {
  84. return autofill::AutofillWalletSyncBridge::FromWebDataService(service)
  85. ->change_processor()
  86. ->GetControllerDelegate();
  87. }
  88. base::WeakPtr<syncer::ModelTypeControllerDelegate>
  89. AutofillWalletMetadataDelegateFromDataService(
  90. autofill::AutofillWebDataService* service) {
  91. return autofill::AutofillWalletMetadataSyncBridge::FromWebDataService(service)
  92. ->change_processor()
  93. ->GetControllerDelegate();
  94. }
  95. base::WeakPtr<syncer::ModelTypeControllerDelegate>
  96. AutofillWalletOfferDelegateFromDataService(
  97. autofill::AutofillWebDataService* service) {
  98. return autofill::AutofillWalletOfferSyncBridge::FromWebDataService(service)
  99. ->change_processor()
  100. ->GetControllerDelegate();
  101. }
  102. // Helper function that deals will null (e.g. tests, iOS webview).
  103. base::WeakPtr<syncer::SyncableService> SyncableServiceForPrefs(
  104. sync_preferences::PrefServiceSyncable* prefs_service,
  105. syncer::ModelType type) {
  106. return prefs_service ? prefs_service->GetSyncableService(type)->AsWeakPtr()
  107. : nullptr;
  108. }
  109. } // namespace
  110. SyncApiComponentFactoryImpl::SyncApiComponentFactoryImpl(
  111. browser_sync::BrowserSyncClient* sync_client,
  112. version_info::Channel channel,
  113. const scoped_refptr<base::SequencedTaskRunner>& ui_thread,
  114. const scoped_refptr<base::SequencedTaskRunner>& db_thread,
  115. const scoped_refptr<autofill::AutofillWebDataService>&
  116. web_data_service_on_disk,
  117. const scoped_refptr<autofill::AutofillWebDataService>&
  118. web_data_service_in_memory,
  119. const scoped_refptr<password_manager::PasswordStoreInterface>&
  120. profile_password_store,
  121. const scoped_refptr<password_manager::PasswordStoreInterface>&
  122. account_password_store,
  123. sync_bookmarks::BookmarkSyncService* bookmark_sync_service)
  124. : sync_client_(sync_client),
  125. channel_(channel),
  126. ui_thread_(ui_thread),
  127. db_thread_(db_thread),
  128. engines_and_directory_deletion_thread_(
  129. base::ThreadPool::CreateSequencedTaskRunner(
  130. {base::MayBlock(), base::TaskPriority::USER_VISIBLE,
  131. base::TaskShutdownBehavior::BLOCK_SHUTDOWN})),
  132. web_data_service_on_disk_(web_data_service_on_disk),
  133. web_data_service_in_memory_(web_data_service_in_memory),
  134. profile_password_store_(profile_password_store),
  135. account_password_store_(account_password_store),
  136. bookmark_sync_service_(bookmark_sync_service) {
  137. DCHECK(sync_client_);
  138. }
  139. SyncApiComponentFactoryImpl::~SyncApiComponentFactoryImpl() = default;
  140. syncer::DataTypeController::TypeVector
  141. SyncApiComponentFactoryImpl::CreateCommonDataTypeControllers(
  142. syncer::ModelTypeSet disabled_types,
  143. syncer::SyncService* sync_service) {
  144. syncer::DataTypeController::TypeVector controllers;
  145. const base::RepeatingClosure dump_stack =
  146. base::BindRepeating(&syncer::ReportUnrecoverableError, channel_);
  147. // TODO(crbug.com/1005651): Consider using a separate delegate for
  148. // transport-only.
  149. controllers.push_back(std::make_unique<ModelTypeController>(
  150. syncer::DEVICE_INFO,
  151. /*delegate_for_full_sync_mode=*/
  152. std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  153. sync_client_->GetDeviceInfoSyncService()
  154. ->GetControllerDelegate()
  155. .get()),
  156. /*delegate_for_transport_mode=*/
  157. std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  158. sync_client_->GetDeviceInfoSyncService()
  159. ->GetControllerDelegate()
  160. .get())));
  161. // These features are enabled only if there's a DB thread to post tasks to.
  162. if (db_thread_) {
  163. // Autocomplete sync is enabled by default. Register unless explicitly
  164. // disabled.
  165. if (!disabled_types.Has(syncer::AUTOFILL)) {
  166. controllers.push_back(std::make_unique<ModelTypeController>(
  167. syncer::AUTOFILL,
  168. std::make_unique<syncer::ProxyModelTypeControllerDelegate>(
  169. db_thread_, base::BindRepeating(
  170. &AutocompleteDelegateFromDataService,
  171. base::RetainedRef(web_data_service_on_disk_)))));
  172. }
  173. // Autofill sync is enabled by default. Register unless explicitly
  174. // disabled.
  175. if (!disabled_types.Has(syncer::AUTOFILL_PROFILE)) {
  176. controllers.push_back(std::make_unique<syncer::ModelTypeController>(
  177. syncer::AUTOFILL_PROFILE,
  178. std::make_unique<syncer::ProxyModelTypeControllerDelegate>(
  179. db_thread_, base::BindRepeating(
  180. &AutofillProfileDelegateFromDataService,
  181. base::RetainedRef(web_data_service_on_disk_)))));
  182. }
  183. // Wallet data sync is enabled by default. Register unless explicitly
  184. // disabled.
  185. if (!disabled_types.Has(syncer::AUTOFILL_WALLET_DATA)) {
  186. controllers.push_back(CreateWalletModelTypeControllerWithInMemorySupport(
  187. syncer::AUTOFILL_WALLET_DATA,
  188. base::BindRepeating(&AutofillWalletDelegateFromDataService),
  189. sync_service));
  190. }
  191. // Wallet metadata sync depends on Wallet data sync. Register if neither
  192. // Wallet data nor Wallet metadata sync is explicitly disabled.
  193. if (!disabled_types.Has(syncer::AUTOFILL_WALLET_DATA) &&
  194. !disabled_types.Has(syncer::AUTOFILL_WALLET_METADATA)) {
  195. controllers.push_back(CreateWalletModelTypeController(
  196. syncer::AUTOFILL_WALLET_METADATA,
  197. base::BindRepeating(&AutofillWalletMetadataDelegateFromDataService),
  198. sync_service));
  199. }
  200. // Wallet offer data is enabled by default. Register unless explicitly
  201. // disabled.
  202. if (!disabled_types.Has(syncer::AUTOFILL_WALLET_DATA) &&
  203. !disabled_types.Has(syncer::AUTOFILL_WALLET_OFFER)) {
  204. controllers.push_back(CreateWalletModelTypeController(
  205. syncer::AUTOFILL_WALLET_OFFER,
  206. base::BindRepeating(&AutofillWalletOfferDelegateFromDataService),
  207. sync_service));
  208. }
  209. }
  210. // Bookmark sync is enabled by default. Register unless explicitly
  211. // disabled.
  212. if (!disabled_types.Has(syncer::BOOKMARKS)) {
  213. favicon::FaviconService* favicon_service =
  214. sync_client_->GetFaviconService();
  215. // Services can be null in tests.
  216. if (bookmark_sync_service_ && favicon_service) {
  217. controllers.push_back(std::make_unique<ModelTypeController>(
  218. syncer::BOOKMARKS,
  219. std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  220. bookmark_sync_service_
  221. ->GetBookmarkSyncControllerDelegate(favicon_service)
  222. .get())));
  223. }
  224. }
  225. // TypedUrl sync is enabled by default. Register unless explicitly disabled.
  226. if (!disabled_types.Has(syncer::TYPED_URLS)) {
  227. // HistoryModelTypeController uses a proxy delegate internally, as
  228. // provided by HistoryService.
  229. controllers.push_back(std::make_unique<history::HistoryModelTypeController>(
  230. syncer::TYPED_URLS, sync_service, sync_client_->GetHistoryService(),
  231. sync_client_->GetPrefService()));
  232. }
  233. if (!disabled_types.Has(syncer::HISTORY) &&
  234. base::FeatureList::IsEnabled(syncer::kSyncEnableHistoryDataType)) {
  235. controllers.push_back(std::make_unique<history::HistoryModelTypeController>(
  236. syncer::HISTORY, sync_service, sync_client_->GetHistoryService(),
  237. sync_client_->GetPrefService()));
  238. }
  239. // Delete directive sync is enabled by default.
  240. if (!disabled_types.Has(syncer::HISTORY_DELETE_DIRECTIVES)) {
  241. controllers.push_back(
  242. std::make_unique<history::HistoryDeleteDirectivesModelTypeController>(
  243. dump_stack, sync_service, sync_client_->GetModelTypeStoreService(),
  244. sync_client_->GetHistoryService(), sync_client_->GetPrefService()));
  245. }
  246. if (!disabled_types.Has(syncer::PROXY_TABS)) {
  247. controllers.push_back(
  248. std::make_unique<sync_sessions::ProxyTabsDataTypeController>(
  249. sync_service, sync_client_->GetPrefService(),
  250. base::BindRepeating(
  251. &sync_sessions::SessionSyncService::ProxyTabsStateChanged,
  252. base::Unretained(sync_client_->GetSessionSyncService()))));
  253. }
  254. if (!disabled_types.Has(syncer::SESSIONS)) {
  255. controllers.push_back(
  256. std::make_unique<sync_sessions::SessionModelTypeController>(
  257. sync_service, sync_client_->GetPrefService(),
  258. std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  259. sync_client_->GetSessionSyncService()
  260. ->GetControllerDelegate()
  261. .get())));
  262. }
  263. // Password sync is enabled by default. Register unless explicitly
  264. // disabled.
  265. if (!disabled_types.Has(syncer::PASSWORDS)) {
  266. if (profile_password_store_) {
  267. // |profile_password_store_| can be null in tests.
  268. controllers.push_back(
  269. std::make_unique<password_manager::PasswordModelTypeController>(
  270. profile_password_store_->CreateSyncControllerDelegate(),
  271. account_password_store_
  272. ? account_password_store_->CreateSyncControllerDelegate()
  273. : nullptr,
  274. account_password_store_, sync_client_->GetPrefService(),
  275. sync_client_->GetIdentityManager(), sync_service));
  276. }
  277. }
  278. if (!disabled_types.Has(syncer::PREFERENCES)) {
  279. controllers.push_back(
  280. std::make_unique<SyncableServiceBasedModelTypeController>(
  281. syncer::PREFERENCES,
  282. sync_client_->GetModelTypeStoreService()->GetStoreFactory(),
  283. SyncableServiceForPrefs(sync_client_->GetPrefServiceSyncable(),
  284. syncer::PREFERENCES),
  285. dump_stack));
  286. }
  287. if (!disabled_types.Has(syncer::PRIORITY_PREFERENCES)) {
  288. controllers.push_back(
  289. std::make_unique<SyncableServiceBasedModelTypeController>(
  290. syncer::PRIORITY_PREFERENCES,
  291. sync_client_->GetModelTypeStoreService()->GetStoreFactory(),
  292. SyncableServiceForPrefs(sync_client_->GetPrefServiceSyncable(),
  293. syncer::PRIORITY_PREFERENCES),
  294. dump_stack));
  295. }
  296. // Reading list sync is enabled by default only on iOS. Register unless
  297. // Reading List or Reading List Sync is explicitly disabled.
  298. if (!disabled_types.Has(syncer::READING_LIST) &&
  299. reading_list::switches::IsReadingListEnabled()) {
  300. controllers.push_back(CreateModelTypeControllerForModelRunningOnUIThread(
  301. syncer::READING_LIST));
  302. }
  303. if (!disabled_types.Has(syncer::USER_EVENTS)) {
  304. controllers.push_back(
  305. std::make_unique<syncer::UserEventModelTypeController>(
  306. sync_service,
  307. CreateForwardingControllerDelegate(syncer::USER_EVENTS)));
  308. }
  309. if (!disabled_types.Has(syncer::SEND_TAB_TO_SELF)) {
  310. syncer::ModelTypeControllerDelegate* delegate =
  311. sync_client_->GetSendTabToSelfSyncService()
  312. ->GetControllerDelegate()
  313. .get();
  314. controllers.push_back(
  315. std::make_unique<send_tab_to_self::SendTabToSelfModelTypeController>(
  316. /*delegate_for_full_sync_mode=*/
  317. std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  318. delegate),
  319. /*delegate_for_transport_mode=*/
  320. std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  321. delegate)));
  322. }
  323. if (!disabled_types.Has(syncer::USER_CONSENTS)) {
  324. // Forward both full-sync and transport-only modes to the same delegate,
  325. // since behavior for USER_CONSENTS does not differ (they are always
  326. // persisted).
  327. controllers.push_back(std::make_unique<ModelTypeController>(
  328. syncer::USER_CONSENTS,
  329. /*delegate_for_full_sync_mode=*/
  330. CreateForwardingControllerDelegate(syncer::USER_CONSENTS),
  331. /*delegate_for_transport_mode=*/
  332. CreateForwardingControllerDelegate(syncer::USER_CONSENTS)));
  333. }
  334. return controllers;
  335. }
  336. std::unique_ptr<DataTypeManager>
  337. SyncApiComponentFactoryImpl::CreateDataTypeManager(
  338. const DataTypeController::TypeMap* controllers,
  339. const syncer::DataTypeEncryptionHandler* encryption_handler,
  340. syncer::ModelTypeConfigurer* configurer,
  341. DataTypeManagerObserver* observer) {
  342. return std::make_unique<DataTypeManagerImpl>(controllers, encryption_handler,
  343. configurer, observer);
  344. }
  345. std::unique_ptr<syncer::SyncEngine>
  346. SyncApiComponentFactoryImpl::CreateSyncEngine(
  347. const std::string& name,
  348. invalidation::InvalidationService* invalidator,
  349. syncer::SyncInvalidationsService* sync_invalidation_service) {
  350. return std::make_unique<syncer::SyncEngineImpl>(
  351. name, invalidator, sync_invalidation_service,
  352. std::make_unique<browser_sync::ActiveDevicesProviderImpl>(
  353. sync_client_->GetDeviceInfoSyncService()->GetDeviceInfoTracker(),
  354. base::DefaultClock::GetInstance()),
  355. std::make_unique<syncer::SyncTransportDataPrefs>(
  356. sync_client_->GetPrefService()),
  357. sync_client_->GetModelTypeStoreService()->GetSyncDataPath(),
  358. engines_and_directory_deletion_thread_,
  359. base::BindRepeating(&syncer::SyncClient::OnLocalSyncTransportDataCleared,
  360. base::Unretained(sync_client_)));
  361. }
  362. void SyncApiComponentFactoryImpl::ClearAllTransportData() {
  363. syncer::SyncTransportDataPrefs sync_transport_data_prefs(
  364. sync_client_->GetPrefService());
  365. // Clearing the Directory via DeleteLegacyDirectoryFilesAndNigoriStorage()
  366. // means there's IO involved which may be considerable overhead if
  367. // triggered consistently upon browser startup (which is the case for
  368. // certain codepaths such as the user being signed out). To avoid that, prefs
  369. // are used to determine whether it's worth it.
  370. if (!sync_transport_data_prefs.GetCacheGuid().empty()) {
  371. engines_and_directory_deletion_thread_->PostTask(
  372. FROM_HERE,
  373. base::BindOnce(
  374. &syncer::DeleteLegacyDirectoryFilesAndNigoriStorage,
  375. sync_client_->GetModelTypeStoreService()->GetSyncDataPath()));
  376. }
  377. sync_transport_data_prefs.ClearAll();
  378. sync_client_->OnLocalSyncTransportDataCleared();
  379. }
  380. std::unique_ptr<syncer::ModelTypeControllerDelegate>
  381. SyncApiComponentFactoryImpl::CreateForwardingControllerDelegate(
  382. syncer::ModelType type) {
  383. return std::make_unique<syncer::ForwardingModelTypeControllerDelegate>(
  384. sync_client_->GetControllerDelegateForModelType(type).get());
  385. }
  386. std::unique_ptr<ModelTypeController>
  387. SyncApiComponentFactoryImpl::CreateModelTypeControllerForModelRunningOnUIThread(
  388. syncer::ModelType type) {
  389. return std::make_unique<ModelTypeController>(
  390. type, CreateForwardingControllerDelegate(type));
  391. }
  392. std::unique_ptr<ModelTypeController>
  393. SyncApiComponentFactoryImpl::CreateWalletModelTypeController(
  394. syncer::ModelType type,
  395. const base::RepeatingCallback<
  396. base::WeakPtr<syncer::ModelTypeControllerDelegate>(
  397. autofill::AutofillWebDataService*)>& delegate_from_web_data,
  398. syncer::SyncService* sync_service) {
  399. return std::make_unique<AutofillWalletModelTypeController>(
  400. type,
  401. std::make_unique<syncer::ProxyModelTypeControllerDelegate>(
  402. db_thread_,
  403. base::BindRepeating(delegate_from_web_data,
  404. base::RetainedRef(web_data_service_on_disk_))),
  405. sync_client_->GetPrefService(), sync_service);
  406. }
  407. std::unique_ptr<ModelTypeController>
  408. SyncApiComponentFactoryImpl::CreateWalletModelTypeControllerWithInMemorySupport(
  409. syncer::ModelType type,
  410. const base::RepeatingCallback<
  411. base::WeakPtr<syncer::ModelTypeControllerDelegate>(
  412. autofill::AutofillWebDataService*)>& delegate_from_web_data,
  413. syncer::SyncService* sync_service) {
  414. return std::make_unique<AutofillWalletModelTypeController>(
  415. type, /*delegate_for_full_sync_mode=*/
  416. std::make_unique<syncer::ProxyModelTypeControllerDelegate>(
  417. db_thread_,
  418. base::BindRepeating(delegate_from_web_data,
  419. base::RetainedRef(web_data_service_on_disk_))),
  420. /*delegate_for_transport_mode=*/
  421. std::make_unique<syncer::ProxyModelTypeControllerDelegate>(
  422. db_thread_,
  423. base::BindRepeating(delegate_from_web_data,
  424. base::RetainedRef(web_data_service_in_memory_))),
  425. sync_client_->GetPrefService(), sync_service);
  426. }
  427. } // namespace browser_sync