gecko-dev/toolkit/modules/tests/browser/browser_AsyncPrefs.js
Kris Maglione e930b89c34 Bug 1514594: Part 3 - Change ChromeUtils.import API.
***
Bug 1514594: Part 3a - Change ChromeUtils.import to return an exports object; not pollute global. r=mccr8

This changes the behavior of ChromeUtils.import() to return an exports object,
rather than a module global, in all cases except when `null` is passed as a
second argument, and changes the default behavior not to pollute the global
scope with the module's exports. Thus, the following code written for the old
model:

  ChromeUtils.import("resource://gre/modules/Services.jsm");

is approximately the same as the following, in the new model:

  var {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");

Since the two behaviors are mutually incompatible, this patch will land with a
scripted rewrite to update all existing callers to use the new model rather
than the old.
***
Bug 1514594: Part 3b - Mass rewrite all JS code to use the new ChromeUtils.import API. rs=Gijs

This was done using the followng script:

https://bitbucket.org/kmaglione/m-c-rewrites/src/tip/processors/cu-import-exports.jsm
***
Bug 1514594: Part 3c - Update ESLint plugin for ChromeUtils.import API changes. r=Standard8

Differential Revision: https://phabricator.services.mozilla.com/D16747
***
Bug 1514594: Part 3d - Remove/fix hundreds of duplicate imports from sync tests. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16748
***
Bug 1514594: Part 3e - Remove no-op ChromeUtils.import() calls. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16749
***
Bug 1514594: Part 3f.1 - Cleanup various test corner cases after mass rewrite. r=Gijs
***
Bug 1514594: Part 3f.2 - Cleanup various non-test corner cases after mass rewrite. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16750

--HG--
extra : rebase_source : 359574ee3064c90f33bf36c2ebe3159a24cc8895
extra : histedit_source : b93c8f42808b1599f9122d7842d2c0b3e656a594%2C64a3a4e3359dc889e2ab2b49461bab9e27fc10a7
2019-01-17 10:18:31 -08:00

97 lines
3.4 KiB
JavaScript

"use strict";
const kWhiteListedBool = "testing.allowed-prefs.some-bool-pref";
const kWhiteListedChar = "testing.allowed-prefs.some-char-pref";
const kWhiteListedInt = "testing.allowed-prefs.some-int-pref";
function resetPrefs() {
for (let pref of [kWhiteListedBool, kWhiteListedChar, kWhiteListedBool]) {
Services.prefs.clearUserPref(pref);
}
}
registerCleanupFunction(resetPrefs);
Services.prefs.getDefaultBranch("testing.allowed-prefs.").setBoolPref("some-bool-pref", false);
Services.prefs.getDefaultBranch("testing.allowed-prefs.").setCharPref("some-char-pref", "");
Services.prefs.getDefaultBranch("testing.allowed-prefs.").setIntPref("some-int-pref", 0);
async function runTest() {
let {AsyncPrefs} = ChromeUtils.import("resource://gre/modules/AsyncPrefs.jsm");
const kInChildProcess = Services.appinfo.processType == Services.appinfo.PROCESS_TYPE_CONTENT;
// Need to define these again because when run in a content task we have no scope access.
const kNotWhiteListed = "some.pref.thats.not.whitelisted";
const kWhiteListedBool = "testing.allowed-prefs.some-bool-pref";
const kWhiteListedChar = "testing.allowed-prefs.some-char-pref";
const kWhiteListedInt = "testing.allowed-prefs.some-int-pref";
const procDesc = kInChildProcess ? "child process" : "parent process";
const valueResultMap = [
[true, "Bool"],
[false, "Bool"],
[10, "Int"],
[-1, "Int"],
["", "Char"],
["stuff", "Char"],
[[], false],
[{}, false],
[Services.io.newURI("http://mozilla.org/"), false],
];
const prefMap = [
["Bool", kWhiteListedBool],
["Char", kWhiteListedChar],
["Int", kWhiteListedInt],
];
function doesFail(pref, value) {
let msg = `Should not succeed setting ${pref} to ${value} in ${procDesc}`;
return AsyncPrefs.set(pref, value).then(() => ok(false, msg), error => ok(true, msg + "; " + error));
}
function doesWork(pref, value) {
let msg = `Should be able to set ${pref} to ${value} in ${procDesc}`;
return AsyncPrefs.set(pref, value).then(() => ok(true, msg), error => ok(false, msg + "; " + error));
}
function doReset(pref) {
let msg = `Should be able to reset ${pref} in ${procDesc}`;
return AsyncPrefs.reset(pref).then(() => ok(true, msg), () => ok(false, msg));
}
for (let [val ] of valueResultMap) {
await doesFail(kNotWhiteListed, val);
is(Services.prefs.prefHasUserValue(kNotWhiteListed), false, "Pref shouldn't get changed");
}
let resetMsg = `Should not succeed resetting ${kNotWhiteListed} in ${procDesc}`;
AsyncPrefs.reset(kNotWhiteListed).then(() => ok(false, resetMsg), error => ok(true, resetMsg + "; " + error));
for (let [type, pref] of prefMap) {
for (let [val, result] of valueResultMap) {
if (result == type) {
await doesWork(pref, val);
is(Services.prefs["get" + type + "Pref"](pref), val, "Pref should have been updated");
await doReset(pref);
} else {
await doesFail(pref, val);
is(Services.prefs.prefHasUserValue(pref), false, `Pref ${pref} shouldn't get changed`);
}
}
}
}
add_task(async function runInParent() {
await runTest();
resetPrefs();
});
if (gMultiProcessBrowser) {
add_task(async function runInChild() {
ok(gBrowser.selectedBrowser.isRemoteBrowser, "Should actually run this in child process");
await ContentTask.spawn(gBrowser.selectedBrowser, null, runTest);
resetPrefs();
});
}