Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Merge pull request #26 from ckeditor/t/21
Browse files Browse the repository at this point in the history 
Other: Made the Watchdog#setDestructor() method optional and default to editor => editor.destroy(). Closes #21.
  • Loading branch information
Piotr Jasiun committed Oct 2, 2019
2 parents 05d2b54 + 9dc0cb8 commit 5a9dc0c
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 42 deletions.
6 changes: 5 additions & 1 deletion docs/features/watchdog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In other words, your goal is to create a watchdog instance and make the watchdog

### Controlling editor creation and destruction

For more control over the creation and destruction of editor instances, you can use the {@link module:watchdog/watchdog~Watchdog#setCreator `Watchdog#setCreator()`} and {@link module:watchdog/watchdog~Watchdog#setDestructor `Watchdog#setDestructor()`} methods:
For more control over the creation and destruction of editor instances, you can use the {@link module:watchdog/watchdog~Watchdog#setCreator `Watchdog#setCreator()`} and, if needed, the {@link module:watchdog/watchdog~Watchdog#setDestructor `Watchdog#setDestructor()`} methods:

```js
// Instantiate the watchdog manually (do not use the for() helper).
Expand All @@ -81,6 +81,10 @@ watchdog.setDestructor( editor => {
watchdog.create( elementOrData, editorConfig );
```

<info-box>
The default (not overridden) editor destructor is the `editor => editor.destroy()` function.
</info-box>

### API

Other useful {@link module:watchdog/watchdog~Watchdog methods, properties and events}:
Expand Down
27 changes: 11 additions & 16 deletions src/watchdog.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ export default class Watchdog {
* @member {Function} #_destructor
* @see #setDestructor
*/
this._destructor = editor => editor.destroy();

/**
* The latest saved editor data represented as a root name -> root data object.
Expand Down Expand Up @@ -189,9 +190,18 @@ export default class Watchdog {

/**
* Sets the function that is responsible for the editor destruction.
* Overrides the default destruction function, which destroys only the editor instance.
* It expects a function that should return a promise or `undefined`.
*
* watchdog.setDestructor( editor => editor.destroy() );
* watchdog.setDestructor( editor => {
* // Do something before the editor is destroyed.
*
* return editor
* .destroy()
* .then( () => {
* // Do something after the editor is destroyed.
* } );
* } );
*
* @param {Function} destructor
*/
Expand Down Expand Up @@ -223,20 +233,6 @@ export default class Watchdog {
);
}

if ( !this._destructor ) {
/**
* The watchdog's editor destructor is not defined. Define it by using
* {@link module:watchdog/watchdog~Watchdog#setDestructor `Watchdog#setDestructor()`} or
* the {@link module:watchdog/watchdog~Watchdog.for `Watchdog.for()`} helper.
*
* @error watchdog-destructor-not-defined
*/
throw new CKEditorError(
'watchdog-destructor-not-defined: The watchdog\'s editor destructor is not defined.',
null
);
}

this._elementOrData = elementOrData;

// Clone configuration because it might be shared within multiple watchdog instances. Otherwise,
Expand Down Expand Up @@ -473,7 +469,6 @@ export default class Watchdog {
const watchdog = new Watchdog( watchdogConfig );

watchdog.setCreator( ( elementOrData, config ) => Editor.create( elementOrData, config ) );
watchdog.setDestructor( editor => editor.destroy() );

return watchdog;
}
Expand Down
56 changes: 31 additions & 25 deletions tests/watchdog.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ describe( 'Watchdog', () => {
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( () => {
Expand All @@ -51,7 +50,6 @@ describe( 'Watchdog', () => {

it( 'should throw an error when the creator is not defined', () => {
const watchdog = new Watchdog();
watchdog.setDestructor( editor => editor.destroy() );

expectToThrowCKEditorError(
() => watchdog.create(),
Expand All @@ -60,21 +58,16 @@ describe( 'Watchdog', () => {
);
} );

it( 'should throw an error when the destructor is not defined', () => {
it( 'should not 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
);
expect( () => watchdog.create() ).to.not.throw();
} );

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: [],
Expand All @@ -91,7 +84,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -166,7 +158,6 @@ describe( 'Watchdog', () => {
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.' ); },
Expand Down Expand Up @@ -199,7 +190,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -228,7 +218,6 @@ describe( 'Watchdog', () => {
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;
Expand All @@ -251,7 +240,6 @@ describe( 'Watchdog', () => {
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 );
Expand Down Expand Up @@ -322,7 +310,6 @@ describe( 'Watchdog', () => {
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;
Expand All @@ -345,7 +332,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -378,7 +364,6 @@ describe( 'Watchdog', () => {
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 );
Expand Down Expand Up @@ -415,7 +400,6 @@ describe( 'Watchdog', () => {
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 );
Expand Down Expand Up @@ -451,7 +435,6 @@ describe( 'Watchdog', () => {
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 );
Expand Down Expand Up @@ -487,7 +470,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -519,7 +501,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -547,7 +528,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -575,7 +555,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -609,7 +588,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -648,7 +626,6 @@ describe( 'Watchdog', () => {
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;
Expand Down Expand Up @@ -698,6 +675,35 @@ describe( 'Watchdog', () => {
} );
} );
} );

it( 'should use the custom destructor if passed', () => {
const watchdog = new Watchdog();
const destructionSpy = sinon.spy();

watchdog.setCreator( ( el, config ) => ClassicTestEditor.create( el, config ) );
watchdog.setDestructor( editor => {
destructionSpy();
return 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;

sinon.assert.calledOnce( destructionSpy );

watchdog.destroy().then( res );
} );
} );
} );
} );
} );

describe( 'async error handling', () => {
Expand Down

0 comments on commit 5a9dc0c

Please sign in to comment.