feat: support Array<ArrayBuffer> as a TurboModule method parameter

Author: paradowstack

packages/react-native-codegen/src/generators/modules/GenerateModuleJavaSpec.js

@@ -25,7 +25,11 @@ import type {AliasResolver} from './Utils';
 const {unwrapNullable} = require('../../parsers/parsers-commons');
 const {wrapOptional} = require('../TypeUtils/Java');
 const {parseValidUnionType, toPascalCase} = require('../Utils');
-const {createAliasResolver, getModules} = require('./Utils');
+const {
+  createAliasResolver,
+  getModules,
+  isArrayBufferElementType,
+} = require('./Utils');
 
 type FilesOutput = Map<string, string>;
 
@@ -272,6 +276,10 @@ function translateFunctionParamToJavaType(
       imports.add('com.facebook.react.bridge.ReadableMap');
       return wrapOptional('ReadableMap', isRequired);
     case 'ArrayTypeAnnotation':
+      if (isArrayBufferElementType(realTypeAnnotation.elementType)) {
+        imports.add('com.facebook.react.bridge.ArrayBuffer');
+        return wrapOptional('ArrayBuffer[]', isRequired);
+      }
       imports.add('com.facebook.react.bridge.ReadableArray');
       return wrapOptional('ReadableArray', isRequired);
     case 'FunctionTypeAnnotation':

packages/react-native-codegen/src/generators/modules/GenerateModuleJniCpp.js

@@ -24,7 +24,11 @@ import type {AliasResolver} from './Utils';
 
 const {unwrapNullable} = require('../../parsers/parsers-commons');
 const {parseValidUnionType} = require('../Utils');
-const {createAliasResolver, getModules} = require('./Utils');
+const {
+  createAliasResolver,
+  getModules,
+  isArrayBufferElementType,
+} = require('./Utils');
 
 type FilesOutput = Map<string, string>;
 
@@ -308,7 +312,9 @@ function translateParamTypeToJniType(
     case 'ObjectTypeAnnotation':
       return 'Lcom/facebook/react/bridge/ReadableMap;';
     case 'ArrayTypeAnnotation':
-      return 'Lcom/facebook/react/bridge/ReadableArray;';
+      return isArrayBufferElementType(realTypeAnnotation.elementType)
+        ? '[Lcom/facebook/react/bridge/ArrayBuffer;'
+        : 'Lcom/facebook/react/bridge/ReadableArray;';
     case 'FunctionTypeAnnotation':
       return 'Lcom/facebook/react/bridge/Callback;';
     case 'ArrayBufferTypeAnnotation':

packages/react-native-codegen/src/generators/modules/GenerateModuleObjCpp/serializeMethod.js

@@ -26,6 +26,7 @@ const {
 } = require('../../../parsers/parsers-commons');
 const {wrapOptional} = require('../../TypeUtils/Objective-C');
 const {capitalize, parseValidUnionType} = require('../../Utils');
+const {isArrayBufferElementType} = require('../Utils');
 const {getNamespacedStructName} = require('./Utils');
 const invariant = require('invariant');
 
@@ -218,6 +219,11 @@ function getParamObjCType(
        *   type Animal = {};
        *   Array<Animal> => NSArray<JS::NativeSampleTurboModule::Animal *>, etc.
        */
+      if (isArrayBufferElementType(typeAnnotation.elementType)) {
+        return notStruct(
+          wrapOptional('NSArray<RCTArrayBuffer *> *', !nullable),
+        );
+      }
       return notStruct(wrapOptional('NSArray *', !nullable));
     }
     case 'ArrayBufferTypeAnnotation': {

packages/react-native-codegen/src/generators/modules/Utils.js

@@ -12,11 +12,13 @@
 
 import type {
   NativeModuleAliasMap,
+  NativeModuleBaseTypeAnnotation,
   NativeModuleObjectTypeAnnotation,
   NativeModuleSchema,
   NativeModuleTypeAnnotation,
   Nullable,
   SchemaType,
+  UnsafeAnyTypeAnnotation,
 } from '../../CodegenSchema';
 
 const {unwrapNullable} = require('../../parsers/parsers-commons');
@@ -77,9 +79,29 @@ function isArrayRecursiveMember(
   );
 }
 
+/**
+ * Whether an array's element type is `ArrayBuffer`. Rejects nullable elements
+ * (`Array<?ArrayBuffer>`) so generators fall back to an untyped array. Handles
+ * the `AnyTypeAnnotation` that `emitArrayType` substitutes when the element
+ * type failed to parse.
+ */
+function isArrayBufferElementType(
+  elementType:
+    Nullable<NativeModuleBaseTypeAnnotation> | UnsafeAnyTypeAnnotation,
+): boolean {
+  if (elementType == null || elementType.type === 'AnyTypeAnnotation') {
+    return false;
+  }
+  if (elementType.type === 'NullableTypeAnnotation') {
+    return false;
+  }
+  return elementType.type === 'ArrayBufferTypeAnnotation';
+}
+
 module.exports = {
   createAliasResolver,
   getModules,
   isDirectRecursiveMember,
   isArrayRecursiveMember,
+  isArrayBufferElementType,
 };

packages/react-native-codegen/src/generators/modules/__test_fixtures__/fixtures.js

@@ -2692,6 +2692,28 @@ const ARRAY_BUFFER_NATIVE_MODULE: SchemaType = {
               params: [],
             },
           },
+          {
+            name: 'arrayBufferArray',
+            optional: false,
+            typeAnnotation: {
+              type: 'FunctionTypeAnnotation',
+              returnTypeAnnotation: {
+                type: 'NumberTypeAnnotation',
+              },
+              params: [
+                {
+                  name: 'values',
+                  optional: false,
+                  typeAnnotation: {
+                    type: 'ArrayTypeAnnotation',
+                    elementType: {
+                      type: 'ArrayBufferTypeAnnotation',
+                    },
+                  },
+                },
+              ],
+            },
+          },
         ],
       },
       moduleName: 'SampleTurboModule',

