Bug 1228044 - [webext] Filter messages between extensions (r=kmag)

This commit is contained in:
Bill McCloskey 2015-12-03 14:25:40 -08:00
parent 87cc880767
commit 755eaf9042
6 changed files with 211 additions and 8 deletions

View File

@ -218,16 +218,20 @@ ExtensionPage = function(extension, params) {
this.incognito = params.incognito || false;
this.onClose = new Set();
// This is the sender property passed to the Messenger for this
// page. It can be augmented by the "page-open" hook.
let sender = {id: extension.id};
// This is the MessageSender property passed to extension.
// It can be augmented by the "page-open" hook.
let sender = {id: extension.uuid};
if (uri) {
sender.url = uri.spec;
}
let delegate = {};
let delegate = {
getSender() {},
};
Management.emit("page-load", this, params, sender, delegate);
let filter = {id: extension.id};
// Properties in |filter| must match those in the |recipient|
// parameter of sendMessage.
let filter = {extensionId: extension.id};
this.messenger = new Messenger(this, globalBroker, sender, filter, delegate);
this.extension.views.add(this);

View File

@ -247,8 +247,12 @@ function ExtensionContext(extensionId, contentWindow) {
let url = contentWindow.location.href;
let broker = ExtensionContent.getBroker(mm);
this.messenger = new Messenger(this, broker, {id: extensionId, frameId, url},
{id: extensionId, frameId}, delegate);
// The |sender| parameter is passed directly to the extension.
let sender = {id: this.extension.uuid, frameId, url};
// Properties in |filter| must match those in the |recipient|
// parameter of sendMessage.
let filter = {extensionId, frameId};
this.messenger = new Messenger(this, broker, sender, filter, delegate);
let chromeObj = Cu.createObjectIn(this.sandbox, {defineAs: "browser"});

View File

@ -669,7 +669,7 @@ function getMessageManager(target) {
//
// |context| is the extension scope.
// |broker| is a MessageBroker used to receive and send messages.
// |sender| is an object describing the sender (usually giving its extensionId, tabId, etc.)
// |sender| is an object describing the sender (usually giving its extension id, tabId, etc.)
// |filter| is a recipient filter to apply to incoming messages from the broker.
// |delegate| is an object that must implement a few methods:
// getSender(context, messageManagerTarget, sender): returns a MessageSender

View File

@ -29,10 +29,12 @@ support-files =
[test_ext_localStorage.html]
[test_ext_notifications.html]
[test_ext_runtime_connect.html]
[test_ext_runtime_connect2.html]
[test_ext_runtime_disconnect.html]
[test_ext_runtime_getPlatformInfo.html]
[test_ext_sandbox_var.html]
[test_ext_sendmessage_reply.html]
[test_ext_sendmessage_reply2.html]
[test_ext_sendmessage_doublereply.html]
[test_ext_storage.html]
[test_ext_background_runtime_connect_params.html]

View File

@ -0,0 +1,100 @@
<!DOCTYPE HTML>
<html>
<head>
<title>WebExtension test</title>
<script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
<script type="text/javascript" src="/tests/SimpleTest/SpawnTask.js"></script>
<script type="text/javascript" src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
<script type="text/javascript" src="head.js"></script>
<link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css"/>
</head>
<body>
<script type="application/javascript;version=1.8">
"use strict";
function backgroundScript(token) {
browser.runtime.onMessage.addListener(msg => {
browser.test.assertEq(msg, "done");
browser.test.notifyPass("sendmessage_reply");
});
browser.runtime.onConnect.addListener(port => {
browser.test.assertTrue(port.sender.url.endsWith("file_sample.html"), "sender url correct");
browser.test.assertTrue(port.sender.tab.url.endsWith("file_sample.html"), "sender url correct");
let tabId = port.sender.tab.id;
browser.tabs.connect(tabId, {name: token});
browser.test.assertEq(port.name, token, "token matches");
port.postMessage(token + "-done");
});
}
function contentScript(token) {
let gotTabMessage = false;
let badTabMessage = false;
browser.runtime.onConnect.addListener(port => {
if (port.name == token) {
gotTabMessage = true;
} else {
badTabMessage = true;
}
port.disconnect();
});
var port = browser.runtime.connect(null, {name: token});
port.onMessage.addListener(function(msg) {
if (msg != token + "-done" || !gotTabMessage || badTabMessage) {
return; // test failed
}
// FIXME: Removing this line causes the test to fail:
// resource://gre/modules/ExtensionUtils.jsm, line 651: NS_ERROR_NOT_INITIALIZED
port.disconnect();
browser.runtime.sendMessage("done");
});
}
function makeExtension() {
let token = Math.random();
let extensionData = {
background: `(${backgroundScript})("${token}")`,
manifest: {
"permissions": ["tabs"],
"content_scripts": [{
"matches": ["http://mochi.test/*/file_sample.html"],
"js": ["content_script.js"],
"run_at": "document_start"
}]
},
files: {
"content_script.js": `(${contentScript})("${token}")`,
},
};
return extensionData;
};
add_task(function* test_contentscript() {
let extension1 = ExtensionTestUtils.loadExtension(makeExtension());
let extension2 = ExtensionTestUtils.loadExtension(makeExtension());
yield Promise.all([extension1.startup(), extension2.startup()]);
info("extensions loaded");
let win = window.open("file_sample.html");
yield Promise.all([waitForLoad(win),
extension1.awaitFinish("sendmessage_reply"),
extension2.awaitFinish("sendmessage_reply")]);
win.close();
yield extension1.unload();
yield extension2.unload();
info("extensions unloaded");
});
</script>
</body>
</html>

View File

@ -0,0 +1,93 @@
<!DOCTYPE HTML>
<html>
<head>
<title>WebExtension test</title>
<script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
<script type="text/javascript" src="/tests/SimpleTest/SpawnTask.js"></script>
<script type="text/javascript" src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
<script type="text/javascript" src="head.js"></script>
<link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css"/>
</head>
<body>
<script type="application/javascript;version=1.8">
"use strict";
function backgroundScript(token) {
browser.runtime.onMessage.addListener((msg, sender, sendReply) => {
browser.test.assertTrue(sender.tab.url.endsWith("file_sample.html"), "sender url correct");
if (msg == "done") {
browser.test.notifyPass("sendmessage_reply");
return;
}
let tabId = sender.tab.id;
browser.tabs.sendMessage(tabId, token + "-tabMessage");
browser.test.assertEq(msg, token, "token matches");
sendReply(token + "-done");
});
}
function contentScript(token) {
let gotTabMessage = false;
let badTabMessage = false;
browser.runtime.onMessage.addListener((msg, sender, sendReply) => {
if (msg == token + "-tabMessage") {
gotTabMessage = true;
} else {
badTabMessage = true;
}
});
browser.runtime.sendMessage(token, function(resp) {
if (resp != token + "-done" || !gotTabMessage || badTabMessage) {
return; // test failed
}
browser.runtime.sendMessage("done");
});
}
function makeExtension() {
let token = Math.random();
let extensionData = {
background: `(${backgroundScript})(${token})`,
manifest: {
"permissions": ["tabs"],
"content_scripts": [{
"matches": ["http://mochi.test/*/file_sample.html"],
"js": ["content_script.js"],
"run_at": "document_start"
}]
},
files: {
"content_script.js": `(${contentScript})(${token})`,
},
};
return extensionData;
};
add_task(function* test_contentscript() {
let extension1 = ExtensionTestUtils.loadExtension(makeExtension());
let extension2 = ExtensionTestUtils.loadExtension(makeExtension());
yield Promise.all([extension1.startup(), extension2.startup()]);
info("extensions loaded");
let win = window.open("file_sample.html");
yield Promise.all([waitForLoad(win),
extension1.awaitFinish("sendmessage_reply"),
extension2.awaitFinish("sendmessage_reply")]);
win.close();
yield extension1.unload();
yield extension2.unload();
info("extensions unloaded");
});
</script>
</body>
</html>