Ensure that sendMessage's callback is called.

extensions/renderer/resources/messaging.js

 // 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.
 
 // chrome.runtime.messaging API implementation.
 
   // TODO(kalman): factor requiring chrome out of here.
   var chrome = requireNative('chrome').GetChrome();
   var Event = require('event_bindings').Event;
   var lastError = require('lastError');
@@ skipping 317 matching lines @@
 
     if (port.name == kMessageChannel && !responseCallback) {
       // TODO(mpcomplete): Do this for the old sendRequest API too, after
       // verifying it doesn't break anything.
       // Go ahead and disconnect immediately if the sender is not expecting
       // a response.
       port.disconnect();
       return;
     }
 
-    // Ensure the callback exists for the older sendRequest API.
-    if (!responseCallback)
-      responseCallback = function() {};
+    function sendResponseIfNeeded(response) {
+      var sendResponse = responseCallback;

[Devlin, 2016/01/08 17:42:28]

Why the copy?

[robwu, 2016/01/08 17:53:20]

This is a bit defensive, to make sure that the callback is called once, if for
whatever reason the destroy/message event is triggered while handling this
message (e.g. due to a model dialog (JS alert) and two recipients who both reply
to the sendMessage call).

[Devlin, 2016/01/08 18:04:25]

That makes sense.  I think if that's the intention, it's more clear to put it
entirely within the if-block.
function() {
  if (responseCallback) {
    // Create a copy so that we don't re-entrantly call responseCallback.
    responseCallbackCopy = responseCallback;
    responseCallback = null;
    responseCallbackCopy(response);
  }
}

[robwu, 2016/01/08 18:14:24]

Added a comment.

+      if (sendResponse) {
+        responseCallback = null;
+        sendResponse(response);
+      }
+    }
+
 
     // Note: make sure to manually remove the onMessage/onDisconnect listeners
     // that we added before destroying the Port, a workaround to a bug in Port
     // where any onMessage/onDisconnect listeners added but not removed will
     // be leaked when the Port is destroyed.
     // http://crbug.com/320723 tracks a sustainable fix.
 
     function disconnectListener() {
-      // For onDisconnects, we only notify the callback if there was an error.
-      if (chrome.runtime && chrome.runtime.lastError)
-        responseCallback();
+      if (lastError.hasError(chrome)) {
+        sendResponseIfNeeded();
+      } else {
+        lastError.set(
+            port.name, 'The message port closed before a reponse was received.',

[Devlin, 2016/01/08 17:42:28]

I must be missing something - where is this listener removed when a response is
received?

[robwu, 2016/01/08 17:53:20]

Are you referring to the existing comment above? I guess at line 376-379 below.

[Devlin, 2016/01/08 18:04:25]

onDisconnect is called when the port is disconnected, but just because the port
is disconnected doesn't mean it didn't receive a response.  What stops this from
sending a lastError when a message was received and then the port is
disconnected?

[robwu, 2016/01/08 18:14:24]

Good point. Fixed!

+            null, chrome);
+        try {
+          sendResponseIfNeeded();
+        } finally {
+          lastError.clear(chrome);
+        }
+      }
     }
 
     function messageListener(response) {
       try {
-        responseCallback(response);
+        sendResponseIfNeeded(response);
       } finally {
         port.disconnect();
       }
     }
 
     privates(port).impl.onDestroy_ = function() {
       port.onDisconnect.removeListener(disconnectListener);
       port.onMessage.removeListener(messageListener);
     };
     port.onDisconnect.addListener(disconnectListener);
@@ skipping 26 matching lines @@
 exports.$set('Port', Port);
 exports.$set('createPort', createPort);
 exports.$set('sendMessageImpl', sendMessageImpl);
 exports.$set('sendMessageUpdateArguments', sendMessageUpdateArguments);
 
 // For C++ code to call.
 exports.$set('hasPort', hasPort);
 exports.$set('dispatchOnConnect', dispatchOnConnect);
 exports.$set('dispatchOnDisconnect', dispatchOnDisconnect);
 exports.$set('dispatchOnMessage', dispatchOnMessage);