Parse and collect enum members in turbo module specs (#36044)

Summary: Pull Request resolved: #36044 > **Notice**: This commit does not change any behaviour. Parse and collect enum members in module specs instead of the current behaviour of parsing enum members as 'string' / 'number' and ignoring the member names. This commit would allow us to generate native Enums corresponding to the schema's enums. Prior to this commit, enum params were parsed as: ``` { 'name': 'qualityParam', 'optional': false, 'typeAnnotation': { 'type': 'EnumDeclaration', 'memberType': 'StringTypeAnnotation' } }, ``` The name of the enum type and the members of the enum type were ignored. After this commit, parsed modules would hold a new object member called `enumMap` that would look like this: ``` 'enumMap': { 'QualityEnum': { 'name': 'QualityEnum', 'type': 'EnumDeclarationWithMembers', 'memberType': 'StringTypeAnnotation', 'members': [ { 'name': 'SD', 'value': 'sd' }, { 'name': 'HD', 'value': 'hd' } ] }, // ... } ``` And enum params would be exported as: ``` { 'name': 'qualityParam', 'optional': false, 'typeAnnotation': { 'name': 'NativeModuleEnumTypeAnnotation', 'type': 'EnumDeclaration', 'memberType': 'StringTypeAnnotation' } }, ``` Combining the two new outputs would allow us to generate Native enums in the Native generators. Changelog: [Internal] Parse and collect enum members in turbo module specs Reviewed By: cipolleschi Differential Revision: D42778258 fbshipit-source-id: 56479342e085bc4e13c5a3e12b265b140e49893c
facebook · Feb 3, 2023 · 39bdb34 · 39bdb34
1 parent 53c9786
commit 39bdb34
Show file tree

Hide file tree

Showing 20 changed files with 999 additions and 170 deletions.
diff --git a/packages/react-native-codegen/src/CodegenSchema.js b/packages/react-native-codegen/src/CodegenSchema.js
@@ -223,6 +223,7 @@ export type NullableTypeAnnotation<+T: NativeModuleTypeAnnotation> = $ReadOnly<{
 export type NativeModuleSchema = $ReadOnly<{
   type: 'NativeModule',
   aliasMap: NativeModuleAliasMap,
+  enumMap: NativeModuleEnumMap,
   spec: NativeModuleSpec,
   moduleName: string,
   // Use for modules that are not used on other platforms.
@@ -239,6 +240,10 @@ export type NativeModulePropertyShape = NamedShape<
   Nullable<NativeModuleFunctionTypeAnnotation>,
 >;
 
+export type NativeModuleEnumMap = $ReadOnly<{
+  [enumName: string]: NativeModuleEnumDeclarationWithMembers,
+}>;
+
 export type NativeModuleAliasMap = $ReadOnly<{
   [aliasName: string]: NativeModuleObjectTypeAnnotation,
 }>;
@@ -287,11 +292,30 @@ export type NativeModuleBooleanTypeAnnotation = $ReadOnly<{
   type: 'BooleanTypeAnnotation',
 }>;
 
+export type NativeModuleEnumMembers = $ReadOnlyArray<
+  $ReadOnly<{
+    name: string,
+    value: string,
+  }>,
+>;
+
+export type NativeModuleEnumMemberType =
+  | 'NumberTypeAnnotation'
+  | 'StringTypeAnnotation';
+
 export type NativeModuleEnumDeclaration = $ReadOnly<{
+  name: string,
   type: 'EnumDeclaration',
-  memberType: 'NumberTypeAnnotation' | 'StringTypeAnnotation',
+  memberType: NativeModuleEnumMemberType,
 }>;
 
+export type NativeModuleEnumDeclarationWithMembers = {
+  name: string,
+  type: 'EnumDeclarationWithMembers',
+  memberType: NativeModuleEnumMemberType,
+  members: NativeModuleEnumMembers,
+};
+
 export type NativeModuleGenericObjectTypeAnnotation = $ReadOnly<{
   type: 'GenericObjectTypeAnnotation',
 }>;

diff --git a/packages/react-native-codegen/src/generators/__test_fixtures__/fixtures.js b/packages/react-native-codegen/src/generators/__test_fixtures__/fixtures.js
@@ -42,6 +42,7 @@ const SCHEMA_WITH_TM_AND_FC: SchemaType = {
     NativeCalculator: {
       type: 'NativeModule',
       aliasMap: {},
+      enumMap: {},
       spec: {
         properties: [
           {

diff --git a/packages/react-native-codegen/src/generators/modules/__test_fixtures__/fixtures.js b/packages/react-native-codegen/src/generators/modules/__test_fixtures__/fixtures.js
@@ -17,6 +17,7 @@ const EMPTY_NATIVE_MODULES: SchemaType = {
     NativeSampleTurboModule: {
       type: 'NativeModule',
       aliasMap: {},
+      enumMap: {},
       spec: {
         properties: [],
       },
@@ -30,6 +31,7 @@ const SIMPLE_NATIVE_MODULES: SchemaType = {
     NativeSampleTurboModule: {
       type: 'NativeModule',
       aliasMap: {},
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -342,6 +344,7 @@ const TWO_MODULES_DIFFERENT_FILES: SchemaType = {
     NativeSampleTurboModule: {
       type: 'NativeModule',
       aliasMap: {},
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -362,6 +365,7 @@ const TWO_MODULES_DIFFERENT_FILES: SchemaType = {
     NativeSampleTurboModule2: {
       type: 'NativeModule',
       aliasMap: {},
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -399,6 +403,7 @@ const COMPLEX_OBJECTS: SchemaType = {
     NativeSampleTurboModule: {
       type: 'NativeModule',
       aliasMap: {},
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -854,6 +859,7 @@ const NATIVE_MODULES_WITH_TYPE_ALIASES: SchemaType = {
           ],
         },
       },
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -1138,6 +1144,7 @@ const REAL_MODULE_EXAMPLE: SchemaType = {
           ],
         },
       },
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -1333,6 +1340,7 @@ const REAL_MODULE_EXAMPLE: SchemaType = {
           type: 'ObjectTypeAnnotation',
         },
       },
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -1508,6 +1516,7 @@ const CXX_ONLY_NATIVE_MODULES: SchemaType = {
           ],
         },
       },
+      enumMap: {},
       spec: {
         properties: [
           {
@@ -1648,6 +1657,7 @@ const SAMPLE_WITH_UPPERCASE_NAME: SchemaType = {
   modules: {
     NativeSampleTurboModule: {
       type: 'NativeModule',
+      enumMap: {},
       aliasMap: {},
       spec: {
         properties: [],

diff --git a/packages/react-native-codegen/src/parsers/__tests__/parsers-commons-test.js b/packages/react-native-codegen/src/parsers/__tests__/parsers-commons-test.js
@@ -277,6 +277,7 @@ describe('parseObjectProperty', () => {
   const moduleName = 'testModuleName';
   const types = {['wrongName']: 'wrongType'};
   const aliasMap = {};
+  const enumMap = {};
   const tryParse = () => null;
   const cxxOnly = false;
   const nullable = true;
@@ -305,6 +306,7 @@ describe('parseObjectProperty', () => {
           moduleName,
           types,
           aliasMap,
+          enumMap,
           tryParse,
           cxxOnly,
           nullable,
@@ -338,6 +340,7 @@ describe('parseObjectProperty', () => {
           moduleName,
           types,
           aliasMap,
+          enumMap,
           tryParse,
           cxxOnly,
           nullable,
@@ -375,6 +378,7 @@ describe('buildSchemaFromConfigType', () => {
   const moduleSchemaMock = {
     type: 'NativeModule',
     aliasMap: {},
+    enumMap: {},
     spec: {properties: []},
     moduleName: '',
   };
@@ -743,6 +747,7 @@ describe('buildSchema', () => {
           fileName: {
             type: 'NativeModule',
             aliasMap: {},
+            enumMap: {},
             spec: {
               properties: [
                 {

diff --git a/packages/react-native-codegen/src/parsers/__tests__/parsers-primitives-test.js b/packages/react-native-codegen/src/parsers/__tests__/parsers-primitives-test.js
@@ -29,6 +29,7 @@ const {
   emitStringish,
   emitMixed,
   typeAliasResolution,
+  typeEnumResolution,
 } = require('../parsers-primitives.js');
 const {MockedParser} = require('../parserMock');
 const {emitUnion} = require('../parsers-primitives');
@@ -264,14 +265,14 @@ describe('typeAliasResolution', () => {
     ],
   };
 
-  describe('when typeAliasResolutionStatus is successful', () => {
-    const typeAliasResolutionStatus = {successful: true, aliasName: 'Foo'};
+  describe('when typeResolution is successful', () => {
+    const typeResolution = {successful: true, type: 'alias', name: 'Foo'};
 
     describe('when nullable is true', () => {
       it('returns nullable TypeAliasTypeAnnotation and map it in aliasMap', () => {
         const aliasMap = {};
         const result = typeAliasResolution(
-          typeAliasResolutionStatus,
+          typeResolution,
           objectTypeAnnotation,
           aliasMap,
           true,
@@ -292,7 +293,7 @@ describe('typeAliasResolution', () => {
       it('returns non nullable TypeAliasTypeAnnotation and map it in aliasMap', () => {
         const aliasMap = {};
         const result = typeAliasResolution(
-          typeAliasResolutionStatus,
+          typeResolution,
           objectTypeAnnotation,
           aliasMap,
           false,
@@ -307,14 +308,14 @@ describe('typeAliasResolution', () => {
     });
   });
 
-  describe('when typeAliasResolutionStatus is not successful', () => {
-    const typeAliasResolutionStatus = {successful: false};
+  describe('when typeResolution is not successful', () => {
+    const typeResolution = {successful: false};
 
     describe('when nullable is true', () => {
       it('returns nullable ObjectTypeAnnotation', () => {
         const aliasMap = {};
         const result = typeAliasResolution(
-          typeAliasResolutionStatus,
+          typeResolution,
           objectTypeAnnotation,
           aliasMap,
           true,
@@ -332,7 +333,7 @@ describe('typeAliasResolution', () => {
       it('returns non nullable ObjectTypeAnnotation', () => {
         const aliasMap = {};
         const result = typeAliasResolution(
-          typeAliasResolutionStatus,
+          typeResolution,
           objectTypeAnnotation,
           aliasMap,
           false,
@@ -345,6 +346,98 @@ describe('typeAliasResolution', () => {
   });
 });
 
+describe('typeEnumResolution', () => {
+  describe('when typeResolution is successful', () => {
+    describe('when nullable is true', () => {
+      it('returns nullable EnumDeclaration and map it in enumMap', () => {
+        const enumMap = {};
+        const mockTypeAnnotation = {type: 'StringTypeAnnotation'};
+
+        const result = typeEnumResolution(
+          mockTypeAnnotation,
+          {successful: true, type: 'enum', name: 'Foo'},
+          true /* nullable */,
+          'SomeModule' /* name */,
+          'Flow',
+          enumMap,
+          parser,
+        );
+
+        expect(enumMap).toEqual({
+          Foo: {
+            type: 'EnumDeclarationWithMembers',
+            name: 'Foo',
+            memberType: 'StringTypeAnnotation',
+            members: [
+              {
+                name: 'Hello',
+                value: 'hello',
+              },
+              {
+                name: 'Goodbye',
+                value: 'goodbye',
+              },
+            ],
+          },
+        });
+
+        expect(result).toEqual({
+          type: 'NullableTypeAnnotation',
+          typeAnnotation: {
+            name: 'Foo',
+            type: 'EnumDeclaration',
+            memberType: 'StringTypeAnnotation',
+          },
+        });
+      });
+    });
+
+    describe('when nullable is false', () => {
+      it('returns non nullable TypeAliasTypeAnnotation and map it in aliasMap', () => {
+        const enumMap = {};
+        const mockTypeAnnotation = {type: 'NumberTypeAnnotation'};
+
+        const result = typeEnumResolution(
+          mockTypeAnnotation,
+          {successful: true, type: 'enum', name: 'Foo'},
+          true /* nullable */,
+          'SomeModule' /* name */,
+          'Flow',
+          enumMap,
+          parser,
+        );
+
+        expect(enumMap).toEqual({
+          Foo: {
+            type: 'EnumDeclarationWithMembers',
+            name: 'Foo',
+            memberType: 'NumberTypeAnnotation',
+            members: [
+              {
+                name: 'On',
+                value: '1',
+              },
+              {
+                name: 'Off',
+                value: '0',
+              },
+            ],
+          },
+        });
+
+        expect(result).toEqual({
+          type: 'NullableTypeAnnotation',
+          typeAnnotation: {
+            name: 'Foo',
+            type: 'EnumDeclaration',
+            memberType: 'NumberTypeAnnotation',
+          },
+        });
+      });
+    });
+  });
+});
+
 describe('emitPromise', () => {
   const moduleName = 'testModuleName';
 
@@ -362,6 +455,8 @@ describe('emitPromise', () => {
       {},
       /* aliasMap: {...NativeModuleAliasMap} */
       {},
+      /* enumMap: {...NativeModuleEnumMap} */
+      {},
       /* tryParse: ParserErrorCapturer */
       // $FlowFixMe[missing-local-annot]
       function <T>(_: () => T) {
@@ -991,6 +1086,8 @@ describe('emitArrayType', () => {
       {},
       /* aliasMap: {...NativeModuleAliasMap} */
       {},
+      /* enumMap: {...NativeModuleEnumMap} */
+      {},
       /* cxxOnly: boolean */
       false,
       nullable,