Fixed bugs in invite and dynamic links implementations

Added proper iOS 9+ handling for dynamic links
Extended returned data to include match confidence (specific for iOS)
Updated documentation

Author: sserdyuk

docs/INVITES_DYNAMICLINKS.md

@@ -5,6 +5,8 @@ Since plugin version 3.12.0 you can use Firebase _Invites_ features.
 
 _Invites_ lets you invite other users to your app from right within your own app, via SMS and/or Email.
 
+Keep in mind that invites are based of dynamic links, and so calling for an invite may return a plain dynamic link, in which case invitationId is null.
+
 ### Android
 * [Make sure you've uploaded your SHA1 fingerprint(s)](https://developers.google.com/android/guides/client-auth) to the Firebase console, then download the latest `google-services.json` file and add it to `app/App_Resources/Android`.
 
@@ -110,12 +112,12 @@ The options you can pass to `sendInvitation` are:
 
 
 ### invites.getInvitation
-When the user opens your app from an invite, you can retrieve the details via the `getInvitation` function:
+When the user opens your app from an invite or a dynamic link, you can retrieve the details via the `getInvitation` function after you initialize Firebase:
 
 ```js
 firebase.invites.getInvitation().then(
     function (result) { // GetInvitationResult
-      console.log("deeplink: " + result.deeplink + ", invitationId: " + result.invitationId);
+      console.log("deepLink: " + result.deepLink + ", invitationId: " + result.invitationId+ ", matchType: "+ result.matchType);
     },
     function (error) {
       console.log("getInvitation error: " + error);
@@ -130,8 +132,8 @@ You can either add an `onDynamicLinkCallback` callback to `init`, or use `addOnD
 
 ```js
   firebase.init({
-    onDynamicLinkCallback: function (url) {
-      console.log("Dynamic Link: " + url); // this is a string, like http://mydomain.com/applink
+    onDynamicLinkCallback: function (result) {
+      console.log("Dynamic Link: " + result.url+ ", matchConfidence: "+ result.matchConfidence); 
     }
   });
 ```
@@ -144,4 +146,4 @@ You can either add an `onDynamicLinkCallback` callback to `init`, or use `addOnD
       // ..
     }
   );
-```
+```

firebase.android.js

@@ -5,7 +5,7 @@ var fs = require("file-system");
 var firebase = require("./firebase-common");
 
 firebase._launchNotification = null;
-firebase._launchDynamicLink = null;
+firebase._cachedDynamicLink = null;
 
 // we need to cache and restore the context, otherwise the next invocation is broken
 firebase._rememberedContext = null;
@@ -75,12 +75,20 @@ var dynamicLinksEnabled = new lazy(function () {
       var getDynamicLinksCallback = new com.google.android.gms.tasks.OnCompleteListener({
         onComplete: function (task) {
           if (task.isSuccessful() && task.getResult() !== null) {
-            result = task.getResult().getLink().toString();
+            var result = task.getResult();
             if (firebase._dynamicLinkCallback === null) {
-              firebase._launchDynamicLink = result;
-            } else {
+              firebase._cachedDynamicLink = {
+                url: result.getLink().toString(),
+                matchConfidence: 1, 
+                minimumAppVersion: result.getMinimumAppVersion()
+              };
+                } else {
               setTimeout(function () {
-                firebase._dynamicLinkCallback(firebase.toJsObject(result));
+                firebase._dynamicLinkCallback({
+                  url: result.getLink().toString(),
+                  matchConfidence: 1, 
+                  minimumAppVersion: result.getMinimumAppVersion()                    
+                });
               });
             }
           }
@@ -394,9 +402,9 @@ firebase.addOnDynamicLinkReceivedCallback = function (callback) {
       firebase._dynamicLinkCallback = callback;
 
       // if the app was launched from a dynamic link, process it now
-      if (firebase._launchDynamicLink !== null) {
-        callback(firebase._launchDynamicLink);
-        firebase._launchDynamicLink = null;
+      if (firebase._cachedDynamicLink !== null) {
+        callback(firebase._cachedDynamicLink);
+        firebase._cachedDynamicLink = null;
       }
 
       resolve();
@@ -2110,18 +2118,17 @@ firebase.invites.getInvitation = function () {
 
       var onConnectionFailedListener = new com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener({
         onConnectionFailed: function (connectionResult) {
-          reject(connectionResult.getErrorMessage());
+          // we shouldn't reject on connection failure as the invitation link may still be available locally
+          // reject(connectionResult.getErrorMessage());
         }
       });
 
-      // var autoLaunchDeepLink = false;
-
-      firebase._mGoogleApiClient = new com.google.android.gms.common.api.GoogleApiClient.Builder(com.tns.NativeScriptApplication.getInstance())
+      firebase._mGoogleInviteApiClient = new com.google.android.gms.common.api.GoogleApiClient.Builder(com.tns.NativeScriptApplication.getInstance())
           .addOnConnectionFailedListener(onConnectionFailedListener)
           .addApi(com.google.android.gms.appinvite.AppInvite.API)
           .build();
 
-      firebase._mGoogleApiClient.connect();
+      firebase._mGoogleInviteApiClient.connect();
 
       var firebaseDynamicLinks = com.google.firebase.dynamiclinks.FirebaseDynamicLinks.getInstance();
 
@@ -2140,6 +2147,7 @@ firebase.invites.getInvitation = function () {
 
           resolve({
             deepLink: deepLinkUri === null ? null : deepLinkUri.toString(),
+            matchType: deepLinkUri === null ? null : 1,
             invitationId: firebaseAppInvite.getInvitationId() // string | null
           });
         }
@@ -2163,4 +2171,4 @@ firebase.invites.getInvitation = function () {
   });
 };
 
-module.exports = firebase;
+module.exports = firebase;

firebase.d.ts

@@ -710,6 +710,11 @@ export module analytics {
 // Invites module
 export module invites {
 
+  export enum MATCH_TYPE {
+    WEAK,
+    STRONG
+  }
+
   export interface SendInvitationOptions {
     /**
      * Invitation title you want to send.
@@ -753,15 +758,29 @@ export module invites {
   }
 
   export interface GetInvitationResult {
-    deeplink: any;
-    invitationId: any;
+    deepLink: string;
+    matchType?: MATCH_TYPE,
+    invitationId: string;
   }
 
   function sendInvitation(options: SendInvitationOptions): Promise<SendInvitationResult>;
 
   function getInvitation(): Promise<GetInvitationResult>;
 }
 
+export module dynamicLinks {
+  export enum MATCH_CONFIDENCE {
+    WEAK,
+    STRONG
+  }
+
+  export interface DynamicLinkCallbackData {
+    url: string;
+    matchConfidence?: MATCH_CONFIDENCE,
+    minimumAppVersion?: string;
+  }
+}
+
 // Auth
 export function login(options: LoginOptions): Promise<User>;
 
@@ -801,7 +820,7 @@ export function addOnPushTokenReceivedCallback(onPushTokenReceived: (data: strin
 export function getCurrentPushToken(): Promise<string>;
 
 // dynamic links
-export function addOnDynamicLinkReceivedCallback(onDynamicLinkReceived: (url: string) => void): Promise<any>;
+export function addOnDynamicLinkReceivedCallback(onDynamicLinkReceived: (callBackData: dynamicLinks.DynamicLinkCallbackData) => void): Promise<any>;
 
 // remote config
 export function getRemoteConfig(options: GetRemoteConfigOptions): Promise<GetRemoteConfigResult>;

firebase.ios.js

@@ -68,8 +68,8 @@ function addBackgroundRemoteNotificationHandler(appDelegate) {
     appDelegate.prototype.applicationDidReceiveRemoteNotificationFetchCompletionHandler = function (app, notification, completionHandler) {
 
       firebase._configure();
-
-      // Pass notification to auth and check if they can handle it (in case phone auth is being used), see https://firebase.google.com/docs/auth/ios/phone-auth
+      
+            // Pass notification to auth and check if they can handle it (in case phone auth is being used), see https://firebase.google.com/docs/auth/ios/phone-auth
       if (FIRAuth.auth().canHandleNotification(notification)) {
         completionHandler(UIBackgroundFetchResultNoData);
         return;
@@ -114,8 +114,9 @@ firebase.addAppDelegateMethods = function (appDelegate) {
         var receivedInvite = FIRInvites.handleURLSourceApplicationAnnotation(url, sourceApplication, annotation);
         if (receivedInvite) {
           console.log("Deep link from " + sourceApplication + ", Invite ID: " + invite.invideId + ", App URL: " + invite.deepLink);
-          this._cachedInvitation = {
+          firebase._cachedInvitation = {
             deepLink: invite.deepLink,
+            matchType: invite.matchType,
             invitationId: invite.invideId
           };
           result = true;
@@ -125,7 +126,12 @@ firebase.addAppDelegateMethods = function (appDelegate) {
       if (typeof(FIRDynamicLink) !== "undefined") {
         var dynamicLink = FIRDynamicLinks.dynamicLinks().dynamicLinkFromCustomSchemeURL(url)
         if (dynamicLink) {
-          this._cachedDeepLink = dynamicLink.url.absoluteString;
+          console.log(">>> dynamicLink.url.absoluteString: " + dynamicLink.url.absoluteString);
+          firebase._cachedDynamicLink = {
+            url: dynamicLink.url.absoluteString,
+            matchConfidence: dynamicLink.matchConfidence, 
+            minimumAppVersion: dynamicLink.minimumAppVersion
+          };
           result = true;
         }
       }
@@ -157,10 +163,18 @@ firebase.addAppDelegateMethods = function (appDelegate) {
         if (dynamicLink) {
           if (dynamicLink.url !== null) {
             console.log(">>> dynamicLink.url.absoluteString: " + dynamicLink.url.absoluteString);
-            if (this._dynamicLinkCallback) {
-              this._dynamicLinkCallback(dynamicLink.url.absoluteString);
+            if (firebase._dynamicLinkCallback) {
+              firebase._dynamicLinkCallback({
+                  url: dynamicLink.url.absoluteString,
+                  matchConfidence: dynamicLink.matchConfidence, 
+                  minimumAppVersion: dynamicLink.minimumAppVersion
+                });
             } else {
-              this._cachedDeepLink = dynamicLink.url.absoluteString;
+              firebase._cachedDynamicLink = {
+                url: dynamicLink.url.absoluteString,
+                matchConfidence: dynamicLink.matchConfidence, 
+                minimumAppVersion: dynamicLink.minimumAppVersion
+              };
             }
             result = true;
           }
@@ -171,6 +185,37 @@ firebase.addAppDelegateMethods = function (appDelegate) {
     };
   }
 
+  if (typeof(FIRDynamicLink) !== "undefined") {
+    appDelegate.prototype.applicationContinueUserActivityRestorationHandler = function (application, userActivity, restorationHandler) {
+      var result = false;
+      
+      if (typeof(FIRDynamicLink) !== "undefined" ) {
+        if (userActivity.webpageURL) {
+          result = FIRDynamicLinks.dynamicLinks().handleUniversalLinkCompletion(userActivity.webpageURL, function(dynamicLink, error){
+            if (dynamicLink.url !== null) {
+              console.log(">>> dynamicLink.url.absoluteString: " + dynamicLink.url.absoluteString);
+              if (firebase._dynamicLinkCallback) {
+                firebase._dynamicLinkCallback({
+                    url: dynamicLink.url.absoluteString,
+                    matchConfidence: dynamicLink.matchConfidence, 
+                    minimumAppVersion: dynamicLink.minimumAppVersion
+                  });
+              } else {
+                firebase._cachedDynamicLink = {
+                  url: dynamicLink.url.absoluteString,
+                  matchConfidence: dynamicLink.matchConfidence, 
+                  minimumAppVersion: dynamicLink.minimumAppVersion
+                };
+              }
+            }
+          })
+        }
+      }
+
+      return result;
+    };
+  }
+
   addBackgroundRemoteNotificationHandler(appDelegate);
 };
 
@@ -586,7 +631,7 @@ firebase.init = function (arg) {
         }
 
         firebase._configure();
-
+        
         if (arg.persist) {
           FIRDatabase.database().persistenceEnabled = true;
         }