Rename InvalidationState to BootstrapData

We have a lot of things called 'state' in sync/, so we're renaming them to
better reflect their actual purpose. The 'state' in this CL is used for
bootstrapping a connection to the cache invalidation server, so we don't need
to go through the process of re-registering each ID we're interested in each
time we reconnect.

BUG=none


Review URL: https://chromiumcodereview.appspot.com/11050005

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@159845 0039d316-1c4b-4281-b951-d872f2087c98

13 files changed, 53 insertions, 52 deletions

diff --git a/sync/notifier/fake_invalidation_state_tracker.cc b/sync/notifier/fake_invalidation_state_tracker.cc
index b4d5e36..a64079b 100644
--- a/sync/notifier/fake_invalidation_state_tracker.cc
+++ b/sync/notifier/fake_invalidation_state_tracker.cc
@@ -41,13 +41,13 @@ void FakeInvalidationStateTracker::Forget(const ObjectIdSet& ids) {
   }
 }
 
-void FakeInvalidationStateTracker::SetInvalidationState(
-    const std::string& state) {
-  state_ = state;
+void FakeInvalidationStateTracker::SetBootstrapData(
+    const std::string& data) {
+  bootstrap_data_ = data;
 }
 
-std::string FakeInvalidationStateTracker::GetInvalidationState() const {
-  return state_;
+std::string FakeInvalidationStateTracker::GetBootstrapData() const {
+  return bootstrap_data_;
 }
 
 }  // namespace syncer
diff --git a/sync/notifier/fake_invalidation_state_tracker.h b/sync/notifier/fake_invalidation_state_tracker.h
index c1a9a42..aea358d 100644
--- a/sync/notifier/fake_invalidation_state_tracker.h
+++ b/sync/notifier/fake_invalidation_state_tracker.h
@@ -26,14 +26,14 @@ class FakeInvalidationStateTracker
   virtual void SetMaxVersion(const invalidation::ObjectId& id,
                              int64 max_version) OVERRIDE;
   virtual void Forget(const ObjectIdSet& ids) OVERRIDE;
-  virtual void SetInvalidationState(const std::string& state) OVERRIDE;
-  virtual std::string GetInvalidationState() const OVERRIDE;
+  virtual void SetBootstrapData(const std::string& data) OVERRIDE;
+  virtual std::string GetBootstrapData() const OVERRIDE;
 
   static const int64 kMinVersion;
 
  private:
   InvalidationVersionMap versions_;
-  std::string state_;
+  std::string bootstrap_data_;
 };
 
 }  // namespace syncer
