Switch cookie async mechanism over to using callbacks.

net/cookies/cookie_monster.h

 // Copyright (c) 2012 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.
 
 // Brought to you by the letter D and the number 2.
 
 #ifndef NET_COOKIES_COOKIE_MONSTER_H_
 #define NET_COOKIES_COOKIE_MONSTER_H_
 
 #include <stddef.h>
@@ skipping 33 matching lines @@
 // The cookie monster is the system for storing and retrieving cookies. It has
 // an in-memory list of all cookies, and synchronizes non-session cookies to an
 // optional permanent storage that implements the PersistentCookieStore
 // interface.
 //
 // Tasks may be deferred if all affected cookies are not yet loaded from the
 // backing store. Otherwise, callbacks may be invoked immediately.
 //
 // A cookie task is either pending loading of the entire cookie store, or
 // loading of cookies for a specific domain key(eTLD+1). In the former case, the
-// cookie task will be queued in tasks_pending_ while PersistentCookieStore
+// cookie callback will be queued in tasks_pending_ while PersistentCookieStore
 // chain loads the cookie store on DB thread. In the latter case, the cookie
-// task will be queued in tasks_pending_for_key_ while PermanentCookieStore
+// callback will be queued in tasks_pending_for_key_ while PermanentCookieStore
 // loads cookies for the specified domain key(eTLD+1) on DB thread.
 //
 // TODO(deanm) Implement CookieMonster, the cookie database.
 //  - Verify that our domain enforcement and non-dotted handling is correct
 class NET_EXPORT CookieMonster : public CookieStore {
  public:
   class PersistentCookieStore;
 
   // Terminology:
   //    * The 'top level domain' (TLD) of an internet domain name is
@@ skipping 154 matching lines @@
   static const char* const kDefaultCookieableSchemes[];
   static const int kDefaultCookieableSchemesCount;
 
   std::unique_ptr<CookieChangedSubscription> AddCallbackForCookie(
       const GURL& url,
       const std::string& name,
       const CookieChangedCallback& callback) override;
 
   bool IsEphemeral() override;
 
+  void SetCookieWithCreationTimeForTesting(const GURL& url,
+                                           const std::string& cookie_line,
+                                           const base::Time& creation_time,
+                                           SetCookiesCallback callback);
+
  private:
   CookieMonster(PersistentCookieStore* store,
                 CookieMonsterDelegate* delegate,
                 ChannelIDService* channel_id_service,
                 base::TimeDelta last_access_threshold);
 
-  // For queueing the cookie monster calls.
-  class CookieMonsterTask;
-  template <typename Result>
-  class DeleteTask;
-  class DeleteAllCreatedBetweenTask;
-  class DeleteAllCreatedBetweenWithPredicateTask;
-  class DeleteCookieTask;
-  class DeleteCanonicalCookieTask;
-  class GetCookieListForURLWithOptionsTask;
-  class GetAllCookiesTask;
-  class GetCookiesWithOptionsTask;
-  class GetCookieListWithOptionsTask;
-  class SetAllCookiesTask;
-  class SetCookieWithDetailsTask;
-  class SetCookieWithOptionsTask;
-  class SetCanonicalCookieTask;
-  class DeleteSessionCookiesTask;
-
-  // Testing support.
-  // For SetCookieWithCreationTime.
-  FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest,
-                           TestCookieDeleteAllCreatedBetweenTimestamps);
-  FRIEND_TEST_ALL_PREFIXES(
-      CookieMonsterTest,
-      TestCookieDeleteAllCreatedBetweenTimestampsWithPredicate);
-
   // For garbage collection constants.
   FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestHostGarbageCollection);
   FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, GarbageCollectionTriggers);
   FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest,
                            GarbageCollectWithSecureCookiesOnly);
   FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestGCTimes);
 
   // For validation of key values.
   FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestDomainTree);
   FRIEND_TEST_ALL_PREFIXES(CookieMonsterTest, TestImport);
@@ skipping 137 matching lines @@
   // The number of days since last access that cookies will not be subject
   // to global garbage collection.
   static const int kSafeFromGlobalPurgeDays;
 
   // Record statistics every kRecordStatisticsIntervalSeconds of uptime.
   static const int kRecordStatisticsIntervalSeconds = 10 * 60;
 
   // The following are synchronous calls to which the asynchronous methods
   // delegate either immediately (if the store is loaded) or through a deferred
   // task (if the store is not yet loaded).
