Pass a RemovalCause to CookieChangedCallback

chrome/browser/extensions/api/cookies/cookies_api.cc

 // 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.
 
 // Implements the Chrome Extensions Cookies API.
 
 #include "chrome/browser/extensions/api/cookies/cookies_api.h"
 
 #include <memory>
 #include <utility>
@@ skipping 125 matching lines @@
   std::unique_ptr<base::DictionaryValue> dict(new base::DictionaryValue());
   dict->SetBoolean(keys::kRemovedKey, details->removed);
 
   cookies::Cookie cookie = cookies_helpers::CreateCookie(
       *details->cookie, cookies_helpers::GetStoreIdFromProfile(profile));
   dict->Set(keys::kCookieKey, cookie.ToValue());
 
   // Map the internal cause to an external string.
   std::string cause;
   switch (details->cause) {
-    case net::CookieMonsterDelegate::CHANGE_COOKIE_EXPLICIT:
+    case net::CookieStore::CHANGE_COOKIE_INSERTED:
+    case net::CookieStore::CHANGE_COOKIE_UNKNOWN_DELETION:

[Devlin, 2016/09/26 16:46:09]

Is it accurate to lump these two in here?  e.g. unknown deletion sounds like it
wasn't necessarily explicit.  And can insertion only happen from explicit
insertions?  If so, what's the difference between insertion and explicit?

[nharper, 2016/09/26 21:09:10]

I agree that UNKNOWN_DELETION doesn't belong here. I've moved it to be with the
default case (the NOTREACHED()). UNKNOWN_DELETION is used in two places. The
first is in GaiaCookieManagerService when a caller forces the
GaiaCookieManagerService to run its cookie changed processing. The
UNKNOWN_DELETION value never leaves the GaiaCookieManagerService in this case.
The other use of UNKNOWN_DELETION is in CookieStoreIOS, and is only used to pass
it in to a CookieChangedCallback, which will never end up here.

The difference between INSERTED and EXPLICIT is that EXPLICIT can be both an add
or a remove, while INSERTED is only an add. According to the documentation at
https://developer.chrome.com/extensions/cookies#type-OnChangedCause, the only
reason here that's valid if a cookie wasn't deleted is "explicit". 

The cause here comes from a call to a CookieMonsterDelegate::OnCookieChanged (in
this case, the CookieMonsterDelegate is an ExtensionCookieMonsterDelegate).
OnCookieChanged is only called in two places, both in CookieMonster, one for
insertions and the other for deletions. The deletion callsite didn't changed -
it takes the CookieMonster::DeletionCause and maps it to the corresponding
CookieStore::ChangeCause (used to be CookieMonsterDelegate::ChangeCause, but the
mapping is the same). The insertion callsite used to always call it with
EXPLICIT, now it's always INSERTED. 

[Devlin, 2016/09/27 15:48:05]

I think that all makes sense - unknown deletion was the really odd one.  Can we
add a comment summarizing why INSERTED is included here?

[nharper, 2016/09/27 17:43:48]

Done.

+    case net::CookieStore::CHANGE_COOKIE_EXPLICIT:
       cause = keys::kExplicitChangeCause;
       break;
 
-    case net::CookieMonsterDelegate::CHANGE_COOKIE_OVERWRITE:
+    case net::CookieStore::CHANGE_COOKIE_OVERWRITE:
       cause = keys::kOverwriteChangeCause;
       break;
 
-    case net::CookieMonsterDelegate::CHANGE_COOKIE_EXPIRED:
+    case net::CookieStore::CHANGE_COOKIE_EXPIRED:
       cause = keys::kExpiredChangeCause;
       break;
 
-    case net::CookieMonsterDelegate::CHANGE_COOKIE_EVICTED:
+    case net::CookieStore::CHANGE_COOKIE_EVICTED:
       cause = keys::kEvictedChangeCause;
       break;
 
-    case net::CookieMonsterDelegate::CHANGE_COOKIE_EXPIRED_OVERWRITE:
+    case net::CookieStore::CHANGE_COOKIE_EXPIRED_OVERWRITE:
       cause = keys::kExpiredOverwriteChangeCause;
       break;
 
     default:
       NOTREACHED();
   }
   dict->SetString(keys::kCauseKey, cause);
 
   args->Append(std::move(dict));
 
@@ skipping 412 matching lines @@
 BrowserContextKeyedAPIFactory<CookiesAPI>* CookiesAPI::GetFactoryInstance() {
   return g_factory.Pointer();
 }
 
 void CookiesAPI::OnListenerAdded(const EventListenerInfo& details) {
   cookies_event_router_.reset(new CookiesEventRouter(browser_context_));
   EventRouter::Get(browser_context_)->UnregisterObserver(this);
 }
 
 }  // namespace extensions