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() {
+      listenOnce(
+        chrome.runtime.onMessage,
+        function(request, sender, sendResponse) {
+          chrome.test.log("sendMessageFromFrameInTab: got frameId " +
+              sender.frameId);
+          // Child frames have a positive frameId.
+          chrome.test.assertTrue(sender.frameId >= 1);
+          delete sender.frameId;

[not at google - send to devlin, 2014/11/11 00:03:04]

Rather than deleting the frameId like this it would be nice to use the
webNavigation API to determine what the frame ID should be. You could filter on
the frame's URL, since you know that, right?

[robwu, 2014/11/11 00:34:26]

I'll be checking frameId / URL below.

+          chrome.test.assertEq({
+            tab: testTab,
+            url: request.frameUrl,
+            id: chrome.runtime.id
+          }, sender);
+
+          // Now test whether the frameId that we got back makes sense...
+          chrome.webNavigation.getAllFrames({
+            tabId: testTab.id
+          }, chrome.test.callback(function(details) {
+            var frames = details.filter(function(frame) {
+              return frame.frameId === sender.frameId;

[not at google - send to devlin, 2014/11/11 00:03:04]

Hasn't sender.frameId been deleted at this point?

[robwu, 2014/11/11 00:34:26]

Done.

+            });
+            // If |frames.length| is zero, then the frameId was bogus.
+            // If it is higher than one, then the webNavigation API is broken.
+            chrome.test.assertEq(frames.length, 1);
+            chrome.test.assertEq(frames[0].url, request.frameUrl);
+          }));
+        }
+      );
+
+      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();
     },
 
   ]);
 });