refactor(core): disable renderer3 unless explicitly enabled by tests (#46530)

alxhub · dylhunn · commit a322b7d6940e · 2022-06-28T11:15:54.000-07:00
The `Renderer3` abstraction in Angular was an experimental code path in Ivy which uses direct DOM operations instead of the former `Renderer2` path. To allow `Renderer2` to tree-shake away, `Renderer3` is the default _unless_ `Renderer2` is provided. It was only an experiment, and never meant to be a production code path. However, it's possible for `Renderer3` to leak into user code. This commit prevents that possibility by causing the `Renderer3` path to throw, unless an explicit function has been called to enable it. PR Close #46530
diff --git a/packages/core/src/render3/component.ts b/packages/core/src/render3/component.ts
@@ -22,7 +22,7 @@ import {addToViewTree, CLEAN_PROMISE, createLView, createTView, getOrCreateTComp
 import {ComponentDef, ComponentType, RenderFlags} from './interfaces/definition';
 import {TElementNode, TNodeType} from './interfaces/node';
 import {PlayerHandler} from './interfaces/player';
-import {domRendererFactory3, Renderer3, RendererFactory3} from './interfaces/renderer';
+import {domRendererFactory3, enableRenderer3, Renderer3, RendererFactory3} from './interfaces/renderer';
 import {RElement} from './interfaces/renderer_dom';
 import {CONTEXT, HEADER_OFFSET, LView, LViewFlags, RootContext, RootContextFlags, TVIEW, TViewType} from './interfaces/view';
 import {writeDirectClass, writeDirectStyle} from './node_manipulation';
@@ -115,6 +115,8 @@ export function renderComponent<T>(
   ngDevMode && publishDefaultGlobalUtils();
   ngDevMode && assertComponentType(componentType);
 
+  enableRenderer3();
+
   const rendererFactory = opts.rendererFactory || domRendererFactory3;
   const sanitizer = opts.sanitizer || null;
   const componentDef = getComponentDef<T>(componentType)!;
diff --git a/packages/core/src/render3/interfaces/renderer.ts b/packages/core/src/render3/interfaces/renderer.ts
@@ -17,6 +17,7 @@
 
 import {RendererStyleFlags2, RendererType2} from '../../render/api_flags';
 import {TrustedHTML, TrustedScript, TrustedScriptURL} from '../../util/security/trusted_type_defs';
+
 import {getDocument} from './document';
 import {RComment, RElement, RNode, RText} from './renderer_dom';
 
@@ -105,8 +106,20 @@ export interface RendererFactory3 {
   end?(): void;
 }
 
+let renderer3Enabled = false;
+
+export function enableRenderer3() {
+  renderer3Enabled = true;
+}
+
 export const domRendererFactory3: RendererFactory3 = {
   createRenderer: (hostElement: RElement|null, rendererType: RendererType2|null): Renderer3 => {
+    if (!renderer3Enabled) {
+      throw new Error(
+          ngDevMode ?
+              `Renderer3 is not supported. This problem is likely caused by some component in the hierarchy was constructed without a correct parent injector.` :
+              'Renderer3 disabled');
+    }
     return getDocument();
   }
 };
diff --git a/packages/core/test/acceptance/component_spec.ts b/packages/core/test/acceptance/component_spec.ts
@@ -12,7 +12,7 @@ import {TestBed} from '@angular/core/testing';
 import {ɵDomRendererFactory2 as DomRendererFactory2} from '@angular/platform-browser';
 import {expect} from '@angular/platform-browser/testing/src/matchers';
 
-import {domRendererFactory3} from '../../src/render3/interfaces/renderer';
+import {domRendererFactory3, enableRenderer3} from '../../src/render3/interfaces/renderer';
 import {global} from '../../src/util/global';
 
 
@@ -582,6 +582,7 @@ describe('component', () => {
   });
 
   describe('should clear host element if provided in ComponentFactory.create', () => {
+    beforeAll(() => enableRenderer3());
     function runTestWithRenderer(rendererProviders: any[]) {
       @Component({
         selector: 'dynamic-comp',
diff --git a/packages/core/test/bundling/animations/bundle.golden_symbols.json b/packages/core/test/bundling/animations/bundle.golden_symbols.json
@@ -149,9 +149,6 @@
   {
     "name": "DIMENSIONAL_PROP_SET"
   },
-  {
-    "name": "DOCUMENT"
-  },
   {
     "name": "DOCUMENT2"
   },
@@ -548,9 +545,6 @@
   {
     "name": "_randomChar"
   },
-  {
-    "name": "componentDefCount"
-  },
   {
     "name": "_testabilityGetter"
   },
@@ -641,6 +635,9 @@
   {
     "name": "collectNativeNodes"
   },
+  {
+    "name": "componentDefCount"
+  },
   {
     "name": "computeStaticStyling"
   },
@@ -1403,4 +1400,4 @@
   {
     "name": "ɵɵproperty"
   }
-]
+]
diff --git a/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json b/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json
@@ -65,9 +65,6 @@
   {
     "name": "_injectImplementation"
   },
-  {
-    "name": "componentDefCount"
-  },
   {
     "name": "addComponentLogic"
   },
@@ -98,6 +95,9 @@
   {
     "name": "classIndexOf"
   },
+  {
+    "name": "componentDefCount"
+  },
   {
     "name": "computeStaticStyling"
   },
@@ -365,6 +365,9 @@
   {
     "name": "renderView"
   },
+  {
+    "name": "renderer3Enabled"
+  },
   {
     "name": "resetPreOrderHookFlags"
   },
@@ -449,4 +452,4 @@
   {
     "name": "ɵɵinject"
   }
-]
+]
diff --git a/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json b/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json
@@ -107,9 +107,6 @@
   {
     "name": "DEFAULT_VALUE_ACCESSOR"
   },
-  {
-    "name": "DOCUMENT"
-  },
   {
     "name": "DOCUMENT2"
   },
diff --git a/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json b/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json
@@ -113,9 +113,6 @@
   {
     "name": "DEFAULT_VALUE_ACCESSOR"
   },
-  {
-    "name": "DOCUMENT"
-  },
   {
     "name": "DOCUMENT2"
   },
diff --git a/packages/core/test/bundling/hello_world/bundle.golden_symbols.json b/packages/core/test/bundling/hello_world/bundle.golden_symbols.json
@@ -62,9 +62,6 @@
   {
     "name": "_injectImplementation"
   },
-  {
-    "name": "componentDefCount"
-  },
   {
     "name": "allocExpando"
   },
@@ -86,6 +83,9 @@
   {
     "name": "callHooks"
   },
+  {
+    "name": "componentDefCount"
+  },
   {
     "name": "concatStringsWithSpace"
   },
@@ -281,6 +281,9 @@
   {
     "name": "renderView"
   },
+  {
+    "name": "renderer3Enabled"
+  },
   {
     "name": "resetPreOrderHookFlags"
   },
@@ -335,4 +338,4 @@
   {
     "name": "ɵɵinject"
   }
-]
+]
diff --git a/packages/core/test/bundling/router/bundle.golden_symbols.json b/packages/core/test/bundling/router/bundle.golden_symbols.json
@@ -140,9 +140,6 @@
   {
     "name": "DEFAULT_SERIALIZER"
   },
-  {
-    "name": "DOCUMENT"
-  },
   {
     "name": "DOCUMENT2"
   },
diff --git a/packages/core/test/bundling/standalone_bootstrap/bundle.golden_symbols.json b/packages/core/test/bundling/standalone_bootstrap/bundle.golden_symbols.json
@@ -59,9 +59,6 @@
   {
     "name": "ConnectableSubscriber"
   },
-  {
-    "name": "DOCUMENT"
-  },
   {
     "name": "DOCUMENT2"
   },
@@ -341,9 +338,6 @@
   {
     "name": "_randomChar"
   },
-  {
-    "name": "componentDefCount"
-  },
   {
     "name": "_wrapInTimeout"
   },
@@ -392,6 +386,9 @@
   {
     "name": "collectNativeNodes"
   },
+  {
+    "name": "componentDefCount"
+  },
   {
     "name": "concatStringsWithSpace"
   },
@@ -881,4 +878,4 @@
   {
     "name": "ɵɵinject"
   }
-]
+]
diff --git a/packages/core/test/bundling/todo/bundle.golden_symbols.json b/packages/core/test/bundling/todo/bundle.golden_symbols.json
@@ -164,9 +164,6 @@
   {
     "name": "_injectImplementation"
   },
