feat: Add ODP Segments support in Audience Evaluation

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

@@ -36,6 +36,8 @@ public class OptimizelyUserContext {
     @Nonnull
     private final Map<String, Object> attributes;
 
+    private List<String> qualifiedSegments;
+
     @Nonnull
     private final Optimizely optimizely;
 
@@ -44,13 +46,7 @@ public class OptimizelyUserContext {
     public OptimizelyUserContext(@Nonnull Optimizely optimizely,
                                  @Nonnull String userId,
                                  @Nonnull Map<String, ?> attributes) {
-        this.optimizely = optimizely;
-        this.userId = userId;
-        if (attributes != null) {
-            this.attributes = Collections.synchronizedMap(new HashMap<>(attributes));
-        } else {
-            this.attributes = Collections.synchronizedMap(new HashMap<>());
-        }
+        this(optimizely, userId, attributes, Collections.EMPTY_MAP);
     }
 
     public OptimizelyUserContext(@Nonnull Optimizely optimizely,
@@ -67,6 +63,7 @@ public OptimizelyUserContext(@Nonnull Optimizely optimizely,
         if (forcedDecisionsMap != null) {
           this.forcedDecisionsMap = new ConcurrentHashMap<>(forcedDecisionsMap);
         }
+        this.qualifiedSegments = Collections.synchronizedList(new LinkedList<>());
     }
 
     public OptimizelyUserContext(@Nonnull Optimizely optimizely, @Nonnull String userId) {
@@ -89,6 +86,15 @@ public OptimizelyUserContext copy() {
         return new OptimizelyUserContext(optimizely, userId, attributes, forcedDecisionsMap);
     }
 
+    /**
+     * Returns true if the user is qualified for the given segment name
+     * @param segment A String segment key which will be check in qualified segments list that if it exist then user is qualified.
+     * @return boolean Is user qualified for a segment.
+     */
+    public boolean isQualifiedFor(@Nonnull String segment) {
+        return qualifiedSegments.contains(segment);
+    }
+
     /**
      * Set an attribute for a given key.
      *

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

@@ -152,7 +152,7 @@ public DecisionResponse<Variation> getVariation(@Nonnull Experiment experiment,
             }
         }
 
-        DecisionResponse<Boolean> decisionMeetAudience = ExperimentUtils.doesUserMeetAudienceConditions(projectConfig, experiment, user.getAttributes(), EXPERIMENT, experiment.getKey());
+        DecisionResponse<Boolean> decisionMeetAudience = ExperimentUtils.doesUserMeetAudienceConditions(projectConfig, experiment, user, EXPERIMENT, experiment.getKey());
         reasons.merge(decisionMeetAudience.getReasons());
         if (decisionMeetAudience.getResult()) {
             String bucketingId = getBucketingId(user.getUserId(), user.getAttributes());
@@ -693,7 +693,7 @@ DecisionResponse<AbstractMap.SimpleEntry> getVariationFromDeliveryRule(@Nonnull
         DecisionResponse<Boolean> audienceDecisionResponse = ExperimentUtils.doesUserMeetAudienceConditions(
             projectConfig,
             rule,
-            user.getAttributes(),
+            user,
             RULE,
             String.valueOf(ruleIndex + 1)
         );

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2019, Optimizely and contributors
+ *    Copyright 2016-2019, 2022, 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.
@@ -16,6 +16,7 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 
 import javax.annotation.Nonnull;
@@ -42,7 +43,7 @@ public List<Condition> getConditions() {
     }
 
     @Nullable
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
         if (conditions == null) return null;
         boolean foundNull = false;
         // According to the matrix where:
@@ -53,7 +54,7 @@ public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
         // true and true is true
         // null and null is null
         for (Condition condition : conditions) {
-            Boolean conditionEval = condition.evaluate(config, attributes);
+            Boolean conditionEval = condition.evaluate(config, user);
             if (conditionEval == null) {
                 foundNull = true;
             } else if (!conditionEval) { // false with nulls or trues is false.

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

@@ -0,0 +1,33 @@
+/**
+ *
+ *    Copyright 2022, 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;
+
+public enum AttributeType {
+    CUSTOM_ATTRIBUTE("custom_attribute"),
+    THIRD_PARTY_DIMENSION("third_party_dimension");
+
+    private final String key;
+
+    AttributeType(String key) {
+        this.key = key;
+    }
+
+    @Override
+    public String toString() {
+        return key;
+    }
+}

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

@@ -1,12 +1,12 @@
 /**
  *
- *    Copyright 2018-2021, Optimizely and contributors
+ *    Copyright 2018-2022, 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
+ *        https://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,
@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.internal.InvalidAudienceCondition;
 import org.slf4j.Logger;
@@ -71,7 +72,7 @@ public String getOperandOrId() {
 
     @Nullable
     @Override
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
         if (config != null) {
             audience = config.getAudienceIdMapping().get(audienceId);
         }
@@ -80,7 +81,7 @@ public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
             return null;
         }
         logger.debug("Starting to evaluate audience \"{}\" with conditions: {}.", audience.getId(), audience.getConditions());
-        Boolean result = audience.getConditions().evaluate(config, attributes);
+        Boolean result = audience.getConditions().evaluate(config, user);
         logger.debug("Audience \"{}\" evaluated to {}.", audience.getId(), result);
         return result;
     }

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2018, Optimizely and contributors
+ *    Copyright 2016-2018, 2022, 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.
@@ -16,6 +16,7 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 
 import javax.annotation.Nullable;
@@ -27,7 +28,7 @@
 public interface Condition<T> {
 
     @Nullable
-    Boolean evaluate(ProjectConfig config, Map<String, ?> attributes);
+    Boolean evaluate(ProjectConfig config, OptimizelyUserContext user);
 
     String toJson();
 

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2019, Optimizely Inc. and contributors
+ *    Copyright 2019, 2022, Optimizely Inc. and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 
 import javax.annotation.Nullable;
@@ -23,7 +24,7 @@
 public class EmptyCondition<T> implements Condition<T> {
     @Nullable
     @Override
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
         return true;
     }
 

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2019, Optimizely and contributors
+ *    Copyright 2016-2019, 2022, 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.
@@ -16,14 +16,13 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 import javax.annotation.Nonnull;
 
-import java.util.Map;
-import java.util.StringJoiner;
 
 /**
  * Represents a 'Not' conditions condition operation.
@@ -43,9 +42,8 @@ public Condition getCondition() {
     }
 
     @Nullable
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
-
-        Boolean conditionEval = condition == null ? null : condition.evaluate(config, attributes);
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
+        Boolean conditionEval = condition == null ? null : condition.evaluate(config, user);
         return (conditionEval == null ? null : !conditionEval);
     }
 

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2019, Optimizely Inc. and contributors
+ *    Copyright 2019, 2022, Optimizely Inc. and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 
 import javax.annotation.Nullable;
@@ -23,7 +24,7 @@
 public class NullCondition<T> implements Condition<T> {
     @Nullable
     @Override
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
         return null;
     }
 

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2019, Optimizely and contributors
+ *    Copyright 2016-2019, 2022, 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.
@@ -16,6 +16,7 @@
  */
 package com.optimizely.ab.config.audience;
 
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 
 import javax.annotation.Nonnull;
@@ -47,11 +48,11 @@ public List<Condition> getConditions() {
     // false or false is false
     // null or null is null
     @Nullable
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
         if (conditions == null) return null;
         boolean foundNull = false;
         for (Condition condition : conditions) {
-            Boolean conditionEval = condition.evaluate(config, attributes);
+            Boolean conditionEval = condition.evaluate(config, user);
             if (conditionEval == null) { // true with falses and nulls is still true
                 foundNull = true;
             } else if (conditionEval) {

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2020, Optimizely and contributors
+ *    Copyright 2016-2020, 2022, 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.
@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.optimizely.ab.OptimizelyUserContext;
 import com.optimizely.ab.config.ProjectConfig;
 import com.optimizely.ab.config.audience.match.*;
 import org.slf4j.Logger;
@@ -27,8 +28,11 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
-import java.util.Collections;
-import java.util.Map;
+import java.util.*;
+
+import static com.optimizely.ab.config.audience.AttributeType.CUSTOM_ATTRIBUTE;
+import static com.optimizely.ab.config.audience.AttributeType.THIRD_PARTY_DIMENSION;
+import static com.optimizely.ab.config.audience.match.MatchRegistry.QUALIFIED;
 
 /**
  * Represents a user attribute instance within an audience's conditions.
@@ -42,7 +46,7 @@ public class UserAttribute<T> implements Condition<T> {
     private final String type;
     private final String match;
     private final Object value;
-
+    private final static List ATTRIBUTE_TYPE = Arrays.asList(new String[]{CUSTOM_ATTRIBUTE.toString(), THIRD_PARTY_DIMENSION.toString()});
     @JsonCreator
     public UserAttribute(@JsonProperty("name") @Nonnull String name,
                          @JsonProperty("type") @Nonnull String type,
@@ -71,19 +75,26 @@ public Object getValue() {
     }
 
     @Nullable
-    public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
-        if (attributes == null) {
-            attributes = Collections.emptyMap();
-        }
+    public Boolean evaluate(ProjectConfig config, OptimizelyUserContext user) {
+        Map<String,Object> attributes = user.getAttributes();
         // Valid for primitive types, but needs to change when a value is an object or an array
         Object userAttributeValue = attributes.get(name);
 
-        if (!"custom_attribute".equals(type)) {
+        if (!isValidType(type)) {
             logger.warn("Audience condition \"{}\" uses an unknown condition type. You may need to upgrade to a newer release of the Optimizely SDK.", this);
             return null; // unknown type
         }
         // check user attribute value is equal
         try {
+            // Handle qualified segments
+            if (QUALIFIED.equals(match)) {
+                if (value instanceof String) {
+                    return user.isQualifiedFor(value.toString());
+                } else {
+                    throw new UnknownValueTypeException();
+                }
+            }
+            // Handle other conditions
             Match matcher = MatchRegistry.getMatch(match);
             Boolean result = matcher.eval(value, userAttributeValue);
             if (result == null) {
@@ -118,6 +129,13 @@ public Boolean evaluate(ProjectConfig config, Map<String, ?> attributes) {
         return null;
     }
 
+    private boolean isValidType(String type) {
+        if (ATTRIBUTE_TYPE.contains(type)) {
+            return true;
+        }
+        return false;
+    }
+
     @Override
     public String getOperandOrId() {
         return null;