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
|
import { mount } from '@vue/test-utils';
import {
SUPER_SIDEBAR_PEEK_OPEN_DELAY,
SUPER_SIDEBAR_PEEK_CLOSE_DELAY,
} from '~/super_sidebar/constants';
import SidebarPeek, {
STATE_CLOSED,
STATE_WILL_OPEN,
STATE_OPEN,
STATE_WILL_CLOSE,
} from '~/super_sidebar/components/sidebar_peek_behavior.vue';
// These are measured at runtime in the browser, but statically defined here
// since Jest does not do layout/styling.
const X_NEAR_WINDOW_EDGE = 5;
const X_SIDEBAR_EDGE = 10;
const X_AWAY_FROM_SIDEBAR = 20;
jest.mock('~/lib/utils/css_utils', () => ({
getCssClassDimensions: (className) => {
if (className === 'gl-w-3') {
return { width: X_NEAR_WINDOW_EDGE };
}
if (className === 'super-sidebar') {
return { width: X_SIDEBAR_EDGE };
}
throw new Error(`No mock for CSS class ${className}`);
},
}));
describe('SidebarPeek component', () => {
let wrapper;
const createComponent = () => {
wrapper = mount(SidebarPeek);
};
const moveMouse = (clientX) => {
const event = new MouseEvent('mousemove', {
clientX,
});
document.dispatchEvent(event);
};
const moveMouseOutOfDocument = () => {
const event = new MouseEvent('mouseleave');
document.documentElement.dispatchEvent(event);
};
const lastNChangeEvents = (n = 1) => wrapper.emitted('change').slice(-n).flat();
beforeEach(() => {
createComponent();
});
it('begins in the closed state', () => {
expect(lastNChangeEvents(Infinity)).toEqual([STATE_CLOSED]);
});
it('does not emit duplicate events in a region', () => {
moveMouse(0);
moveMouse(1);
moveMouse(2);
expect(lastNChangeEvents(Infinity)).toEqual([STATE_CLOSED, STATE_WILL_OPEN]);
});
it('transitions to will-open when in peek region', () => {
moveMouse(X_NEAR_WINDOW_EDGE);
expect(lastNChangeEvents(1)).toEqual([STATE_CLOSED]);
moveMouse(X_NEAR_WINDOW_EDGE - 1);
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_OPEN]);
});
it('transitions will-open -> open after delay', () => {
moveMouse(0);
jest.advanceTimersByTime(SUPER_SIDEBAR_PEEK_OPEN_DELAY - 1);
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_OPEN]);
jest.advanceTimersByTime(1);
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_OPEN, STATE_OPEN]);
});
it('cancels transition will-open -> open if mouse out of peek region', () => {
moveMouse(0);
jest.advanceTimersByTime(SUPER_SIDEBAR_PEEK_OPEN_DELAY - 1);
moveMouse(X_NEAR_WINDOW_EDGE);
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(3)).toEqual([STATE_CLOSED, STATE_WILL_OPEN, STATE_CLOSED]);
});
it('transitions open -> will-close if mouse out of sidebar region', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
moveMouse(X_SIDEBAR_EDGE - 1);
expect(lastNChangeEvents(1)).toEqual([STATE_OPEN]);
moveMouse(X_SIDEBAR_EDGE);
expect(lastNChangeEvents(2)).toEqual([STATE_OPEN, STATE_WILL_CLOSE]);
});
it('transitions will-close -> closed after delay', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
moveMouse(X_SIDEBAR_EDGE);
jest.advanceTimersByTime(SUPER_SIDEBAR_PEEK_CLOSE_DELAY - 1);
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_CLOSE]);
jest.advanceTimersByTime(1);
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_CLOSE, STATE_CLOSED]);
});
it('cancels transition will-close -> close if mouse move in sidebar region', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
moveMouse(X_SIDEBAR_EDGE);
jest.advanceTimersByTime(SUPER_SIDEBAR_PEEK_CLOSE_DELAY - 1);
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_CLOSE]);
moveMouse(X_SIDEBAR_EDGE - 1);
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(3)).toEqual([STATE_OPEN, STATE_WILL_CLOSE, STATE_OPEN]);
});
it('immediately transitions open -> closed if mouse moves far away', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
moveMouse(X_AWAY_FROM_SIDEBAR);
expect(lastNChangeEvents(2)).toEqual([STATE_OPEN, STATE_CLOSED]);
});
it('immediately transitions will-close -> closed if mouse moves far away', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
moveMouse(X_AWAY_FROM_SIDEBAR - 1);
moveMouse(X_AWAY_FROM_SIDEBAR);
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_CLOSE, STATE_CLOSED]);
});
it('cleans up its mousemove listener before destroy', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
wrapper.destroy();
moveMouse(X_AWAY_FROM_SIDEBAR);
expect(lastNChangeEvents(1)).toEqual([STATE_OPEN]);
});
it('cleans up its timers before destroy', () => {
moveMouse(0);
wrapper.destroy();
jest.runOnlyPendingTimers();
expect(lastNChangeEvents(1)).toEqual([STATE_WILL_OPEN]);
});
it('transitions will-open -> closed if cursor leaves document', () => {
moveMouse(0);
moveMouseOutOfDocument();
expect(lastNChangeEvents(2)).toEqual([STATE_WILL_OPEN, STATE_CLOSED]);
});
it('transitions open -> will-close if cursor leaves document', () => {
moveMouse(0);
jest.runOnlyPendingTimers();
moveMouseOutOfDocument();
expect(lastNChangeEvents(2)).toEqual([STATE_OPEN, STATE_WILL_CLOSE]);
});
it('cleans up document mouseleave listener before destroy', () => {
moveMouse(0);
wrapper.destroy();
moveMouseOutOfDocument();
expect(lastNChangeEvents(1)).not.toEqual([STATE_CLOSED]);
});
});
|
