-
Notifications
You must be signed in to change notification settings - Fork 560
/
event-tracker.js
102 lines (85 loc) · 3.13 KB
/
event-tracker.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
/**
* Copyright 2016 Google Inc. 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 {delegate} from 'dom-utils';
import provide from '../provide';
import TrackerQueue from '../tracker-queue';
import {plugins, trackUsage} from '../usage';
import {assign, createFieldsObj, getAttributeFields, now} from '../utilities';
/**
* Class for the `eventTracker` analytics.js plugin.
* @implements {EventTrackerPublicInterface}
*/
class EventTracker {
/**
* Registers declarative event tracking.
* @param {!Tracker} tracker Passed internally by analytics.js
* @param {?EventTrackerOpts} opts Passed by the require command.
*/
constructor(tracker, opts) {
trackUsage(tracker, plugins.EVENT_TRACKER);
/** @type {EventTrackerOpts} */
const defaultOpts = {
events: ['click'],
fieldsObj: {},
attributePrefix: 'ga-',
// hitFilter: undefined,
};
this.opts = /** @type {EventTrackerOpts} */ (assign(defaultOpts, opts));
this.tracker = tracker;
// Binds methods.
this.handleEvents = this.handleEvents.bind(this);
const selector = '[' + this.opts.attributePrefix + 'on]';
this.delegates = {};
this.opts.events.forEach((event) => {
this.delegates[event] = delegate(document, event, selector,
this.handleEvents, {composed: true, useCapture: true});
});
this.queue = TrackerQueue.getOrCreate(tracker.get('trackingId'));
}
/**
* Handles all events on elements with event attributes.
* @param {Event} event The DOM click event.
* @param {Element} element The delegated DOM element target.
*/
handleEvents(event, element) {
this.queue.pushTask(({time}) => {
const prefix = this.opts.attributePrefix;
const events = element.getAttribute(prefix + 'on').split(/\s*,\s*/);
// Ensures the type matches one of the events specified on the element.
if (events.indexOf(event.type) < 0) return;
/** @type {FieldsObj} */
const defaultFields = {
transport: 'beacon',
queueTime: now() - time,
};
const attributeFields = getAttributeFields(element, prefix);
const userFields = assign({}, this.opts.fieldsObj, attributeFields);
const hitType = attributeFields.hitType || 'event';
this.tracker.send(hitType, createFieldsObj(defaultFields,
userFields, this.tracker, this.opts.hitFilter, element, event));
});
}
/**
* Removes all event listeners and instance properties.
*/
remove() {
this.queue.destroy();
Object.keys(this.delegates).forEach((key) => {
this.delegates[key].destroy();
});
}
}
provide('eventTracker', EventTracker);