Refactor sync passphrase setup flow and fix passphrase tests

chrome/browser/sync/profile_sync_service.h

 // Copyright (c) 2011 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 CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_
 #define CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_
 #pragma once
 
 #include <string>
 
@@ skipping 177 matching lines @@
   virtual void SetSyncSetupCompleted();
 
   // SyncFrontend implementation.
   virtual void OnBackendInitialized();
   virtual void OnSyncCycleCompleted();
   virtual void OnAuthError();
   virtual void OnStopSyncingPermanently();
   virtual void OnClearServerDataFailed();
   virtual void OnClearServerDataTimeout();
   virtual void OnClearServerDataSucceeded();
-  virtual void OnPassphraseRequired(bool for_decryption);
+  virtual void OnPassphraseRequired(sync_api::PassphraseRequiredReason reason);
   virtual void OnPassphraseAccepted();
   virtual void OnEncryptionComplete(
       const syncable::ModelTypeSet& encrypted_types);
   virtual void OnMigrationNeededForTypes(
       const syncable::ModelTypeSet& types);
 
   // Called when a user enters credentials through UI.
   virtual void OnUserSubmittedAuth(const std::string& username,
                                    const std::string& password,
                                    const std::string& captcha,
@@ skipping 66 matching lines @@
   }
   tracked_objects::Location unrecoverable_error_location() {
     return unrecoverable_error_location_.get() ?
         *unrecoverable_error_location_.get() : tracked_objects::Location();
   }
 
   bool UIShouldDepictAuthInProgress() const {
     return is_auth_in_progress_;
   }
 
-  bool observed_passphrase_required() const {
-    return observed_passphrase_required_;
+  // Returns true if OnPassphraseRequired has been called for any reason.
+  bool ObservedPassphraseRequired() const {
+    return passphrase_required_reason_ !=
+        sync_api::REASON_PASSPHRASE_NOT_REQUIRED;
   }
 
-  bool passphrase_required_for_decryption() const {
-    return passphrase_required_for_decryption_;
+  sync_api::PassphraseRequiredReason passphrase_required_reason() const {
+    return passphrase_required_reason_;
   }
 
   // Returns a user-friendly string form of last synced time (in minutes).
   virtual string16 GetLastSyncedTimeString() const;
 
   // Returns the authenticated username of the sync user, or empty if none
   // exists. It will only exist if the authentication service provider (e.g
   // GAIA) has confirmed the username is authentic.
   virtual string16 GetAuthenticatedUsername() const;
 
@@ skipping 201 matching lines @@
   // service using this member. Captcha and error state are reflected.
   GoogleServiceAuthError last_auth_error_;
 
   // Our asynchronous backend to communicate with sync components living on
   // other threads.
   scoped_ptr<browser_sync::SyncBackendHost> backend_;
 
   // Cache of the last name the client attempted to authenticate.
   std::string last_attempted_user_email_;
 
-  // Whether we have seen a SYNC_PASSPHRASE_REQUIRED since initializing the
-  // backend, telling us that it is safe to send a passphrase down ASAP.
-  bool observed_passphrase_required_;
-
   // Was the last SYNC_PASSPHRASE_REQUIRED notification sent because it
-  // was required for decryption?
-  bool passphrase_required_for_decryption_;
+  // was required for encryption, decryption with a cached passphrase, or
+  // because a new passphrase is required?
+  sync_api::PassphraseRequiredReason passphrase_required_reason_;
 
   // Is the user in a passphrase migration?
   bool passphrase_migration_in_progress_;
 
  private:
   friend class ProfileSyncServicePasswordTest;
   friend class TestProfileSyncService;
   FRIEND_TEST_ALL_PREFIXES(ProfileSyncServiceTest, InitialState);
 
   // If |delete_sync_data_folder| is true, then this method will delete all
@@ skipping 114 matching lines @@
   // The set of encrypted types. This is updated whenever datatypes are
   // encrypted through the OnEncryptionComplete callback of SyncFrontend.
   syncable::ModelTypeSet encrypted_types_;
 
   scoped_ptr<browser_sync::BackendMigrator> migrator_;
 
   DISALLOW_COPY_AND_ASSIGN(ProfileSyncService);
 };
 
 #endif  // CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_