[WiP] Adding aggregated roots config. by niegowski · Pull Request #19937 · ckeditor/ckeditor5

niegowski · 2026-03-10T13:29:45Z

🚀 Summary

A brief summary of what this PR changes.

📌 Related issues

Closes Add root/roots editor config option #19885

💡 Additional information

Optional: Notes on decisions, edge cases, or anything helpful for reviewers.

🧾 Checklists

Use the following checklists to ensure important areas were not overlooked.
This does not apply to feature-branch merges.
If an item is not relevant to this type of change, simply leave it unchecked.

Author checklist

Reviewer checklist

PR description explains the changes and the chosen approach (especially when performance, API, or UX is affected).
The changelog entry is clear, user‑ or integrator-facing, and it describes any breaking changes.
All new external dependencies have been approved and mentioned in LICENSE.md (if any).
All human-readable, translateable strings in this PR been introduced using t() (if any).
I manually verified the change (e.g., in manual tests or documentation).
The target branch is correct.

Note

Medium Risk
Medium risk because it changes how all editor types derive initialData, placeholder, and label, and it rewires multi-root lazy loading/attributes and watchdog restart logic; mis-normalization could affect editor initialization and restoration flows.

Overview
Adds aggregated per-root configuration via new EditorConfig.root/EditorConfig.roots and RootConfig, while deprecating legacy config.initialData, config.placeholder, and config.label in favor of per-root equivalents.

Introduces normalizeRootsConfig() in core and updates all editor constructors/UIs (classic/inline/balloon/decoupled/multi-root, plus tests) to normalize config and read initialData/placeholder/label from config.roots (with legacy values mapped into roots and new validation errors for conflicting sources).

Updates multi-root configuration to move lazyRoots and rootsAttributes into roots.<name>.lazyLoad and roots.<name>.modelAttributes, throwing on deprecated options, and adjusts multi-root initialization and data.init() to consume initial data extracted from root configs. Watchdog restart logic is updated to preserve/normalize root configs (including legacy placeholders) and no longer depends on multi-root as a runtime dependency.

^{Written by Cursor Bugbot for commit f82c56f. This will update automatically on new commits. Configure here.}

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts

Mati365

TODO:

ckeditor5/packages/ckeditor5-heading/src/title.ts

Line 358 in 631c6f4

const bodyPlaceholder = editor.config.get( 'placeholder' ) ||

Title plugin depends on config.placeholder property.

niegowski · 2026-03-12T08:54:00Z

TODO:

ckeditor5/packages/ckeditor5-heading/src/title.ts

Line 358 in 631c6f4

const bodyPlaceholder = editor.config.get( 'placeholder' ) ||

Title plugin depends on config.placeholder property.

I know, I have it marked locally

marburek · 2026-03-12T12:32:38Z

bugbot run

cursor · 2026-03-12T12:32:40Z

Bugbot couldn't run

Bugbot is not enabled for your user on this team.

Ask your team administrator to increase your team's hard limit for Bugbot seats or add you to the allowlist in the Cursor dashboard.

marburek · 2026-03-12T19:05:18Z

bugbot run

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Autofix Details

Bugbot Autofix prepared fixes for both issues found in the latest run.

✅ Fixed: Falsy empty string skips conflicting initialData validation
- Updated root conflict checks to treat empty strings as provided source data by checking for null/undefined explicitly before validating element type.
✅ Fixed: Test config places bar outside roots object
- Moved the bar root test configuration under roots so the test correctly validates both root entries.

Or push these changes by commenting:

@cursor push 8d233d8ee3

Preview (8d233d8ee3)

