Merge pull request #917 from breningham/implement-callable-functions

EddyVerbruggen · web-flow · commit ff95c77c7b09 · 2018-09-25T13:44:10.000+02:00
Ready For Testing - Implement callable functions
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,7 @@ src/platforms/android/include.gradle
 !src/platforms/web/typings/firebase-webapi.d.ts
 !src/platforms/ios/typings/*.d.ts
 !src/platforms/android/typings/**/*.d.ts
+!src/functions/functions.d.ts
 !src/scripts/*.js
 !demo/karma.conf.js
 demo/*.d.ts
diff --git a/demo/app/main-page.xml b/demo/app/main-page.xml
@@ -18,7 +18,7 @@
       <TabViewItem.view>
         <ScrollView>
           <GridLayout columns="*, *"
-                      rows="auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto"
+                      rows="auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto, auto"
                       horizontalAlignment="stretch"
                       class="tab-content">
             <Button row="0" colSpan="2" text="init firebase - do this first" tap="{{ doWebInit }}" class="button button-positive"/>
@@ -72,6 +72,10 @@
 
             <Label row="19" colSpan="2" text="{{ storageFeedback }}" class="message" textWrap="true"/>
 
+            <Label row="20" colSpan="2" text="Callable Functions" class="subtitle" />
+
+            <Button row="21" col="0" text="callable 1" tap="{{ doCallableFunction }}"  class="button button-functions" />
+
           </GridLayout>
         </ScrollView>
       </TabViewItem.view>
diff --git a/demo/app/main-view-model.ts b/demo/app/main-view-model.ts
@@ -8,6 +8,7 @@ import { MessagingViewModel } from './messaging-view-model';
 
 const firebaseWebApi = require("nativescript-plugin-firebase/app");
 
+
 declare const Crashlytics: any;
 
 export class HelloWorldModel extends Observable {
@@ -195,6 +196,25 @@ export class HelloWorldModel extends Observable {
     }
   }
 
+  public doCallableFunction(): void {
+    const fn = firebaseWebApi.functions().httpsCallable('helloName');
+
+    fn( 'Nativescript-Plugin-Firebase!' ).then((DataCue) => {
+      alert({
+        title: "Callable Function Result",
+        message: DataCue.message,
+        okButtonText: "Nice!"
+      });
+    })
+    .catch((errorMessage) => {
+      alert({
+        title: "An Error Occurred",
+        message: errorMessage,
+        okButtonText: "OK, thanks"
+      });
+    });
+  }
+
   public doWebAddValueEventListenerForCompanies(): void {
     const path = "/companies";
     const onValueEvent = result => {
diff --git a/demo/firebase.nativescript.json b/demo/firebase.nativescript.json
@@ -1,18 +1,20 @@
 {
-  "using_ios": true,
-  "using_android": true,
-  "firestore": false,
-  "realtimedb": true,
-  "authentication": true,
-  "remote_config": true,
-  "messaging": true,
-  "crashlytics": true,
-  "crash_reporting": false,
-  "storage": true,
-  "facebook_auth": true,
-  "google_auth": true,
-  "admob": true,
-  "invites": true,
-  "dynamic_links": true,
-  "ml_kit": false
-}
+    "external_push_client_only": false,
+    "using_ios": true,
+    "using_android": true,
+    "firestore": true,
+    "realtimedb": true,
+    "authentication": true,
+    "remote_config": true,
+    "messaging": true,
+    "crashlytics": true,
+    "crash_reporting": true,
+    "storage": true,
+    "functions": true,
+    "facebook_auth": true,
+    "google_auth": true,
+    "admob": true,
+    "invites": true,
+    "dynamic_links": true,
+    "ml_kit": false
+}
diff --git a/demo/package.json b/demo/package.json
@@ -1,18 +1,18 @@
 {
   "nativescript": {
     "id": "org.nativescript.firebasedemo",
-    "tns-ios": {
-      "version": "4.2.0"
-    },
     "tns-android": {
       "version": "4.2.0"
+    },
+    "tns-ios": {
+      "version": "4.3.0-2018-09-19-01"
     }
   },
   "dependencies": {
     "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-7.0.1.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
-    "tns-core-modules": "~4.2.0"
+    "tns-core-modules": "^4.2.1"
   },
   "devDependencies": {
     "@types/jasmine": "~2.8.0",
diff --git a/src/app/functions/index.ts b/src/app/functions/index.ts
@@ -0,0 +1,10 @@
+import * as firebase from "../../firebase";
+
+export namespace functions {
+    // tslint:disable-next-line:class-name
+    export class Functions {
+        httpsCallable<I, O>( functionName: string ) {
+            return firebase.functions.httpsCallable<I, O>(functionName);
+        }
+    }
+}
diff --git a/src/app/index.ts b/src/app/index.ts
@@ -8,6 +8,7 @@ import { auth as firebaseAuthModule } from "./auth";
 import { database as firebaseDatabaseModule } from "./database";
 import { firestore as firebaseFirestoreModule } from "./firestore";
 import { storage as firebaseStorageModule } from "./storage";
+import { functions as firebaseFunctionsModule } from './functions';
 
 export function initializeApp(options?: firebase.InitOptions, name? /* ignored */: string): Promise<any> {
   return firebase.init(options);
@@ -46,6 +47,17 @@ export function firestore(app?: any): firebaseFirestoreModule.Firestore {
   return firestoreCache;
 }
 
+let functionsCache;
+export function functions(app?: any): firebaseFunctionsModule.Functions {
+  if (app) {
+    console.log("The 'app' param is ignored at the moment.");
+  }
+  if ( !functionsCache ) {
+    functionsCache = new firebaseFunctionsModule.Functions();
+  }
+  return functionsCache;
+}
+
 let storageCache;
 export function storage(app?: any): firebaseStorageModule.Storage {
   if (app) {
diff --git a/src/firebase.android.ts b/src/firebase.android.ts
@@ -6,6 +6,7 @@ import {
   isDocumentReference
 } from "./firebase-common";
 import * as firebaseMessaging from "./messaging/messaging";
+import * as firebaseFunctions from "./functions/functions";
 import * as appModule from "tns-core-modules/application";
 import { AndroidActivityResultEventData } from "tns-core-modules/application";
 import { ad as AndroidUtils, layout } from "tns-core-modules/utils/utils";
@@ -190,7 +191,7 @@ firebase.toValue = val => {
     }
   }
   return returnVal;
-}
+};
 
 firebase.toJsObject = javaObj => {
   if (javaObj === null || typeof javaObj !== "object") {
@@ -448,6 +449,8 @@ firebase.subscribeToTopic = firebaseMessaging.subscribeToTopic;
 firebase.unsubscribeFromTopic = firebaseMessaging.unsubscribeFromTopic;
 firebase.areNotificationsEnabled = firebaseMessaging.areNotificationsEnabled;
 
+firebase.functions = firebaseFunctions;
+
 firebase.addOnDynamicLinkReceivedCallback = callback => {
   return new Promise((resolve, reject) => {
     try {
diff --git a/src/firebase.d.ts b/src/firebase.d.ts
@@ -846,6 +846,10 @@ export namespace firestore {
   function batch(): firestore.WriteBatch;
 }
 
+export namespace functions {
+  export type HttpsCallable<I, O> = ( callableData: I ) => Promise<O>;
+  export function httpsCallable<I, O>( callableFunctionName: string ): HttpsCallable<I, O>;
+}
 // Auth
 export function login(options: LoginOptions): Promise<User>;
 
diff --git a/src/firebase.ios.ts b/src/firebase.ios.ts
@@ -10,6 +10,7 @@ import * as application from "tns-core-modules/application/application";
 import { ios as iOSUtils } from "tns-core-modules/utils/utils";
 import { device } from "tns-core-modules/platform/platform";
 import { DeviceType } from "tns-core-modules/ui/enums/enums";
+import * as firebaseFunctions from './functions/functions';
 import { firestore, User } from "./firebase";
 import { firebaseUtils } from "./utils";
 
@@ -42,6 +43,8 @@ firebase.subscribeToTopic = firebaseMessaging.subscribeToTopic;
 firebase.unsubscribeFromTopic = firebaseMessaging.unsubscribeFromTopic;
 firebase.areNotificationsEnabled = firebaseMessaging.areNotificationsEnabled;
 
+firebase.functions = firebaseFunctions;
+
 firebase.addAppDelegateMethods = appDelegate => {
   // we need the launchOptions for this one so it's a bit hard to use the UIApplicationDidFinishLaunchingNotification pattern we're using for other things
   appDelegate.prototype.applicationDidFinishLaunchingWithOptions = (application, launchOptions) => {
diff --git a/src/functions/functions.android.ts b/src/functions/functions.android.ts
@@ -0,0 +1,32 @@
+import {HttpsCallable} from './functions';
+import { firebase } from '../firebase-common';
+
+export function httpsCallable<I = {}, O = {}>(functionName: string): HttpsCallable<I, O> {
+    const instance = com.google.firebase.functions.FirebaseFunctions.getInstance();
+
+    return (data: I) => new Promise<O>((resolve, reject) => {
+
+        let actData = firebase.toValue(data);
+
+        return instance.getHttpsCallable(functionName)
+                .call(actData)
+                .continueWith(new (<any>com.google.android.gms).tasks.Continuation({
+                    then: (task) => {
+
+                        try {
+                            const result = task.getResult() as com.google.firebase.functions.HttpsCallableResult;
+                            const resultData = result.getData();
+
+                            resolve( firebase.toJsObject(resultData) as O );
+                        } catch (e) {
+                            console.log('Error Caught:', e);
+                            reject( e.message );
+                        }
+
+                    }
+                }));
+
+    });
+
+
+}
diff --git a/src/functions/functions.d.ts b/src/functions/functions.d.ts
@@ -0,0 +1,2 @@
+export declare type HttpsCallable<I, O> = ( callableData: I ) => Promise<O>;
+export declare function httpsCallable<I = {}, O = {}>(functionName: string): HttpsCallable<I, O>;
diff --git a/src/functions/functions.ios.ts b/src/functions/functions.ios.ts
@@ -0,0 +1,34 @@
+import {HttpsCallable} from './functions';
+import { firebaseUtils } from '../utils';
+
+
+export function httpsCallable< I = {}, O = {} >( functionName: string ): HttpsCallable<I, O> {
+
+    const functions = FIRFunctions.functions();
+
+    return (data: I ) => new Promise((resolve, reject) => {
+
+        const callable = functions.HTTPSCallableWithName(functionName);
+
+        const handleCompletion = (result: FIRHTTPSCallableResult, err: NSError) => {
+            if ( err ) {
+                if ( err.domain === FIRFunctionsErrorDomain ) {
+                    const message = err.localizedDescription;
+                    reject( message );
+                }
+
+                reject( err.localizedDescription );
+            }
+
+            if ( result ) {
+                resolve( firebaseUtils.toJsObject(result.data) as O );
+            }
+        };
+
+        if ( data ) {
+            callable.callWithObjectCompletion(data, handleCompletion);
+        } else {
+            callable.callWithCompletion(handleCompletion);
+        }
+    });
+}
diff --git a/src/functions/index.ts b/src/functions/index.ts
@@ -0,0 +1,2 @@
+import * as callableFns from "./functions";
+export const functions = callableFns;
diff --git a/src/package-lock.json b/src/package-lock.json
diff --git a/src/package.json b/src/package.json
@@ -117,7 +117,7 @@
   "devDependencies": {
     "rimraf": "^2.6.2",
     "tns-core-modules": "~4.2.0",
-    "tns-platform-declarations": "~4.2.0",
+    "tns-platform-declarations": "^4.2.1",
     "tslint": "^5.1.0",
     "typescript": "~2.8.0"
   }
diff --git a/src/platforms/ios/typings/objc!FirebaseFunctions.d.ts b/src/platforms/ios/typings/objc!FirebaseFunctions.d.ts

Original file line number	Diff line number	Diff line change
`@@ -846,6 +846,10 @@ export namespace firestore {`
`846`	`846`	`function batch(): firestore.WriteBatch;`
`847`	`847`	`}`
`848`	`848`
	`849`	`+export namespace functions {`
	`850`	`+ export type HttpsCallable<I, O> = ( callableData: I ) => Promise<O>;`
	`851`	`+ export function httpsCallable<I, O>( callableFunctionName: string ): HttpsCallable<I, O>;`
	`852`	`+}`
`849`	`853`	`// Auth`
`850`	`854`	`export function login(options: LoginOptions): Promise<User>;`
`851`	`855`