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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
import { RemotePageChild } from "resource://gre/actors/RemotePageChild.sys.mjs";
import { ShoppingProduct } from "chrome://global/content/shopping/ShoppingProduct.mjs";
let lazy = {};
let gAllActors = new Set();
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"optedIn",
"browser.shopping.experience2023.optedIn",
null,
function optedInStateChanged() {
for (let actor of gAllActors) {
actor.optedInStateChanged();
}
}
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"adsEnabled",
"browser.shopping.experience2023.ads.enabled",
true
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"adsEnabledByUser",
"browser.shopping.experience2023.ads.userEnabled",
true,
function adsEnabledByUserChanged() {
for (let actor of gAllActors) {
actor.adsEnabledByUserChanged();
}
}
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"adsExposure",
"browser.shopping.experience2023.ads.exposure",
false
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"autoOpenEnabled",
"browser.shopping.experience2023.autoOpen.enabled",
true
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"autoOpenEnabledByUser",
"browser.shopping.experience2023.autoOpen.userEnabled",
true,
function autoOpenEnabledByUserChanged() {
for (let actor of gAllActors) {
actor.autoOpenEnabledByUserChanged();
}
}
);
export class ShoppingSidebarChild extends RemotePageChild {
constructor() {
super();
}
actorCreated() {
super.actorCreated();
gAllActors.add(this);
}
didDestroy() {
this._destroyed = true;
super.didDestroy?.();
gAllActors.delete(this);
this.#product?.off("analysis-progress", this.#onAnalysisProgress);
this.#product?.uninit();
}
#productURI = null;
#product = null;
receiveMessage(message) {
switch (message.name) {
case "ShoppingSidebar:UpdateProductURL":
let { url, isReload } = message.data;
let uri = url ? Services.io.newURI(url) : null;
// If we're going from null to null, bail out:
if (!this.#productURI && !uri) {
return null;
}
// If we haven't reloaded, check if the URIs represent the same product
// as sites might change the URI after they have loaded (Bug 1852099).
if (!isReload && this.isSameProduct(uri, this.#productURI)) {
return null;
}
this.#productURI = uri;
this.updateContent({ haveUpdatedURI: true });
break;
case "ShoppingSidebar:ShowKeepClosedMessage":
this.sendToContent("ShowKeepClosedMessage");
break;
case "ShoppingSidebar:HideKeepClosedMessage":
this.sendToContent("HideKeepClosedMessage");
break;
case "ShoppingSidebar:IsKeepClosedMessageShowing":
return !!this.document.querySelector("shopping-container")
?.wrappedJSObject.showingKeepClosedMessage;
}
return null;
}
isSameProduct(newURI, currentURI) {
if (!newURI || !currentURI) {
return false;
}
// Check if the URIs are equal:
if (currentURI.equalsExceptRef(newURI)) {
return true;
}
if (!this.#product) {
return false;
}
// If the current ShoppingProduct has product info set,
// check if the product ids are the same:
let currentProduct = this.#product.product;
if (currentProduct) {
let newProduct = ShoppingProduct.fromURL(URL.fromURI(newURI));
if (newProduct.id === currentProduct.id) {
return true;
}
}
return false;
}
handleEvent(event) {
let aid;
switch (event.type) {
case "ContentReady":
this.updateContent();
break;
case "PolledRequestMade":
this.updateContent({ isPolledRequest: true });
break;
case "ReportProductAvailable":
this.reportProductAvailable();
break;
case "AdClicked":
aid = event.detail.aid;
ShoppingProduct.sendAttributionEvent("click", aid);
Glean.shopping.surfaceAdsClicked.record();
break;
case "AdImpression":
aid = event.detail.aid;
ShoppingProduct.sendAttributionEvent("impression", aid);
Glean.shopping.surfaceAdsImpression.record();
break;
case "DisableShopping":
this.sendAsyncMessage("DisableShopping");
break;
}
}
// Exposed for testing. Assumes uri is a nsURI.
set productURI(uri) {
if (!(uri instanceof Ci.nsIURI)) {
throw new Error("productURI setter expects an nsIURI");
}
this.#productURI = uri;
}
// Exposed for testing. Assumes product is a ShoppingProduct.
set product(product) {
if (!(product instanceof ShoppingProduct)) {
throw new Error("product setter expects an instance of ShoppingProduct");
}
this.#product = product;
}
get canFetchAndShowData() {
return lazy.optedIn === 1;
}
get adsEnabled() {
return lazy.adsEnabled;
}
get adsEnabledByUser() {
return lazy.adsEnabledByUser;
}
get canFetchAndShowAd() {
return this.adsEnabled && this.adsEnabledByUser;
}
get autoOpenEnabled() {
return lazy.autoOpenEnabled;
}
get autoOpenEnabledByUser() {
return lazy.autoOpenEnabledByUser;
}
optedInStateChanged() {
// Force re-fetching things if needed by clearing the last product URI:
this.#productURI = null;
// Then let content know.
this.updateContent({ focusCloseButton: true });
}
adsEnabledByUserChanged() {
this.sendToContent("adsEnabledByUserChanged", {
adsEnabledByUser: this.adsEnabledByUser,
});
this.requestRecommendations(this.#productURI);
}
autoOpenEnabledByUserChanged() {
this.sendToContent("autoOpenEnabledByUserChanged", {
autoOpenEnabledByUser: this.autoOpenEnabledByUser,
});
}
getProductURI() {
return this.#productURI;
}
/**
* This callback is invoked whenever something changes that requires
* re-rendering content. The expected cases for this are:
* - page navigations (both to new products and away from a product once
* the sidebar has been created)
* - opt in state changes.
*
* @param {object?} options
* Optional parameter object.
* @param {bool} options.haveUpdatedURI = false
* Whether we've got an up-to-date URI already. If true, we avoid
* fetching the URI from the parent, and assume `this.#productURI`
* is current. Defaults to false.
* @param {bool} options.isPolledRequest = false
*
*/
async updateContent({
haveUpdatedURI = false,
isPolledRequest = false,
focusCloseButton = false,
} = {}) {
// updateContent is an async function, and when we're off making requests or doing
// other things asynchronously, the actor can be destroyed, the user
// might navigate to a new page, the user might disable the feature ... -
// all kinds of things can change. So we need to repeatedly check
// whether we can keep going with our async processes. This helper takes
// care of these checks.
let canContinue = (currentURI, checkURI = true) => {
if (this._destroyed || !this.canFetchAndShowData) {
return false;
}
if (!checkURI) {
return true;
}
return currentURI && currentURI == this.#productURI;
};
this.#product?.off("analysis-progress", this.#onAnalysisProgress);
this.#product?.uninit();
// We are called either because the URL has changed or because the opt-in
// state has changed. In both cases, we want to clear out content
// immediately, without waiting for potentially async operations like
// obtaining product information.
// Do not clear data however if an analysis was requested via a call-to-action.
if (!isPolledRequest) {
this.sendToContent("Update", {
adsEnabled: this.adsEnabled,
adsEnabledByUser: this.adsEnabledByUser,
autoOpenEnabled: this.autoOpenEnabled,
autoOpenEnabledByUser: this.autoOpenEnabledByUser,
showOnboarding: !this.canFetchAndShowData,
data: null,
recommendationData: null,
focusCloseButton,
});
}
if (this.canFetchAndShowData) {
if (!this.#productURI) {
// If we already have a URI and it's just null, bail immediately.
if (haveUpdatedURI) {
return;
}
let url = await this.sendQuery("GetProductURL");
// Bail out if we opted out in the meantime, or don't have a URI.
if (!canContinue(null, false)) {
return;
}
this.#productURI = Services.io.newURI(url);
}
let uri = this.#productURI;
this.#product = new ShoppingProduct(uri);
this.#product.on(
"analysis-progress",
this.#onAnalysisProgress.bind(this)
);
let data;
let isAnalysisInProgress;
try {
let analysisStatusResponse;
if (isPolledRequest) {
// Request a new analysis.
analysisStatusResponse = await this.#product.requestCreateAnalysis();
} else {
// Check if there is an analysis in progress.
analysisStatusResponse =
await this.#product.requestAnalysisCreationStatus();
}
let analysisStatus = analysisStatusResponse?.status;
isAnalysisInProgress =
analysisStatus &&
(analysisStatus == "pending" || analysisStatus == "in_progress");
if (isAnalysisInProgress) {
// Only clear the existing data if the update wasn't
// triggered by a Polled Request event as re-analysis should
// keep any stale data visible while processing.
if (!isPolledRequest) {
this.sendToContent("Update", {
isAnalysisInProgress,
});
}
analysisStatusResponse = await this.#product.pollForAnalysisCompleted(
{
pollInitialWait: analysisStatus == "in_progress" ? 0 : undefined,
}
);
analysisStatus = analysisStatusResponse?.status;
isAnalysisInProgress = false;
}
// Use the analysis status instead of re-requesting unnecessarily,
// or throw if the status from the last analysis was an error.
switch (analysisStatus) {
case "not_analyzable":
case "page_not_supported":
data = { page_not_supported: true };
break;
case "not_enough_reviews":
data = { not_enough_reviews: true };
break;
case "unprocessable":
case "stale":
throw new Error(analysisStatus, { cause: analysisStatus });
default:
// Status is "completed" or "not_found" (no analysis status),
// so we should request the analysis data.
}
if (!data) {
data = await this.#product.requestAnalysis();
if (!data) {
throw new Error("request failed");
}
}
} catch (err) {
console.error("Failed to fetch product analysis data", err);
data = { error: err };
}
// Check if we got nuked from orbit, or the product URI or opt in changed while we waited.
if (!canContinue(uri)) {
return;
}
this.sendToContent("Update", {
adsEnabled: this.adsEnabled,
adsEnabledByUser: this.adsEnabledByUser,
autoOpenEnabled: this.autoOpenEnabled,
autoOpenEnabledByUser: this.autoOpenEnabledByUser,
showOnboarding: false,
data,
productUrl: this.#productURI.spec,
isAnalysisInProgress,
});
if (!data || data.error) {
return;
}
if (!isPolledRequest && !data.grade) {
Glean.shopping.surfaceNoReviewReliabilityAvailable.record();
}
this.requestRecommendations(uri);
} else {
// Don't bother continuing if the user has opted out.
if (lazy.optedIn == 2) {
return;
}
let url = await this.sendQuery("GetProductURL");
// Similar to canContinue() above, check to see if things
// have changed while we were waiting. Bail out if the user
// opted in, or if the actor doesn't exist.
if (this._destroyed || this.canFetchAndShowData) {
return;
}
this.#productURI = Services.io.newURI(url);
// Send the productURI to content for Onboarding's dynamic text
this.sendToContent("Update", {
showOnboarding: true,
data: null,
productUrl: this.#productURI.spec,
});
}
}
/**
* Utility function to determine if we should request ads.
*/
canFetchAds(uri) {
return (
uri.equalsExceptRef(this.#productURI) &&
this.canFetchAndShowData &&
(lazy.adsExposure || this.canFetchAndShowAd)
);
}
/**
* Utility function to determine if we should display ads. This is different
* from fetching ads, because of ads exposure telemetry (bug 1858470).
*/
canShowAds(uri) {
return (
uri.equalsExceptRef(this.#productURI) &&
this.canFetchAndShowData &&
this.canFetchAndShowAd
);
}
/**
* Request recommended products for a given uri and send the recommendations
* to the content if recommendations are enabled.
*
* @param {nsIURI} uri The uri of the current product page
*/
async requestRecommendations(uri) {
if (!this.canFetchAds(uri)) {
return;
}
let recommendationData = await this.#product.requestRecommendations();
// Note: this needs to be separate from the inverse conditional check below
// because here we want to know if an ad exists for the product, regardless
// of whether ads are enabled, while for the surfaceNoAdsAvailable Glean
// probe, we want to know if ads would have been shown, but one wasn't
// available.
if (recommendationData.length) {
Glean.shopping.adsExposure.record();
}
// Check if the product URI or opt in changed while we waited.
if (!this.canShowAds(uri)) {
return;
}
if (!recommendationData.length) {
// We tried to fetch an ad, but didn't get one.
Glean.shopping.surfaceNoAdsAvailable.record();
} else {
ShoppingProduct.sendAttributionEvent(
"placement",
recommendationData[0].aid
);
Glean.shopping.surfaceAdsPlacement.record();
}
this.sendToContent("UpdateRecommendations", {
recommendationData,
});
}
sendToContent(eventName, detail) {
if (this._destroyed) {
return;
}
let win = this.contentWindow;
let evt = new win.CustomEvent(eventName, {
bubbles: true,
detail: Cu.cloneInto(detail, win),
});
win.document.dispatchEvent(evt);
}
async reportProductAvailable() {
await this.#product.sendReport();
}
#onAnalysisProgress(eventName, progress) {
this.sendToContent("UpdateAnalysisProgress", {
progress,
});
}
}
|