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
|
import * as Sentry from '@sentry/browser';
import { GlCollapsibleListbox, GlFormGroup } from '@gitlab/ui';
import Vue, { nextTick } from 'vue';
import VueApollo from 'vue-apollo';
import waitForPromises from 'helpers/wait_for_promises';
import createMockApollo from 'helpers/mock_apollo_helper';
import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
import WorkItemParent from '~/work_items/components/work_item_parent.vue';
import updateWorkItemMutation from '~/work_items/graphql/update_work_item.mutation.graphql';
import projectWorkItemsQuery from '~/work_items/graphql/project_work_items.query.graphql';
import { WORK_ITEM_TYPE_ENUM_OBJECTIVE } from '~/work_items/constants';
import {
availableObjectivesResponse,
mockParentWidgetResponse,
updateWorkItemMutationResponseFactory,
searchedObjectiveResponse,
updateWorkItemMutationErrorResponse,
} from '../mock_data';
jest.mock('@sentry/browser');
describe('WorkItemParent component', () => {
Vue.use(VueApollo);
let wrapper;
const workItemId = 'gid://gitlab/WorkItem/1';
const workItemType = 'Objective';
const availableWorkItemsSuccessHandler = jest.fn().mockResolvedValue(availableObjectivesResponse);
const availableWorkItemsFailureHandler = jest.fn().mockRejectedValue(new Error());
const successUpdateWorkItemMutationHandler = jest
.fn()
.mockResolvedValue(updateWorkItemMutationResponseFactory({ parent: mockParentWidgetResponse }));
const createComponent = ({
canUpdate = true,
parent = null,
searchQueryHandler = availableWorkItemsSuccessHandler,
mutationHandler = successUpdateWorkItemMutationHandler,
} = {}) => {
wrapper = shallowMountExtended(WorkItemParent, {
apolloProvider: createMockApollo([
[projectWorkItemsQuery, searchQueryHandler],
[updateWorkItemMutation, mutationHandler],
]),
provide: {
fullPath: 'full-path',
},
propsData: {
canUpdate,
parent,
workItemId,
workItemType,
},
});
};
beforeEach(() => {
createComponent();
});
const findInputGroup = () => wrapper.findComponent(GlFormGroup);
const findParentText = () => wrapper.findByTestId('disabled-text');
const findCollapsibleListbox = () => wrapper.findComponent(GlCollapsibleListbox);
describe('template', () => {
it('shows field label as Parent', () => {
expect(findInputGroup().exists()).toBe(true);
expect(findInputGroup().attributes('label')).toBe('Parent');
});
it('renders the collapsible listbox with required props', () => {
expect(findCollapsibleListbox().exists()).toBe(true);
expect(findCollapsibleListbox().props()).toMatchObject({
items: [],
headerText: 'Assign parent',
category: 'tertiary',
loading: false,
noCaret: true,
isCheckCentered: true,
searchable: true,
searching: false,
infiniteScroll: false,
noResultsText: 'No matching results',
toggleText: 'None',
searchPlaceholder: 'Search',
resetButtonLabel: 'Unassign',
block: true,
});
});
it('displays parent text instead of listbox if canUpdate is false', () => {
createComponent({ canUpdate: false, parent: mockParentWidgetResponse });
expect(findCollapsibleListbox().exists()).toBe(false);
expect(findParentText().exists()).toBe(true);
expect(findParentText().text()).toBe('Objective 101');
});
it('shows loading while searching', async () => {
await findCollapsibleListbox().vm.$emit('shown');
expect(findCollapsibleListbox().props('searching')).toBe(true);
expect(findCollapsibleListbox().props('no-caret')).toBeUndefined();
});
});
describe('work items query', () => {
it('loads work items in the listbox', async () => {
await findCollapsibleListbox().vm.$emit('shown');
await waitForPromises();
expect(findCollapsibleListbox().props('searching')).toBe(false);
expect(findCollapsibleListbox().props('items')).toStrictEqual([
{ text: 'Objective 101', value: 'gid://gitlab/WorkItem/716' },
{ text: 'Objective 103', value: 'gid://gitlab/WorkItem/712' },
{ text: 'Objective 102', value: 'gid://gitlab/WorkItem/711' },
]);
expect(availableWorkItemsSuccessHandler).toHaveBeenCalled();
});
it('emits error when the query fails', async () => {
createComponent({ searchQueryHandler: availableWorkItemsFailureHandler });
await findCollapsibleListbox().vm.$emit('shown');
await waitForPromises();
expect(wrapper.emitted('error')).toEqual([
['Something went wrong while fetching items. Please try again.'],
]);
});
it('searches item when input data is entered', async () => {
const searchedItemQueryHandler = jest.fn().mockResolvedValue(searchedObjectiveResponse);
createComponent({
searchQueryHandler: searchedItemQueryHandler,
});
await findCollapsibleListbox().vm.$emit('shown');
await findCollapsibleListbox().vm.$emit('search', 'Objective 101');
await waitForPromises();
expect(searchedItemQueryHandler).toHaveBeenCalledWith({
fullPath: 'full-path',
searchTerm: 'Objective 101',
types: [WORK_ITEM_TYPE_ENUM_OBJECTIVE],
in: 'TITLE',
});
await nextTick();
expect(findCollapsibleListbox().props('items')).toStrictEqual([
{ text: 'Objective 101', value: 'gid://gitlab/WorkItem/716' },
]);
});
});
describe('listbox', () => {
const selectWorkItem = async (workItem) => {
await findCollapsibleListbox().vm.$emit('shown');
await findCollapsibleListbox().vm.$emit('select', workItem);
};
it('calls mutation when item is selected', async () => {
selectWorkItem('gid://gitlab/WorkItem/716');
await waitForPromises();
expect(successUpdateWorkItemMutationHandler).toHaveBeenCalledWith({
input: {
id: 'gid://gitlab/WorkItem/1',
hierarchyWidget: {
parentId: 'gid://gitlab/WorkItem/716',
},
},
});
});
it('calls mutation when item is unassigned', async () => {
const unAssignParentWorkItemMutationHandler = jest
.fn()
.mockResolvedValue(updateWorkItemMutationResponseFactory({ parent: null }));
createComponent({
mutationHandler: unAssignParentWorkItemMutationHandler,
});
await findCollapsibleListbox().vm.$emit('reset');
await waitForPromises();
expect(unAssignParentWorkItemMutationHandler).toHaveBeenCalledWith({
input: {
id: 'gid://gitlab/WorkItem/1',
hierarchyWidget: {
parentId: null,
},
},
});
});
it('emits error when mutation fails', async () => {
createComponent({
mutationHandler: jest.fn().mockResolvedValue(updateWorkItemMutationErrorResponse),
});
selectWorkItem('gid://gitlab/WorkItem/716');
await waitForPromises();
expect(wrapper.emitted('error')).toEqual([['Error!']]);
});
it('emits error and captures exception in sentry when network request fails', async () => {
const error = new Error('error');
createComponent({
mutationHandler: jest.fn().mockRejectedValue(error),
});
selectWorkItem('gid://gitlab/WorkItem/716');
await waitForPromises();
expect(wrapper.emitted('error')).toEqual([
['Something went wrong while updating the objective. Please try again.'],
]);
expect(Sentry.captureException).toHaveBeenCalledWith(error);
});
});
});
|