-  bool SetCookieWithDetails(const GURL& url,
+  void SetCookieWithDetails(const GURL& url,
                             const std::string& name,
                             const std::string& value,
                             const std::string& domain,
                             const std::string& path,
                             base::Time creation_time,
                             base::Time expiration_time,
                             base::Time last_access_time,
                             bool secure,
                             bool http_only,
                             CookieSameSite same_site,
-                            CookiePriority priority);
+                            CookiePriority priority,
+                            SetCookiesCallback callback);
 
   // Sets a canonical cookie, deletes equivalents and performs garbage
   // collection.  |source_secure| indicates if the cookie is being set
   // from a secure source (e.g. a cryptographic scheme).
   // |modify_http_only| indicates if this setting operation is allowed
   // to affect http_only cookies.
-  bool SetCanonicalCookie(std::unique_ptr<CanonicalCookie> cookie,
+  void SetCanonicalCookie(std::unique_ptr<CanonicalCookie> cookie,
                           bool secure_source,
-                          bool can_modify_httponly);
+                          bool can_modify_httponly,
+                          SetCookiesCallback callback);
 
-  CookieList GetAllCookies();
+  void GetAllCookies(GetCookieListCallback callback);
 
-  CookieList GetCookieListWithOptions(const GURL& url,
-                                      const CookieOptions& options);
+  void GetCookieListWithOptions(const GURL& url,
+                                const CookieOptions& options,
+                                GetCookieListCallback callback);
 
-  uint32_t DeleteAllCreatedBetween(const base::Time& delete_begin,
-                                   const base::Time& delete_end);
+  void DeleteAllCreatedBetween(const base::Time& delete_begin,
+                               const base::Time& delete_end,
+                               DeleteCallback callback);
 
   // Predicate will be called with the calling thread.
-  uint32_t DeleteAllCreatedBetweenWithPredicate(
+  void DeleteAllCreatedBetweenWithPredicate(
       const base::Time& delete_begin,
       const base::Time& delete_end,
-      const base::Callback<bool(const CanonicalCookie&)>& predicate);
+      const base::Callback<bool(const CanonicalCookie&)>& predicate,
+      DeleteCallback callback);
 
-  bool SetCookieWithOptions(const GURL& url,
+  void SetCookieWithOptions(const GURL& url,
                             const std::string& cookie_line,
-                            const CookieOptions& options);
+                            const CookieOptions& options,
+                            SetCookiesCallback callback);
 
-  std::string GetCookiesWithOptions(const GURL& url,
-                                    const CookieOptions& options);
+  void GetCookiesWithOptions(const GURL& url,
+                             const CookieOptions& options,
+                             GetCookiesCallback callback);
 
-  void DeleteCookie(const GURL& url, const std::string& cookie_name);
+  void DeleteCookie(const GURL& url,
+                    const std::string& cookie_name,
+                    base::OnceClosure callback);
 
-  uint32_t DeleteCanonicalCookie(const CanonicalCookie& cookie);
+  void DeleteCanonicalCookie(const CanonicalCookie& cookie,
+                             DeleteCallback callback);
 
-  bool SetCookieWithCreationTime(const GURL& url,
-                                 const std::string& cookie_line,
-                                 const base::Time& creation_time);
-
-  uint32_t DeleteSessionCookies();
+  void DeleteSessionCookies(DeleteCallback callback);
 
   // The first access to the cookie store initializes it. This method should be
   // called before any access to the cookie store.
   void MarkCookieStoreAsInitialized();
 
   // Fetches all cookies if the backing store exists and they're not already
   // being fetched.
   void FetchAllCookiesIfNecessary();
 
   // Fetches all cookies from the backing store.
@@ skipping 63 matching lines @@
 
   // Inserts |cc| into cookies_. Returns an iterator that points to the inserted
   // cookie in cookies_. Guarantee: all iterators to cookies_ remain valid.
   CookieMap::iterator InternalInsertCookie(const std::string& key,
                                            std::unique_ptr<CanonicalCookie> cc,
                                            bool sync_to_store);
 
   // Helper function that sets cookies with more control.
   // Not exposed as we don't want callers to have the ability
   // to specify (potentially duplicate) creation times.
-  bool SetCookieWithCreationTimeAndOptions(const GURL& url,
+  void SetCookieWithCreationTimeAndOptions(const GURL& url,
                                            const std::string& cookie_line,
                                            const base::Time& creation_time,
-                                           const CookieOptions& options);
+                                           const CookieOptions& options,
+                                           SetCookiesCallback callback);
 
   // Sets all cookies from |list| after deleting any equivalent cookie.
   // For data gathering purposes, this routine is treated as if it is
   // restoring saved cookies; some statistics are not gathered in this case.