packages/react-native-codegen/src/generators/modules/__tests__/GenerateModuleHObjCpp-test.js

@@ -31,4 +31,16 @@ describe('GenerateModuleHObjCpp', () => {
         ).toMatchSnapshot();
       });
     });
+
+  it('generates NSArray<RCTArrayBuffer *> for a top-level Array<ArrayBuffer> parameter', () => {
+    const output = generator.generate(
+      'array_buffer_native_module',
+      fixtures.array_buffer_native_module,
+      'com.facebook.fbreact.specs',
+      false,
+    );
+    expect([...output.values()].join('\n')).toContain(
+      'arrayBufferArray:(NSArray<RCTArrayBuffer *> *)values',
+    );
+  });
 });

packages/react-native-codegen/src/generators/modules/__tests__/GenerateModuleJavaSpec-test.js

@@ -29,4 +29,60 @@ describe('GenerateModuleJavaSpec', () => {
         ).toMatchSnapshot();
       });
     });
+
+  it('generates ArrayBuffer[] for a top-level Array<ArrayBuffer> parameter', () => {
+    const output = generator.generate(
+      'array_buffer_native_module',
+      fixtures.array_buffer_native_module,
+      'com.facebook.fbreact.specs',
+    );
+    expect([...output.values()].join('\n')).toContain('ArrayBuffer[] values');
+  });
+
+  it('does not generate ArrayBuffer[] when array element type is nullable', () => {
+    const schema: $FlowFixMe = {
+      modules: {
+        NativeSampleTurboModule: {
+          type: 'NativeModule',
+          aliasMap: {},
+          enumMap: {},
+          moduleName: 'SampleTurboModule',
+          spec: {
+            eventEmitters: [],
+            methods: [
+              {
+                name: 'nullableElements',
+                optional: false,
+                typeAnnotation: {
+                  type: 'FunctionTypeAnnotation',
+                  returnTypeAnnotation: {type: 'NumberTypeAnnotation'},
+                  params: [
+                    {
+                      name: 'values',
+                      optional: false,
+                      typeAnnotation: {
+                        type: 'ArrayTypeAnnotation',
+                        elementType: {
+                          type: 'NullableTypeAnnotation',
+                          typeAnnotation: {type: 'ArrayBufferTypeAnnotation'},
+                        },
+                      },
+                    },
+                  ],
+                },
+              },
+            ],
+          },
+        },
+      },
+    };
+    const output = generator.generate(
+      'nullable_array_buffer_elements',
+      schema,
+      'com.facebook.fbreact.specs',
+    );
+    const contents = [...output.values()].join('\n');
+    expect(contents).toContain('nullableElements(ReadableArray values)');
+    expect(contents).not.toMatch(/nullableElements\(ArrayBuffer\[\] values\)/);
+  });
 });

