fix: update method parameters in Optimizely.java and Bucketer.java to use ExperimentCore instead of Experiment. Fix ActivateNotification, ExperimentUtils, ActivateNotificationListener, NotificationCenterTest to reflect these changes.

Author: muzahidul-opti

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

@@ -24,6 +24,7 @@
 import com.optimizely.ab.config.DatafileProjectConfig;
 import com.optimizely.ab.config.EventType;
 import com.optimizely.ab.config.Experiment;
+import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.FeatureFlag;
 import com.optimizely.ab.config.FeatureVariable;
 import com.optimizely.ab.config.FeatureVariableUsageInstance;
@@ -319,7 +320,7 @@ private void sendImpression(@Nonnull ProjectConfig projectConfig,
      * @param ruleType           It can either be experiment in case impression event is sent from activate or it's feature-test or rollout
      */
     private boolean sendImpression(@Nonnull ProjectConfig projectConfig,
-                                   @Nullable Experiment experiment,
+                                   @Nullable ExperimentCore experiment,
                                    @Nonnull String userId,
                                    @Nonnull Map<String, ?> filteredAttributes,
                                    @Nullable Variation variation,

core-api/src/main/java/com/optimizely/ab/bucketing/Bucketer.java

@@ -16,18 +16,25 @@
  */
 package com.optimizely.ab.bucketing;
 
+import java.util.List;
+
+import javax.annotation.Nonnull;
+import javax.annotation.concurrent.Immutable;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import com.optimizely.ab.annotations.VisibleForTesting;
 import com.optimizely.ab.bucketing.internal.MurmurHash3;
-import com.optimizely.ab.config.*;
+import com.optimizely.ab.config.Experiment;
+import com.optimizely.ab.config.ExperimentCore;
+import com.optimizely.ab.config.Group;
+import com.optimizely.ab.config.ProjectConfig;
+import com.optimizely.ab.config.TrafficAllocation;
+import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.optimizelydecision.DecisionReasons;
 import com.optimizely.ab.optimizelydecision.DecisionResponse;
 import com.optimizely.ab.optimizelydecision.DefaultDecisionReasons;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import javax.annotation.Nonnull;
-import javax.annotation.concurrent.Immutable;
-import java.util.List;
 
 /**
  * Default Optimizely bucketing algorithm that evenly distributes users using the Murmur3 hash of some provided
@@ -89,7 +96,7 @@ private Experiment bucketToExperiment(@Nonnull Group group,
     }
 
     @Nonnull
-    private DecisionResponse<Variation> bucketToVariation(@Nonnull Experiment experiment,
+    private DecisionResponse<Variation> bucketToVariation(@Nonnull ExperimentCore experiment,
                                                           @Nonnull String bucketingId) {
         DecisionReasons reasons = DefaultDecisionReasons.newInstance();
 
@@ -130,7 +137,7 @@ private DecisionResponse<Variation> bucketToVariation(@Nonnull Experiment experi
      * @return A {@link DecisionResponse} including the {@link Variation} that user is bucketed into (or null) and the decision reasons
      */
     @Nonnull
-    public DecisionResponse<Variation> bucket(@Nonnull Experiment experiment,
+    public DecisionResponse<Variation> bucket(@Nonnull ExperimentCore experiment,
                                               @Nonnull String bucketingId,
                                               @Nonnull ProjectConfig projectConfig) {
         DecisionReasons reasons = DefaultDecisionReasons.newInstance();

core-api/src/main/java/com/optimizely/ab/bucketing/FeatureDecision.java

@@ -15,17 +15,18 @@
  ***************************************************************************/
 package com.optimizely.ab.bucketing;
 
+import javax.annotation.Nullable;
+
 import com.optimizely.ab.config.Experiment;
+import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.Variation;
 
-import javax.annotation.Nullable;
-
 public class FeatureDecision {
     /**
      * The {@link Experiment} the Feature is associated with.
      */
     @Nullable
-    public Experiment experiment;
+    public ExperimentCore experiment;
 
     /**
      * The {@link Variation} the user was bucketed into.
@@ -41,7 +42,8 @@ public class FeatureDecision {
 
     public enum DecisionSource {
         FEATURE_TEST("feature-test"),
-        ROLLOUT("rollout");
+        ROLLOUT("rollout"),
+        HOLDOUT("holdout");
 
         private final String key;
 
@@ -62,7 +64,7 @@ public String toString() {
      * @param variation      The {@link Variation} the user was bucketed into.
      * @param decisionSource The source of the variation.
      */
-    public FeatureDecision(@Nullable Experiment experiment, @Nullable Variation variation,
+    public FeatureDecision(@Nullable ExperimentCore experiment, @Nullable Variation variation,
                            @Nullable DecisionSource decisionSource) {
         this.experiment = experiment;
         this.variation = variation;

core-api/src/main/java/com/optimizely/ab/event/internal/UserEventFactory.java

@@ -16,23 +16,26 @@
  */
 package com.optimizely.ab.event.internal;
 
+import java.util.Map;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import com.optimizely.ab.bucketing.FeatureDecision;
-import com.optimizely.ab.config.Experiment;
+import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.internal.payload.DecisionMetadata;
 import com.optimizely.ab.internal.EventTagUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import java.util.Map;
 
 public class UserEventFactory {
     private static final Logger logger = LoggerFactory.getLogger(UserEventFactory.class);
 
     public static ImpressionEvent createImpressionEvent(@Nonnull ProjectConfig projectConfig,
-                                                        @Nullable Experiment activatedExperiment,
+                                                        @Nullable ExperimentCore activatedExperiment,
                                                         @Nullable Variation variation,
                                                         @Nonnull String userId,
                                                         @Nonnull Map<String, ?> attributes,

core-api/src/main/java/com/optimizely/ab/internal/ExperimentUtils.java

@@ -16,22 +16,24 @@
  */
 package com.optimizely.ab.internal;
 
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.annotation.Nonnull;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.Experiment;
+import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.audience.AudienceIdCondition;
 import com.optimizely.ab.config.audience.Condition;
 import com.optimizely.ab.config.audience.OrCondition;
 import com.optimizely.ab.optimizelydecision.DecisionReasons;
 import com.optimizely.ab.optimizelydecision.DecisionResponse;
 import com.optimizely.ab.optimizelydecision.DefaultDecisionReasons;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import javax.annotation.Nonnull;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
 
 public final class ExperimentUtils {
 
@@ -62,7 +64,7 @@ public static boolean isExperimentActive(@Nonnull Experiment experiment) {
      */
     @Nonnull
     public static DecisionResponse<Boolean> doesUserMeetAudienceConditions(@Nonnull ProjectConfig projectConfig,
-                                                                           @Nonnull Experiment experiment,
+                                                                           @Nonnull ExperimentCore experiment,
                                                                            @Nonnull OptimizelyUserContext user,
                                                                            @Nonnull String loggingEntityType,
                                                                            @Nonnull String loggingKey) {
@@ -86,7 +88,7 @@ public static DecisionResponse<Boolean> doesUserMeetAudienceConditions(@Nonnull
 
     @Nonnull
     public static DecisionResponse<Boolean> evaluateAudience(@Nonnull ProjectConfig projectConfig,
-                                                             @Nonnull Experiment experiment,
+                                                             @Nonnull ExperimentCore experiment,
                                                              @Nonnull OptimizelyUserContext user,
                                                              @Nonnull String loggingEntityType,
                                                              @Nonnull String loggingKey) {
@@ -118,7 +120,7 @@ public static DecisionResponse<Boolean> evaluateAudience(@Nonnull ProjectConfig
 
     @Nonnull
     public static DecisionResponse<Boolean> evaluateAudienceConditions(@Nonnull ProjectConfig projectConfig,
-                                                                       @Nonnull Experiment experiment,
+                                                                       @Nonnull ExperimentCore experiment,
                                                                        @Nonnull OptimizelyUserContext user,
                                                                        @Nonnull String loggingEntityType,
                                                                        @Nonnull String loggingKey) {

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

@@ -16,13 +16,13 @@
  */
 package com.optimizely.ab.notification;
 
+import java.util.Map;
+
 import com.optimizely.ab.annotations.VisibleForTesting;
-import com.optimizely.ab.config.Experiment;
+import com.optimizely.ab.config.ExperimentCore;
 import com.optimizely.ab.config.Variation;
 import com.optimizely.ab.event.LogEvent;
 
-import java.util.Map;
-
 /**
  * ActivateNotification supplies notification for AB activatation.
  *
@@ -32,7 +32,7 @@
 @Deprecated
 public final class ActivateNotification {
 
-    private final Experiment experiment;
+    private final ExperimentCore 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(Experiment experiment, String userId, Map<String, ?> attributes, Variation variation, LogEvent event) {
+    public ActivateNotification(ExperimentCore 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 Experiment getExperiment() {
+    public ExperimentCore getExperiment() {
         return experiment;
     }
 

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

@@ -17,13 +17,15 @@
 
 package com.optimizely.ab.notification;
 
+import java.util.Map;
+
+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;
 
-import javax.annotation.Nonnull;
-import java.util.Map;
-
 /**
  * ActivateNotificationListener handles the activate event notification.
  *
@@ -80,7 +82,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 Experiment experiment,
+    public abstract void onActivate(@Nonnull ExperimentCore experiment,
                                     @Nonnull String userId,
                                     @Nonnull Map<String, ?> attributes,
                                     @Nonnull Variation variation,

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

@@ -16,12 +16,13 @@
  */
 package com.optimizely.ab.notification;
 
-import com.optimizely.ab.config.Experiment;
-import com.optimizely.ab.config.Variation;
-import com.optimizely.ab.event.LogEvent;
+import java.util.Map;
 
 import javax.annotation.Nonnull;
-import java.util.Map;
+
+import com.optimizely.ab.config.ExperimentCore;
+import com.optimizely.ab.config.Variation;
+import com.optimizely.ab.event.LogEvent;
 
 /**
  * ActivateNotificationListenerInterface provides and interface for activate event notification.
@@ -40,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 Experiment experiment,
+    public void onActivate(@Nonnull ExperimentCore experiment,
                            @Nonnull String userId,
                            @Nonnull Map<String, ?> attributes,
                            @Nonnull Variation variation,

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

@@ -16,19 +16,21 @@
  */
 package com.optimizely.ab.notification;
 
-import com.optimizely.ab.config.Experiment;
-import com.optimizely.ab.config.Variation;
-import com.optimizely.ab.event.LogEvent;
-import org.junit.Before;
-import org.junit.Test;
-
-import javax.annotation.Nonnull;
 import java.util.Collections;
 import java.util.Map;
 
-import static org.junit.Assert.*;
+import javax.annotation.Nonnull;
+
+import static org.junit.Assert.assertEquals;
+import org.junit.Before;
+import org.junit.Test;
 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;
+
 public class ActivateNotificationListenerTest {
 
     private static final Experiment EXPERIMENT = mock(Experiment.class);
@@ -64,7 +66,7 @@ public void testNotifyWithActivateNotificationArg() {
     private static class ActivateNotificationHandler extends ActivateNotificationListener {
 
         @Override
-        public void onActivate(@Nonnull Experiment experiment, @Nonnull String userId, @Nonnull Map<String, ?> attributes, @Nonnull Variation variation, @Nonnull LogEvent event) {
+        public void onActivate(@Nonnull ExperimentCore 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);