[Extensions] Extension Port Ids and Initialization 2.0

extensions/renderer/messaging_bindings.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 EXTENSIONS_RENDERER_MESSAGING_BINDINGS_H_
 #define EXTENSIONS_RENDERER_MESSAGING_BINDINGS_H_
 
 #include <string>
 
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
+#include "base/unguessable_token.h"
 #include "extensions/renderer/object_backed_native_handler.h"
 
 struct ExtensionMsg_ExternalConnectionInfo;
 struct ExtensionMsg_TabConnectionInfo;
 
 namespace content {
 class RenderFrame;
 }
 
 namespace extensions {
 class ExtensionPort;
 struct Message;
+struct PortId;
 class ScriptContextSet;
 
 // Manually implements JavaScript bindings for extension messaging.
 class MessagingBindings : public ObjectBackedNativeHandler {
  public:
   explicit MessagingBindings(ScriptContext* script_context);
   ~MessagingBindings() override;
 
   // Checks whether the port exists in the given frame. If it does not, a reply
   // is sent back to the browser.
   static void ValidateMessagePort(const ScriptContextSet& context_set,
-                                  int port_id,
+                                  const PortId& port_id,
                                   content::RenderFrame* render_frame);
 
   // Dispatches the onConnect content script messaging event to some contexts
   // in |context_set|. If |restrict_to_render_frame| is specified, only contexts
   // in that render frame will receive the message.
   static void DispatchOnConnect(const ScriptContextSet& context_set,
-                                int target_port_id,
+                                const PortId& target_port_id,
                                 const std::string& channel_name,
                                 const ExtensionMsg_TabConnectionInfo& source,
                                 const ExtensionMsg_ExternalConnectionInfo& info,
                                 const std::string& tls_channel_id,
                                 content::RenderFrame* restrict_to_render_frame);
 
   // Delivers a message sent using content script messaging to some of the
   // contexts in |bindings_context_set|. If |restrict_to_render_frame| is
   // specified, only contexts in that render view will receive the message.
   static void DeliverMessage(const ScriptContextSet& context_set,
-                             int target_port_id,
+                             const PortId& target_port_id,
                              const Message& message,
                              content::RenderFrame* restrict_to_render_frame);
 
   // Dispatches the onDisconnect event in response to the channel being closed.
   static void DispatchOnDisconnect(
       const ScriptContextSet& context_set,
-      int port_id,
+      const PortId& port_id,
       const std::string& error_message,
       content::RenderFrame* restrict_to_render_frame);
 
   // Returns an existing port with the given |global_id|, or null.

[lazyboy, 2016/12/03 03:53:27]

s/global_id/id

[Devlin, 2016/12/05 17:07:42]

Done.

-  ExtensionPort* GetPortWithGlobalId(int global_id);
+  ExtensionPort* GetPortWithId(const PortId& id);
 
   // Creates a new port with the given |global_id|. MessagingBindings owns the

[lazyboy, 2016/12/03 03:53:27]

Same as ^^^

[Devlin, 2016/12/05 17:07:42]

Done.

   // returned port.
-  ExtensionPort* CreateNewPortWithGlobalId(int global_id);
+  ExtensionPort* CreateNewPortWithId(const PortId& id);
 
-  // Removes the port with the given |local_id|.
-  void RemovePortWithLocalId(int local_id);
+  // Removes the port with the given |js_id|.
+  void RemovePortWithJsId(int js_id);
+
+  const base::UnguessableToken& context_id() const { return context_id_; }
 
   base::WeakPtr<MessagingBindings> GetWeakPtr();
 
  private:
   using PortMap = std::map<int, std::unique_ptr<ExtensionPort>>;
 
   // JS Exposed Function: Sends a message along the given channel.
   void PostMessage(const v8::FunctionCallbackInfo<v8::Value>& args);
 
   // JS Exposed Function: Close a port, optionally forcefully (i.e. close the
@@ skipping 10 matching lines @@
   void OpenChannelToExtension(const v8::FunctionCallbackInfo<v8::Value>& args);
 
   // JS Exposed Function: Opens a new channel to a native application.
   void OpenChannelToNativeApp(const v8::FunctionCallbackInfo<v8::Value>& args);
 
   // JS Exposed Function: Opens a new channel to a tab.
   void OpenChannelToTab(const v8::FunctionCallbackInfo<v8::Value>& args);
 
   // Helper function to close a port. See CloseChannel() for |force_close|
   // documentation.
-  void ClosePort(int port_id, bool force_close);
+  void ClosePort(int local_port_id, bool force_close);
 
-  // Sets the global id for the port with |local_id|.
-  void SetGlobalPortId(int local_id, int global_id);
-
-  int GetNextLocalId();
+  int GetNextJsId();
 
   // Active ports, mapped by local port id.
   PortMap ports_;
 
   // Ports which are disconnected, but haven't been fully initialized. Once
   // initialized and any pending messages are sent, these ports are removed.
   PortMap disconnected_ports_;
 
-  // The next available local id for a port.
-  size_t next_local_id_ = 0;
+  // The next available js id for a port.
+  size_t next_js_id_ = 0;
 
   // The number of ports created in the 'beforeunload' event handler.
   size_t ports_created_in_before_unload_ = 0;

[lazyboy, 2016/12/03 03:53:26]

These seems to be unused atm, remove these and their histogram code?

[Devlin, 2016/12/05 17:07:42]

Good catch.  I'm still interested in this data overall, but we now we can only
really track total.  Reworked.

 
   // The number of ports created in the 'unload' event handler.
   size_t ports_created_in_unload_ = 0;
 
   // The number of ports created during during any time that isn't in the unload
   // or beforeunload handlers.
   int ports_created_normal_ = 0;
 
+  // A unique identifier for this context.

[lazyboy, 2016/12/03 03:53:26]

nit: context/ScriptContext to be specific

[Devlin, 2016/12/05 17:07:42]

I'd prefer JS context, since this is a per-JS context object and that's really
what we're identifying.  Otherwise the id should really go directly on the
ScriptContext (which we may do at some point).

+  const base::UnguessableToken context_id_;
+
   base::WeakPtrFactory<MessagingBindings> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MessagingBindings);
 };
 
 }  // namespace extensions
 
 #endif  // EXTENSIONS_RENDERER_MESSAGING_BINDINGS_H_