packages/react-native-codegen/src/generators/modules/__tests__/GenerateModuleJniCpp-test.js

@@ -29,4 +29,15 @@ describe('GenerateModuleJniCpp', () => {
         ).toMatchSnapshot();
       });
     });
+
+  it('generates a JNI ArrayBuffer array signature for a top-level Array<ArrayBuffer> parameter', () => {
+    const output = generator.generate(
+      'array_buffer_native_module',
+      fixtures.array_buffer_native_module,
+      'com.facebook.fbreact.specs',
+    );
+    expect([...output.values()].join('\n')).toContain(
+      '[Lcom/facebook/react/bridge/ArrayBuffer;',
+    );
+  });
 });

packages/react-native-codegen/src/generators/modules/__tests__/__snapshots__/GenerateModuleH-test.js.snap

@@ -69,6 +69,7 @@ protected:
     methodMap_[\\"voidNullableArrayBuffer\\"] = MethodMetadata {.argCount = 1, .invoker = __voidNullableArrayBuffer};
     methodMap_[\\"promiseArrayBuffer\\"] = MethodMetadata {.argCount = 0, .invoker = __promiseArrayBuffer};
     methodMap_[\\"promiseNullableArrayBuffer\\"] = MethodMetadata {.argCount = 0, .invoker = __promiseNullableArrayBuffer};
+    methodMap_[\\"arrayBufferArray\\"] = MethodMetadata {.argCount = 1, .invoker = __arrayBufferArray};
   }
 
 private:
@@ -108,6 +109,14 @@ private:
       \\"Expected promiseNullableArrayBuffer(...) to have 1 parameters\\");
     return bridging::callFromJs<jsi::Value>(rt, &T::promiseNullableArrayBuffer,  static_cast<NativeSampleTurboModuleCxxSpec*>(&turboModule)->jsInvoker_, static_cast<T*>(&turboModule));
   }
+
+  static jsi::Value __arrayBufferArray(jsi::Runtime &rt, TurboModule &turboModule, const jsi::Value* args, size_t count) {
+    static_assert(
+      bridging::getParameterCount(&T::arrayBufferArray) == 2,
+      \\"Expected arrayBufferArray(...) to have 2 parameters\\");
+    return bridging::callFromJs<double>(rt, &T::arrayBufferArray,  static_cast<NativeSampleTurboModuleCxxSpec*>(&turboModule)->jsInvoker_, static_cast<T*>(&turboModule),
+      count <= 0 ? throw jsi::JSError(rt, \\"Expected argument in position 0 to be passed\\") : args[0].asObject(rt).asArray(rt));
+  }
 };
 
 } // namespace facebook::react

packages/react-native-codegen/src/generators/modules/__tests__/__snapshots__/GenerateModuleHObjCpp-test.js.snap

@@ -111,6 +111,7 @@ Map {
                     reject:(RCTPromiseRejectBlock)reject;
 - (void)promiseNullableArrayBuffer:(RCTPromiseResolveBlock)resolve
                             reject:(RCTPromiseRejectBlock)reject;
+- (NSNumber *)arrayBufferArray:(NSArray<RCTArrayBuffer *> *)values;
 
 @end