1738567 - Support cookieStoreId option in userScripts.register

Status: RESOLVED FIXED

(WebExtensions :: General, enhancement, P5)

Description

[erosman]

Target APIs:

• contentScripts.register()
• userScripts.register()

Currently, users are able to decide whether an extension can run in Private Browsing Mode or not, and set it globally.

Scripts (or CSS) in contentScripts.register() & userScripts.register() are registered from the background script globally and do not differentiate between normal or private browsing.

Being able to set whether the script (or CSS) should be injected in private mode or not, would enhance (the control over) the aforementioned APIs.

For example, the following registration would only inject into tabs in normal mode.

const scriptObj = await browser.contentScripts.register({
  matches: ["*://*.org/*"],
  js: [{file: "/content_scripts/example.js"}],
  runAt: "document_idle",
  incognito: false                // defaults to true
});

Update

Change to Support cookieStoreId option in userScripts.register

const scriptObj = await browser.contentScripts.register({
  matches: ["*://*.org/*"],
  js: [{file: "/content_scripts/example.js"}],
  runAt: "document_idle",
  cookieStoreId: "firefox-default"
});

Comment 1

[Rob Wu [:robwu]]

Support for cookieStoreId: "firefox-private" is being introduced in bug 1470651.

That's only for contentScripts.register, not userScripts.register though.

Comment 2

[Richa Sharma]

Attachment: Bug 1738567 - Support cookieStoreId option in userScripts.register r=rpl,robwu

Comment 3

[erosman]

Will the cookieStoreId in userScripts.register feature be ready for Firefox 97 like contentScripts.register?

Comment 4

[Rob Wu [:robwu]]

Maybe, if the review+update cycle completes in time.

Comment 5

[erosman]

Can the unit tests be made available for the review for the current Firefox 97 (as requested on Dec 15th)?
Note: Firefox 97 soft freeze date is 2022-01-06.

Comment 6

[Rob Wu [:robwu]]

The patch author is a volunteer who is not bound to deadlines.

Comment 7

[Richa Sharma]

I'll try to have a unit test ready before the soft freeze.

Comment 8

[BugBot [:suhaib / :marco/ :calixte]]

There's a r+ patch which didn't land and no activity in this bug for 2 weeks.
:onlinericha19, could you have a look please?
For more information, please visit auto_nag documentation.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/82b887dab708
Support cookieStoreId option in userScripts.register r=robwu

Comment 10

[Marian-Vasile Laza]

https://hg.mozilla.org/mozilla-central/rev/82b887dab708

Comment 11

[Richard Bloor]

Documentation changes are ready for review:

• Compatibility data changes
• MDN documentation changes