feat: add configuration for user engagement event (#34)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>

Author: zhu-xiaowei

README.md

@@ -92,6 +92,7 @@ ClickstreamAnalytics.getClickStreamConfiguration()
             .withSendEventsInterval(10000)
             .withSessionTimeoutDuration(1800000)
             .withTrackScreenViewEvents(false)
+            .withTrackUserEngagementEvents(false)
             .withTrackAppExceptionEvents(false)
             .withLogEvents(true)
             .withCustomDns(CustomOkhttpDns.getInstance())

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

@@ -167,11 +167,6 @@ public void configure(
                     pluginConfiguration.getBoolean(ConfigurationKey.COMPRESS_EVENTS.getConfigurationKey()));
             }
 
-            if (pluginConfiguration.has(ConfigurationKey.TRACK_APP_LIFECYCLE_EVENTS.getConfigurationKey())) {
-                configurationBuilder.withTrackScreenViewEvents(pluginConfiguration
-                    .getBoolean(ConfigurationKey.TRACK_APP_LIFECYCLE_EVENTS.getConfigurationKey()));
-            }
-
             if (pluginConfiguration.has(ConfigurationKey.TRACK_APP_EXCEPTION_EVENTS.getConfigurationKey())) {
                 configurationBuilder.withTrackAppExceptionEvents(pluginConfiguration
                     .getBoolean(ConfigurationKey.TRACK_APP_EXCEPTION_EVENTS.getConfigurationKey()));
@@ -235,11 +230,6 @@ public enum ConfigurationKey {
          */
         COMPRESS_EVENTS("isCompressEvents"),
 
-        /**
-         * Whether to track app lifecycle events automatically.
-         */
-        TRACK_APP_LIFECYCLE_EVENTS("isTrackAppLifecycleEvents"),
-
         /**
          * Whether to track app exception events automatically.
          */

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

@@ -29,13 +29,15 @@ public final class AWSClickstreamPluginConfiguration {
     private final long sendEventsInterval;
     private final long callTimeOut;
     private final boolean isTrackScreenViewEvents;
+    private final boolean isTrackUserEngagementEvents;
     private final boolean isTrackAppExceptionEvents;
     private final boolean isCompressEvents;
     private final long sessionTimeOut;
 
     private AWSClickstreamPluginConfiguration(Builder builder) {
         this.appId = builder.appId;
         this.isTrackScreenViewEvents = builder.isTrackScreenViewEvents;
+        this.isTrackUserEngagementEvents = builder.isTrackUserEngagementEvents;
         this.isTrackAppExceptionEvents = builder.isTrackAppExceptionEvents;
         this.callTimeOut = builder.callTimeOut;
         this.sendEventsInterval = builder.sendEventsInterval;
@@ -80,6 +82,15 @@ boolean isTrackScreenViewEvents() {
         return isTrackScreenViewEvents;
     }
 
+    /**
+     * Is auto user engagement tracking enabled.
+     *
+     * @return Is auto user engagement tracking enabled.
+     */
+    boolean isTrackUserEngagementEvents() {
+        return isTrackUserEngagementEvents;
+    }
+
     /**
      * Is auto exception tracking enabled.
      *
@@ -136,6 +147,7 @@ static final class Builder {
         private final long callTimeOut = DEFAULT_CALL_TIME_OUT;
         private boolean isCompressEvents = true;
         private boolean isTrackScreenViewEvents = true;
+        private boolean isTrackUserEngagementEvents = true;
         private boolean isTrackAppExceptionEvents = false;
 
         private long sessionTimeOut = DEFAULT_SESSION_TIME_OUT;
@@ -165,6 +177,11 @@ Builder withTrackScreenViewEvents(final boolean trackScreenViewEvents) {
             return this;
         }
 
+        Builder withTrackUserEngagementEvents(final boolean trackUserEngagementEvents) {
+            this.isTrackUserEngagementEvents = trackUserEngagementEvents;
+            return this;
+        }
+
         Builder withTrackAppExceptionEvents(final boolean trackAppExceptionEvents) {
             this.isTrackAppExceptionEvents = trackAppExceptionEvents;
             return this;

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

@@ -37,6 +37,7 @@ static ClickstreamManager create(Context context,
                 .withCallTimeOut(clickstreamPluginConfiguration.getCallTimeOut())
                 .withCompressEvents(clickstreamPluginConfiguration.isCompressEvents())
                 .withTrackScreenViewEvents(clickstreamPluginConfiguration.isTrackScreenViewEvents())
+                .withTrackUserEngagementEvents(clickstreamPluginConfiguration.isTrackUserEngagementEvents())
                 .withTrackAppExceptionEvents(clickstreamPluginConfiguration.isTrackAppExceptionEvents())
                 .withSessionTimeoutDuration(clickstreamPluginConfiguration.getSessionTimeOut());
 

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

@@ -134,7 +134,8 @@ public String getScreenUniqueId(Activity activity) {
      */
     public void recordUserEngagement() {
         lastEngageTime = endEngageTimestamp - startEngageTimestamp;
-        if (lastEngageTime > MIN_ENGAGEMENT_TIME) {
+        if (clickstreamContext.getClickstreamConfiguration().isTrackUserEngagementEvents() &&
+            lastEngageTime > MIN_ENGAGEMENT_TIME) {
             final AnalyticsEvent event =
                 this.clickstreamContext.getAnalyticsClient().createEvent(Event.PresetEvent.USER_ENGAGEMENT);
             event.addAttribute(Event.ReservedAttribute.ENGAGEMENT_TIMESTAMP, lastEngageTime);

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

@@ -32,6 +32,7 @@ public class ClickstreamConfiguration {
     private long callTimeOut;
     private boolean isCompressEvents;
     private boolean isTrackScreenViewEvents;
+    private boolean isTrackUserEngagementEvents;
     private boolean isTrackAppExceptionEvents;
     private boolean isLogEvents;
     private String authCookie;
@@ -192,6 +193,15 @@ public boolean isTrackScreenViewEvents() {
         return this.isTrackScreenViewEvents;
     }
 
+    /**
+     * Is track user engagement events.
+     *
+     * @return Is track user engagement events.
+     */
+    public boolean isTrackUserEngagementEvents() {
+        return this.isTrackUserEngagementEvents;
+    }
+
     /**
      * Is track app screen view events.
      *
@@ -203,6 +213,17 @@ public ClickstreamConfiguration withTrackScreenViewEvents(final boolean isTrackS
         return this;
     }
 
+    /**
+     * Is track user engagement events.
+     *
+     * @param isTrackUserEngagementEvents Is track user engagement events.
+     * @return the current ClickstreamConfiguration instance.
+     */
+    public ClickstreamConfiguration withTrackUserEngagementEvents(final boolean isTrackUserEngagementEvents) {
+        this.isTrackUserEngagementEvents = isTrackUserEngagementEvents;
+        return this;
+    }
+
     /**
      * Is track app exception events.
      *

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

@@ -79,7 +79,9 @@ public void setup() {
         AWSClickstreamPluginConfiguration.Builder configurationBuilder = AWSClickstreamPluginConfiguration.builder();
         configurationBuilder.withAppId("demo-app")
             .withEndpoint("http://cs-se-serve-1qtj719j88vwn-1291141553.ap-southeast-1.elb.amazonaws.com/collect")
-            .withSendEventsInterval(10000).withTrackScreenViewEvents(true);
+            .withSendEventsInterval(10000)
+            .withTrackScreenViewEvents(true)
+            .withTrackUserEngagementEvents(true);
         AWSClickstreamPluginConfiguration clickstreamPluginConfiguration = configurationBuilder.build();
         ClickstreamManager clickstreamManager =
             ClickstreamManagerFactory.create(context, clickstreamPluginConfiguration);
@@ -146,6 +148,28 @@ public void testUserEngagementFail() throws Exception {
         }
     }
 
+    /**
+     * test record user engagement event when configure is disabled.
+     *
+     * @throws Exception exception.
+     */
+    @Test
+    public void testCloseUserEngagementEvent() throws Exception {
+        clickstreamContext.getClickstreamConfiguration().withTrackUserEngagementEvents(false);
+        lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_START);
+        Thread.sleep(1100);
+        lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_STOP);
+        try (Cursor cursor = dbUtil.queryAllEvents();) {
+            List<String> eventList = new ArrayList<>();
+            while (cursor.moveToNext()) {
+                String eventString = cursor.getString(2);
+                JSONObject jsonObject = new JSONObject(eventString);
+                eventList.add(jsonObject.getString("event_type"));
+            }
+            assertFalse(eventList.contains(Event.PresetEvent.USER_ENGAGEMENT));
+        }
+    }
+
     /**
      * test view only one screen and record an screen view event.
      *

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

@@ -57,7 +57,8 @@ public void setup() {
         AWSClickstreamPluginConfiguration.Builder configurationBuilder = AWSClickstreamPluginConfiguration.builder();
         configurationBuilder.withAppId("demo-app")
             .withEndpoint("http://cs-se-serve-1qtj719j88vwn-1291141553.ap-southeast-1.elb.amazonaws.com/collect")
-            .withSendEventsInterval(10000);
+            .withSendEventsInterval(10000)
+            .withSessionTimeOut(1800000L);
         AWSClickstreamPluginConfiguration clickstreamPluginConfiguration = configurationBuilder.build();
         ClickstreamManager clickstreamManager =
             ClickstreamManagerFactory.create(context, clickstreamPluginConfiguration);