fix(core): unable to inject ChangeDetectorRef inside host directives (#48355)

crisbeto · AndrewKushnir · commit e4dcaa513e7d · 2022-12-07T09:06:46.000-08:00
When injecting the `ChangeDetectorRef` into a node that matches a component, we create a new ref using the component's LView. This breaks down for host directives, because they run before the component's LView has been created. These changes resolve the issue by creating the LView before creating the node injector for the directives. Fixes #48249. PR Close #48355
diff --git a/packages/core/src/render3/instructions/shared.ts b/packages/core/src/render3/instructions/shared.ts
@@ -1142,6 +1142,16 @@ function instantiateAllDirectives(
     tView: TView, lView: LView, tNode: TDirectiveHostNode, native: RNode) {
   const start = tNode.directiveStart;
   const end = tNode.directiveEnd;
+
+  // The component view needs to be created before creating the node injector
+  // since it is used to inject some special symbols like `ChangeDetectorRef`.
+  if (isComponentHost(tNode)) {
+    ngDevMode && assertTNodeType(tNode, TNodeType.AnyRNode);
+    addComponentLogic(
+        lView, tNode as TElementNode,
+        tView.data[start + tNode.componentOffset] as ComponentDef<unknown>);
+  }
+
   if (!tView.firstCreatePass) {
     getOrCreateNodeInjectorForNode(tNode, lView);
   }
@@ -1151,23 +1161,16 @@ function instantiateAllDirectives(
   const initialInputs = tNode.initialInputs;
   for (let i = start; i < end; i++) {
     const def = tView.data[i] as DirectiveDef<any>;
-    const isComponent = isComponentDef(def);
-
-    if (isComponent) {
-      ngDevMode && assertTNodeType(tNode, TNodeType.AnyRNode);
-      addComponentLogic(lView, tNode as TElementNode, def as ComponentDef<any>);
-    }
-
     const directive = getNodeInjectable(lView, tView, i, tNode);
     attachPatchData(directive, lView);
 
     if (initialInputs !== null) {
       setInputsFromAttrs(lView, i - start, directive, def, tNode, initialInputs!);
     }
 
-    if (isComponent) {
+    if (isComponentDef(def)) {
       const componentView = getComponentLViewByIndex(tNode.index, lView);
-      componentView[CONTEXT] = directive;
+      componentView[CONTEXT] = getNodeInjectable(lView, tView, i, tNode);
     }
   }
 }
diff --git a/packages/core/test/acceptance/host_directives_spec.ts b/packages/core/test/acceptance/host_directives_spec.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {AfterViewChecked, AfterViewInit, Component, Directive, ElementRef, EventEmitter, forwardRef, inject, Inject, InjectionToken, Input, OnChanges, OnInit, Output, SimpleChanges, Type, ViewChild, ViewContainerRef} from '@angular/core';
+import {AfterViewChecked, AfterViewInit, ChangeDetectorRef, Component, Directive, ElementRef, EventEmitter, forwardRef, inject, Inject, InjectionToken, Input, OnChanges, OnInit, Output, SimpleChanges, Type, ViewChild, ViewContainerRef} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
 import {By} from '@angular/platform-browser';
 
@@ -919,6 +919,44 @@ describe('host directives', () => {
          expect(() => TestBed.createComponent(App))
              .toThrowError(/NG0200: Circular dependency in DI detected for HostDir/);
        });
+
+    it('should inject a valid ChangeDetectorRef when attached to a component', () => {
+      type InternalChangeDetectorRef = ChangeDetectorRef&{_lView: unknown};
+
+      @Directive({standalone: true})
+      class HostDir {
+        changeDetectorRef = inject(ChangeDetectorRef) as InternalChangeDetectorRef;
+      }
+
+      @Component({selector: 'my-comp', hostDirectives: [HostDir], template: ''})
+      class Comp {
+        changeDetectorRef = inject(ChangeDetectorRef) as InternalChangeDetectorRef;
+      }
+
+      @Component({template: '<my-comp></my-comp>'})
+      class App {
+        @ViewChild(HostDir) hostDir!: HostDir;
+        @ViewChild(Comp) comp!: Comp;
+      }
+
+      TestBed.configureTestingModule({declarations: [App, Comp]});
+      const fixture = TestBed.createComponent(App);
+      fixture.detectChanges();
+
+      const hostDirectiveCdr = fixture.componentInstance.hostDir.changeDetectorRef;
+      const componentCdr = fixture.componentInstance.comp.changeDetectorRef;
+
+      // We can't assert that the change detectors are the same by comparing
+      // them directly, because a new one is created each time. Instead of we
+      // compare that they're associated with the same LView.
+      expect(hostDirectiveCdr._lView).toBeTruthy();
+      expect(componentCdr._lView).toBeTruthy();
+      expect(hostDirectiveCdr._lView).toBe(componentCdr._lView);
+      expect(() => {
+        hostDirectiveCdr.markForCheck();
+        hostDirectiveCdr.detectChanges();
+      }).not.toThrow();
+    });
   });
 
   describe('outputs', () => {
diff --git a/packages/core/test/bundling/animations/bundle.golden_symbols.json b/packages/core/test/bundling/animations/bundle.golden_symbols.json
@@ -548,9 +548,6 @@
   {
     "name": "addClass"
   },
-  {
-    "name": "addComponentLogic"
-  },
   {
     "name": "addPropertyAlias"
   },
diff --git a/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json b/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json
@@ -386,9 +386,6 @@
   {
     "name": "_wrapInTimeout"
   },
-  {
-    "name": "addComponentLogic"
-  },
   {
     "name": "addPropertyAlias"
   },
@@ -743,6 +740,9 @@
   {
     "name": "isComponentDef"
   },
+  {
+    "name": "isComponentHost"
+  },
   {
     "name": "isContentQueryHost"
   },
diff --git a/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json b/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json
@@ -551,9 +551,6 @@
   {
     "name": "_wrapInTimeout"
   },
-  {
-    "name": "addComponentLogic"
-  },
   {
     "name": "addPropertyAlias"
   },
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
@@ -539,9 +539,6 @@
   {
     "name": "_wrapInTimeout"
   },
-  {
-    "name": "addComponentLogic"
-  },
   {
     "name": "addPropertyAlias"
   },
diff --git a/packages/core/test/bundling/router/bundle.golden_symbols.json b/packages/core/test/bundling/router/bundle.golden_symbols.json
@@ -707,9 +707,6 @@
   {
     "name": "absoluteRedirect"
   },
-  {
-    "name": "addComponentLogic"
-  },
   {
     "name": "addPropertyAlias"
   },
diff --git a/packages/core/test/bundling/todo/bundle.golden_symbols.json b/packages/core/test/bundling/todo/bundle.golden_symbols.json
@@ -464,9 +464,6 @@
   {
     "name": "_wrapInTimeout"
   },
-  {
-    "name": "addComponentLogic"
-  },
   {
     "name": "addPropertyAlias"
   },

Original file line number	Diff line number	Diff line change
`@@ -548,9 +548,6 @@`
`548`	`548`	`{`
`549`	`549`	`"name": "addClass"`
`550`	`550`	`},`
`551`		`- {`
`552`		`- "name": "addComponentLogic"`
`553`		`- },`
`554`	`551`	`{`
`555`	`552`	`"name": "addPropertyAlias"`
`556`	`553`	`},`
Original file line number	Diff line number	Diff line change
`@@ -386,9 +386,6 @@`
`386`	`386`	`{`
`387`	`387`	`"name": "_wrapInTimeout"`
`388`	`388`	`},`
`389`		`- {`
`390`		`- "name": "addComponentLogic"`
`391`		`- },`
`392`	`389`	`{`
`393`	`390`	`"name": "addPropertyAlias"`
`394`	`391`	`},`
`@@ -743,6 +740,9 @@`
`743`	`740`	`{`
`744`	`741`	`"name": "isComponentDef"`
`745`	`742`	`},`
	`743`	`+ {`
	`744`	`+ "name": "isComponentHost"`
	`745`	`+ },`
`746`	`746`	`{`
`747`	`747`	`"name": "isContentQueryHost"`
`748`	`748`	`},`
Original file line number	Diff line number	Diff line change
`@@ -551,9 +551,6 @@`
`551`	`551`	`{`
`552`	`552`	`"name": "_wrapInTimeout"`
`553`	`553`	`},`
`554`		`- {`
`555`		`- "name": "addComponentLogic"`
`556`		`- },`
`557`	`554`	`{`
`558`	`555`	`"name": "addPropertyAlias"`
`559`	`556`	`},`
Original file line number	Diff line number	Diff line change
`@@ -539,9 +539,6 @@`
`539`	`539`	`{`
`540`	`540`	`"name": "_wrapInTimeout"`
`541`	`541`	`},`
`542`		`- {`
`543`		`- "name": "addComponentLogic"`
`544`		`- },`
`545`	`542`	`{`
`546`	`543`	`"name": "addPropertyAlias"`
`547`	`544`	`},`
Original file line number	Diff line number	Diff line change
`@@ -707,9 +707,6 @@`
`707`	`707`	`{`
`708`	`708`	`"name": "absoluteRedirect"`
`709`	`709`	`},`
`710`		`- {`
`711`		`- "name": "addComponentLogic"`
`712`		`- },`
`713`	`710`	`{`
`714`	`711`	`"name": "addPropertyAlias"`
`715`	`712`	`},`
Original file line number	Diff line number	Diff line change
`@@ -464,9 +464,6 @@`
`464`	`464`	`{`
`465`	`465`	`"name": "_wrapInTimeout"`
`466`	`466`	`},`
`467`		`- {`
`468`		`- "name": "addComponentLogic"`
`469`		`- },`
`470`	`467`	`{`
`471`	`468`	`"name": "addPropertyAlias"`
`472`	`469`	`},`