| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- 'use strict';
- import moduleUtils from '/tests/_utils/module.js';
- import testUtils from '/tests/_utils/utils.js';
- import Editor from '/ckeditor5/core/editor.js';
- import PluginCollection from '/ckeditor5/core/plugincollection.js';
- import Plugin from '/ckeditor5/core/plugin.js';
- import Creator from '/ckeditor5/core/creator.js';
- import CKEditorError from '/ckeditor5/utils/ckeditorerror.js';
- import log from '/ckeditor5/utils/log.js';
- let editor;
- let PluginA, PluginB, PluginC, PluginD, PluginE, PluginF, PluginG;
- class TestError extends Error {}
- testUtils.createSinonSandbox();
- before( () => {
- PluginA = createPlugin( 'A' );
- PluginB = createPlugin( 'B' );
- PluginC = createPlugin( 'C' );
- PluginD = createPlugin( 'D' );
- PluginE = createPlugin( 'E' );
- PluginF = createPlugin( 'F' );
- PluginG = createPlugin( 'G', Creator );
- PluginC.requires = [ PluginB ];
- PluginD.requires = [ PluginA, PluginC ];
- PluginF.requires = [ PluginE ];
- PluginE.requires = [ PluginF ];
- editor = new Editor( document.body.appendChild( document.createElement( 'div' ) ) );
- } );
- // Create fake plugins that will be used on tests.
- moduleUtils.define( 'A', () => {
- return PluginA;
- } );
- moduleUtils.define( 'B', () => {
- return PluginB;
- } );
- moduleUtils.define( 'C', [ 'core/editor', 'B' ], () => {
- return PluginC;
- } );
- moduleUtils.define( 'D', [ 'core/editor', 'A', 'C' ], () => {
- return PluginD;
- } );
- moduleUtils.define( 'E', [ 'core/editor', 'F' ], () => {
- return PluginE;
- } );
- moduleUtils.define( 'F', [ 'core/editor', 'E' ], () => {
- return PluginF;
- } );
- moduleUtils.define( 'G', () => {
- return PluginG;
- } );
- // Erroneous cases.
- moduleUtils.define( 'X', () => {
- throw new TestError( 'Some error inside a plugin' );
- } );
- moduleUtils.define( 'Y', () => {
- return class {};
- } );
- /////////////
- describe( 'load', () => {
- it( 'should not fail when trying to load 0 plugins (empty array)', () => {
- let plugins = new PluginCollection( editor );
- return plugins.load( [] )
- .then( () => {
- expect( getPlugins( plugins ) ).to.be.empty();
- } );
- } );
- it( 'should add collection items for loaded plugins', () => {
- let plugins = new PluginCollection( editor );
- return plugins.load( [ 'A', 'B' ] )
- .then( () => {
- expect( getPlugins( plugins ).length ).to.equal( 2 );
- expect( plugins.get( PluginA ) ).to.be.an.instanceof( PluginA );
- expect( plugins.get( PluginB ) ).to.be.an.instanceof( PluginB );
- expect( plugins.get( 'A' ) ).to.be.an.instanceof( PluginA );
- expect( plugins.get( 'B' ) ).to.be.an.instanceof( PluginB );
- } );
- } );
- it( 'should load dependency plugins', () => {
- let plugins = new PluginCollection( editor );
- let spy = sinon.spy( plugins, '_add' );
- return plugins.load( [ 'A', 'C' ] )
- .then( ( loadedPlugins ) => {
- expect( getPlugins( plugins ).length ).to.equal( 3 );
- expect( getPluginNames( getPluginsFromSpy( spy ) ) )
- .to.deep.equal( [ 'A', 'B', 'C' ], 'order by plugins._add()' );
- expect( getPluginNames( loadedPlugins ) )
- .to.deep.equal( [ 'A', 'B', 'C' ], 'order by returned value' );
- } );
- } );
- it( 'should be ok when dependencies are loaded first', () => {
- let plugins = new PluginCollection( editor );
- let spy = sinon.spy( plugins, '_add' );
- return plugins.load( [ 'A', 'B', 'C' ] )
- .then( ( loadedPlugins ) => {
- expect( getPlugins( plugins ).length ).to.equal( 3 );
- expect( getPluginNames( getPluginsFromSpy( spy ) ) )
- .to.deep.equal( [ 'A', 'B', 'C' ], 'order by plugins._add()' );
- expect( getPluginNames( loadedPlugins ) )
- .to.deep.equal( [ 'A', 'B', 'C' ], 'order by returned value' );
- } );
- } );
- it( 'should load deep dependency plugins', () => {
- let plugins = new PluginCollection( editor );
- let spy = sinon.spy( plugins, '_add' );
- return plugins.load( [ 'D' ] )
- .then( ( loadedPlugins ) => {
- expect( getPlugins( plugins ).length ).to.equal( 4 );
- // The order must have dependencies first.
- expect( getPluginNames( getPluginsFromSpy( spy ) ) )
- .to.deep.equal( [ 'A', 'B', 'C', 'D' ], 'order by plugins._add()' );
- expect( getPluginNames( loadedPlugins ) )
- .to.deep.equal( [ 'A', 'B', 'C', 'D' ], 'order by returned value' );
- } );
- } );
- it( 'should handle cross dependency plugins', () => {
- let plugins = new PluginCollection( editor );
- let spy = sinon.spy( plugins, '_add' );
- return plugins.load( [ 'A', 'E' ] )
- .then( ( loadedPlugins ) => {
- expect( getPlugins( plugins ).length ).to.equal( 3 );
- // The order must have dependencies first.
- expect( getPluginNames( getPluginsFromSpy( spy ) ) )
- .to.deep.equal( [ 'A', 'F', 'E' ], 'order by plugins._add()' );
- expect( getPluginNames( loadedPlugins ) )
- .to.deep.equal( [ 'A', 'F', 'E' ], 'order by returned value' );
- } );
- } );
- it( 'should load grand child classes', () => {
- let plugins = new PluginCollection( editor );
- return plugins.load( [ 'G' ] )
- .then( () => {
- expect( getPlugins( plugins ).length ).to.equal( 1 );
- } );
- } );
- it( 'should set the `editor` property on loaded plugins', () => {
- let plugins = new PluginCollection( editor );
- return plugins.load( [ 'A', 'B' ] )
- .then( () => {
- expect( plugins.get( 'A' ).editor ).to.equal( editor );
- expect( plugins.get( 'B' ).editor ).to.equal( editor );
- } );
- } );
- it( 'should reject on invalid plugin names (forward require.js loading error)', () => {
- let logSpy = testUtils.sinon.stub( log, 'error' );
- let plugins = new PluginCollection( editor );
- return plugins.load( [ 'A', 'BAD', 'B' ] )
- // Throw here, so if by any chance plugins.load() was resolved correctly catch() will be stil executed.
- .then( () => {
- throw new Error( 'Test error: this promise should not be resolved successfully' );
- } )
- .catch( ( err ) => {
- expect( err ).to.be.an.instanceof( Error );
- // Make sure it's the Require.JS error, not the one thrown above.
- expect( err.message ).to.match( /^Script error for/ );
- sinon.assert.calledOnce( logSpy );
- expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^plugincollection-load:/ );
- } );
- } );
- it( 'should reject on broken plugins (forward the error thrown in a plugin)', () => {
- let logSpy = testUtils.sinon.stub( log, 'error' );
- let plugins = new PluginCollection( editor );
- return plugins.load( [ 'A', 'X', 'B' ] )
- // Throw here, so if by any chance plugins.load() was resolved correctly catch() will be stil executed.
- .then( () => {
- throw new Error( 'Test error: this promise should not be resolved successfully' );
- } )
- .catch( ( err ) => {
- expect( err ).to.be.an.instanceof( TestError );
- expect( err ).to.have.property( 'message', 'Some error inside a plugin' );
- sinon.assert.calledOnce( logSpy );
- expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^plugincollection-load:/ );
- } );
- } );
- it( 'should reject when loading a module which is not a plugin', () => {
- let logSpy = testUtils.sinon.stub( log, 'error' );
- let plugins = new PluginCollection( editor );
- return plugins.load( [ 'Y' ] )
- // Throw here, so if by any chance plugins.load() was resolved correctly catch() will be stil executed.
- .then( () => {
- throw new Error( 'Test error: this promise should not be resolved successfully' );
- } )
- .catch( ( err ) => {
- expect( err ).to.be.an.instanceof( CKEditorError );
- expect( err.message ).to.match( /^plugincollection-instance/ );
- sinon.assert.calledOnce( logSpy );
- expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^plugincollection-load:/ );
- } );
- } );
- } );
- describe( 'getPluginPath()', () => {
- it( 'generates path for modules within some package', () => {
- const p = PluginCollection.getPluginPath( 'some/ba' );
- expect( p ).to.equal( 'ckeditor5/some/ba.js' );
- } );
- it( 'generates path from simplified feature name', () => {
- const p = PluginCollection.getPluginPath( 'foo' );
- expect( p ).to.equal( 'ckeditor5/foo/foo.js' );
- } );
- } );
- function createPlugin( name, baseClass ) {
- baseClass = baseClass || Plugin;
- const P = class extends baseClass {
- constructor( editor ) {
- super( editor );
- this._pluginName = name;
- }
- };
- P._pluginName = name;
- return P;
- }
- function getPlugins( pluginCollection ) {
- const plugins = [];
- for ( let entry of pluginCollection ) {
- // Keep only plugins kept under their classes.
- if ( typeof entry[ 0 ] == 'function' ) {
- plugins.push( entry[ 1 ] );
- }
- }
- return plugins;
- }
- function getPluginsFromSpy( addSpy ) {
- return addSpy.args
- .map( ( arg ) => arg[ 0 ] )
- // Entries may be kept twice in the plugins map - once as a pluginName => plugin, once as pluginClass => plugin.
- // Return only pluginClass => plugin entries as these will always represent all plugins.
- .filter( ( plugin ) => typeof plugin == 'function' );
- }
- function getPluginNames( plugins ) {
- return plugins.map( ( plugin ) => plugin._pluginName );
- }
|