mozilla-central/browser/components/urlbar/tests/quicksuggest/unit/test_quicksuggest_migrate_v2.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// Tests quick suggest prefs migration to version 2.
"use strict";
// Expected version 2 default-branch prefs
const DEFAULT_PREFS = {
"quicksuggest.enabled": true,
"quicksuggest.dataCollection.enabled": false,
"suggest.quicksuggest.nonsponsored": true,
"suggest.quicksuggest.sponsored": true,
};
// Migration will use these values to migrate only up to version 1 instead of
// the current version.
// Currently undefined because version 2 is the current migration version and we
// want migration to use its actual values, not overrides. When version 3 is
// added, set this to an object like the one in test_quicksuggest_migrate_v1.js.
const TEST_OVERRIDES = undefined;
add_setup(async () => {
await UrlbarTestUtils.initNimbusFeature();
});
// The following tasks test OFFLINE UNVERSIONED to version 2
// Migrating from:
// * Unversioned prefs
// * Offline
// * Main suggestions pref: user left on
// * Sponsored suggestions: user left on
//
// Expected:
// * Non-sponsored suggestions: on
// * Sponsored suggestions: on
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
},
});
});
// Migrating from:
// * Unversioned prefs
// * Offline
// * Main suggestions pref: user turned off
// * Sponsored suggestions: user left on (but ignored since main was off)
//
// Expected:
// * Non-sponsored suggestions: off
// * Sponsored suggestions: off
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"suggest.quicksuggest": false,
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
userBranch: {
"suggest.quicksuggest.nonsponsored": false,
"suggest.quicksuggest.sponsored": false,
},
},
});
});
// Migrating from:
// * Unversioned prefs
// * Offline
// * Main suggestions pref: user left on
// * Sponsored suggestions: user turned off
//
// Expected:
// * Non-sponsored suggestions: on
// * Sponsored suggestions: off
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"suggest.quicksuggest.sponsored": false,
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
userBranch: {
"suggest.quicksuggest.sponsored": false,
},
},
});
});
// Migrating from:
// * Unversioned prefs
// * Offline
// * Main suggestions pref: user turned off
// * Sponsored suggestions: user turned off
//
// Expected:
// * Non-sponsored suggestions: off
// * Sponsored suggestions: off
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"suggest.quicksuggest": false,
"suggest.quicksuggest.sponsored": false,
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
userBranch: {
"suggest.quicksuggest.nonsponsored": false,
"suggest.quicksuggest.sponsored": false,
},
},
});
});
// The following tasks test OFFLINE VERSION 1 to version 2
// Migrating from:
// * Version 1 prefs
// * Offline
// * Non-sponsored suggestions: user left on
// * Sponsored suggestions: user left on
// * Data collection: user left off
//
// Expected:
// * Non-sponsored suggestions: on
// * Sponsored suggestions: on
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"quicksuggest.migrationVersion": 1,
"quicksuggest.scenario": "offline",
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
},
});
});
// Migrating from:
// * Version 1 prefs
// * Offline
// * Non-sponsored suggestions: user left on
// * Sponsored suggestions: user left on
// * Data collection: user turned on
//
// Expected:
// * Non-sponsored suggestions: on
// * Sponsored suggestions: on
// * Data collection: on
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"quicksuggest.migrationVersion": 1,
"quicksuggest.scenario": "offline",
"quicksuggest.dataCollection.enabled": true,
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
userBranch: {
"quicksuggest.dataCollection.enabled": true,
},
},
});
});
// Migrating from:
// * Version 1 prefs
// * Offline
// * Non-sponsored suggestions: user left on
// * Sponsored suggestions: user turned off
// * Data collection: user left off
//
// Expected:
// * Non-sponsored suggestions: on
// * Sponsored suggestions: off
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"quicksuggest.migrationVersion": 1,
"quicksuggest.scenario": "offline",
"suggest.quicksuggest.sponsored": false,
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
userBranch: {
"suggest.quicksuggest.sponsored": false,
},
},
});
});
// Migrating from:
// * Version 1 prefs
// * Offline
// * Non-sponsored suggestions: user turned off
// * Sponsored suggestions: user turned off
// * Data collection: user left off
//
// Expected:
// * Non-sponsored suggestions: off
// * Sponsored suggestions: off
// * Data collection: off
add_task(async function () {
await doMigrateTest({
testOverrides: TEST_OVERRIDES,
initialUserBranch: {
"quicksuggest.migrationVersion": 1,
"quicksuggest.scenario": "offline",
"suggest.quicksuggest.nonsponsored": false,
"suggest.quicksuggest.sponsored": false,
},
expectedPrefs: {
defaultBranch: DEFAULT_PREFS,
userBranch: {
"suggest.quicksuggest.nonsponsored": false,
"suggest.quicksuggest.sponsored": false,
},
},
});
});