@ckeditor/ckeditor5-utils 34.2.0 → 35.1.0

package/src/ckeditorerror.js

@@ -2,18 +2,14 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module utils/ckeditorerror
  */
-
 /* globals console */
-
 /**
  * URL to the documentation with error codes.
  */
 export const DOCUMENTATION_URL = 'https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html';
-
 /**
  * The CKEditor error class.
  *
@@ -43,85 +39,76 @@ export const DOCUMENTATION_URL = 'https://ckeditor.com/docs/ckeditor5/latest/sup
  * @extends Error
  */
 export default class CKEditorError extends Error {
-	/**
-	 * Creates an instance of the CKEditorError class.
-	 *
-	 * @param {String} errorName The error id in an `error-name` format. A link to this error documentation page will be added
-	 * to the thrown error's `message`.
-	 * @param {Object|null} context A context of the error by which the {@link module:watchdog/watchdog~Watchdog watchdog}
-	 * is able to determine which editor crashed. It should be an editor instance or a property connected to it. It can be also
-	 * a `null` value if the editor should not be restarted in case of the error (e.g. during the editor initialization).
-	 * The error context should be checked using the `areConnectedThroughProperties( editor, context )` utility
-	 * to check if the object works as the context.
-	 * @param {Object} [data] Additional data describing the error. A stringified version of this object
-	 * will be appended to the error message, so the data are quickly visible in the console. The original
-	 * data object will also be later available under the {@link #data} property.
-	 */
-	constructor( errorName, context, data ) {
-		super( getErrorMessage( errorName, data ) );
-
-		/**
-		 * @type {String}
-		 */
-		this.name = 'CKEditorError';
-
-		/**
-		 * A context of the error by which the Watchdog is able to determine which editor crashed.
-		 *
-		 * @type {Object|null}
-		 */
-		this.context = context;
-
-		/**
-		 * The additional error data passed to the constructor. Undefined if none was passed.
-		 *
-		 * @type {Object|undefined}
-		 */
-		this.data = data;
-	}
-
-	/**
-	 * Checks if the error is of the `CKEditorError` type.
-	 * @returns {Boolean}
-	 */
-	is( type ) {
-		return type === 'CKEditorError';
-	}
-
-	/**
-	 * A utility that ensures that the thrown error is a {@link module:utils/ckeditorerror~CKEditorError} one.
-	 * It is useful when combined with the {@link module:watchdog/watchdog~Watchdog} feature, which can restart the editor in case
-	 * of a {@link module:utils/ckeditorerror~CKEditorError} error.
-	 *
-	 * @static
-	 * @param {Error} err The error to rethrow.
-	 * @param {Object} context An object connected through properties with the editor instance. This context will be used
-	 * by the watchdog to verify which editor should be restarted.
-	 */
-	static rethrowUnexpectedError( err, context ) {
-		if ( err.is && err.is( 'CKEditorError' ) ) {
-			throw err;
-		}
-
-		/**
-		 * An unexpected error occurred inside the CKEditor 5 codebase. This error will look like the original one
-		 * to make the debugging easier.
-		 *
-		 * This error is only useful when the editor is initialized using the {@link module:watchdog/watchdog~Watchdog} feature.
-		 * In case of such error (or any {@link module:utils/ckeditorerror~CKEditorError} error) the watchdog should restart the editor.
-		 *
-		 * @error unexpected-error
-		 */
-		const error = new CKEditorError( err.message, context );
-
-		// Restore the original stack trace to make the error look like the original one.
-		// See https://github.com/ckeditor/ckeditor5/issues/5595 for more details.
-		error.stack = err.stack;
-
-		throw error;
-	}
+    /**
+     * Creates an instance of the CKEditorError class.
+     *
+     * @param {String} errorName The error id in an `error-name` format. A link to this error documentation page will be added
+     * to the thrown error's `message`.
+     * @param {Object|null} context A context of the error by which the {@link module:watchdog/watchdog~Watchdog watchdog}
+     * is able to determine which editor crashed. It should be an editor instance or a property connected to it. It can be also
+     * a `null` value if the editor should not be restarted in case of the error (e.g. during the editor initialization).
+     * The error context should be checked using the `areConnectedThroughProperties( editor, context )` utility
+     * to check if the object works as the context.
+     * @param {Object} [data] Additional data describing the error. A stringified version of this object
+     * will be appended to the error message, so the data are quickly visible in the console. The original
+     * data object will also be later available under the {@link #data} property.
+     */
+    constructor(errorName, context, data) {
+        super(getErrorMessage(errorName, data));
+        /**
+         * @type {String}
+         */
+        this.name = 'CKEditorError';
+        /**
+         * A context of the error by which the Watchdog is able to determine which editor crashed.
+         *
+         * @type {Object|null}
+         */
+        this.context = context;
+        /**
+         * The additional error data passed to the constructor. Undefined if none was passed.
+         *
+         * @type {Object|undefined}
+         */
+        this.data = data;
+    }
+    /**
+     * Checks if the error is of the `CKEditorError` type.
+     * @returns {Boolean}
+     */
+    is(type) {
+        return type === 'CKEditorError';
+    }
+    /**
+     * A utility that ensures that the thrown error is a {@link module:utils/ckeditorerror~CKEditorError} one.
+     * It is useful when combined with the {@link module:watchdog/watchdog~Watchdog} feature, which can restart the editor in case
+     * of a {@link module:utils/ckeditorerror~CKEditorError} error.
+     *
+     * @static
+     * @param {Error} err The error to rethrow.
+     * @param {Object} context An object connected through properties with the editor instance. This context will be used
+     * by the watchdog to verify which editor should be restarted.
+     */
+    static rethrowUnexpectedError(err, context) {
+        if (err.is && err.is('CKEditorError')) {
+            throw err;
+        }
+        /**
+         * An unexpected error occurred inside the CKEditor 5 codebase. This error will look like the original one
+         * to make the debugging easier.
+         *
+         * This error is only useful when the editor is initialized using the {@link module:watchdog/watchdog~Watchdog} feature.
+         * In case of such error (or any {@link module:utils/ckeditorerror~CKEditorError} error) the watchdog should restart the editor.
+         *
+         * @error unexpected-error
+         */
+        const error = new CKEditorError(err.message, context);
+        // Restore the original stack trace to make the error look like the original one.
+        // See https://github.com/ckeditor/ckeditor5/issues/5595 for more details.
+        error.stack = err.stack;
+        throw error;
+    }
 }
