Source code
Revision control
Copy as Markdown
Other Tools
Test Info: Warnings
- This test gets skipped with pattern: os == 'android'
- Manifest: toolkit/modules/tests/xpcshell/xpcshell.toml
"use strict";
const { FirstStartup } = ChromeUtils.importESModule(
"resource://gre/modules/FirstStartup.sys.mjs"
);
const { updateAppInfo } = ChromeUtils.importESModule(
);
const { sinon } = ChromeUtils.importESModule(
);
const PREF_CATEGORY_TASKS = "first-startup.category-tasks-enabled";
const CATEGORY_NAME = "first-startup-new-profile";
const CATEGORY_TASK_TOPIC = "first-startup-category-task-called";
add_setup(function test_setup() {
do_get_profile();
Services.fog.initializeFOG();
// Delete any categories that have been registered statically so that we're
// just running the one here under test.
Services.catMan.deleteCategory(CATEGORY_NAME);
});
/**
* Test that category tasks registered with the first-startup-new-profile
* category are invoked during FirstStartup initialization, and that they run
* after Normandy initialization completes. Verifies that the
* categoryTasksTime Glean metric is recorded.
*/
add_task(async function test_categoryTasks_called_after_normandy() {
if (!AppConstants.MOZ_NORMANDY) {
info("Skipping test - MOZ_NORMANDY not enabled");
return;
}
updateAppInfo();
Services.prefs.setBoolPref(PREF_CATEGORY_TASKS, true);
FirstStartup.resetForTesting();
let catManUpdated = TestUtils.topicObserved("xpcom-category-entry-added");
Services.catMan.addCategoryEntry(
CATEGORY_NAME,
TEST_MODULE,
"FirstStartupCategoryModule.firstStartupNewProfile",
false,
false
);
await catManUpdated;
const { Normandy } = ChromeUtils.importESModule(
"resource://normandy/Normandy.sys.mjs"
);
let sandbox = sinon.createSandbox();
let normandyInitComplete = false;
let originalInit = Normandy.init.bind(Normandy);
sandbox.stub(Normandy, "init").callsFake(function (...args) {
return originalInit(...args).finally(() => {
normandyInitComplete = true;
});
});
let categoryTaskCalled = false;
let categoryTaskPromise = TestUtils.topicObserved(CATEGORY_TASK_TOPIC).then(
([_subj, data]) => {
Assert.ok(
Normandy.init.calledOnce,
"Normandy.init should have been called"
);
Assert.ok(
normandyInitComplete,
"Normandy init should be complete before category task starts"
);
categoryTaskCalled = true;
return data;
}
);
let submissionPromise = new Promise(resolve => {
GleanPings.firstStartup.testBeforeNextSubmit(() => {
Assert.equal(FirstStartup.state, FirstStartup.SUCCESS);
Assert.ok(Glean.firstStartup.newProfile.testGetValue());
Assert.equal(
Glean.firstStartup.statusCode.testGetValue(),
FirstStartup.SUCCESS
);
Assert.greater(Glean.firstStartup.normandyInitTime.testGetValue(), 0);
Assert.greater(
Glean.firstStartup.categoryTasksTime.testGetValue(),
0,
"Category tasks time should be recorded"
);
resolve();
});
});
FirstStartup.init(true);
await submissionPromise;
Assert.equal(
await categoryTaskPromise,
"executed",
"Category task should have been called"
);
Assert.ok(categoryTaskCalled, "Category task was invoked");
sandbox.restore();
Services.catMan.deleteCategoryEntry(CATEGORY_NAME, TEST_MODULE, false);
Services.prefs.clearUserPref(PREF_CATEGORY_TASKS);
});
/**
* Test that category tasks are not invoked when the category tasks pref is
* disabled, even when tasks are registered with the category.
*/
add_task(async function test_categoryTasks_disabled_by_pref() {
if (!AppConstants.MOZ_NORMANDY) {
info("Skipping test - MOZ_NORMANDY not enabled");
return;
}
updateAppInfo();
Services.prefs.setBoolPref(PREF_CATEGORY_TASKS, false);
FirstStartup.resetForTesting();
let catManUpdated = TestUtils.topicObserved("xpcom-category-entry-added");
Services.catMan.addCategoryEntry(
CATEGORY_NAME,
TEST_MODULE,
"FirstStartupCategoryModule.firstStartupNewProfile",
false,
false
);
await catManUpdated;
let categoryTaskCalled = false;
Services.obs.addObserver(() => {
categoryTaskCalled = true;
}, CATEGORY_TASK_TOPIC);
let submissionPromise = new Promise(resolve => {
GleanPings.firstStartup.testBeforeNextSubmit(() => {
resolve();
});
});
FirstStartup.init(true);
await submissionPromise;
Assert.ok(
!categoryTaskCalled,
"Category task should not be called when pref is false"
);
Services.catMan.deleteCategoryEntry(CATEGORY_NAME, TEST_MODULE, false);
Services.prefs.clearUserPref(PREF_CATEGORY_TASKS);
});