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
|
import API from '~/api';
import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
import InternalEvents from '~/tracking/internal_events';
import { LOAD_INTERNAL_EVENTS_SELECTOR } from '~/tracking/constants';
import * as utils from '~/tracking/utils';
import { Tracker } from '~/tracking/tracker';
jest.mock('~/api', () => ({
trackInternalEvent: jest.fn(),
}));
jest.mock('~/tracking/utils', () => ({
...jest.requireActual('~/tracking/utils'),
getInternalEventHandlers: jest.fn(),
}));
Tracker.enabled = jest.fn();
const event = 'TestEvent';
describe('InternalEvents', () => {
describe('trackEvent', () => {
it('trackEvent calls API.trackInternalEvent with correct arguments', () => {
InternalEvents.trackEvent(event);
expect(API.trackInternalEvent).toHaveBeenCalledTimes(1);
expect(API.trackInternalEvent).toHaveBeenCalledWith(event);
});
it('trackEvent calls trackBrowserSDK with correct arguments', () => {
jest.spyOn(InternalEvents, 'trackBrowserSDK').mockImplementation(() => {});
InternalEvents.trackEvent(event);
expect(InternalEvents.trackBrowserSDK).toHaveBeenCalledTimes(1);
expect(InternalEvents.trackBrowserSDK).toHaveBeenCalledWith(event);
});
});
describe('mixin', () => {
let wrapper;
const Component = {
template: `
<div>
<button data-testid="button" @click="handleButton1Click">Button</button>
</div>
`,
methods: {
handleButton1Click() {
this.trackEvent(event);
},
},
mixins: [InternalEvents.mixin()],
};
beforeEach(() => {
wrapper = shallowMountExtended(Component);
});
it('this.trackEvent function calls InternalEvent`s track function with an event', async () => {
const trackEventSpy = jest.spyOn(InternalEvents, 'trackEvent');
await wrapper.findByTestId('button').trigger('click');
expect(trackEventSpy).toHaveBeenCalledTimes(1);
expect(trackEventSpy).toHaveBeenCalledWith(event);
});
});
describe('bindInternalEventDocument', () => {
it('should not bind event handlers if tracker is not enabled', () => {
Tracker.enabled.mockReturnValue(false);
const result = InternalEvents.bindInternalEventDocument();
expect(result).toEqual([]);
expect(utils.getInternalEventHandlers).not.toHaveBeenCalled();
});
it('should not bind event handlers if already bound', () => {
Tracker.enabled.mockReturnValue(true);
document.internalEventsTrackingBound = true;
const result = InternalEvents.bindInternalEventDocument();
expect(result).toEqual([]);
expect(utils.getInternalEventHandlers).not.toHaveBeenCalled();
});
it('should bind event handlers when not bound yet', () => {
Tracker.enabled.mockReturnValue(true);
document.internalEventsTrackingBound = false;
const addEventListenerMock = jest.spyOn(document, 'addEventListener');
const result = InternalEvents.bindInternalEventDocument();
expect(addEventListenerMock).toHaveBeenCalledWith('click', expect.any(Function));
expect(result).toEqual({ name: 'click', func: expect.any(Function) });
});
});
describe('trackInternalLoadEvents', () => {
let querySelectorAllMock;
let mockElements;
const action = 'i_devops_action';
beforeEach(() => {
Tracker.enabled.mockReturnValue(true);
querySelectorAllMock = jest.fn();
document.querySelectorAll = querySelectorAllMock;
});
it('should return an empty array if Tracker is not enabled', () => {
Tracker.enabled.mockReturnValue(false);
const result = InternalEvents.trackInternalLoadEvents();
expect(result).toEqual([]);
});
describe('tracking', () => {
let trackEventSpy;
beforeEach(() => {
trackEventSpy = jest.spyOn(InternalEvents, 'trackEvent');
});
it('should track event if action exists', () => {
mockElements = [{ dataset: { eventTracking: action, eventTrackingLoad: true } }];
querySelectorAllMock.mockReturnValue(mockElements);
const result = InternalEvents.trackInternalLoadEvents();
expect(trackEventSpy).toHaveBeenCalledWith(action);
expect(trackEventSpy).toHaveBeenCalledTimes(1);
expect(querySelectorAllMock).toHaveBeenCalledWith(LOAD_INTERNAL_EVENTS_SELECTOR);
expect(result).toEqual(mockElements);
});
it('should not track event if action is not present', () => {
mockElements = [{ dataset: { eventTracking: undefined, eventTrackingLoad: true } }];
querySelectorAllMock.mockReturnValue(mockElements);
InternalEvents.trackInternalLoadEvents();
expect(trackEventSpy).toHaveBeenCalledTimes(0);
});
});
});
describe('initBrowserSDK', () => {
beforeEach(() => {
window.glClient = {
setDocumentTitle: jest.fn(),
page: jest.fn(),
};
window.gl = {
environment: 'testing',
key: 'value',
};
});
it('should not call setDocumentTitle or page methods when window.glClient is undefined', () => {
window.glClient = undefined;
InternalEvents.initBrowserSDK();
expect(window.glClient?.setDocumentTitle).toBeUndefined();
expect(window.glClient?.page).toBeUndefined();
});
it('should call setDocumentTitle and page methods on window.glClient when it is defined', () => {
InternalEvents.initBrowserSDK();
expect(window.glClient.setDocumentTitle).toHaveBeenCalledWith('GitLab');
expect(window.glClient.page).toHaveBeenCalledWith({
title: 'GitLab',
});
});
it('should call setDocumentTitle and page methods with default data when window.gl is undefined', () => {
window.gl = undefined;
InternalEvents.initBrowserSDK();
expect(window.glClient.setDocumentTitle).toHaveBeenCalledWith('GitLab');
expect(window.glClient.page).toHaveBeenCalledWith({
title: 'GitLab',
});
});
});
describe('trackBrowserSDK', () => {
beforeEach(() => {
window.glClient = {
track: jest.fn(),
};
});
it('should not call glClient.track if Tracker is not enabled', () => {
Tracker.enabled.mockReturnValue(false);
InternalEvents.trackBrowserSDK(event);
expect(window.glClient.track).not.toHaveBeenCalled();
});
it('should call glClient.track with correct arguments if Tracker is enabled', () => {
Tracker.enabled.mockReturnValue(true);
InternalEvents.trackBrowserSDK(event);
expect(window.glClient.track).toHaveBeenCalledTimes(1);
expect(window.glClient.track).toHaveBeenCalledWith(event);
});
});
});
|
