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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
|
import { launchDrawioEditor } from '~/drawio/drawio_editor';
import {
DRAWIO_EDITOR_URL,
DRAWIO_FRAME_ID,
DIAGRAM_BACKGROUND_COLOR,
DRAWIO_IFRAME_TIMEOUT,
DIAGRAM_MAX_SIZE,
} from '~/drawio/constants';
import { createAlert, VARIANT_SUCCESS } from '~/alert';
jest.mock('~/alert');
jest.useFakeTimers();
describe('drawio/drawio_editor', () => {
let editorFacade;
let drawioIFrameReceivedMessages;
const diagramURL = `${window.location.origin}/uploads/diagram.drawio.svg`;
const testSvg = '<svg></svg>';
const testEncodedSvg = `data:image/svg+xml;base64,${btoa(testSvg)}`;
const filename = 'diagram.drawio.svg';
const findDrawioIframe = () => document.getElementById(DRAWIO_FRAME_ID);
const waitForDrawioIFrameMessage = ({ messageNumber = 1 } = {}) =>
new Promise((resolve) => {
let messageCounter = 0;
const iframe = findDrawioIframe();
iframe?.contentWindow.addEventListener('message', (event) => {
drawioIFrameReceivedMessages.push(event);
messageCounter += 1;
if (messageCounter === messageNumber) {
resolve();
}
});
});
const expectDrawioIframeMessage = ({ expectation, messageNumber = 1 }) => {
expect(drawioIFrameReceivedMessages).toHaveLength(messageNumber);
expect(JSON.parse(drawioIFrameReceivedMessages[messageNumber - 1].data)).toEqual(expectation);
};
const postMessageToParentWindow = (data) => {
const event = new Event('message');
Object.setPrototypeOf(event, {
source: findDrawioIframe().contentWindow,
data: JSON.stringify(data),
});
window.dispatchEvent(event);
};
beforeEach(() => {
editorFacade = {
getDiagram: jest.fn(),
uploadDiagram: jest.fn(),
insertDiagram: jest.fn(),
updateDiagram: jest.fn(),
};
drawioIFrameReceivedMessages = [];
});
afterEach(() => {
jest.clearAllMocks();
findDrawioIframe()?.remove();
});
describe('initializing', () => {
beforeEach(() => {
launchDrawioEditor({ editorFacade });
});
it('creates the drawio editor iframe and attaches it to the body', () => {
expect(findDrawioIframe().getAttribute('src')).toBe(DRAWIO_EDITOR_URL);
});
it('sets drawio-editor classname to the iframe', () => {
expect(findDrawioIframe().classList).toContain('drawio-editor');
});
});
describe(`when parent window does not receive configure event after ${DRAWIO_IFRAME_TIMEOUT} ms`, () => {
beforeEach(() => {
launchDrawioEditor({ editorFacade });
});
it('disposes draw.io iframe', () => {
expect(findDrawioIframe()).not.toBe(null);
jest.runAllTimers();
expect(findDrawioIframe()).toBe(null);
});
it('displays an alert indicating that the draw.io editor could not be loaded', () => {
jest.runAllTimers();
expect(createAlert).toHaveBeenCalledWith({
message: 'The diagrams.net editor could not be loaded.',
});
});
});
describe('when parent window receives configure event', () => {
beforeEach(async () => {
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'configure' });
await waitForDrawioIFrameMessage();
});
it('sends configure action to the draw.io iframe', () => {
expectDrawioIframeMessage({
expectation: {
action: 'configure',
config: {
darkColor: '#202020',
settingsName: 'gitlab',
},
colorSchemeMeta: false,
},
});
});
it('does not remove the iframe after the load error timeouts run', () => {
jest.runAllTimers();
expect(findDrawioIframe()).not.toBe(null);
});
});
describe('when parent window receives init event', () => {
describe('when there isn’t a diagram selected', () => {
beforeEach(() => {
editorFacade.getDiagram.mockResolvedValueOnce(null);
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'init' });
});
it('sends load action to the draw.io iframe with empty svg and title', async () => {
await waitForDrawioIFrameMessage();
expectDrawioIframeMessage({
expectation: {
action: 'load',
xml: null,
border: 8,
background: DIAGRAM_BACKGROUND_COLOR,
dark: false,
title: null,
},
});
});
});
describe('when there is a diagram selected', () => {
const diagramSvg = '<svg></svg>';
beforeEach(() => {
editorFacade.getDiagram.mockResolvedValueOnce({
diagramURL,
diagramSvg,
filename,
contentType: 'image/svg+xml',
});
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'init' });
});
it('sends load action to the draw.io iframe with the selected diagram svg and filename', async () => {
await waitForDrawioIFrameMessage();
// Step 5: The draw.io editor will send the downloaded diagram to the iframe
expectDrawioIframeMessage({
expectation: {
action: 'load',
xml: diagramSvg,
border: 8,
background: DIAGRAM_BACKGROUND_COLOR,
dark: false,
title: filename,
},
});
});
it('sets the drawio iframe as visible and resets cursor', async () => {
await waitForDrawioIFrameMessage();
expect(findDrawioIframe().style.visibility).toBe('visible');
expect(findDrawioIframe().style.cursor).toBe('');
});
it('scrolls window to the top', async () => {
await waitForDrawioIFrameMessage();
expect(window.scrollX).toBe(0);
});
});
describe.each`
description | errorMessage | diagram
${'when there is an image selected that is not an svg file'} | ${'The selected image is not a valid SVG diagram'} | ${{
diagramURL,
contentType: 'image/png',
filename: 'image.png',
}}
${'when the selected image is not an asset upload'} | ${'The selected image is not an asset uploaded in the application'} | ${{
diagramSvg: '<svg></svg>',
filename,
contentType: 'image/svg+xml',
diagramURL: 'https://example.com/image.drawio.svg',
}}
${'when the selected image is too large'} | ${'The selected image is too large.'} | ${{
diagramSvg: 'x'.repeat(DIAGRAM_MAX_SIZE + 1),
filename,
contentType: 'image/svg+xml',
diagramURL,
}}
`('$description', ({ errorMessage, diagram }) => {
beforeEach(() => {
editorFacade.getDiagram.mockResolvedValueOnce(diagram);
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'init' });
});
it('displays an error alert indicating that the image is not a diagram', () => {
expect(createAlert).toHaveBeenCalledWith({
message: errorMessage,
error: expect.any(Error),
});
});
it('disposes the draw.io diagram iframe', () => {
expect(findDrawioIframe()).toBe(null);
});
});
describe('when loading a diagram fails', () => {
beforeEach(() => {
editorFacade.getDiagram.mockRejectedValueOnce(new Error());
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'init' });
});
it('displays an error alert indicating the failure', () => {
expect(createAlert).toHaveBeenCalledWith({
message: 'Cannot load the diagram into the diagrams.net editor',
error: expect.any(Error),
});
});
it('disposes the draw.io diagram iframe', () => {
expect(findDrawioIframe()).toBe(null);
});
});
});
describe('when parent window receives prompt event', () => {
describe('when the filename is empty', () => {
beforeEach(() => {
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'prompt', value: '' });
});
it('sends prompt action to the draw.io iframe requesting a filename', async () => {
await waitForDrawioIFrameMessage({ messageNumber: 1 });
expectDrawioIframeMessage({
expectation: {
action: 'prompt',
titleKey: 'filename',
okKey: 'save',
defaultValue: 'diagram.drawio.svg',
},
messageNumber: 1,
});
});
it('sends dialog action to the draw.io iframe indicating that the filename cannot be empty', async () => {
await waitForDrawioIFrameMessage({ messageNumber: 2 });
expectDrawioIframeMessage({
expectation: {
action: 'dialog',
titleKey: 'error',
messageKey: 'filenameShort',
buttonKey: 'ok',
},
messageNumber: 2,
});
});
});
describe('when the event data is not empty', () => {
beforeEach(async () => {
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'prompt', value: 'diagram.drawio.svg' });
await waitForDrawioIFrameMessage();
});
it('starts the saving file process', () => {
expectDrawioIframeMessage({
expectation: {
action: 'spinner',
show: true,
messageKey: 'saving',
},
});
});
});
});
describe('when parent receives export event', () => {
beforeEach(() => {
editorFacade.uploadDiagram.mockResolvedValueOnce({});
});
it('reloads diagram in the draw.io editor', async () => {
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
await waitForDrawioIFrameMessage();
expectDrawioIframeMessage({
expectation: expect.objectContaining({
action: 'load',
xml: expect.stringContaining(testSvg),
}),
});
});
it('marks the diagram as modified in the draw.io editor', async () => {
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
await waitForDrawioIFrameMessage({ messageNumber: 2 });
expectDrawioIframeMessage({
expectation: expect.objectContaining({
action: 'status',
modified: true,
}),
messageNumber: 2,
});
});
describe('when the diagram filename is set', () => {
const TEST_FILENAME = 'diagram.drawio.svg';
beforeEach(() => {
launchDrawioEditor({ editorFacade, filename: TEST_FILENAME });
});
it('displays loading spinner in the draw.io editor', async () => {
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
await waitForDrawioIFrameMessage({ messageNumber: 3 });
expectDrawioIframeMessage({
expectation: {
action: 'spinner',
show: true,
messageKey: 'saving',
},
messageNumber: 3,
});
});
it('uploads exported diagram', async () => {
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
await waitForDrawioIFrameMessage({ messageNumber: 3 });
expect(editorFacade.uploadDiagram).toHaveBeenCalledWith({
filename: TEST_FILENAME,
diagramSvg: expect.stringContaining(testSvg),
});
});
describe('when uploading the exported diagram succeeds', () => {
it('displays an alert indicating that the diagram was uploaded successfully', async () => {
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
await waitForDrawioIFrameMessage({ messageNumber: 3 });
expect(createAlert).toHaveBeenCalledWith({
message: expect.any(String),
variant: VARIANT_SUCCESS,
fadeTransition: true,
});
});
it('disposes iframe', () => {
jest.runAllTimers();
expect(findDrawioIframe()).toBe(null);
});
});
describe('when uploading the exported diagram fails', () => {
const uploadError = new Error();
beforeEach(() => {
editorFacade.uploadDiagram.mockReset();
editorFacade.uploadDiagram.mockRejectedValue(uploadError);
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
});
it('hides loading indicator in the draw.io editor', async () => {
await waitForDrawioIFrameMessage({ messageNumber: 4 });
expectDrawioIframeMessage({
expectation: {
action: 'spinner',
show: false,
},
messageNumber: 4,
});
});
it('displays an error dialog in the draw.io editor', async () => {
await waitForDrawioIFrameMessage({ messageNumber: 5 });
expectDrawioIframeMessage({
expectation: {
action: 'dialog',
titleKey: 'error',
modified: true,
buttonKey: 'close',
messageKey: 'errorSavingFile',
},
messageNumber: 5,
});
});
});
});
describe('when diagram filename is not set', () => {
it('sends prompt action to the draw.io iframe', async () => {
launchDrawioEditor({ editorFacade });
postMessageToParentWindow({ event: 'export', data: testEncodedSvg });
await waitForDrawioIFrameMessage({ messageNumber: 3 });
expect(drawioIFrameReceivedMessages[2].data).toEqual(
JSON.stringify({
action: 'prompt',
titleKey: 'filename',
okKey: 'save',
defaultValue: 'diagram.drawio.svg',
}),
);
});
});
});
describe('when parent window receives exit event', () => {
beforeEach(() => {
launchDrawioEditor({ editorFacade });
});
it('disposes the the draw.io iframe', () => {
expect(findDrawioIframe()).not.toBe(null);
postMessageToParentWindow({ event: 'exit' });
expect(findDrawioIframe()).toBe(null);
});
});
});
|