diff --git a/packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts b/packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts
--- a/packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts
+++ b/packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts
@@ -69,6 +69,7 @@
 	for ( const rootName of rootNames ) {
 		const rootConfig = rootsConfig[ rootName ] || Object.create( null );
 		const sourceElementOrDataForRoot = sourceElementIsPlainObject ? sourceElementsOrData[ rootName ] : sourceElementsOrData;
+		const sourceElementOrDataForRootIsDefined = sourceElementOrDataForRoot !== undefined && sourceElementOrDataForRoot !== null;
 
 		// No dedicated initial data for the root.
 		if ( rootConfig.initialData === undefined ) {
@@ -78,7 +79,7 @@
 				rootConfig.initialData = getInitialData( sourceElementOrDataForRoot );
 			}
 			// If both `config.initialData` is set and initial data is passed as the constructor parameter, then throw.
-			else if ( sourceElementOrDataForRoot && !isElement( sourceElementOrDataForRoot ) ) {
+			else if ( sourceElementOrDataForRootIsDefined && !isElement( sourceElementOrDataForRoot ) ) {
 				// Documented in core/editor/editorconfig.ts.
 				// eslint-disable-next-line ckeditor5-rules/ckeditor-error-message
 				throw new CKEditorError( 'editor-create-initial-data', null );
@@ -89,7 +90,7 @@
 			}
 		}
 		// If both `rootConfig.initialData` is set and initial data is passed as the constructor parameter, then throw.
-		else if ( sourceElementOrDataForRoot && !isElement( sourceElementOrDataForRoot ) ) {
+		else if ( sourceElementOrDataForRootIsDefined && !isElement( sourceElementOrDataForRoot ) ) {
 			// Documented in core/editor/editorconfig.ts.
 			// eslint-disable-next-line ckeditor5-rules/ckeditor-error-message
 			throw new CKEditorError( 'editor-create-initial-data', null );

diff --git a/packages/ckeditor5-core/tests/editor/utils/normalizerootsconfig.js b/packages/ckeditor5-core/tests/editor/utils/normalizerootsconfig.js
--- a/packages/ckeditor5-core/tests/editor/utils/normalizerootsconfig.js
+++ b/packages/ckeditor5-core/tests/editor/utils/normalizerootsconfig.js
@@ -42,8 +42,9 @@
 
 		it( 'should use initialData from config.root if set', () => {
 			config.set( 'root', { initialData: '<p>bar</p>' } );
+			const sourceElement = document.createElement( 'div' );
 
-			normalizeRootsConfig( '', config );
+			normalizeRootsConfig( sourceElement, config );
 
 			const roots = config.get( 'roots' );
 

diff --git a/packages/ckeditor5-editor-multi-root/tests/multirooteditor.js b/packages/ckeditor5-editor-multi-root/tests/multirooteditor.js
--- a/packages/ckeditor5-editor-multi-root/tests/multirooteditor.js
+++ b/packages/ckeditor5-editor-multi-root/tests/multirooteditor.js
@@ -143,7 +143,7 @@
 				expect( () => {
 					// eslint-disable-next-line no-new
 					new MultiRootEditor( { foo: '<p>Foo</p>', bar: '<p>Bar</p>' },
-						{ roots: { foo: { initialData: '<p>Bar</p>' } }, bar: { initialData: '<p>Abc</p>' } }
+						{ roots: { foo: { initialData: '<p>Bar</p>' }, bar: { initialData: '<p>Abc</p>' } } }
 					);
 				} ).to.throw( CKEditorError, 'editor-create-initial-data' );
 			} );

_{This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.}

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts

packages/ckeditor5-editor-multi-root/tests/multirooteditor.js

packages/ckeditor5-core/src/editor/editorconfig.ts

cursor · 2026-03-12T20:45:01Z

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts

+			// No legacy initial data for the root, either.
+			if ( legacyInitialData[ rootName ] === undefined ) {
+				// Use source element data or data itself as a string.
+				rootConfig.initialData = getInitialData( sourceElementOrDataForRoot );


Undefined passed to getInitialData for missing source roots

Medium Severity

When sourceElementIsPlainObject is true and a root name exists in config.roots or legacyInitialData but not in the source elements object, sourceElementsOrData[rootName] evaluates to undefined. This undefined is passed to getInitialData, which has a return type of string but will silently return undefined at runtime (since isElement(undefined) is false, it returns sourceElementOrData which is undefined). This sets rootConfig.initialData = undefined, violating the expected string type for initialData.

Additional Locations (1)

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts#L130-L133

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts

packages/ckeditor5-watchdog/src/editorwatchdog.ts

packages/ckeditor5-watchdog/src/utils/normalizerootsconfig.ts

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

There are 3 total unresolved issues (including 1 from previous review).

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

cursor · 2026-03-14T09:48:00Z

packages/ckeditor5-watchdog/src/editorwatchdog.ts

 	 */
-	private _initUsingData = true;
+	// TODO clean it
+	// private _initUsingData = true;


Accidentally committed WiP TODO comments and debug code

Medium Severity

Multiple WiP artifacts remain: /** * TODO */ placeholder doc comments on _editorAttachTo and _isSingleRootEditor, a commented-out // private _initUsingData = true; with // TODO clean it, // TODO make it nicer, // TODO is this correct for lazy root?, // TODO keep the documentation, // TODO update comment, placeholder?: string; // TODO, // TODO add tests, and TODO breaking change in doc text. These indicate unfinished work accidentally included.

Additional Locations (2)

packages/ckeditor5-editor-multi-root/src/multirooteditor.ts#L161-L204

packages/ckeditor5-core/src/editor/editorconfig.ts#L979-L980

cursor · 2026-03-14T09:48:00Z

packages/ckeditor5-editor-multi-root/src/multirooteditor.ts

-			editableElements: sourceIsData ? undefined : sourceElementsOrData as Record<string, HTMLElement>,
-			label: this.config.get( 'label' )
+			editableElements: this.sourceElements,
+			label: extractRootsConfigField( this.config.get( 'roots' )!, 'label' )


Multi-root editor passes empty object instead of undefined for editableElements

Medium Severity

When the multi-root editor is initialized with string data (no DOM elements), this.sourceElements is {}. The old code passed undefined for editableElements in this case, but the new code always passes this.sourceElements. Since {} is truthy, MultiRootEditorUIView may treat it differently from undefined, potentially trying to bind to nonexistent DOM elements rather than creating new ones.

niegowski added 4 commits March 9, 2026 18:32

Adding aggregated roots config.

bb269f7

Added support for multi-root dedicated config.

68561aa

Some API docs cleaning.

50d9a1a

Add tests for normalizeRootsConfig util.

c938e54

mmotyczynska self-requested a review March 11, 2026 09:32

Mati365 reviewed Mar 11, 2026

View reviewed changes

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts Outdated Show resolved Hide resolved

Mati365 and others added 2 commits March 11, 2026 13:48

Merge branch 'master' into ck/19885

7e5a6f9

Avoid prototype pollution.

6b2965b

Mati365 mentioned this pull request Mar 11, 2026

Update documentation to reflect new root configuration structure #19948

Open

18 tasks

Mati365 and others added 7 commits March 11, 2026 15:17

Update guide

0369567

Update more docs.

d0229cc

Adjust paths.

d9a53ed

Fix path typo.

eb4cb4d

Fix few api docs.

0f57ed9

Move snippets changes to different branch.

8296538

Fixed issues with watchdog and multi root editor.

631c6f4

Mati365 reviewed Mar 12, 2026

View reviewed changes

niegowski added 2 commits March 12, 2026 11:54

Adjusted the Title plugin to the normalized editor config.

3b1880a

Removed imports from core in watchdog.

02b7720

niegowski marked this pull request as ready for review March 12, 2026 12:16

niegowski changed the title ~~Adding aggregated roots config.~~ [WiP] Adding aggregated roots config. Mar 12, 2026

ckeditor deleted a comment from cursor bot Mar 12, 2026

niegowski added 2 commits March 12, 2026 13:43

Added tests for code coverage.

a65ae75

Fixed dependencies.

978692a

niegowski requested a review from a team as a code owner March 12, 2026 14:24

cursor bot reviewed Mar 12, 2026

View reviewed changes

packages/ckeditor5-core/src/editor/utils/normalizerootsconfig.ts Show resolved Hide resolved

packages/ckeditor5-editor-multi-root/tests/multirooteditor.js Outdated Show resolved Hide resolved

niegowski added 2 commits March 12, 2026 21:16

Marked optional config option as optional.

4777f9b

Fixed invalid test.

8190f4c

cursor bot reviewed Mar 12, 2026

View reviewed changes

packages/ckeditor5-core/src/editor/editorconfig.ts Show resolved Hide resolved

Updated pnpm-lock files.

b891e6d

cursor bot reviewed Mar 12, 2026

View reviewed changes

niegowski added 2 commits March 12, 2026 21:46

Merge branch 'master' into ck/19885

5a7983e

Changed modelElement.attributes to modelAttributes root config.

f82c56f

cursor bot reviewed Mar 14, 2026

View reviewed changes

Uh oh!

Conversation

niegowski commented Mar 10, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Summary

📌 Related issues

💡 Additional information

🧾 Checklists

Author checklist

Reviewer checklist

Uh oh!

Uh oh!

Mati365 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niegowski commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marburek commented Mar 12, 2026

Uh oh!

cursor bot commented Mar 12, 2026

Bugbot couldn't run

Uh oh!

marburek commented Mar 12, 2026

Uh oh!

cursor bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot Mar 12, 2026

Choose a reason for hiding this comment

Undefined passed to getInitialData for missing source roots

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Mar 14, 2026

Choose a reason for hiding this comment

Accidentally committed WiP TODO comments and debug code

Uh oh!

cursor bot Mar 14, 2026

Choose a reason for hiding this comment

Multi-root editor passes empty object instead of undefined for editableElements

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

niegowski commented Mar 10, 2026 •

edited by cursor bot

Loading

Mati365 left a comment •

edited

Loading

niegowski commented Mar 12, 2026 •

edited

Loading

cursor bot left a comment •

edited

Loading

Undefined passed to `getInitialData` for missing source roots