[compiler] Type provider infra for tests

ghstack-source-id: bfdbf67e3dd0cbfd511bed0bd6ba92266cf99ab8 Pull Request resolved: #30776
facebook · Aug 21, 2024 · 529abd3 · 529abd3
1 parent 8ece668
commit 529abd3
Show file tree

Hide file tree

Showing 29 changed files with 1,020 additions and 57 deletions.
diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts
@@ -29,6 +29,7 @@ import {
   NonLocalBinding,
   PolyType,
   ScopeId,
+  SourceLocation,
   Type,
   ValidatedIdentifier,
   ValueKind,
@@ -126,11 +127,6 @@ const HookSchema = z.object({
 
 export type Hook = z.infer<typeof HookSchema>;
 
-export const ModuleTypeResolver = z
-  .function()
-  .args(z.string())
-  .returns(z.nullable(TypeSchema));
-
 /*
  * TODO(mofeiZ): User defined global types (with corresponding shapes).
  * User defined global types should have inline ObjectShapes instead of directly
@@ -148,7 +144,7 @@ const EnvironmentConfigSchema = z.object({
    * A function that, given the name of a module, can optionally return a description
    * of that module's type signature.
    */
-  resolveModuleTypeSchema: z.nullable(ModuleTypeResolver).default(null),
+  moduleTypeProvider: z.nullable(z.function().args(z.string())).default(null),
 
   /**
    * A list of functions which the application compiles as macros, where
@@ -712,19 +708,27 @@ export class Environment {
     return this.#outlinedFunctions;
   }
 
-  #resolveModuleType(moduleName: string): Global | null {
-    if (this.config.resolveModuleTypeSchema == null) {
+  #resolveModuleType(moduleName: string, loc: SourceLocation): Global | null {
+    if (this.config.moduleTypeProvider == null) {
       return null;
     }
     let moduleType = this.#moduleTypes.get(moduleName);
     if (moduleType === undefined) {
-      const moduleConfig = this.config.resolveModuleTypeSchema(moduleName);
-      if (moduleConfig != null) {
-        const moduleTypes = TypeSchema.parse(moduleConfig);
+      const unparsedModuleConfig = this.config.moduleTypeProvider(moduleName);
+      if (unparsedModuleConfig != null) {
+        const parsedModuleConfig = TypeSchema.safeParse(unparsedModuleConfig);
+        if (!parsedModuleConfig.success) {
+          CompilerError.throwInvalidConfig({
+            reason: `Could not parse module type, the configured \`moduleTypeProvider\` function returned an invalid module description`,
+            description: parsedModuleConfig.error.toString(),
+            loc,
+          });
+        }
+        const moduleConfig = parsedModuleConfig.data;
         moduleType = installTypeConfig(
           this.#globals,
           this.#shapes,
-          moduleTypes,
+          moduleConfig,
         );
       } else {
         moduleType = null;
@@ -734,7 +738,10 @@ export class Environment {
     return moduleType;
   }
 
-  getGlobalDeclaration(binding: NonLocalBinding): Global | null {
+  getGlobalDeclaration(
+    binding: NonLocalBinding,
+    loc: SourceLocation,
+  ): Global | null {
     if (this.config.hookPattern != null) {
       const match = new RegExp(this.config.hookPattern).exec(binding.name);
       if (
@@ -772,7 +779,7 @@ export class Environment {
             (isHookName(binding.imported) ? this.#getCustomHookType() : null)
           );
         } else {
-          const moduleType = this.#resolveModuleType(binding.module);
+          const moduleType = this.#resolveModuleType(binding.module, loc);
           if (moduleType !== null) {
             const importedType = this.getPropertyType(
               moduleType,
@@ -805,10 +812,16 @@ export class Environment {
             (isHookName(binding.name) ? this.#getCustomHookType() : null)
           );
         } else {
-          const moduleType = this.#resolveModuleType(binding.module);
+          const moduleType = this.#resolveModuleType(binding.module, loc);
           if (moduleType !== null) {
-            // TODO: distinguish default/namespace cases
-            return moduleType;
+            if (binding.kind === 'ImportDefault') {
+              const defaultType = this.getPropertyType(moduleType, 'default');
+              if (defaultType !== null) {
+                return defaultType;
+              }
+            } else {
+              return moduleType;
+            }
           }
           return isHookName(binding.name) ? this.#getCustomHookType() : null;
         }
@@ -819,9 +832,7 @@ export class Environment {
   #isKnownReactModule(moduleName: string): boolean {
     return (
       moduleName.toLowerCase() === 'react' ||
-      moduleName.toLowerCase() === 'react-dom' ||
-      (this.config.enableSharedRuntime__testonly &&
-        moduleName === 'shared-runtime')
+      moduleName.toLowerCase() === 'react-dom'
     );
   }
 

diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/Globals.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/Globals.ts
@@ -551,6 +551,9 @@ export function installTypeConfig(
         case 'Ref': {
           return {kind: 'Object', shapeId: BuiltInUseRefId};
         }
+        case 'Any': {
+          return {kind: 'Poly'};
+        }
         default: {
           assertExhaustive(
             typeConfig.name,
@@ -566,6 +569,20 @@ export function installTypeConfig(
         calleeEffect: typeConfig.calleeEffect,
         returnType: installTypeConfig(globals, shapes, typeConfig.returnType),
         returnValueKind: typeConfig.returnValueKind,
+        noAlias: typeConfig.noAlias === true,
+        mutableOnlyIfOperandsAreMutable:
+          typeConfig.mutableOnlyIfOperandsAreMutable === true,
+      });
+    }
+    case 'hook': {
+      return addHook(shapes, {
+        hookKind: 'Custom',
+        positionalParams: typeConfig.positionalParams ?? [],
+        restParam: typeConfig.restParam ?? Effect.Freeze,
+        calleeEffect: Effect.Read,
+        returnType: installTypeConfig(globals, shapes, typeConfig.returnType),
+        returnValueKind: typeConfig.returnValueKind ?? ValueKind.Frozen,
+        noAlias: typeConfig.noAlias === true,
       });
     }
     case 'object': {
@@ -578,6 +595,12 @@ export function installTypeConfig(
         ]),
       );
     }
+    default: {
+      assertExhaustive(
+        typeConfig,
+        `Unexpected type kind '${(typeConfig as any).kind}'`,
+      );
+    }
   }
 }
 

diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/HIR.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/HIR.ts
@@ -1361,6 +1361,15 @@ export enum ValueKind {
   Context = 'context',
 }
 
+export const ValueKindSchema = z.enum([
+  ValueKind.MaybeFrozen,
+  ValueKind.Frozen,
+  ValueKind.Primitive,
+  ValueKind.Global,
+  ValueKind.Mutable,
+  ValueKind.Context,
+]);
+
 // The effect with which a value is modified.
 export enum Effect {
   // Default value: not allowed after lifetime inference

diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/TypeSchema.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/TypeSchema.ts
@@ -8,7 +8,7 @@
 import {isValidIdentifier} from '@babel/types';
 import {z} from 'zod';
 import {Effect, ValueKind} from '..';
-import {EffectSchema} from './HIR';
+import {EffectSchema, ValueKindSchema} from './HIR';
 
 export type ObjectPropertiesConfig = {[key: string]: TypeConfig};
 export const ObjectPropertiesSchema: z.ZodType<ObjectPropertiesConfig> = z
@@ -18,9 +18,9 @@ export const ObjectPropertiesSchema: z.ZodType<ObjectPropertiesConfig> = z
   )
   .refine(record => {
     return Object.keys(record).every(
-      key => key === '*' || isValidIdentifier(key),
+      key => key === '*' || key === 'default' || isValidIdentifier(key),
     );
-  }, 'Expected all "object" property names to be valid identifiers or `*` to match any property');
+  }, 'Expected all "object" property names to be valid identifier, `*` to match any property, of `default` to define a module default export');
 
 export type ObjectTypeConfig = {
   kind: 'object';
@@ -38,18 +38,45 @@ export type FunctionTypeConfig = {
   calleeEffect: Effect;
   returnType: TypeConfig;
   returnValueKind: ValueKind;
+  noAlias?: boolean | null | undefined;
+  mutableOnlyIfOperandsAreMutable?: boolean | null | undefined;
 };
 export const FunctionTypeSchema: z.ZodType<FunctionTypeConfig> = z.object({
   kind: z.literal('function'),
   positionalParams: z.array(EffectSchema),
   restParam: EffectSchema.nullable(),
   calleeEffect: EffectSchema,
   returnType: z.lazy(() => TypeSchema),
-  returnValueKind: z.nativeEnum(ValueKind),
+  returnValueKind: ValueKindSchema,
+  noAlias: z.boolean().nullable().optional(),
+  mutableOnlyIfOperandsAreMutable: z.boolean().nullable().optional(),
 });
 
-export type BuiltInTypeConfig = 'Ref' | 'Array' | 'Primitive' | 'MixedReadonly';
+export type HookTypeConfig = {
+  kind: 'hook';
+  positionalParams?: Array<Effect> | null | undefined;
+  restParam?: Effect | null | undefined;
+  returnType: TypeConfig;
+  returnValueKind?: ValueKind | null | undefined;
+  noAlias?: boolean | null | undefined;
+};
+export const HookTypeSchema: z.ZodType<HookTypeConfig> = z.object({
+  kind: z.literal('hook'),
+  positionalParams: z.array(EffectSchema).nullable().optional(),
+  restParam: EffectSchema.nullable().optional(),
+  returnType: z.lazy(() => TypeSchema),
+  returnValueKind: ValueKindSchema.nullable().optional(),
+  noAlias: z.boolean().nullable().optional(),
+});
+
+export type BuiltInTypeConfig =
+  | 'Any'
+  | 'Ref'
+  | 'Array'
+  | 'Primitive'
+  | 'MixedReadonly';
 export const BuiltInTypeSchema: z.ZodType<BuiltInTypeConfig> = z.union([
+  z.literal('Any'),
   z.literal('Ref'),
   z.literal('Array'),
   z.literal('Primitive'),
@@ -68,9 +95,11 @@ export const TypeReferenceSchema: z.ZodType<TypeReferenceConfig> = z.object({
 export type TypeConfig =
   | ObjectTypeConfig
   | FunctionTypeConfig
+  | HookTypeConfig
   | TypeReferenceConfig;
 export const TypeSchema: z.ZodType<TypeConfig> = z.union([
   ObjectTypeSchema,
   FunctionTypeSchema,
+  HookTypeSchema,
   TypeReferenceSchema,
 ]);
diff --git a/compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts b/compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts
@@ -127,7 +127,7 @@ function collectTemporaries(
       break;
     }
     case 'LoadGlobal': {
-      const global = env.getGlobalDeclaration(value.binding);
+      const global = env.getGlobalDeclaration(value.binding, value.loc);
       const hookKind = global !== null ? getHookKindForType(env, global) : null;
       const lvalId = instr.lvalue.identifier.id;
       if (hookKind === 'useMemo' || hookKind === 'useCallback') {

diff --git a/compiler/packages/babel-plugin-react-compiler/src/TypeInference/InferTypes.ts b/compiler/packages/babel-plugin-react-compiler/src/TypeInference/InferTypes.ts
@@ -227,7 +227,7 @@ function* generateInstructionTypes(
     }
 
     case 'LoadGlobal': {
-      const globalType = env.getGlobalDeclaration(value.binding);
+      const globalType = env.getGlobalDeclaration(value.binding, value.loc);
       if (globalType) {
         yield equation(left, globalType);
       }

diff --git a/..._/fixtures/compiler/destructuring-mixed-scope-declarations-and-locals.expect.md b/..._/fixtures/compiler/destructuring-mixed-scope-declarations-and-locals.expect.md
@@ -2,6 +2,8 @@
 ## Input
 
 ```javascript
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const post = useFragment(
     graphql`
@@ -36,6 +38,8 @@ function Component(props) {
 
 ```javascript
 import { c as _c } from "react/compiler-runtime";
+import { useFragment } from "shared-runtime";
+
 function Component(props) {
   const $ = _c(4);
   const post = useFragment(

diff --git a/...iler/src/__tests__/fixtures/compiler/destructuring-mixed-scope-declarations-and-locals.js b/...iler/src/__tests__/fixtures/compiler/destructuring-mixed-scope-declarations-and-locals.js
@@ -1,3 +1,5 @@
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const post = useFragment(
     graphql`

diff --git a/...-react-compiler/src/__tests__/fixtures/compiler/optional-call-logical.expect.md b/...-react-compiler/src/__tests__/fixtures/compiler/optional-call-logical.expect.md
@@ -2,6 +2,8 @@
 ## Input
 
 ```javascript
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const item = useFragment(
     graphql`
@@ -20,6 +22,8 @@ function Component(props) {
 
 ```javascript
 import { c as _c } from "react/compiler-runtime";
+import { useFragment } from "shared-runtime";
+
 function Component(props) {
   const $ = _c(2);
   const item = useFragment(

diff --git a/...ages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/optional-call-logical.js b/...ages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/optional-call-logical.js
@@ -1,3 +1,5 @@
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const item = useFragment(
     graphql`

diff --git a/...tests__/fixtures/compiler/readonly-object-method-calls-mutable-lambda.expect.md b/...tests__/fixtures/compiler/readonly-object-method-calls-mutable-lambda.expect.md
@@ -2,6 +2,8 @@
 ## Input
 
 ```javascript
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const x = makeObject();
   const user = useFragment(
@@ -28,6 +30,8 @@ function Component(props) {
 
 ```javascript
 import { c as _c } from "react/compiler-runtime";
+import { useFragment } from "shared-runtime";
+
 function Component(props) {
   const $ = _c(3);
   const x = makeObject();

diff --git a/...t-compiler/src/__tests__/fixtures/compiler/readonly-object-method-calls-mutable-lambda.js b/...t-compiler/src/__tests__/fixtures/compiler/readonly-object-method-calls-mutable-lambda.js
@@ -1,3 +1,5 @@
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const x = makeObject();
   const user = useFragment(

diff --git a/...compiler/src/__tests__/fixtures/compiler/readonly-object-method-calls.expect.md b/...compiler/src/__tests__/fixtures/compiler/readonly-object-method-calls.expect.md
@@ -2,6 +2,8 @@
 ## Input
 
 ```javascript
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const user = useFragment(
     graphql`
@@ -26,6 +28,8 @@ function Component(props) {
 
 ```javascript
 import { c as _c } from "react/compiler-runtime";
+import { useFragment } from "shared-runtime";
+
 function Component(props) {
   const $ = _c(5);
   const user = useFragment(

diff --git a/...bel-plugin-react-compiler/src/__tests__/fixtures/compiler/readonly-object-method-calls.js b/...bel-plugin-react-compiler/src/__tests__/fixtures/compiler/readonly-object-method-calls.js
@@ -1,3 +1,5 @@
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const user = useFragment(
     graphql`

diff --git a/...eact-compiler/src/__tests__/fixtures/compiler/tagged-template-in-hook.expect.md b/...eact-compiler/src/__tests__/fixtures/compiler/tagged-template-in-hook.expect.md
@@ -2,6 +2,8 @@
 ## Input
 
 ```javascript
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const user = useFragment(
     graphql`
@@ -19,6 +21,8 @@ function Component(props) {
 ## Code
 
 ```javascript
+import { useFragment } from "shared-runtime";
+
 function Component(props) {
   const user = useFragment(
     graphql`

diff --git a/...es/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/tagged-template-in-hook.js b/...es/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/tagged-template-in-hook.js
@@ -1,3 +1,5 @@
+import {useFragment} from 'shared-runtime';
+
 function Component(props) {
   const user = useFragment(
     graphql`