mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-10 20:05:49 +00:00
Bug 1404584 Part 1: Use extensionId in ExtensionSettingsStore and ExtensionPreferencesManager methods, r=aswan
This code changes all of the functions in the ESS and the EPM to accept an extensionId rather than an extension object, which is required for responding to the new onUpdate event. MozReview-Commit-ID: FwMVa0fShGj --HG-- extra : rebase_source : 6b17f729966b5f1c804fb50fe41459859ab3049b
This commit is contained in:
Andrew Swan
parent
effa6e2462
commit
e22db87de6
@ -45,10 +45,10 @@ this.chrome_settings_overrides = class extends ExtensionAPI {
|
||||
// The current engine is not the same as the value that the ExtensionSettingsStore has.
|
||||
// This means that the user changed the engine, so we shouldn't control it anymore.
|
||||
// Do nothing and remove our entry from the ExtensionSettingsStore.
|
||||
ExtensionSettingsStore.removeSetting(extension, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME);
|
||||
ExtensionSettingsStore.removeSetting(extension.id, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME);
|
||||
return;
|
||||
}
|
||||
item = ExtensionSettingsStore[action](extension, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME);
|
||||
item = ExtensionSettingsStore[action](extension.id, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME);
|
||||
if (item) {
|
||||
try {
|
||||
let engine = Services.search.getEngineByName(item.value || item.initialValue);
|
||||
@ -67,7 +67,7 @@ this.chrome_settings_overrides = class extends ExtensionAPI {
|
||||
|
||||
await ExtensionSettingsStore.initialize();
|
||||
if (manifest.chrome_settings_overrides.homepage) {
|
||||
ExtensionPreferencesManager.setSetting(extension, "homepage_override",
|
||||
ExtensionPreferencesManager.setSetting(extension.id, "homepage_override",
|
||||
manifest.chrome_settings_overrides.homepage);
|
||||
}
|
||||
if (manifest.chrome_settings_overrides.search_provider) {
|
||||
@ -142,7 +142,7 @@ this.chrome_settings_overrides = class extends ExtensionAPI {
|
||||
// only sets default for install or enable.
|
||||
await this.setDefault(engineName);
|
||||
} else if (ExtensionSettingsStore.hasSetting(
|
||||
extension, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME)) {
|
||||
extension.id, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME)) {
|
||||
// is_default has been removed, but we still have a setting. Remove it.
|
||||
// This won't cover the case where the entire search_provider is removed.
|
||||
this.processDefaultSearchSetting("removeSetting");
|
||||
@ -154,7 +154,7 @@ this.chrome_settings_overrides = class extends ExtensionAPI {
|
||||
let {extension} = this;
|
||||
if (extension.startupReason === "ADDON_INSTALL") {
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extension, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME, engineName, () => {
|
||||
extension.id, DEFAULT_SEARCH_STORE_TYPE, DEFAULT_SEARCH_SETTING_NAME, engineName, () => {
|
||||
return Services.search.currentEngine.name;
|
||||
});
|
||||
Services.search.currentEngine = Services.search.getEngineByName(item.value);
|
||||
|
||||
@ -17,7 +17,7 @@ const NEW_TAB_SETTING_NAME = "newTabURL";
|
||||
this.urlOverrides = class extends ExtensionAPI {
|
||||
processNewTabSetting(action) {
|
||||
let {extension} = this;
|
||||
let item = ExtensionSettingsStore[action](extension, STORE_TYPE, NEW_TAB_SETTING_NAME);
|
||||
let item = ExtensionSettingsStore[action](extension.id, STORE_TYPE, NEW_TAB_SETTING_NAME);
|
||||
if (item) {
|
||||
aboutNewTabService.newTabURL = item.value || item.initialValue;
|
||||
}
|
||||
@ -53,14 +53,14 @@ this.urlOverrides = class extends ExtensionAPI {
|
||||
let url = extension.baseURI.resolve(manifest.chrome_url_overrides.newtab);
|
||||
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extension, STORE_TYPE, NEW_TAB_SETTING_NAME, url,
|
||||
extension.id, STORE_TYPE, NEW_TAB_SETTING_NAME, url,
|
||||
() => aboutNewTabService.newTabURL);
|
||||
|
||||
// If the extension was just re-enabled, change the setting to enabled.
|
||||
// This is required because addSetting above is used for both add and update.
|
||||
if (["ADDON_ENABLE", "ADDON_UPGRADE", "ADDON_DOWNGRADE"]
|
||||
.includes(extension.startupReason)) {
|
||||
item = ExtensionSettingsStore.enable(extension, STORE_TYPE, NEW_TAB_SETTING_NAME);
|
||||
item = ExtensionSettingsStore.enable(extension.id, STORE_TYPE, NEW_TAB_SETTING_NAME);
|
||||
}
|
||||
|
||||
// Set the newTabURL to the current value of the setting.
|
||||
|
||||
@ -50,18 +50,18 @@ Management.on("shutdown", (type, extension) => {
|
||||
if (ADDON_REPLACE_REASONS.has(extension.shutdownReason)) {
|
||||
Services.obs.notifyObservers(null, "web-extension-preferences-replacing");
|
||||
}
|
||||
this.ExtensionPreferencesManager.disableAll(extension);
|
||||
this.ExtensionPreferencesManager.disableAll(extension.id);
|
||||
break;
|
||||
|
||||
case "ADDON_UNINSTALL":
|
||||
this.ExtensionPreferencesManager.removeAll(extension);
|
||||
this.ExtensionPreferencesManager.removeAll(extension.id);
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
Management.on("startup", async (type, extension) => {
|
||||
if (["ADDON_ENABLE", "ADDON_UPGRADE", "ADDON_DOWNGRADE"].includes(extension.startupReason)) {
|
||||
const enablePromise = this.ExtensionPreferencesManager.enableAll(extension);
|
||||
const enablePromise = this.ExtensionPreferencesManager.enableAll(extension.id);
|
||||
if (ADDON_REPLACE_REASONS.has(extension.startupReason)) {
|
||||
await enablePromise;
|
||||
Services.obs.notifyObservers(null, "web-extension-preferences-replaced");
|
||||
@ -124,8 +124,8 @@ function setPrefs(setting, item) {
|
||||
* user manually changing the pref value), then we do not change any
|
||||
* of the prefs.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being modified.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being modified.
|
||||
* @param {string} name
|
||||
* The name of the setting being processed.
|
||||
* @param {string} action
|
||||
@ -136,10 +136,10 @@ function setPrefs(setting, item) {
|
||||
* Resolves to true if preferences were set as a result and to false
|
||||
* if preferences were not set.
|
||||
*/
|
||||
async function processSetting(extension, name, action) {
|
||||
async function processSetting(id, name, action) {
|
||||
await ExtensionSettingsStore.initialize();
|
||||
let expectedItem = ExtensionSettingsStore.getSetting(STORE_TYPE, name);
|
||||
let item = ExtensionSettingsStore[action](extension, STORE_TYPE, name);
|
||||
let item = ExtensionSettingsStore[action](id, STORE_TYPE, name);
|
||||
if (item) {
|
||||
let setting = settingsMap.get(name);
|
||||
let expectedPrefs = expectedItem.initialValue
|
||||
@ -185,8 +185,8 @@ this.ExtensionPreferencesManager = {
|
||||
* Indicates that an extension would like to change the value of a previously
|
||||
* defined setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being set.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being set.
|
||||
* @param {string} name
|
||||
* The unique id of the setting.
|
||||
* @param {any} value
|
||||
@ -197,11 +197,11 @@ this.ExtensionPreferencesManager = {
|
||||
* Resolves to true if the preferences were changed and to false if
|
||||
* the preferences were not changed.
|
||||
*/
|
||||
async setSetting(extension, name, value) {
|
||||
async setSetting(id, name, value) {
|
||||
let setting = settingsMap.get(name);
|
||||
await ExtensionSettingsStore.initialize();
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extension, STORE_TYPE, name, value, initialValueCallback.bind(setting));
|
||||
id, STORE_TYPE, name, value, initialValueCallback.bind(setting));
|
||||
if (item) {
|
||||
setPrefs(setting, item);
|
||||
return true;
|
||||
@ -213,8 +213,8 @@ this.ExtensionPreferencesManager = {
|
||||
* Indicates that this extension wants to temporarily cede control over the
|
||||
* given setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a preference setting is being removed.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a preference setting is being disabled.
|
||||
* @param {string} name
|
||||
* The unique id of the setting.
|
||||
*
|
||||
@ -222,15 +222,15 @@ this.ExtensionPreferencesManager = {
|
||||
* Resolves to true if the preferences were changed and to false if
|
||||
* the preferences were not changed.
|
||||
*/
|
||||
disableSetting(extension, name) {
|
||||
return processSetting(extension, name, "disable");
|
||||
disableSetting(id, name) {
|
||||
return processSetting(id, name, "disable");
|
||||
},
|
||||
|
||||
/**
|
||||
* Enable a setting that has been disabled.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being enabled.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being enabled.
|
||||
* @param {string} name
|
||||
* The unique id of the setting.
|
||||
*
|
||||
@ -238,15 +238,15 @@ this.ExtensionPreferencesManager = {
|
||||
* Resolves to true if the preferences were changed and to false if
|
||||
* the preferences were not changed.
|
||||
*/
|
||||
enableSetting(extension, name) {
|
||||
return processSetting(extension, name, "enable");
|
||||
enableSetting(id, name) {
|
||||
return processSetting(id, name, "enable");
|
||||
},
|
||||
|
||||
/**
|
||||
* Indicates that this extension no longer wants to set the given setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a preference setting is being removed.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a preference setting is being removed.
|
||||
* @param {string} name
|
||||
* The unique id of the setting.
|
||||
*
|
||||
@ -254,23 +254,23 @@ this.ExtensionPreferencesManager = {
|
||||
* Resolves to true if the preferences were changed and to false if
|
||||
* the preferences were not changed.
|
||||
*/
|
||||
removeSetting(extension, name) {
|
||||
return processSetting(extension, name, "removeSetting");
|
||||
removeSetting(id, name) {
|
||||
return processSetting(id, name, "removeSetting");
|
||||
},
|
||||
|
||||
/**
|
||||
* Disables all previously set settings for an extension. This can be called when
|
||||
* an extension is being disabled, for example.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which all settings are being unset.
|
||||
* @param {string} id
|
||||
* The id of the extension for which all settings are being unset.
|
||||
*/
|
||||
async disableAll(extension) {
|
||||
async disableAll(id) {
|
||||
await ExtensionSettingsStore.initialize();
|
||||
let settings = ExtensionSettingsStore.getAllForExtension(extension, STORE_TYPE);
|
||||
let settings = ExtensionSettingsStore.getAllForExtension(id, STORE_TYPE);
|
||||
let disablePromises = [];
|
||||
for (let name of settings) {
|
||||
disablePromises.push(this.disableSetting(extension, name));
|
||||
disablePromises.push(this.disableSetting(id, name));
|
||||
}
|
||||
await Promise.all(disablePromises);
|
||||
},
|
||||
@ -279,15 +279,15 @@ this.ExtensionPreferencesManager = {
|
||||
* Enables all disabled settings for an extension. This can be called when
|
||||
* an extension has finsihed updating or is being re-enabled, for example.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which all settings are being enabled.
|
||||
* @param {string} id
|
||||
* The id of the extension for which all settings are being enabled.
|
||||
*/
|
||||
async enableAll(extension) {
|
||||
async enableAll(id) {
|
||||
await ExtensionSettingsStore.initialize();
|
||||
let settings = ExtensionSettingsStore.getAllForExtension(extension, STORE_TYPE);
|
||||
let settings = ExtensionSettingsStore.getAllForExtension(id, STORE_TYPE);
|
||||
let enablePromises = [];
|
||||
for (let name of settings) {
|
||||
enablePromises.push(this.enableSetting(extension, name));
|
||||
enablePromises.push(this.enableSetting(id, name));
|
||||
}
|
||||
await Promise.all(enablePromises);
|
||||
},
|
||||
@ -296,15 +296,15 @@ this.ExtensionPreferencesManager = {
|
||||
* Removes all previously set settings for an extension. This can be called when
|
||||
* an extension is being uninstalled, for example.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which all settings are being unset.
|
||||
* @param {string} id
|
||||
* The id of the extension for which all settings are being unset.
|
||||
*/
|
||||
async removeAll(extension) {
|
||||
async removeAll(id) {
|
||||
await ExtensionSettingsStore.initialize();
|
||||
let settings = ExtensionSettingsStore.getAllForExtension(extension, STORE_TYPE);
|
||||
let settings = ExtensionSettingsStore.getAllForExtension(id, STORE_TYPE);
|
||||
let removePromises = [];
|
||||
for (let name of settings) {
|
||||
removePromises.push(this.removeSetting(extension, name));
|
||||
removePromises.push(this.removeSetting(id, name));
|
||||
}
|
||||
await Promise.all(removePromises);
|
||||
},
|
||||
@ -327,8 +327,8 @@ this.ExtensionPreferencesManager = {
|
||||
* This queries the levelOfControl from the ExtensionSettingsStore and also
|
||||
* takes into account whether any of the setting's preferences are locked.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which levelOfControl is being requested.
|
||||
* @param {string} id
|
||||
* The id of the extension for which levelOfControl is being requested.
|
||||
* @param {string} name
|
||||
* The unique id of the setting.
|
||||
* @param {string} storeType
|
||||
@ -338,7 +338,7 @@ this.ExtensionPreferencesManager = {
|
||||
* @returns {Promise}
|
||||
* Resolves to the level of control of the extension over the setting.
|
||||
*/
|
||||
async getLevelOfControl(extension, name, storeType = STORE_TYPE) {
|
||||
async getLevelOfControl(id, name, storeType = STORE_TYPE) {
|
||||
// This could be called for a setting that isn't defined to the PreferencesManager,
|
||||
// in which case we simply defer to the SettingsStore.
|
||||
if (storeType === STORE_TYPE) {
|
||||
@ -353,6 +353,6 @@ this.ExtensionPreferencesManager = {
|
||||
}
|
||||
}
|
||||
await ExtensionSettingsStore.initialize();
|
||||
return ExtensionSettingsStore.getLevelOfControl(extension, storeType, name);
|
||||
return ExtensionSettingsStore.getLevelOfControl(id, storeType, name);
|
||||
},
|
||||
};
|
||||
|
||||
@ -146,8 +146,8 @@ function precedenceComparator(a, b) {
|
||||
* Helper method that alters a setting, either by changing its enabled status
|
||||
* or by removing it.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being removed/disabled.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being removed/disabled.
|
||||
* @param {string} type
|
||||
* The type of setting to be altered.
|
||||
* @param {string} key
|
||||
@ -161,7 +161,7 @@ function precedenceComparator(a, b) {
|
||||
* corresponds to the current top precedent setting, or null if
|
||||
* the current top precedent setting has not changed.
|
||||
*/
|
||||
function alterSetting(extension, type, key, action) {
|
||||
function alterSetting(id, type, key, action) {
|
||||
let returnItem;
|
||||
ensureType(type);
|
||||
|
||||
@ -174,7 +174,6 @@ function alterSetting(extension, type, key, action) {
|
||||
`Cannot alter the setting for ${type}:${key} as it does not exist.`);
|
||||
}
|
||||
|
||||
let id = extension.id;
|
||||
let foundIndex = keyInfo.precedenceList.findIndex(item => item.id == id);
|
||||
|
||||
if (foundIndex === -1) {
|
||||
@ -235,8 +234,8 @@ this.ExtensionSettingsStore = {
|
||||
* Adds a setting to the store, possibly returning the current top precedent
|
||||
* setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being added.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being added.
|
||||
* @param {string} type
|
||||
* The type of setting to be stored.
|
||||
* @param {string} key
|
||||
@ -257,12 +256,11 @@ this.ExtensionSettingsStore = {
|
||||
* added does not need to be set because it is not
|
||||
* at the top of the precedence list.
|
||||
*/
|
||||
async addSetting(extension, type, key, value, initialValueCallback, callbackArgument = key) {
|
||||
async addSetting(id, type, key, value, initialValueCallback, callbackArgument = key) {
|
||||
if (typeof initialValueCallback != "function") {
|
||||
throw new Error("initialValueCallback must be a function.");
|
||||
}
|
||||
|
||||
let id = extension.id;
|
||||
ensureType(type);
|
||||
|
||||
if (!_store.data[type][key]) {
|
||||
@ -302,8 +300,8 @@ this.ExtensionSettingsStore = {
|
||||
* Removes a setting from the store, possibly returning the current top
|
||||
* precedent setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being removed.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being removed.
|
||||
* @param {string} type
|
||||
* The type of setting to be removed.
|
||||
* @param {string} key
|
||||
@ -314,16 +312,16 @@ this.ExtensionSettingsStore = {
|
||||
* corresponds to the current top precedent setting, or null if
|
||||
* the current top precedent setting has not changed.
|
||||
*/
|
||||
removeSetting(extension, type, key) {
|
||||
return alterSetting(extension, type, key, "remove");
|
||||
removeSetting(id, type, key) {
|
||||
return alterSetting(id, type, key, "remove");
|
||||
},
|
||||
|
||||
/**
|
||||
* Enables a setting in the store, possibly returning the current top
|
||||
* precedent setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being enabled.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being enabled.
|
||||
* @param {string} type
|
||||
* The type of setting to be enabled.
|
||||
* @param {string} key
|
||||
@ -334,16 +332,16 @@ this.ExtensionSettingsStore = {
|
||||
* corresponds to the current top precedent setting, or null if
|
||||
* the current top precedent setting has not changed.
|
||||
*/
|
||||
enable(extension, type, key) {
|
||||
return alterSetting(extension, type, key, "enable");
|
||||
enable(id, type, key) {
|
||||
return alterSetting(id, type, key, "enable");
|
||||
},
|
||||
|
||||
/**
|
||||
* Disables a setting in the store, possibly returning the current top
|
||||
* precedent setting.
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which a setting is being disabled.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a setting is being disabled.
|
||||
* @param {string} type
|
||||
* The type of setting to be disabled.
|
||||
* @param {string} key
|
||||
@ -354,8 +352,8 @@ this.ExtensionSettingsStore = {
|
||||
* corresponds to the current top precedent setting, or null if
|
||||
* the current top precedent setting has not changed.
|
||||
*/
|
||||
disable(extension, type, key) {
|
||||
return alterSetting(extension, type, key, "disable");
|
||||
disable(id, type, key) {
|
||||
return alterSetting(id, type, key, "disable");
|
||||
},
|
||||
|
||||
/**
|
||||
@ -382,18 +380,21 @@ this.ExtensionSettingsStore = {
|
||||
/**
|
||||
* Retrieves all settings from the store for a given extension.
|
||||
*
|
||||
* @param {Extension} extension The extension for which a settings are being retrieved.
|
||||
* @param {string} type The type of setting to be returned.
|
||||
* @param {string} id
|
||||
* The id of the extension for which a settings are being retrieved.
|
||||
* @param {string} type
|
||||
* The type of setting to be returned.
|
||||
*
|
||||
* @returns {array} A list of settings which have been stored for the extension.
|
||||
* @returns {array}
|
||||
* A list of settings which have been stored for the extension.
|
||||
*/
|
||||
getAllForExtension(extension, type) {
|
||||
getAllForExtension(id, type) {
|
||||
ensureType(type);
|
||||
|
||||
let keysObj = _store.data[type];
|
||||
let items = [];
|
||||
for (let key in keysObj) {
|
||||
if (keysObj[key].precedenceList.find(item => item.id == extension.id)) {
|
||||
if (keysObj[key].precedenceList.find(item => item.id == id)) {
|
||||
items.push(key);
|
||||
}
|
||||
}
|
||||
@ -417,14 +418,14 @@ this.ExtensionSettingsStore = {
|
||||
* Returns whether an extension currently has a stored setting for a given
|
||||
* key.
|
||||
*
|
||||
* @param {Extension} extension The extension which is being checked.
|
||||
* @param {string} id The id of the extension which is being checked.
|
||||
* @param {string} type The type of setting to be checked.
|
||||
* @param {string} key A string that uniquely identifies the setting.
|
||||
*
|
||||
* @returns {boolean} Whether the extension currently has a stored setting.
|
||||
*/
|
||||
hasSetting(extension, type, key) {
|
||||
return this.getAllForExtension(extension, type).includes(key);
|
||||
hasSetting(id, type, key) {
|
||||
return this.getAllForExtension(id, type).includes(key);
|
||||
},
|
||||
|
||||
/**
|
||||
@ -439,8 +440,8 @@ this.ExtensionSettingsStore = {
|
||||
* controllable_by_this_extension: can be controlled by this extension
|
||||
* controlled_by_this_extension: controlled by this extension
|
||||
*
|
||||
* @param {Extension} extension
|
||||
* The extension for which levelOfControl is being requested.
|
||||
* @param {string} id
|
||||
* The id of the extension for which levelOfControl is being requested.
|
||||
* @param {string} type
|
||||
* The type of setting to be returned. For example `pref`.
|
||||
* @param {string} key
|
||||
@ -450,7 +451,7 @@ this.ExtensionSettingsStore = {
|
||||
* @returns {string}
|
||||
* The level of control of the extension over the key.
|
||||
*/
|
||||
async getLevelOfControl(extension, type, key) {
|
||||
async getLevelOfControl(id, type, key) {
|
||||
ensureType(type);
|
||||
|
||||
let keyInfo = _store.data[type][key];
|
||||
@ -458,7 +459,6 @@ this.ExtensionSettingsStore = {
|
||||
return "controllable_by_this_extension";
|
||||
}
|
||||
|
||||
let id = extension.id;
|
||||
let enabledItems = keyInfo.precedenceList.filter(item => item.enabled);
|
||||
if (!enabledItems.length) {
|
||||
return "controllable_by_this_extension";
|
||||
|
||||
@ -2,8 +2,6 @@
|
||||
/* vim: set sts=2 sw=2 et tw=80: */
|
||||
"use strict";
|
||||
|
||||
XPCOMUtils.defineLazyModuleGetter(this, "ExtensionSettingsStore",
|
||||
"resource://gre/modules/ExtensionSettingsStore.jsm");
|
||||
XPCOMUtils.defineLazyModuleGetter(this, "Services",
|
||||
"resource://gre/modules/Services.jsm");
|
||||
|
||||
@ -27,19 +25,19 @@ const getSettingsAPI = (extension, name, callback, storeType, readOnly = false)
|
||||
levelOfControl: details.incognito ?
|
||||
"not_controllable" :
|
||||
await ExtensionPreferencesManager.getLevelOfControl(
|
||||
extension, name, storeType),
|
||||
extension.id, name, storeType),
|
||||
value: await callback(),
|
||||
};
|
||||
},
|
||||
set(details) {
|
||||
if (!readOnly) {
|
||||
return ExtensionPreferencesManager.setSetting(
|
||||
extension, name, details.value);
|
||||
extension.id, name, details.value);
|
||||
}
|
||||
},
|
||||
clear(details) {
|
||||
if (!readOnly) {
|
||||
return ExtensionPreferencesManager.removeSetting(extension, name);
|
||||
return ExtensionPreferencesManager.removeSetting(extension.id, name);
|
||||
}
|
||||
},
|
||||
};
|
||||
|
||||
@ -128,7 +128,7 @@ this.contextualIdentities = class extends ExtensionAPI {
|
||||
let {extension} = this;
|
||||
|
||||
if (extension.hasPermission("contextualIdentities")) {
|
||||
ExtensionPreferencesManager.setSetting(extension, CONTAINERS_ENABLED_SETTING_NAME, extension.id);
|
||||
ExtensionPreferencesManager.setSetting(extension.id, CONTAINERS_ENABLED_SETTING_NAME, extension.id);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -24,19 +24,19 @@ const getPrivacyAPI = (extension, name, callback) => {
|
||||
levelOfControl: details.incognito ?
|
||||
"not_controllable" :
|
||||
await ExtensionPreferencesManager.getLevelOfControl(
|
||||
extension, name),
|
||||
extension.id, name),
|
||||
value: await callback(),
|
||||
};
|
||||
},
|
||||
set(details) {
|
||||
checkScope(details.scope);
|
||||
return ExtensionPreferencesManager.setSetting(
|
||||
extension, name, details.value);
|
||||
extension.id, name, details.value);
|
||||
},
|
||||
clear(details) {
|
||||
checkScope(details.scope);
|
||||
return ExtensionPreferencesManager.removeSetting(
|
||||
extension, name);
|
||||
extension.id, name);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
@ -104,16 +104,16 @@ add_task(async function test_preference_manager() {
|
||||
let settingObj = SETTINGS[setting];
|
||||
let newValue1 = "newValue1";
|
||||
let levelOfControl = await ExtensionPreferencesManager.getLevelOfControl(
|
||||
extensions[1], setting);
|
||||
extensions[1].id, setting);
|
||||
equal(levelOfControl, "controllable_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl with no settings set.");
|
||||
|
||||
let prefsChanged = await ExtensionPreferencesManager.setSetting(
|
||||
extensions[1], setting, newValue1);
|
||||
extensions[1].id, setting, newValue1);
|
||||
ok(prefsChanged, "setSetting returns true when the pref(s) have been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"setSetting sets the prefs for the first extension.");
|
||||
levelOfControl = await ExtensionPreferencesManager.getLevelOfControl(extensions[1], setting);
|
||||
levelOfControl = await ExtensionPreferencesManager.getLevelOfControl(extensions[1].id, setting);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_this_extension",
|
||||
@ -123,47 +123,47 @@ add_task(async function test_preference_manager() {
|
||||
equal(checkSetting.value, newValue1, "getSetting returns the expected value.");
|
||||
|
||||
let newValue2 = "newValue2";
|
||||
prefsChanged = await ExtensionPreferencesManager.setSetting(extensions[0], setting, newValue2);
|
||||
prefsChanged = await ExtensionPreferencesManager.setSetting(extensions[0].id, setting, newValue2);
|
||||
ok(!prefsChanged, "setSetting returns false when the pref(s) have not been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"setSetting does not set the pref(s) for an earlier extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.disableSetting(extensions[0], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.disableSetting(extensions[0].id, setting);
|
||||
ok(!prefsChanged, "disableSetting returns false when the pref(s) have not been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"disableSetting does not change the pref(s) for the non-top extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.enableSetting(extensions[0], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.enableSetting(extensions[0].id, setting);
|
||||
ok(!prefsChanged, "enableSetting returns false when the pref(s) have not been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"enableSetting does not change the pref(s) for the non-top extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.removeSetting(extensions[0], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.removeSetting(extensions[0].id, setting);
|
||||
ok(!prefsChanged, "removeSetting returns false when the pref(s) have not been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"removeSetting does not change the pref(s) for the non-top extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.setSetting(extensions[0], setting, newValue2);
|
||||
prefsChanged = await ExtensionPreferencesManager.setSetting(extensions[0].id, setting, newValue2);
|
||||
ok(!prefsChanged, "setSetting returns false when the pref(s) have not been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"setSetting does not set the pref(s) for an earlier extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.disableSetting(extensions[1], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.disableSetting(extensions[1].id, setting);
|
||||
ok(prefsChanged, "disableSetting returns true when the pref(s) have been set.");
|
||||
checkPrefs(settingObj, newValue2,
|
||||
"disableSetting sets the pref(s) to the next value when disabling the top extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.enableSetting(extensions[1], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.enableSetting(extensions[1].id, setting);
|
||||
ok(prefsChanged, "enableSetting returns true when the pref(s) have been set.");
|
||||
checkPrefs(settingObj, newValue1,
|
||||
"enableSetting sets the pref(s) to the previous value(s).");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.removeSetting(extensions[1], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.removeSetting(extensions[1].id, setting);
|
||||
ok(prefsChanged, "removeSetting returns true when the pref(s) have been set.");
|
||||
checkPrefs(settingObj, newValue2,
|
||||
"removeSetting sets the pref(s) to the next value when removing the top extension.");
|
||||
|
||||
prefsChanged = await ExtensionPreferencesManager.removeSetting(extensions[0], setting);
|
||||
prefsChanged = await ExtensionPreferencesManager.removeSetting(extensions[0].id, setting);
|
||||
ok(prefsChanged, "removeSetting returns true when the pref(s) have been set.");
|
||||
for (let i = 0; i < settingObj.prefNames.length; i++) {
|
||||
equal(Preferences.get(settingObj.prefNames[i]), settingObj.initalValues[i],
|
||||
@ -178,13 +178,13 @@ add_task(async function test_preference_manager() {
|
||||
let newValue3 = "newValue3";
|
||||
for (let setting in SETTINGS) {
|
||||
let settingObj = SETTINGS[setting];
|
||||
await ExtensionPreferencesManager.setSetting(extensions[0], setting, newValue3);
|
||||
await ExtensionPreferencesManager.setSetting(extensions[0].id, setting, newValue3);
|
||||
checkPrefs(settingObj, newValue3, "setSetting set the pref.");
|
||||
}
|
||||
|
||||
let setSettings = await ExtensionSettingsStore.getAllForExtension(extensions[0], STORE_TYPE);
|
||||
let setSettings = await ExtensionSettingsStore.getAllForExtension(extensions[0].id, STORE_TYPE);
|
||||
deepEqual(setSettings, Object.keys(SETTINGS), "Expected settings were set for extension.");
|
||||
await ExtensionPreferencesManager.disableAll(extensions[0]);
|
||||
await ExtensionPreferencesManager.disableAll(extensions[0].id);
|
||||
|
||||
for (let setting in SETTINGS) {
|
||||
let settingObj = SETTINGS[setting];
|
||||
@ -194,16 +194,16 @@ add_task(async function test_preference_manager() {
|
||||
}
|
||||
}
|
||||
|
||||
setSettings = await ExtensionSettingsStore.getAllForExtension(extensions[0], STORE_TYPE);
|
||||
setSettings = await ExtensionSettingsStore.getAllForExtension(extensions[0].id, STORE_TYPE);
|
||||
deepEqual(setSettings, Object.keys(SETTINGS), "disableAll retains the settings.");
|
||||
|
||||
await ExtensionPreferencesManager.enableAll(extensions[0]);
|
||||
await ExtensionPreferencesManager.enableAll(extensions[0].id);
|
||||
for (let setting in SETTINGS) {
|
||||
let settingObj = SETTINGS[setting];
|
||||
checkPrefs(settingObj, newValue3, "enableAll re-set the pref.");
|
||||
}
|
||||
|
||||
await ExtensionPreferencesManager.removeAll(extensions[0]);
|
||||
await ExtensionPreferencesManager.removeAll(extensions[0].id);
|
||||
|
||||
for (let setting in SETTINGS) {
|
||||
let settingObj = SETTINGS[setting];
|
||||
@ -213,7 +213,7 @@ add_task(async function test_preference_manager() {
|
||||
}
|
||||
}
|
||||
|
||||
setSettings = await ExtensionSettingsStore.getAllForExtension(extensions[0], STORE_TYPE);
|
||||
setSettings = await ExtensionSettingsStore.getAllForExtension(extensions[0].id, STORE_TYPE);
|
||||
deepEqual(setSettings, [], "removeAll removed all settings.");
|
||||
|
||||
// Tests for preventing automatic changes to manually edited prefs.
|
||||
@ -222,7 +222,7 @@ add_task(async function test_preference_manager() {
|
||||
let manualValue = "something different";
|
||||
let settingObj = SETTINGS[setting];
|
||||
let extension = extensions[1];
|
||||
await ExtensionPreferencesManager.setSetting(extension, setting, apiValue);
|
||||
await ExtensionPreferencesManager.setSetting(extension.id, setting, apiValue);
|
||||
|
||||
let checkResetPrefs = (method) => {
|
||||
let prefNames = settingObj.prefNames;
|
||||
@ -241,13 +241,13 @@ add_task(async function test_preference_manager() {
|
||||
// Manually set the preference to a different value.
|
||||
Preferences.set(settingObj.prefNames[0], manualValue);
|
||||
|
||||
await ExtensionPreferencesManager.disableAll(extension);
|
||||
await ExtensionPreferencesManager.disableAll(extension.id);
|
||||
checkResetPrefs("disableAll");
|
||||
|
||||
await ExtensionPreferencesManager.enableAll(extension);
|
||||
await ExtensionPreferencesManager.enableAll(extension.id);
|
||||
checkResetPrefs("enableAll");
|
||||
|
||||
await ExtensionPreferencesManager.removeAll(extension);
|
||||
await ExtensionPreferencesManager.removeAll(extension.id);
|
||||
checkResetPrefs("removeAll");
|
||||
}
|
||||
|
||||
@ -257,10 +257,10 @@ add_task(async function test_preference_manager() {
|
||||
let pref = settingObj.prefNames[0];
|
||||
let newValue = "newValue";
|
||||
Preferences.reset(pref);
|
||||
await ExtensionPreferencesManager.setSetting(extensions[1], setting, newValue);
|
||||
await ExtensionPreferencesManager.setSetting(extensions[1].id, setting, newValue);
|
||||
equal(Preferences.get(pref), settingObj.valueFn(pref, newValue),
|
||||
"Uninitialized pref is set.");
|
||||
await ExtensionPreferencesManager.removeSetting(extensions[1], setting);
|
||||
await ExtensionPreferencesManager.removeSetting(extensions[1].id, setting);
|
||||
ok(!Preferences.has(pref), "removeSetting removed the pref.");
|
||||
|
||||
// Test levelOfControl with a locked pref.
|
||||
@ -268,7 +268,7 @@ add_task(async function test_preference_manager() {
|
||||
let prefToLock = SETTINGS[setting].prefNames[0];
|
||||
Preferences.lock(prefToLock, 1);
|
||||
ok(Preferences.locked(prefToLock), `Preference ${prefToLock} is locked.`);
|
||||
let levelOfControl = await ExtensionPreferencesManager.getLevelOfControl(extensions[1], setting);
|
||||
let levelOfControl = await ExtensionPreferencesManager.getLevelOfControl(extensions[1].id, setting);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"not_controllable",
|
||||
|
||||
@ -90,13 +90,13 @@ add_task(async function test_settings_store() {
|
||||
for (let key of KEY_LIST) {
|
||||
let extensionIndex = 1;
|
||||
let itemToAdd = ITEMS[key][extensionIndex];
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl with no settings set for a key.");
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extensions[extensionIndex], TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
extensions[extensionIndex].id, TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
expectedCallbackCount++;
|
||||
equal(callbackCount,
|
||||
expectedCallbackCount,
|
||||
@ -107,12 +107,12 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
itemToAdd,
|
||||
"getSetting returns correct item with only one item in the list.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl with only one item in the list.");
|
||||
ok(ExtensionSettingsStore.hasSetting(extensions[extensionIndex], TEST_TYPE, key),
|
||||
ok(ExtensionSettingsStore.hasSetting(extensions[extensionIndex].id, TEST_TYPE, key),
|
||||
"hasSetting returns the correct value when an extension has a setting set.");
|
||||
}
|
||||
|
||||
@ -121,7 +121,7 @@ add_task(async function test_settings_store() {
|
||||
let extensionIndex = 0;
|
||||
let itemToAdd = ITEMS[key][extensionIndex];
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extensions[extensionIndex], TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
extensions[extensionIndex].id, TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
equal(callbackCount,
|
||||
expectedCallbackCount,
|
||||
"initialValueCallback called the expected number of times.");
|
||||
@ -131,7 +131,7 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
ITEMS[key][1],
|
||||
"getSetting returns correct item with more than one item in the list.");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_other_extensions",
|
||||
@ -145,13 +145,13 @@ add_task(async function test_settings_store() {
|
||||
for (let key of KEY_LIST) {
|
||||
let extensionIndex = 2;
|
||||
let itemToAdd = ITEMS[key][extensionIndex];
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl for a more recent extension.");
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extensions[extensionIndex], TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
extensions[extensionIndex].id, TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
equal(callbackCount,
|
||||
expectedCallbackCount,
|
||||
"initialValueCallback called the expected number of times.");
|
||||
@ -161,7 +161,7 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
ITEMS[key][2],
|
||||
"getSetting returns correct item with more than one item in the list.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_this_extension",
|
||||
@ -169,21 +169,21 @@ add_task(async function test_settings_store() {
|
||||
}
|
||||
|
||||
for (let extension of extensions) {
|
||||
let items = await ExtensionSettingsStore.getAllForExtension(extension, TEST_TYPE);
|
||||
let items = await ExtensionSettingsStore.getAllForExtension(extension.id, TEST_TYPE);
|
||||
deepEqual(items, KEY_LIST, "getAllForExtension returns expected keys.");
|
||||
}
|
||||
|
||||
// Attempting to remove a setting that has not been set should *not* throw an exception.
|
||||
let removeResult = await ExtensionSettingsStore.removeSetting(extensions[0], "myType", "unset_key");
|
||||
let removeResult = await ExtensionSettingsStore.removeSetting(extensions[0].id, "myType", "unset_key");
|
||||
equal(removeResult, null, "Removing a setting that was not previously set returns null.");
|
||||
|
||||
// Attempting to disable a setting that has not been set should throw an exception.
|
||||
Assert.throws(() => ExtensionSettingsStore.disable(extensions[0], "myType", "unset_key"),
|
||||
Assert.throws(() => ExtensionSettingsStore.disable(extensions[0].id, "myType", "unset_key"),
|
||||
/Cannot alter the setting for myType:unset_key as it does not exist/,
|
||||
"disable rejects with an unset key.");
|
||||
|
||||
// Attempting to enable a setting that has not been set should throw an exception.
|
||||
Assert.throws(() => ExtensionSettingsStore.enable(extensions[0], "myType", "unset_key"),
|
||||
Assert.throws(() => ExtensionSettingsStore.enable(extensions[0].id, "myType", "unset_key"),
|
||||
/Cannot alter the setting for myType:unset_key as it does not exist/,
|
||||
"enable rejects with an unset key.");
|
||||
|
||||
@ -192,21 +192,21 @@ add_task(async function test_settings_store() {
|
||||
for (let key of KEY_LIST) {
|
||||
let extensionIndex = 0;
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extensions[extensionIndex], TEST_TYPE, key, "new value", initialValue);
|
||||
extensions[extensionIndex].id, TEST_TYPE, key, "new value", initialValue);
|
||||
equal(callbackCount,
|
||||
expectedCallbackCount,
|
||||
"initialValueCallback called the expected number of times.");
|
||||
equal(item, null, "Updating non-top item for a key returns null");
|
||||
item = await ExtensionSettingsStore.disable(extensions[extensionIndex], TEST_TYPE, key);
|
||||
item = await ExtensionSettingsStore.disable(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(item, null, "Disabling non-top item for a key returns null.");
|
||||
let allForExtension = await ExtensionSettingsStore.getAllForExtension(extensions[extensionIndex], TEST_TYPE);
|
||||
let allForExtension = await ExtensionSettingsStore.getAllForExtension(extensions[extensionIndex].id, TEST_TYPE);
|
||||
deepEqual(allForExtension, expectedKeys, "getAllForExtension returns expected keys after a disable.");
|
||||
item = await ExtensionSettingsStore.getSetting(TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
ITEMS[key][2],
|
||||
"getSetting returns correct item after a disable.");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_other_extensions",
|
||||
@ -216,16 +216,16 @@ add_task(async function test_settings_store() {
|
||||
// Re-enable the non-top item for a key.
|
||||
for (let key of KEY_LIST) {
|
||||
let extensionIndex = 0;
|
||||
let item = await ExtensionSettingsStore.enable(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let item = await ExtensionSettingsStore.enable(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(item, null, "Enabling non-top item for a key returns null.");
|
||||
let allForExtension = await ExtensionSettingsStore.getAllForExtension(extensions[extensionIndex], TEST_TYPE);
|
||||
let allForExtension = await ExtensionSettingsStore.getAllForExtension(extensions[extensionIndex].id, TEST_TYPE);
|
||||
deepEqual(allForExtension, expectedKeys, "getAllForExtension returns expected keys after an enable.");
|
||||
item = await ExtensionSettingsStore.getSetting(TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
ITEMS[key][2],
|
||||
"getSetting returns correct item after an enable.");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_other_extensions",
|
||||
@ -235,28 +235,28 @@ add_task(async function test_settings_store() {
|
||||
// Remove the non-top item for a key.
|
||||
for (let key of KEY_LIST) {
|
||||
let extensionIndex = 0;
|
||||
let item = await ExtensionSettingsStore.removeSetting(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let item = await ExtensionSettingsStore.removeSetting(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(item, null, "Removing non-top item for a key returns null.");
|
||||
expectedKeys = expectedKeys.filter(expectedKey => expectedKey != key);
|
||||
let allForExtension = await ExtensionSettingsStore.getAllForExtension(extensions[extensionIndex], TEST_TYPE);
|
||||
let allForExtension = await ExtensionSettingsStore.getAllForExtension(extensions[extensionIndex].id, TEST_TYPE);
|
||||
deepEqual(allForExtension, expectedKeys, "getAllForExtension returns expected keys after a removal.");
|
||||
item = await ExtensionSettingsStore.getSetting(TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
ITEMS[key][2],
|
||||
"getSetting returns correct item after a removal.");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[extensionIndex].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_other_extensions",
|
||||
"getLevelOfControl returns correct levelOfControl after removal of non-top item.");
|
||||
ok(!ExtensionSettingsStore.hasSetting(extensions[extensionIndex], TEST_TYPE, key),
|
||||
ok(!ExtensionSettingsStore.hasSetting(extensions[extensionIndex].id, TEST_TYPE, key),
|
||||
"hasSetting returns the correct value when an extension does not have a setting set.");
|
||||
}
|
||||
|
||||
for (let key of KEY_LIST) {
|
||||
// Disable the top item for a key.
|
||||
let item = await ExtensionSettingsStore.disable(extensions[2], TEST_TYPE, key);
|
||||
let item = await ExtensionSettingsStore.disable(extensions[2].id, TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
ITEMS[key][1],
|
||||
@ -266,14 +266,14 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
ITEMS[key][1],
|
||||
"getSetting returns correct item after a disable.");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[2], TEST_TYPE, key);
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[2].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl after disabling of top item.");
|
||||
|
||||
// Re-enable the top item for a key.
|
||||
item = await ExtensionSettingsStore.enable(extensions[2], TEST_TYPE, key);
|
||||
item = await ExtensionSettingsStore.enable(extensions[2].id, TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
ITEMS[key][2],
|
||||
@ -283,14 +283,14 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
ITEMS[key][2],
|
||||
"getSetting returns correct item after an enable.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[2], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[2].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl after re-enabling top item.");
|
||||
|
||||
// Remove the top item for a key.
|
||||
item = await ExtensionSettingsStore.removeSetting(extensions[2], TEST_TYPE, key);
|
||||
item = await ExtensionSettingsStore.removeSetting(extensions[2].id, TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
ITEMS[key][1],
|
||||
@ -300,7 +300,7 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
ITEMS[key][1],
|
||||
"getSetting returns correct item after a removal.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[2], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[2].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
@ -309,7 +309,7 @@ add_task(async function test_settings_store() {
|
||||
// Add a setting for the current top item.
|
||||
let itemToAdd = {key, value: `new-${key}`, id: "@second"};
|
||||
item = await ExtensionSettingsStore.addSetting(
|
||||
extensions[1], TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
extensions[1].id, TEST_TYPE, itemToAdd.key, itemToAdd.value, initialValue);
|
||||
equal(callbackCount,
|
||||
expectedCallbackCount,
|
||||
"initialValueCallback called the expected number of times.");
|
||||
@ -322,7 +322,7 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
itemToAdd,
|
||||
"getSetting returns correct item after updating.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_this_extension",
|
||||
@ -333,7 +333,7 @@ add_task(async function test_settings_store() {
|
||||
// We're using the callback to set the expected value, so we need to increment the
|
||||
// expectedCallbackCount.
|
||||
expectedCallbackCount++;
|
||||
item = await ExtensionSettingsStore.disable(extensions[1], TEST_TYPE, key);
|
||||
item = await ExtensionSettingsStore.disable(extensions[1].id, TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
expectedItem,
|
||||
@ -343,14 +343,14 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
expectedItem,
|
||||
"getSetting returns the initial value after all are disabled.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl after all are disabled.");
|
||||
|
||||
// Re-enable the last remaining item for a key.
|
||||
item = await ExtensionSettingsStore.enable(extensions[1], TEST_TYPE, key);
|
||||
item = await ExtensionSettingsStore.enable(extensions[1].id, TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
itemToAdd,
|
||||
@ -360,14 +360,14 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
itemToAdd,
|
||||
"getSetting returns expected value after re-enabling.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controlled_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl after re-enabling.");
|
||||
|
||||
// Remove the last remaining item for a key.
|
||||
item = await ExtensionSettingsStore.removeSetting(extensions[1], TEST_TYPE, key);
|
||||
item = await ExtensionSettingsStore.removeSetting(extensions[1].id, TEST_TYPE, key);
|
||||
deepEqual(
|
||||
item,
|
||||
expectedItem,
|
||||
@ -377,14 +377,14 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
null,
|
||||
"getSetting returns null after all are removed.");
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1], TEST_TYPE, key);
|
||||
levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1].id, TEST_TYPE, key);
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
"getLevelOfControl returns correct levelOfControl after all are removed.");
|
||||
|
||||
// Attempting to remove a setting that has had all extensions removed should *not* throw an exception.
|
||||
removeResult = await ExtensionSettingsStore.removeSetting(extensions[1], TEST_TYPE, key);
|
||||
removeResult = await ExtensionSettingsStore.removeSetting(extensions[1].id, TEST_TYPE, key);
|
||||
equal(removeResult, null, "Removing a setting that has had all extensions removed returns null.");
|
||||
}
|
||||
|
||||
@ -394,7 +394,7 @@ add_task(async function test_settings_store() {
|
||||
let callbackArgumentValue = Date.now();
|
||||
// Add the setting.
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
extensions[extensionIndex], TEST_TYPE, testKey, 1, initialValue, callbackArgumentValue);
|
||||
extensions[extensionIndex].id, TEST_TYPE, testKey, 1, initialValue, callbackArgumentValue);
|
||||
expectedCallbackCount++;
|
||||
equal(callbackCount,
|
||||
expectedCallbackCount,
|
||||
@ -404,7 +404,7 @@ add_task(async function test_settings_store() {
|
||||
// We're using the callback to set the expected value, so we need to increment the
|
||||
// expectedCallbackCount.
|
||||
expectedCallbackCount++;
|
||||
item = await ExtensionSettingsStore.removeSetting(extensions[extensionIndex], TEST_TYPE, testKey);
|
||||
item = await ExtensionSettingsStore.removeSetting(extensions[extensionIndex].id, TEST_TYPE, testKey);
|
||||
deepEqual(
|
||||
item,
|
||||
expectedItem,
|
||||
@ -420,7 +420,7 @@ add_task(async function test_settings_store() {
|
||||
item,
|
||||
null,
|
||||
"getSetting returns a null item if the setting does not have any records.");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1], TEST_TYPE, "not a key");
|
||||
let levelOfControl = await ExtensionSettingsStore.getLevelOfControl(extensions[1].id, TEST_TYPE, "not a key");
|
||||
equal(
|
||||
levelOfControl,
|
||||
"controllable_by_this_extension",
|
||||
@ -477,17 +477,17 @@ add_task(async function test_settings_store_setByUser() {
|
||||
"getSetting is initially null");
|
||||
|
||||
let item = await ExtensionSettingsStore.addSetting(
|
||||
one, type, key, "one", initialCallback);
|
||||
one.id, type, key, "one", initialCallback);
|
||||
deepEqual({key, value: "one", id: one.id}, item,
|
||||
"addSetting returns the first set item");
|
||||
|
||||
item = await ExtensionSettingsStore.addSetting(
|
||||
two, type, key, "two", initialCallback);
|
||||
two.id, type, key, "two", initialCallback);
|
||||
deepEqual({key, value: "two", id: two.id}, item,
|
||||
"addSetting returns the second set item");
|
||||
|
||||
item = await ExtensionSettingsStore.addSetting(
|
||||
three, type, key, "three", initialCallback);
|
||||
three.id, type, key, "three", initialCallback);
|
||||
deepEqual({key, value: "three", id: three.id}, item,
|
||||
"addSetting returns the third set item");
|
||||
|
||||
@ -498,15 +498,15 @@ add_task(async function test_settings_store_setByUser() {
|
||||
deepEqual({key, initialValue: "initial"}, ExtensionSettingsStore.getSetting(type, key),
|
||||
"getSetting returns the initial value after being set by user");
|
||||
|
||||
item = ExtensionSettingsStore.enable(one, type, key);
|
||||
item = ExtensionSettingsStore.enable(one.id, type, key);
|
||||
deepEqual({key, value: "one", id: one.id}, item,
|
||||
"enable returns the first set item after enable");
|
||||
|
||||
item = ExtensionSettingsStore.enable(three, type, key);
|
||||
item = ExtensionSettingsStore.enable(three.id, type, key);
|
||||
deepEqual({key, value: "three", id: three.id}, item,
|
||||
"enable returns the third set item after enable");
|
||||
|
||||
item = ExtensionSettingsStore.enable(two, type, key);
|
||||
item = ExtensionSettingsStore.enable(two.id, type, key);
|
||||
deepEqual(undefined, item,
|
||||
"enable returns undefined after enabling the second item");
|
||||
|
||||
@ -514,9 +514,9 @@ add_task(async function test_settings_store_setByUser() {
|
||||
deepEqual({key, value: "three", id: three.id}, item,
|
||||
"getSetting returns the third set item after enabling the second item");
|
||||
|
||||
ExtensionSettingsStore.removeSetting(three, type, key);
|
||||
ExtensionSettingsStore.removeSetting(two, type, key);
|
||||
ExtensionSettingsStore.removeSetting(one, type, key);
|
||||
ExtensionSettingsStore.removeSetting(three.id, type, key);
|
||||
ExtensionSettingsStore.removeSetting(two.id, type, key);
|
||||
ExtensionSettingsStore.removeSetting(one.id, type, key);
|
||||
|
||||
equal(null, ExtensionSettingsStore.getSetting(type, key),
|
||||
"getSetting returns null after removing all settings");
|
||||
|
||||
Loading…
Reference in New Issue
Block a user