(fix): Refactored Use of Event Processor (#299)

* Refactored Use of Event Processor

* Refactored Use of Event Processor

* Update Java-sdk version in gradle.build

* Reverted the Java SDK Version

* Updated java-sdk version

* Updated java-sdk version

* update unit tests

* setting notificationcenter if sent from optimizelymanager

* sending eventProcessor to optimizely

* Added Close

* hope you don't mind. updated java sdk to get build to pass. :)

Author: fayyazarshad

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyManagerBuilderTest.java

@@ -16,50 +16,19 @@
 
 package com.optimizely.ab.android.sdk;
 
-import android.app.UiModeManager;
-import android.content.Context;
-import android.content.res.Configuration;
-import android.os.Build;
-import android.support.annotation.RequiresApi;
 import android.support.test.InstrumentationRegistry;
-import android.support.test.espresso.core.deps.guava.util.concurrent.ListeningExecutorService;
 import android.support.test.runner.AndroidJUnit4;
-
-import com.optimizely.ab.Optimizely;
 import com.optimizely.ab.OptimizelyRuntimeException;
 import com.optimizely.ab.android.datafile_handler.DefaultDatafileHandler;
 import com.optimizely.ab.android.event_handler.DefaultEventHandler;
-import com.optimizely.ab.android.shared.DatafileConfig;
 import com.optimizely.ab.android.user_profile.DefaultUserProfileService;
-import com.optimizely.ab.config.Experiment;
-import com.optimizely.ab.config.ProjectConfig;
-import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.error.ErrorHandler;
-import com.optimizely.ab.event.internal.payload.Event;
-import com.optimizely.ab.notification.NotificationListener;
-
-import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.mockito.Mock;
-import org.mockito.exceptions.verification.junit.ArgumentsAreDifferent;
 import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-
-import static junit.framework.Assert.assertEquals;
-import static junit.framework.Assert.assertFalse;
 import static junit.framework.Assert.assertNotNull;
-import static junit.framework.Assert.assertNull;
-import static junit.framework.Assert.assertTrue;
 import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.verifyZeroInteractions;
-import static org.mockito.Mockito.when;
 
 @RunWith(AndroidJUnit4.class)
 public class OptimizelyManagerBuilderTest {

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyManagerTest.java

@@ -41,6 +41,7 @@
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.EventHandler;
+import com.optimizely.ab.event.EventProcessor;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -96,8 +97,15 @@ public void setup() throws Exception {
         executor = MoreExecutors.newDirectExecutorService();
         defaultDatafileHandler = mock(DefaultDatafileHandler.class);
         EventHandler eventHandler = mock(DefaultEventHandler.class);
-        optimizelyManager = new OptimizelyManager(testProjectId, null, null, logger, 3600L, defaultDatafileHandler, null, 3600L,
-                eventHandler, null);
+        EventProcessor eventProcessor = mock(EventProcessor.class);
+        optimizelyManager = OptimizelyManager.builder(testProjectId)
+                .withLogger(logger)
+                .withDatafileDownloadInterval(3600L)
+                .withDatafileHandler(defaultDatafileHandler)
+                .withEventDispatchInterval(3600L)
+                .withEventHandler(eventHandler)
+                .withEventProcessor(eventProcessor)
+                .build(InstrumentationRegistry.getTargetContext());
         String datafile = optimizelyManager.getDatafile(InstrumentationRegistry.getTargetContext(), R.raw.datafile);
         ProjectConfig config = new DatafileProjectConfig.Builder().withDatafile(datafile).build();
 
@@ -152,8 +160,9 @@ public void initializeSyncWithEnvironment() {
         Logger logger = mock(Logger.class);
         DatafileHandler datafileHandler = mock(DefaultDatafileHandler.class);
         EventHandler eventHandler = mock(DefaultEventHandler.class);
+        EventProcessor eventProcessor = mock(EventProcessor.class);
         OptimizelyManager optimizelyManager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, 3600L, datafileHandler, null, 3600L,
-                eventHandler, null);
+                eventHandler, eventProcessor, null, null);
         /*
          * Scenario#1: when datafile is not Empty
          * Scenario#2: when datafile is Empty
@@ -209,8 +218,9 @@ public void initializeAsyncWithEnvironment() {
         Logger logger = mock(Logger.class);
         DatafileHandler datafileHandler = mock(DefaultDatafileHandler.class);
         EventHandler eventHandler = mock(DefaultEventHandler.class);
+        EventProcessor eventProcessor = mock(EventProcessor.class);
         final OptimizelyManager optimizelyManager = new OptimizelyManager(testProjectId, testSdkKey, null, logger, 3600L, datafileHandler, null, 3600L,
-                eventHandler, null);
+                eventHandler, eventProcessor, null, null);
 
         /*
          * Scenario#1: when datafile is not Empty

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyClient.java

@@ -24,13 +24,15 @@
 import com.optimizely.ab.UnknownEventTypeException;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.Variation;
+import com.optimizely.ab.event.EventHandler;
 import com.optimizely.ab.notification.DecisionNotification;
 import com.optimizely.ab.notification.NotificationCenter;
 import com.optimizely.ab.notification.NotificationHandler;
 import com.optimizely.ab.notification.TrackNotification;
 
 import org.slf4j.Logger;
 
+import java.io.Closeable;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -170,6 +172,16 @@ protected void setDefaultAttributes(@NonNull Map<String, ?> attrs) {
         }
     }
 
+    /**
+     * Checks if eventHandler {@link EventHandler}
+     * are Closeable {@link Closeable} and calls close on them.
+     *
+     * <b>NOTE:</b> There is a chance that this could be long running if the implementations of close are long running.
+     */
+    public void close() {
+        optimizely.close();
+    }
+
     /**
      * Check that this is a valid instance
      *

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyManager.java

@@ -43,6 +43,8 @@
 import com.optimizely.ab.config.parser.ConfigParseException;
 import com.optimizely.ab.error.ErrorHandler;
 import com.optimizely.ab.event.EventHandler;
+import com.optimizely.ab.event.EventProcessor;
+import com.optimizely.ab.event.ForwardingEventProcessor;
 import com.optimizely.ab.event.internal.payload.EventBatch;
 import com.optimizely.ab.notification.NotificationCenter;
 import com.optimizely.ab.notification.UpdateConfigNotification;
@@ -66,6 +68,8 @@ public class OptimizelyManager {
     private final long datafileDownloadInterval;
     private final long eventDispatchInterval;
     @Nullable private EventHandler eventHandler = null;
+    @Nullable private EventProcessor eventProcessor = null;
+    @Nullable private NotificationCenter notificationCenter = null;
     @Nullable private ErrorHandler errorHandler;
     @NonNull private Logger logger;
     @Nullable private final String projectId;
@@ -85,7 +89,9 @@ public class OptimizelyManager {
                       @Nullable ErrorHandler errorHandler,
                       long eventDispatchInterval,
                       @NonNull EventHandler eventHandler,
-                      @NonNull UserProfileService userProfileService) {
+                      @Nullable EventProcessor eventProcessor,
+                      @NonNull UserProfileService userProfileService,
+                      @NonNull NotificationCenter notificationCenter) {
 
         if (projectId == null && sdkKey == null) {
             logger.error("projectId and sdkKey are both null!");
@@ -103,8 +109,10 @@ public class OptimizelyManager {
         this.datafileHandler = datafileHandler;
         this.eventDispatchInterval = eventDispatchInterval;
         this.eventHandler = eventHandler;
+        this.eventProcessor = eventProcessor;
         this.errorHandler = errorHandler;
         this.userProfileService = userProfileService;
+        this.notificationCenter = notificationCenter;
     }
 
     @VisibleForTesting
@@ -501,6 +509,7 @@ private OptimizelyClient buildOptimizely(@NonNull Context context, @NonNull Stri
         Optimizely.Builder builder = Optimizely.builder();
 
         builder.withEventHandler(eventHandler);
+        builder.withEventProcessor(eventProcessor);
 
         if (datafileHandler instanceof DefaultDatafileHandler) {
             DefaultDatafileHandler handler = (DefaultDatafileHandler)datafileHandler;
@@ -519,7 +528,7 @@ private OptimizelyClient buildOptimizely(@NonNull Context context, @NonNull Stri
         }
 
         builder.withUserProfileService(userProfileService);
-
+        builder.withNotificationCenter(notificationCenter);
         Optimizely optimizely = builder.build();
         return new OptimizelyClient(optimizely, LoggerFactory.getLogger(OptimizelyClient.class));
     }
@@ -644,6 +653,8 @@ public static class Builder {
         @Nullable private Logger logger = null;
         @Nullable private EventHandler eventHandler = null;
         @Nullable private ErrorHandler errorHandler = null;
+        @Nullable private EventProcessor eventProcessor = null;
+        @Nullable private NotificationCenter notificationCenter = null;
         @Nullable private UserProfileService userProfileService = null;
         @Nullable private String sdkKey = null;
         @Nullable private DatafileConfig datafileConfig = null;
@@ -748,6 +759,16 @@ public Builder withDatafileConfig(DatafileConfig datafileConfig) {
             return this;
         }
 
+        public Builder withEventProcessor(EventProcessor eventProcessor) {
+            this.eventProcessor = eventProcessor;
+            return this;
+        }
+
+        public Builder withNotificationCenter(NotificationCenter notificationCenter) {
+            this.notificationCenter = notificationCenter;
+            return this;
+        }
+
         /**
          * Get a new {@link Builder} instance to create {@link OptimizelyManager} with.
          * @param  context the application context used to create default service if not provided.
@@ -791,6 +812,14 @@ public OptimizelyManager build(Context context) {
                 eventHandler = DefaultEventHandler.getInstance(context);
             }
 
+            if(notificationCenter == null) {
+                notificationCenter = new NotificationCenter();
+            }
+
+            if(eventProcessor == null) {
+                eventProcessor = new ForwardingEventProcessor(eventHandler, notificationCenter);
+            }
+
             if (projectId == null && sdkKey == null) {
                 logger.error("ProjectId and SDKKey cannot both be null");
                 return null;
@@ -804,7 +833,9 @@ public OptimizelyManager build(Context context) {
                     errorHandler,
                     eventDispatchInterval,
                     eventHandler,
-                    userProfileService);
+                    eventProcessor,
+                    userProfileService,
+                    notificationCenter);
         }
     }
 }

build.gradle

@@ -53,7 +53,7 @@ ext {
     build_tools_version = "28.0.3"
     min_sdk_version = 14
     target_sdk_version = 28
-    java_core_ver = "3.2.1"
+    java_core_ver = "3.3.1"
     android_logger_ver = "1.3.6"
     jacksonversion= "2.9.9.1"
     support_annotations_ver = "24.2.1"