Merge pull request #13 from BranchMetrics/INTENG-9038/cleanup-initialization-flow

bklastaitis-branch · web-flow · commit 5ec4eaae8dcd · 2020-02-18T17:38:18.000-08:00
INTENG-9038
diff --git a/AdobeBranchExample/.gitignore b/AdobeBranchExample/.gitignore
@@ -1 +1,11 @@
+*.iml
+/local.properties
+.DS_Store
 /build
+/captures
+
+/.idea/
+/.gradle/
+gradle/
+gradlew
+gradlew.bat
diff --git a/AdobeBranchExample/src/main/AndroidManifest.xml b/AdobeBranchExample/src/main/AndroidManifest.xml
@@ -60,15 +60,6 @@
             android:name="io.branch.sdk.BranchKey"
             android:value="key_live_nbB0KZ4UGOKaHEWCjQI2ThncEAeRJmhy" />
 
-        <!-- Branch install referrer tracking (optional) -->
-        <receiver
-            android:name="io.branch.referral.InstallListener"
-            android:exported="true">
-            <intent-filter>
-                <action android:name="com.android.vending.INSTALL_REFERRER" />
-            </intent-filter>
-        </receiver>
-
     </application>
 
 </manifest>
diff --git a/AdobeBranchExample/src/main/java/io/branch/adobe/demo/DemoApplication.java b/AdobeBranchExample/src/main/java/io/branch/adobe/demo/DemoApplication.java
@@ -2,8 +2,6 @@
 
 import com.adobe.marketing.mobile.AdobeCallback;
 import com.adobe.marketing.mobile.Analytics;
-import com.adobe.marketing.mobile.ExtensionError;
-import com.adobe.marketing.mobile.ExtensionErrorCallback;
 import com.adobe.marketing.mobile.Identity;
 import com.adobe.marketing.mobile.InvalidInitException;
 import com.adobe.marketing.mobile.Lifecycle;
@@ -13,38 +11,24 @@
 import com.adobe.marketing.mobile.UserProfile;
 
 import android.app.Application;
