mozilla-central/browser/components/newtab/test/browser/browser_multistage_spotlight_telemetry.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

"use strict";
const { Spotlight } = ChromeUtils.importESModule(
);
const { PanelTestProvider } = ChromeUtils.importESModule(
);
const { AboutWelcomeTelemetry } = ChromeUtils.importESModule(
);
async function waitForClick(selector, win) {
await TestUtils.waitForCondition(() => win.document.querySelector(selector));
win.document.querySelector(selector).click();
}
function waitForDialog(callback = win => win.close()) {
return BrowserTestUtils.promiseAlertDialog(
null,
{ callback, isSubDialog: true }
);
}
function showAndWaitForDialog(dialogOptions, callback) {
const promise = waitForDialog(callback);
Spotlight.showSpotlightDialog(
dialogOptions.browser,
dialogOptions.message,
dialogOptions.dispatchStub
);
return promise;
}
add_task(async function send_spotlight_as_page_in_telemetry() {
let message = (await PanelTestProvider.getMessages()).find(
m => m.id === "MULTISTAGE_SPOTLIGHT_MESSAGE"
);
let dispatchStub = sinon.stub();
let browser = BrowserWindowTracker.getTopWindow().gBrowser.selectedBrowser;
let sandbox = sinon.createSandbox();
await showAndWaitForDialog({ message, browser, dispatchStub }, async win => {
let stub = sandbox.stub(win, "AWSendEventTelemetry");
await waitForClick("button.secondary", win);
Assert.equal(
stub.lastCall.args[0].event_context.page,
"spotlight",
"The value of event context page should be set to 'spotlight' in event telemetry"
);
win.close();
});
sandbox.restore();
});
add_task(async function send_dismiss_event_telemetry() {
// Have to turn on AS telemetry for anything to be recorded.
await SpecialPowers.pushPrefEnv({
set: [["browser.newtabpage.activity-stream.telemetry", true]],
});
registerCleanupFunction(async () => {
await SpecialPowers.popPrefEnv();
});
// Let's collect all "messaging-system" pings submitted in this test.
let pingContents = [];
let onSubmit = () => {
pingContents.push({
messageId: Glean.messagingSystem.messageId.testGetValue(),
event: Glean.messagingSystem.event.testGetValue(),
});
GleanPings.messagingSystem.testBeforeNextSubmit(onSubmit);
};
GleanPings.messagingSystem.testBeforeNextSubmit(onSubmit);
const messageId = "MULTISTAGE_SPOTLIGHT_MESSAGE";
let message = (await PanelTestProvider.getMessages()).find(
m => m.id === messageId
);
let browser = BrowserWindowTracker.getTopWindow().gBrowser.selectedBrowser;
let sandbox = sinon.createSandbox();
let spy = sandbox.spy(AboutWelcomeTelemetry.prototype, "sendTelemetry");
// send without a dispatch function so that default is used
await showAndWaitForDialog({ message, browser }, async win => {
await waitForClick("button.dismiss-button", win);
await win.close();
});
Assert.equal(
spy.lastCall.args[0].message_id,
messageId,
"A dismiss event is called with the correct message id"
);
Assert.equal(
spy.lastCall.args[0].event,
"DISMISS",
"A dismiss event is called with a top level event field with value 'DISMISS'"
);
Assert.greater(
pingContents.length,
0,
"Glean 'messaging-system' pings were submitted."
);
Assert.ok(
pingContents.some(ping => {
return ping.messageId === messageId && ping.event === "DISMISS";
}),
"A Glean 'messaging-system' ping was sent for the correct message+event."
);
// Tidy up by removing the self-referential test callback.
GleanPings.messagingSystem.testBeforeNextSubmit(() => {});
sandbox.restore();
});
add_task(
async function do_not_send_impression_telemetry_from_default_dispatch() {
// Don't send impression telemetry from the Spotlight default dispatch function
let message = (await PanelTestProvider.getMessages()).find(
m => m.id === "MULTISTAGE_SPOTLIGHT_MESSAGE"
);
let browser = BrowserWindowTracker.getTopWindow().gBrowser.selectedBrowser;
let sandbox = sinon.createSandbox();
let stub = sandbox.stub(AboutWelcomeTelemetry.prototype, "sendTelemetry");
// send without a dispatch function so that default is used
await showAndWaitForDialog({ message, browser });
Assert.equal(
stub.calledOn(),
false,
"No extra impression event was sent for multistage Spotlight"
);
sandbox.restore();
}
);