feat(core-api): deprecate ExperimentCore and replace with Experiment in ActivateNotification

Author: muzahidul-opti

core-api/src/main/java/com/optimizely/ab/Optimizely.java

@@ -345,13 +345,17 @@ private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
         if (experiment != null) {
             logger.info("Activating user \"{}\" in experiment \"{}\".", userId, experiment.getKey());
         }
+
+        // Legacy API methods only apply to the Experiment type and not to Holdout.
+        boolean isExperimentType = experiment instanceof Experiment;
+        
         // Kept For backwards compatibility.
         // This notification is deprecated and the new DecisionNotifications
         // are sent via their respective method calls.
-        if (notificationCenter.getNotificationManager(ActivateNotification.class).size() > 0) {
+        if (notificationCenter.getNotificationManager(ActivateNotification.class).size() > 0 && isExperimentType) {
             LogEvent impressionEvent = EventFactory.createLogEvent(userEvent);
             ActivateNotification activateNotification = new ActivateNotification(
-                experiment, userId, filteredAttributes, variation, impressionEvent);
+                (Experiment)experiment, userId, filteredAttributes, variation, impressionEvent);
             notificationCenter.send(activateNotification);
         }
         return true;

core-api/src/main/java/com/optimizely/ab/notification/ActivateNotification.java

@@ -19,7 +19,7 @@
 import java.util.Map;
 
 import com.optimizely.ab.annotations.VisibleForTesting;
-import com.optimizely.ab.config.ExperimentCore;
+import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
 
@@ -32,7 +32,7 @@
 @Deprecated
 public final class ActivateNotification {
 
-    private final ExperimentCore experiment;
+    private final Experiment experiment;
     private final String userId;
     private final Map<String, ?> attributes;
     private final Variation variation;
@@ -50,15 +50,15 @@ public final class ActivateNotification {
      * @param variation  - The variation that was returned from activate.
      * @param event      - The impression event that was triggered.
      */
-    public ActivateNotification(ExperimentCore experiment, String userId, Map<String, ?> attributes, Variation variation, LogEvent event) {
+    public ActivateNotification(Experiment experiment, String userId, Map<String, ?> attributes, Variation variation, LogEvent event) {
         this.experiment = experiment;
         this.userId = userId;
         this.attributes = attributes;
         this.variation = variation;
         this.event = event;
     }
 
-    public ExperimentCore getExperiment() {
+    public Experiment getExperiment() {
         return experiment;
     }
 

core-api/src/main/java/com/optimizely/ab/notification/ActivateNotificationListener.java

@@ -22,7 +22,6 @@
 import javax.annotation.Nonnull;
 
 import com.optimizely.ab.config.Experiment;
-import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
 
@@ -82,7 +81,7 @@ public final void handle(ActivateNotification message) {
      * @param variation  - The variation that was returned from activate.
      * @param event      - The impression event that was triggered.
      */
-    public abstract void onActivate(@Nonnull ExperimentCore experiment,
+    public abstract void onActivate(@Nonnull Experiment experiment,
                                     @Nonnull String userId,
                                     @Nonnull Map<String, ?> attributes,
                                     @Nonnull Variation variation,

core-api/src/main/java/com/optimizely/ab/notification/ActivateNotificationListenerInterface.java

@@ -20,7 +20,7 @@
 
 import javax.annotation.Nonnull;
 
-import com.optimizely.ab.config.ExperimentCore;
+import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
 
@@ -41,7 +41,7 @@ public interface ActivateNotificationListenerInterface {
      * @param variation  - The variation that was returned from activate.
      * @param event      - The impression event that was triggered.
      */
-    public void onActivate(@Nonnull ExperimentCore experiment,
+    public void onActivate(@Nonnull Experiment experiment,
                            @Nonnull String userId,
                            @Nonnull Map<String, ?> attributes,
                            @Nonnull Variation variation,

core-api/src/test/java/com/optimizely/ab/notification/ActivateNotificationListenerTest.java

@@ -27,7 +27,6 @@
 import static org.mockito.Mockito.mock;
 
 import com.optimizely.ab.config.Experiment;
-import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
 
@@ -66,7 +65,7 @@ public void testNotifyWithActivateNotificationArg() {
     private static class ActivateNotificationHandler extends ActivateNotificationListener {
 
         @Override
-        public void onActivate(@Nonnull ExperimentCore experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
+        public void onActivate(@Nonnull Experiment experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
             assertEquals(EXPERIMENT, experiment);
             assertEquals(USER_ID, userId);
             assertEquals(USER_ATTRIBUTES, attributes);

core-api/src/test/java/com/optimizely/ab/notification/NotificationCenterTest.java

@@ -32,7 +32,7 @@
 import static org.mockito.Mockito.mock;
 
 import com.optimizely.ab.OptimizelyRuntimeException;
-import com.optimizely.ab.config.ExperimentCore;
+import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
 import com.optimizely.ab.internal.LogbackVerifier;
@@ -94,7 +94,7 @@ public void testAddDecisionNotificationTwice() {
     public void testAddActivateNotificationTwice() {
         ActivateNotificationListener listener = new ActivateNotificationListener() {
             @Override
-            public void onActivate(@Nonnull ExperimentCore experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
+            public void onActivate(@Nonnull Experiment experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
 
             }
         };
@@ -109,7 +109,7 @@ public void onActivate(@Nonnull ExperimentCore experiment, @Nonnull String userI
     public void testAddActivateNotification() {
         int notificationId = notificationCenter.addActivateNotificationListener(new ActivateNotificationListener() {
             @Override
-            public void onActivate(@Nonnull ExperimentCore experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
+            public void onActivate(@Nonnull Experiment experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
 
             }
         });