Merge pull request #31 from comapi/push_deep_links_v2

Push deep links v2

Author: MarcinSwierczek

COMAPI/foundation/src/main/java/com/comapi/BaseClient.java

@@ -54,6 +54,7 @@
 import com.comapi.internal.push.PushManager;
 import com.google.firebase.messaging.RemoteMessage;
 
+import org.json.JSONException;
 import org.json.JSONObject;
 
 import java.io.File;
@@ -414,7 +415,7 @@ public void removeListener(StateListener listener) {
         listenerListAdapter.removeListener(listener);
     }
 
-    protected Observable<PushHandleResult> handlePushNotification(Context activityContext, Intent i, boolean startActivity) {
+    protected Observable<PushHandleResult> handlePush(Context activityContext, Intent i, boolean startActivity) {
         if (i.hasExtra(PushDataKeys.KEY_PUSH_DEEP_LINK)) {
             JSONObject deepLinkData;
             try {
@@ -463,30 +464,33 @@ protected Observable<PushHandleResult> handlePushNotification(Context activityCo
         return  Observable.fromCallable(() -> new PushHandleResult(null, null, false, false));
     }
 
-    static protected Observable<PushDetails> parsePush(RemoteMessage message) {
+    /**
+     * Parse Firebase Push RemoteNotification to extract deep link url or data send with Dotdigital program
+     * @param message RemoteMessage received in a push handler implementing PushMessageListener registered with SDK initialisation call.
+     * @return parsed deep link url or data
+     */
+    static public PushDetails parsePushMessage(RemoteMessage message) throws JSONException {
         RemoteMessage.Notification n = message.getNotification();
         if (message.getData().containsKey(PushDataKeys.KEY_PUSH_DEEP_LINK)) {
             String deepLinkDataJson = message.getData().get(PushDataKeys.KEY_PUSH_DEEP_LINK);
-            try {
-                assert deepLinkDataJson != null;
+            if (deepLinkDataJson != null) {
                 JSONObject deepLinkData = new JSONObject(deepLinkDataJson);
                 if (deepLinkData.has(PushDataKeys.KEY_PUSH_URL)) {
                     String url = deepLinkData.getString(PushDataKeys.KEY_PUSH_URL);
-                    return  Observable.fromCallable(() -> new PushDetails(url, null));
+                    return new PushDetails(url, null);
                 }
-            } catch (Exception e) {
-                return Observable.error(e);
+            } else {
+                return new PushDetails(null, null);
             }
         } else if (message.getData().containsKey(PushDataKeys.KEY_PUSH_DATA)) {
             String dataJson = message.getData().get(PushDataKeys.KEY_PUSH_DATA);
-            try {
-                assert dataJson != null;
+            if (dataJson != null) {
                 JSONObject data = new JSONObject(dataJson);
-                return  Observable.fromCallable(() -> new PushDetails(null, data));
-            } catch (Exception e) {
-                return Observable.error(e);
+                return  new PushDetails(null, data);
+            } else {
+                return new PushDetails(null, null);
             }
         }
-        return  Observable.fromCallable(() -> new PushDetails(null, null));
+        return new PushDetails(null, null);
     }
 }

COMAPI/foundation/src/main/java/com/comapi/ComapiClient.java

@@ -25,9 +25,9 @@
 import android.content.Intent;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import com.comapi.internal.CallbackAdapter;
-import com.google.firebase.messaging.RemoteMessage;
 
 import java.io.File;
 
@@ -120,16 +120,12 @@ public void clean(@NonNull Context context) {
      * @param i intent that is retrieved by getIntent() in onCreate or intent passed to onNewIntent lifecycle callbacks
      * @param startActivity should start activity from deep link url
      * @param callback Contains result of the push notification processing
-     *                 getUrl - url passed as a deep link with the notification
+     *                 getUrl - url passed as a deep link with the notification by dotdigital program
+     *                 getData - data passed with the notification by dotdigital program
      *                 isTrackingSuccessful - was call to record a click for analytics successful;
      *                 isStartActivitySuccessful - was starting activity from url successful
      */
-    public void handlePush(Context activityContext, Intent i, boolean startActivity, Callback<PushHandleResult> callback) {
-        adapter.adapt(super.handlePushNotification(activityContext, i, startActivity),callback);
-    }
-
-    public static void parsePushMessage(RemoteMessage message, Callback<PushDetails> callback) {
-        CallbackAdapter adapter = new CallbackAdapter();
-        adapter.adapt(BaseClient.parsePush(message), callback);
+    public void handlePushNotification(@NonNull Context activityContext, @NonNull Intent i, boolean startActivity, @Nullable Callback<PushHandleResult> callback) {
+        adapter.adapt(super.handlePush(activityContext, i, startActivity),callback);
     }
 }

COMAPI/foundation/src/main/java/com/comapi/RxComapiClient.java

@@ -30,7 +30,6 @@
 import com.comapi.internal.lifecycle.LifecycleListener;
 import com.comapi.internal.log.Logger;
 import com.comapi.internal.network.api.RxComapiService;
-import com.google.firebase.messaging.RemoteMessage;
 
 import java.io.File;
 
@@ -141,11 +140,18 @@ protected RxComapiService getComapiService() {
         return service;
     }
 
-    public Observable<PushHandleResult> handlePush(Context activityContext, Intent i, boolean startActivity) {
-        return super.handlePushNotification(activityContext, i, startActivity);
-    }
-
-    public Observable<PushDetails> parsePushMessage(RemoteMessage message) {
-        return BaseClient.parsePush(message);
+    /**
+     * Handles click push notification tracking and opens deep link
+     * @param activityContext pass calling activity here
+     * @param i intent that is retrieved by getIntent() in onCreate or intent passed to onNewIntent lifecycle callbacks
+     * @param startActivity should start activity from deep link url
+     * @return Observable containing result of the push notification processing
+     *         getUrl - url passed as a deep link with the notification
+     *         getData - data passed with the notification by dotdigital program
+     *         isTrackingSuccessful - was call to record a click for analytics successful;
+     *         isStartActivitySuccessful - was starting activity from url successful
+     */
+    public Observable<PushHandleResult> handlePushNotification(Context activityContext, Intent i, boolean startActivity) {
+        return super.handlePush(activityContext, i, startActivity);
     }
 }