feat: add _app_start event, change user engagement attribute. (#20)

zhu-xiaowei · xiaoweii · web-flow · commit 1e570e52fe0a · 2023-06-14T18:35:10.000+08:00
Co-authored-by: xiaoweii &lt;xiaoweii@amazom.com&gt;
diff --git a/README.md b/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.4.4'
+    implementation 'software.aws.solution:clickstream:0.5.0'
 }
 ```
 
diff --git a/clickstream/src/main/java/software/aws/solution/clickstream/ActivityLifecycleManager.java b/clickstream/src/main/java/software/aws/solution/clickstream/ActivityLifecycleManager.java
@@ -143,7 +143,7 @@ public void onStateChanged(@NonNull LifecycleOwner lifecycleOwner, @NonNull Life
             autoRecordEventClient.recordUserEngagement();
         } else if (event == Lifecycle.Event.ON_START) {
             LOG.debug("Application entered the foreground.");
-            autoRecordEventClient.handleFirstOpen();
+            autoRecordEventClient.handleAppStart();
             autoRecordEventClient.updateEngageTimestamp();
             boolean isNewSession = sessionClient.initialSession();
             if (isNewSession) {
diff --git a/clickstream/src/main/java/software/aws/solution/clickstream/client/AutoRecordEventClient.java b/clickstream/src/main/java/software/aws/solution/clickstream/client/AutoRecordEventClient.java
@@ -42,6 +42,11 @@ public class AutoRecordEventClient {
      */
     private boolean isFirstOpen;
 
+    /**
+     * whether app is first time start from process launch.
+     */
+    private boolean isFirstTime = true;
+
     /**
      * current screen is entrances.
      */
@@ -71,17 +76,21 @@ public AutoRecordEventClient(@NonNull final ClickstreamContext clickstreamContex
     public void recordViewScreen(Activity activity) {
         String screenId = activity.getClass().getCanonicalName();
         String screenName = activity.getClass().getSimpleName();
+        long currentTimestamp = System.currentTimeMillis();
         ScreenRefererTool.setCurrentScreenId(screenId);
         ScreenRefererTool.setCurrentScreenName(screenName);
+        ScreenRefererTool.setCurrentScreenStartTimestamp(currentTimestamp);
         final AnalyticsEvent event =
             this.clickstreamContext.getAnalyticsClient().createEvent(Event.PresetEvent.SCREEN_VIEW);
         event.addAttribute(Event.ReservedAttribute.SCREEN_NAME, ScreenRefererTool.getCurrentScreenName());
         event.addAttribute(Event.ReservedAttribute.SCREEN_ID, ScreenRefererTool.getCurrentScreenId());
         event.addAttribute(Event.ReservedAttribute.PREVIOUS_SCREEN_NAME, ScreenRefererTool.getPreviousScreenName());
         event.addAttribute(Event.ReservedAttribute.PREVIOUS_SCREEN_ID, ScreenRefererTool.getPreviousScreenId());
         event.addAttribute(Event.ReservedAttribute.ENTRANCES, isEntrances ? 1 : 0);
-        event.addAttribute(Event.ReservedAttribute.ENGAGEMENT_TIMESTAMP,
-            System.currentTimeMillis() - startEngageTimestamp);
+        if (!isEntrances) {
+            event.addAttribute(Event.ReservedAttribute.ENGAGEMENT_TIMESTAMP,
+                currentTimestamp - ScreenRefererTool.getPreviousScreenStartTimestamp());
+        }
         this.clickstreamContext.getAnalyticsClient().recordEvent(event);
         isEntrances = false;
         LOG.debug("record an _screen_view event, screenId:" + screenId + "lastScreenId:" +
@@ -97,6 +106,8 @@ public void recordUserEngagement() {
             final AnalyticsEvent event =
                 this.clickstreamContext.getAnalyticsClient().createEvent(Event.PresetEvent.USER_ENGAGEMENT);
             event.addAttribute(Event.ReservedAttribute.ENGAGEMENT_TIMESTAMP, engagementTime);
+            event.addAttribute(Event.ReservedAttribute.SCREEN_NAME, ScreenRefererTool.getCurrentScreenName());
+            event.addAttribute(Event.ReservedAttribute.SCREEN_ID, ScreenRefererTool.getCurrentScreenId());
             this.clickstreamContext.getAnalyticsClient().recordEvent(event);
         }
     }
@@ -151,7 +162,7 @@ private void checkOSVersionUpdate() {
     /**
      * handle the first open event.
      */
-    public void handleFirstOpen() {
+    public void handleAppStart() {
         checkAppVersionUpdate();
         checkOSVersionUpdate();
         if (isFirstOpen) {
@@ -161,6 +172,13 @@ public void handleFirstOpen() {
             clickstreamContext.getSystem().getPreferences().putBoolean("isFirstOpen", false);
             isFirstOpen = false;
         }
+        final AnalyticsEvent event =
+            this.clickstreamContext.getAnalyticsClient().createEvent(Event.PresetEvent.APP_START);
+        event.addAttribute(Event.ReservedAttribute.IS_FIRST_TIME, isFirstTime);
+        event.addAttribute(Event.ReservedAttribute.SCREEN_NAME, ScreenRefererTool.getCurrentScreenName());
+        event.addAttribute(Event.ReservedAttribute.SCREEN_ID, ScreenRefererTool.getCurrentScreenId());
+        this.clickstreamContext.getAnalyticsClient().recordEvent(event);
+        isFirstTime = false;
     }
 
     /**
diff --git a/clickstream/src/main/java/software/aws/solution/clickstream/client/Event.java b/clickstream/src/main/java/software/aws/solution/clickstream/client/Event.java
@@ -269,6 +269,11 @@ public static final class ReservedAttribute {
          */
         public static final String ENGAGEMENT_TIMESTAMP = "_engagement_time_msec";
 
+        /**
+         * is the first time attribute.
+         */
+        public static final String IS_FIRST_TIME = "_is_first_time";
+
         private ReservedAttribute() {
         }
     }
@@ -282,15 +287,16 @@ public static final class PresetEvent {
          */
         public static final String SESSION_START = "_session_start";
 
-        /**
-         * The eventType recorded for session stop events.
-         */
-        public static final String SESSION_STOP = "_session_stop";
         /**
          * The eventType recorded for app first open from install.
          */
         public static final String FIRST_OPEN = "_first_open";
 
+        /**
+         * The eventType recorded for app start when app move to foreground.
+         */
+        public static final String APP_START = "_app_start";
+
         /**
          * The user engagement event when the app is in the foreground at least one second.
          */
diff --git a/clickstream/src/main/java/software/aws/solution/clickstream/client/ScreenRefererTool.java b/clickstream/src/main/java/software/aws/solution/clickstream/client/ScreenRefererTool.java
@@ -24,6 +24,8 @@ public final class ScreenRefererTool {
     private static String mCurrentScreenId;
     private static String mPreviousScreenName;
     private static String mCurrentScreenName;
+    private static long mPreviousScreenStartTimestamp;
+    private static long mCurrentScreenStartTimestamp;
 
     private ScreenRefererTool() {
     }
@@ -48,6 +50,16 @@ public static void setCurrentScreenId(String screenId) {
         mCurrentScreenId = screenId;
     }
 
+    /**
+     * set current screen id.
+     *
+     * @param timestamp current screen engage timestamp.
+     */
+    public static void setCurrentScreenStartTimestamp(long timestamp) {
+        mPreviousScreenStartTimestamp = mCurrentScreenStartTimestamp;
+        mCurrentScreenStartTimestamp = timestamp;
+    }
+
     /**
      * get current ScreenName.
      *
@@ -83,4 +95,13 @@ public static String getPreviousScreenName() {
     public static String getPreviousScreenId() {
         return mPreviousScreenId;
     }
+
+    /**
+     * get previous screen start timestamp.
+     *
+     * @return previous screen start timestamp
+     */
+    public static long getPreviousScreenStartTimestamp() {
+        return mPreviousScreenStartTimestamp;
+    }
 }
diff --git a/clickstream/src/main/java/software/aws/solution/clickstream/client/network/NetRequest.java b/clickstream/src/main/java/software/aws/solution/clickstream/client/network/NetRequest.java
@@ -106,7 +106,7 @@ private static Response request(@NonNull String eventJson, @NonNull ClickstreamC
         RequestBody body = RequestBody.create(curStr, MediaType.parse("application/json; charset=utf-8"));
         Request request = new Request.Builder().url(endpoint).build();
         HttpUrl url = request.url().newBuilder()
-            .addQueryParameter("platform", "ANDROID")
+            .addQueryParameter("platform", "Android")
             .addQueryParameter("appId", appId)
             .addQueryParameter("event_bundle_sequence_id", String.valueOf(bundleSequenceId))
             .addQueryParameter("compression", compression)
diff --git a/clickstream/src/main/java/software/aws/solution/clickstream/client/system/AndroidDeviceDetails.java b/clickstream/src/main/java/software/aws/solution/clickstream/client/system/AndroidDeviceDetails.java
@@ -59,7 +59,7 @@ public String platformVersion() {
      * @return The name of platform.
      */
     public String platform() {
-        return "ANDROID";
+        return "Android";
     }
 
     /**
diff --git a/clickstream/src/test/java/software/aws/solution/clickstream/ActivityLifecycleManagerUnitTest.java b/clickstream/src/test/java/software/aws/solution/clickstream/ActivityLifecycleManagerUnitTest.java
@@ -117,7 +117,7 @@ public void testOnAppForegrounded() {
         when(sessionClient.initialSession()).thenReturn(true);
         lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_START);
         verify(autoRecordEventClient).updateEngageTimestamp();
-        verify(autoRecordEventClient).handleFirstOpen();
+        verify(autoRecordEventClient).handleAppStart();
         verify(sessionClient).initialSession();
         verify(autoRecordEventClient).setIsEntrances();
     }
diff --git a/clickstream/src/test/java/software/aws/solution/clickstream/AutoRecordEventClientTest.java b/clickstream/src/test/java/software/aws/solution/clickstream/AutoRecordEventClientTest.java
@@ -39,6 +39,7 @@
 import software.aws.solution.clickstream.client.ClickstreamContext;
 import software.aws.solution.clickstream.client.ClickstreamManager;
 import software.aws.solution.clickstream.client.Event;
+import software.aws.solution.clickstream.client.ScreenRefererTool;
 import software.aws.solution.clickstream.client.db.ClickstreamDBUtil;
 import software.aws.solution.clickstream.client.util.StringUtil;
 import software.aws.solution.clickstream.util.ReflectUtil;
@@ -96,7 +97,7 @@ public void setup() {
     @Test
     public void testUserEngagementSuccess() throws Exception {
         lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_START);
-        Thread.sleep(1500);
+        Thread.sleep(1100);
         lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_STOP);
         try (Cursor cursor = dbUtil.queryAllEvents()) {
             List<String> eventList = new ArrayList<>();
@@ -108,12 +109,15 @@ public void testUserEngagementSuccess() throws Exception {
                 if (eventName.equals(Event.PresetEvent.USER_ENGAGEMENT)) {
                     JSONObject attributes = jsonObject.getJSONObject("attributes");
                     assertTrue(attributes.has(ReservedAttribute.ENGAGEMENT_TIMESTAMP));
+                    assertFalse(attributes.has(ReservedAttribute.SCREEN_NAME));
+                    assertFalse(attributes.has(ReservedAttribute.SCREEN_ID));
                     assertTrue(attributes.getLong(ReservedAttribute.ENGAGEMENT_TIMESTAMP) > 1000);
                 }
             }
             assertEquals(Event.PresetEvent.FIRST_OPEN, eventList.get(0));
-            assertEquals(Event.PresetEvent.SESSION_START, eventList.get(1));
-            assertEquals(Event.PresetEvent.USER_ENGAGEMENT, eventList.get(2));
+            assertEquals(Event.PresetEvent.APP_START, eventList.get(1));
+            assertEquals(Event.PresetEvent.SESSION_START, eventList.get(2));
+            assertEquals(Event.PresetEvent.USER_ENGAGEMENT, eventList.get(3));
         }
     }
 
@@ -164,6 +168,7 @@ public void testViewOneScreenEvent() throws Exception {
                     Assert.assertFalse(attributes.has(ReservedAttribute.PREVIOUS_SCREEN_NAME));
                     Assert.assertFalse(attributes.has(ReservedAttribute.PREVIOUS_SCREEN_ID));
                     Assert.assertEquals(1, attributes.getInt(ReservedAttribute.ENTRANCES));
+                    Assert.assertFalse(attributes.has(ReservedAttribute.ENGAGEMENT_TIMESTAMP));
                 }
             }
             assertTrue(eventList.contains(Event.PresetEvent.SCREEN_VIEW));
@@ -208,8 +213,9 @@ public void testViewTwoScreenEvent() throws Exception {
                 attributes.getString(ReservedAttribute.PREVIOUS_SCREEN_NAME));
             assertEquals(activity1.getClass().getCanonicalName(),
                 attributes.getString(ReservedAttribute.PREVIOUS_SCREEN_ID));
-
             assertEquals(0, attributes.getInt(ReservedAttribute.ENTRANCES));
+            Assert.assertTrue(attributes.has(ReservedAttribute.ENGAGEMENT_TIMESTAMP));
+            Assert.assertTrue(attributes.getLong(ReservedAttribute.ENGAGEMENT_TIMESTAMP) >= 0);
         }
     }
 
@@ -333,8 +339,8 @@ public void testOSVersionForUpdate() throws Exception {
      */
     @Test
     public void testHandleFirstOpen() throws Exception {
-        client.handleFirstOpen();
-        assertEquals(1, dbUtil.getTotalNumber());
+        client.handleAppStart();
+        assertEquals(2, dbUtil.getTotalNumber());
         Cursor cursor = dbUtil.queryAllEvents();
         cursor.moveToFirst();
         String eventString = cursor.getString(2);
@@ -351,10 +357,10 @@ public void testHandleFirstOpen() throws Exception {
      */
     @Test
     public void testHandleFirstOpenMultiTimes() throws Exception {
-        client.handleFirstOpen();
-        client.handleFirstOpen();
-        client.handleFirstOpen();
-        assertEquals(1, dbUtil.getTotalNumber());
+        client.handleAppStart();
+        client.handleAppStart();
+        client.handleAppStart();
+        assertEquals(4, dbUtil.getTotalNumber());
         Cursor cursor = dbUtil.queryAllEvents();
         cursor.moveToFirst();
         String eventString = cursor.getString(2);
@@ -364,6 +370,47 @@ public void testHandleFirstOpenMultiTimes() throws Exception {
         cursor.close();
     }
 
+    /**
+     * test execute handleAppStart.
+     *
+     * @throws Exception exception.
+     */
+    @Test
+    public void testHandleAppStart() throws Exception {
+        client.handleAppStart();
+        Activity activity1 = mock(Activity.class);
+        Bundle bundle = mock(Bundle.class);
+        callbacks.onActivityCreated(activity1, bundle);
+        callbacks.onActivityStarted(activity1);
+        callbacks.onActivityResumed(activity1);
+        client.handleAppStart();
+        assertEquals(4, dbUtil.getTotalNumber());
+        try (Cursor cursor = dbUtil.queryAllEvents()) {
+            List<JSONObject> eventList = new ArrayList<>();
+            while (cursor.moveToNext()) {
+                String eventString = cursor.getString(2);
+                JSONObject jsonObject = new JSONObject(eventString);
+                eventList.add(jsonObject);
+            }
+            assertEquals(Event.PresetEvent.FIRST_OPEN, eventList.get(0).getString("event_type"));
+            assertEquals(Event.PresetEvent.APP_START, eventList.get(1).getString("event_type"));
+            JSONObject appStart1 = eventList.get(1).getJSONObject("attributes");
+            assertTrue(appStart1.getBoolean(Event.ReservedAttribute.IS_FIRST_TIME));
+            assertFalse(appStart1.has(ReservedAttribute.SCREEN_NAME));
+            assertFalse(appStart1.has(Event.ReservedAttribute.SCREEN_ID));
+
+            assertEquals(Event.PresetEvent.SCREEN_VIEW, eventList.get(2).getString("event_type"));
+
+            assertEquals(Event.PresetEvent.APP_START, eventList.get(3).getString("event_type"));
+            JSONObject appStart2 = eventList.get(3).getJSONObject("attributes");
+            assertFalse(appStart2.getBoolean(Event.ReservedAttribute.IS_FIRST_TIME));
+            assertTrue(appStart2.has(ReservedAttribute.SCREEN_NAME));
+            assertTrue(appStart2.has(Event.ReservedAttribute.SCREEN_ID));
+            assertEquals(activity1.getClass().getSimpleName(), appStart2.getString(ReservedAttribute.SCREEN_NAME));
+            assertEquals(activity1.getClass().getCanonicalName(), appStart2.getString(ReservedAttribute.SCREEN_ID));
+        }
+    }
+
     /**
      * test init autoRecordEventClient with null analyticsClient.
      */
@@ -378,6 +425,8 @@ public void testInitAutoRecordEventClientWithNullAnalyticsClient() {
      */
     @After
     public void tearDown() {
+        ScreenRefererTool.setCurrentScreenName(null);
+        ScreenRefererTool.setCurrentScreenId(null);
         dbUtil.closeDB();
     }
 }
diff --git a/gradle.properties b/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.4.4
+VERSION_NAME=0.5.0
 
 POM_GROUP=software.aws.solution
 POM_ARTIFACT_ID=clickstream

Original file line number	Diff line number	Diff line change
@@ -20,7 +20,7 @@ Add the following dependency to your `app` module's `build.gradle` file.
`20`	`20`
`21`	`21`	```groovy
`22`	`22`	`dependencies {`
`23`		`- implementation 'software.aws.solution:clickstream:0.4.4'`
	`23`	`+ implementation 'software.aws.solution:clickstream:0.5.0'`
`24`	`24`	`}`
`25`	`25`	```
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public String platformVersion() {`
`59`	`59`	`* @return The name of platform.`
`60`	`60`	`*/`
`61`	`61`	`public String platform() {`
`62`		`- return "ANDROID";`
	`62`	`+ return "Android";`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public void testOnAppForegrounded() {`
`117`	`117`	`when(sessionClient.initialSession()).thenReturn(true);`
`118`	`118`	`lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_START);`
`119`	`119`	`verify(autoRecordEventClient).updateEngageTimestamp();`
`120`		`- verify(autoRecordEventClient).handleFirstOpen();`
	`120`	`+ verify(autoRecordEventClient).handleAppStart();`
`121`	`121`	`verify(sessionClient).initialSession();`
`122`	`122`	`verify(autoRecordEventClient).setIsEntrances();`
`123`	`123`	`}`