| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals setTimeout, window, console, document */
- import Watchdog from '../src/watchdog';
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- describe( 'Watchdog', () => {
- let element;
- beforeEach( () => {
- element = document.createElement( 'div' );
- document.body.appendChild( element );
- } );
- afterEach( () => {
- element.remove();
- sinon.restore();
- } );
- describe( 'create()', () => {
- it( 'should create an editor instance', () => {
- const watchdog = new Watchdog();
- const editorCreateSpy = sinon.spy( ClassicTestEditor, 'create' );
- const editorDestroySpy = sinon.spy( ClassicTestEditor.prototype, 'destroy' );
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- return watchdog.create( element, {} )
- .then( () => {
- sinon.assert.calledOnce( editorCreateSpy );
- sinon.assert.notCalled( editorDestroySpy );
- return watchdog.destroy();
- } )
- .then( () => {
- sinon.assert.calledOnce( editorCreateSpy );
- sinon.assert.calledOnce( editorDestroySpy );
- } );
- } );
- it( 'should throw an error when the creator is not defined', () => {
- const watchdog = new Watchdog();
- watchdog.setDestructor( editor => editor.destroy() );
- expectToThrowCKEditorError(
- () => watchdog.create(),
- /^watchdog-creator-not-defined/,
- null
- );
- } );
- it( 'should throw an error when the destructor is not defined', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- expectToThrowCKEditorError(
- () => watchdog.create(),
- /^watchdog-destructor-not-defined/,
- null
- );
- } );
- it( 'should properly copy the config', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- const config = {
- foo: [],
- bar: document.createElement( 'div' )
- };
- return watchdog.create( element, config ).then( () => {
- expect( watchdog.editor.config._config.foo ).to.not.equal( config.foo );
- expect( watchdog.editor.config._config.bar ).to.equal( config.bar );
- } );
- } );
- it( 'should support editor data passed as the first argument', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( data, config ) => ClassicTestEditor.create( data, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- const windowErrorSpy = sinon.spy();
- window.onerror = windowErrorSpy;
- return watchdog.create( '<p>foo</p>', { plugins: [ Paragraph ] } )
- .then( () => {
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p>' );
- return new Promise( res => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- res();
- } );
- } );
- } )
- .then( () => {
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p>' );
- return watchdog.destroy();
- } );
- } );
- } );
- describe( 'editor', () => {
- it( 'should be the current editor instance', () => {
- const watchdog = Watchdog.for( ClassicTestEditor );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- const windowErrorSpy = sinon.spy();
- window.onerror = windowErrorSpy;
- expect( watchdog.editor ).to.be.null;
- let oldEditor;
- return watchdog.create( element, {} )
- .then( () => {
- oldEditor = watchdog.editor;
- expect( watchdog.editor ).to.be.instanceOf( ClassicTestEditor );
- return new Promise( res => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- res();
- } );
- } );
- } )
- .then( () => {
- expect( watchdog.editor ).to.be.instanceOf( ClassicTestEditor );
- expect( watchdog.editor ).to.not.equal( oldEditor );
- return watchdog.destroy();
- } )
- .then( () => {
- expect( watchdog.editor ).to.be.null;
- } );
- } );
- } );
- describe( 'error handling', () => {
- it( 'Watchdog should not restart editor during the initialization', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( el =>
- ClassicTestEditor.create( el )
- .then( () => Promise.reject( new Error( 'foo' ) ) )
- );
- watchdog.setDestructor( editor => editor.destroy() );
- return watchdog.create( element ).then(
- () => { throw new Error( '`watchdog.create()` should throw an error.' ); },
- err => {
- expect( err ).to.be.instanceOf( Error );
- expect( err.message ).to.equal( 'foo' );
- }
- );
- } );
- it( 'Watchdog should not restart editor during the destroy', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( el => ClassicTestEditor.create( el ) );
- watchdog.setDestructor( () => Promise.reject( new Error( 'foo' ) ) );
- return Promise.resolve()
- .then( () => watchdog.create( element ) )
- .then( () => watchdog.destroy() )
- .then(
- () => { throw new Error( '`watchdog.create()` should throw an error.' ); },
- err => {
- expect( err ).to.be.instanceOf( Error );
- expect( err.message ).to.equal( 'foo' );
- }
- );
- } );
- it( 'Watchdog should not hide intercepted errors', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- const windowErrorSpy = sinon.spy();
- window.onerror = windowErrorSpy;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- sinon.assert.calledOnce( windowErrorSpy );
- // Various browsers will display the error slightly differently.
- expect( windowErrorSpy.getCall( 0 ).args[ 0 ] ).to.match( /foo/ );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should intercept editor errors and restart the editor during the runtime', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should not intercept non-editor errors', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- const editorErrorSpy = sinon.spy();
- watchdog.on( 'error', editorErrorSpy );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => {
- throw new Error( 'foo' );
- } );
- return new Promise( res => {
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- sinon.assert.notCalled( editorErrorSpy );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should not intercept other editor errors', () => {
- const watchdog1 = Watchdog.for( ClassicTestEditor );
- const watchdog2 = Watchdog.for( ClassicTestEditor );
- const config = {
- plugins: []
- };
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return Promise.all( [
- watchdog1.create( element, config ),
- watchdog2.create( element, config )
- ] ).then( () => {
- return new Promise( res => {
- const watchdog1ErrorSpy = sinon.spy();
- const watchdog2ErrorSpy = sinon.spy();
- watchdog1.on( 'restart', watchdog1ErrorSpy );
- watchdog2.on( 'restart', watchdog2ErrorSpy );
- setTimeout( () => throwCKEditorError( 'foo', watchdog2.editor ) );
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- sinon.assert.notCalled( watchdog1ErrorSpy );
- sinon.assert.calledOnce( watchdog2ErrorSpy );
- Promise.all( [ watchdog1.destroy(), watchdog2.destroy() ] )
- .then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should intercept editor errors and restart the editor if the editor can be found from the context', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor.model.document ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should intercept editor errors and restart the editor if the editor can be found from the context #2', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', {
- foo: [ 1, 2, 3, {
- bar: new Set( [
- new Map( [
- [ 'foo', 'bar' ],
- [ 0, watchdog.editor ]
- ] )
- ] )
- } ]
- } ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should crash permanently if the `crashNumberLimit` is reached' +
- ' and the average time between errors is lower than `minimumNonErrorTimePeriod` (default values)', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- const errorSpy = sinon.spy();
- watchdog.on( 'error', errorSpy );
- const restartSpy = sinon.spy();
- watchdog.on( 'restart', restartSpy );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo1', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'foo2', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'foo3', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'foo4', watchdog.editor ) );
- return new Promise( res => {
- setTimeout( () => {
- expect( errorSpy.callCount ).to.equal( 4 );
- expect( watchdog.crashes.length ).to.equal( 4 );
- expect( restartSpy.callCount ).to.equal( 3 );
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should crash permanently if the `crashNumberLimit` is reached' +
- ' and the average time between errors is lower than `minimumNonErrorTimePeriod` (custom values)', () => {
- const watchdog = new Watchdog( { crashNumberLimit: 2, minimumNonErrorTimePeriod: 1000 } );
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- const errorSpy = sinon.spy();
- watchdog.on( 'error', errorSpy );
- const restartSpy = sinon.spy();
- watchdog.on( 'restart', restartSpy );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo1', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'foo2', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'foo3', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'foo4', watchdog.editor ) );
- return new Promise( res => {
- setTimeout( () => {
- expect( errorSpy.callCount ).to.equal( 3 );
- expect( watchdog.crashes.length ).to.equal( 3 );
- expect( restartSpy.callCount ).to.equal( 2 );
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should not crash permantently when average time between errors is longer than `minimumNonErrorTimePeriod`', () => {
- const watchdog = new Watchdog( { crashNumberLimit: 2, minimumNonErrorTimePeriod: 0 } );
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- const errorSpy = sinon.spy();
- watchdog.on( 'error', errorSpy );
- const restartSpy = sinon.spy();
- watchdog.on( 'restart', restartSpy );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo1', watchdog.editor ), 5 );
- setTimeout( () => throwCKEditorError( 'foo2', watchdog.editor ), 10 );
- setTimeout( () => throwCKEditorError( 'foo3', watchdog.editor ), 15 );
- setTimeout( () => throwCKEditorError( 'foo4', watchdog.editor ), 20 );
- return new Promise( res => {
- setTimeout( () => {
- expect( errorSpy.callCount ).to.equal( 4 );
- expect( watchdog.crashes.length ).to.equal( 4 );
- expect( restartSpy.callCount ).to.equal( 4 );
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( res );
- }, 20 );
- } );
- } );
- } );
- it( 'Watchdog should warn if the CKEditorError missing its context', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- sinon.stub( console, 'error' );
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo' ) );
- return new Promise( res => {
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.crashes ).to.deep.equal( [] );
- sinon.assert.calledWithExactly(
- console.error,
- 'The error is missing its context and Watchdog cannot restart the proper editor.'
- );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'Watchdog should omit error if the CKEditorError context is equal to null', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- sinon.stub( console, 'error' );
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', null ) );
- return new Promise( res => {
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.crashes ).to.deep.equal( [] );
- sinon.assert.notCalled( console.error );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'editor should be restarted with the data before the crash #1', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element, {
- initialData: '<p>foo</p>',
- plugins: [ Paragraph ]
- } ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p>' );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'editor should be restarted with the data before the crash #2', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element, {
- initialData: '<p>foo</p>',
- plugins: [ Paragraph ]
- } ).then( () => {
- const doc = watchdog.editor.model.document;
- watchdog.editor.model.change( writer => {
- writer.insertText( 'bar', writer.createPositionAt( doc.getRoot(), 1 ) );
- } );
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p><p>bar</p>' );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'editor should be restarted with the data of the latest document version before the crash', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element, {
- initialData: '<p>foo</p>',
- plugins: [ Paragraph ]
- } ).then( () => {
- const model = watchdog.editor.model;
- const doc = model.document;
- // Decrement the document version to simulate a situation when an operation
- // don't produce new document version.
- doc.version--;
- model.change( writer => {
- writer.insertText( 'bar', writer.createPositionAt( doc.getRoot(), 1 ) );
- } );
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p>' );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- it( 'editor should be restarted with the latest available data before the crash', () => {
- const watchdog = new Watchdog();
- watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
- watchdog.setDestructor( editor => editor.destroy() );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- sinon.stub( console, 'error' );
- return watchdog.create( element, {
- initialData: '<p>foo</p>',
- plugins: [ Paragraph ]
- } ).then( () => {
- const editorGetDataError = new Error( 'Some error' );
- const getDataStub = sinon.stub( watchdog.editor.data, 'get' )
- .throwsException( editorGetDataError );
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- const doc = watchdog.editor.model.document;
- watchdog.editor.model.change( writer => {
- writer.insertText( 'bar', writer.createPositionAt( doc.getRoot(), 1 ) );
- } );
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- // It is called second time by during the default editor destruction
- // to update the source element.
- sinon.assert.calledTwice( getDataStub );
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p>' );
- sinon.assert.calledWith(
- console.error,
- editorGetDataError,
- 'An error happened during restoring editor data. Editor will be restored from the previously saved data.'
- );
- sinon.assert.calledWith(
- console.error,
- 'An error happened during the editor destructing.'
- );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- } );
- describe( 'destroy()', () => {
- // See #19.
- it( 'should clean internal stuff', () => {
- // 30ms should be enough to make the two data changes split into two data save actions.
- // This will ensure that the second data save action will be put off in time.
- const SAVE_INTERVAL = 30;
- const watchdog = Watchdog.for( ClassicTestEditor, {
- saveInterval: SAVE_INTERVAL,
- } );
- return watchdog.create( element, {
- initialData: '<p>foo</p>',
- plugins: [ Paragraph ]
- } ).then( () => {
- const doc = watchdog.editor.model.document;
- watchdog.editor.model.change( writer => {
- writer.insertText( 'bar', writer.createPositionAt( doc.getRoot(), 1 ) );
- } );
- watchdog.editor.model.change( writer => {
- writer.insertText( 'foo', writer.createPositionAt( doc.getRoot(), 1 ) );
- } );
- } ).then( () => {
- return watchdog.destroy();
- } ).then( () => {
- // Wait to ensure that the throttled save is cleared and won't be executed
- // on the non-existing editor.
- return new Promise( res => setTimeout( res, SAVE_INTERVAL ) );
- } ).then( () => {
- expect( watchdog.editor ).to.equal( null );
- expect( watchdog.state ).to.equal( 'destroyed' );
- expect( watchdog.crashes ).to.deep.equal( [] );
- } );
- } );
- } );
- describe( 'static for()', () => {
- it( 'should be a shortcut method for creating the watchdog', () => {
- const watchdog = Watchdog.for( ClassicTestEditor );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element, {
- initialData: '<p>foo</p>',
- plugins: [ Paragraph ]
- } ).then( () => {
- const oldEditor = watchdog.editor;
- expect( watchdog.editor ).to.be.an.instanceOf( ClassicTestEditor );
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- return new Promise( res => {
- watchdog.on( 'restart', () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.editor ).to.be.an.instanceOf( ClassicTestEditor );
- expect( watchdog.editor ).to.not.equal( oldEditor );
- expect( watchdog.editor.getData() ).to.equal( '<p>foo</p>' );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- } );
- describe( 'crashes', () => {
- it( 'should be an array of caught errors by the watchdog', () => {
- const watchdog = Watchdog.for( ClassicTestEditor );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'bar', watchdog.editor ) );
- return new Promise( res => {
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.crashes[ 0 ].message ).to.equal( 'foo' );
- expect( watchdog.crashes[ 1 ].message ).to.equal( 'bar' );
- watchdog.destroy().then( res );
- } );
- } );
- } );
- } );
- } );
- describe( 'state', () => {
- it( 'should reflect the state of the watchdog', () => {
- const watchdog = Watchdog.for( ClassicTestEditor );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- expect( watchdog.state ).to.equal( 'initializing' );
- return watchdog.create( element ).then( () => {
- expect( watchdog.state ).to.equal( 'ready' );
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'bar', watchdog.editor ) );
- return new Promise( res => {
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- expect( watchdog.state ).to.equal( 'ready' );
- watchdog.destroy().then( () => {
- expect( watchdog.state ).to.equal( 'destroyed' );
- res();
- } );
- } );
- } );
- } );
- } );
- } );
- it( 'should be observable', () => {
- const watchdog = Watchdog.for( ClassicTestEditor );
- const states = [];
- watchdog.on( 'change:state', ( evt, propName, newValue ) => {
- states.push( newValue );
- } );
- // sinon.stub( window, 'onerror' ).value( undefined ); and similar do not work.
- const originalErrorHandler = window.onerror;
- window.onerror = undefined;
- return watchdog.create( element ).then( () => {
- return watchdog.create( element ).then( () => {
- setTimeout( () => throwCKEditorError( 'foo', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'bar', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'baz', watchdog.editor ) );
- setTimeout( () => throwCKEditorError( 'biz', watchdog.editor ) );
- return new Promise( res => {
- setTimeout( () => {
- window.onerror = originalErrorHandler;
- watchdog.destroy().then( () => {
- expect( states ).to.deep.equal( [
- 'ready',
- 'crashed',
- 'initializing',
- 'ready',
- 'crashed',
- 'initializing',
- 'ready',
- 'crashed',
- 'initializing',
- 'ready',
- 'crashed',
- 'crashedPermanently',
- 'destroyed'
- ] );
- res();
- } );
- } );
- } );
- } );
- } );
- } );
- } );
- } );
- function throwCKEditorError( name, context ) {
- throw new CKEditorError( name, context );
- }
|