-  bool SetAllCookies(const CookieList& list);
+  void SetAllCookies(CookieList list, SetCookiesCallback callback);
 
   void InternalUpdateCookieAccessTime(CanonicalCookie* cc,
                                       const base::Time& current_time);
 
   // |deletion_cause| argument is used for collecting statistics and choosing
   // the correct CookieStore::ChangeCause for OnCookieChanged
   // notifications.  Guarantee: All iterators to cookies_ except to the
   // deleted entry remain valid.
   void InternalDeleteCookie(CookieMap::iterator it,
                             bool sync_to_store,
@@ skipping 63 matching lines @@
   void RecordPeriodicStats(const base::Time& current_time);
 
   // Initialize the above variables; should only be called from
   // the constructor.
   void InitializeHistograms();
 
   // The resolution of our time isn't enough, so we do something
   // ugly and increment when we've seen the same time twice.
   base::Time CurrentTime();
 
-  // Runs the task if, or defers the task until, the full cookie database is
-  // loaded.
-  void DoCookieTask(const scoped_refptr<CookieMonsterTask>& task_item);
+  // Runs the callback if, or defers the callback until, the full cookie
+  // database is loaded.
+  void DoCookieCallback(base::OnceClosure callback);
 
-  // Runs the task if, or defers the task until, the cookies for the given URL
-  // are loaded.
-  void DoCookieTaskForURL(const scoped_refptr<CookieMonsterTask>& task_item,
-                          const GURL& url);
+  // Runs the callback if, or defers the callback until, the cookies for the
+  // given URL are loaded.
+  void DoCookieCallbackForURL(base::OnceClosure callback, const GURL& url);
 
   // Computes the difference between |old_cookies| and |new_cookies|, and writes
   // the result in |cookies_to_add| and |cookies_to_delete|.
   // This function has the side effect of changing the order of |old_cookies|
   // and |new_cookies|. |cookies_to_add| and |cookies_to_delete| must be empty,
   // and none of the arguments can be null.
   void ComputeCookieDiff(CookieList* old_cookies,
                          CookieList* new_cookies,
                          CookieList* cookies_to_add,
                          CookieList* cookies_to_delete);
 
-  // Runs the given callback. Used to avoid running callbacks after the store
-  // has been destroyed.
-  void RunCallback(base::OnceClosure callback);
-
   // Run all cookie changed callbacks that are monitoring |cookie|.
   // |removed| is true if the cookie was deleted.
   void RunCookieChangedCallbacks(const CanonicalCookie& cookie,
                                  CookieStore::ChangeCause cause);
 
   // Histogram variables; see CookieMonster::InitializeHistograms() in
   // cookie_monster.cc for details.
   base::HistogramBase* histogram_expiration_duration_minutes_;
   base::HistogramBase* histogram_count_;
   base::HistogramBase* histogram_cookie_type_;
@@ skipping 12 matching lines @@
   bool finished_fetching_all_cookies_;
   // The strategy to use for fetching cookies.
   FetchStrategy fetch_strategy_;
 
   // List of domain keys that have been loaded from the DB.
   std::set<std::string> keys_loaded_;
 
   // Map of domain keys to their associated task queues. These tasks are blocked
   // until all cookies for the associated domain key eTLD+1 are loaded from the
   // backend store.
-  std::map<std::string, std::deque<scoped_refptr<CookieMonsterTask>>>
-      tasks_pending_for_key_;
+  std::map<std::string, std::deque<base::OnceClosure>> tasks_pending_for_key_;
 
   // Queues tasks that are blocked until all cookies are loaded from the backend
   // store.
-  std::deque<scoped_refptr<CookieMonsterTask>> tasks_pending_;
+  std::deque<base::OnceClosure> tasks_pending_;
 
   // Once a global cookie task has been seen, all per-key tasks must be put in
   // |tasks_pending_| instead of |tasks_pending_for_key_| to ensure a reasonable
-  // view of the cookie store. This more to ensure fancy cookie export/import
+  // view of the cookie store. This is more to ensure fancy cookie export/import
   // code has a consistent view of the CookieStore, rather than out of concern
   // for typical use.
   bool seen_global_task_;
 
   scoped_refptr<PersistentCookieStore> store_;
 
   base::Time last_time_seen_;
 
   // Minimum delay after updating a cookie's LastAccessDate before we will
   // update it again.
@@ skipping 106 matching lines @@
   virtual ~PersistentCookieStore() {}
 
  private:
   friend class base::RefCountedThreadSafe<PersistentCookieStore>;
   DISALLOW_COPY_AND_ASSIGN(PersistentCookieStore);
 };
 
 }  // namespace net
 
 #endif  // NET_COOKIES_COOKIE_MONSTER_H_