Delete unused SyncedPrefChangeRegistrar

Bug: none
Change-Id: I7202497b938141a0488d99329733e478e07a1b0e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1869216Reviewed-by: Tim Schumann <tschumann@chromium.org>
Commit-Queue: Marc Treib <treib@chromium.org>
Cr-Commit-Position: refs/heads/master@{#707348}

chrome/browser/prefs/synced_pref_change_registrar_browsertest.cc

-// Copyright 2013 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#include <memory>
-#include <string>
-
-#include "base/bind.h"
-#include "base/json/json_string_value_serializer.h"
-#include "base/message_loop/message_loop_current.h"
-#include "base/run_loop.h"
-#include "base/time/time.h"
-#include "base/values.h"
-#include "chrome/browser/prefs/pref_service_syncable_util.h"
-#include "chrome/browser/ui/browser.h"
-#include "chrome/common/pref_names.h"
-#include "chrome/test/base/in_process_browser_test.h"
-#include "chrome/test/base/testing_profile.h"
-#include "components/policy/core/browser/browser_policy_connector.h"
-#include "components/policy/core/common/mock_configuration_policy_provider.h"
-#include "components/policy/core/common/policy_map.h"
-#include "components/policy/core/common/policy_types.h"
-#include "components/policy/policy_constants.h"
-#include "components/sync/model/fake_sync_change_processor.h"
-#include "components/sync/model/sync_change.h"
-#include "components/sync/model/sync_error_factory.h"
-#include "components/sync/model/sync_error_factory_mock.h"
-#include "components/sync/model/syncable_service.h"
-#include "components/sync/protocol/sync.pb.h"
-#include "components/sync_preferences/synced_pref_change_registrar.h"
-#include "components/sync_preferences/testing_pref_service_syncable.h"
-#include "content/public/test/test_utils.h"
-
-namespace {
-
-using testing::Return;
-using testing::_;
-
-class SyncedPrefChangeRegistrarTest : public InProcessBrowserTest {
- public:
-  SyncedPrefChangeRegistrarTest() : next_sync_data_id_(0) {}
-  ~SyncedPrefChangeRegistrarTest() override {}
-
-  void UpdateChromePolicy(const policy::PolicyMap& policies) {
-    policy_provider_.UpdateChromePolicy(policies);
-    DCHECK(base::MessageLoopCurrent::Get());
-    base::RunLoop loop;
-    loop.RunUntilIdle();
-  }
-
-  void SetBooleanPrefValueFromSync(const std::string& name, bool value) {
-    std::string serialized_value;
-    JSONStringValueSerializer json(&serialized_value);
-    json.Serialize(base::Value(value));
-
-    sync_pb::EntitySpecifics specifics;
-    sync_pb::PreferenceSpecifics* pref_specifics =
-        specifics.mutable_preference();
-    pref_specifics->set_name(name);
-    pref_specifics->set_value(serialized_value);
-
-    syncer::SyncData change_data =
-        syncer::SyncData::CreateRemoteData(++next_sync_data_id_, specifics);
-    syncer::SyncChange change(
-        FROM_HERE, syncer::SyncChange::ACTION_UPDATE, change_data);
-
-    syncer::SyncChangeList change_list;
-    change_list.push_back(change);
-
-    syncer_->ProcessSyncChanges(FROM_HERE, change_list);
-  }
-
-  void SetBooleanPrefValueFromLocal(const std::string& name, bool value) {
-    prefs_->SetBoolean(name.c_str(), value);
-  }
-
-  bool GetBooleanPrefValue(const std::string& name) {
-    return prefs_->GetBoolean(name.c_str());
-  }
-
-  sync_preferences::PrefServiceSyncable* prefs() const { return prefs_; }
-
-  sync_preferences::SyncedPrefChangeRegistrar* registrar() const {
-    return registrar_.get();
-  }
-
- private:
-  void SetUpInProcessBrowserTestFixture() override {
-    EXPECT_CALL(policy_provider_, IsInitializationComplete(_))
-        .WillRepeatedly(Return(true));
-    policy::BrowserPolicyConnector::SetPolicyProviderForTesting(
-        &policy_provider_);
-  }
-
-  void SetUpOnMainThread() override {
-    prefs_ = PrefServiceSyncableFromProfile(browser()->profile());
-    syncer_ = prefs_->GetSyncableService(syncer::PREFERENCES);
-    syncer_->MergeDataAndStartSyncing(
-        syncer::PREFERENCES, syncer::SyncDataList(),
-        std::unique_ptr<syncer::SyncChangeProcessor>(
-            new syncer::FakeSyncChangeProcessor),
-        std::unique_ptr<syncer::SyncErrorFactory>(
-            new syncer::SyncErrorFactoryMock));
-    registrar_.reset(new sync_preferences::SyncedPrefChangeRegistrar(prefs_));
-  }
-
-  void TearDownOnMainThread() override { registrar_.reset(); }
-
-  sync_preferences::PrefServiceSyncable* prefs_;
-  syncer::SyncableService* syncer_;
-  int next_sync_data_id_;
-
-  std::unique_ptr<sync_preferences::SyncedPrefChangeRegistrar> registrar_;
-  policy::MockConfigurationPolicyProvider policy_provider_;
-};
-
-struct TestSyncedPrefObserver {
-  bool last_seen_value;
-  bool last_update_is_from_sync;
-  bool has_been_notified;
-};
-
-void TestPrefChangeCallback(PrefService* prefs,
-                            TestSyncedPrefObserver* observer,
-                            const std::string& path,
-                            bool from_sync) {
-  observer->last_seen_value = prefs->GetBoolean(path.c_str());
-  observer->last_update_is_from_sync = from_sync;
-  observer->has_been_notified = true;
-}
-
-}  // namespace
-
-IN_PROC_BROWSER_TEST_F(SyncedPrefChangeRegistrarTest,
-                       DifferentiateRemoteAndLocalChanges) {
-  TestSyncedPrefObserver observer = {};
-  registrar()->Add(prefs::kShowHomeButton,
-      base::Bind(&TestPrefChangeCallback, prefs(), &observer));
-
-  EXPECT_FALSE(observer.has_been_notified);
-
-  SetBooleanPrefValueFromSync(prefs::kShowHomeButton, true);
-  EXPECT_TRUE(observer.has_been_notified);
-  EXPECT_TRUE(GetBooleanPrefValue(prefs::kShowHomeButton));
-  EXPECT_TRUE(observer.last_update_is_from_sync);
-  EXPECT_TRUE(observer.last_seen_value);
-
-  observer.has_been_notified = false;
-  SetBooleanPrefValueFromLocal(prefs::kShowHomeButton, false);
-  EXPECT_TRUE(observer.has_been_notified);
-  EXPECT_FALSE(GetBooleanPrefValue(prefs::kShowHomeButton));
-  EXPECT_FALSE(observer.last_update_is_from_sync);
-  EXPECT_FALSE(observer.last_seen_value);
-
-  observer.has_been_notified = false;
-  SetBooleanPrefValueFromLocal(prefs::kShowHomeButton, true);
-  EXPECT_TRUE(observer.has_been_notified);
-  EXPECT_TRUE(GetBooleanPrefValue(prefs::kShowHomeButton));
-  EXPECT_FALSE(observer.last_update_is_from_sync);
-  EXPECT_TRUE(observer.last_seen_value);
-
-  observer.has_been_notified = false;
-  SetBooleanPrefValueFromSync(prefs::kShowHomeButton, false);
-  EXPECT_TRUE(observer.has_been_notified);
-  EXPECT_FALSE(GetBooleanPrefValue(prefs::kShowHomeButton));
-  EXPECT_TRUE(observer.last_update_is_from_sync);
-  EXPECT_FALSE(observer.last_seen_value);
-}
-
-IN_PROC_BROWSER_TEST_F(SyncedPrefChangeRegistrarTest,
-                       IgnoreLocalChangesToManagedPrefs) {
-  TestSyncedPrefObserver observer = {};
-  registrar()->Add(prefs::kShowHomeButton,
-      base::Bind(&TestPrefChangeCallback, prefs(), &observer));
-
-  policy::PolicyMap policies;
-  policies.Set(policy::key::kShowHomeButton, policy::POLICY_LEVEL_MANDATORY,
-               policy::POLICY_SCOPE_USER, policy::POLICY_SOURCE_CLOUD,
-               std::make_unique<base::Value>(true), nullptr);
-  UpdateChromePolicy(policies);
-
-  EXPECT_TRUE(prefs()->IsManagedPreference(prefs::kShowHomeButton));
-
-  SetBooleanPrefValueFromLocal(prefs::kShowHomeButton, false);
-  EXPECT_FALSE(observer.has_been_notified);
-  EXPECT_TRUE(GetBooleanPrefValue(prefs::kShowHomeButton));
-}
-
-IN_PROC_BROWSER_TEST_F(SyncedPrefChangeRegistrarTest,
-                       IgnoreSyncChangesToManagedPrefs) {
-  TestSyncedPrefObserver observer = {};
-  registrar()->Add(prefs::kShowHomeButton,
-      base::Bind(&TestPrefChangeCallback, prefs(), &observer));
-
-  policy::PolicyMap policies;
-  policies.Set(policy::key::kShowHomeButton, policy::POLICY_LEVEL_MANDATORY,
-               policy::POLICY_SCOPE_USER, policy::POLICY_SOURCE_CLOUD,
-               std::make_unique<base::Value>(true), nullptr);
-  UpdateChromePolicy(policies);
-
-  EXPECT_TRUE(prefs()->IsManagedPreference(prefs::kShowHomeButton));
-  SetBooleanPrefValueFromSync(prefs::kShowHomeButton, false);
-  EXPECT_FALSE(observer.has_been_notified);
-  EXPECT_TRUE(GetBooleanPrefValue(prefs::kShowHomeButton));
-}

chrome/test/BUILD.gn

@@ -1060,7 +1060,6 @@ if (!is_android) {
       "../browser/prefetch/prefetch_browsertest.cc",
       "../browser/prefs/pref_functional_browsertest.cc",
       "../browser/prefs/pref_service_browsertest.cc",
-      "../browser/prefs/synced_pref_change_registrar_browsertest.cc",
       "../browser/prefs/tracked/pref_hash_browsertest.cc",
       "../browser/prerender/prerender_browsertest.cc",
       "../browser/prerender/prerender_nostate_prefetch_browsertest.cc",

components/sync_preferences/BUILD.gn

@@ -14,8 +14,6 @@ static_library("sync_preferences") {
     "pref_service_syncable_factory.cc",
     "pref_service_syncable_factory.h",
     "pref_service_syncable_observer.h",
-    "synced_pref_change_registrar.cc",
-    "synced_pref_change_registrar.h",
     "synced_pref_observer.h",
   ]
 

components/sync_preferences/synced_pref_change_registrar.cc

-// Copyright 2013 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#include "components/sync_preferences/synced_pref_change_registrar.h"
-
-#include "base/bind.h"
-
-namespace sync_preferences {
-
-namespace {
-
-void InvokeUnnamedCallback(
-    const SyncedPrefChangeRegistrar::ChangeCallback& callback,
-    const std::string& path,
-    bool from_sync) {
-  callback.Run(from_sync);
-}
-
-}  // namespace
-
-SyncedPrefChangeRegistrar::SyncedPrefChangeRegistrar(
-    PrefServiceSyncable* pref_service) {
-  pref_service_ = pref_service;
-}
-
-SyncedPrefChangeRegistrar::~SyncedPrefChangeRegistrar() {
-  RemoveAll();
-}
-
-void SyncedPrefChangeRegistrar::Add(const char* path,
-                                    const ChangeCallback& callback) {
-  Add(path, base::Bind(InvokeUnnamedCallback, callback));
-}
-
-void SyncedPrefChangeRegistrar::Add(const char* path,
-                                    const NamedChangeCallback& callback) {
-  DCHECK(!IsObserved(path));
-  observers_[path] = callback;
-  pref_service_->AddSyncedPrefObserver(path, this);
-}
-
-void SyncedPrefChangeRegistrar::Remove(const char* path) {
-  observers_.erase(path);
-  pref_service_->RemoveSyncedPrefObserver(path, this);
-}
-
-void SyncedPrefChangeRegistrar::RemoveAll() {
-  for (auto iter = observers_.begin(); iter != observers_.end(); ++iter) {
-    pref_service_->RemoveSyncedPrefObserver(iter->first, this);
-  }
-  observers_.clear();
-}
-
-bool SyncedPrefChangeRegistrar::IsObserved(const char* path) const {
-  return observers_.find(path) != observers_.end();
-}
-
-void SyncedPrefChangeRegistrar::OnSyncedPrefChanged(const std::string& path,
-                                                    bool from_sync) {
-  if (pref_service_->IsManagedPreference(path))
-    return;
-  ObserverMap::const_iterator iter = observers_.find(path);
-  if (iter == observers_.end())
-    return;
-  iter->second.Run(path, from_sync);
-}
-
-}  // namespace sync_preferences

components/sync_preferences/synced_pref_change_registrar.h

-// Copyright 2013 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#ifndef COMPONENTS_SYNC_PREFERENCES_SYNCED_PREF_CHANGE_REGISTRAR_H_
-#define COMPONENTS_SYNC_PREFERENCES_SYNCED_PREF_CHANGE_REGISTRAR_H_
-
-#include <map>
-#include <string>
-
-#include "base/callback.h"
-#include "base/macros.h"
-#include "components/sync_preferences/pref_service_syncable.h"
-#include "components/sync_preferences/synced_pref_observer.h"
-
-namespace sync_preferences {
-
-// Manages the registration of one or more SyncedPrefObservers on a
-// PrefServiceSyncable. This is modeled after base::PrefChangeRegistrar, and
-// it should be used whenever it's necessary to determine whether a pref change
-// has come from sync or from some other mechanism (managed, UI, external, etc.)
-class SyncedPrefChangeRegistrar : public SyncedPrefObserver {
- public:
-  // Registered callbacks may optionally take a path argument.
-  // The boolean argument indicates whether (true) or not (false)
-  // the change was a result of syncing.
-  typedef base::Callback<void(bool)> ChangeCallback;
-  typedef base::Callback<void(const std::string&, bool)> NamedChangeCallback;
-
-  explicit SyncedPrefChangeRegistrar(PrefServiceSyncable* pref_service);
-  virtual ~SyncedPrefChangeRegistrar();
-
-  // Register an observer callback for sync change events on the pref at
-  // |path|. Only one callback may be registered per pref.
-  void Add(const char* path, const ChangeCallback& callback);
-  void Add(const char* path, const NamedChangeCallback& callback);
-
-  // Remove the registered observer for |path|.
-  void Remove(const char* path);
-
-  // Remove all registered observers.
-  void RemoveAll();
-
-  // Indicates whether or not an observer is already registered for |path|.
-  bool IsObserved(const char* path) const;
-
- private:
-  // SyncedPrefObserver implementation
-  void OnSyncedPrefChanged(const std::string& path, bool from_sync) override;
-
-  typedef std::map<std::string, NamedChangeCallback> ObserverMap;
-
-  PrefServiceSyncable* pref_service_;
-  ObserverMap observers_;
-
-  DISALLOW_COPY_AND_ASSIGN(SyncedPrefChangeRegistrar);
-};
-
-}  // namespace sync_preferences
-
-#endif  // COMPONENTS_SYNC_PREFERENCES_SYNCED_PREF_CHANGE_REGISTRAR_H_