feat(compiler-cli): exclude abstract classes from `strictInjectionPar… #44615

JoostK · 2022-01-04T18:04:24Z

…ameters` requirement

In AOT compilations, the strictInjectionParameters compiler option can
be enabled to report errors when an @Injectable annotated class has a
constructor with parameters that do not provide an injection token, e.g.
only a primitive type or interface.

Since Ivy it's become required that any class with Angular behavior
(e.g. the ngOnDestroy lifecycle hook) is decorated using an Angular
decorator, which meant that @Injectable() may need to have been added
to abstract base classes. Doing so would then report an error if
strictInjectionParameters is enabled, if the abstract class has an
incompatible constructor for DI purposes. This may be fine though, as
a subclass may call the constructor explicitly without relying on
Angular's DI mechanism.

Therefore, this commit excludes abstract classes from the
strictInjectionParameters check. This avoids an error from being
reported at compile time. If the constructor ends up being used by
Angular's DI system at runtime, then the factory function of the
abstract class will throw an error by means of the ɵɵinvalidFactory
instruction.

Closes #37914

packages/compiler-cli/src/ngtsc/annotations/common/src/diagnostics.ts

JoostK · 2022-03-23T22:29:06Z

packages/compiler-cli/test/ngtsc/ngtsc_spec.ts

+             expect(diags[0].code).toBe(ngErrorCode(ErrorCode.DIRECTIVE_INHERITS_UNDECORATED_CTOR));
+             expect(diags[0].messageText)
+                 .toEqual(
+                     `The directive AbstractMiddleDir inherits its constructor from ParentClass, but the latter does not have an Angular decorator of its own. Dependency injection will not be able to resolve the parameters of ParentClass's constructor. Either add a @Directive decorator to ParentClass, or add an explicit constructor to AbstractMiddleDir.`);


We used to report this report this error for abstract classes and I haven't changed this, but I'm wondering if we should exempt abstract directives from this error.

JoostK · 2022-03-23T22:29:06Z

packages/compiler-cli/test/ngtsc/ngtsc_spec.ts

+               @Injectable({ providedIn: 'root', useValue: null })
+               export class UseValueService extends ParentService {}
+
+               @Injectable({ providedIn: 'root', useClass: ConcreteServiceWithCtor })


Interestingly, we don't check useClass here like we check providers in the providers array! 😱

jessicajaniuk

reviewed-for: public-api

dylhunn · 2022-05-02T18:58:18Z

@JoostK It looks like this hasn't been updated in a while. Is this a PR we'd like to merge for 14?

JoostK · 2022-05-02T19:04:16Z

@JoostK It looks like this hasn't been updated in a while. Is this a PR we'd like to merge for 14?

It's ready to go from my side, just awaiting review. I'm afraid we're short on time to get this LGTM'd in time.

packages/compiler-cli/src/ngtsc/annotations/common/src/diagnostics.ts

atscott · 2022-05-02T21:37:47Z

packages/compiler-cli/src/ngtsc/annotations/common/src/injectable_registry.ts

+    const ctorDeps = getConstructorDependencies(declaration, this.host, this.isCore);
+    return {
+      ctorDeps: unwrapConstructorDependencies(ctorDeps),
+    };
+  }


Should this call registerInjectable before returning?

Hmm yeah that might make sense to avoid potential repeated work 👍

AndrewKushnir

Reviewed-for: public-api

dylhunn

reviewed-for: public-api

atscott

reviewed-for: public-api

quick note: I would might classify this as a fix. I don't think the distinction will matter if it gets merged before the feature freeze for v14

ngbot · 2022-05-03T14:56:10Z

I see that you just added the action: merge label, but the following checks are still failing:
status "ci/circleci: test_angular_devtools" is failing
1 pending code review

If you want your PR to be merged, it has to pass all the CI checks.

If you can't get the PR to a green state due to flakes or broken master, please try rebasing to master and/or restarting the CI job. If that fails and you believe that the issue is not due to your change, please contact the caretaker and ask for help.

dylhunn · 2022-05-03T17:39:58Z

This PR was merged into the repository by commit 9cf14ff.

