-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
instrumentation.js
178 lines (165 loc) · 5.01 KB
/
instrumentation.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
/**
* Copyright 2015 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 {
AmpStoryEventTracker,
AnalyticsEvent,
AnalyticsEventType,
CustomEventTracker,
getTrackerKeyName,
} from './events';
import {AmpdocAnalyticsRoot, EmbedAnalyticsRoot} from './analytics-root';
import {AnalyticsGroup} from './analytics-group';
import {Services} from '../../../src/services';
import {dict} from '../../../src/utils/object';
import {getFriendlyIframeEmbedOptional} from '../../../src/iframe-helper';
import {
getParentWindowFrameElement,
getServiceForDoc,
getServicePromiseForDoc,
registerServiceBuilderForDoc,
} from '../../../src/service';
const PROP = '__AMP_AN_ROOT';
/**
* @implements {../../../src/service.Disposable}
* @package
* @visibleForTesting
*/
export class InstrumentationService {
/**
* @param {!../../../src/service/ampdoc-impl.AmpDoc} ampdoc
*/
constructor(ampdoc) {
/** @const */
this.ampdoc = ampdoc;
/** @const */
this.root_ = this.findRoot_(ampdoc.getRootNode());
}
/** @override */
dispose() {
this.root_.dispose();
}
/**
* @param {!Node} context
* @return {!./analytics-root.AnalyticsRoot}
*/
getAnalyticsRoot(context) {
return this.findRoot_(context);
}
/**
* @param {!Element} analyticsElement
* @return {!AnalyticsGroup}
*/
createAnalyticsGroup(analyticsElement) {
const root = this.findRoot_(analyticsElement);
return new AnalyticsGroup(root, analyticsElement);
}
/**
* @param {string} trackerName
* @private
*/
getTrackerClass_(trackerName) {
switch (trackerName) {
case AnalyticsEventType.STORY:
return AmpStoryEventTracker;
default:
return CustomEventTracker;
}
}
/**
* Triggers the analytics event with the specified type.
*
* @param {!Element} target
* @param {string} eventType
* @param {!JsonObject} vars A map of vars and their values.
* @param {boolean} enableDataVars A boolean to indicate if data-vars-*
* attribute value from target element should be included.
*/
triggerEventForTarget(
target,
eventType,
vars = dict(),
enableDataVars = true
) {
const event = new AnalyticsEvent(target, eventType, vars, enableDataVars);
const root = this.findRoot_(target);
const trackerName = getTrackerKeyName(eventType);
const tracker = /** @type {!CustomEventTracker|!AmpStoryEventTracker} */ (root.getTracker(
trackerName,
this.getTrackerClass_(trackerName)
));
tracker.trigger(event);
}
/**
* @param {!Node} context
* @return {!./analytics-root.AnalyticsRoot}
*/
findRoot_(context) {
// TODO(#22733): cleanup when ampdoc-fie is launched. Just use
// `ampdoc.getParent()`.
const ampdoc = Services.ampdoc(context);
const frame = getParentWindowFrameElement(context);
const embed = frame && getFriendlyIframeEmbedOptional(frame);
if (ampdoc == this.ampdoc && !embed && this.root_) {
// Main root already exists.
return this.root_;
}
return this.getOrCreateRoot_(embed || ampdoc, () => {
if (embed) {
return new EmbedAnalyticsRoot(ampdoc, embed);
}
return new AmpdocAnalyticsRoot(ampdoc);
});
}
/**
* @param {!Object} holder
* @param {function():!./analytics-root.AnalyticsRoot} factory
* @return {!./analytics-root.AnalyticsRoot}
*/
getOrCreateRoot_(holder, factory) {
let root = /** @type {?./analytics-root.AnalyticsRoot} */ (holder[PROP]);
if (!root) {
root = factory();
holder[PROP] = root;
}
return root;
}
}
/**
* It's important to resolve instrumentation asynchronously in elements that
* depends on it in multi-doc scope. Otherwise an element life-cycle could
* resolve way before we have the service available.
*
* @param {!Element|!../../../src/service/ampdoc-impl.AmpDoc} elementOrAmpDoc
* @return {!Promise<InstrumentationService>}
*/
export function instrumentationServicePromiseForDoc(elementOrAmpDoc) {
return /** @type {!Promise<InstrumentationService>} */ (getServicePromiseForDoc(
elementOrAmpDoc,
'amp-analytics-instrumentation'
));
}
/**
* @param {!Element|!../../../src/service/ampdoc-impl.AmpDoc} elementOrAmpDoc
* @return {!InstrumentationService}
*/
export function instrumentationServiceForDocForTesting(elementOrAmpDoc) {
registerServiceBuilderForDoc(
elementOrAmpDoc,
'amp-analytics-instrumentation',
InstrumentationService
);
return getServiceForDoc(elementOrAmpDoc, 'amp-analytics-instrumentation');
}