Merge pull request #10740 from ckeditor/ci/1098-experimental-flag

Other (engine): Introduced flag for experimental rendering mode for the editing view. Other (media-embed, html-support): Enable experimental rendering in tests.
ckeditor · Oct 22, 2021 · 13f788a · 13f788a
2 parents bd7f292 + a4b6b05
commit 13f788a
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 10 deletions.
diff --git a/packages/ckeditor5-engine/src/view/domconverter.js b/packages/ckeditor5-engine/src/view/domconverter.js
@@ -72,6 +72,14 @@ export default class DomConverter {
 		 */
 		this.renderingMode = options.renderingMode || 'editing';
 
+		/**
+		 * Main switch for new rendering approach in the editing view.
+		 *
+		 * @protected
+		 * @member {Boolean}
+		 */
+		this.experimentalRenderingMode = false;
+
 		/**
 		 * The mode of a block filler used by the DOM converter.
 		 *
@@ -241,7 +249,7 @@ export default class DomConverter {
 	 * @returns {Boolean}
 	 */
 	shouldRenderAttribute( attributeKey, attributeValue ) {
-		if ( this.renderingMode === 'data' ) {
+		if ( !this.experimentalRenderingMode || this.renderingMode === 'data' ) {
 			return true;
 		}
 
@@ -259,7 +267,7 @@ export default class DomConverter {
 	 */
 	setContentOf( domElement, html ) {
 		// For data pipeline we pass the HTML as-is.
-		if ( this.renderingMode === 'data' ) {
+		if ( !this.experimentalRenderingMode || this.renderingMode === 'data' ) {
 			domElement.innerHTML = html;
 
 			return;
@@ -1478,7 +1486,7 @@ export default class DomConverter {
 	 * @returns {Boolean}
 	 */
 	_shouldRenameElement( elementName ) {
-		return this.renderingMode == 'editing' && elementName == 'script';
+		return this.experimentalRenderingMode && this.renderingMode == 'editing' && elementName == 'script';
 	}
 
 	/**

diff --git a/packages/ckeditor5-engine/tests/view/domconverter/domconverter.js b/packages/ckeditor5-engine/tests/view/domconverter/domconverter.js
@@ -435,6 +435,14 @@ describe( 'DomConverter', () => {
 	} );
 
 	describe( 'shouldRenderAttribute()', () => {
+		beforeEach( () => {
+			converter.experimentalRenderingMode = true;
+		} );
+
+		afterEach( () => {
+			converter.experimentalRenderingMode = false;
+		} );
+
 		it( 'should allow all in for data pipeline', () => {
 			expect( converter.shouldRenderAttribute( 'onclick', 'anything' ) ).to.be.false;
 			expect( converter.shouldRenderAttribute( 'anything', 'javascript:something' ) ).to.be.false;
@@ -564,6 +572,14 @@ describe( 'DomConverter', () => {
 		} );
 
 		describe( 'editing pipeline', () => {
+			beforeEach( () => {
+				converter.experimentalRenderingMode = true;
+			} );
+
+			afterEach( () => {
+				converter.experimentalRenderingMode = false;
+			} );
+
 			it( 'should remove certain attributes', () => {
 				const element = document.createElement( 'p' );
 

diff --git a/packages/ckeditor5-engine/tests/view/domconverter/view-to-dom.js b/packages/ckeditor5-engine/tests/view/domconverter/view-to-dom.js
@@ -230,6 +230,7 @@ describe( 'DomConverter', () => {
 					renderingMode: 'editing'
 				} );
 
+				converter.experimentalRenderingMode = true;
 				converter.bindElements( domImg, viewImg );
 
 				const domP = converter.viewToDom( viewP, document );
@@ -257,6 +258,7 @@ describe( 'DomConverter', () => {
 				converter = new DomConverter( viewDocument, {
 					renderingMode: 'editing'
 				} );
+				converter.experimentalRenderingMode = true;
 
 				const domP = converter.viewToDom( viewP, document );
 

diff --git a/packages/ckeditor5-engine/tests/view/renderer.js b/packages/ckeditor5-engine/tests/view/renderer.js
@@ -3975,18 +3975,13 @@ describe( 'Renderer', () => {
 
 			beforeEach( () => {
 				view = new View( new StylesProcessor() );
+				view.domConverter.experimentalRenderingMode = true;
+
 				viewDoc = view.document;
 				domRoot = document.createElement( 'div' );
 				document.body.appendChild( domRoot );
 				viewRoot = createViewRoot( viewDoc );
 				view.attachDomRoot( domRoot );
-
-				viewDocument = new ViewDocument( new StylesProcessor() );
-				selection = new DocumentSelection();
-				// Enable editing render mode.
-				domConverter = new DomConverter( viewDocument, { renderingMode: 'editing' } );
-				renderer = new Renderer( domConverter, selection );
-				renderer.domDocuments.add( document );
 			} );
 
 			afterEach( () => {
@@ -3996,6 +3991,7 @@ describe( 'Renderer', () => {
 
 			it( 'should handle script tag rendering', () => {
 				window.spy = sinon.spy();
+
 				viewRoot._appendChild( parse( '<container:script>spy()</container:script>' ) );
 
 				renderer.markToSync( 'children', viewRoot );
@@ -4007,14 +4003,19 @@ describe( 'Renderer', () => {
 			} );
 
 			it( 'should replace script element with span and custom data attribute', () => {
+				window.spy = sinon.spy();
+
 				setViewData( view,
 					'<container:script>spy()</container:script>'
 				);
 
 				view.forceRender();
 
+				expect( window.spy.calledOnce ).to.be.false;
 				expect( getViewData( view ) ).to.equal( '<script>spy()</script>' );
 				expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<span data-ck-hidden="script">spy()</span>' );
+
+				delete window.spy;
 			} );
 
 			it( 'should remove attributes that can affect editing pipeline', () => {

diff --git a/packages/ckeditor5-html-support/tests/datafilter.js b/packages/ckeditor5-html-support/tests/datafilter.js
@@ -188,6 +188,8 @@ describe( 'DataFilter', () => {
 				'</paragraph>'
 			);
 
+			editor.editing.view.domConverter.experimentalRenderingMode = true;
+
 			expect( getViewData( editor.editing.view, {
 				withoutSelection: true,
 				renderRawElements: true,
@@ -203,6 +205,8 @@ describe( 'DataFilter', () => {
 				'</p>'
 			);
 
+			editor.editing.view.domConverter.experimentalRenderingMode = false;
+
 			expect( editor.getData() ).to.equal( '<p><video>' +
 				'<source src="https://example.com/video.mp4" type="video/mp4" onclick="action()">' +
 					'Your browser does not support the video tag.</video>' +

diff --git a/packages/ckeditor5-media-embed/tests/mediaembedediting.js b/packages/ckeditor5-media-embed/tests/mediaembedediting.js
@@ -1062,6 +1062,7 @@ describe( 'MediaEmbedEditing', () => {
 						provider
 					]
 				} ).then( editor => {
+					editor.editing.view.domConverter.experimentalRenderingMode = true;
 					editor.setData( '<figure class="media"><div data-oembed-url="foo.com"></div></figure>' );
 
 					expect( getViewData( editor.editing.view, {