Support multiple push providers (#433)

* Support multiple push providers

* Fix unit tests

* Try to fix unit tests

* Run failing test class only

* Try only the failing test

* Try to fix unit test

* Fix unit test and revert travis changes

* Renaming constants

* Remove comment

* Add default constructor for reflection

Author: hborisoff

AndroidSDK/proguard-rules.pro

@@ -332,7 +332,6 @@
 }
 
 -keep class com.leanplum.utils.BitmapUtil { public private protected *; }
--keep class com.leanplum.LeanplumPushServiceFcm { *; }
 -keep class com.leanplum.LeanplumPushService  { *; }
 -keep class com.leanplum.LeanplumFcmProvider { *; }
 -keep class com.leanplum.LeanplumCloudMessagingProvider{ *; }

AndroidSDKCore/src/main/java/com/leanplum/Leanplum.java

@@ -690,8 +690,8 @@ private static void startHelper(
     Date now = new Date();
     int timezoneOffsetSeconds = localTimeZone.getOffset(now.getTime()) / 1000;
 
-    String registrationId = SharedPreferencesUtil.getString(context,
-        Constants.Defaults.LEANPLUM_PUSH, Constants.Defaults.PROPERTY_TOKEN_ID);
+    String fcmRegistrationId = SharedPreferencesUtil.getString(context,
+        Constants.Defaults.LEANPLUM_PUSH, Constants.Defaults.PROPERTY_FCM_TOKEN_ID);
 
     HashMap<String, Object> params = new HashMap<>();
     params.put(Constants.Params.INCLUDE_DEFAULTS, Boolean.toString(false));
@@ -703,8 +703,8 @@ private static void startHelper(
     params.put(Constants.Params.DEVICE_MODEL, Util.getDeviceModel());
     params.put(Constants.Params.DEVICE_SYSTEM_NAME, Util.getSystemName());
     params.put(Constants.Params.DEVICE_SYSTEM_VERSION, Util.getSystemVersion());
-    if (!TextUtils.isEmpty(registrationId)) {
-      params.put(Constants.Params.DEVICE_PUSH_TOKEN, registrationId);
+    if (!TextUtils.isEmpty(fcmRegistrationId)) {
+      params.put(Constants.Params.DEVICE_FCM_PUSH_TOKEN, fcmRegistrationId);
     }
     params.put(Constants.Keys.TIMEZONE, localTimeZone.getID());
     params.put(Constants.Keys.TIMEZONE_OFFSET_SECONDS, Integer.toString(timezoneOffsetSeconds));
@@ -1546,10 +1546,18 @@ public static void setUserAttributes(Map<String, Object> userAttributes) {
   /**
    * Sets the registration ID used for Cloud Messaging.
    */
-  static void setRegistrationId(final String registrationId) {
+  static void setRegistrationId(PushProviderType type, final String registrationId) {
     if (Constants.isNoop()) {
       return;
     }
+    String attributeName;
+    switch (type) {
+      case FCM:
+        attributeName = Constants.Params.DEVICE_FCM_PUSH_TOKEN;
+        break;
+      default:
+        return;
+    }
     pushStartCallback = new Runnable() {
       @Override
       public void run() {
@@ -1559,7 +1567,7 @@ public void run() {
         try {
           Request request = RequestBuilder
               .withSetDeviceAttributesAction()
-              .andParam(Constants.Params.DEVICE_PUSH_TOKEN, registrationId)
+              .andParam(attributeName, registrationId)
               .andType(RequestType.IMMEDIATE)
               .create();
           RequestSender.getInstance().send(request);

AndroidSDKCore/src/main/java/com/leanplum/PushProviderType.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2020, Leanplum, Inc. All rights reserved.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.leanplum;
+
+enum PushProviderType {
+  FCM
+}

AndroidSDKCore/src/main/java/com/leanplum/internal/Constants.java

@@ -86,7 +86,7 @@ public static class Defaults {
     public static final String INBOX_KEY = "__leanplum_newsfeed";
     public static final String LEANPLUM_PUSH = "__leanplum_push__";
     public static final String APP_ID = "__app_id";
-    public static final String PROPERTY_TOKEN_ID = "registration_id";
+    public static final String PROPERTY_FCM_TOKEN_ID = "registration_id";
     public static final String PROPERTY_SENDER_IDS = "sender_ids";
     public static final String NOTIFICATION_CHANNELS_KEY = "__leanplum_notification_channels";
     public static final String DEFAULT_NOTIFICATION_CHANNEL_KEY = "__leanplum_default_notification_channels";
@@ -107,7 +107,7 @@ public static class Params {
     public static final String DEVICE_ID = "deviceId";
     public static final String DEVICE_MODEL = "deviceModel";
     public static final String DEVICE_NAME = "deviceName";
-    public static final String DEVICE_PUSH_TOKEN = "gcmRegistrationId";
+    public static final String DEVICE_FCM_PUSH_TOKEN = "gcmRegistrationId";
     public static final String DEVICE_SYSTEM_NAME = "systemName";
     public static final String DEVICE_SYSTEM_VERSION = "systemVersion";
     public static final String EMAIL = "email";

AndroidSDKFcm/src/main/java/com/leanplum/LeanplumFcmProvider.java

@@ -27,24 +27,37 @@
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.iid.FirebaseInstanceId;
 import com.google.firebase.iid.InstanceIdResult;
+import com.leanplum.internal.Constants;
 import com.leanplum.internal.Log;
 
 import androidx.annotation.NonNull;
 
 /**
  * Leanplum provider for work with Firebase.
+ * Class is instantiated by reflection using default constructor.
  *
  * @author Anna Orlova
  */
 class LeanplumFcmProvider extends LeanplumCloudMessagingProvider {
 
+  /**
+   * Constructor called by reflection.
+   */
+  public LeanplumFcmProvider() {
+  }
+
+  @Override
+  protected String getSharedPrefsPropertyName() {
+    return Constants.Defaults.PROPERTY_FCM_TOKEN_ID;
+  }
+
   @Override
-  public String getRegistrationId() {
-    return this.getStoredRegistrationPreferences(Leanplum.getContext());
+  public PushProviderType getType() {
+    return PushProviderType.FCM;
   }
 
   @Override
-  public void getCurrentRegistrationIdAndUpdateBackend() {
+  public void updateRegistrationId() {
     FirebaseInstanceId.getInstance().getInstanceId()
         .addOnCompleteListener(new OnCompleteListener<InstanceIdResult>() {
           @Override
@@ -57,17 +70,12 @@ public void onComplete(@NonNull Task<InstanceIdResult> task) {
             // Get new Instance ID token
             String tokenId = task.getResult().getToken();
             if (!TextUtils.isEmpty(tokenId)) {
-                onRegistrationIdReceived(Leanplum.getContext(), tokenId);
+                setRegistrationId(tokenId);
               }
             }
         });
   }
 
-  @Override
-  public boolean isInitialized() {
-    return true;
-  }
-
   @Override
   public void unregister() {
     try {

AndroidSDKFcm/src/main/java/com/leanplum/LeanplumFirebaseServiceHandler.java

@@ -46,11 +46,8 @@ public void onCreate(Context context) {
    * Call from your implementation of {@link FirebaseMessagingService#onNewToken(String)}
    */
   public void onNewToken(String token, Context context) {
-    LeanplumPushService.setCloudMessagingProvider(new LeanplumFcmProvider());
-    LeanplumPushService.getCloudMessagingProvider().storePreferences(context, token);
-
     //send the new token to backend
-    LeanplumPushService.getCloudMessagingProvider().onRegistrationIdReceived(context, token);
+    LeanplumPushService.getPushProviders().setRegistrationId(PushProviderType.FCM, token);
   }
 
   /**

AndroidSDKFcm/src/main/java/com/leanplum/LeanplumPushServiceFcm.java

@@ -4,8 +4,6 @@
 
     <application>
         <receiver android:name="com.leanplum.LeanplumJobStartReceiver" />
-        <!-- Leanplum FCM Registration Service. -->
-        <service android:name="com.leanplum.LeanplumPushRegistrationService" />
         <!-- Leanplum Local Push Notification Service. -->
         <service
             android:name="com.leanplum.LeanplumLocalPushListenerService"

AndroidSDKPush/src/main/AndroidManifest.xml

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016, Leanplum, Inc. All rights reserved.
+ * Copyright 2020, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -21,34 +21,30 @@
 
 package com.leanplum;
 
-import android.content.Context;
+interface IPushProvider {
 
-/**
- * Leanplum provider for manually registering for Cloud Messaging services.
- *
- * @author Anna Orlova
- */
-public class LeanplumManualProvider extends LeanplumCloudMessagingProvider {
-  LeanplumManualProvider(Context context, String registrationId) {
-    onRegistrationIdReceived(context, registrationId);
-  }
-
-  @Override
-  public String getRegistrationId() {
-    return getCurrentRegistrationId();
-  }
+  /**
+   * Returns the type of this push provider.
+   */
+  PushProviderType getType();
 
-  @Override
-  public void getCurrentRegistrationIdAndUpdateBackend() {
+  /**
+   * Returns the stored registration ID.
+   */
+  String getRegistrationId();
 
-  }
+  /**
+   * Stores the registration ID and sends it to backend.
+   */
+  void setRegistrationId(String regId);
 
-  @Override
-  public boolean isInitialized() {
-    return true;
-  }
+  /**
+   * Unregister from cloud messaging. Main usage is for testing purposes.
+   */
+  void unregister();
 
-  @Override
-  public void unregister() {
-  }
+  /**
+   * Updates the current registration ID from the cloud messaging's API.
+   */
+  void updateRegistrationId();
 }