Add frameId to MessageSender (extension messaging API)

chrome/test/data/extensions/api_test/messaging/connect/test.js

 // Copyright (c) 2011 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.
 
 var listenOnce = chrome.test.listenOnce;
 var listenForever = chrome.test.listenForever;
 
 JSON.parse = function() {
   return "JSON.parse clobbered by extension.";
 };
@@ skipping 52 matching lines @@
         chrome.test.assertEq(msg.portName, portName);
         port.disconnect();
       });
     },
 
     // Tests that postMessage from the tab and its response works.
     function postMessageFromTab() {
       listenOnce(chrome.runtime.onConnect, function(port) {
         chrome.test.assertEq({
           tab: testTab,
+          frameId: 0, // Main frame
           url: testTab.url,
            id: chrome.runtime.id
         }, port.sender);
         listenOnce(port.onMessage, function(msg) {
           chrome.test.assertTrue(msg.testPostMessageFromTab);
           port.postMessage({success: true, portName: port.name});
           chrome.test.log("postMessageFromTab: got message from tab");
         });
       });
 
       var port = chrome.tabs.connect(testTab.id);
       port.postMessage({testPostMessageFromTab: true});
       chrome.test.log("postMessageFromTab: sent first message to tab");
       listenOnce(port.onMessage, function(msg) {
         port.disconnect();
       });
     },
 
     // Tests receiving a request from a content script and responding.
     function sendMessageFromTab() {
       var doneListening = listenForever(
         chrome.runtime.onMessage,
         function(request, sender, sendResponse) {
           chrome.test.assertEq({
             tab: testTab,
+            frameId: 0, // Main frame
             url: testTab.url,
              id: chrome.runtime.id
           }, sender);
           if (request.step == 1) {
             // Step 1: Page should send another request for step 2.
             chrome.test.log("sendMessageFromTab: got step 1");
             sendResponse({nextStep: true});
           } else {
             // Step 2.
             chrome.test.assertEq(request.step, 2);
             sendResponse();
             doneListening();
           }
       });
 
       var port = chrome.tabs.connect(testTab.id);
       port.postMessage({testSendMessageFromTab: true});
       port.disconnect();
       chrome.test.log("sendMessageFromTab: sent first message to tab");
     },
 
+    // Tests that a message from a child frame has a correct frameId.
+    function sendMessageFromFrameInTab() {
+      var senders = [];
+      listenForever(
+        chrome.runtime.onMessage,
+        function(request, sender, sendResponse) {
+          // Child frames have a positive frameId.
+          senders.push(sender);
+

[not at google - send to devlin, 2014/11/12 01:02:46]

Add comment:

// testSendMessageFromFrame() in page.js adds 2 frames. Wait for messages from
each.

[robwu, 2014/11/12 10:00:21]

Done.

+          if (senders.length == 2) {
+            chrome.webNavigation.getAllFrames({
+              tabId: testTab.id
+            }, function(details) {
+              var expectedSenders = details.filter(function() {
+                return frame.frameId > 0; // Exlude main frame.

[not at google - send to devlin, 2014/11/12 01:02:46]

Exlude -> Exclude.

[robwu, 2014/11/12 10:00:21]

Done.

+              }).map(function(frame) {
+                return {
+                  tab: testTab,
+                  frameId: frame.frameId,
+                  url: frame.url,
+                  id: chrome.runtime.id
+                };
+              }).sort(sortByFrameId);
+              senders.sort(sortByFrameId);
+              chrome.test.assertEq(expectedSenders, senders);
+              doneListening();
+            });
+          }
+        }
+      );
+      function sortByFrameId(a, b) {

[not at google - send to devlin, 2014/11/12 01:02:46]

nit: put this before it's used, not after. You could even declare it within the
callback to getAllFrames.

[robwu, 2014/11/12 10:00:21]

Done.

+        return a.frameId < b.frameId ? 1 : -1;
+      }
+
+      var port = chrome.tabs.connect(testTab.id);
+      port.postMessage({testSendMessageFromFrame: true});
+      port.disconnect();
+      chrome.test.log("sendMessageFromFrameInTab: send 1st message to tab");
+    },
+
     // Tests error handling when sending a request from a content script to an
     // invalid extension.
     function sendMessageFromTabError() {
       listenOnce(
         chrome.runtime.onMessage,
         function(request, sender, sendResponse) {
           if (!request.success)
             chrome.test.fail();
         }
       );
@@ skipping 76 matching lines @@
       } catch(e) {
         error = e;
       }
       chrome.test.assertTrue(error != undefined);
 
       chrome.test.succeed();
     },
 
   ]);
 });