-
 /**
  * Logs a warning to the console with a properly formatted message and adds a link to the documentation.
  * Use whenever you want to log a warning to the console.
@@ -141,10 +128,9 @@ export default class CKEditorError extends Error {
  * @param {String} errorName The error name to be logged.
  * @param {Object} [data] Additional data to be logged.
  */
-export function logWarning( errorName, data ) {
-	console.warn( ...formatConsoleArguments( errorName, data ) );
+export function logWarning(errorName, data) {
+    console.warn(...formatConsoleArguments(errorName, data));
 }
-
 /**
  * Logs an error to the console with a properly formatted message and adds a link to the documentation.
  * Use whenever you want to log an error to the console.
@@ -165,53 +151,45 @@ export function logWarning( errorName, data ) {
  * @param {String} errorName The error name to be logged.
  * @param {Object} [data] Additional data to be logged.
  */
-export function logError( errorName, data ) {
-	console.error( ...formatConsoleArguments( errorName, data ) );
+export function logError(errorName, data) {
+    console.error(...formatConsoleArguments(errorName, data));
 }
-
 // Returns formatted link to documentation message.
 //
 // @private
 // @param {String} errorName
 // @returns {string}
-function getLinkToDocumentationMessage( errorName ) {
-	return `\nRead more: ${ DOCUMENTATION_URL }#error-${ errorName }`;
+function getLinkToDocumentationMessage(errorName) {
+    return `\nRead more: ${DOCUMENTATION_URL}#error-${errorName}`;
 }
-
 // Returns formatted error message.
 //
 // @private
 // @param {String} errorName
 // @param {Object} [data]
 // @returns {string}
-function getErrorMessage( errorName, data ) {
-	const processedObjects = new WeakSet();
-	const circularReferencesReplacer = ( key, value ) => {
-		if ( typeof value === 'object' && value !== null ) {
-			if ( processedObjects.has( value ) ) {
-				return `[object ${ value.constructor.name }]`;
-			}
-
-			processedObjects.add( value );
-		}
-
-		return value;
-	};
-
-	const stringifiedData = data ? ` ${ JSON.stringify( data, circularReferencesReplacer ) }` : '';
-	const documentationLink = getLinkToDocumentationMessage( errorName );
-
-	return errorName + stringifiedData + documentationLink;
+function getErrorMessage(errorName, data) {
+    const processedObjects = new WeakSet();
+    const circularReferencesReplacer = (key, value) => {
+        if (typeof value === 'object' && value !== null) {
+            if (processedObjects.has(value)) {
+                return `[object ${value.constructor.name}]`;
+            }
+            processedObjects.add(value);
+        }
+        return value;
+    };
+    const stringifiedData = data ? ` ${JSON.stringify(data, circularReferencesReplacer)}` : '';
+    const documentationLink = getLinkToDocumentationMessage(errorName);
+    return errorName + stringifiedData + documentationLink;
 }
-
 // Returns formatted console error arguments.
 //
 // @private
 // @param {String} errorName
 // @param {Object} [data]
 // @returns {Array}
-function formatConsoleArguments( errorName, data ) {
-	const documentationMessage = getLinkToDocumentationMessage( errorName );
-
-	return data ? [ errorName, data, documentationMessage ] : [ errorName, documentationMessage ];
+function formatConsoleArguments(errorName, data) {
+    const documentationMessage = getLinkToDocumentationMessage(errorName);
+    return data ? [errorName, data, documentationMessage] : [errorName, documentationMessage];
 }