Move the event attach/detach logic on unload from event.js to

extensions/renderer/event_bindings.cc

 // 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.
 
 #include "extensions/renderer/event_bindings.h"
 
 #include <map>
 #include <set>

[Devlin, 2015/04/13 16:07:07]

remove #include <set>, <string>

[not at google - send to devlin, 2015/04/13 17:08:30]

Done.

 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/lazy_instance.h"
 #include "base/memory/scoped_ptr.h"
 #include "components/crx_file/id_util.h"
 #include "content/public/child/v8_value_converter.h"
 #include "content/public/renderer/render_thread.h"
 #include "content/public/renderer/render_view.h"
 #include "extensions/common/event_filter.h"
 #include "extensions/common/extension.h"
 #include "extensions/common/extension_messages.h"
 #include "extensions/common/manifest_handlers/background_info.h"
 #include "extensions/common/value_counter.h"
 #include "extensions/renderer/dispatcher.h"
 #include "extensions/renderer/extension_helper.h"
 #include "extensions/renderer/object_backed_native_handler.h"

[Devlin, 2015/04/13 16:07:07]

remove

[not at google - send to devlin, 2015/04/13 17:08:30]

... christ, how do you find these things. I didn't even make changes that would
trigger this.

 #include "url/gurl.h"
 #include "v8/include/v8.h"

[Devlin, 2015/04/13 16:07:07]

remove

 
 namespace extensions {
 
 namespace {
 
 // A map of event names to the number of contexts listening to that event.
 // We notify the browser about event listeners when we transition between 0
 // and 1.
 typedef std::map<std::string, int> EventListenerCounts;
 
@@ skipping 96 matching lines @@
   FilteredEventListenerCounts::iterator it = counts.find(event_name);
   if (it == counts.end())
     return false;
   return 0 == it->second->Remove(*filter);
 }
 
 }  // namespace
 
 EventBindings::EventBindings(Dispatcher* dispatcher, ScriptContext* context)
     : ObjectBackedNativeHandler(context), dispatcher_(dispatcher) {
-  RouteFunction(
-      "AttachEvent",
-      base::Bind(&EventBindings::AttachEvent, base::Unretained(this)));
-  RouteFunction(
-      "DetachEvent",
-      base::Bind(&EventBindings::DetachEvent, base::Unretained(this)));
+  RouteFunction("AttachEvent", base::Bind(&EventBindings::AttachEventHandler,
+                                          base::Unretained(this)));

[Devlin, 2015/04/13 16:07:07]

If you can, a really brief note about why unretained is safe would be great.

[not at google - send to devlin, 2015/04/13 17:08:30]

There are many many calls of RouteFunction. I'll add a general comment to
extensions/renderer/object_backed_native_handler.h.

+  RouteFunction("DetachEvent", base::Bind(&EventBindings::DetachEventHandler,
+                                          base::Unretained(this)));
   RouteFunction(
       "AttachFilteredEvent",
       base::Bind(&EventBindings::AttachFilteredEvent, base::Unretained(this)));
   RouteFunction(
       "DetachFilteredEvent",
       base::Bind(&EventBindings::DetachFilteredEvent, base::Unretained(this)));
   RouteFunction("MatchAgainstEventFilter",
                 base::Bind(&EventBindings::MatchAgainstEventFilter,
                            base::Unretained(this)));
+
+  // It's safe to use base::Unretained here because |context| will always
+  // outlive us.
+  context->AddInvalidationObserver(
+      base::Bind(&EventBindings::OnInvalidated, base::Unretained(this)));
 }
 
 EventBindings::~EventBindings() {}
 
-// Attach an event name to an object.
-void EventBindings::AttachEvent(
+void EventBindings::AttachEventHandler(
     const v8::FunctionCallbackInfo<v8::Value>& args) {
   CHECK_EQ(1, args.Length());
   CHECK(args[0]->IsString());
+  AttachEvent(*v8::String::Utf8Value(args[0]));
+}
 
-  std::string event_name = *v8::String::Utf8Value(args[0]);
-
+void EventBindings::AttachEvent(const std::string& event_name) {
+  // This method throws an exception if it returns false.
   if (!dispatcher_->CheckContextAccessToExtensionAPI(event_name, context()))
     return;
 
+  // Record the attachment for this context so that events can be detached when
+  // the context is destroyed.
+  //
+  // Ideally we'd CHECK that it's not already attached, however that's not
+  // possible because extensions can create and attach events themselves. Very
+  // silly, but that's the way it is. For an example of this, see
+  // chrome/test/data/extensions/api_test/events/background.js.
+  attached_event_names_.insert(event_name);
+
   const std::string& extension_id = context()->GetExtensionID();
   if (IncrementEventListenerCount(context(), event_name) == 1) {
     content::RenderThread::Get()->Send(new ExtensionHostMsg_AddListener(
         extension_id, context()->GetURL(), event_name));
   }
 
   // This is called the first time the page has added a listener. Since
   // the background page is the only lazy page, we know this is the first
   // time this listener has been registered.
   if (IsLazyBackgroundPage(context()->GetRenderView(),
                            context()->extension())) {
     content::RenderThread::Get()->Send(
         new ExtensionHostMsg_AddLazyListener(extension_id, event_name));
   }
 }
 
-void EventBindings::DetachEvent(
+void EventBindings::DetachEventHandler(
     const v8::FunctionCallbackInfo<v8::Value>& args) {
   CHECK_EQ(2, args.Length());
   CHECK(args[0]->IsString());
   CHECK(args[1]->IsBoolean());
+  DetachEvent(*v8::String::Utf8Value(args[0]), args[1]->BooleanValue());
+}
 
-  std::string event_name = *v8::String::Utf8Value(args[0]);
-  bool is_manual = args[1]->BooleanValue();
+void EventBindings::DetachEvent(const std::string& event_name, bool is_manual) {
+  // See comment in AttachEvent().
+  attached_event_names_.erase(event_name);
 
   const std::string& extension_id = context()->GetExtensionID();
+
   if (DecrementEventListenerCount(context(), event_name) == 0) {
     content::RenderThread::Get()->Send(new ExtensionHostMsg_RemoveListener(
         extension_id, context()->GetURL(), event_name));
   }
 
   // DetachEvent is called when the last listener for the context is
   // removed. If the context is the background page, and it removes the
   // last listener manually, then we assume that it is no longer interested
   // in being awakened for this event.
   if (is_manual && IsLazyBackgroundPage(context()->GetRenderView(),
@@ skipping 105 matching lines @@
   args.GetReturnValue().Set(array);
 }
 
 scoped_ptr<EventMatcher> EventBindings::ParseEventMatcher(
     base::DictionaryValue* filter_dict) {
   return scoped_ptr<EventMatcher>(new EventMatcher(
       scoped_ptr<base::DictionaryValue>(filter_dict->DeepCopy()),
       context()->GetRenderView()->GetRoutingID()));
 }
 
+void EventBindings::OnInvalidated() {
+  // Detach all attached events that weren't attached. Iterate over a copy
+  // because it will be mutated.
+  std::set<std::string> attached_event_names_safe = attached_event_names_;
+  for (const std::string& event_name : attached_event_names_safe) {
+    DetachEvent(event_name, false /* is_manual */);
+  }
+  DCHECK(attached_event_names_.empty())
+      << "Events cannot be attached during invalidation";
+}
+
 }  // namespace extensions