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
|
import { mount } from '@vue/test-utils';
import { nextTick } from 'vue';
import {
SUPER_SIDEBAR_PEEK_OPEN_DELAY,
SUPER_SIDEBAR_PEEK_CLOSE_DELAY,
JS_TOGGLE_EXPAND_CLASS,
SUPER_SIDEBAR_PEEK_STATE_CLOSED as STATE_CLOSED,
SUPER_SIDEBAR_PEEK_STATE_WILL_OPEN as STATE_WILL_OPEN,
SUPER_SIDEBAR_PEEK_STATE_OPEN as STATE_OPEN,
SUPER_SIDEBAR_PEEK_STATE_WILL_CLOSE as STATE_WILL_CLOSE,
} from '~/super_sidebar/constants';
import SidebarHoverPeek from '~/super_sidebar/components/sidebar_hover_peek_behavior.vue';
import { mockTracking, unmockTracking } from 'helpers/tracking_helper';
import { moveMouse, mouseEnter, mouseLeave, moveMouseOutOfDocument } from '../mocks';
// This is measured at runtime in the browser, but statically defined here
// since Jest does not do layout/styling.
const X_SIDEBAR_EDGE = 10;
jest.mock('~/lib/utils/css_utils', () => ({
getCssClassDimensions: () => ({ width: X_SIDEBAR_EDGE }),
}));
describe('SidebarHoverPeek component', () => {
let wrapper;
let toggle;
let trackingSpy = null;
const createComponent = (props = { isMouseOverSidebar: false }) => {
wrapper = mount(SidebarHoverPeek, {
propsData: props,
});
return nextTick();
};
const lastNChangeEvents = (n = 1) => wrapper.emitted('change').slice(-n).flat();
beforeEach(() => {
toggle = document.createElement('button');
toggle.classList.add(JS_TOGGLE_EXPAND_CLASS);
document.body.appendChild(toggle);
trackingSpy = mockTracking(undefined, undefined, jest.spyOn);
});
afterEach(() => {
unmockTracking();
// We destroy the wrapper ourselves as that needs to happen before the toggle is removed.
// eslint-disable-next-line @gitlab/vtu-no-explicit-wrapper-destroy
wrapper.destroy();
toggle?.remove();
});
it('begins in the closed state', async () => {
await createComponent();
expect(lastNChangeEvents(Infinity)).toEqual([STATE_CLOSED]);
});
describe('when mouse enters the toggle', () => {
beforeEach(async () => {
await createComponent();
mouseEnter(toggle);
});
it('does not emit duplicate events in a region', () => {
mouseEnter(toggle);
expect(lastNChangeEvents(Infinity)).toEqual([STATE_CLOSED, STATE_WILL_OPEN]);
});
it('transitions to will-open when hovering the toggle', () => {
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_OPEN]);
});
describe('when transitioning away from the will-open state', () => {
beforeEach(() => {
jest.advanceTimersByTime(SUPER_SIDEBAR_PEEK_OPEN_DELAY - 1);
});
it('transitions to open after delay', () => {
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_OPEN]);
jest.advanceTimersByTime(1);
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_OPEN, STATE_OPEN]);
expect(trackingSpy).toHaveBeenCalledWith(undefined, 'nav_hover_peek', {
label: 'nav_sidebar_toggle',
property: 'nav_sidebar',
});
});
it('cancels transition to open if mouse out of toggle', () => {
mouseLeave(toggle);
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(3)).toEqual([STATE_WILL_OPEN, STATE_WILL_CLOSE, STATE_CLOSED]);
});
it('transitions to closed if cursor leaves document', () => {
moveMouseOutOfDocument();
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_OPEN, STATE_CLOSED]);
});
});
describe('when transitioning away from the will-close state', () => {
beforeEach(() => {
jest.runOnlyPendingTimers();
moveMouse(X_SIDEBAR_EDGE);
jest.advanceTimersByTime(SUPER_SIDEBAR_PEEK_CLOSE_DELAY - 1);
});
it('transitions to closed after delay', () => {
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_CLOSE]);
jest.advanceTimersByTime(1);
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_CLOSE, STATE_CLOSED]);
});
it('cancels transition to close if mouse moves back to toggle', () => {
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_CLOSE]);
mouseEnter(toggle);
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(4)).toEqual([
STATE_OPEN,
STATE_WILL_CLOSE,
STATE_WILL_OPEN,
STATE_OPEN,
]);
});
});
describe('when transitioning away from the open state', () => {
beforeEach(() => {
jest.runOnlyPendingTimers();
});
it('transitions to will-close if mouse out of sidebar region', () => {
expect(lastNChangeEvents(1)).toEqual([STATE_OPEN]);
moveMouse(X_SIDEBAR_EDGE);
expect(lastNChangeEvents(2)).toEqual([STATE_OPEN, STATE_WILL_CLOSE]);
});
it('transitions to will-close if cursor leaves document', () => {
moveMouseOutOfDocument();
expect(lastNChangeEvents(2)).toEqual([STATE_OPEN, STATE_WILL_CLOSE]);
});
});
it('cleans up its mouseleave listener before destroy', () => {
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(1)).toEqual([STATE_OPEN]);
wrapper.destroy();
mouseLeave(toggle);
expect(lastNChangeEvents(1)).toEqual([STATE_OPEN]);
});
it('cleans up its timers before destroy', () => {
wrapper.destroy();
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_OPEN]);
});
it('cleans up document mouseleave listener before destroy', () => {
mouseEnter(toggle);
wrapper.destroy();
moveMouseOutOfDocument();
expect(lastNChangeEvents(1)).not.toEqual([STATE_CLOSED]);
});
});
describe('when mouse is over sidebar child element', () => {
beforeEach(async () => {
await createComponent({ isMouseOverSidebar: true });
});
it('does not transition to will-close or closed when mouse is over sidebar child element', () => {
mouseEnter(toggle);
jest.runOnlyPendingTimers();
mouseLeave(toggle);
expect(lastNChangeEvents(1)).toEqual([STATE_OPEN]);
});
});
it('cleans up its mouseenter listener before destroy', async () => {
await createComponent();
mouseLeave(toggle);
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(1)).toEqual([STATE_CLOSED]);
wrapper.destroy();
mouseEnter(toggle);
expect(lastNChangeEvents(1)).toEqual([STATE_CLOSED]);
});
});
|
