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
|
import { editor as monacoEditor } from 'monaco-editor';
import {
EDITOR_EXTENSION_NAMING_CONFLICT_ERROR,
EDITOR_EXTENSION_NO_DEFINITION_ERROR,
EDITOR_EXTENSION_DEFINITION_TYPE_ERROR,
EDITOR_EXTENSION_NOT_REGISTERED_ERROR,
EDITOR_EXTENSION_NOT_SPECIFIED_FOR_UNUSE_ERROR,
} from '~/editor/constants';
import SourceEditorInstance from '~/editor/source_editor_instance';
import { sprintf } from '~/locale';
import {
SEClassExtension,
conflictingExtensions,
SEFnExtension,
SEConstExt,
SEWithSetupExt,
} from './helpers';
describe('Source Editor Instance', () => {
let seInstance;
const defSetupOptions = { foo: 'bar' };
const fullExtensionsArray = [
{ definition: SEClassExtension },
{ definition: SEFnExtension },
{ definition: SEConstExt },
];
const fullExtensionsArrayWithOptions = [
{ definition: SEClassExtension, setupOptions: defSetupOptions },
{ definition: SEFnExtension, setupOptions: defSetupOptions },
{ definition: SEConstExt, setupOptions: defSetupOptions },
];
const fooFn = jest.fn();
const fooProp = 'foo';
class DummyExt {
// eslint-disable-next-line class-methods-use-this
get extensionName() {
return 'DummyExt';
}
// eslint-disable-next-line class-methods-use-this
provides() {
return {
fooFn,
fooProp,
};
}
}
afterEach(() => {
seInstance = undefined;
});
it('sets up the registry for the methods coming from extensions', () => {
seInstance = new SourceEditorInstance();
expect(seInstance.methods).toBeDefined();
seInstance.use({ definition: SEClassExtension });
expect(seInstance.methods).toEqual({
shared: 'SEClassExtension',
classExtMethod: 'SEClassExtension',
});
seInstance.use({ definition: SEFnExtension });
expect(seInstance.methods).toEqual({
shared: 'SEClassExtension',
classExtMethod: 'SEClassExtension',
fnExtMethod: 'SEFnExtension',
});
});
describe('proxy', () => {
it('returns a method from an extension if extension provides it', () => {
seInstance = new SourceEditorInstance();
seInstance.use({ definition: DummyExt });
expect(fooFn).not.toHaveBeenCalled();
seInstance.fooFn();
expect(fooFn).toHaveBeenCalled();
});
it('returns a prop from an extension if extension provides it', () => {
seInstance = new SourceEditorInstance();
seInstance.use({ definition: DummyExt });
expect(seInstance.fooProp).toBe('foo');
});
it.each`
stringPropToPass | objPropToPass | setupOptions
${undefined} | ${undefined} | ${undefined}
${'prop'} | ${undefined} | ${undefined}
${'prop'} | ${[]} | ${undefined}
${'prop'} | ${{}} | ${undefined}
${'prop'} | ${{ alpha: 'beta' }} | ${undefined}
${'prop'} | ${{ alpha: 'beta' }} | ${defSetupOptions}
${'prop'} | ${undefined} | ${defSetupOptions}
${undefined} | ${undefined} | ${defSetupOptions}
${''} | ${{}} | ${defSetupOptions}
`(
'correctly passes arguments ("$stringPropToPass", "$objPropToPass") and instance (with "$setupOptions" setupOptions) to extension methods',
({ stringPropToPass, objPropToPass, setupOptions }) => {
seInstance = new SourceEditorInstance();
seInstance.use({ definition: SEWithSetupExt, setupOptions });
const [stringProp, objProp, instance] = seInstance.returnInstanceAndProps(
stringPropToPass,
objPropToPass,
);
const expectedObjProps = objPropToPass || {};
expect(instance).toBe(seInstance);
expect(stringProp).toBe(stringPropToPass);
expect(objProp).toEqual(expectedObjProps);
if (setupOptions) {
Object.keys(setupOptions).forEach((key) => {
expect(instance[key]).toBe(setupOptions[key]);
});
}
},
);
it('correctly passes instance to the methods even if no additional props have been passed', () => {
seInstance = new SourceEditorInstance();
seInstance.use({ definition: SEWithSetupExt });
const instance = seInstance.returnInstance();
expect(instance).toBe(seInstance);
});
it("correctly sets the context of the 'this' keyword for the extension's methods", () => {
seInstance = new SourceEditorInstance();
const extension = seInstance.use({ definition: SEWithSetupExt });
expect(seInstance.giveMeContext()).toEqual(extension.obj);
});
it('returns props from SE instance itself if no extension provides the prop', () => {
seInstance = new SourceEditorInstance({
use: fooFn,
});
const spy = jest.spyOn(seInstance.constructor.prototype, 'use').mockImplementation(() => {});
expect(spy).not.toHaveBeenCalled();
expect(fooFn).not.toHaveBeenCalled();
seInstance.use();
expect(spy).toHaveBeenCalled();
expect(fooFn).not.toHaveBeenCalled();
});
it('returns props from Monaco instance when the prop does not exist on the SE instance', () => {
seInstance = new SourceEditorInstance({
fooFn,
});
expect(fooFn).not.toHaveBeenCalled();
seInstance.fooFn();
expect(fooFn).toHaveBeenCalled();
});
});
describe('public API', () => {
it.each(['use', 'unuse'], 'provides "%s" as public method by default', (method) => {
seInstance = new SourceEditorInstance();
expect(seInstance[method]).toBeDefined();
});
describe('use', () => {
it('extends the SE instance with methods provided by an extension', () => {
seInstance = new SourceEditorInstance();
seInstance.use({ definition: DummyExt });
expect(fooFn).not.toHaveBeenCalled();
seInstance.fooFn();
expect(fooFn).toHaveBeenCalled();
});
it.each`
extensions | expectedProps
${{ definition: SEClassExtension }} | ${['shared', 'classExtMethod']}
${{ definition: SEFnExtension }} | ${['fnExtMethod']}
${{ definition: SEConstExt }} | ${['constExtMethod']}
${fullExtensionsArray} | ${['shared', 'classExtMethod', 'fnExtMethod', 'constExtMethod']}
${fullExtensionsArrayWithOptions} | ${['shared', 'classExtMethod', 'fnExtMethod', 'constExtMethod']}
`(
'Should register $expectedProps when extension is "$extensions"',
({ extensions, expectedProps }) => {
seInstance = new SourceEditorInstance();
expect(seInstance.extensionsAPI).toHaveLength(0);
seInstance.use(extensions);
expect(seInstance.extensionsAPI).toEqual(expectedProps);
},
);
it.each`
definition | preInstalledExtDefinition | expectedErrorProp
${conflictingExtensions.WithInstanceExt} | ${SEClassExtension} | ${'use'}
${conflictingExtensions.WithInstanceExt} | ${null} | ${'use'}
${conflictingExtensions.WithAnotherExt} | ${null} | ${undefined}
${conflictingExtensions.WithAnotherExt} | ${SEClassExtension} | ${'shared'}
${SEClassExtension} | ${conflictingExtensions.WithAnotherExt} | ${'shared'}
`(
'logs the naming conflict error when registering $definition',
({ definition, preInstalledExtDefinition, expectedErrorProp }) => {
seInstance = new SourceEditorInstance();
jest.spyOn(console, 'error').mockImplementation(() => {});
if (preInstalledExtDefinition) {
seInstance.use({ definition: preInstalledExtDefinition });
// eslint-disable-next-line no-console
expect(console.error).not.toHaveBeenCalled();
}
seInstance.use({ definition });
if (expectedErrorProp) {
// eslint-disable-next-line no-console
expect(console.error).toHaveBeenCalledWith(
expect.any(String),
expect.stringContaining(
sprintf(EDITOR_EXTENSION_NAMING_CONFLICT_ERROR, { prop: expectedErrorProp }),
),
);
} else {
// eslint-disable-next-line no-console
expect(console.error).not.toHaveBeenCalled();
}
},
);
it.each`
extensions | thrownError
${''} | ${EDITOR_EXTENSION_NO_DEFINITION_ERROR}
${undefined} | ${EDITOR_EXTENSION_NO_DEFINITION_ERROR}
${{}} | ${EDITOR_EXTENSION_NO_DEFINITION_ERROR}
${{ foo: 'bar' }} | ${EDITOR_EXTENSION_NO_DEFINITION_ERROR}
${{ definition: '' }} | ${EDITOR_EXTENSION_NO_DEFINITION_ERROR}
${{ definition: undefined }} | ${EDITOR_EXTENSION_NO_DEFINITION_ERROR}
${{ definition: [] }} | ${EDITOR_EXTENSION_DEFINITION_TYPE_ERROR}
${{ definition: {} }} | ${EDITOR_EXTENSION_DEFINITION_TYPE_ERROR}
${{ definition: { foo: 'bar' } }} | ${EDITOR_EXTENSION_DEFINITION_TYPE_ERROR}
`(
'Should throw $thrownError when extension is "$extensions"',
({ extensions, thrownError }) => {
seInstance = new SourceEditorInstance();
const useExtension = () => {
seInstance.use(extensions);
};
expect(useExtension).toThrowError(thrownError);
},
);
describe('global extensions registry', () => {
let extensionStore;
beforeEach(() => {
extensionStore = new Map();
seInstance = new SourceEditorInstance({}, extensionStore);
});
it('stores _instances_ of the used extensions in a global registry', () => {
const extension = seInstance.use({ definition: SEClassExtension });
expect(extensionStore.size).toBe(1);
expect(extensionStore.entries().next().value).toEqual(['SEClassExtension', extension]);
});
it('does not duplicate entries in the registry', () => {
jest.spyOn(extensionStore, 'set');
const extension1 = seInstance.use({ definition: SEClassExtension });
seInstance.use({ definition: SEClassExtension });
expect(extensionStore.set).toHaveBeenCalledTimes(1);
expect(extensionStore.set).toHaveBeenCalledWith('SEClassExtension', extension1);
});
it.each`
desc | currentSetupOptions | newSetupOptions | expectedCallTimes
${'updates'} | ${undefined} | ${defSetupOptions} | ${2}
${'updates'} | ${defSetupOptions} | ${undefined} | ${2}
${'updates'} | ${{ foo: 'bar' }} | ${{ foo: 'new' }} | ${2}
${'does not update'} | ${undefined} | ${undefined} | ${1}
${'does not update'} | ${{}} | ${{}} | ${1}
${'does not update'} | ${defSetupOptions} | ${defSetupOptions} | ${1}
`(
'$desc the extensions entry when setupOptions "$currentSetupOptions" get changed to "$newSetupOptions"',
({ currentSetupOptions, newSetupOptions, expectedCallTimes }) => {
jest.spyOn(extensionStore, 'set');
const extension1 = seInstance.use({
definition: SEClassExtension,
setupOptions: currentSetupOptions,
});
const extension2 = seInstance.use({
definition: SEClassExtension,
setupOptions: newSetupOptions,
});
expect(extensionStore.size).toBe(1);
expect(extensionStore.set).toHaveBeenCalledTimes(expectedCallTimes);
if (expectedCallTimes > 1) {
expect(extensionStore.set).toHaveBeenCalledWith('SEClassExtension', extension2);
} else {
expect(extensionStore.set).toHaveBeenCalledWith('SEClassExtension', extension1);
}
},
);
});
});
describe('unuse', () => {
it.each`
unuseExtension | thrownError
${undefined} | ${EDITOR_EXTENSION_NOT_SPECIFIED_FOR_UNUSE_ERROR}
${''} | ${EDITOR_EXTENSION_NOT_SPECIFIED_FOR_UNUSE_ERROR}
${{}} | ${sprintf(EDITOR_EXTENSION_NOT_REGISTERED_ERROR, { name: '' })}
${[]} | ${EDITOR_EXTENSION_NOT_SPECIFIED_FOR_UNUSE_ERROR}
`(
`Should throw "${EDITOR_EXTENSION_NOT_SPECIFIED_FOR_UNUSE_ERROR}" when extension is "$unuseExtension"`,
({ unuseExtension, thrownError }) => {
seInstance = new SourceEditorInstance();
const unuse = () => {
seInstance.unuse(unuseExtension);
};
expect(unuse).toThrowError(thrownError);
},
);
it.each`
initExtensions | unuseExtensionIndex | remainingAPI
${{ definition: SEClassExtension }} | ${0} | ${[]}
${{ definition: SEFnExtension }} | ${0} | ${[]}
${{ definition: SEConstExt }} | ${0} | ${[]}
${fullExtensionsArray} | ${0} | ${['fnExtMethod', 'constExtMethod']}
${fullExtensionsArray} | ${1} | ${['shared', 'classExtMethod', 'constExtMethod']}
${fullExtensionsArray} | ${2} | ${['shared', 'classExtMethod', 'fnExtMethod']}
`(
'un-registers properties introduced by single extension $unuseExtension',
({ initExtensions, unuseExtensionIndex, remainingAPI }) => {
seInstance = new SourceEditorInstance();
const extensions = seInstance.use(initExtensions);
if (Array.isArray(initExtensions)) {
seInstance.unuse(extensions[unuseExtensionIndex]);
} else {
seInstance.unuse(extensions);
}
expect(seInstance.extensionsAPI).toEqual(remainingAPI);
},
);
it.each`
unuseExtensionIndex | remainingAPI
${[0, 1]} | ${['constExtMethod']}
${[0, 2]} | ${['fnExtMethod']}
${[1, 2]} | ${['shared', 'classExtMethod']}
`(
'un-registers properties introduced by multiple extensions $unuseExtension',
({ unuseExtensionIndex, remainingAPI }) => {
seInstance = new SourceEditorInstance();
const extensions = seInstance.use(fullExtensionsArray);
const extensionsToUnuse = extensions.filter((ext, index) =>
unuseExtensionIndex.includes(index),
);
seInstance.unuse(extensionsToUnuse);
expect(seInstance.extensionsAPI).toEqual(remainingAPI);
},
);
it('it does not remove entry from the global registry to keep for potential future re-use', () => {
const extensionStore = new Map();
seInstance = new SourceEditorInstance({}, extensionStore);
const extensions = seInstance.use(fullExtensionsArray);
const verifyExpectations = () => {
const entries = extensionStore.entries();
const mockExtensions = ['SEClassExtension', 'SEFnExtension', 'SEConstExt'];
expect(extensionStore.size).toBe(mockExtensions.length);
mockExtensions.forEach((ext, index) => {
expect(entries.next().value).toEqual([ext, extensions[index]]);
});
};
verifyExpectations();
seInstance.unuse(extensions);
verifyExpectations();
});
});
describe('updateModelLanguage', () => {
let instanceModel;
beforeEach(() => {
instanceModel = monacoEditor.createModel('');
seInstance = new SourceEditorInstance({
getModel: () => instanceModel,
});
});
it.each`
path | expectedLanguage
${'foo.js'} | ${'javascript'}
${'foo.md'} | ${'markdown'}
${'foo.rb'} | ${'ruby'}
${''} | ${'plaintext'}
${undefined} | ${'plaintext'}
${'test.nonexistingext'} | ${'plaintext'}
`(
'changes language of an attached model to "$expectedLanguage" when filepath is "$path"',
({ path, expectedLanguage }) => {
seInstance.updateModelLanguage(path);
expect(instanceModel.getLanguageIdentifier().language).toBe(expectedLanguage);
},
);
});
describe('extensions life-cycle callbacks', () => {
const onSetup = jest.fn().mockImplementation(() => {});
const onUse = jest.fn().mockImplementation(() => {});
const onBeforeUnuse = jest.fn().mockImplementation(() => {});
const onUnuse = jest.fn().mockImplementation(() => {});
const MyFullExtWithCallbacks = () => {
return {
onSetup,
onUse,
onBeforeUnuse,
onUnuse,
};
};
it('passes correct arguments to callback fns when using an extension', () => {
seInstance = new SourceEditorInstance();
seInstance.use({
definition: MyFullExtWithCallbacks,
setupOptions: defSetupOptions,
});
expect(onSetup).toHaveBeenCalledWith(seInstance, defSetupOptions);
expect(onUse).toHaveBeenCalledWith(seInstance);
});
it('passes correct arguments to callback fns when un-using an extension', () => {
seInstance = new SourceEditorInstance();
const extension = seInstance.use({
definition: MyFullExtWithCallbacks,
setupOptions: defSetupOptions,
});
seInstance.unuse(extension);
expect(onBeforeUnuse).toHaveBeenCalledWith(seInstance);
expect(onUnuse).toHaveBeenCalledWith(seInstance);
});
});
});
});
|