import type { BaseEditor, EditorLifecycleError, EditorLifecycleErrorSink, } from '../interfaces/editor'; import { getEditorRuntimeOwner } from './editor-runtime'; const EDITOR_LIFECYCLE_ERROR_SINKS = new WeakMap< BaseEditor, (error: unknown) => void >(); export const setEditorLifecycleErrorSink = < TEditor extends BaseEditor, >( editor: TEditor, sink: EditorLifecycleErrorSink | undefined ) => { const owner = getEditorRuntimeOwner(editor); if (sink) { EDITOR_LIFECYCLE_ERROR_SINKS.set(owner, (error) => Reflect.apply(sink, undefined, [error]) ); } else { EDITOR_LIFECYCLE_ERROR_SINKS.delete(owner); } }; type SourcedLifecycleError = Extract< EditorLifecycleError, { source: string } >; const describeSource: { [TSource in SourcedLifecycleError['source']]: ( error: Extract ) => string; } = { 'data-transfer-format': (error) => `data-transfer-format ${error.phase} failed in plugin "${error.pluginName}" for MIME type "${error.mimeType}" and key "${error.key}"`, 'external-text': (error) => `external-text ${error.phase} failed`, history: (error) => `history ${error.phase} failed on ${error.direction}`, pagination: (error) => `pagination ${error.phase} failed`, 'render-element': (error) => `render-element ${error.phase} check failed`, yjs: (error) => `yjs ${error.phase} lost this peer's copy of root "${error.root}"`, }; const describeCause = (cause: unknown) => { try { return String(cause instanceof Error ? cause.message : cause); } catch { return 'a value that cannot be converted to a string'; } }; const describeFailingPart = (error: EditorLifecycleError): string => { if (!('source' in error)) { return `plugin ${error.phase} failed in plugin "${error.pluginName}"`; } return ( describeSource[error.source] as (error: SourcedLifecycleError) => string )(error); }; const logLifecycleError = (...values: unknown[]) => { try { globalThis.console?.error(...values); } catch { // Reports run inside other listeners' loops, and a console can throw while // it formats a value whose inspect hook throws. } }; /** @internal */ export const reportEditorLifecycleError = < TEditor extends BaseEditor, >( error: EditorLifecycleError ) => { const sink = EDITOR_LIFECYCLE_ERROR_SINKS.get( getEditorRuntimeOwner(error.editor) ); if (sink) { try { sink(error); return; } catch (sinkError) { logLifecycleError(error, sinkError); return; } } const { cause } = error; const reported = new Error( `Editor ${describeFailingPart(error)}: ${describeCause(cause)}`, { cause } ); const { reportError } = globalThis as { reportError?: (error: unknown) => void; }; if (reportError) { reportError(reported); } else { logLifecycleError(reported); } }; type EditorObserverPhase = | 'after-commit' | 'commit-listener' | 'node-change-listener' | 'snapshot-listener' | 'source-listener' | 'text-change-listener'; /** @internal */ export const runEditorObserver = ( editor: BaseEditor, phase: EditorObserverPhase, observer: () => void, pluginName = '$editor' ) => { try { observer(); } catch (error) { reportEditorLifecycleError( Object.freeze({ cause: error, editor, pluginName, phase }) ); } }; /** @internal */ export const notifyObservers = ( editor: BaseEditor, listeners: ReadonlySet | undefined, phase: EditorObserverPhase, call: (listener: TListener) => void, pluginName?: string ) => { if (!listeners || listeners.size === 0) { return; } for (const listener of [...listeners]) { if (listeners.has(listener)) { runEditorObserver(editor, phase, () => call(listener), pluginName); } } };