Source code
Revision control
Copy as Markdown
Other Tools
Test Info: Errors
- This test failed 5 times in the preceding 30 days. quicksearch this test
- Manifest: toolkit/components/shopping/test/browser/browser.toml
/* Any copyright is dedicated to the Public Domain.
"use strict";
const { sinon } = ChromeUtils.importESModule(
);
function recommendedAdsEventListener(eventName, sidebar) {
return SpecialPowers.spawn(
sidebar.querySelector("browser"),
[eventName],
name => {
let shoppingContainer =
content.document.querySelector("shopping-container").wrappedJSObject;
let adEl = shoppingContainer.recommendedAdEl;
return ContentTaskUtils.waitForEvent(adEl, name, false, null, true).then(
() => null
);
}
);
}
function recommendedAdVisible(sidebar) {
return SpecialPowers.spawn(sidebar.querySelector("browser"), [], async () => {
await ContentTaskUtils.waitForCondition(() => {
let shoppingContainer =
content.document.querySelector("shopping-container").wrappedJSObject;
return (
shoppingContainer?.recommendedAdEl &&
ContentTaskUtils.isVisible(shoppingContainer?.recommendedAdEl)
);
});
});
}
add_setup(async function () {
await Services.fog.testFlushAllChildren();
Services.fog.testResetFOG();
await SpecialPowers.pushPrefEnv({
set: [
["toolkit.shopping.ohttpRelayURL", ""],
["toolkit.shopping.ohttpConfigURL", ""],
["browser.shopping.experience2023.ads.enabled", true],
["browser.shopping.experience2023.ads.userEnabled", true],
],
});
});
add_task(async function test_ad_attribution() {
await BrowserTestUtils.withNewTab(PRODUCT_TEST_URL, async browser => {
// Test that impression event is fired when opening sidebar
let sidebar = gBrowser.getPanel(browser).querySelector("shopping-sidebar");
Assert.ok(sidebar, "Sidebar should exist");
Assert.ok(
BrowserTestUtils.isVisible(sidebar),
"Sidebar should be visible."
);
let shoppingButton = document.getElementById("shopping-sidebar-button");
ok(
BrowserTestUtils.isVisible(shoppingButton),
"Shopping Button should be visible on a product page"
);
info("Waiting for sidebar to update.");
await promiseSidebarUpdated(sidebar, PRODUCT_TEST_URL);
await recommendedAdVisible(sidebar);
info("Verifying product info for initial product.");
await verifyProductInfo(sidebar, {
productURL: PRODUCT_TEST_URL,
adjustedRating: "4.1",
letterGrade: "B",
});
// Test placement was recorded by telemetry
info("Verifying ad placement event.");
await Services.fog.testFlushAllChildren();
var adsPlacementEvents = Glean.shopping.surfaceAdsPlacement.testGetValue();
Assert.equal(adsPlacementEvents.length, 1, "should have recorded an event");
Assert.equal(adsPlacementEvents[0].category, "shopping");
Assert.equal(adsPlacementEvents[0].name, "surface_ads_placement");
Assert.equal(adsPlacementEvents[0].extra.sponsored, "true");
let impressionEvent = recommendedAdsEventListener("AdImpression", sidebar);
info("Waiting for ad impression event.");
await impressionEvent;
Assert.ok(true, "Got ad impression event");
// Test the impression was recorded by telemetry
await Services.fog.testFlushAllChildren();
var adsImpressionEvents =
Glean.shopping.surfaceAdsImpression.testGetValue();
Assert.equal(
adsImpressionEvents.length,
1,
"should have recorded an event"
);
Assert.equal(adsImpressionEvents[0].category, "shopping");
Assert.equal(adsImpressionEvents[0].name, "surface_ads_impression");
Assert.equal(adsImpressionEvents[0].extra.sponsored, "true");
//
// Test that impression event is fired after switching to a tab that was
// opened in the background
let tab = BrowserTestUtils.addTab(gBrowser, PRODUCT_TEST_URL);
await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
let tabSidebar = gBrowser
.getPanel(tab.linkedBrowser)
.querySelector("shopping-sidebar");
Assert.ok(tabSidebar, "Sidebar should exist");
info("Waiting for sidebar to update.");
await promiseSidebarUpdated(tabSidebar, PRODUCT_TEST_URL);
await recommendedAdVisible(tabSidebar);
// Need to wait the impression timeout to confirm that no impression event
// has been dispatched
// setTimeout
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
await new Promise(r => setTimeout(r, 2000));
let hasImpressed = await SpecialPowers.spawn(
tabSidebar.querySelector("browser"),
[],
() => {
let shoppingContainer =
content.document.querySelector("shopping-container").wrappedJSObject;
let adEl = shoppingContainer.recommendedAdEl;
return adEl.hasImpressed;
}
);
Assert.ok(!hasImpressed, "We haven't seend the ad yet");
impressionEvent = recommendedAdsEventListener("AdImpression", tabSidebar);
await BrowserTestUtils.switchTab(gBrowser, tab);
await recommendedAdVisible(tabSidebar);
info("Waiting for ad impression event.");
await impressionEvent;
Assert.ok(true, "Got ad impression event");
//
// Test that the impression event is fired after opening foreground tab,
// switching away and the event is not fired, then switching back and the
// event does fire
gBrowser.removeTab(tab);
tab = BrowserTestUtils.addTab(gBrowser, PRODUCT_TEST_URL);
await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
tabSidebar = gBrowser
.getPanel(tab.linkedBrowser)
.querySelector("shopping-sidebar");
Assert.ok(tabSidebar, "Sidebar should exist");
info("Waiting for sidebar to update.");
await promiseSidebarUpdated(tabSidebar, PRODUCT_TEST_URL);
await recommendedAdVisible(tabSidebar);
// Switch to new sidebar tab
await BrowserTestUtils.switchTab(gBrowser, tab);
// switch back to original tab
await BrowserTestUtils.switchTab(
gBrowser,
gBrowser.getTabForBrowser(browser)
);
// Need to wait the impression timeout to confirm that no impression event
// has been dispatched
// setTimeout
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
await new Promise(r => setTimeout(r, 2000));
hasImpressed = await SpecialPowers.spawn(
tabSidebar.querySelector("browser"),
[],
() => {
let shoppingContainer =
content.document.querySelector("shopping-container").wrappedJSObject;
let adEl = shoppingContainer.recommendedAdEl;
return adEl.hasImpressed;
}
);
Assert.ok(!hasImpressed, "We haven't seend the ad yet");
impressionEvent = recommendedAdsEventListener("AdImpression", tabSidebar);
await BrowserTestUtils.switchTab(gBrowser, tab);
await recommendedAdVisible(tabSidebar);
info("Waiting for ad impression event.");
await impressionEvent;
Assert.ok(true, "Got ad impression event");
gBrowser.removeTab(tab);
//
// Test ad clicked event
let adOpenedTabPromise = BrowserTestUtils.waitForNewTab(
gBrowser,
PRODUCT_TEST_URL,
true
);
let clickedEvent = recommendedAdsEventListener("AdClicked", sidebar);
await SpecialPowers.spawn(sidebar.querySelector("browser"), [], () => {
let shoppingContainer =
content.document.querySelector("shopping-container").wrappedJSObject;
let adEl = shoppingContainer.recommendedAdEl;
adEl.linkEl.click();
});
let adTab = await adOpenedTabPromise;
info("Waiting for ad clicked event.");
await clickedEvent;
Assert.ok(true, "Got ad clicked event");
// Test the click was recorded by telemetry
await Services.fog.testFlushAllChildren();
var adsClickedEvents = Glean.shopping.surfaceAdsClicked.testGetValue();
Assert.equal(adsClickedEvents.length, 1, "should have recorded a click");
Assert.equal(adsClickedEvents[0].category, "shopping");
Assert.equal(adsClickedEvents[0].name, "surface_ads_clicked");
Assert.equal(adsClickedEvents[0].extra.sponsored, "true");
gBrowser.removeTab(adTab);
Services.fog.testResetFOG();
});
});
add_task(async function test_non_sponsored_attribution() {
await BrowserTestUtils.withNewTab(
PRODUCT_TEST_URL_NOT_SPONSORED,
async browser => {
let sidebar = gBrowser
.getPanel(browser)
.querySelector("shopping-sidebar");
info("Waiting for sidebar to update.");
await promiseSidebarUpdated(sidebar, PRODUCT_TEST_URL_NOT_SPONSORED);
await recommendedAdVisible(sidebar);
// Test placement was recorded by telemetry
info("Verifying recommendation placement event.");
await Services.fog.testFlushAllChildren();
var adsPlacementEvents =
Glean.shopping.surfaceAdsPlacement.testGetValue();
Assert.equal(
adsPlacementEvents.length,
1,
"should have recorded an event"
);
Assert.equal(adsPlacementEvents[0].category, "shopping");
Assert.equal(adsPlacementEvents[0].name, "surface_ads_placement");
Assert.equal(adsPlacementEvents[0].extra?.sponsored, "false");
let impressionEvent = recommendedAdsEventListener(
"AdImpression",
sidebar
);
info("Waiting for ad impression event.");
await impressionEvent;
Assert.ok(true, "Got ad impression event");
// Test the impression was recorded by telemetry
await Services.fog.testFlushAllChildren();
var adsImpressionEvents =
Glean.shopping.surfaceAdsImpression.testGetValue();
Assert.equal(
adsImpressionEvents.length,
1,
"should have recorded an event"
);
Assert.equal(adsImpressionEvents[0].category, "shopping");
Assert.equal(adsImpressionEvents[0].name, "surface_ads_impression");
Assert.equal(adsImpressionEvents[0].extra.sponsored, "false");
// Test ad clicked event
let adOpenedTabPromise = BrowserTestUtils.waitForNewTab(
gBrowser,
PRODUCT_TEST_URL_NOT_SPONSORED,
true
);
let clickedEvent = recommendedAdsEventListener("AdClicked", sidebar);
await SpecialPowers.spawn(sidebar.querySelector("browser"), [], () => {
let shoppingContainer =
content.document.querySelector("shopping-container").wrappedJSObject;
let adEl = shoppingContainer.recommendedAdEl;
adEl.linkEl.click();
});
let adTab = await adOpenedTabPromise;
info("Waiting for ad clicked event.");
await clickedEvent;
Assert.ok(true, "Got ad clicked event");
// Test the click was recorded by telemetry
await Services.fog.testFlushAllChildren();
var adsClickedEvents = Glean.shopping.surfaceAdsClicked.testGetValue();
Assert.equal(adsClickedEvents.length, 1, "should have recorded a click");
Assert.equal(adsClickedEvents[0].category, "shopping");
Assert.equal(adsClickedEvents[0].name, "surface_ads_clicked");
Assert.equal(adsClickedEvents[0].extra.sponsored, "false");
gBrowser.removeTab(adTab);
Services.fog.testResetFOG();
}
);
});