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
|
import { GlLoadingIcon, GlListboxItem, GlCollapsibleListbox } from '@gitlab/ui';
import { nextTick } from 'vue';
import { mountExtended } from 'helpers/vue_test_utils_helper';
import eventHubFactory from '~/helpers/event_hub_factory';
import ReferenceBubbleMenu from '~/content_editor/components/bubble_menus/reference_bubble_menu.vue';
import BubbleMenu from '~/content_editor/components/bubble_menus/bubble_menu.vue';
import { stubComponent } from 'helpers/stub_component';
import Reference from '~/content_editor/extensions/reference';
import { createTestEditor, emitEditorEvent, createDocBuilder } from '../../test_utils';
const mockIssue = {
href: 'https://gitlab.com/gitlab-org/gitlab-test/-/issues/24',
text: '#24',
expandedText: 'Et fuga quos omnis enim dolores amet impedit. (#24)',
fullyExpandedText:
'Et fuga quos omnis enim dolores amet impedit. (#24) • Fernanda Adams • Sprint - Eligendi quas non inventore eum quaerat sit.',
};
const mockMergeRequest = {
href: 'https://gitlab.com/gitlab-org/gitlab-test/-/merge_requests/2',
text: '!2',
expandedText: 'Qui possimus sit harum ut ipsam autem. (!2)',
fullyExpandedText: 'Qui possimus sit harum ut ipsam autem. (!2) • Margrett Wunsch • v0.0',
};
const mockEpic = {
href: 'https://gitlab.com/groups/gitlab-org/-/epics/5',
text: '&5',
expandedText: 'Temporibus delectus distinctio quas sed non per... (&5)',
};
const supportedIssueDisplayFormats = ['Issue ID', 'Issue title', 'Issue summary'];
const supportedMergeRequestDisplayFormats = [
'Merge request ID',
'Merge request title',
'Merge request summary',
];
const supportedEpicDisplayFormats = ['Epic ID', 'Epic title'];
describe('content_editor/components/bubble_menus/reference_bubble_menu', () => {
let wrapper;
let tiptapEditor;
let contentEditor;
let eventHub;
let doc;
let p;
let reference;
const buildExpectedDoc = (href, originalText, referenceType, text) =>
doc(p(reference({ className: 'gfm', href, originalText, referenceType, text })));
const buildEditor = () => {
tiptapEditor = createTestEditor({ extensions: [Reference] });
contentEditor = { resolveReference: jest.fn().mockImplementation(() => new Promise(() => {})) };
eventHub = eventHubFactory();
({
builders: { doc, p, reference },
} = createDocBuilder({
tiptapEditor,
names: {
reference: { nodeType: Reference.name },
},
}));
};
const expectedDocs = {
issue: [
() =>
buildExpectedDoc(
'https://gitlab.com/gitlab-org/gitlab-test/-/issues/24',
'#24',
'issue',
'#24',
),
() =>
buildExpectedDoc(
'https://gitlab.com/gitlab-org/gitlab-test/-/issues/24',
'#24+',
'issue',
'Et fuga quos omnis enim dolores amet impedit. (#24)',
),
() =>
buildExpectedDoc(
'https://gitlab.com/gitlab-org/gitlab-test/-/issues/24',
'#24+s',
'issue',
'Et fuga quos omnis enim dolores amet impedit. (#24) • Fernanda Adams • Sprint - Eligendi quas non inventore eum quaerat sit.',
),
],
merge_request: [
() =>
buildExpectedDoc(
'https://gitlab.com/gitlab-org/gitlab-test/-/merge_requests/2',
'!2',
'merge_request',
'!2',
),
() =>
buildExpectedDoc(
'https://gitlab.com/gitlab-org/gitlab-test/-/merge_requests/2',
'!2+',
'merge_request',
'Qui possimus sit harum ut ipsam autem. (!2)',
),
() =>
buildExpectedDoc(
'https://gitlab.com/gitlab-org/gitlab-test/-/merge_requests/2',
'!2+s',
'merge_request',
'Qui possimus sit harum ut ipsam autem. (!2) • Margrett Wunsch • v0.0',
),
],
epic: [
() => buildExpectedDoc('https://gitlab.com/groups/gitlab-org/-/epics/5', '&5', 'epic', '&5'),
() =>
buildExpectedDoc(
'https://gitlab.com/groups/gitlab-org/-/epics/5',
'&5+',
'epic',
'Temporibus delectus distinctio quas sed non per... (&5)',
),
],
};
const buildWrapper = () => {
wrapper = mountExtended(ReferenceBubbleMenu, {
provide: {
tiptapEditor,
contentEditor,
eventHub,
},
stubs: {
BubbleMenu: stubComponent(BubbleMenu),
},
});
};
const showMenu = () => {
wrapper.findComponent(BubbleMenu).vm.$emit('show');
return nextTick();
};
const buildWrapperAndDisplayMenu = async () => {
buildWrapper();
await showMenu();
await emitEditorEvent({ event: 'transaction', tiptapEditor });
};
beforeEach(() => {
buildEditor();
tiptapEditor
.chain()
.setContent(
'<a href="https://gitlab.com/gitlab-org/gitlab/issues/1" class="gfm" data-reference-type="issue" data-original="#1">#1</a>',
)
.setNodeSelection(1)
.run();
});
it('shows a loading indicator while the reference is being resolved', async () => {
await buildWrapperAndDisplayMenu();
expect(wrapper.findComponent(GlLoadingIcon).exists()).toBe(true);
});
describe.each`
referenceType | mockReference | supportedDisplayFormats
${'issue'} | ${mockIssue} | ${supportedIssueDisplayFormats}
${'merge_request'} | ${mockMergeRequest} | ${supportedMergeRequestDisplayFormats}
${'epic'} | ${mockEpic} | ${supportedEpicDisplayFormats}
`(
'for reference type $referenceType',
({ referenceType, mockReference, supportedDisplayFormats }) => {
beforeEach(async () => {
tiptapEditor
.chain()
.setContent(
`<a href="${mockReference.href}" class="gfm" data-reference-type="${referenceType}" data-original="${mockReference.text}">${mockReference.text}</a>`,
)
.setNodeSelection(1)
.run();
contentEditor.resolveReference.mockImplementation(() => Promise.resolve(mockReference));
await emitEditorEvent({ event: 'transaction', tiptapEditor });
});
it('shows a dropdown with supported display formats', async () => {
await buildWrapperAndDisplayMenu();
supportedDisplayFormats.forEach((format) => expect(wrapper.text()).toContain(format));
});
describe.each`
option | displayFormat | selectedValue
${0} | ${supportedDisplayFormats[0]} | ${''}
${1} | ${supportedDisplayFormats[1]} | ${'+'}
${2} | ${supportedDisplayFormats[2]} | ${'+s'}
`('on selecting option $option', ({ option, displayFormat, selectedValue }) => {
if (!displayFormat) return;
const findDropdownItem = () => wrapper.findAllComponents(GlListboxItem).at(option);
beforeEach(async () => {
await buildWrapperAndDisplayMenu();
findDropdownItem().trigger('click');
});
it('selects the option', () => {
expect(wrapper.findComponent(GlCollapsibleListbox).props()).toMatchObject({
selected: selectedValue,
toggleText: displayFormat,
});
});
it('updates the reference in content editor', () => {
expect(tiptapEditor.getJSON()).toEqual(expectedDocs[referenceType][option]().toJSON());
});
});
},
);
describe('copy URL button', () => {
it('copies the reference link to clipboard', async () => {
jest.spyOn(navigator.clipboard, 'writeText');
await buildWrapperAndDisplayMenu();
await wrapper.findByTestId('copy-reference-url').trigger('click');
expect(navigator.clipboard.writeText).toHaveBeenCalledWith(
'https://gitlab.com/gitlab-org/gitlab/issues/1',
);
});
});
describe('remove reference button', () => {
it('removes the reference', async () => {
await buildWrapperAndDisplayMenu();
await wrapper.findByTestId('remove-reference').trigger('click');
expect(tiptapEditor.getHTML()).toBe('<p dir="auto"></p>');
});
});
});
|
