Audience combinations (#225)

* create ConditionUtil for condition parsing and add audeince holder.

* add ability to parse audienceConditions.  Also, consolidate parseConditions to ConditionsUtil.

* fix the parsers to parse audienceConditions

* add audienceConditions parsed correctly in V4 datafile and empty in the rest

* start using audienceConditions

* user series of ors to test audienceConditions

* rename AudienceHolderCondition to AudienceIdCondition.

* add license headers

* remove extra parseConditions

* add tests for audienceCondition with AND

* refactor and move audience id condition resolver to ConditionsUtil

* added sanity checks, comments, and exceptions

* add exceptions before refactor

* use implicit or condition to evaluate

* refactor to pass in the project config when evaluating conditions.

* remove unused exception

* catch all exceptions just in case.

* slight refactor

* rename methods and cleanup javadoc

* update with last fixes

* refactor how audienceConditions is parsed

* allow for empty audienceConditions.  Check for index out of bounds in 'not' operand

* change so that empty Not condition returns null

* if conditions has no condition for not operator.  evaluates to null

* refactor out operand parse. rename audience combindations

* remove parsing of audienceConditions as string.

* add parsing checks for valid and invalid conditions for all parsers.  tweak convertObject to use value and attribute to ensure type safety.  Add generics for condition types holder

* rename convert to castToValueType

* add a couple of safeguards

* minor fixes from Logan's comments

Author: thomaszurkan-optimizely

core-api/src/main/java/com/optimizely/ab/config/Experiment.java

@@ -17,6 +17,8 @@
 package com.optimizely.ab.config;
 
 import com.fasterxml.jackson.annotation.*;
+import com.optimizely.ab.config.audience.AudienceIdCondition;
+import com.optimizely.ab.config.audience.Condition;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -41,6 +43,7 @@ public class Experiment implements IdKeyMapped {
     private final String groupId;
 
     private final List<String> audienceIds;
+    private final Condition<AudienceIdCondition> audienceConditions;
     private final List<Variation> variations;
     private final List<TrafficAllocation> trafficAllocation;
 
@@ -72,17 +75,19 @@ public Experiment(@JsonProperty("id") String id,
                       @JsonProperty("status") String status,
                       @JsonProperty("layerId") String layerId,
                       @JsonProperty("audienceIds") List<String> audienceIds,
+                      @JsonProperty("audienceConditions") Condition audienceConditions,
                       @JsonProperty("variations") List<Variation> variations,
                       @JsonProperty("forcedVariations") Map<String, String> userIdToVariationKeyMap,
                       @JsonProperty("trafficAllocation") List<TrafficAllocation> trafficAllocation) {
-        this(id, key, status, layerId, audienceIds, variations, userIdToVariationKeyMap, trafficAllocation, "");
+        this(id, key, status, layerId, audienceIds, audienceConditions, variations, userIdToVariationKeyMap, trafficAllocation, "");
     }
 
     public Experiment(@Nonnull String id,
                       @Nonnull String key,
                       @Nullable String status,
                       @Nullable String layerId,
                       @Nonnull List<String> audienceIds,
+                      @Nullable Condition audienceConditions,
                       @Nonnull List<Variation> variations,
                       @Nonnull Map<String, String> userIdToVariationKeyMap,
                       @Nonnull List<TrafficAllocation> trafficAllocation,
@@ -92,6 +97,7 @@ public Experiment(@Nonnull String id,
         this.status = status == null ? ExperimentStatus.NOT_STARTED.toString() : status;
         this.layerId = layerId;
         this.audienceIds = Collections.unmodifiableList(audienceIds);
+        this.audienceConditions = audienceConditions;
         this.variations = Collections.unmodifiableList(variations);
         this.trafficAllocation = Collections.unmodifiableList(trafficAllocation);
         this.groupId = groupId;
@@ -120,6 +126,10 @@ public List<String> getAudienceIds() {
         return audienceIds;
     }
 
+    public Condition getAudienceConditions() {
+        return audienceConditions;
+    }
+
     public List<Variation> getVariations() {
         return variations;
     }
@@ -165,6 +175,7 @@ public String toString() {
                 ", groupId='" + groupId + '\'' +
                 ", status='" + status + '\'' +
                 ", audienceIds=" + audienceIds +
+                ", audienceConditions=" + audienceConditions +
                 ", variations=" + variations +
                 ", variationKeyToVariationMap=" + variationKeyToVariationMap +
                 ", userIdToVariationKeyMap=" + userIdToVariationKeyMap +

core-api/src/main/java/com/optimizely/ab/config/Group.java

@@ -58,6 +58,7 @@ public Group(@JsonProperty("id") String id,
                     experiment.getStatus(),
                     experiment.getLayerId(),
                     experiment.getAudienceIds(),
+                    experiment.getAudienceConditions(),
                     experiment.getVariations(),
                     experiment.getUserIdToVariationKeyMap(),
                     experiment.getTrafficAllocation(),

core-api/src/main/java/com/optimizely/ab/config/ProjectConfig.java

@@ -20,7 +20,6 @@
 import com.optimizely.ab.UnknownEventTypeException;
 import com.optimizely.ab.UnknownExperimentException;
 import com.optimizely.ab.config.audience.Audience;
-import com.optimizely.ab.config.audience.Condition;
 import com.optimizely.ab.config.parser.ConfigParseException;
 import com.optimizely.ab.config.parser.DefaultConfigParser;
 import com.optimizely.ab.error.ErrorHandler;
@@ -408,11 +407,7 @@ public List<Audience> getTypedAudiences() {
         return typedAudiences;
     }
 
-    public Condition getAudienceConditionsFromId(String audienceId) {
-        Audience audience = audienceIdMapping.get(audienceId);
-
-        return audience != null ? audience.getConditions() : null;
-    }
+    public Audience getAudience(String audienceId) { return audienceIdMapping.get(audienceId); }
 
     public List<LiveVariable> getLiveVariables() {
         return liveVariables;

core-api/src/main/java/com/optimizely/ab/config/audience/AndCondition.java

@@ -16,6 +16,8 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.config.ProjectConfig;
+
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
@@ -25,8 +27,7 @@
 /**
  * Represents an 'And' conditions condition operation.
  */
-@Immutable
-public class AndCondition implements Condition {
+public class AndCondition<T> implements Condition<T> {
 
     private final List<Condition> conditions;
     public AndCondition(@Nonnull List<Condition> conditions) {
@@ -38,7 +39,8 @@ public List<Condition> getConditions() {
     }
 
     public @Nullable
-    Boolean evaluate(Map<String, ?> attributes) {
+    Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+        if (conditions == null) return null;
         boolean foundNull = false;
         // According to the matrix where:
         // false and true is false
@@ -48,7 +50,7 @@ Boolean evaluate(Map<String, ?> attributes) {
         // true and true is true
         // null and null is null
         for (Condition condition : conditions) {
-            Boolean conditionEval = condition.evaluate(attributes);
+            Boolean conditionEval = condition.evaluate(config, attributes);
             if (conditionEval == null) {
                 foundNull = true;
             }

core-api/src/main/java/com/optimizely/ab/config/audience/Audience.java

@@ -34,7 +34,7 @@ public class Audience implements IdKeyMapped {
 
     private final String id;
     private final String name;
-    private final Condition conditions;
+    private final Condition<UserAttribute> conditions;
 
     @JsonCreator
     public Audience(@JsonProperty("id") String id,

core-api/src/main/java/com/optimizely/ab/config/audience/AudienceIdCondition.java

@@ -0,0 +1,100 @@
+/**
+ *
+ *    Copyright 2018, Optimizely and contributors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+ package com.optimizely.ab.config.audience;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.optimizely.ab.config.ProjectConfig;
+import com.optimizely.ab.internal.InvalidAudienceCondition;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+import javax.annotation.concurrent.Immutable;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * The AudienceIdCondition is a holder for the audience id in
+ * {@link com.optimizely.ab.config.Experiment#audienceConditions auienceConditions}.
+ * If the audienceId is not resolved at evaluation time, the
+ * condition will fail.  AudienceIdConditions are resolved when the ProjectConfig is passed into evaluate.
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AudienceIdCondition<T> implements Condition<T> {
+    private Audience audience;
+    final private String audienceId;
+
+    final private static Logger logger = LoggerFactory.getLogger("AudienceIdCondition");
+
+    /**
+     * Constructor used in json parsing to store the audienceId parsed from Experiment.audienceConditions.
+     * @param audienceId
+     */
+    @JsonCreator
+    public AudienceIdCondition(String audienceId) {
+        this.audienceId = audienceId;
+    }
+
+    public Audience getAudience() {
+        return audience;
+    }
+
+    public void setAudience(Audience audience) {
+        this.audience = audience;
+    }
+
+    public String getAudienceId() {
+        return audienceId;
+    }
+
+    @Nullable
+    @Override
+    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+        if (config != null) {
+            audience = config.getAudienceIdMapping().get(audienceId);
+        }
+        if (audience == null) {
+            logger.error(String.format("Audience not set for audienceConditions %s", audienceId));
+            return null;
+        }
+        return audience.getConditions().evaluate(config, attributes);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AudienceIdCondition condition = (AudienceIdCondition) o;
+        return ((audience == null) ? (null == condition.audience) :
+                (audience.getId().equals(condition.audience!=null?condition.audience.getId():null))) &&
+                ((audienceId == null) ? (null == condition.audienceId) :
+                        (audienceId.equals(condition.audienceId)));
+    }
+
+    @Override
+    public int hashCode() {
+
+        return Objects.hash(audience, audienceId);
+    }
+
+    @Override
+    public String toString() {
+        return audienceId;
+    }
+}

core-api/src/main/java/com/optimizely/ab/config/audience/Condition.java

@@ -16,14 +16,16 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.config.ProjectConfig;
+
 import javax.annotation.Nullable;
 import java.util.Map;
 
 /**
  * Interface implemented by all conditions condition objects to aid in condition evaluation.
  */
-public interface Condition {
+public interface Condition<T> {
 
     @Nullable
-    Boolean evaluate(Map<String, ?> attributes);
+    Boolean evaluate(ProjectConfig config, Map<String, ?> attributes);
 }

core-api/src/main/java/com/optimizely/ab/config/audience/EmptyCondition.java

@@ -0,0 +1,15 @@
+package com.optimizely.ab.config.audience;
+
+import com.optimizely.ab.config.ProjectConfig;
+
+import javax.annotation.Nullable;
+import java.util.Map;
+
+public class EmptyCondition<T> implements Condition<T> {
+    @Nullable
+    @Override
+    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+        return true;
+    }
+
+}

core-api/src/main/java/com/optimizely/ab/config/audience/NotCondition.java

@@ -16,6 +16,8 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.config.ProjectConfig;
+
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 import javax.annotation.Nonnull;
@@ -26,7 +28,7 @@
  * Represents a 'Not' conditions condition operation.
  */
 @Immutable
-public class NotCondition implements Condition {
+public class NotCondition<T> implements Condition<T> {
 
     private final Condition condition;
 
@@ -38,8 +40,9 @@ public Condition getCondition() {
         return condition;
     }
 
-    public @Nullable Boolean evaluate(Map<String, ?> attributes) {
-        Boolean conditionEval = condition.evaluate(attributes);
+    public @Nullable Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+
+        Boolean conditionEval = condition == null ? null : condition.evaluate(config, attributes);
         return (conditionEval == null ? null : !conditionEval);
     }
 

core-api/src/main/java/com/optimizely/ab/config/audience/NullCondition.java

@@ -0,0 +1,14 @@
+package com.optimizely.ab.config.audience;
+
+import com.optimizely.ab.config.ProjectConfig;
+
+import javax.annotation.Nullable;
+import java.util.Map;
+
+public class NullCondition<T> implements Condition<T> {
+    @Nullable
+    @Override
+    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+        return null;
+    }
+}