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() {
+      // This test will run twice.
+      // At the first run, the frameId will be saved. At the second run we check
+      // whether the frameId is different from the previously saved frameId.
+      var runCount = 0;
+      var frameId;
+      listenForever(
+        chrome.runtime.onMessage,
+        function(request, sender, sendResponse) {
+          // Child frames have a positive frameId.
+          chrome.test.assertTrue(sender.frameId >= 1,
+              'frameId must be positive, but it is ' + sender.frameId);
+          if (runCount === 0)
+            frameId = sender.frameId;
+          else // The second (different) frame must have a different frameId.
+            chrome.test.assertTrue(sender.frameId != frameId);
+          delete sender.frameId;
+          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
+          }, function(details) {
+            var frames = details.filter(function(frame) {
+              return frame.frameId === frameId;
+            });
+            // 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);
+            if (++runCount == 2) {
+              // This is the second run, the test has completed.
+              doneListening();
+            }
+          });
+        }
+      );

[not at google - send to devlin, 2014/11/11 01:00:56]

Sorry - why does it need to be as complicated as this? I would have thought it
could look something like
(1) gather messages from the frames
(2) assert that the URL matches the expected frame ID.

E.g, maybe like,

var messageSenders = [];
var done = listenForever(chrome.runtime.onMessage, function(_, sender) {
  messageSenders.push(sender);
  if (messageSenders.length == 3) {
    // Expecting 3 messages: 1 main frame, 2 child frames.
    // maybe for that to be non-flaky you'll need to check against the
    // expected tab ID as well.
    chrome.webNavigation.getAllFrames(function(frames) {
      // assert for each frame pair that the URL and the frame ID match.
      ...
      done();
    });
});

You might want to use different URLs for each frame in that case.

[robwu, 2014/11/11 21:32:47]

and 3) frameId is positive and 4) frameId is unique.
Updated test code to use one getAllFrames call.

[not at google - send to devlin, 2014/11/11 22:01:58]

3 and 4 seem implicitly tested by 1 and 2? So long as the webNavigation API
works, of course.

[robwu, 2014/11/11 22:20:49]

Yes. We're commenting on an old version of the file, have you already seen the
latest version of this file? (since patch set 10).

+
+      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();
     },
 
   ]);
 });