…ctionParameters` requirement (angular#44615)" This reverts commit 9cf14ff.

dylhunn · 2022-05-03T23:48:23Z

We have to roll this back due to breakage in g3. This will likely need forward fixes in order to land.

…ctionParameters` requirement (#44615)" (#45862) This reverts commit 9cf14ff. PR Close #45862

…meters` requirement In AOT compilations, the `strictInjectionParameters` compiler option can be enabled to report errors when an `@Injectable` annotated class has a constructor with parameters that do not provide an injection token, e.g. only a primitive type or interface. Since Ivy it's become required that any class with Angular behavior (e.g. the `ngOnDestroy` lifecycle hook) is decorated using an Angular decorator, which meant that `@Injectable()` may need to have been added to abstract base classes. Doing so would then report an error if `strictInjectionParameters` is enabled, if the abstract class has an incompatible constructor for DI purposes. This may be fine though, as a subclass may call the constructor explicitly without relying on Angular's DI mechanism. Therefore, this commit excludes abstract classes from the `strictInjectionParameters` check. This avoids an error from being reported at compile time. If the constructor ends up being used by Angular's DI system at runtime, then the factory function of the abstract class will throw an error by means of the `ɵɵinvalidFactory` instruction. In addition to the runtime error, this commit also analyzes the inheritance chain of an injectable without a constructor to verify that their inherited constructor is valid. Closes angular#37914

JoostK added feature comp: compiler target: minor labels Jan 4, 2022

ngbot bot added this to the Backlog milestone Jan 4, 2022

JoostK force-pushed the ngtsc/di/strict-params-abstract branch 2 times, most recently from 72cc61c to 7f30792 Compare Mar 23, 2022

JoostK reviewed Mar 23, 2022

View changes

JoostK force-pushed the ngtsc/di/strict-params-abstract branch 3 times, most recently from efbc3f0 to b1db475 Compare Apr 25, 2022

JoostK marked this pull request as ready for review Apr 25, 2022

JoostK added the action: review label Apr 25, 2022

pullapprove bot requested review from alxhub, AndrewKushnir, atscott and jessicajaniuk Apr 25, 2022

jessicajaniuk previously approved these changes Apr 26, 2022

View changes

pullapprove bot requested a review from dylhunn Apr 26, 2022

AndrewKushnir removed this from the Backlog milestone Apr 27, 2022

AndrewKushnir added this to the v14-candidates milestone Apr 27, 2022

JoostK force-pushed the ngtsc/di/strict-params-abstract branch from b1db475 to 7be53d8 Compare Apr 27, 2022

dylhunn dismissed jessicajaniuk’s stale review via 7be53d8 May 2, 2022

atscott approved these changes May 2, 2022

View changes

AndrewKushnir previously approved these changes May 2, 2022

View changes

pullapprove bot requested a review from atscott May 2, 2022

dylhunn previously approved these changes May 2, 2022

View changes

atscott previously approved these changes May 3, 2022

View changes

atscott added action: merge and removed action: review labels May 3, 2022

JoostK dismissed stale reviews from atscott, dylhunn, and AndrewKushnir via a703061 May 3, 2022

JoostK force-pushed the ngtsc/di/strict-params-abstract branch from 7be53d8 to a703061 Compare May 3, 2022

dylhunn closed this in 9cf14ff May 3, 2022

dylhunn added a commit to dylhunn/angular that referenced this issue May 3, 2022

Revert "feat(compiler-cli): exclude abstract classes from `strictInje…

03a6297

…ctionParameters` requirement (angular#44615)" This reverts commit 9cf14ff.

dylhunn mentioned this pull request May 3, 2022

Revert "feat(compiler-cli): exclude abstract classes from `strictInje… #45862

Closed

dylhunn reopened this May 3, 2022

AndrewKushnir added state: blocked and removed action: merge labels May 3, 2022

dylhunn added a commit that referenced this issue May 4, 2022

Revert "feat(compiler-cli): exclude abstract classes from `strictInje…

a2d5358

…ctionParameters` requirement (#44615)" (#45862) This reverts commit 9cf14ff. PR Close #45862

alxhub removed this from the v14-candidates milestone May 4, 2022

ngbot bot added this to the Backlog milestone May 4, 2022

JoostK force-pushed the ngtsc/di/strict-params-abstract branch from a703061 to b0ba89e Compare May 4, 2022

JoostK added target: rc and removed feature target: minor labels May 4, 2022

AndrewKushnir added target: minor and removed target: rc labels Jun 21, 2022

feat(compiler-cli): exclude abstract classes from `strictInjectionPar… #44615

feat(compiler-cli): exclude abstract classes from `strictInjectionPar… #44615

JoostK commented Jan 4, 2022

JoostK Mar 23, 2022

JoostK Mar 23, 2022

jessicajaniuk left a comment

dylhunn commented May 2, 2022

JoostK commented May 2, 2022

atscott May 2, 2022

JoostK May 3, 2022

AndrewKushnir left a comment

dylhunn left a comment

atscott left a comment

ngbot bot commented May 3, 2022

dylhunn commented May 3, 2022

dylhunn commented May 3, 2022

feat(compiler-cli): exclude abstract classes from `strictInjectionPar… #44615

Are you sure you want to change the base?

feat(compiler-cli): exclude abstract classes from `strictInjectionPar… #44615

Conversation

JoostK commented Jan 4, 2022

JoostK Mar 23, 2022

Choose a reason for hiding this comment

JoostK Mar 23, 2022

Choose a reason for hiding this comment

jessicajaniuk left a comment

dylhunn commented May 2, 2022

JoostK commented May 2, 2022

atscott May 2, 2022

Choose a reason for hiding this comment

JoostK May 3, 2022

Choose a reason for hiding this comment

AndrewKushnir left a comment

dylhunn left a comment

atscott left a comment

ngbot bot commented May 3, 2022

dylhunn commented May 3, 2022

dylhunn commented May 3, 2022