forked from ampproject/amphtml
-
Notifications
You must be signed in to change notification settings - Fork 1
/
analytics-root.js
448 lines (399 loc) · 11.6 KB
/
analytics-root.js
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
/**
* Copyright 2017 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
VisibilityManagerForDoc,
VisibilityManagerForEmbed,
} from './visibility-manager';
import {
closestBySelector,
matches,
scopedQuerySelector,
} from '../../../src/dom';
import {dev, user} from '../../../src/log';
import {getMode} from '../../../src/mode';
import {layoutRectLtwh} from '../../../src/layout-rect';
import {map} from '../../../src/utils/object';
import {
viewerForDoc,
viewportForDoc,
} from '../../../src/services';
import {whenContentIniLoad} from '../../../src/friendly-iframe-embed';
const TAG = 'amp-analytics';
/**
* An analytics root. Analytics can be scoped to either ampdoc, embed or
* an arbitrary AMP element.
*
* TODO(dvoytenko): consider moving this concept into core as `AmpRoot`
* interface that will be implemented by `AmpDoc` and `FriendlyIframeEmbed`.
*
* @implements {../../../src/service.Disposable}
* @abstract
*/
export class AnalyticsRoot {
/**
* @param {!../../../src/service/ampdoc-impl.AmpDoc} ampdoc
* @param {?AnalyticsRoot} parent
*/
constructor(ampdoc, parent) {
/** @const */
this.ampdoc = ampdoc;
/** @const */
this.parent = parent;
/** @const */
this.trackers_ = map();
/** @private {?./visibility-manager.VisibilityManager} */
this.visibilityManager_ = null;
}
/** @override */
dispose() {
for (const k in this.trackers_) {
this.trackers_[k].dispose();
delete this.trackers_[k];
}
if (this.visibilityManager_) {
this.visibilityManager_.dispose();
}
}
/**
* Returns the type of the tracker.
* @return {string}
* @abstract
*/
getType() {}
/**
* The root node the analytics is scoped to.
*
* @return {!Document|!ShadowRoot|!Element}
* @abstract
*/
getRoot() {}
/**
* The viewer of analytics root
* @return {!../../../src/service/viewer-impl.Viewer}
*/
getViewer() {
return viewerForDoc(this.ampdoc);
}
/**
* The root element within the analytics root.
*
* @return {!Element}
*/
getRootElement() {
const root = this.getRoot();
return dev().assertElement(root.documentElement || root.body || root);
}
/**
* The host element of the analytics root.
*
* @return {?Element}
* @abstract
*/
getHostElement() {}
/**
* The signals for the root.
*
* @return {!../../../src/utils/signals.Signals}
* @abstract
*/
signals() {}
/**
* Whether this analytics root contains the specified node.
*
* @param {!Node} node
* @return {boolean}
*/
contains(node) {
return this.getRoot().contains(node);
}
/**
* Returns the element with the specified ID in the scope of this root.
*
* @param {string} unusedId
* @return {?Element}
* @abstract
*/
getElementById(unusedId) {}
/**
* Returns the tracker for the specified name and type. If the tracker
* has not been requested before, it will be created.
*
* @param {string} name
* @param {function(new:./events.EventTracker, !AnalyticsRoot)} klass
* @return {!./events.EventTracker}
*/
getTracker(name, klass) {
let tracker = this.trackers_[name];
if (!tracker) {
tracker = new klass(this);
this.trackers_[name] = tracker;
}
return tracker;
}
/**
* Returns the tracker for the specified name or `null`.
* @param {string} name
* @return {?./events.EventTracker}
*/
getTrackerOptional(name) {
return this.trackers_[name] || null;
}
/**
* Searches the element that matches the selector within the scope of the
* analytics root in relationship to the specified context node.
*
* @param {!Element} context
* @param {string} selector DOM query selector.
* @param {?string=} selectionMethod Allowed values are `null`,
* `'closest'` and `'scope'`.
* @return {?Element} Element corresponding to the selector if found.
*/
getElement(context, selector, selectionMethod = null) {
// Special case selectors. The selection method is irrelavant.
if (selector == ':root') {
return this.getRootElement();
}
if (selector == ':host') {
return this.getHostElement();
}
// Query search based on the selection method.
let found;
if (selectionMethod == 'scope') {
found = scopedQuerySelector(context, selector);
} else if (selectionMethod == 'closest') {
found = closestBySelector(context, selector);
} else {
found = this.getRoot().querySelector(selector);
}
// DOM search can "look" outside the boundaries of the root, thus make
// sure the result is contained.
if (found && this.contains(found)) {
return found;
}
return null;
}
/**
* Searches the AMP element that matches the selector within the scope of the
* analytics root in relationship to the specified context node.
*
* @param {!Element} context
* @param {string} selector DOM query selector.
* @param {?string=} selectionMethod Allowed values are `null`,
* `'closest'` and `'scope'`.
* @return {?AmpElement} AMP element corresponding to the selector if found.
*/
getAmpElement(context, selector, selectionMethod) {
const element = this.getElement(context, selector, selectionMethod);
if (element) {
user().assert(
element.classList.contains('i-amphtml-element'),
'Element "%s" is required to be an AMP element', selector);
}
return element;
}
/**
* Creates listener-filter for DOM events to check against the specified
* selector. If the node (or its ancestors) match the selector the listener
* will be called.
*
* @param {function(!Element, !Event)} listener The first argument is the
* matched target node and the second is the original event.
* @param {!Element} context
* @param {string} selector DOM query selector.
* @param {?string=} selectionMethod Allowed values are `null`,
* `'closest'` and `'scope'`.
* @return {function(!Event)}
*/
createSelectiveListener(
listener, context, selector, selectionMethod = null) {
return event => {
if (selector == ':host') {
// `:host` is not reachable via selective listener b/c event path
// cannot be retargeted across the boundary of the embed.
return;
}
// Navigate up the DOM tree to find the actual target.
const rootElement = this.getRootElement();
const isSelectAny = (selector == '*');
const isSelectRoot = (selector == ':root');
let target = event.target;
while (target) {
// Target must be contained by this root.
if (!this.contains(target)) {
break;
}
// `:scope` context must contain the target.
if (selectionMethod == 'scope' &&
!isSelectRoot && !context.contains(target)) {
break;
}
// `closest()` target must contain the conext.
if (selectionMethod == 'closest' && !target.contains(context)) {
// However, the search must continue!
target = target.parentElement;
continue;
}
// Check if the target matches the selector.
if (isSelectAny ||
isSelectRoot && target == rootElement ||
matchesNoInline(target, selector)) {
listener(target, event);
// Don't fire the event multiple times even if the more than one
// ancestor matches the selector.
break;
}
target = target.parentElement;
}
};
}
/**
* Returns the promise that will be resolved as soon as the elements within
* the root have been loaded inside the first viewport of the root.
* @return {!Promise}
* @abstract
*/
whenIniLoaded() {}
/**
* Returns the visibility root corresponding to this analytics root (ampdoc
* or embed). The visibility root is created lazily as needed and takes
* care of all visibility tracking functions.
* @return {!./visibility-manager.VisibilityManager}
*/
getVisibilityManager() {
if (!this.visibilityManager_) {
this.visibilityManager_ = this.createVisibilityManager();
}
return this.visibilityManager_;
}
/**
* @return {!./visibility-manager.VisibilityManager}
* @protected
* @abstract
*/
createVisibilityManager() {}
}
/**
* The implementation of the analytics root for an ampdoc.
*/
export class AmpdocAnalyticsRoot extends AnalyticsRoot {
/**
* @param {!../../../src/service/ampdoc-impl.AmpDoc} ampdoc
*/
constructor(ampdoc) {
super(ampdoc, /* parent */ null);
}
/** @override */
getType() {
return 'ampdoc';
}
/** @override */
getRoot() {
return this.ampdoc.getRootNode();
}
/** @override */
getHostElement() {
// ampdoc is always the root of everything - no host.
return null;
}
/** @override */
signals() {
return this.ampdoc.signals();
}
/** @override */
getElementById(id) {
return this.ampdoc.getElementById(id);
}
/** @override */
whenIniLoaded() {
const viewport = viewportForDoc(this.ampdoc);
let rect;
if (getMode(this.ampdoc.win).runtime == 'inabox') {
// TODO(dvoytenko, #7971): This is currently addresses incorrect position
// calculations in a in-a-box viewport where all elements are offset
// to the bottom of the embed. The current approach, even if fixed, still
// creates a significant probability of risk condition.
// Once address, we can simply switch to the 0/0 approach in the `else`
// clause.
rect = viewport.getLayoutRect(this.getRootElement());
} else {
const size = viewport.getSize();
rect = layoutRectLtwh(0, 0, size.width, size.height);
}
return whenContentIniLoad(this.ampdoc, this.ampdoc.win, rect);
}
/** @override */
createVisibilityManager() {
return new VisibilityManagerForDoc(this.ampdoc);
}
}
/**
* The implementation of the analytics root for FIE.
*/
export class EmbedAnalyticsRoot extends AnalyticsRoot {
/**
* @param {!../../../src/service/ampdoc-impl.AmpDoc} ampdoc
* @param {!../../../src/friendly-iframe-embed.FriendlyIframeEmbed} embed
* @param {?AnalyticsRoot} parent
*/
constructor(ampdoc, embed, parent) {
super(ampdoc, parent);
/** @const */
this.embed = embed;
}
/** @override */
getType() {
return 'embed';
}
/** @override */
getRoot() {
return this.embed.win.document;
}
/** @override */
getHostElement() {
return this.embed.iframe;
}
/** @override */
signals() {
return this.embed.signals();
}
/** @override */
getElementById(id) {
return this.embed.win.document.getElementById(id);
}
/** @override */
whenIniLoaded() {
return this.embed.whenIniLoaded();
}
/** @override */
createVisibilityManager() {
return new VisibilityManagerForEmbed(
this.parent.getVisibilityManager(),
this.embed);
}
}
/**
* @param {!Element} el
* @param {!string} selector
* @return {boolean}
*/
function matchesNoInline(el, selector) {
try {
return matches(el, selector);
} catch (e) {
user().error(TAG, 'Bad query selector.', selector, e);
return false;
}
}