Deprecate chrome.extension.sendRequest in favor of sendMessage, with a safer

chrome/renderer/resources/extensions/miscellaneous_bindings.js

 // 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.
 
 // This script contains unprivileged javascript APIs related to chrome
 // extensions.  It is loaded by any extension-related context, such as content
 // scripts or background pages.
 // See user_script_slave.cc for script that is loaded by content scripts only.
 
   require('json_schema');
   require('event_bindings');
   var miscNatives = requireNative('miscellaneous_bindings');
   var CloseChannel = miscNatives.CloseChannel;
   var PortAddRef = miscNatives.PortAddRef;
   var PortRelease = miscNatives.PortRelease;
   var PostMessage = miscNatives.PostMessage;
   var BindToGC = miscNatives.BindToGC;
 
   var chromeHidden = requireNative('chrome_hidden').GetChromeHidden();
   var manifestVersion;
   var extensionId;
 
-  // The reserved channel name for the sendRequest API.
+  // The reserved channel name for the sendRequest/sendMessage APIs.
+  // Note: sendRequest is deprecated.
   chromeHidden.kRequestChannel = "chrome.extension.sendRequest";
+  chromeHidden.kMessageChannel = "chrome.extension.sendMessage";
 
   // Map of port IDs to port object.
   var ports = {};
 
   // Map of port IDs to chromeHidden.onUnload listeners. Keep track of these
   // to free the onUnload listeners when ports are closed.
   var portReleasers = {};
 
   // Change even to odd and vice versa, to get the other side of a given
   // channel.
@@ skipping 53 matching lines @@
     }
     var port = new PortImpl(portId, opt_name);
     ports[portId] = port;
     portReleasers[portId] = PortRelease.bind(this, portId);
     chromeHidden.onUnload.addListener(portReleasers[portId]);
 
     PortAddRef(portId);
     return port;
   };
 
