Source code
Revision control
Copy as Markdown
Other Tools
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<title>PreferencesBindings Setting Tests</title>
<link
rel="stylesheet"
/>
<script
type="application/javascript"
src="chrome://global/content/preferencesBindings.js"
></script>
<script>
/* import-globals-from /toolkit/content/preferencesBindings.js */
function waitForSettingChange(setting) {
return new Promise(resolve => {
setting.on("change", function handler() {
setting.off("change", handler);
resolve();
});
});
}
add_task(async function testSimplePrefSetting() {
const PREF_ID = "test.setting.bool";
const SETTING_ID = "testSettingBool";
await SpecialPowers.pushPrefEnv({
set: [[PREF_ID, false]],
});
Preferences.add({
id: PREF_ID,
type: "bool",
});
Preferences.addSetting({
id: SETTING_ID,
pref: PREF_ID,
});
let setting = Preferences.getSetting(SETTING_ID);
ok(setting, "Got a setting object");
is(Services.prefs.getBoolPref(PREF_ID), false, "Pref is false");
is(setting.value, false, "Setting read from prefs");
let settingChanged = waitForSettingChange(setting);
setting.userChange(true);
await settingChanged;
is(Services.prefs.getBoolPref(PREF_ID), true, "Pref is true");
is(setting.value, true, "Setting updated");
is(setting.visible, true, "Setting is visible by default");
});
add_task(async function testPrefSettingCustomValue() {
const PREF_ID = "test.setting.int";
const SETTING_ID = "testSettingInt";
await SpecialPowers.pushPrefEnv({
set: [[PREF_ID, 7]],
});
Preferences.add({
id: PREF_ID,
type: "int",
});
Preferences.addSetting({
id: SETTING_ID,
pref: PREF_ID,
get(prefVal) {
return prefVal == 3;
},
set(val) {
return val ? 3 : 7;
},
});
let setting = Preferences.getSetting(SETTING_ID);
ok(setting, "Got a setting object");
is(Services.prefs.getIntPref(PREF_ID), 7, "Pref is 7");
is(setting.value, false, "Setting read from prefs 7 is false");
let settingChanged = waitForSettingChange(setting);
setting.userChange(true);
await settingChanged;
is(setting.value, true, "Setting is now true");
is(Services.prefs.getIntPref(PREF_ID), 3, "Pref is 3 now");
});
add_task(async function testPrefSettingOnUserChange() {
const PREF_ID = "test.setting.int2";
const SETTING_ID = "testSettingOnUserChange";
await SpecialPowers.pushPrefEnv({
set: [[PREF_ID, 7]],
});
let inputValue;
Preferences.add({
id: PREF_ID,
type: "int",
});
Preferences.addSetting({
id: SETTING_ID,
pref: PREF_ID,
onUserChange: val => {
inputValue = val;
},
});
let setting = Preferences.getSetting(SETTING_ID);
ok(setting, "Got a setting object");
is(Services.prefs.getIntPref(PREF_ID), 7, "Pref is 7");
is(setting.value, 7, "Setting read from prefs is 7");
ok(!inputValue, "Callback has not fired");
let settingChanged = waitForSettingChange(setting);
setting.userChange(9);
await settingChanged;
is(setting.value, 9, "Setting is now 9");
is(Services.prefs.getIntPref(PREF_ID), 9, "Pref is 9 now");
is(inputValue, 9, "Callback set inputValue to 9");
});
add_task(async function testPrefSettingVisible() {
const PREF_ID = "test.setting.visible";
const SETTING_ID = "testSettingVisible";
await SpecialPowers.pushPrefEnv({
set: [[PREF_ID, 5]],
});
Preferences.add({
id: PREF_ID,
type: "int",
});
Preferences.addSetting({
id: SETTING_ID,
pref: PREF_ID,
visible: () => false,
});
let setting = Preferences.getSetting(SETTING_ID);
ok(setting, "Got a setting object");
is(setting.visible, false, "Setting is not visible");
});
add_task(async function testPrefSettingDisabled() {
const DEFAULT_SETTING_ID = "testSettingDisabledDefault";
const DISABLED_SETTING_ID = "testSettingDisabled";
Preferences.addSetting({
id: DEFAULT_SETTING_ID,
});
Preferences.addSetting({
id: DISABLED_SETTING_ID,
disabled: () => true,
});
let defaultSetting = Preferences.getSetting(DEFAULT_SETTING_ID);
ok(!defaultSetting.disabled, "Setting is not disabled by default");
let disabledSetting = Preferences.getSetting(DISABLED_SETTING_ID);
ok(disabledSetting.disabled, "Setting disabled is called");
});
add_task(async function testPrefIsLocked() {
const PREF_ID = "test.setting.locked";
const SETTING_ID = "testSettingLocked";
const NO_PREF_ID = "noSettingLocked";
await SpecialPowers.pushPrefEnv({
set: [[PREF_ID, false]],
});
Preferences.add({
id: PREF_ID,
type: "bool",
});
Preferences.addSetting({
id: SETTING_ID,
pref: PREF_ID,
});
Preferences.addSetting({
id: NO_PREF_ID,
get: () => true,
});
let setting = Preferences.getSetting(SETTING_ID);
ok(setting, "Got a setting object");
is(setting.locked, false, "Setting is not locked");
Services.prefs.lockPref(PREF_ID);
is(setting.locked, true, "Setting is locked");
Services.prefs.unlockPref(PREF_ID);
is(setting.locked, false, "Setting is not unlocked");
let noPrefSetting = Preferences.getSetting(NO_PREF_ID);
ok(noPrefSetting, "Got a setting not backed by prefs");
is(noPrefSetting.locked, false, "Non-pref setting is not locked");
});
add_task(async function testGetControlConfig() {
const SETTING_ID = "getControlConfigSetting";
const NO_CONFIG_ID = "noGetControlConfigSetting";
const BASE_CONFIG = { original: "settings" };
Preferences.addSetting({
id: SETTING_ID,
getControlConfig: config => ({ ...config, added: "config" }),
});
Preferences.addSetting({ id: NO_CONFIG_ID });
let setting = Preferences.getSetting(SETTING_ID);
let controlConfig = setting.getControlConfig(BASE_CONFIG);
is(Object.keys(controlConfig).length, 2, "There are now 2 config keys");
is(
controlConfig.original,
"settings",
"The original config is passed in"
);
is(controlConfig.added, "config", "The config was updated");
let noConfigSetting = Preferences.getSetting(NO_CONFIG_ID);
let noConfigControlConfig =
noConfigSetting.getControlConfig(BASE_CONFIG);
is(
noConfigControlConfig,
BASE_CONFIG,
"There's a default implementation"
);
});
add_task(async function testDepsChange() {
const DEP_PREF_ID = "test.depsChange.dep";
const DEP_SETTING_ID = "testDepsChangeDep";
await SpecialPowers.pushPrefEnv({
set: [[DEP_PREF_ID, true]],
});
Preferences.add({ id: DEP_PREF_ID, type: "bool" });
Preferences.addSetting({
id: DEP_SETTING_ID,
pref: DEP_PREF_ID,
});
const PARENT_SETTING_ID = "testDepsChangeParent";
Preferences.addSetting({
id: PARENT_SETTING_ID,
deps: [DEP_SETTING_ID],
visible: deps => deps[DEP_SETTING_ID].value,
});
const parentSetting = Preferences.getSetting(PARENT_SETTING_ID);
ok(parentSetting.visible, "Parent setting is visible initially");
let settingChanged = waitForSettingChange(parentSetting);
Services.prefs.setBoolPref(DEP_PREF_ID, false);
await settingChanged;
ok(
!parentSetting.visible,
"Parent setting is not visible based on dep"
);
});
</script>
</head>
<body>
<p id="display"></p>
<div id="content" style="display: none"></div>
<pre id="test"></pre>
</body>
</html>