feat: support application context when initialize SDK. (#25)

Co-authored-by: xiaoweii <[email protected]>

Author: zhu-xiaowei

README.md

@@ -20,7 +20,7 @@ Add the following dependency to your `app` module's `build.gradle` file.
 
 ```groovy
 dependencies {
-    implementation 'software.aws.solution:clickstream:0.5.1'
+    implementation 'software.aws.solution:clickstream:0.5.2'
 }
 ```
 
@@ -32,7 +32,7 @@ Find the res directory under your  `project/app/src/main` , and manually create
 
 ![](images/raw_folder.png)
 
-Downlod your `amplifyconfiguration.json` file from your clickstream control plane, and paste it to raw floder, the json file will be as following:
+Download your `amplifyconfiguration.json` file from your clickstream control plane, and paste it to raw folder, the json file will be as following:
 
 ```json
 {
@@ -69,7 +69,7 @@ public void onCreate() {
     super.onCreate();
 
     try{
-        ClickstreamAnalytics.init(this);
+        ClickstreamAnalytics.init(getApplicationContext());
         Log.i("MyApp", "Initialized ClickstreamAnalytics");
     } catch (AmplifyException error){
         Log.e("MyApp", "Could not initialize ClickstreamAnalytics", error);

clickstream/src/main/java/software/aws/solution/clickstream/AWSClickstreamPlugin.java

@@ -15,7 +15,6 @@
 
 package software.aws.solution.clickstream;
 
-import android.app.Application;
 import android.content.Context;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -45,18 +44,18 @@
 public final class AWSClickstreamPlugin extends AnalyticsPlugin<Object> {
 
     private static final Log LOG = LogFactory.getLog(AWSClickstreamPlugin.class);
-    private final Application application;
+    private final Context context;
     private AnalyticsClient analyticsClient;
     private AutoEventSubmitter autoEventSubmitter;
     private ActivityLifecycleManager activityLifecycleManager;
 
     /**
      * Constructs a new {@link AWSClickstreamPlugin}.
      *
-     * @param application Global application context
+     * @param context ApplicationContext
      */
-    public AWSClickstreamPlugin(final Application application) {
-        this.application = application;
+    public AWSClickstreamPlugin(final Context context) {
+        this.context = context;
     }
 
     @Override
@@ -79,13 +78,13 @@ public void identifyUser(@NonNull String userId, @Nullable UserProfile profile)
     @Override
     public void disable() {
         autoEventSubmitter.stop();
-        activityLifecycleManager.stopLifecycleTracking(application);
+        activityLifecycleManager.stopLifecycleTracking(context);
     }
 
     @Override
     public void enable() {
         autoEventSubmitter.start();
-        activityLifecycleManager.startLifecycleTracking(application, ProcessLifecycleOwner.get().getLifecycle());
+        activityLifecycleManager.startLifecycleTracking(context, ProcessLifecycleOwner.get().getLifecycle());
     }
 
     @Override
@@ -197,7 +196,7 @@ public void configure(
         autoEventSubmitter.start();
 
         activityLifecycleManager = new ActivityLifecycleManager(clickstreamManager);
-        activityLifecycleManager.startLifecycleTracking(application, ProcessLifecycleOwner.get().getLifecycle());
+        activityLifecycleManager.startLifecycleTracking(this.context, ProcessLifecycleOwner.get().getLifecycle());
     }
 
     @Override

clickstream/src/main/java/software/aws/solution/clickstream/ActivityLifecycleManager.java

@@ -17,6 +17,7 @@
 
 import android.app.Activity;
 import android.app.Application;
+import android.content.Context;
 import android.os.Bundle;
 import androidx.annotation.NonNull;
 import androidx.lifecycle.Lifecycle;
@@ -35,11 +36,8 @@
  **/
 final class ActivityLifecycleManager implements Application.ActivityLifecycleCallbacks, LifecycleEventObserver {
     private static final Log LOG = LogFactory.getLog(ActivityLifecycleManager.class);
-
     private final SessionClient sessionClient;
     private final AutoRecordEventClient autoRecordEventClient;
-    private boolean inForeground;
-    private int foregroundActivityCount;
 
     /**
      * Constructor. Registers to receive activity lifecycle events.
@@ -49,17 +47,21 @@ final class ActivityLifecycleManager implements Application.ActivityLifecycleCal
     ActivityLifecycleManager(final ClickstreamManager clickstreamManager) {
         this.sessionClient = clickstreamManager.getSessionClient();
         this.autoRecordEventClient = clickstreamManager.getAutoRecordEventClient();
-        inForeground = false;
-        foregroundActivityCount = 0;
     }
 
-    void startLifecycleTracking(final Application application, Lifecycle lifecycle) {
-        application.registerActivityLifecycleCallbacks(this);
-        lifecycle.addObserver(this);
+    void startLifecycleTracking(final Context context, Lifecycle lifecycle) {
+        if (context instanceof Application) {
+            ((Application) context).registerActivityLifecycleCallbacks(this);
+            lifecycle.addObserver(this);
+        } else {
+            LOG.warn("The context is not ApplicationContext, so lifecycle events are not automatically recorded");
+        }
     }
 
-    void stopLifecycleTracking(final Application application) {
-        application.unregisterActivityLifecycleCallbacks(this);
+    void stopLifecycleTracking(final Context context) {
+        if (context instanceof Application) {
+            ((Application) context).unregisterActivityLifecycleCallbacks(this);
+        }
     }
 
     @Override
@@ -77,8 +79,6 @@ public void onActivityResumed(final Activity activity) {
         // An activity came to foreground. Application potentially entered foreground as well
         // if there were no other activities in the foreground.
         LOG.debug("Activity resumed: " + activity.getLocalClassName());
-        checkIfApplicationEnteredForeground();
-        foregroundActivityCount++;
         autoRecordEventClient.recordViewScreen(activity);
     }
 
@@ -97,8 +97,6 @@ public void onActivityStopped(final Activity activity) {
         // no other activities in non-stopped states, in which case app is not visible to user and has
         // entered background state.
         LOG.debug("Activity stopped: " + activity.getLocalClassName());
-        foregroundActivityCount--;
-        checkIfApplicationEnteredBackground();
     }
 
     @Override
@@ -112,29 +110,6 @@ public void onActivityDestroyed(final Activity activity) {
         LOG.debug("Activity destroyed " + activity.getLocalClassName());
     }
 
-    /**
-     * Called from onActivityResumed to check if the application came to the foreground.
-     */
-    private void checkIfApplicationEnteredForeground() {
-        // if nothing is in the activity lifecycle map indicating that we are likely in the background, and the flag
-        // indicates we are indeed in the background.
-        if (foregroundActivityCount == 0 && !inForeground) {
-            inForeground = true;
-            LOG.debug("Application open.");
-        }
-    }
-
-    /**
-     * Called from onActivityStopped to check if the application receded to the background.
-     */
-    private void checkIfApplicationEnteredBackground() {
-        // If the App is in the foreground and there are no longer any activities that have not been stopped.
-        if (foregroundActivityCount == 0 && inForeground) {
-            inForeground = false;
-            LOG.debug("Application exit.");
-        }
-    }
-
     @Override
     public void onStateChanged(@NonNull LifecycleOwner lifecycleOwner, @NonNull Lifecycle.Event event) {
         if (event == Lifecycle.Event.ON_STOP) {

clickstream/src/main/java/software/aws/solution/clickstream/ClickstreamAnalytics.java

@@ -15,7 +15,7 @@
 
 package software.aws.solution.clickstream;
 
-import android.app.Application;
+import android.content.Context;
 import androidx.annotation.NonNull;
 
 import com.amplifyframework.AmplifyException;
@@ -40,7 +40,7 @@ private ClickstreamAnalytics() {
      * @param context ApplicationContext
      * @throws AmplifyException Exception of init.
      */
-    public static void init(@NonNull Application context) throws AmplifyException {
+    public static void init(@NonNull Context context) throws AmplifyException {
         Amplify.addPlugin(new AWSClickstreamPlugin(context));
         Amplify.configure(context);
     }

clickstream/src/test/java/software/aws/solution/clickstream/ActivityLifecycleManagerUnitTest.java

@@ -47,6 +47,7 @@ public final class ActivityLifecycleManagerUnitTest {
     private Application.ActivityLifecycleCallbacks callbacks;
     private Log log;
     private LifecycleRegistry lifecycle;
+    private ActivityLifecycleManager lifecycleManager;
 
     /**
      * Setup dependencies and object under test.
@@ -60,7 +61,7 @@ public void setup() throws Exception {
         this.autoRecordEventClient = mock(AutoRecordEventClient.class);
         when(clickstreamManager.getSessionClient()).thenReturn(sessionClient);
         when(clickstreamManager.getAutoRecordEventClient()).thenReturn(autoRecordEventClient);
-        ActivityLifecycleManager lifecycleManager = new ActivityLifecycleManager(clickstreamManager);
+        lifecycleManager = new ActivityLifecycleManager(clickstreamManager);
         this.callbacks = lifecycleManager;
         log = mock(Log.class);
         ReflectUtil.modifyFiled(this.callbacks, "LOG", log);
@@ -82,7 +83,6 @@ public void testWhenAppOpened() {
         callbacks.onActivityCreated(activity, bundle);
         callbacks.onActivityStarted(activity);
         callbacks.onActivityResumed(activity);
-        verify(log).debug("Application open.");
     }
 
     /**
@@ -104,9 +104,16 @@ public void testWhenAppEnterAndExit() {
         callbacks.onActivitySaveInstanceState(activity, bundle);
         callbacks.onActivityStopped(activity);
         callbacks.onActivityDestroyed(activity);
+    }
 
-        verify(log).debug("Application open.");
-        verify(log).debug("Application exit.");
+    /**
+     * test invalid context.
+     */
+    @Test
+    public void testContextIsInValid() {
+        Activity activity = mock(Activity.class);
+        lifecycleManager.startLifecycleTracking(activity, lifecycle);
+        verify(log).warn("The context is not ApplicationContext, so lifecycle events are not automatically recorded");
     }
 
     /**

gradle.properties

@@ -12,7 +12,7 @@ org.gradle.jvmargs=-Xmx4g
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 org.gradle.parallel=true
 
-VERSION_NAME=0.5.1
+VERSION_NAME=0.5.2
 
 POM_GROUP=software.aws.solution
 POM_ARTIFACT_ID=clickstream