+  // Helper function for dispatchOnConnect.
+  function handleSendRequestError(isSendMessage, responseCallbackAccessed,
+                                  sourceExtensionId, targetExtensionId) {
+    var errorMsg;
+    var eventName = (isSendMessage  ?
+        "chrome.extension.onMessage" : "chrome.extension.onRequest");
+    if (isSendMessage && !responseCallbackAccessed) {
+      errorMsg =
+          "The " + eventName + " listener must return true if you want to" +
+          " send a response after the listener returns ";
+    } else {
+      errorMsg =
+          "Cannot send a response more than once per " + eventName +
+          " listener per document";
+    }
+    errorMsg += " (message was sent by extension " + sourceExtensionId;
+    if (sourceExtensionId != targetExtensionId)
+      errorMsg += " for extension " + targetExtensionId;
+    errorMsg += ").";
+
+    chrome.extension.lastError = {"message": errorMsg};
+    console.error("Could not send response: " + errorMsg);
+  }
+
   // Called by native code when a channel has been opened to this context.
   chromeHidden.Port.dispatchOnConnect = function(portId, channelName, tab,
                                                  sourceExtensionId,
                                                  targetExtensionId) {
     // Only create a new Port if someone is actually listening for a connection.
     // In addition to being an optimization, this also fixes a bug where if 2
     // channels were opened to and from the same process, closing one would
     // close both.
     if (targetExtensionId != extensionId)
       return;  // not for us
     if (ports[getOppositePortId(portId)])
       return;  // this channel was opened by us, so ignore it
 
     // Determine whether this is coming from another extension, so we can use
     // the right event.
     var isExternal = sourceExtensionId != extensionId;
 
     if (tab)
       tab = chromeHidden.JSON.parse(tab);
     var sender = {tab: tab, id: sourceExtensionId};
 
-    // Special case for sendRequest/onRequest.
-    if (channelName == chromeHidden.kRequestChannel) {
-      var requestEvent = (isExternal ?
-          chrome.extension.onRequestExternal : chrome.extension.onRequest);
+    // Special case for sendRequest/onRequest and sendMessage/onMessage.
+    var isSendMessage = channelName == chromeHidden.kMessageChannel;
+    if (channelName == chromeHidden.kRequestChannel ||
+        channelName == chromeHidden.kMessageChannel) {
+      var requestEvent = (isSendMessage ?

[Aaron Boodman, 2012/03/30 21:28:00]

O_o

[Matt Perry, 2012/03/30 23:02:48]

Yeah I went there.

+         (isExternal ?
+             chrome.extension.onMessageExternal : chrome.extension.onMessage) :
+         (isExternal ?
+             chrome.extension.onRequestExternal : chrome.extension.onRequest));
       if (requestEvent.hasListeners()) {
         var port = chromeHidden.Port.createPort(portId, channelName);
         port.onMessage.addListener(function(request) {
+          var responseCallbackAccessed = false;
           var responseCallback = function(response) {
             if (port) {
               port.postMessage(response);
               port = null;
             } else {
               // We nulled out port when sending the response, and now the page
               // is trying to send another response for the same request.
-              var errorMsg =
-                  "Cannot send a response more than once per " +
-                  "chrome.extension.onRequest listener per document (message " +
-                  "was sent by extension " + sourceExtensionId;
-              if (sourceExtensionId != targetExtensionId) {
-                errorMsg += " for extension " + targetExtensionId;
-              }
-              errorMsg += ").";
-              chrome.extension.lastError = {"message": errorMsg};
-              console.error("Could not send response: " + errorMsg);
+              handleSendRequestError(isSendMessage, responseCallbackAccessed,
+                                     sourceExtensionId, targetExtensionId);
             }
           };
           // In case the extension never invokes the responseCallback, and also
           // doesn't keep a reference to it, we need to clean up the port. Do
           // so by attaching to the garbage collection of the responseCallback
           // using some native hackery.
           BindToGC(responseCallback, function() {
             if (port) {
               port.disconnect();
               port = null;
             }
           });
-          requestEvent.dispatch(request, sender, responseCallback);
+          if (!isSendMessage) {
+            requestEvent.dispatch(request, sender, responseCallback);
+          } else {
+            var retvals = requestEvent.dispatch(request, sender,
+                                                responseCallback);
+            for (var i in retvals) {
+              if (retvals[i] === true) {
+                responseCallbackAccessed = true;

[Aaron Boodman, 2012/03/30 21:28:00]

Were you originally trying to do some craziness where you detect whether they
use the callback variable? That is an interesting idea, but now I think the name
is out of date?

[Aaron Boodman, 2012/03/30 21:28:00]

responseCallback = retvals.indexOf(true) > -1;

[Matt Perry, 2012/03/30 23:02:48]

Yep. New name.

[Matt Perry, 2012/03/30 23:02:48]

Sweet, done.

+                break;
+              }
+            }
+            if (!responseCallbackAccessed) {
+              // If they didn't access the response callback, they're not
+              // going to send a response, so clean up the port immediately.
+              port.destroy_();
+              port = null;
+            }
+          }
         });
       }
-      return;
     }
 
     var connectEvent = (isExternal ?
         chrome.extension.onConnectExternal : chrome.extension.onConnect);
     if (connectEvent.hasListeners()) {
       var port = chromeHidden.Port.createPort(portId, channelName);
       port.sender = sender;
       if (manifestVersion < 2)
         port.tab = port.sender.tab;
 
@@ skipping 27 matching lines @@
   chromeHidden.Port.dispatchOnMessage = function(msg, portId) {
     var port = ports[portId];
     if (port) {
       if (msg) {
         msg = chromeHidden.JSON.parse(msg);
       }
       port.onMessage.dispatch(msg, port);
     }
   };
 
+  // Shared implementation used by tabs.sendMessage and extension.sendMessage.
+  chromeHidden.Port.sendMessageImpl = function(port, request,
+                                               responseCallback) {
+    port.postMessage(request);
+
+    if (port.name == chromeHidden.kMessageChannel && !responseCallback) {
+      // Go ahead and disconnect immediately if the sender is not expecting
+      // a response.
+      port.disconnect();
+      return;
+    }
+
+    if (!responseCallback)

[Aaron Boodman, 2012/03/30 21:28:00]

Maybe add a comment that this is used by the older kRequestChannel?

[Matt Perry, 2012/03/30 23:02:48]

Done.

+      responseCallback = function() {};
+
+    port.onDisconnect.addListener(function() {
+      // For onDisconnects, we only notify the callback if there was an error
+      try {
+        if (chrome.extension.lastError)
+          responseCallback();
+      } finally {
+        port = null;
+      }
+    });
+    port.onMessage.addListener(function(response) {
+      try {
+        responseCallback(response);
+      } finally {
+        port.disconnect();
+        port = null;
+      }
+    });
+  }
+
   // This function is called on context initialization for both content scripts
   // and extension contexts.
   chromeHidden.onLoad.addListener(function(tempExtensionId,
                                            isExtensionProcess,
                                            inIncognitoContext,
                                            tempManifestVersion) {
     extensionId = tempExtensionId;
     manifestVersion = tempManifestVersion;
 
     chrome.extension = chrome.extension || {};
 
     if (manifestVersion < 2) {
       chrome.self = chrome.extension;
       chrome.extension.inIncognitoTab = inIncognitoContext;
     }
 
     chrome.extension.inIncognitoContext = inIncognitoContext;
   });