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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const currentTime = Date.now() / 1000;
const time25HrsAgo = currentTime - 25 * 60 * 60;
const time1HrAgo = currentTime - 1 * 60 * 60;
add_task(async function test_setup() {
await BrowserTestUtils.withNewTab(
{
url: "about:shoppingsidebar",
gBrowser,
},
async browser => {
await SpecialPowers.spawn(browser, [], async () => {
let childActor = content.windowGlobalChild.getExistingActor(
"AboutWelcomeShopping"
);
childActor.resetChildStates();
});
}
);
});
/**
* Test to check survey renders when show survey conditions are met
*/
add_task(async function test_showSurvey_Enabled() {
await SpecialPowers.pushPrefEnv({
set: [
["browser.shopping.experience2023.optedIn", 1],
["browser.shopping.experience2023.survey.enabled", true],
["browser.shopping.experience2023.survey.hasSeen", false],
["browser.shopping.experience2023.survey.pdpVisits", 5],
["browser.shopping.experience2023.survey.optedInTime", time25HrsAgo],
],
});
await BrowserTestUtils.withNewTab(
{
url: "about:shoppingsidebar",
gBrowser,
},
async browser => {
await SpecialPowers.spawn(
browser,
[MOCK_ANALYZED_PRODUCT_RESPONSE],
async mockData => {
const { TestUtils } = ChromeUtils.importESModule(
"resource://testing-common/TestUtils.sys.mjs"
);
let surveyPrefChanged = TestUtils.waitForPrefChange(
"browser.shopping.experience2023.survey.hasSeen"
);
let shoppingContainer =
content.document.querySelector(
"shopping-container"
).wrappedJSObject;
shoppingContainer.data = Cu.cloneInto(mockData, content);
// Manually send data update event, as it isn't set due to the lack of mock APIs.
// TODO: Support for the mocks will be added in Bug 1853474.
let mockObj = {
data: mockData,
productUrl: "https://example.com/product/1234",
};
let evt = new content.CustomEvent("Update", {
bubbles: true,
detail: Cu.cloneInto(mockObj, content),
});
content.document.dispatchEvent(evt);
await shoppingContainer.updateComplete;
await surveyPrefChanged;
let childActor = content.windowGlobalChild.getExistingActor(
"AboutWelcomeShopping"
);
ok(childActor.surveyEnabled, "Survey is Enabled");
let surveyScreen = await ContentTaskUtils.waitForCondition(
() =>
content.document.querySelector(
"shopping-container .screen.SHOPPING_MICROSURVEY_SCREEN_1"
),
"survey-screen"
);
ok(surveyScreen, "Survey screen is rendered");
ok(
childActor.showMicroSurvey,
"Show Survey targeting conditions met"
);
Assert.strictEqual(
content.document
.getElementById("steps")
.getAttribute("data-l10n-id"),
"shopping-onboarding-welcome-steps-indicator-label",
"Steps indicator has appropriate fluent ID"
);
ok(
!content.document.getElementById("multi-stage-message-root").hidden,
"Survey Message container is shown"
);
ok(
content.document.querySelector(".dismiss-button"),
"Dismiss button is shown"
);
let survey_seen_status = Services.prefs.getBoolPref(
"browser.shopping.experience2023.survey.hasSeen",
false
);
ok(survey_seen_status, "Survey pref state is updated");
childActor.resetChildStates();
}
);
}
);
await SpecialPowers.popPrefEnv();
});
/**
* Test to check survey is hidden when survey enabled pref is false
*/
add_task(async function test_showSurvey_Disabled() {
await SpecialPowers.pushPrefEnv({
set: [
["browser.shopping.experience2023.optedIn", 1],
["browser.shopping.experience2023.survey.enabled", false],
["browser.shopping.experience2023.survey.hasSeen", false],
["browser.shopping.experience2023.survey.pdpVisits", 5],
["browser.shopping.experience2023.survey.optedInTime", time25HrsAgo],
],
});
await BrowserTestUtils.withNewTab(
{
url: "about:shoppingsidebar",
gBrowser,
},
async browser => {
await SpecialPowers.spawn(
browser,
[MOCK_ANALYZED_PRODUCT_RESPONSE],
async mockData => {
let shoppingContainer =
content.document.querySelector(
"shopping-container"
).wrappedJSObject;
shoppingContainer.data = Cu.cloneInto(mockData, content);
// Manually send data update event, as it isn't set due to the lack of mock APIs.
// TODO: Support for the mocks will be added in Bug 1853474.
let mockObj = {
data: mockData,
productUrl: "https://example.com/product/1234",
};
let evt = new content.CustomEvent("Update", {
bubbles: true,
detail: Cu.cloneInto(mockObj, content),
});
content.document.dispatchEvent(evt);
await shoppingContainer.updateComplete;
let childActor = content.windowGlobalChild.getExistingActor(
"AboutWelcomeShopping"
);
ok(!childActor.surveyEnabled, "Survey is disabled");
let surveyScreen = content.document.querySelector(
"shopping-container .screen.SHOPPING_MICROSURVEY_SCREEN_1"
);
ok(!surveyScreen, "Survey screen is not rendered");
ok(
!childActor.showMicroSurvey,
"Show Survey targeting conditions are not met"
);
ok(
content.document.getElementById("multi-stage-message-root").hidden,
"Survey Message container is hidden"
);
childActor.resetChildStates();
}
);
}
);
await SpecialPowers.popPrefEnv();
});
/**
* Test to check survey display logic respects 24 hours after Opt-in rule
*/
add_task(async function test_24_hr_since_optin_rule() {
await SpecialPowers.pushPrefEnv({
set: [
["browser.shopping.experience2023.optedIn", 1],
["browser.shopping.experience2023.survey.enabled", true],
["browser.shopping.experience2023.survey.hasSeen", false],
["browser.shopping.experience2023.survey.pdpVisits", 5],
["browser.shopping.experience2023.survey.optedInTime", time1HrAgo],
],
});
await BrowserTestUtils.withNewTab(
{
url: "about:shoppingsidebar",
gBrowser,
},
async browser => {
await SpecialPowers.spawn(
browser,
[MOCK_ANALYZED_PRODUCT_RESPONSE],
async mockData => {
let shoppingContainer =
content.document.querySelector(
"shopping-container"
).wrappedJSObject;
shoppingContainer.data = Cu.cloneInto(mockData, content);
await shoppingContainer.updateComplete;
let childActor = content.windowGlobalChild.getExistingActor(
"AboutWelcomeShopping"
);
let surveyScreen = content.document.querySelector(
"shopping-container .screen.SHOPPING_MICROSURVEY_SCREEN_1"
);
ok(!surveyScreen, "Survey screen is not rendered");
ok(
!childActor.showMicroSurvey,
"Show Survey 24 hours after opt in conditions are not met"
);
ok(
content.document.getElementById("multi-stage-message-root").hidden,
"Survey Message container is hidden"
);
childActor.resetChildStates();
}
);
}
);
await SpecialPowers.popPrefEnv();
});
add_task(async function test_confirmation_screen() {
await SpecialPowers.pushPrefEnv({
set: [
["browser.shopping.experience2023.optedIn", 1],
["browser.shopping.experience2023.survey.enabled", true],
["browser.shopping.experience2023.survey.hasSeen", false],
["browser.shopping.experience2023.survey.pdpVisits", 5],
["browser.shopping.experience2023.survey.optedInTime", time25HrsAgo],
],
});
await BrowserTestUtils.withNewTab(
{
url: "about:shoppingsidebar",
gBrowser,
},
async browser => {
await SpecialPowers.spawn(
browser,
[MOCK_ANALYZED_PRODUCT_RESPONSE],
async mockData => {
async function clickVisibleElement(selector) {
await ContentTaskUtils.waitForCondition(
() => content.document.querySelector(selector),
`waiting for selector ${selector}`,
200, // interval
100 // maxTries
);
content.document.querySelector(selector).click();
}
let shoppingContainer =
content.document.querySelector(
"shopping-container"
).wrappedJSObject;
shoppingContainer.data = Cu.cloneInto(mockData, content);
// Manually send data update event, as it isn't set due to the lack of mock APIs.
// TODO: Support for the mocks will be added in Bug 1853474.
let mockObj = {
data: mockData,
productUrl: "https://example.com/product/1234",
};
let evt = new content.CustomEvent("Update", {
bubbles: true,
detail: Cu.cloneInto(mockObj, content),
});
content.document.dispatchEvent(evt);
await shoppingContainer.updateComplete;
let surveyScreen1 = await ContentTaskUtils.waitForCondition(
() =>
content.document.querySelector(
"shopping-container .screen.SHOPPING_MICROSURVEY_SCREEN_1"
),
"survey-screen"
);
ok(surveyScreen1, "Survey screen 1 is rendered");
clickVisibleElement("#radio-1");
clickVisibleElement("button.primary");
let surveyScreen2 = await ContentTaskUtils.waitForCondition(
() =>
content.document.querySelector(
"shopping-container .screen.SHOPPING_MICROSURVEY_SCREEN_2"
),
"survey-screen"
);
ok(surveyScreen2, "Survey screen 2 is rendered");
clickVisibleElement("#radio-1");
clickVisibleElement("button.primary");
let confirmationScreen = await ContentTaskUtils.waitForCondition(
() => content.document.querySelector("shopping-message-bar"),
"survey-screen"
);
ok(confirmationScreen, "Survey confirmation screen is rendered");
}
);
}
);
await SpecialPowers.popPrefEnv();
});
|