diff --git a/sync/notifier/invalidation_notifier.cc b/sync/notifier/invalidation_notifier.cc
index aaab368..7b00b12 100644
--- a/sync/notifier/invalidation_notifier.cc
+++ b/sync/notifier/invalidation_notifier.cc
@@ -20,14 +20,14 @@ namespace syncer {
 InvalidationNotifier::InvalidationNotifier(
     scoped_ptr<notifier::PushClient> push_client,
     const InvalidationVersionMap& initial_max_invalidation_versions,
-    const std::string& initial_invalidation_state,
+    const std::string& invalidation_bootstrap_data,
     const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
     const std::string& client_info)
     : state_(STOPPED),
       initial_max_invalidation_versions_(initial_max_invalidation_versions),
       invalidation_state_tracker_(invalidation_state_tracker),
       client_info_(client_info),
-      invalidation_state_(initial_invalidation_state),
+      invalidation_bootstrap_data_(invalidation_bootstrap_data),
       invalidation_listener_(push_client.Pass()) {
 }
 
@@ -67,7 +67,7 @@ void InvalidationNotifier::SetUniqueId(const std::string& unique_id) {
 void InvalidationNotifier::SetStateDeprecated(const std::string& state) {
   DCHECK(CalledOnValidThread());
   DCHECK_LT(state_, STARTED);
-  if (invalidation_state_.empty()) {
+  if (invalidation_bootstrap_data_.empty()) {
     // Migrate state from sync to invalidation state tracker (bug
     // 124140).  We've just been handed state from the syncable::Directory, and
     // the initial invalidation state was empty, implying we've never written
@@ -75,9 +75,9 @@ void InvalidationNotifier::SetStateDeprecated(const std::string& state) {
     // we fail to establish an initial connection or receive an initial
     // invalidation) so that we can make the old code obsolete as soon as
     // possible.
-    invalidation_state_ = state;
+    invalidation_bootstrap_data_ = state;
     invalidation_state_tracker_.Call(
-        FROM_HERE, &InvalidationStateTracker::SetInvalidationState, state);
+        FROM_HERE, &InvalidationStateTracker::SetBootstrapData, state);
     UMA_HISTOGRAM_BOOLEAN("InvalidationNotifier.UsefulSetState", true);
   } else {
     UMA_HISTOGRAM_BOOLEAN("InvalidationNotifier.UsefulSetState", false);
@@ -89,11 +89,11 @@ void InvalidationNotifier::UpdateCredentials(
   if (state_ == STOPPED) {
     invalidation_listener_.Start(
         base::Bind(&invalidation::CreateInvalidationClient),
-        client_id_, client_info_, invalidation_state_,
+        client_id_, client_info_, invalidation_bootstrap_data_,
         initial_max_invalidation_versions_,
         invalidation_state_tracker_,
         this);
-    invalidation_state_.clear();
+    invalidation_bootstrap_data_.clear();
     state_ = STARTED;
   }
   invalidation_listener_.UpdateCredentials(email, token);
diff --git a/sync/notifier/invalidation_notifier.h b/sync/notifier/invalidation_notifier.h
index a1c4328..ae67a22 100644
--- a/sync/notifier/invalidation_notifier.h
+++ b/sync/notifier/invalidation_notifier.h
@@ -42,7 +42,7 @@ class InvalidationNotifier
   InvalidationNotifier(
       scoped_ptr<notifier::PushClient> push_client,
       const InvalidationVersionMap& initial_max_invalidation_versions,
-      const std::string& initial_invalidation_state,
+      const std::string& invalidation_bootstrap_data,
       const WeakHandle<InvalidationStateTracker>&
           invalidation_state_tracker,
       const std::string& client_info);
@@ -92,10 +92,10 @@ class InvalidationNotifier
   // The client ID to pass to |invalidation_listener_|.
   std::string client_id_;
 
-  // The state to pass to |invalidation_listener_|.
+  // The initial bootstrap data to pass to |invalidation_listener_|.
   // TODO(tim): This should be made const once migration is completed for bug
   // 124140.
-  std::string invalidation_state_;
+  std::string invalidation_bootstrap_data_;
 
   // The invalidation listener.
   SyncInvalidationListener invalidation_listener_;
diff --git a/sync/notifier/invalidation_state_tracker.h b/sync/notifier/invalidation_state_tracker.h
index 3105f3a..5541142 100644
--- a/sync/notifier/invalidation_state_tracker.h
+++ b/sync/notifier/invalidation_state_tracker.h
@@ -32,12 +32,12 @@ class InvalidationStateTracker {
   // Removes all state tracked for |ids|.
   virtual void Forget(const ObjectIdSet& ids) = 0;
 
-  // Used by InvalidationClient for persistence. |state| is opaque data we can
-  // present back to the client (e.g. after a restart) for it to bootstrap
-  // itself.
-  // |state| is plain old data (not valid UTF8, embedded nulls, etc).
-  virtual void SetInvalidationState(const std::string& state) = 0;
-  virtual std::string GetInvalidationState() const = 0;
+  // Used by invalidation::InvalidationClient for persistence. |data| is an
+  // opaque blob that an invalidation client can use after a restart to
+  // bootstrap itself. |data| is binary data (not valid UTF8, embedded nulls,
+  // etc).
+  virtual void SetBootstrapData(const std::string& data) = 0;
+  virtual std::string GetBootstrapData() const = 0;
 
  protected:
   virtual ~InvalidationStateTracker() {}
diff --git a/sync/notifier/invalidator_factory.cc b/sync/notifier/invalidator_factory.cc
index 80ceb16..ea0d59d 100644
--- a/sync/notifier/invalidator_factory.cc
+++ b/sync/notifier/invalidator_factory.cc
@@ -18,7 +18,7 @@ namespace {
 Invalidator* CreateDefaultInvalidator(
     const notifier::NotifierOptions& notifier_options,
     const InvalidationVersionMap& initial_max_invalidation_versions,
-    const std::string& initial_invalidation_state,
+    const std::string& invalidation_bootstrap_data,
     const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
     const std::string& client_info) {
   if (notifier_options.notification_method == notifier::NOTIFICATION_P2P) {
@@ -33,7 +33,7 @@ Invalidator* CreateDefaultInvalidator(
 
   return new NonBlockingInvalidator(
       notifier_options, initial_max_invalidation_versions,
-      initial_invalidation_state, invalidation_state_tracker, client_info);
+      invalidation_bootstrap_data, invalidation_state_tracker, client_info);
 }
 
 }  // namespace
@@ -50,9 +50,9 @@ InvalidatorFactory::InvalidatorFactory(
           invalidation_state_tracker.get() ?
           invalidation_state_tracker->GetAllMaxVersions() :
           InvalidationVersionMap()),
-      initial_invalidation_state_(
+      invalidation_bootstrap_data_(
           invalidation_state_tracker.get() ?
-          invalidation_state_tracker->GetInvalidationState() :
+          invalidation_state_tracker->GetBootstrapData() :
           std::string()),
       invalidation_state_tracker_(invalidation_state_tracker) {
 }
@@ -67,7 +67,7 @@ Invalidator* InvalidatorFactory::CreateInvalidator() {
 #else
   return CreateDefaultInvalidator(notifier_options_,
                                   initial_max_invalidation_versions_,
-                                  initial_invalidation_state_,
+                                  invalidation_bootstrap_data_,
                                   invalidation_state_tracker_,
                                   client_info_);
 #endif
diff --git a/sync/notifier/invalidator_factory.h b/sync/notifier/invalidator_factory.h
index 48763cd..c92291f 100644
--- a/sync/notifier/invalidator_factory.h
+++ b/sync/notifier/invalidator_factory.h
@@ -39,7 +39,7 @@ class InvalidatorFactory {
   const notifier::NotifierOptions notifier_options_;
   const std::string client_info_;
   const InvalidationVersionMap initial_max_invalidation_versions_;
-  const std::string initial_invalidation_state_;
+  const std::string invalidation_bootstrap_data_;
   const WeakHandle<InvalidationStateTracker>
       invalidation_state_tracker_;
 };
diff --git a/sync/notifier/invalidator_test_template.h b/sync/notifier/invalidator_test_template.h
index 8aadade..5bf841c 100644
--- a/sync/notifier/invalidator_test_template.h
+++ b/sync/notifier/invalidator_test_template.h
@@ -115,9 +115,9 @@ class InvalidatorTest : public testing::Test {
     // associated issues are fixed.
     invalidator->SetStateDeprecated("fake_state");
     this->delegate_.WaitForInvalidator();
-    // We don't expect |fake_tracker_|'s state to change, as we
-    // initialized with non-empty initial_invalidation_state above.
-    EXPECT_TRUE(this->fake_tracker_.GetInvalidationState().empty());
+    // We don't expect |fake_tracker_|'s bootstrap data to change, as we
+    // initialized with a non-empty value previously.
+    EXPECT_TRUE(this->fake_tracker_.GetBootstrapData().empty());
     invalidator->SetUniqueId("fake_id");
     this->delegate_.WaitForInvalidator();
     invalidator->UpdateCredentials("foo@bar.com", "fake_token");
@@ -383,10 +383,10 @@ TYPED_TEST_P(InvalidatorTest, GetInvalidatorStateAlwaysCurrent) {
   EXPECT_EQ(TRANSIENT_INVALIDATION_ERROR, handler.GetLastRetrievedState());
 }
 
-// Initialize the invalidator with an empty initial state.  Call the deprecated
+// Initialize the invalidator with no bootstrap data.  Call the deprecated
 // state setter function a number of times, destroying and re-creating the
-// invalidator in between.  Only the first one should take effect (i.e., state
-// migration should only happen once).
+// invalidator in between.  Only the first one should take effect (i.e.,
+// migration of bootstrap data should only happen once)
 TYPED_TEST_P(InvalidatorTest, MigrateState) {
   if (!this->delegate_.InvalidatorHandlesDeprecatedState()) {
     DLOG(INFO) << "This Invalidator doesn't handle deprecated state; "
@@ -400,12 +400,12 @@ TYPED_TEST_P(InvalidatorTest, MigrateState) {
 
   invalidator->SetStateDeprecated("fake_state");
   this->delegate_.WaitForInvalidator();
-  EXPECT_EQ("fake_state", this->fake_tracker_.GetInvalidationState());
+  EXPECT_EQ("fake_state", this->fake_tracker_.GetBootstrapData());
 
   // Should do nothing.
   invalidator->SetStateDeprecated("spurious_fake_state");
   this->delegate_.WaitForInvalidator();
-  EXPECT_EQ("fake_state", this->fake_tracker_.GetInvalidationState());
+  EXPECT_EQ("fake_state", this->fake_tracker_.GetBootstrapData());
 
   // Pretend that Chrome has shut down.
   this->delegate_.DestroyInvalidator();
@@ -416,7 +416,7 @@ TYPED_TEST_P(InvalidatorTest, MigrateState) {
   // Should do nothing.
   invalidator->SetStateDeprecated("more_spurious_fake_state");
   this->delegate_.WaitForInvalidator();
-  EXPECT_EQ("fake_state", this->fake_tracker_.GetInvalidationState());
+  EXPECT_EQ("fake_state", this->fake_tracker_.GetBootstrapData());
 }
 
 REGISTER_TYPED_TEST_CASE_P(InvalidatorTest,
diff --git a/sync/notifier/non_blocking_invalidator.cc b/sync/notifier/non_blocking_invalidator.cc
index 0574415..8b80a04 100644
--- a/sync/notifier/non_blocking_invalidator.cc
+++ b/sync/notifier/non_blocking_invalidator.cc
@@ -31,7 +31,7 @@ class NonBlockingInvalidator::Core
   void Initialize(
       const notifier::NotifierOptions& notifier_options,
       const InvalidationVersionMap& initial_max_invalidation_versions,
-      const std::string& initial_invalidation_state,
+      const std::string& invalidation_bootstrap_data,
       const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
       const std::string& client_info);
   void Teardown();
@@ -73,7 +73,7 @@ NonBlockingInvalidator::Core::~Core() {
 void NonBlockingInvalidator::Core::Initialize(
     const notifier::NotifierOptions& notifier_options,
     const InvalidationVersionMap& initial_max_invalidation_versions,
-    const std::string& initial_invalidation_state,
+    const std::string& invalidation_bootstrap_data,
     const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
     const std::string& client_info) {
   DCHECK(notifier_options.request_context_getter);
@@ -86,7 +86,7 @@ void NonBlockingInvalidator::Core::Initialize(
       new InvalidationNotifier(
           notifier::PushClient::CreateDefaultOnIOThread(notifier_options),
           initial_max_invalidation_versions,
-          initial_invalidation_state,
+          invalidation_bootstrap_data,
           invalidation_state_tracker,
           client_info));
   invalidation_notifier_->RegisterHandler(this);
@@ -140,7 +140,7 @@ void NonBlockingInvalidator::Core::OnIncomingInvalidation(
 NonBlockingInvalidator::NonBlockingInvalidator(
     const notifier::NotifierOptions& notifier_options,
     const InvalidationVersionMap& initial_max_invalidation_versions,
-    const std::string& initial_invalidation_state,
+    const std::string& invalidation_bootstrap_data,
     const WeakHandle<InvalidationStateTracker>&
         invalidation_state_tracker,
     const std::string& client_info)
@@ -158,7 +158,7 @@ NonBlockingInvalidator::NonBlockingInvalidator(
               core_.get(),
               notifier_options,
               initial_max_invalidation_versions,
-              initial_invalidation_state,
+              invalidation_bootstrap_data,
               invalidation_state_tracker,
               client_info))) {
     NOTREACHED();
diff --git a/sync/notifier/non_blocking_invalidator.h b/sync/notifier/non_blocking_invalidator.h
index 35e870b..30e245f 100644
--- a/sync/notifier/non_blocking_invalidator.h
+++ b/sync/notifier/non_blocking_invalidator.h
@@ -38,7 +38,7 @@ class NonBlockingInvalidator
   NonBlockingInvalidator(
       const notifier::NotifierOptions& notifier_options,
       const InvalidationVersionMap& initial_max_invalidation_versions,
-      const std::string& initial_invalidation_state,
+      const std::string& invalidation_bootstrap_data,
       const WeakHandle<InvalidationStateTracker>&
           invalidation_state_tracker,
       const std::string& client_info);
diff --git a/sync/notifier/sync_invalidation_listener.cc b/sync/notifier/sync_invalidation_listener.cc
index 9e8b2ad..f879683 100644
--- a/sync/notifier/sync_invalidation_listener.cc
+++ b/sync/notifier/sync_invalidation_listener.cc
@@ -51,7 +51,7 @@ void SyncInvalidationListener::Start(
     const CreateInvalidationClientCallback&
         create_invalidation_client_callback,
     const std::string& client_id, const std::string& client_info,
-    const std::string& state,
+    const std::string& invalidation_bootstrap_data,
     const InvalidationVersionMap& initial_max_invalidation_versions,
     const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
     Delegate* delegate) {
@@ -64,7 +64,8 @@ void SyncInvalidationListener::Start(
   // The Storage resource is implemented as a write-through cache.  We populate
   // it with the initial state on startup, so subsequent writes go to disk and
   // update the in-memory cache, while reads just return the cached state.
-  sync_system_resources_.storage()->SetInitialState(state);
+  sync_system_resources_.storage()->SetInitialState(
+      invalidation_bootstrap_data);
 
   max_invalidation_versions_ = initial_max_invalidation_versions;
   if (max_invalidation_versions_.empty()) {
@@ -285,7 +286,7 @@ void SyncInvalidationListener::WriteState(const std::string& state) {
   DCHECK(CalledOnValidThread());
   DVLOG(1) << "WriteState";
   invalidation_state_tracker_.Call(
-      FROM_HERE, &InvalidationStateTracker::SetInvalidationState, state);
+      FROM_HERE, &InvalidationStateTracker::SetBootstrapData, state);
 }
 
 void SyncInvalidationListener::DoRegistrationUpdate() {
diff --git a/sync/notifier/sync_invalidation_listener.h b/sync/notifier/sync_invalidation_listener.h
index ed7f031..0a63bd6 100644
--- a/sync/notifier/sync_invalidation_listener.h
+++ b/sync/notifier/sync_invalidation_listener.h
@@ -73,7 +73,7 @@ class SyncInvalidationListener
       const CreateInvalidationClientCallback&
           create_invalidation_client_callback,
       const std::string& client_id, const std::string& client_info,
-      const std::string& state,
+      const std::string& invalidation_bootstrap_data,
       const InvalidationVersionMap& initial_max_invalidation_versions,
       const WeakHandle<InvalidationStateTracker>& invalidation_state_tracker,
       Delegate* delegate);
diff --git a/sync/notifier/sync_invalidation_listener_unittest.cc b/sync/notifier/sync_invalidation_listener_unittest.cc
index 11e35fc..d17f988 100644
--- a/sync/notifier/sync_invalidation_listener_unittest.cc
+++ b/sync/notifier/sync_invalidation_listener_unittest.cc
@@ -225,8 +225,8 @@ class SyncInvalidationListenerTest : public testing::Test {
     return fake_tracker_.GetMaxVersion(id);
   }
 
-  std::string GetInvalidationState() const {
-    return fake_tracker_.GetInvalidationState();
+  std::string GetBootstrapData() const {
+    return fake_tracker_.GetBootstrapData();
   }
 
   ObjectIdSet GetRegisteredIds() const {
@@ -330,7 +330,7 @@ class SyncInvalidationListenerTest : public testing::Test {
 TEST_F(SyncInvalidationListenerTest, WriteState) {
   WriteState(kNewState);
 
-  EXPECT_EQ(kNewState, GetInvalidationState());
+  EXPECT_EQ(kNewState, GetBootstrapData());
 }
 
 // Invalidation tests.