-  {
-    "name": "componentDefCount"
-  },
   {
     "name": "_symbolIterator"
   },
@@ -239,6 +236,9 @@
   {
     "name": "collectStylingFromTAttrs"
   },
+  {
+    "name": "componentDefCount"
+  },
   {
     "name": "computeStaticStyling"
   },
@@ -698,6 +698,9 @@
   {
     "name": "renderView"
   },
+  {
+    "name": "renderer3Enabled"
+  },
   {
     "name": "resetPreOrderHookFlags"
   },
@@ -866,4 +869,4 @@
   {
     "name": "ɵɵtextInterpolate1"
   }
-]
+]
diff --git a/packages/core/test/render3/perf/setup.ts b/packages/core/test/render3/perf/setup.ts
@@ -8,13 +8,14 @@
 import {addToViewTree, createLContainer, createLView, createTNode, createTView, getOrCreateTNode, refreshView, renderView} from '../../../src/render3/instructions/shared';
 import {ComponentTemplate, DirectiveDefList} from '../../../src/render3/interfaces/definition';
 import {TAttributes, TElementNode, TNodeType} from '../../../src/render3/interfaces/node';
-import {domRendererFactory3, RendererFactory3} from '../../../src/render3/interfaces/renderer';
+import {domRendererFactory3, enableRenderer3, RendererFactory3} from '../../../src/render3/interfaces/renderer';
 import {LView, LViewFlags, TVIEW, TView, TViewType} from '../../../src/render3/interfaces/view';
 import {insertView} from '../../../src/render3/node_manipulation';
 
 import {MicroBenchmarkRendererFactory} from './noop_renderer';
 
 const isBrowser = typeof process === 'undefined';
