feat: Add ODP Segments support in Audience Evaluation

.github/workflows/java.yml

@@ -45,7 +45,7 @@ jobs:
 
   test:
     if: startsWith(github.ref, 'refs/tags/') != true
-    runs-on: ubuntu-18.04
+    runs-on: macos-latest
     strategy:
       fail-fast: false
       matrix:

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,19 +46,14 @@ 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, null);
     }
 
     public OptimizelyUserContext(@Nonnull Optimizely optimizely,
                                  @Nonnull String userId,
                                  @Nonnull Map<String, ?> attributes,
-                                 @Nullable Map<String, OptimizelyForcedDecision> forcedDecisionsMap) {
+                                 @Nullable Map<String, OptimizelyForcedDecision> forcedDecisionsMap,
+                                 @Nullable List<String> qualifiedSegments) {
         this.optimizely = optimizely;
         this.userId = userId;
         if (attributes != null) {
@@ -65,8 +62,10 @@ public OptimizelyUserContext(@Nonnull Optimizely optimizely,
             this.attributes = Collections.synchronizedMap(new HashMap<>());
         }
         if (forcedDecisionsMap != null) {
-          this.forcedDecisionsMap = new ConcurrentHashMap<>(forcedDecisionsMap);
+            this.forcedDecisionsMap = new ConcurrentHashMap<>(forcedDecisionsMap);
         }
+
+        this.qualifiedSegments = Collections.synchronizedList( qualifiedSegments == null ? new LinkedList<>(): qualifiedSegments);
     }
 
     public OptimizelyUserContext(@Nonnull Optimizely optimizely, @Nonnull String userId) {
@@ -86,7 +85,16 @@ public Optimizely getOptimizely() {
     }
 
     public OptimizelyUserContext copy() {
-        return new OptimizelyUserContext(optimizely, userId, attributes, forcedDecisionsMap);
+        return new OptimizelyUserContext(optimizely, userId, attributes, forcedDecisionsMap, qualifiedSegments);
+    }
+
+    /**
+     * Returns true if the user is qualified for the given segment name
+     * @param segment A String segment key which will be checked in the qualified segments list that if it exists then user is qualified.
+     * @return boolean Is user qualified for a segment.
+     */
+    public boolean isQualifiedFor(@Nonnull String segment) {
+        return qualifiedSegments.contains(segment);
     }
 
     /**
@@ -265,7 +273,14 @@ public boolean removeAllForcedDecisions() {
         return true;
     }
 
+    public List<String> getQualifiedSegments() {
+        return qualifiedSegments;
+    }
 
+    public void setQualifiedSegments(List<String> qualifiedSegments) {
+        this.qualifiedSegments.clear();
+        this.qualifiedSegments.addAll(qualifiedSegments);
+    }
 
     // Utils
 

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/DatafileProjectConfig.java

@@ -63,6 +63,8 @@ public class DatafileProjectConfig implements ProjectConfig {
     private final boolean anonymizeIP;
     private final boolean sendFlagDecisions;
     private final Boolean botFiltering;
+    private final String hostForODP;
+    private final String publicKeyForODP;
     private final List<Attribute> attributes;
     private final List<Audience> audiences;
     private final List<Audience> typedAudiences;
@@ -71,6 +73,7 @@ public class DatafileProjectConfig implements ProjectConfig {
     private final List<FeatureFlag> featureFlags;
     private final List<Group> groups;
     private final List<Rollout> rollouts;
+    private final List<Integration> integrations;
 
     // key to entity mappings
     private final Map<String, Attribute> attributeKeyMapping;
@@ -121,6 +124,7 @@ public DatafileProjectConfig(String accountId, String projectId, String version,
             experiments,
             null,
             groups,
+            null,
             null
         );
     }
@@ -142,8 +146,8 @@ public DatafileProjectConfig(String accountId,
                                  List<Experiment> experiments,
                                  List<FeatureFlag> featureFlags,
                                  List<Group> groups,
-                                 List<Rollout> rollouts) {
-
+                                 List<Rollout> rollouts,
+                                 List<Integration> integrations) {
         this.accountId = accountId;
         this.projectId = projectId;
         this.version = version;
@@ -182,6 +186,24 @@ public DatafileProjectConfig(String accountId,
         allExperiments.addAll(aggregateGroupExperiments(groups));
         this.experiments = Collections.unmodifiableList(allExperiments);
 
+        String publicKeyForODP = "";
+        String hostForODP = "";
+        if (integrations == null) {
+            this.integrations = Collections.emptyList();
+        } else {
+            this.integrations = Collections.unmodifiableList(integrations);
+            for (Integration integration: this.integrations) {
+                if (integration.getKey().equals("odp")) {
+                    hostForODP = integration.getHost();
+                    publicKeyForODP = integration.getPublicKey();
+                    break;
+                }
+            }
+        }
+
+        this.publicKeyForODP = publicKeyForODP;
+        this.hostForODP = hostForODP;
+
         Map<String, Experiment> variationIdToExperimentMap = new HashMap<String, Experiment>();
         for (Experiment experiment : this.experiments) {
             for (Variation variation : experiment.getVariations()) {
@@ -448,6 +470,11 @@ public List<Audience> getTypedAudiences() {
         return typedAudiences;
     }
 
+    @Override
+    public List<Integration> getIntegrations() {
+        return integrations;
+    }
+
     @Override
     public Audience getAudience(String audienceId) {
         return audienceIdMapping.get(audienceId);
@@ -524,6 +551,16 @@ public Variation getFlagVariationByKey(String flagKey, String variationKey) {
         return null;
     }
 
+    @Override
+    public String getHostForODP() {
+        return hostForODP;
+    }
+
+    @Override
+    public String getPublicKeyForODP() {
+        return publicKeyForODP;
+    }
+
     @Override
     public String toString() {
         return "ProjectConfig{" +

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

@@ -0,0 +1,67 @@
+/**
+ *
+ *    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;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.annotation.concurrent.Immutable;
+
+/**
+ * Represents the Optimizely Integration configuration.
+ *
+ * @see <a href="http://developers.optimizely.com/server/reference/index.html#json">Project JSON</a>
+ */
+@Immutable
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class Integration {
+    private final String key;
+    private final String host;
+    private final String publicKey;
+
+    @JsonCreator
+    public Integration(@JsonProperty("key") String key,
+                       @JsonProperty("host") String host,
+                       @JsonProperty("publicKey") String publicKey) {
+        this.key = key;
+        this.host = host;
+        this.publicKey = publicKey;
+    }
+
+    @Nonnull
+    public String getKey() {
+        return key;
+    }
+
+    @Nullable
+    public String getHost() { return host; }
+
+    @Nullable
+    public String getPublicKey() { return publicKey; }
+
+    @Override
+    public String toString() {
+        return "Integration{" +
+            "key='" + key + '\'' +
+            ((this.host != null) ? (", host='" + host + '\'') : "") +
+            ((this.publicKey != null) ? (", publicKey='" + publicKey + '\'') : "") +
+            '}';
+    }
+}

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

@@ -83,6 +83,8 @@ Experiment getExperimentForKey(@Nonnull String experimentKey,
 
     List<Audience> getTypedAudiences();
 
+    List<Integration> getIntegrations();
+
     Audience getAudience(String audienceId);
 
     Map<String, Experiment> getExperimentKeyMapping();
@@ -107,6 +109,10 @@ Experiment getExperimentForKey(@Nonnull String experimentKey,
 
     Variation getFlagVariationByKey(String flagKey, String variationKey);
 
+    String getHostForODP();
+
+    String getPublicKeyForODP();
+
     @Override
     String toString();
 

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;
     }