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
|
import Vue, { nextTick } from 'vue';
import VueApollo from 'vue-apollo';
import WorkItemMilestone from '~/work_items/components/work_item_milestone_with_edit.vue';
import WorkItemSidebarDropdownWidgetWithEdit from '~/work_items/components/shared/work_item_sidebar_dropdown_widget_with_edit.vue';
import createMockApollo from 'helpers/mock_apollo_helper';
import { mockTracking } from 'helpers/tracking_helper';
import { mountExtended, shallowMountExtended } from 'helpers/vue_test_utils_helper';
import waitForPromises from 'helpers/wait_for_promises';
import { TRACKING_CATEGORY_SHOW } from '~/work_items/constants';
import updateWorkItemMutation from '~/work_items/graphql/update_work_item.mutation.graphql';
import projectMilestonesQuery from '~/sidebar/queries/project_milestones.query.graphql';
import {
projectMilestonesResponse,
projectMilestonesResponseWithNoMilestones,
mockMilestoneWidgetResponse,
updateWorkItemMutationErrorResponse,
updateWorkItemMutationResponse,
} from '../mock_data';
describe('WorkItemMilestoneWithEdit component', () => {
Vue.use(VueApollo);
let wrapper;
const workItemId = 'gid://gitlab/WorkItem/1';
const workItemType = 'Task';
const findSidebarDropdownWidget = () =>
wrapper.findComponent(WorkItemSidebarDropdownWidgetWithEdit);
const successSearchQueryHandler = jest.fn().mockResolvedValue(projectMilestonesResponse);
const successSearchWithNoMatchingMilestones = jest
.fn()
.mockResolvedValue(projectMilestonesResponseWithNoMilestones);
const successUpdateWorkItemMutationHandler = jest
.fn()
.mockResolvedValue(updateWorkItemMutationResponse);
const showDropdown = () => findSidebarDropdownWidget().vm.$emit('dropdownShown');
const createComponent = ({
mountFn = shallowMountExtended,
canUpdate = true,
milestone = mockMilestoneWidgetResponse,
searchQueryHandler = successSearchQueryHandler,
mutationHandler = successUpdateWorkItemMutationHandler,
} = {}) => {
wrapper = mountFn(WorkItemMilestone, {
apolloProvider: createMockApollo([
[projectMilestonesQuery, searchQueryHandler],
[updateWorkItemMutation, mutationHandler],
]),
propsData: {
fullPath: 'full-path',
canUpdate,
workItemMilestone: milestone,
workItemId,
workItemType,
},
});
};
it('has "Milestone" label', () => {
createComponent();
expect(findSidebarDropdownWidget().props('dropdownLabel')).toBe('Milestone');
});
describe('Default text with canUpdate false and milestone value', () => {
describe.each`
description | milestone | value
${'when no milestone'} | ${null} | ${'None'}
${'when milestone set'} | ${mockMilestoneWidgetResponse} | ${mockMilestoneWidgetResponse.title}
`('$description', ({ milestone, value }) => {
it(`has a value of "${value}"`, () => {
createComponent({ mountFn: mountExtended, canUpdate: false, milestone });
expect(findSidebarDropdownWidget().props('canUpdate')).toBe(false);
expect(wrapper.text()).toContain(value);
});
});
});
describe('Dropdown search', () => {
it('shows no matching results when no items', () => {
createComponent({
searchQueryHandler: successSearchWithNoMatchingMilestones,
});
expect(findSidebarDropdownWidget().props('listItems')).toHaveLength(0);
});
});
describe('Dropdown options', () => {
beforeEach(() => {
createComponent({ canUpdate: true });
});
it('calls successSearchQueryHandler with variables when dropdown is opened', async () => {
showDropdown();
await waitForPromises();
expect(successSearchQueryHandler).toHaveBeenCalledWith({
first: 20,
fullPath: 'full-path',
state: 'active',
title: '',
});
});
it('shows the skeleton loader when the items are being fetched on click', async () => {
showDropdown();
await nextTick();
expect(findSidebarDropdownWidget().props('loading')).toBe(true);
});
it('shows the milestones in dropdown when the items have finished fetching', async () => {
showDropdown();
await waitForPromises();
expect(findSidebarDropdownWidget().props('loading')).toBe(false);
expect(findSidebarDropdownWidget().props('listItems')).toHaveLength(
projectMilestonesResponse.data.workspace.attributes.nodes.length,
);
});
it('changes the milestone to null when clicked on Clear', async () => {
findSidebarDropdownWidget().vm.$emit('updateValue', null);
await nextTick();
expect(findSidebarDropdownWidget().props('updateInProgress')).toBe(true);
await waitForPromises();
expect(findSidebarDropdownWidget().props('updateInProgress')).toBe(false);
expect(findSidebarDropdownWidget().props('itemValue')).toBe(null);
});
it('changes the milestone to the selected milestone', async () => {
const milestoneAtIndex = projectMilestonesResponse.data.workspace.attributes.nodes[0];
showDropdown();
await waitForPromises();
findSidebarDropdownWidget().vm.$emit('updateValue', milestoneAtIndex.id);
await nextTick();
expect(findSidebarDropdownWidget().props('itemValue').title).toBe(milestoneAtIndex.title);
});
});
describe('Error handlers', () => {
it.each`
errorType | expectedErrorMessage | mockValue | resolveFunction
${'graphql error'} | ${'Something went wrong while updating the task. Please try again.'} | ${updateWorkItemMutationErrorResponse} | ${'mockResolvedValue'}
${'network error'} | ${'Something went wrong while updating the task. Please try again.'} | ${new Error()} | ${'mockRejectedValue'}
`(
'emits an error when there is a $errorType',
async ({ mockValue, expectedErrorMessage, resolveFunction }) => {
createComponent({
mutationHandler: jest.fn()[resolveFunction](mockValue),
canUpdate: true,
});
showDropdown();
findSidebarDropdownWidget().vm.$emit('updateValue', null);
await waitForPromises();
expect(wrapper.emitted('error')).toEqual([[expectedErrorMessage]]);
},
);
});
describe('Tracking event', () => {
it('tracks updating the milestone', async () => {
const trackingSpy = mockTracking(undefined, wrapper.element, jest.spyOn);
createComponent({ canUpdate: true });
showDropdown();
findSidebarDropdownWidget().vm.$emit('updateValue', null);
await waitForPromises();
expect(trackingSpy).toHaveBeenCalledWith(TRACKING_CATEGORY_SHOW, 'updated_milestone', {
category: TRACKING_CATEGORY_SHOW,
label: 'item_milestone',
property: 'type_Task',
});
});
});
});
|
