fix(cloud_functions): Allow raw data arguments to be passed as data to Cloud Function for Android & iOS. (#7994)

russellwheatley · Salakar · web-flow · commit 8288b811f2b8 · 2022-03-10T09:52:16.000Z
Co-authored-by: Mike Diarmid &lt;mike.diarmid@gmail.com&gt;
diff --git a/.github/workflows/scripts/functions/src/index.ts b/.github/workflows/scripts/functions/src/index.ts
@@ -61,6 +61,10 @@ export const testFunctionDefaultRegion = functions.https.onCall((data) => {
     return 'array';
   }
 
+  if(data.type === 'rawData') {
+    return data;
+  }
+
   const sampleData: {
     [key: string]: any;
   } = {
diff --git a/packages/cloud_functions/cloud_functions/example/lib/firebase_config.dart b/packages/cloud_functions/cloud_functions/example/lib/firebase_config.dart
diff --git a/packages/cloud_functions/cloud_functions/example/lib/firebase_options.dart b/packages/cloud_functions/cloud_functions/example/lib/firebase_options.dart
@@ -0,0 +1,77 @@
+// File generated by FlutterFire CLI.
+import 'package:firebase_core/firebase_core.dart' show FirebaseOptions;
+import 'package:flutter/foundation.dart'
+    show defaultTargetPlatform, kIsWeb, TargetPlatform;
+
+class DefaultFirebaseOptions {
+  static FirebaseOptions get currentPlatform {
+    if (kIsWeb) {
+      return web;
+    }
+    // ignore: missing_enum_constant_in_switch
+    switch (defaultTargetPlatform) {
+      case TargetPlatform.android:
+        return android;
+      case TargetPlatform.iOS:
+        return ios;
+      case TargetPlatform.macOS:
+        return macos;
+    }
+
+    throw UnsupportedError(
+      'DefaultFirebaseOptions are not supported for this platform.',
+    );
+  }
+
+  static const FirebaseOptions web = FirebaseOptions(
+    apiKey: 'AIzaSyB7wZb2tO1-Fs6GbDADUSTs2Qs3w08Hovw',
+    appId: '1:406099696497:web:d15569c1e161ad253574d0',
+    messagingSenderId: '406099696497',
+    projectId: 'flutterfire-e2e-tests',
+    authDomain: 'flutterfire-e2e-tests.firebaseapp.com',
+    databaseURL:
+        'https://flutterfire-e2e-tests-default-rtdb.europe-west1.firebasedatabase.app',
+    storageBucket: 'flutterfire-e2e-tests.appspot.com',
+    measurementId: 'G-Q5JXJGXDS9',
+  );
+
+  static const FirebaseOptions android = FirebaseOptions(
+    apiKey: 'AIzaSyCdRjCVZlhrq72RuEklEyyxYlBRCYhI2Sw',
+    appId: '1:406099696497:android:7ca3394493cc601a3574d0',
+    messagingSenderId: '406099696497',
+    projectId: 'flutterfire-e2e-tests',
+    databaseURL:
+        'https://flutterfire-e2e-tests-default-rtdb.europe-west1.firebasedatabase.app',
+    storageBucket: 'flutterfire-e2e-tests.appspot.com',
+  );
+
+  static const FirebaseOptions ios = FirebaseOptions(
+    apiKey: 'AIzaSyDooSUGSf63Ghq02_iIhtnmwMDs4HlWS6c',
+    appId: '1:406099696497:ios:69e46ec5e92b32c83574d0',
+    messagingSenderId: '406099696497',
+    projectId: 'flutterfire-e2e-tests',
+    databaseURL:
+        'https://flutterfire-e2e-tests-default-rtdb.europe-west1.firebasedatabase.app',
+    storageBucket: 'flutterfire-e2e-tests.appspot.com',
+    androidClientId:
+        '406099696497-tvtvuiqogct1gs1s6lh114jeps7hpjm5.apps.googleusercontent.com',
+    iosClientId:
+        '406099696497-v19okv5oaniql5uouh7go85uld7pa4mo.apps.googleusercontent.com',
+    iosBundleId: 'io.flutter.plugins.firebase.functions.example',
+  );
+
+  static const FirebaseOptions macos = FirebaseOptions(
+    apiKey: 'AIzaSyDooSUGSf63Ghq02_iIhtnmwMDs4HlWS6c',
+    appId: '1:406099696497:ios:69e46ec5e92b32c83574d0',
+    messagingSenderId: '406099696497',
+    projectId: 'flutterfire-e2e-tests',
+    databaseURL:
+        'https://flutterfire-e2e-tests-default-rtdb.europe-west1.firebasedatabase.app',
+    storageBucket: 'flutterfire-e2e-tests.appspot.com',
+    androidClientId:
+        '406099696497-tvtvuiqogct1gs1s6lh114jeps7hpjm5.apps.googleusercontent.com',
+    iosClientId:
+        '406099696497-v19okv5oaniql5uouh7go85uld7pa4mo.apps.googleusercontent.com',
+    iosBundleId: 'io.flutter.plugins.firebase.functions.example',
+  );
+}
diff --git a/packages/cloud_functions/cloud_functions/example/lib/main.dart b/packages/cloud_functions/cloud_functions/example/lib/main.dart
@@ -5,14 +5,14 @@
 import 'dart:core';
 
 import 'package:cloud_functions/cloud_functions.dart';
-import 'package:cloud_functions_example/firebase_config.dart';
+import 'package:cloud_functions_example/firebase_options.dart';
 import 'package:firebase_core/firebase_core.dart';
 import 'package:flutter/material.dart';
 
 Future<void> main() async {
   WidgetsFlutterBinding.ensureInitialized();
 
-  await Firebase.initializeApp(options: DefaultFirebaseConfig.platformOptions);
+  await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
 
   // You should have the Functions Emulator running locally to use it
   // https://firebase.google.com/docs/functions/local-emulator
diff --git a/packages/cloud_functions/cloud_functions/lib/cloud_functions.dart b/packages/cloud_functions/cloud_functions/lib/cloud_functions.dart
@@ -6,6 +6,7 @@
 library cloud_functions;
 
 import 'dart:async';
+import 'dart:typed_data';
 
 import 'package:cloud_functions_platform_interface/cloud_functions_platform_interface.dart';
 import 'package:firebase_core/firebase_core.dart';
diff --git a/packages/cloud_functions/cloud_functions/lib/src/https_callable.dart b/packages/cloud_functions/cloud_functions/lib/src/https_callable.dart
@@ -32,7 +32,33 @@ class HttpsCallable {
   /// the user is also automatically included.
   Future<HttpsCallableResult<T>> call<T>([dynamic parameters]) async {
     assert(_debugIsValidParameterType(parameters));
-    return HttpsCallableResult<T>._(await delegate.call(parameters));
+
+    Object? updatedParameters;
+    if (parameters is Map) {
+      Map update = {};
+      parameters.forEach((key, value) {
+        update[key] = _updateRawDataToList(value);
+      });
+      updatedParameters = update;
+    } else if (parameters is List) {
+      List update = parameters.map(_updateRawDataToList).toList();
+      updatedParameters = update;
+    } else {
+      updatedParameters = _updateRawDataToList(parameters);
+    }
+    return HttpsCallableResult<T>._(await delegate.call(updatedParameters));
+  }
+}
+
+dynamic _updateRawDataToList(dynamic value) {
+  if (value is Uint8List ||
+      value is Int32List ||
+      value is Int64List ||
+      value is Float32List ||
+      value is Float64List) {
+    return value.toList();
+  } else {
+    return value;
   }
 }
 
diff --git a/tests/test_driver/cloud_functions/cloud_functions_e2e.dart b/tests/test_driver/cloud_functions/cloud_functions_e2e.dart
@@ -2,9 +2,12 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'dart:typed_data';
+
 import 'package:cloud_functions/cloud_functions.dart';
 import 'package:firebase_core/firebase_core.dart';
 import 'package:drive/drive.dart';
+import 'package:flutter/foundation.dart';
 
 import '../firebase_default_options.dart';
 
@@ -84,6 +87,28 @@ void setupTests() {
         expect(result.data, equals(data.deepList));
       });
 
+      test(
+        'accepts raw data as arguments',
+        () async {
+          HttpsCallableResult result = await callable({
+            'type': 'rawData',
+            'list': Uint8List(100),
+            'int': Int32List(39),
+            'long': Int64List(45),
+            'float': Float32List(23),
+            'double': Float64List(1001),
+          });
+          final data = result.data;
+          expect(data['list'], isA<List>());
+          expect(data['int'], isA<List>());
+          expect(data['long'], isA<List>());
+          expect(data['float'], isA<List>());
+          expect(data['double'], isA<List>());
+        },
+				// Int64List is not supported on Web.
+        skip: kIsWeb,
+      );
+
       test(
         '[HttpsCallableResult.data] should return Map<String, dynamic> type for returned objects',
         () async {
