GaiaCookieServiceManager handles general request types

components/signin/core/browser/gaia_cookie_manager_service.h

 // Copyright 2014 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_SIGNIN_CORE_BROWSER_GAIA_COOKIE_MANAGER_SERVICE_H
 #define COMPONENTS_SIGNIN_CORE_BROWSER_GAIA_COOKIE_MANAGER_SERVICE_H
 
 #include <deque>
 
 #include "base/observer_list.h"
 #include "base/timer/timer.h"
 #include "components/signin/core/browser/signin_client.h"
 #include "google_apis/gaia/gaia_auth_consumer.h"
 #include "google_apis/gaia/ubertoken_fetcher.h"
 #include "net/url_request/url_fetcher_delegate.h"
 
 class GaiaAuthFetcher;
+class GaiaCookieRequest;

[Roger Tawa OOO till Jul 10th, 2015/03/30 18:57:23]

What is this forward declare for?

[Mike Lerman, 2015/04/01 16:39:35]

For... no good reason.

 class GoogleServiceAuthError;
 class OAuth2TokenService;
 
 namespace net {
 class URLFetcher;
 }
 
 // Merges a Google account known to Chrome into the cookie jar.  When merging
 // multiple accounts, one instance of the helper is better than multiple
 // instances if there is the possibility that they run concurrently, since
 // changes to the cookie must be serialized.
 //
 // Also checks the External CC result to ensure no services that consume the
 // GAIA cookie are blocked (such as youtube). This is executed once for the
 // lifetime of this object, when the first call is made to AddAccountToCookie.
 class GaiaCookieManagerService : public KeyedService,
                                  public GaiaAuthConsumer,
                                  public UbertokenConsumer,
                                  public net::URLFetcherDelegate {
  public:
+  typedef base::Callback<void(const std::string& data,
+                              const GoogleServiceAuthError& error)>
+      ListAccountsCallback;
+
+
+  enum GaiaCookieRequestType {
+    ADD_ACCOUNT,
+    LOG_OUT,
+    LIST_ACCOUNTS
+  };
+
+  // Contains the information and parameters for any request.
+  class GaiaCookieRequest {
+   public:
+    ~GaiaCookieRequest();
+
+    GaiaCookieRequestType request_type() const { return request_type_; }
+    const std::string& account_id() const {return account_id_; }
+    const GaiaCookieManagerService::ListAccountsCallback&
+        list_accounts_callback() const {
+      return list_accounts_callback_;
+    }
+
+    static GaiaCookieRequest AddAccountRequest(
+        const std::string& account_id);
+    static GaiaCookieRequest LogOutRequest();
+    static GaiaCookieRequest ListAccountsRequest(
+        const GaiaCookieManagerService::ListAccountsCallback&
+            list_accounts_callback);

[Roger Tawa OOO till Jul 10th, 2015/03/30 18:57:23]

Should these be called CreateXXX() ?

[Mike Lerman, 2015/04/01 16:39:35]

Sure.

+
+   private:
+    GaiaCookieRequest(
+        GaiaCookieRequestType request_type,
+        const std::string& account_id,
+        const GaiaCookieManagerService::ListAccountsCallback&
+            list_accounts_callback);
+
+    GaiaCookieRequestType request_type_;
+    std::string account_id_;
+    GaiaCookieManagerService::ListAccountsCallback list_accounts_callback_;
+  };
+
   class Observer {
    public:
     // Called whenever a merge session is completed.  The account that was
     // merged is given by |account_id|.  If |error| is equal to
     // GoogleServiceAuthError::AuthErrorNone() then the merge succeeeded.
     virtual void OnAddAccountToCookieCompleted(
         const std::string& account_id,
         const GoogleServiceAuthError& error) = 0;
 
     // Called when ExternalCcResultFetcher completes. From this moment
@@ skipping 68 matching lines @@
     DISALLOW_COPY_AND_ASSIGN(ExternalCcResultFetcher);
   };
 
   GaiaCookieManagerService(OAuth2TokenService* token_service,
                            const std::string& source,
                            SigninClient* signin_client);
   ~GaiaCookieManagerService() override;
 
   void AddAccountToCookie(const std::string& account_id);
 
+  void ListAccounts(const ListAccountsCallback& callback);
+
   // Add or remove observers of this helper.
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Cancel all login requests.
   void CancelAll();
 
-  // Signout of |account_id| given a list of accounts already signed in.
-  // Since this involves signing out of all accounts and resigning back in,
-  // the order which |accounts| are given is important as it will dictate
-  // the sign in order. |account_id| does not have to be in |accounts|.
-  void LogOut(const std::string& account_id,
-              const std::vector<std::string>& accounts);
-
   // Signout all accounts.
   void LogOutAllAccounts();
 
   // Call observers when merge session completes.  This public so that callers
   // that know that a given account is already in the cookie jar can simply
   // inform the observers.
   void SignalComplete(const std::string& account_id,
                       const GoogleServiceAuthError& error);
 
   // Returns true of there are pending log ins or outs.
-  bool is_running() const { return accounts_.size() > 0; }
+  bool is_running() const { return requests_.size() > 0; }
 
   // Start the process of fetching the external check connection result so that
   // its ready when we try to perform a merge session.
   void StartFetchingExternalCcResult();
 
  private:
   net::URLRequestContextGetter* request_context() {
     return signin_client_->GetURLRequestContext();
   }
 
   // Overridden from UbertokenConsumer.
   void OnUbertokenSuccess(const std::string& token) override;
   void OnUbertokenFailure(const GoogleServiceAuthError& error) override;
 
   // Overridden from GaiaAuthConsumer.
   void OnMergeSessionSuccess(const std::string& data) override;
   void OnMergeSessionFailure(const GoogleServiceAuthError& error) override;
 
-  void LogOutInternal(const std::string& account_id,
-                      const std::vector<std::string>& accounts);
-
   // Starts the proess of fetching the uber token and performing a merge session
   // for the next account.  Virtual so that it can be overriden in tests.
-  virtual void StartFetching();
+  virtual void StartFetchingUbertoken();
 
   // Virtual for testing purpose.
   virtual void StartLogOutUrlFetch();
 
-  // Start the next merge session, if needed.
-  void HandleNextAccount();
+  // Start the next request, if needed.
+  void HandleNextRequest();
 
   // Overridden from URLFetcherDelgate.
   void OnURLFetchComplete(const net::URLFetcher* source) override;
 
   OAuth2TokenService* token_service_;
   SigninClient* signin_client_;
   scoped_ptr<GaiaAuthFetcher> gaia_auth_fetcher_;
   scoped_ptr<UbertokenFetcher> uber_token_fetcher_;
   ExternalCcResultFetcher external_cc_result_fetcher_;
 
-  // A worklist for this class. Accounts names are stored here if
-  // we are pending a signin action for that account. Empty strings
-  // represent a signout request.
-  std::deque<std::string> accounts_;
+  // A worklist for this class. Stores any pending requests that couldn't be
+  // executed right away, since this class only permits one request to be
+  // executed at a time.
+  std::deque<GaiaCookieRequest> requests_;
 
   // List of observers to notify when merge session completes.
   // Makes sure list is empty on destruction.
   ObserverList<Observer, true> observer_list_;
 
   // Source to use with GAIA endpoints for accounting.
   std::string source_;
 
   DISALLOW_COPY_AND_ASSIGN(GaiaCookieManagerService);
 };
 
 #endif  // COMPONENTS_SIGNIN_CORE_BROWSER_GAIA_COOKIE_MANAGER_SERVICE_H