+enableRenderer3();
 const rendererFactory: RendererFactory3 =
     isBrowser ? domRendererFactory3 : new MicroBenchmarkRendererFactory;
 const renderer = rendererFactory.createRenderer(null, null);
diff --git a/packages/core/test/render3/render_util.ts b/packages/core/test/render3/render_util.ts
@@ -36,14 +36,15 @@ import {NG_ELEMENT_ID} from '../../src/render3/fields';
 import {ComponentDef, ComponentTemplate, ComponentType, DirectiveDef, DirectiveType, renderComponent as _renderComponent, RenderFlags, tick, ɵɵdefineComponent, ɵɵdefineDirective, ɵɵProvidersFeature} from '../../src/render3/index';
 import {DirectiveDefList, DirectiveDefListOrFactory, DirectiveTypesOrFactory, HostBindingsFunction, PipeDef, PipeDefList, PipeDefListOrFactory, PipeTypesOrFactory} from '../../src/render3/interfaces/definition';
 import {PlayerHandler} from '../../src/render3/interfaces/player';
-import {domRendererFactory3, ProceduralRenderer3, Renderer3, RendererFactory3, RendererStyleFlags3} from '../../src/render3/interfaces/renderer';
+import {domRendererFactory3, enableRenderer3, ProceduralRenderer3, Renderer3, RendererFactory3, RendererStyleFlags3} from '../../src/render3/interfaces/renderer';
 import {LView, LViewFlags, TVIEW, TViewType} from '../../src/render3/interfaces/view';
 import {destroyLView} from '../../src/render3/node_manipulation';
 import {getRootView} from '../../src/render3/util/view_traversal_utils';
 import {Sanitizer} from '../../src/sanitization/sanitizer';
 
 import {getRendererFactory2} from './imported_renderer2';
 
+enableRenderer3();
 
 
 export abstract class BaseFixture {

Original file line number	Diff line number	Diff line change
`@@ -149,9 +149,6 @@`
`149`	`149`	`{`
`150`	`150`	`"name": "DIMENSIONAL_PROP_SET"`
`151`	`151`	`},`
`152`		`- {`
`153`		`- "name": "DOCUMENT"`
`154`		`- },`
`155`	`152`	`{`
`156`	`153`	`"name": "DOCUMENT2"`
`157`	`154`	`},`
`@@ -548,9 +545,6 @@`
`548`	`545`	`{`
`549`	`546`	`"name": "_randomChar"`
`550`	`547`	`},`
`551`		`- {`
`552`		`- "name": "componentDefCount"`
`553`		`- },`
`554`	`548`	`{`
`555`	`549`	`"name": "_testabilityGetter"`
`556`	`550`	`},`
`@@ -641,6 +635,9 @@`
`641`	`635`	`{`
`642`	`636`	`"name": "collectNativeNodes"`
`643`	`637`	`},`
	`638`	`+ {`
	`639`	`+ "name": "componentDefCount"`
	`640`	`+ },`
`644`	`641`	`{`
`645`	`642`	`"name": "computeStaticStyling"`
`646`	`643`	`},`
`@@ -1403,4 +1400,4 @@`
`1403`	`1400`	`{`
`1404`	`1401`	`"name": "ɵɵproperty"`
`1405`	`1402`	`}`
`1406`		`-]`
	`1403`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -65,9 +65,6 @@`
`65`	`65`	`{`
`66`	`66`	`"name": "_injectImplementation"`
`67`	`67`	`},`
`68`		`- {`
`69`		`- "name": "componentDefCount"`
`70`		`- },`
`71`	`68`	`{`
`72`	`69`	`"name": "addComponentLogic"`
`73`	`70`	`},`
`@@ -98,6 +95,9 @@`
`98`	`95`	`{`
`99`	`96`	`"name": "classIndexOf"`
`100`	`97`	`},`
	`98`	`+ {`
	`99`	`+ "name": "componentDefCount"`
	`100`	`+ },`
`101`	`101`	`{`
`102`	`102`	`"name": "computeStaticStyling"`
`103`	`103`	`},`
`@@ -365,6 +365,9 @@`
`365`	`365`	`{`
`366`	`366`	`"name": "renderView"`
`367`	`367`	`},`
	`368`	`+ {`
	`369`	`+ "name": "renderer3Enabled"`
	`370`	`+ },`
`368`	`371`	`{`
`369`	`372`	`"name": "resetPreOrderHookFlags"`
`370`	`373`	`},`
`@@ -449,4 +452,4 @@`
`449`	`452`	`{`
`450`	`453`	`"name": "ɵɵinject"`
`451`	`454`	`}`
`452`		`-]`
	`455`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -107,9 +107,6 @@`
