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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
import { mount } from '@vue/test-utils';
import MockAdapter from 'axios-mock-adapter';
import { nextTick } from 'vue';
import waitForPromises from 'helpers/wait_for_promises';
import {
defaultProps,
issuable1,
issuable2,
} from 'jest/issuable/components/related_issuable_mock_data';
import createFlash from '~/flash';
import axios from '~/lib/utils/axios_utils';
import { linkedIssueTypesMap } from '~/related_issues/constants';
import RelatedIssuesBlock from '~/related_issues/components/related_issues_block.vue';
import RelatedIssuesRoot from '~/related_issues/components/related_issues_root.vue';
import relatedIssuesService from '~/related_issues/services/related_issues_service';
jest.mock('~/flash');
describe('RelatedIssuesRoot', () => {
let wrapper;
let mock;
const findRelatedIssuesBlock = () => wrapper.findComponent(RelatedIssuesBlock);
beforeEach(() => {
mock = new MockAdapter(axios);
mock.onGet(defaultProps.endpoint).reply(200, []);
});
afterEach(() => {
mock.restore();
wrapper.destroy();
});
const createComponent = ({ props = {}, data = {} } = {}) => {
wrapper = mount(RelatedIssuesRoot, {
propsData: {
...defaultProps,
...props,
},
data() {
return data;
},
});
// Wait for fetch request `fetchRelatedIssues` to complete before starting to test
return waitForPromises();
};
describe('events', () => {
describe('when "relatedIssueRemoveRequest" event is emitted', () => {
describe('when emitted value is a numerical issue', () => {
beforeEach(async () => {
jest
.spyOn(relatedIssuesService.prototype, 'fetchRelatedIssues')
.mockReturnValue(Promise.reject());
await createComponent();
wrapper.vm.store.setRelatedIssues([issuable1]);
});
it('removes related issue on API success', async () => {
mock.onDelete(issuable1.referencePath).reply(200, { issues: [] });
findRelatedIssuesBlock().vm.$emit('relatedIssueRemoveRequest', issuable1.id);
await axios.waitForAll();
expect(findRelatedIssuesBlock().props('relatedIssues')).toEqual([]);
});
it('does not remove related issue on API error', async () => {
mock.onDelete(issuable1.referencePath).reply(422, {});
findRelatedIssuesBlock().vm.$emit('relatedIssueRemoveRequest', issuable1.id);
await axios.waitForAll();
expect(findRelatedIssuesBlock().props('relatedIssues')).toEqual([
expect.objectContaining({ id: issuable1.id }),
]);
});
});
describe('when emitted value is a work item id', () => {
it('removes related issue', async () => {
const workItem = `gid://gitlab/WorkItem/${issuable1.id}`;
createComponent({ data: { state: { relatedIssues: [issuable1] } } });
findRelatedIssuesBlock().vm.$emit('relatedIssueRemoveRequest', workItem);
await nextTick();
expect(findRelatedIssuesBlock().props('relatedIssues')).toEqual([]);
});
});
});
describe('when "toggleAddRelatedIssuesForm" event is emitted', () => {
it('toggles related issues form to visible from hidden', async () => {
createComponent();
findRelatedIssuesBlock().vm.$emit('toggleAddRelatedIssuesForm');
await nextTick();
expect(findRelatedIssuesBlock().props('isFormVisible')).toBe(true);
});
it('toggles related issues form to hidden from visible', async () => {
createComponent({ data: { isFormVisible: true } });
findRelatedIssuesBlock().vm.$emit('toggleAddRelatedIssuesForm');
await nextTick();
expect(findRelatedIssuesBlock().props('isFormVisible')).toBe(false);
});
});
describe('when "pendingIssuableRemoveRequest" event is emitted', () => {
beforeEach(() => {
createComponent();
wrapper.vm.store.setPendingReferences([issuable1.reference]);
});
it('removes pending related issue', async () => {
expect(findRelatedIssuesBlock().props('pendingReferences')).toHaveLength(1);
findRelatedIssuesBlock().vm.$emit('pendingIssuableRemoveRequest', 0);
await nextTick();
expect(findRelatedIssuesBlock().props('pendingReferences')).toHaveLength(0);
});
});
describe('when "addIssuableFormSubmit" event is emitted', () => {
beforeEach(async () => {
jest
.spyOn(relatedIssuesService.prototype, 'fetchRelatedIssues')
.mockReturnValue(Promise.reject());
await createComponent();
jest.spyOn(wrapper.vm, 'processAllReferences');
jest.spyOn(wrapper.vm.service, 'addRelatedIssues');
createFlash.mockClear();
});
it('processes references before submitting', () => {
const input = '#123';
const linkedIssueType = linkedIssueTypesMap.RELATES_TO;
const emitObj = {
pendingReferences: input,
linkedIssueType,
};
findRelatedIssuesBlock().vm.$emit('addIssuableFormSubmit', emitObj);
expect(wrapper.vm.processAllReferences).toHaveBeenCalledWith(input);
expect(wrapper.vm.service.addRelatedIssues).toHaveBeenCalledWith([input], linkedIssueType);
});
it('submits zero pending issues as related issue', () => {
wrapper.vm.store.setPendingReferences([]);
findRelatedIssuesBlock().vm.$emit('addIssuableFormSubmit', {});
expect(findRelatedIssuesBlock().props('pendingReferences')).toHaveLength(0);
expect(findRelatedIssuesBlock().props('relatedIssues')).toHaveLength(0);
});
it('submits pending issue as related issue', async () => {
mock.onPost(defaultProps.endpoint).reply(200, {
issuables: [issuable1],
result: {
message: 'something was successfully related',
status: 'success',
},
});
wrapper.vm.store.setPendingReferences([issuable1.reference]);
findRelatedIssuesBlock().vm.$emit('addIssuableFormSubmit', {});
await waitForPromises();
expect(findRelatedIssuesBlock().props('pendingReferences')).toHaveLength(0);
expect(findRelatedIssuesBlock().props('relatedIssues')).toEqual([
expect.objectContaining({ id: issuable1.id }),
]);
});
it('submits multiple pending issues as related issues', async () => {
mock.onPost(defaultProps.endpoint).reply(200, {
issuables: [issuable1, issuable2],
result: {
message: 'something was successfully related',
status: 'success',
},
});
wrapper.vm.store.setPendingReferences([issuable1.reference, issuable2.reference]);
findRelatedIssuesBlock().vm.$emit('addIssuableFormSubmit', {});
await waitForPromises();
expect(findRelatedIssuesBlock().props('pendingReferences')).toHaveLength(0);
expect(findRelatedIssuesBlock().props('relatedIssues')).toEqual([
expect.objectContaining({ id: issuable1.id }),
expect.objectContaining({ id: issuable2.id }),
]);
});
it('displays a message from the backend upon error', async () => {
const input = '#123';
const message = 'error';
mock.onPost(defaultProps.endpoint).reply(409, { message });
wrapper.vm.store.setPendingReferences([issuable1.reference, issuable2.reference]);
expect(createFlash).not.toHaveBeenCalled();
findRelatedIssuesBlock().vm.$emit('addIssuableFormSubmit', input);
await waitForPromises();
expect(createFlash).toHaveBeenCalledWith({ message });
});
});
describe('when "addIssuableFormCancel" event is emitted', () => {
beforeEach(() => createComponent({ data: { isFormVisible: true, inputValue: 'foo' } }));
it('hides form and resets input', async () => {
findRelatedIssuesBlock().vm.$emit('addIssuableFormCancel');
await nextTick();
expect(findRelatedIssuesBlock().props('isFormVisible')).toBe(false);
expect(findRelatedIssuesBlock().props('inputValue')).toBe('');
expect(findRelatedIssuesBlock().props('pendingReferences')).toHaveLength(0);
});
});
describe('when "addIssuableFormInput" event is emitted', () => {
it('updates pending references with issue reference', async () => {
const input = '#123 ';
createComponent();
findRelatedIssuesBlock().vm.$emit('addIssuableFormInput', {
untouchedRawReferences: [input.trim()],
touchedReference: input,
});
await nextTick();
expect(findRelatedIssuesBlock().props('pendingReferences')).toEqual([input.trim()]);
});
it('updates pending references with full reference', async () => {
const input = 'asdf/qwer#444 ';
createComponent();
findRelatedIssuesBlock().vm.$emit('addIssuableFormInput', {
untouchedRawReferences: [input.trim()],
touchedReference: input,
});
await nextTick();
expect(findRelatedIssuesBlock().props('pendingReferences')).toEqual([input.trim()]);
});
it('updates pending references with issue link', async () => {
const link = 'http://localhost:3000/foo/bar/issues/111';
const input = `${link} `;
createComponent();
findRelatedIssuesBlock().vm.$emit('addIssuableFormInput', {
untouchedRawReferences: [input.trim()],
touchedReference: input,
});
await nextTick();
expect(findRelatedIssuesBlock().props('pendingReferences')).toEqual([link]);
});
it('updates pending references with multiple references', async () => {
const input = 'asdf/qwer#444 #12 ';
createComponent();
findRelatedIssuesBlock().vm.$emit('addIssuableFormInput', {
untouchedRawReferences: input.trim().split(/\s/),
touchedReference: '2',
});
await nextTick();
expect(findRelatedIssuesBlock().props('pendingReferences')).toEqual([
'asdf/qwer#444',
'#12',
]);
});
it('updates pending references with invalid values', async () => {
const input = 'something random ';
createComponent();
findRelatedIssuesBlock().vm.$emit('addIssuableFormInput', {
untouchedRawReferences: input.trim().split(/\s/),
touchedReference: '2',
});
await nextTick();
expect(findRelatedIssuesBlock().props('pendingReferences')).toEqual([
'something',
'random',
]);
});
it.each(['#', '&'])(
'prepends %s when user enters a numeric value [0-9]',
async (pathIdSeparator) => {
const input = '23';
createComponent({ props: { pathIdSeparator } });
findRelatedIssuesBlock().vm.$emit('addIssuableFormInput', {
untouchedRawReferences: input.trim().split(/\s/),
touchedReference: input,
});
await nextTick();
expect(findRelatedIssuesBlock().props('inputValue')).toBe(`${pathIdSeparator}${input}`);
},
);
});
describe('when "addIssuableFormBlur" event is emitted', () => {
beforeEach(() => {
createComponent();
jest.spyOn(wrapper.vm, 'processAllReferences').mockImplementation(() => {});
});
it('adds any references to pending when blurring', () => {
const input = '#123';
findRelatedIssuesBlock().vm.$emit('addIssuableFormBlur', input);
expect(wrapper.vm.processAllReferences).toHaveBeenCalledWith(input);
});
});
});
});
|