refactor(compiler-cli): reference InputFlags enum directly for full…

… compiler output Instead of computing the bit input flags at compile-time and inling the final bit flag number, we will use the `InputFlags` enum directly. This is a little more code in the compiler side, but will allow us to have better debuggable development code, and also prevents problems where runtime flag bitmasks differ from the compiler flag bitmasks. This is in practice a noop for optimized applications as the enum values would be inlined anyway. This matches existing compiler emit for e.g. change detection strategy, or view encapsulation enums.
angular · Dec 14, 2023 · 107f6d8 · 107f6d8
1 parent f462dfe
commit 107f6d8
Show file tree

Hide file tree

Showing 12 changed files with 53 additions and 29 deletions.
diff --git a/...ompliance/components_and_directives/lifecycle_hooks/lifecycle_hooks_lifecycle_comp_def.js b/...ompliance/components_and_directives/lifecycle_hooks/lifecycle_hooks_lifecycle_comp_def.js
@@ -1,7 +1,7 @@
 LifecycleComp.ɵcmp = /*@__PURE__*/ $r3$.ɵɵdefineComponent({
   type: LifecycleComp,
   selectors: [["lifecycle-comp"]],
-  inputs: {nameMin: [0, "name", "nameMin"]},
+  inputs: {nameMin: [$r3$.ɵɵInputFlags.None, "name", "nameMin"]},
   features: [$r3$.ɵɵNgOnChangesFeature],
   decls: 0,
   vars: 0,

diff --git a/...ler-cli/test/compliance/test_cases/r3_view_compiler_input_outputs/component_definition.js b/...ler-cli/test/compliance/test_cases/r3_view_compiler_input_outputs/component_definition.js
@@ -2,7 +2,7 @@ MyComponent.ɵcmp = /*@__PURE__*/ $r3$.ɵɵdefineComponent({
   …
   inputs:{
     componentInput: "componentInput",
-    originalComponentInput: [0, "renamedComponentInput", "originalComponentInput"]
+    originalComponentInput: [$r3$.ɵɵInputFlags.None, "renamedComponentInput", "originalComponentInput"]
   },
   outputs: {
     componentOutput: "componentOutput",

diff --git a/...ler-cli/test/compliance/test_cases/r3_view_compiler_input_outputs/directive_definition.js b/...ler-cli/test/compliance/test_cases/r3_view_compiler_input_outputs/directive_definition.js
@@ -2,7 +2,7 @@ MyDirective.ɵdir = /*@__PURE__*/ $r3$.ɵɵdefineDirective({
   …
   inputs:{
     directiveInput: "directiveInput",
-    originalDirectiveInput: [0, "renamedDirectiveInput", "originalDirectiveInput"]
+    originalDirectiveInput: [$r3$.ɵɵInputFlags.None, "renamedDirectiveInput", "originalDirectiveInput"]
   },
   outputs: {
     directiveOutput: "directiveOutput",

diff --git a/...i/test/compliance/test_cases/r3_view_compiler_input_outputs/input_transform_definition.js b/...i/test/compliance/test_cases/r3_view_compiler_input_outputs/input_transform_definition.js
@@ -1,8 +1,8 @@
 MyDirective.ɵdir = /*@__PURE__*/ $r3$.ɵɵdefineDirective({
   …
   inputs: {
-    functionDeclarationInput: [0, "functionDeclarationInput", "functionDeclarationInput", toNumber],
-    inlineFunctionInput: [0, "inlineFunctionInput", "inlineFunctionInput", (value, _) => value ? 1 : 0]
+    functionDeclarationInput: [$r3$.ɵɵInputFlags.None, "functionDeclarationInput", "functionDeclarationInput", toNumber],
+    inlineFunctionInput: [$r3$.ɵɵInputFlags.None, "inlineFunctionInput", "inlineFunctionInput", (value, _) => value ? 1 : 0]
   },
   features: [$r3$.ɵɵInputTransformsFeature]…
 });
diff --git a/packages/compiler-cli/test/ngtsc/authoring_spec.ts b/packages/compiler-cli/test/ngtsc/authoring_spec.ts
@@ -33,7 +33,7 @@ runInEachFileSystem(() => {
       `);
       env.driveMain();
       const js = env.getContents('test.js');
-      expect(js).toContain('inputs: { data: [1, "data"] }');
+      expect(js).toContain('inputs: { data: [i0.ɵɵInputFlags.SignalBased, "data"] }');
     });
 
     it('should handle an alias configured, primitive valued input', () => {
@@ -49,7 +49,7 @@ runInEachFileSystem(() => {
       `);
       env.driveMain();
       const js = env.getContents('test.js');
-      expect(js).toContain('inputs: { data: [1, "publicName", "data"] }');
+      expect(js).toContain('inputs: { data: [i0.ɵɵInputFlags.SignalBased, "publicName", "data"] }');
     });
 
     it('should error if a required input declares an initial value', () => {
@@ -82,7 +82,8 @@ runInEachFileSystem(() => {
         }
       `);
       env.driveMain();
-      expect(env.getContents('test.js')).toContain(`inputs: { data: [1, "data"] }`);
+      expect(env.getContents('test.js'))
+          .toContain(`inputs: { data: [i0.ɵɵInputFlags.SignalBased, "data"] }`);
       expect(env.getContents('test.d.ts')).toContain('"required": true; "isSignal": true;');
       expect(env.getContents('test.d.ts'))
           .withContext(
@@ -101,7 +102,8 @@ runInEachFileSystem(() => {
         }
       `);
       env.driveMain();
-      expect(env.getContents('test.js')).toContain(`inputs: { data: [1, "data"] }`);
+      expect(env.getContents('test.js'))
+          .toContain(`inputs: { data: [i0.ɵɵInputFlags.SignalBased, "data"] }`);
     });
 
     describe('type checking', () => {

diff --git a/packages/compiler-cli/test/ngtsc/ngtsc_spec.ts b/packages/compiler-cli/test/ngtsc/ngtsc_spec.ts
@@ -5800,8 +5800,8 @@ function allTests(os: string) {
         "track-name": "track-name",
         inputTrackName: "inputTrackName",
         "src.xl": "src.xl",
-        trackType: [0, "track-type", "trackType"],
-        trackName: [0, "track-name", "trackName"]
+        trackType: [i0.ɵɵInputFlags.None, "track-type", "trackType"],
+        trackName: [i0.ɵɵInputFlags.None, "track-name", "trackName"]
       },
       outputs: {
         "output-track-type": "output-track-type",
@@ -8603,7 +8603,8 @@ function allTests(os: string) {
         const jsContents = env.getContents('test.js');
         const dtsContents = env.getContents('test.d.ts');
 
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+        expect(jsContents)
+            .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents).toContain('static ngAcceptInputType_value: boolean | string;');
       });
@@ -8625,7 +8626,8 @@ function allTests(os: string) {
         const jsContents = env.getContents('test.js');
         const dtsContents = env.getContents('test.d.ts');
 
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+        expect(jsContents)
+            .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
         expect(jsContents)
             .toContain('features: [i0.ɵɵInputTransformsFeature, i0.ɵɵStandaloneFeature]');
         expect(dtsContents).toContain('static ngAcceptInputType_value: boolean | string;');
@@ -8655,7 +8657,8 @@ function allTests(os: string) {
            const jsContents = env.getContents('test.js');
            const dtsContents = env.getContents('test.d.ts');
 
-           expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+           expect(jsContents)
+               .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
            expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
            expect(dtsContents).toContain('import * as i1 from "./types"');
            expect(dtsContents)
@@ -8694,7 +8697,8 @@ function allTests(os: string) {
            const jsContents = env.getContents('test.js');
            const dtsContents = env.getContents('test.d.ts');
 
-           expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+           expect(jsContents)
+               .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
            expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
            expect(dtsContents).toContain('import * as i1 from "./types"');
            expect(dtsContents).toContain('import * as i2 from "./other-types"');
@@ -8730,7 +8734,9 @@ function allTests(os: string) {
         const dtsContents = env.getContents('test.d.ts');
 
         expect(jsContents).toContain(`import { externalToNumber } from 'external';`);
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", externalToNumber] }');
+        expect(jsContents)
+            .toContain(
+                'inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", externalToNumber] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents).toContain('import * as i1 from "external";');
         expect(dtsContents).toContain('static ngAcceptInputType_value: i1.ExternalToNumberType;');
@@ -8761,7 +8767,8 @@ function allTests(os: string) {
         const dtsContents = env.getContents('test.d.ts');
 
         expect(jsContents)
-            .toContain('inputs: { value: [0, "value", "value", (value) => value ? 1 : 0] }');
+            .toContain(
+                'inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", (value) => value ? 1 : 0] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents).toContain('import * as i1 from "external";');
         expect(dtsContents).toContain('static ngAcceptInputType_value: i1.ExternalToNumberType;');
@@ -8788,7 +8795,8 @@ function allTests(os: string) {
         const jsContents = env.getContents('test.js');
         const dtsContents = env.getContents('test.d.ts');
 
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", toBoolean] }');
+        expect(jsContents)
+            .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toBoolean] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents)
             .toContain(`static ngAcceptInputType_value: boolean | "" | "true" | "false";`);
@@ -8811,7 +8819,8 @@ function allTests(os: string) {
         const jsContents = env.getContents('test.js');
         const dtsContents = env.getContents('test.d.ts');
 
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+        expect(jsContents)
+            .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents).toContain('static ngAcceptInputType_value: boolean | string;');
       });
@@ -8833,7 +8842,8 @@ function allTests(os: string) {
         const jsContents = env.getContents('test.js');
         const dtsContents = env.getContents('test.d.ts');
 
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+        expect(jsContents)
+            .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents).toContain('static ngAcceptInputType_value: unknown;');
       });
@@ -8858,7 +8868,8 @@ function allTests(os: string) {
         const jsContents = env.getContents('test.js');
         const dtsContents = env.getContents('test.d.ts');
 
-        expect(jsContents).toContain('inputs: { value: [0, "value", "value", toNumber] }');
+        expect(jsContents)
+            .toContain('inputs: { value: [i0.ɵɵInputFlags.None, "value", "value", toNumber] }');
         expect(jsContents)
             .toContain('features: [i0.ɵɵInputTransformsFeature, i0.ɵɵInheritDefinitionFeature]');
         expect(dtsContents).toContain('static ngAcceptInputType_value: boolean | string;');
@@ -8887,7 +8898,8 @@ function allTests(os: string) {
         const dtsContents = env.getContents('test.d.ts');
 
         expect(jsContents)
-            .toContain('inputs: { element: [0, "element", "element", coerceElement] }');
+            .toContain(
+                'inputs: { element: [i0.ɵɵInputFlags.None, "element", "element", coerceElement] }');
         expect(jsContents).toContain('features: [i0.ɵɵInputTransformsFeature]');
         expect(dtsContents)
             .toContain(

diff --git a/packages/compiler/src/compiler_facade_interface.ts b/packages/compiler/src/compiler_facade_interface.ts
@@ -68,7 +68,7 @@ export interface CompilerFacade {
 }
 
 export interface CoreEnvironment {
-  [name: string]: Function;
+  [name: string]: unknown;
 }
 
 export type ResourceLoader = {

diff --git a/packages/compiler/src/render3/r3_identifiers.ts b/packages/compiler/src/render3/r3_identifiers.ts
@@ -375,6 +375,11 @@ export class Identifiers {
     moduleName: CORE,
   };
 
+  static InputFlags: o.ExternalReference = {
+    name: 'ɵɵInputFlags',
+    moduleName: CORE,
+  };
+
   // sanitization-related functions
   static sanitizeHtml: o.ExternalReference = {name: 'ɵɵsanitizeHtml', moduleName: CORE};
   static sanitizeStyle: o.ExternalReference = {name: 'ɵɵsanitizeStyle', moduleName: CORE};

diff --git a/packages/compiler/src/render3/view/util.ts b/packages/compiler/src/render3/view/util.ts
@@ -210,15 +210,16 @@ export function conditionallyCreateDirectiveBindingLiteral(
       const hasTransform = value.transformFunction !== null;
 
       // Build up input flags
-      let flags = 0;
+      let flags: o.Expression|null = null;
       if (value.isSignal) {
-        flags = flags | InputFlags.SignalBased;
+        flags = o.importExpr(R3.InputFlags).prop(InputFlags[InputFlags.SignalBased]);
       }
 
       // Inputs, compared to outputs, will track their declared name (for `ngOnChanges`), or support
       // transform functions, or store flag information if there is any.
-      if (forInputs && (differentDeclaringName || hasTransform || flags !== 0)) {
-        const result: o.Expression[] = [o.literal(flags), asLiteral(publicName)];
+      if (forInputs && (differentDeclaringName || hasTransform || flags !== null)) {
+        const flagsExpr = flags ?? o.importExpr(R3.InputFlags).prop(InputFlags[InputFlags.None]);
+        const result: o.Expression[] = [flagsExpr, asLiteral(publicName)];
 
         if (differentDeclaringName || hasTransform) {
           result.push(asLiteral(declaredName));

diff --git a/packages/core/src/compiler/compiler_facade_interface.ts b/packages/core/src/compiler/compiler_facade_interface.ts
@@ -68,7 +68,7 @@ export interface CompilerFacade {
 }
 
 export interface CoreEnvironment {
-  [name: string]: Function;
+  [name: string]: unknown;
 }
 
 export type ResourceLoader = {

diff --git a/packages/core/src/core_render3_private_export.ts b/packages/core/src/core_render3_private_export.ts
@@ -316,5 +316,6 @@ export { AfterRenderEventManager as ɵAfterRenderEventManager, internalAfterNext
 export {depsTracker as ɵdepsTracker, USE_RUNTIME_DEPS_TRACKER_FOR_JIT as ɵUSE_RUNTIME_DEPS_TRACKER_FOR_JIT} from './render3/deps_tracker/deps_tracker';
 export {generateStandaloneInDeclarationsError as ɵgenerateStandaloneInDeclarationsError} from './render3/jit/module';
 export {getAsyncClassMetadataFn as ɵgetAsyncClassMetadataFn} from './render3/metadata';
+export {InputFlags as ɵɵInputFlags} from './render3/interfaces/definition';
 
 // clang-format on
diff --git a/packages/core/src/render3/jit/environment.ts b/packages/core/src/render3/jit/environment.ts
@@ -10,6 +10,7 @@ import {forwardRef, resolveForwardRef} from '../../di/forward_ref';
 import {ɵɵinject, ɵɵinvalidFactoryDep} from '../../di/injector_compatibility';
 import {ɵɵdefineInjectable, ɵɵdefineInjector} from '../../di/interface/defs';
 import {registerNgModuleType} from '../../linker/ng_module_registration';
+import {InputFlags} from '../../render3/interfaces/definition';
 import * as iframe_attrs_validation from '../../sanitization/iframe_attrs_validation';
 import * as sanitization from '../../sanitization/sanitization';
 import * as r3 from '../index';
@@ -20,7 +21,7 @@ import * as r3 from '../index';
  *
  * This should be kept up to date with the public exports of @angular/core.
  */
-export const angularCoreEnv: {[name: string]: Function} =
+export const angularCoreEnv: {[name: string]: unknown} =
     (() => ({
        'ɵɵattribute': r3.ɵɵattribute,
        'ɵɵattributeInterpolate1': r3.ɵɵattributeInterpolate1,
@@ -199,4 +200,6 @@ export const angularCoreEnv: {[name: string]: Function} =
 
        'forwardRef': forwardRef,
        'resolveForwardRef': resolveForwardRef,
+
+       'ɵɵInputFlags': InputFlags,
      }))();