Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/* Any copyright is dedicated to the Public Domain.
// Test that TelemetryController sends close to shutdown don't lead
// to AsyncShutdown timeouts.
"use strict";
ChromeUtils.defineESModuleGetters(this, {
AppConstants: "resource://gre/modules/AppConstants.sys.mjs",
NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs",
WinTaskbarJumpList: "resource:///modules/WindowsJumpLists.sys.mjs",
});
const { NimbusTestUtils } = ChromeUtils.importESModule(
);
const { Policy, TelemetryReportingPolicy } = ChromeUtils.importESModule(
"resource://gre/modules/TelemetryReportingPolicy.sys.mjs"
);
NimbusTestUtils.init(this);
const TOU_ACCEPTED_VERSION_PREF = "termsofuse.acceptedVersion";
const TOU_CURRENT_VERSION_PREF = "termsofuse.currentVersion";
const TOU_MINIMUM_VERSION_PREF = "termsofuse.minimumVersion";
const TOU_ACCEPTED_DATE_PREF = "termsofuse.acceptedDate";
const TOU_BYPASS_NOTIFICATION_PREF = "termsofuse.bypassNotification";
// Some tests in this test file can't outside desktop Firefox because of
// features that aren't included in the build.
const skipIfNotBrowser = () => ({
skip_if: () => AppConstants.MOZ_BUILD_APP != "browser",
});
function fakeResetAcceptedPolicy() {
Services.prefs.clearUserPref(TOU_ACCEPTED_DATE_PREF);
Services.prefs.clearUserPref(TOU_ACCEPTED_VERSION_PREF);
}
// Fake dismissing a modal dialog.
function fakeInteractWithModal() {
Services.obs.notifyObservers(null, "termsofuse:interacted");
}
function unsetMinimumPolicyVersion() {
Services.prefs.clearUserPref(TOU_MINIMUM_VERSION_PREF);
}
function enrollInPreonboardingExperiment(version) {
return NimbusTestUtils.enrollWithFeatureConfig(
{
featureId: NimbusFeatures.preonboarding.featureId,
value: {
enabled: true,
currentVersion: version,
minimumVersion: version,
// Needed to opt into the modal flow, but not actually used in this test.
screens: [{ id: "test" }],
},
},
{ isRollout: false }
);
}
add_setup(async function test_setup() {
// Addon manager needs a profile directory
do_get_profile(true);
await loadAddonManager(
"xpcshell@tests.mozilla.org",
"XPCShell",
"1",
"1.9.2"
);
finishAddonManagerStartup();
fakeIntlReady();
// Make sure we don't generate unexpected pings due to pref changes.
await setEmptyPrefWatchlist();
// Don't bypass the legacy data reporting notifications in this test, we'll
// fake it.
Services.prefs.setBoolPref(
TelemetryUtils.Preferences.BypassNotification,
false
);
// Don't bypass the terms of use notification in this test, we'll
// fake it.
Services.prefs.setBoolPref(TOU_BYPASS_NOTIFICATION_PREF, false);
await Services.fog.testResetFOG();
TelemetryReportingPolicy.setup();
});
add_setup(skipIfNotBrowser(), async () => {
const { cleanup } = await NimbusTestUtils.setupTest();
registerCleanupFunction(cleanup);
});
add_task(skipIfNotBrowser(), async function test_feature_prefs() {
// Verify that feature values impact Gecko preferences at
// `sessionstore-windows-restored` time, but not afterward.
function assertPrefs(currentVersion, minimumVersion, firstRunURL) {
Assert.equal(
Services.prefs.getIntPref(TOU_CURRENT_VERSION_PREF),
currentVersion,
`${TOU_CURRENT_VERSION_PREF} is set`
);
Assert.equal(
Services.prefs.getIntPref(TOU_MINIMUM_VERSION_PREF),
minimumVersion,
`${TOU_MINIMUM_VERSION_PREF} is set`
);
Assert.equal(
Services.prefs.getCharPref(TelemetryUtils.Preferences.FirstRunURL),
firstRunURL,
"datareporting.policy.firstRunURL is set"
);
}
unsetMinimumPolicyVersion();
Services.prefs.clearUserPref(TOU_CURRENT_VERSION_PREF);
let doCleanup = await NimbusTestUtils.enrollWithFeatureConfig(
{
featureId: NimbusFeatures.preonboarding.featureId,
value: {
enabled: true,
currentVersion: 900,
minimumVersion: 899,
},
},
{ isRollout: false }
);
Assert.ok(NimbusFeatures.preonboarding.getVariable("enabled"));
// Before `sessionstore-windows-restored`, nothing is configured.
TelemetryReportingPolicy.reset();
Assert.ok(
!Services.prefs.prefHasUserValue(TOU_CURRENT_VERSION_PREF),
`${TOU_CURRENT_VERSION_PREF} is not set`
);
Assert.ok(
!Services.prefs.prefHasUserValue(TOU_MINIMUM_VERSION_PREF),
`${TOU_MINIMUM_VERSION_PREF} is not set`
);
Assert.ok(
!Services.prefs.prefHasUserValue(TelemetryUtils.Preferences.FirstRunURL),
"datareporting.policy.firstRunURL is not set"
);
// After `sessionstore-windows-restored`, values are adopted.
await Policy.fakeSessionRestoreNotification();
// Unenroll. Values remain, for consistency while Firefox is running.
await doCleanup();
Assert.ok(!NimbusFeatures.preonboarding.getVariable("enabled"));
// Updating the Nimbus feature does nothing (without `sessionstore-windows-restored`).
doCleanup = await NimbusTestUtils.enrollWithFeatureConfig(
{
featureId: NimbusFeatures.preonboarding.featureId,
value: {
enabled: true,
currentVersion: 901,
minimumVersion: 900,
},
},
{ isRollout: false }
);
Assert.ok(NimbusFeatures.preonboarding.getVariable("enabled"));
await doCleanup();
});
async function doOneModalFlow(version) {
let doCleanup = await enrollInPreonboardingExperiment(version);
let displayStub = sinon.stub(Policy, "showModal").returns(true);
// This will notify the user via a modal.
TelemetryReportingPolicy.reset();
await Policy.fakeSessionRestoreNotification();
Assert.equal(displayStub.callCount, 1, "showModal is invoked");
Assert.equal(
TelemetryReportingPolicy.userHasAcceptedTOU(),
false,
"Before interaction, the user should be reported as not having accepted"
);
let completed = false;
let p = TelemetryReportingPolicy.ensureUserIsNotified().then(
() => (completed = true)
);
Assert.equal(
completed,
false,
"The notification promise should not resolve before the user interacts"
);
fakeInteractWithModal();
await p;
Assert.equal(
completed,
true,
"The notification promise should resolve after user interacts"
);
Assert.equal(
TelemetryReportingPolicy.userHasAcceptedTOU(),
true,
"After interaction, the state should be accepted."
);
const metricVersion = await Glean.termsofuse.version.testGetValue();
Assert.equal(
metricVersion,
version,
`Glean.termsofuse.version is ${metricVersion} and matches expected ${version}`
);
const rawDate = await Glean.termsofuse.date.testGetValue();
// Compare only seconds
const metricSec = getDateInSeconds(rawDate);
const expectedSec = getDateInSeconds(
Services.prefs.getStringPref(TOU_ACCEPTED_DATE_PREF)
);
Assert.equal(
metricSec,
expectedSec,
`Glean.termsofuse.date (in seconds) is ${metricSec} and matches expected ${expectedSec}`
);
await doCleanup();
sinon.restore();
}
add_task(
skipIfNotBrowser(),
async function test_modal_flow_before_notification() {
// Test the `--first-startup` flow. Suppose the user has not been notified.
// Verify that when the Nimbus feature is configured, the modal branch is
// taken, that the ensure promise waits, and that the observer notification
// resolves the ensure promise.
fakeResetAcceptedPolicy();
Services.prefs.clearUserPref(TelemetryUtils.Preferences.FirstRun);
await doOneModalFlow(900);
// The user accepted the version from the experiment/rollout.
Assert.equal(Services.prefs.getIntPref(TOU_ACCEPTED_VERSION_PREF), 900);
}
);
add_task(
skipIfNotBrowser(),
async function test_modal_flow_after_notification() {
// If the legacy infobar was shown previously (existing users), we never
// show the TOU modal, even if they’re later enrolled in a Nimbus
// experiment.
fakeResetAcceptedPolicy();
Services.prefs.clearUserPref(TelemetryUtils.Preferences.FirstRun);
// Mark user as already notified via the legacy infobar
TelemetryReportingPolicy.reset();
TelemetryReportingPolicy.testInfobarShown();
Assert.ok(
TelemetryReportingPolicy.testIsUserNotifiedOfDataReportingPolicy(),
"User is notified after seeing the legacy infobar"
);
let doCleanup = await enrollInPreonboardingExperiment(900);
let modalStub = sinon.stub(Policy, "showModal").returns(true);
let p = Policy.delayedSetup();
Policy.fakeSessionRestoreNotification();
await p;
Assert.equal(
modalStub.callCount,
0,
"showModal should not be invoked after legacy infobar notification"
);
// Cleanup
Services.prefs.clearUserPref(TelemetryUtils.Preferences.AcceptedPolicyDate);
Services.prefs.clearUserPref(
TelemetryUtils.Preferences.AcceptedPolicyVersion
);
TelemetryReportingPolicy.reset();
await doCleanup();
sinon.restore();
}
);
add_task(
skipIfNotBrowser(),
async function test_default_modal_shows_when_not_enrolled_in_experiment() {
if (AppConstants.platform === "linux") {
info(
"Skipping test for Linux where preonboarding is disabled by default"
);
return;
}
let modalStub = sinon.stub(Policy, "showModal").returns(true);
fakeResetAcceptedPolicy();
TelemetryReportingPolicy.reset();
let p = Policy.delayedSetup();
Policy.fakeSessionRestoreNotification();
fakeInteractWithModal();
await p;
Assert.equal(
modalStub.callCount,
1,
"showModal is invoked once when not enrolled in an experiemnt"
);
sinon.restore();
fakeResetAcceptedPolicy();
}
);
add_task(skipIfNotBrowser(), async function test_modal_not_shown_on_linux() {
if (AppConstants.platform !== "linux") {
info("Skipping test on non-Linux platforms");
return;
}
let modalStub = sinon.stub(Policy, "showModal").returns(true);
fakeResetAcceptedPolicy();
TelemetryReportingPolicy.reset();
let p = Policy.delayedSetup();
Policy.fakeSessionRestoreNotification();
await p;
Assert.equal(
modalStub.callCount,
0,
"showModal is not invoked on Linux by default"
);
sinon.restore();
fakeResetAcceptedPolicy();
});
add_task(
skipIfNotBrowser(),
async function test_jumplist_blocking_on_modal_display_and_unblocking_after_interaction() {
if (AppConstants.platform !== "win") {
info("Skipping test for Windows only behavior");
return;
}
fakeResetAcceptedPolicy();
Services.prefs.clearUserPref(TelemetryUtils.Preferences.FirstRun);
let blockSpy = sinon.spy(WinTaskbarJumpList, "blockJumpList");
let unblockSpy = sinon.spy(WinTaskbarJumpList, "_unblockJumpList");
sinon.stub(Policy, "showModal").returns(true);
let doCleanup = await enrollInPreonboardingExperiment(900);
// This will notify the user via a modal.
TelemetryReportingPolicy.reset();
await Policy.fakeSessionRestoreNotification();
Assert.ok(
blockSpy.calledOnce,
"Jump list should be blocked when modal is presented."
);
let p = TelemetryReportingPolicy.ensureUserIsNotified;
fakeInteractWithModal();
await p;
Assert.greaterOrEqual(
unblockSpy.callCount,
blockSpy.callCount,
"Jump list should be unblocked after user interacts with modal"
);
await doCleanup();
sinon.restore();
}
);
add_task(
skipIfNotBrowser(),
async function test_startup_records_tou_telemetry_if_prefs_already_set() {
const timestamp = Date.now();
const version = 999;
Services.prefs.setStringPref(TOU_ACCEPTED_DATE_PREF, timestamp.toString());
Services.prefs.setIntPref(TOU_ACCEPTED_VERSION_PREF, version);
TelemetryReportingPolicy.reset();
const metricVersion = await Glean.termsofuse.version.testGetValue();
Assert.equal(
metricVersion,
version,
`Glean.termsofuse.version is ${metricVersion} and matches expected ${version}`
);
// Compare only seconds
const rawDate = await Glean.termsofuse.date.testGetValue();
const metricSec = getDateInSeconds(rawDate);
const expectedSec = getDateInSeconds(timestamp);
Assert.equal(
metricSec,
expectedSec,
`Glean.termsofuse.date (in seconds) is ${metricSec} and matches expected ${expectedSec}`
);
}
);