Pass a RemovalCause to CookieChangedCallback

net/cookies/cookie_store.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 number 42.
 
 #ifndef NET_COOKIES_COOKIE_STORE_H_
 #define NET_COOKIES_COOKIE_STORE_H_
 
 #include <memory>
@@ skipping 15 matching lines @@
 
 // An interface for storing and retrieving cookies. Implementations are not
 // thread safe, as with most other net classes. All methods must be invoked on
 // the network thread, and all callbacks will be calle there.
 //
 // All async functions may either invoke the callback asynchronously, or they
 // may be invoked immediately (prior to return of the asynchronous function).
 // Destroying the CookieStore will cancel pending async callbacks.
 class NET_EXPORT CookieStore {
  public:
+  // In a CookieChangedCallback, this indicates why a cookie was removed if it
+  // was removed. This roughly mirrors CookieMonster::DeletionCause and
+  // CookieMonsterDelegate::ChangeCause.
+  enum class RemovalCause {
+    NOT_REMOVED,

[Roger Tawa OOO till Jul 10th, 2016/09/19 20:23:02]

If I have a value set for a cookie, and I browse to a website which returns a
Set-Cookie header, will I get only a NOT_REMOVED notif, or an EXPLICIT or
OVERWRITE notif followed by a NOT_REMOVED?

[nharper, 2016/09/19 21:34:30]

It looks like you'll first get a (removed=true) OVERWRITE followed by a
(removed=false) EXPLICIT (or NOT_REMOVED as currently implemented) - afaict that
behavior is implemented by removing the existing value and then inserting the
new value.

+    UNKNOWN,
+    EXPLICIT,
+    OVERWRITE,
+    EXPIRED,
+    EVICTED,
+    EXPIRED_OVERWRITE,
+  };

[Roger Tawa OOO till Jul 10th, 2016/09/19 20:23:02]

Wondering why you didn't define as ChangeCause instead, or maybe merge with
CookieMonsterDelegate::ChangeCause.  You could then remove the |bool removed|
from the callback signature.  If you changed all calls to the callback with:

removed=false
cause=UNKNOWN

to be just cause=NOT_REMOVED that would accomplish the same without the bool
arg.  Yes/no?

[nharper, 2016/09/19 21:34:30]

I'm thinking combining the bool with the enum would make sense. I'm less sure
about combining this enum with CookieMonsterDelegate::ChangeCause - let me ask
on net-dev what people think.

+
   // Callback definitions.
   typedef base::Callback<void(const CookieList& cookies)> GetCookieListCallback;
   typedef base::Callback<void(const std::string& cookie)> GetCookiesCallback;
   typedef base::Callback<void(bool success)> SetCookiesCallback;
   typedef base::Callback<void(int num_deleted)> DeleteCallback;
-  typedef base::Callback<void(const CanonicalCookie& cookie, bool removed)>
+  typedef base::Callback<
+      void(const CanonicalCookie& cookie, bool removed, RemovalCause cause)>
       CookieChangedCallback;
-  typedef base::CallbackList<void(const CanonicalCookie& cookie, bool removed)>
+  typedef base::CallbackList<
+      void(const CanonicalCookie& cookie, bool removed, RemovalCause cause)>
       CookieChangedCallbackList;
   typedef CookieChangedCallbackList::Subscription CookieChangedSubscription;
   typedef base::Callback<bool(const CanonicalCookie& cookie)> CookiePredicate;
 
   virtual ~CookieStore();
 
   // Returns the cookie line (e.g. "cookie1=value1; cookie2=value2") represented
   // by |cookies|. The string is built in the same order as the given list.
   //
   // TODO(mkwst): We really should standardize on either
@@ skipping 157 matching lines @@
   int GetChannelIDServiceID();
 
  protected:
   CookieStore();
   int channel_id_service_id_;
 };
 
 }  // namespace net
 
 #endif  // NET_COOKIES_COOKIE_STORE_H_