fix(functions): return correct type on native (#5709)

Author: russellwheatley

.editorconfig

@@ -8,3 +8,4 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+quote_type = single

.github/workflows/scripts/functions/src/index.ts

@@ -1,46 +1,42 @@
-import * as assert from "assert";
+import * as assert from 'assert';
 import * as functions from 'firebase-functions';
 
 // For example app.
 // noinspection JSUnusedGlobalSymbols
 export const listFruit = functions.https.onCall(() => {
-  return [
-    "Apple",
-    "Banana",
-    "Cherry",
-    "Date",
-    "Fig",
-    "Grapes"
-  ];
+  return ['Apple', 'Banana', 'Cherry', 'Date', 'Fig', 'Grapes'];
 });
 
-
 // For e2e testing a custom region.
 // noinspection JSUnusedGlobalSymbols
 export const testFunctionCustomRegion = functions
   .region('europe-west1')
   .https.onCall(() => 'europe-west1');
 
 // For e2e testing timeouts.
-export const testFunctionTimeout = functions
-  .https.onCall(data => {
-    console.log(JSON.stringify({data}));
-    return new Promise((resolve, reject) => {
-      if (data && data.testTimeout) {
-        setTimeout(() => resolve({timeLimit: 'exceeded'}), parseInt(data.testTimeout, 10));
-      } else {
-        reject(new functions.https.HttpsError(
+export const testFunctionTimeout = functions.https.onCall((data) => {
+  console.log(JSON.stringify({ data }));
+  return new Promise((resolve, reject) => {
+    if (data && data.testTimeout) {
+      setTimeout(
+        () => resolve({ timeLimit: 'exceeded' }),
+        parseInt(data.testTimeout, 10)
+      );
+    } else {
+      reject(
+        new functions.https.HttpsError(
           'invalid-argument',
           'testTimeout must be provided.'
-        ));
-      }
-    });
+        )
+      );
+    }
   });
+});
 
 // For e2e testing errors & return values.
 // noinspection JSUnusedGlobalSymbols
-export const testFunctionDefaultRegion = functions.https.onCall(data => {
-  console.log(JSON.stringify({data}));
+export const testFunctionDefaultRegion = functions.https.onCall((data) => {
+  console.log(JSON.stringify({ data }));
   if (typeof data === 'undefined') {
     return 'undefined';
   }
@@ -66,12 +62,12 @@ export const testFunctionDefaultRegion = functions.https.onCall(data => {
   }
 
   const sampleData: {
-    [key: string]: any
+    [key: string]: any;
   } = {
     number: 1234,
     string: 'acde',
     boolean: true,
-    'null': null,
+    null: null,
     map: {
       number: 1234,
       string: 'acde',
@@ -85,8 +81,8 @@ export const testFunctionDefaultRegion = functions.https.onCall(data => {
       booleanTrue: true,
       booleanFalse: false,
       null: null,
-      'list': ['1', 2, true, false],
-      'map': {
+      list: ['1', 2, true, false],
+      map: {
         number: 123,
         string: 'foo',
         booleanTrue: true,
@@ -95,7 +91,10 @@ export const testFunctionDefaultRegion = functions.https.onCall(data => {
       },
     },
     deepList: [
-      '1', 2, true, false,
+      '1',
+      2,
+      true,
+      false,
       ['1', 2, true, false],
       {
         number: 123,
@@ -107,10 +106,14 @@ export const testFunctionDefaultRegion = functions.https.onCall(data => {
     ],
   };
 
-  const {type, asError, inputData}: {
-    type: string,
-    asError?: boolean,
-    inputData?: any,
+  const {
+    type,
+    asError,
+    inputData,
+  }: {
+    type: string;
+    asError?: boolean;
+    inputData?: any;
   } = data;
   if (!Object.hasOwnProperty.call(sampleData, type)) {
     throw new functions.https.HttpsError(
@@ -144,3 +147,6 @@ export const testFunctionDefaultRegion = functions.https.onCall(data => {
   return outputData;
 });
 
+export const testMapConvertType = functions.https.onCall((data) => ({
+  foo: 'bar',
+}));

packages/cloud_functions/cloud_functions/example/test_driver/cloud_functions_e2e.dart

@@ -16,6 +16,7 @@ import 'sample.dart' as data;
 String kTestFunctionDefaultRegion = 'testFunctionDefaultRegion';
 String kTestFunctionCustomRegion = 'testFunctionCustomRegion';
 String kTestFunctionTimeout = 'testFunctionTimeout';
+String kTestMapConvertType = 'testMapConvertType';
 
 void testsMain() {
   HttpsCallable callable;
@@ -82,6 +83,17 @@ void testsMain() {
       });
       expect(result.data, equals(data.deepList));
     });
+
+    test(
+        '[HttpsCallableResult.data] should return Map<String, dynamic> type for returned objects',
+        () async {
+      HttpsCallable callable =
+          FirebaseFunctions.instance.httpsCallable(kTestMapConvertType);
+
+      var result = await callable();
+
+      expect(result.data, isA<Map<String, dynamic>>());
+    });
   });
 
   group('FirebaseFunctionsException', () {

packages/cloud_functions/cloud_functions_platform_interface/lib/src/method_channel/method_channel_https_callable.dart

@@ -17,8 +17,8 @@ class MethodChannelHttpsCallable extends HttpsCallablePlatform {
       : super(functions, origin, name, options);
 
   @override
-  Future<dynamic> call([dynamic parameters]) {
-    return MethodChannelFirebaseFunctions.channel
+  Future<dynamic> call([Object? parameters]) async {
+    Object? result = await MethodChannelFirebaseFunctions.channel
         .invokeMethod('FirebaseFunctions#call', <String, dynamic>{
       'appName': functions.app!.name,
       'functionName': name,
@@ -27,5 +27,11 @@ class MethodChannelHttpsCallable extends HttpsCallablePlatform {
       'timeout': options.timeout.inMilliseconds,
       'parameters': parameters,
     }).catchError(catchPlatformException);
+
+    if (result is Map) {
+      return Map<String, dynamic>.from(result);
+    } else {
+      return result;
+    }
   }
 }