| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /**
- * @module engine/dev-utils/enableenginedebug
- */
- /* global console */
- import OperationReplayer from './operationreplayer';
- import ModelPosition from '../model/position';
- import ModelRange from '../model/range';
- import ModelText from '../model/text';
- import ModelTextProxy from '../model/textproxy';
- import ModelElement from '../model/element';
- import Operation from '../model/operation/operation';
- import AttributeOperation from '../model/operation/attributeoperation';
- import DetachOperation from '../model/operation/detachoperation';
- import InsertOperation from '../model/operation/insertoperation';
- import MarkerOperation from '../model/operation/markeroperation';
- import MoveOperation from '../model/operation/moveoperation';
- import NoOperation from '../model/operation/nooperation';
- import RenameOperation from '../model/operation/renameoperation';
- import RootAttributeOperation from '../model/operation/rootattributeoperation';
- import SplitOperation from '../model/operation/splitoperation';
- import MergeOperation from '../model/operation/mergeoperation';
- import Model from '../model/model';
- import ModelDocument from '../model/document';
- import ModelDocumentFragment from '../model/documentfragment';
- import ModelRootElement from '../model/rootelement';
- import ViewDocument from '../view/document';
- import ViewElement from '../view/element';
- import ViewText from '../view/text';
- import ViewTextProxy from '../view/textproxy';
- import ViewDocumentFragment from '../view/documentfragment';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
- // Sandbox class allows creating mocks of the functions and restoring these mocks to the original values.
- class Sandbox {
- constructor() {
- // An array that contains functions which restore the original values of mocked objects.
- // @private
- // @type {Array.<Function>}
- this._restores = [];
- }
- // Creates a new mock.
- //
- // @param {Object} object Object to mock.
- // @param {String} methodName Function to mock.
- // @param {Function} fakeMethod Function that will be executed.
- mock( object, methodName, fakeMethod ) {
- const originalMethod = object[ methodName ];
- object[ methodName ] = fakeMethod;
- this._restores.unshift( () => {
- if ( originalMethod ) {
- object[ methodName ] = originalMethod;
- } else {
- delete object[ methodName ];
- }
- } );
- }
- // Restores all mocked functions.
- restore() {
- for ( const restore of this._restores ) {
- restore();
- }
- this._restores = [];
- }
- }
- const sandbox = new Sandbox();
- const treeDump = Symbol( '_treeDump' );
- // Maximum number of stored states of model and view document.
- const maxTreeDumpLength = 20;
- // Separator used to separate stringified operations.
- const LOG_SEPARATOR = '-------';
- // Specified whether debug tools were already enabled.
- let enabled = false;
- // Logging function used to log debug messages.
- let logger = console;
- /**
- * Enhances model classes with logging methods. Returns a plugin that should be loaded in the editor to
- * enable debugging features.
- *
- * Every operation applied on {@link module:engine/model/document~Document model.Document} is logged.
- *
- * The following classes are expanded with `log` and meaningful `toString` methods:
- * * {@link module:engine/model/position~Position model.Position},
- * * {@link module:engine/model/range~Range model.Range},
- * * {@link module:engine/model/text~Text model.Text},
- * * {@link module:engine/model/element~Element model.Element},
- * * {@link module:engine/model/rootelement~RootElement model.RootElement},
- * * {@link module:engine/model/documentfragment~DocumentFragment model.DocumentFragment},
- * * {@link module:engine/model/document~Document model.Document},
- * * all {@link module:engine/model/operation/operation~Operation operations}
- * * {@link module:engine/view/element~Element view.Element},
- * * {@link module:engine/view/documentfragment~DocumentFragment view.DocumentFragment},
- * * {@link module:engine/view/document~Document view.Document}.
- *
- * Additionally, the following logging utility methods are added:
- * * {@link module:engine/model/text~Text model.Text} `logExtended`,
- * * {@link module:engine/model/element~Element model.Element} `logExtended`,
- * * {@link module:engine/model/element~Element model.Element} `logAll`.
- *
- * Additionally, the following classes are expanded with `logTree` and `printTree` methods:
- * * {@link module:engine/model/element~Element model.Element},
- * * {@link module:engine/model/documentfragment~DocumentFragment model.DocumentFragment},
- * * {@link module:engine/view/element~Element view.Element},
- * * {@link module:engine/view/documentfragment~DocumentFragment view.DocumentFragment}.
- *
- * Finally, the following methods are added to {@link module:core/editor/editor~Editor}: `logModel`, `logView`, `logDocuments`.
- * All those methods take one parameter, which is the version of the {@link module:engine/model/document~Document model document}
- * for which the model or view document state should be logged.
- *
- * @param {Object} [_logger] An object with functions used to log messages and errors. By default messages are logged to the console.
- * If specified, it is expected to have `log()` and `error()` methods.
- * @returns {module:engine/dev-utils/enableenginedebug~DebugPlugin} The plugin to be loaded into the editor.
- */
- export default function enableEngineDebug( _logger = console ) {
- logger = _logger;
- if ( !enabled ) {
- enabled = true;
- enableLoggingTools();
- enableDocumentTools();
- enableReplayerTools();
- }
- return DebugPlugin;
- }
- /**
- * Restores all methods that have been overwritten.
- */
- export function disableEngineDebug() {
- sandbox.restore();
- enabled = false;
- }
- function enableLoggingTools() {
- sandbox.mock( ModelPosition.prototype, 'toString', function() {
- return `${ this.root } [ ${ this.path.join( ', ' ) } ]`;
- } );
- sandbox.mock( ModelPosition.prototype, 'log', function() {
- logger.log( 'ModelPosition: ' + this );
- } );
- sandbox.mock( ModelRange.prototype, 'toString', function() {
- return `${ this.root } [ ${ this.start.path.join( ', ' ) } ] - [ ${ this.end.path.join( ', ' ) } ]`;
- } );
- sandbox.mock( ModelRange.prototype, 'log', function() {
- logger.log( 'ModelRange: ' + this );
- } );
- sandbox.mock( ModelText.prototype, 'toString', function() {
- return `#${ this.data }`;
- } );
- sandbox.mock( ModelText.prototype, 'logExtended', function() {
- logger.log( `ModelText: ${ this }, attrs: ${ mapString( this.getAttributes() ) }` );
- } );
- sandbox.mock( ModelText.prototype, 'log', function() {
- logger.log( 'ModelText: ' + this );
- } );
- sandbox.mock( ModelTextProxy.prototype, 'toString', function() {
- return `#${ this.data }`;
- } );
- sandbox.mock( ModelTextProxy.prototype, 'logExtended', function() {
- logger.log( `ModelTextProxy: ${ this }, attrs: ${ mapString( this.getAttributes() ) }` );
- } );
- sandbox.mock( ModelTextProxy.prototype, 'log', function() {
- logger.log( 'ModelTextProxy: ' + this );
- } );
- sandbox.mock( ModelElement.prototype, 'toString', function() {
- return `<${ this.rootName || this.name }>`;
- } );
- sandbox.mock( ModelElement.prototype, 'log', function() {
- logger.log( 'ModelElement: ' + this );
- } );
- sandbox.mock( ModelElement.prototype, 'logExtended', function() {
- logger.log( `ModelElement: ${ this }, ${ this.childCount } children, attrs: ${ mapString( this.getAttributes() ) }` );
- } );
- sandbox.mock( ModelElement.prototype, 'logAll', function() {
- logger.log( '--------------------' );
- this.logExtended();
- logger.log( 'List of children:' );
- for ( const child of this.getChildren() ) {
- child.log();
- }
- } );
- sandbox.mock( ModelElement.prototype, 'printTree', function( level = 0 ) {
- let string = '';
- string += '\t'.repeat( level ) + `<${ this.rootName || this.name }${ mapToTags( this.getAttributes() ) }>`;
- for ( const child of this.getChildren() ) {
- string += '\n';
- if ( child.is( 'text' ) ) {
- const textAttrs = mapToTags( child._attrs );
- string += '\t'.repeat( level + 1 );
- if ( textAttrs !== '' ) {
- string += `<$text${ textAttrs }>` + child.data + '</$text>';
- } else {
- string += child.data;
- }
- } else {
- string += child.printTree( level + 1 );
- }
- }
- if ( this.childCount ) {
- string += '\n' + '\t'.repeat( level );
- }
- string += `</${ this.rootName || this.name }>`;
- return string;
- } );
- sandbox.mock( ModelElement.prototype, 'logTree', function() {
- logger.log( this.printTree() );
- } );
- sandbox.mock( ModelRootElement.prototype, 'toString', function() {
- return this.rootName;
- } );
- sandbox.mock( ModelRootElement.prototype, 'log', function() {
- logger.log( 'ModelRootElement: ' + this );
- } );
- sandbox.mock( ModelDocumentFragment.prototype, 'toString', function() {
- return 'documentFragment';
- } );
- sandbox.mock( ModelDocumentFragment.prototype, 'log', function() {
- logger.log( 'ModelDocumentFragment: ' + this );
- } );
- sandbox.mock( ModelDocumentFragment.prototype, 'printTree', function() {
- let string = 'ModelDocumentFragment: [';
- for ( const child of this.getChildren() ) {
- string += '\n';
- if ( child.is( 'text' ) ) {
- const textAttrs = mapToTags( child._attrs );
- string += '\t'.repeat( 1 );
- if ( textAttrs !== '' ) {
- string += `<$text${ textAttrs }>` + child.data + '</$text>';
- } else {
- string += child.data;
- }
- } else {
- string += child.printTree( 1 );
- }
- }
- string += '\n]';
- return string;
- } );
- sandbox.mock( ModelDocumentFragment.prototype, 'logTree', function() {
- logger.log( this.printTree() );
- } );
- sandbox.mock( Operation.prototype, 'log', function() {
- logger.log( this.toString() );
- } );
- sandbox.mock( AttributeOperation.prototype, 'toString', function() {
- return getClassName( this ) + `( ${ this.baseVersion } ): ` +
- `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.range }`;
- } );
- sandbox.mock( DetachOperation.prototype, 'toString', function() {
- const range = ModelRange._createFromPositionAndShift( this.sourcePosition, this.howMany );
- const nodes = Array.from( range.getItems() );
- const nodeString = nodes.length > 1 ? `[ ${ nodes.length } ]` : nodes[ 0 ];
- return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ range }`;
- } );
- sandbox.mock( InsertOperation.prototype, 'toString', function() {
- const nodeString = this.nodes.length > 1 ? `[ ${ this.nodes.length } ]` : this.nodes.getNode( 0 );
- return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ this.position }`;
- } );
- sandbox.mock( MarkerOperation.prototype, 'toString', function() {
- return getClassName( this ) + `( ${ this.baseVersion } ): ` +
- `"${ this.name }": ${ this.oldRange } -> ${ this.newRange }`;
- } );
- sandbox.mock( MoveOperation.prototype, 'toString', function() {
- const range = ModelRange._createFromPositionAndShift( this.sourcePosition, this.howMany );
- return getClassName( this ) + `( ${ this.baseVersion } ): ${ range } -> ${ this.targetPosition }`;
- } );
- sandbox.mock( NoOperation.prototype, 'toString', function() {
- return `NoOperation( ${ this.baseVersion } )`;
- } );
- sandbox.mock( RenameOperation.prototype, 'toString', function() {
- return getClassName( this ) + `( ${ this.baseVersion } ): ` +
- `${ this.position }: "${ this.oldName }" -> "${ this.newName }"`;
- } );
- sandbox.mock( RootAttributeOperation.prototype, 'toString', function() {
- return getClassName( this ) + `( ${ this.baseVersion } ): ` +
- `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.root.rootName }`;
- } );
- sandbox.mock( MergeOperation.prototype, 'toString', function() {
- return getClassName( this ) + `( ${ this.baseVersion } ): ` +
- `${ this.sourcePosition } -> ${ this.targetPosition } ( ${ this.howMany } ), ${ this.graveyardPosition }`;
- } );
- sandbox.mock( SplitOperation.prototype, 'toString', function() {
- return getClassName( this ) + `( ${ this.baseVersion } ): ${ this.splitPosition } ` +
- `( ${ this.howMany } ) -> ${ this.insertionPosition }${ this.graveyardPosition ? ' with ' + this.graveyardPosition : '' }`;
- } );
- sandbox.mock( ViewText.prototype, 'toString', function() {
- return `#${ this.data }`;
- } );
- sandbox.mock( ViewText.prototype, 'logExtended', function() {
- logger.log( 'ViewText: ' + this );
- } );
- sandbox.mock( ViewText.prototype, 'log', function() {
- logger.log( 'ViewText: ' + this );
- } );
- sandbox.mock( ViewTextProxy.prototype, 'toString', function() {
- return `#${ this.data }`;
- } );
- sandbox.mock( ViewTextProxy.prototype, 'logExtended', function() {
- logger.log( 'ViewTextProxy: ' + this );
- } );
- sandbox.mock( ViewTextProxy.prototype, 'log', function() {
- logger.log( 'ViewTextProxy: ' + this );
- } );
- sandbox.mock( ViewElement.prototype, 'printTree', function( level = 0 ) {
- let string = '';
- string += '\t'.repeat( level ) + `<${ this.name }${ mapToTags( this.getAttributes() ) }>`;
- for ( const child of this.getChildren() ) {
- if ( child.is( 'text' ) ) {
- string += '\n' + '\t'.repeat( level + 1 ) + child.data;
- } else {
- string += '\n' + child.printTree( level + 1 );
- }
- }
- if ( this.childCount ) {
- string += '\n' + '\t'.repeat( level );
- }
- string += `</${ this.name }>`;
- return string;
- } );
- sandbox.mock( ViewElement.prototype, 'logTree', function() {
- logger.log( this.printTree() );
- } );
- sandbox.mock( ViewDocumentFragment.prototype, 'printTree', function() {
- let string = 'ViewDocumentFragment: [';
- for ( const child of this.getChildren() ) {
- if ( child.is( 'text' ) ) {
- string += '\n' + '\t'.repeat( 1 ) + child.data;
- } else {
- string += '\n' + child.printTree( 1 );
- }
- }
- string += '\n]';
- return string;
- } );
- sandbox.mock( ViewDocumentFragment.prototype, 'logTree', function() {
- logger.log( this.printTree() );
- } );
- }
- function enableReplayerTools() {
- const _modelApplyOperation = Model.prototype.applyOperation;
- sandbox.mock( Model.prototype, 'applyOperation', function( operation ) {
- if ( !this._appliedOperations ) {
- this._appliedOperations = [];
- }
- this._appliedOperations.push( operation );
- return _modelApplyOperation.call( this, operation );
- } );
- sandbox.mock( Model.prototype, 'getAppliedOperations', function() {
- if ( !this._appliedOperations ) {
- return '';
- }
- return this._appliedOperations.map( JSON.stringify ).join( LOG_SEPARATOR );
- } );
- sandbox.mock( Model.prototype, 'createReplayer', function( stringifiedOperations ) {
- return new OperationReplayer( this, LOG_SEPARATOR, stringifiedOperations );
- } );
- }
- function enableDocumentTools() {
- const _modelApplyOperation = Model.prototype.applyOperation;
- sandbox.mock( Model.prototype, 'applyOperation', function( operation ) {
- logger.log( 'Applying ' + operation );
- if ( !this._operationLogs ) {
- this._operationLogs = [];
- }
- this._operationLogs.push( JSON.stringify( operation ) );
- return _modelApplyOperation.call( this, operation );
- } );
- sandbox.mock( ModelDocument.prototype, 'log', function( version = null ) {
- version = version === null ? this.version : version;
- logDocument( this, version );
- } );
- sandbox.mock( ViewDocument.prototype, 'log', function( version ) {
- logDocument( this, version );
- } );
- sandbox.mock( Editor.prototype, 'logModel', function( version = null ) {
- version = version === null ? this.model.document.version : version;
- this.model.document.log( version );
- } );
- sandbox.mock( Editor.prototype, 'logView', function( version ) {
- this.editing.view.document.log( version );
- } );
- sandbox.mock( Editor.prototype, 'logDocuments', function( version = null ) {
- version = version === null ? this.model.document.version : version;
- this.logModel( version );
- this.logView( version );
- } );
- function logDocument( document, version ) {
- logger.log( '--------------------' );
- if ( document[ treeDump ][ version ] ) {
- logger.log( document[ treeDump ][ version ] );
- } else {
- logger.log( 'Tree log unavailable for given version: ' + version );
- }
- }
- }
- /**
- * Plugin that enables debugging features on the editor's model and view documents.
- */
- class DebugPlugin extends Plugin {
- constructor( editor ) {
- super( editor );
- const model = this.editor.model;
- const modelDocument = model.document;
- const view = this.editor.editing.view;
- const viewDocument = view.document;
- modelDocument[ treeDump ] = [];
- viewDocument[ treeDump ] = [];
- dumpTrees( modelDocument, modelDocument.version );
- dumpTrees( viewDocument, modelDocument.version );
- model.on( 'applyOperation', () => {
- dumpTrees( modelDocument, modelDocument.version );
- }, { priority: 'lowest' } );
- model.document.on( 'change', () => {
- dumpTrees( viewDocument, modelDocument.version );
- }, { priority: 'lowest' } );
- }
- }
- // Helper function, stores the `document` state for a given `version` as a string in a private property.
- function dumpTrees( document, version ) {
- let string = '';
- for ( const root of document.roots ) {
- string += root.printTree() + '\n';
- }
- document[ treeDump ][ version ] = string.substr( 0, string.length - 1 ); // Remove the last "\n".
- const overflow = document[ treeDump ].length - maxTreeDumpLength;
- if ( overflow > 0 ) {
- document[ treeDump ][ overflow - 1 ] = null;
- }
- }
- // Helper function, returns the class name of a given `Operation`.
- // @param {module:engine/model/operation/operation~Operation}
- // @returns {String} Class name.
- function getClassName( obj ) {
- return obj.constructor.className;
- }
- // Helper function, converts a map to the {"key1":"value1","key2":"value2"} format.
- // @param {Map} map Map to convert.
- // @returns {String} Converted map.
- function mapString( map ) {
- const obj = {};
- for ( const entry of map ) {
- obj[ entry[ 0 ] ] = entry[ 1 ];
- }
- return JSON.stringify( obj );
- }
- // Helper function, converts a map to the key1="value1" key2="value1" format.
- // @param {Map} map Map to convert.
- // @returns {String} Converted map.
- function mapToTags( map ) {
- let string = '';
- for ( const entry of map ) {
- string += ` ${ entry[ 0 ] }=${ JSON.stringify( entry[ 1 ] ) }`;
- }
- return string;
- }
|