1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
"use strict";
const { ASRouter } = ChromeUtils.import(
"resource://activity-stream/lib/ASRouter.jsm"
);
const { AttributionCode } = ChromeUtils.importESModule(
"resource:///modules/AttributionCode.sys.mjs"
);
const { AddonRepository } = ChromeUtils.importESModule(
"resource://gre/modules/addons/AddonRepository.sys.mjs"
);
const TEST_ATTRIBUTION_DATA = {
source: "addons.mozilla.org",
medium: "referral",
campaign: "non-fx-button",
// with the sinon override, the id doesn't matter
content: "rta:whatever",
};
const TEST_ADDON_INFO = [
{
name: "Test Add-on",
sourceURI: { scheme: "https", spec: "https://test.xpi" },
icons: { 32: "test.png", 64: "test.png" },
type: "extension",
},
];
const TEST_UA_ATTRIBUTION_DATA = {
ua: "chrome",
};
const TEST_PROTON_CONTENT = [
{
id: "AW_STEP1",
content: {
title: "Step 1",
primary_button: {
label: "Next",
action: {
navigate: true,
},
},
has_noodles: true,
},
},
{
id: "AW_STEP2",
content: {
title: "Step 2",
primary_button: {
label: {
string_id: "onboarding-multistage-import-primary-button-label",
},
action: {
type: "SHOW_MIGRATION_WIZARD",
data: {},
},
},
has_noodles: true,
},
},
];
async function openRTAMOWithAttribution() {
const sandbox = sinon.createSandbox();
sandbox.stub(AddonRepository, "getAddonsByIDs").resolves(TEST_ADDON_INFO);
await AttributionCode.deleteFileAsync();
await ASRouter.forceAttribution(TEST_ATTRIBUTION_DATA);
AttributionCode._clearCache();
const data = await AttributionCode.getAttrDataAsync();
Assert.equal(
data.source,
"addons.mozilla.org",
"Attribution data should be set"
);
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
"about:welcome",
true
);
registerCleanupFunction(async () => {
BrowserTestUtils.removeTab(tab);
await ASRouter.forceAttribution("");
sandbox.restore();
});
return tab.linkedBrowser;
}
/**
* Setup and test RTAMO welcome UI
*/
async function test_screen_content(
browser,
experiment,
expectedSelectors = [],
unexpectedSelectors = []
) {
await ContentTask.spawn(
browser,
{ expectedSelectors, experiment, unexpectedSelectors },
async ({
expectedSelectors: expected,
experiment: experimentName,
unexpectedSelectors: unexpected,
}) => {
for (let selector of expected) {
await ContentTaskUtils.waitForCondition(
() => content.document.querySelector(selector),
`Should render ${selector} in ${experimentName}`
);
}
for (let selector of unexpected) {
ok(
!content.document.querySelector(selector),
`Should not render ${selector} in ${experimentName}`
);
}
}
);
}
add_task(async function test_rtamo_attribution() {
let browser = await openRTAMOWithAttribution();
await test_screen_content(
browser,
"RTAMO UI",
// Expected selectors:
[
"div.onboardingContainer",
"h2[data-l10n-id='mr1-return-to-amo-addon-title']",
"div.rtamo-icon",
"button.primary",
"button.secondary",
],
// Unexpected selectors:
[
"main.AW_STEP1",
"main.AW_STEP2",
"main.AW_STEP3",
"div.tiles-container.info",
]
);
});
async function openMultiStageWithUserAgentAttribution() {
const sandbox = sinon.createSandbox();
await ASRouter.forceAttribution(TEST_UA_ATTRIBUTION_DATA);
const TEST_PROTON_JSON = JSON.stringify(TEST_PROTON_CONTENT);
await setAboutWelcomePref(true);
await pushPrefs(["browser.aboutwelcome.screens", TEST_PROTON_JSON]);
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
"about:welcome",
true
);
registerCleanupFunction(async () => {
BrowserTestUtils.removeTab(tab);
await ASRouter.forceAttribution("");
sandbox.restore();
});
return tab.linkedBrowser;
}
async function onButtonClick(browser, elementId) {
await ContentTask.spawn(
browser,
{ elementId },
async ({ elementId: buttonId }) => {
await ContentTaskUtils.waitForCondition(
() => content.document.querySelector(buttonId),
buttonId
);
let button = content.document.querySelector(buttonId);
button.click();
}
);
}
add_task(async function test_ua_attribution() {
let browser = await openMultiStageWithUserAgentAttribution();
await test_screen_content(
browser,
"multistage step 1 with ua attribution",
// Expected selectors:
["div.onboardingContainer", "main.AW_STEP1", "button.primary"],
// Unexpected selectors:
["main.AW_STEP2"]
);
await onButtonClick(browser, "button.primary");
await test_screen_content(
browser,
"multistage step 2 with ua attribution",
// Expected selectors:
[
"div.onboardingContainer",
"main.AW_STEP2",
"button.primary[data-l10n-args*='Google Chrome']",
],
// Unexpected selectors:
["main.AW_STEP1"]
);
});
|
