1276338 - chrome.runtime.id is undefined in content scripts

Status: RESOLVED FIXED

(WebExtensions :: Untriaged, defect)

Description

[Serge]

User Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36

Steps to reproduce:

While porting our (Ghostery) code written for Chrome to Nightly build 49 with Web Extesions API support we noticed that in context script chrome.runtime.id is undefined. It is properly defined when accessed in background.js or extension popup scripts.


Actual results:

chrome.runtime.id is undefined


Expected results:

chrome.runtime.id should be equal to our extension id specified in the manifest under this key:

	"applications": {
	  "gecko": {
	    "id": "[e-mail]"
	  }

Comment 1

[Bob Silverberg [:bsilverberg]]

The code in `ExtensionContent.jsm` confirms that we do not provide this value to content scripts, and the Chrome docs do state that it is available to content scripts [2], so it sounds like something we should support. Do others agree?

[1] https://dxr.mozilla.org/mozilla-central/source/toolkit/components/extensions/ExtensionContent.jsm#71
[2] https://developer.chrome.com/extensions/runtime

Comment 2

[Andy McKay]

Agreed, with the minor point that it is the id of the addon stored in the addons manager, which may not correspond directly to the manifest if its absent from the manifest.

Comment 3

[Bob Silverberg [:bsilverberg]]

Thanks Andy. This is a very easy fix so I'm just going to bang it off.

Comment 4

[Kris Maglione [:kmag]]

+1

Comment 5

[Bob Silverberg [:bsilverberg]]

Attachment: MozReview Request: Bug 1276338 - chrome.runtime.id is undefined in content scripts, r?kmag

Review commit: https://reviewboard.mozilla.org/r/56634/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/56634/

Comment 6

[Kris Maglione [:kmag]]

Comment on attachment 8758402 [details]
MozReview Request: Bug 1276338 - chrome.runtime.id is undefined in content scripts, r?kmag

https://reviewboard.mozilla.org/r/56634/#review53304

::: toolkit/components/extensions/test/mochitest/test_ext_runtime_id.html:47
(Diff revision 1)
> +  yield extension.startup();
> +
> +  let backgroundId = yield extension.awaitMessage("background-id");
> +  let win = window.open("file_sample.html");
> +  let contentId = yield extension.awaitMessage("content-id");
> +  is(backgroundId, contentId, "runtime.id from background script matches id from content script");

We should check that they're both the same as the extension ID, not just that they're the same.

You can pass an ID as the second argument of `loadExtension`

Comment 7

[Bob Silverberg [:bsilverberg]]

Comment on attachment 8758402 [details]
MozReview Request: Bug 1276338 - chrome.runtime.id is undefined in content scripts, r?kmag

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/56634/diff/1-2/

Comment 8

[Bob Silverberg [:bsilverberg]]

https://reviewboard.mozilla.org/r/56634/#review53304

> We should check that they're both the same as the extension ID, not just that they're the same.
> 
> You can pass an ID as the second argument of `loadExtension`

Nice! I did not know that.

Comment 9

[Kris Maglione [:kmag]]

Comment on attachment 8758402 [details]
MozReview Request: Bug 1276338 - chrome.runtime.id is undefined in content scripts, r?kmag

https://reviewboard.mozilla.org/r/56634/#review53654

Looks good. Thanks!

Comment 10

[Bob Silverberg [:bsilverberg]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=7f8ac0527d59

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/fx-team/rev/1b67bc89fe9a
chrome.runtime.id is undefined in content scripts, r=kmag

Comment 12

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/1b67bc89fe9a