feat: add preset event app end (#35)

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

Author: zhu-xiaowei

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

@@ -123,6 +123,7 @@ public void onStateChanged(@NonNull LifecycleOwner lifecycleOwner, @NonNull Life
         if (event == Lifecycle.Event.ON_STOP) {
             LOG.debug("Application entered the background.");
             autoRecordEventClient.recordUserEngagement();
+            autoRecordEventClient.handleAppEnd();
             sessionClient.storeSession();
             autoRecordEventClient.flushEvents();
         } else if (event == Lifecycle.Event.ON_START) {

clickstream/src/main/java/software/aws/solution/clickstream/client/AutoRecordEventClient.java

@@ -206,11 +206,13 @@ private void checkOSVersionUpdate() {
     }
 
     /**
-     * handle the first open event.
+     * handle the app start event.
      */
     public void handleAppStart() {
-        checkAppVersionUpdate();
-        checkOSVersionUpdate();
+        if (isFirstTime) {
+            checkAppVersionUpdate();
+            checkOSVersionUpdate();
+        }
         if (isFirstOpen) {
             final AnalyticsEvent event =
                 this.clickstreamContext.getAnalyticsClient().createEvent(Event.PresetEvent.FIRST_OPEN);
@@ -223,10 +225,23 @@ public void handleAppStart() {
         event.addAttribute(Event.ReservedAttribute.IS_FIRST_TIME, isFirstTime);
         event.addAttribute(Event.ReservedAttribute.SCREEN_NAME, ScreenRefererTool.getCurrentScreenName());
         event.addAttribute(Event.ReservedAttribute.SCREEN_ID, ScreenRefererTool.getCurrentScreenId());
+        event.addAttribute(Event.ReservedAttribute.SCREEN_UNIQUE_ID, ScreenRefererTool.getCurrentScreenUniqueId());
         this.clickstreamContext.getAnalyticsClient().recordEvent(event);
         isFirstTime = false;
     }
 
+    /**
+     * handle the app end event.
+     */
+    public void handleAppEnd() {
+        final AnalyticsEvent event =
+            this.clickstreamContext.getAnalyticsClient().createEvent(Event.PresetEvent.APP_END);
+        event.addAttribute(Event.ReservedAttribute.SCREEN_NAME, ScreenRefererTool.getCurrentScreenName());
+        event.addAttribute(Event.ReservedAttribute.SCREEN_ID, ScreenRefererTool.getCurrentScreenId());
+        event.addAttribute(Event.ReservedAttribute.SCREEN_UNIQUE_ID, ScreenRefererTool.getCurrentScreenUniqueId());
+        this.clickstreamContext.getAnalyticsClient().recordEvent(event);
+    }
+
     /**
      * setter for isEntrances.
      */

clickstream/src/main/java/software/aws/solution/clickstream/client/Event.java

@@ -311,6 +311,11 @@ public static final class PresetEvent {
          */
         public static final String APP_START = "_app_start";
 
+        /**
+         * The eventType recorded for app end when app move to background.
+         */
+        public static final String APP_END = "_app_end";
+
         /**
          * The user engagement event when the app is in the foreground at least one second.
          */

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

@@ -125,6 +125,7 @@ public void testUserEngagementSuccess() throws Exception {
             assertEquals(Event.PresetEvent.APP_START, eventList.get(1));
             assertEquals(Event.PresetEvent.SESSION_START, eventList.get(2));
             assertEquals(Event.PresetEvent.USER_ENGAGEMENT, eventList.get(3));
+            assertEquals(Event.PresetEvent.APP_END, eventList.get(4));
         }
     }
 
@@ -617,6 +618,32 @@ public void testHandleAppStart() throws Exception {
         }
     }
 
+    /**
+     * test app end event.
+     *
+     * @throws Exception exception.
+     */
+    @Test
+    public void testAppEnd() throws Exception {
+        Activity activity = mock(Activity.class);
+        Bundle bundle = mock(Bundle.class);
+        callbacks.onActivityCreated(activity, bundle);
+        callbacks.onActivityStarted(activity);
+        callbacks.onActivityResumed(activity);
+        client.handleAppEnd();
+        try (Cursor cursor = dbUtil.queryAllEvents()) {
+            cursor.moveToLast();
+            String eventString = cursor.getString(2);
+            JSONObject jsonObject = new JSONObject(eventString);
+            String eventType = jsonObject.getString("event_type");
+            JSONObject attributes = jsonObject.getJSONObject("attributes");
+            assertEquals(Event.PresetEvent.APP_END, eventType);
+            assertTrue(attributes.has(ReservedAttribute.SCREEN_NAME));
+            assertTrue(attributes.has(ReservedAttribute.SCREEN_ID));
+            assertTrue(attributes.has(ReservedAttribute.SCREEN_UNIQUE_ID));
+        }
+    }
+
     /**
      * test case for app move to background with flush event.
      *