-import io.branch.adobe.extension.AdobeBranch;
 import io.branch.adobe.extension.AdobeBranchExtension;
 import io.branch.referral.*;
 
 public class DemoApplication extends Application {
-    private static final String TAG = "DemoApplication::";
     private static final String ADOBE_APP_ID = "d10f76259195/b0503e1a5dce/launch-9948a3b3a89d-development";
 
     @Override
     public void onCreate() {
         super.onCreate();
 
         // Initialize
-        initBranch();
         initAdobeBranch();
-        registerAdobeBranchExtension();
-//        Analytics.setVisitorIdentifier("custom_identifier_123"); // to test custom visitor ID (key: "vid")
-    }
-
-    private void initBranch() {
-        Branch.enableDebugMode();
-
-        // TODO: Revisit.  This is how we should encourage customers to initialize Branch using Branch.
-        // Branch.getAutoInstance(this);
+        Analytics.setVisitorIdentifier("custom_identifier_1234"); // to test custom visitor ID (key: "vid")
     }
 
     private void initAdobeBranch() {
         PrefHelper.Debug("initAdobeBranch()");
 
-        // TODO: Revisit.  We should encourage customers to initialize Branch using Branch.
-        AdobeBranch.getAutoInstance(this);
-
         MobileCore.setApplication(this);
         MobileCore.setLogLevel(LoggingMode.DEBUG);
 
@@ -54,28 +38,14 @@ private void initAdobeBranch() {
             Identity.registerExtension();
             Lifecycle.registerExtension();
             Signal.registerExtension();
+            AdobeBranchExtension.registerExtension(this, true);
             MobileCore.start(new AdobeCallback () {
-                @Override
-                public void call(Object o) {
+                @Override public void call(Object o) {
                     MobileCore.configureWithAppID(ADOBE_APP_ID);
                 }
             });
         } catch (InvalidInitException e) {
             PrefHelper.Debug("InitException: " + e.getLocalizedMessage());
         }
     }
-
-    private void registerAdobeBranchExtension() {
-        ExtensionErrorCallback<ExtensionError> errorCallback = new ExtensionErrorCallback<ExtensionError>() {
-            @Override
-            public void error(final ExtensionError extensionError) {
-                PrefHelper.Debug(String.format("An error occurred while registering the AdobeBranchExtension %d %s", extensionError.getErrorCode(), extensionError.getErrorName()));
-            }
-        };
-
-        if (!MobileCore.registerExtension(AdobeBranchExtension.class, errorCallback)) {
-            PrefHelper.Debug("Failed to register the AdobeBranchExtension extension");
-        }
-    }
-
 }
diff --git a/AdobeBranchExtension/build.gradle b/AdobeBranchExtension/build.gradle
@@ -34,12 +34,12 @@ dependencies {
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
 
     // Branch
-    api 'io.branch.sdk.android:library:4.2.0'
-    javadocDeps 'io.branch.sdk.android:library:4.2.0'
+    api 'io.branch.sdk.android:library:4.3.2'
+    javadocDeps 'io.branch.sdk.android:library:4.3.2'
 
     // Adobe
     androidTestImplementation 'com.adobe.marketing.mobile:userprofile:1.0.1'
-    implementation 'com.adobe.marketing.mobile:sdk-core:1.4.6'
+    implementation 'com.adobe.marketing.mobile:sdk-core:1.5.0'
 }
 
 //------------- Javadocs ---------------//
diff --git a/AdobeBranchExtension/src/androidTest/java/io/branch/adobe/extension/test/TestApplication.java b/AdobeBranchExtension/src/androidTest/java/io/branch/adobe/extension/test/TestApplication.java
@@ -4,8 +4,6 @@
 import android.util.Log;
 
 import com.adobe.marketing.mobile.AdobeCallback;
-import com.adobe.marketing.mobile.ExtensionError;
-import com.adobe.marketing.mobile.ExtensionErrorCallback;
 import com.adobe.marketing.mobile.Identity;
 import com.adobe.marketing.mobile.InvalidInitException;
 import com.adobe.marketing.mobile.Lifecycle;
@@ -16,7 +14,6 @@
 
 import io.branch.adobe.extension.AdobeBranch;
 import io.branch.adobe.extension.AdobeBranchExtension;
-import io.branch.referral.*;
 
 public class TestApplication extends Application {
     private static final String TAG = "Branch::TestApplication::";
@@ -27,13 +24,7 @@ public void onCreate() {
         super.onCreate();
 
         // Initialize
-        initBranch();
         initAdobeBranch();
-        registerAdobeBranchExtension();
-    }
-
-    private void initBranch() {
-        Branch.enableDebugMode();
     }
 
     private void initAdobeBranch() {
@@ -45,6 +36,7 @@ private void initAdobeBranch() {
         MobileCore.setLogLevel(LoggingMode.VERBOSE);
 
         try {
+            AdobeBranchExtension.registerExtension(this, true);
             UserProfile.registerExtension();
             Identity.registerExtension();
             Lifecycle.registerExtension();
@@ -59,20 +51,4 @@ public void call(Object o) {
             Log.e(TAG, "InitException", e);
         }
     }
-
-    private void registerAdobeBranchExtension() {
-        MobileCore.setApplication(this);
-
-        ExtensionErrorCallback<ExtensionError> errorCallback = new ExtensionErrorCallback<ExtensionError>() {
-            @Override
-            public void error(final ExtensionError extensionError) {
-                Log.e(TAG, String.format("An error occurred while registering the AdobeBranchExtension %d %s", extensionError.getErrorCode(), extensionError.getErrorName()));
-            }
-        };
-
-        if (!MobileCore.registerExtension(AdobeBranchExtension.class, errorCallback)) {
-            Log.e(TAG, "Failed to register the AdobeBranchExtension extension");
-        }
-    }
-
 }
diff --git a/AdobeBranchExtension/src/main/java/io/branch/adobe/extension/AdobeBranch.java b/AdobeBranchExtension/src/main/java/io/branch/adobe/extension/AdobeBranch.java
@@ -3,6 +3,7 @@
 import android.app.Activity;
 import android.content.Context;
 import android.net.Uri;
+import android.os.Handler;
 import android.util.Pair;
 
 import androidx.annotation.NonNull;
@@ -33,6 +34,7 @@ public class AdobeBranch {
 
     // Package Private Configuration Event
     static final String KEY_APICONFIGURATION = "branch_api_configuration";
+    static final int INIT_SESSION_DELAY_MILLIS = 750;
 
     /**
      * Singleton method to return the pre-initialized, or newly initialize and return, a singleton
@@ -47,19 +49,47 @@ public static Branch getAutoInstance(@NonNull Context context) {
     }
 
     /**
-     * <p>Initializes a session with the Branch API.
+     * <p>Initializes Branch session after the default 750 millisecond delay needed to collect Adobe IDs.
+     * To initialize without delay, use initSession(callback, data, activity, delay) passing in 0 as the delay parameter.
+     *
      * @param callback A listener that will be called following successful (or unsuccessful)
      *                 initialization of the session with the Branch API.
      * @param data     A {@link  Uri} variable containing the details of the source link that
      *                 led to this initialization action.
      * @param activity The calling {@link Activity} for context.
-     * @return A {@link Boolean} value that will return <i>false</i> if the supplied <i>data</i>
-     * parameter cannot be handled successfully - i.e. is not of a valid URI format.
+     * @return         A {@link Boolean} value that will return <i>false</i> if the supplied <i>data</i>
+     *                 parameter cannot be handled successfully - i.e. is not of a valid URI format.
      */
     public static boolean initSession(Branch.BranchReferralInitListener callback, Uri data, Activity activity) {
-        Branch branch = Branch.getInstance();
+        return initSession(callback, data, activity, INIT_SESSION_DELAY_MILLIS);
+    }
+
+    /**
+     * <p>Initializes Branch session after the chosen delay in milliseconds (needed to collect Adobe IDs).
+     * To initialize without delay pass 0 as the delay parameter.
+     *
+     * @param callback A listener that will be called following successful (or unsuccessful)
+     *                 initialization of the session with the Branch API.
+     * @param data     A {@link  Uri} variable containing the details of the source link that
+     *                 led to this initialization action.
+     * @param activity The calling {@link Activity} for context.
+     * @param delay    An {@link Integer} to set session initialization delay in millis (delay is needed to collect Adobe IDs).
+     * @return         A {@link Boolean} value that will return <i>false</i> if the supplied <i>data</i>
+     *                 parameter cannot be handled successfully - i.e. is not of a valid URI format.
+     */
+    public static boolean initSession(final Branch.BranchReferralInitListener callback, final Uri data, final Activity activity, int delay) {
+        final Branch branch = Branch.getInstance();
         if (branch != null) {
-            return branch.initSession(callback, data, activity);
+            if (delay == 0) {
+                branch.initSession(callback, data, activity);
+            } else {
+                new Handler().postDelayed(new Runnable() {
+                    @Override public void run() {
+                        branch.initSession(callback, data, activity);
+                    }
+                }, delay);
+            }
+            return true;
         }
         return false;
     }
diff --git a/AdobeBranchExtension/src/main/java/io/branch/adobe/extension/AdobeBranchExtension.java b/AdobeBranchExtension/src/main/java/io/branch/adobe/extension/AdobeBranchExtension.java
@@ -3,17 +3,21 @@
 import android.content.Context;
 import android.text.TextUtils;
 
+import androidx.annotation.NonNull;
+
 import com.adobe.marketing.mobile.Event;
 import com.adobe.marketing.mobile.Extension;
 import com.adobe.marketing.mobile.ExtensionApi;
 import com.adobe.marketing.mobile.ExtensionError;
 import com.adobe.marketing.mobile.ExtensionErrorCallback;
+import com.adobe.marketing.mobile.MobileCore;
 
 import org.json.JSONObject;
 
 import java.lang.reflect.Field;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 
 import io.branch.referral.Branch;
@@ -42,41 +46,59 @@ public class AdobeBranchExtension extends Extension implements ExtensionErrorCal
 
     public AdobeBranchExtension(final ExtensionApi extensionApi) {
         super(extensionApi);
-
         initExtension();
     }
 
-    @Override
-    protected String getName() {
+    public static void registerExtension(@NonNull Context context) {
+        registerExtension(context, false);
+    }
+
+    @SuppressWarnings("WeakerAccess")
+    public static void registerExtension(@NonNull Context context, boolean debugMode) {
+        if (debugMode) {
+            Branch.enableDebugMode();
+        }
+        AdobeBranch.getAutoInstance(context.getApplicationContext());
+        boolean successfulRegistration = MobileCore.registerExtension(AdobeBranchExtension.class, new ExtensionErrorCallback<ExtensionError>() {
+            @Override public void error(final ExtensionError extensionError) {
+                PrefHelper.Debug(String.format(Locale.getDefault(),
+                        "An error occurred while registering the AdobeBranchExtension %d %s",
+                        extensionError.getErrorCode(), extensionError.getErrorName()));
+            }
+        });
+        if (!successfulRegistration) {
+            PrefHelper.Debug("Failed to register the AdobeBranchExtension extension");
+        }
+    }
+
+    @Override protected String getName() {
         return "io.branch";
     }
 
-    @Override
-    public final String getVersion() {
+    @Override public final String getVersion() {
         return BuildConfig.VERSION_NAME;
     }
 
-    @Override
-    public void error(ExtensionError extensionError) {
-        // something went wrong...
-        // TODO: What to do about it.
-        PrefHelper.Debug(TAG + String.format("An error occurred in the AdobeBranchExtension %d %s", extensionError.getErrorCode(), extensionError.getErrorName()));
+    @Override public void error(ExtensionError extensionError) {
+        // error callback when registering event listeners
+        PrefHelper.Debug(TAG + String.format(Locale.getDefault(),
+                "An error occurred in the AdobeBranchExtension %d %s",
+                extensionError.getErrorCode(), extensionError.getErrorName()));
     }
 
     private void initExtension() {
         // Register default Event Listeners
-        registerExtension(ADOBE_TRACK_EVENT, ADOBE_EVENT_SOURCE);
-        registerExtension(BRANCH_CONFIGURATION_EVENT, BRANCH_EVENT_SOURCE);
-        registerExtension(ADOBE_HUB_EVENT_TYPE, ADOBE_SHARED_STATE_EVENT_SOURCE);
-    }
-
-    private void registerExtension(String eventType, String eventSource) {
-        getApi().registerEventListener(eventType, eventSource, AdobeBranchExtensionListener.class, this);
+        ExtensionApi api = getApi();
+        if (api != null) {
+            api.registerEventListener(ADOBE_TRACK_EVENT, ADOBE_EVENT_SOURCE, AdobeBranchExtensionListener.class, this);
+            api.registerEventListener(BRANCH_CONFIGURATION_EVENT, BRANCH_EVENT_SOURCE, AdobeBranchExtensionListener.class, this);
+            api.registerEventListener(ADOBE_HUB_EVENT_TYPE, ADOBE_SHARED_STATE_EVENT_SOURCE, AdobeBranchExtensionListener.class, this);
+        }
     }
 
-    // Package Private
     void handleAdobeEvent(final Event event) {
-        PrefHelper.Debug(TAG + String.format("Started processing new event [%s] of type [%s] and source [%s]", event.getName(), event.getType(), event.getSource()));
+        PrefHelper.Debug(TAG + String.format("Started processing new event [%s] of type [%s] and source [%s]",
+                event.getName(), event.getType(), event.getSource()));
 
         if (Branch.getInstance() == null) {
             // Branch is not initialized.
@@ -128,15 +150,16 @@ private void handleBranchConfigurationEvent(final Event event) {
             PrefHelper.Debug("Configuring AdobeBranch");
 
             Object object = eventData.get(AdobeBranch.KEY_APICONFIGURATION);
+            ExtensionApi api = getApi();
 
             // We expect this to be a List of Strings.
-            if (object instanceof List<?>) {
+            if (object instanceof List<?> && api != null) {
                 try {
                     apiWhitelist = (List<AdobeBranch.EventTypeSource>)object;
 
                     // For each pair in the whitelist, register the extension
                     for (AdobeBranch.EventTypeSource pair : apiWhitelist) {
-                        registerExtension(pair.getType(), pair.getSource());
+                        api.registerEventListener(pair.getType(), pair.getSource(), AdobeBranchExtensionListener.class, this);
                     }
 
                 } catch (Exception e) {
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,4 +1,9 @@
 # Adobe Branch SDK Extension change log
+- v1.2.0
+  * _*Master Release*_ - November 19, 2019
+  * Minor: delay session initialization to allow enough time to collect Adobe IDs
+  * Clean up extension registration flow
+
 - v1.1.3
   * _*Master Release*_ - November 19, 2019
   * Patch: automatically pick up all Adobe IDs and pass it to Branch
diff --git a/gradle.properties b/gradle.properties
@@ -11,8 +11,8 @@ org.gradle.jvmargs=-Xmx1536m
 # This option should only be used with decoupled projects. More details, visit
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
-VERSION_NAME=1.1.3
-VERSION_CODE=010103
+VERSION_NAME=1.2.0
+VERSION_CODE=010200
 GROUP=io.branch.sdk.android
 
 POM_NAME=Branch Adobe Android SDK