`107`	`107`	`{`
`108`	`108`	`"name": "DEFAULT_VALUE_ACCESSOR"`
`109`	`109`	`},`
`110`		`- {`
`111`		`- "name": "DOCUMENT"`
`112`		`- },`
`113`	`110`	`{`
`114`	`111`	`"name": "DOCUMENT2"`
`115`	`112`	`},`
Original file line number	Diff line number	Diff line change
`@@ -113,9 +113,6 @@`
`113`	`113`	`{`
`114`	`114`	`"name": "DEFAULT_VALUE_ACCESSOR"`
`115`	`115`	`},`
`116`		`- {`
`117`		`- "name": "DOCUMENT"`
`118`		`- },`
`119`	`116`	`{`
`120`	`117`	`"name": "DOCUMENT2"`
`121`	`118`	`},`
Original file line number	Diff line number	Diff line change
`@@ -62,9 +62,6 @@`
`62`	`62`	`{`
`63`	`63`	`"name": "_injectImplementation"`
`64`	`64`	`},`
`65`		`- {`
`66`		`- "name": "componentDefCount"`
`67`		`- },`
`68`	`65`	`{`
`69`	`66`	`"name": "allocExpando"`
`70`	`67`	`},`
`@@ -86,6 +83,9 @@`
`86`	`83`	`{`
`87`	`84`	`"name": "callHooks"`
`88`	`85`	`},`
	`86`	`+ {`
	`87`	`+ "name": "componentDefCount"`
	`88`	`+ },`
`89`	`89`	`{`
`90`	`90`	`"name": "concatStringsWithSpace"`
`91`	`91`	`},`
`@@ -281,6 +281,9 @@`
`281`	`281`	`{`
`282`	`282`	`"name": "renderView"`
`283`	`283`	`},`
	`284`	`+ {`
	`285`	`+ "name": "renderer3Enabled"`
	`286`	`+ },`
`284`	`287`	`{`
`285`	`288`	`"name": "resetPreOrderHookFlags"`
`286`	`289`	`},`
`@@ -335,4 +338,4 @@`
`335`	`338`	`{`
`336`	`339`	`"name": "ɵɵinject"`
`337`	`340`	`}`
`338`		`-]`
	`341`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -140,9 +140,6 @@`
`140`	`140`	`{`
`141`	`141`	`"name": "DEFAULT_SERIALIZER"`
`142`	`142`	`},`
`143`		`- {`
`144`		`- "name": "DOCUMENT"`
`145`		`- },`
`146`	`143`	`{`
`147`	`144`	`"name": "DOCUMENT2"`
`148`	`145`	`},`
Original file line number	Diff line number	Diff line change
`@@ -59,9 +59,6 @@`
`59`	`59`	`{`
`60`	`60`	`"name": "ConnectableSubscriber"`
`61`	`61`	`},`
`62`		`- {`
`63`		`- "name": "DOCUMENT"`
`64`		`- },`
`65`	`62`	`{`
`66`	`63`	`"name": "DOCUMENT2"`
`67`	`64`	`},`
`@@ -341,9 +338,6 @@`
`341`	`338`	`{`
`342`	`339`	`"name": "_randomChar"`
`343`	`340`	`},`
`344`		`- {`
`345`		`- "name": "componentDefCount"`
`346`		`- },`
`347`	`341`	`{`
`348`	`342`	`"name": "_wrapInTimeout"`
`349`	`343`	`},`
`@@ -392,6 +386,9 @@`
`392`	`386`	`{`
`393`	`387`	`"name": "collectNativeNodes"`
`394`	`388`	`},`
	`389`	`+ {`
	`390`	`+ "name": "componentDefCount"`
	`391`	`+ },`
`395`	`392`	`{`
`396`	`393`	`"name": "concatStringsWithSpace"`
`397`	`394`	`},`
`@@ -881,4 +878,4 @@`
`881`	`878`	`{`
`882`	`879`	`"name": "ɵɵinject"`
`883`	`880`	`}`
`884`		`-]`
	`881`	`+]`