feat: Integrated ODPManager with UserContext and Optimizely client

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

@@ -28,6 +28,7 @@
 import com.optimizely.ab.event.internal.*;
 import com.optimizely.ab.event.internal.payload.EventBatch;
 import com.optimizely.ab.notification.*;
+import com.optimizely.ab.odp.*;
 import com.optimizely.ab.optimizelyconfig.OptimizelyConfig;
 import com.optimizely.ab.optimizelyconfig.OptimizelyConfigManager;
 import com.optimizely.ab.optimizelyconfig.OptimizelyConfigService;
@@ -96,6 +97,9 @@ public class Optimizely implements AutoCloseable {
     @Nullable
     private final UserProfileService userProfileService;
 
+    @Nullable
+    private final ODPManager odpManager;
+
     private Optimizely(@Nonnull EventHandler eventHandler,
                        @Nonnull EventProcessor eventProcessor,
                        @Nonnull ErrorHandler errorHandler,
@@ -104,7 +108,8 @@ private Optimizely(@Nonnull EventHandler eventHandler,
                        @Nonnull ProjectConfigManager projectConfigManager,
                        @Nullable OptimizelyConfigManager optimizelyConfigManager,
                        @Nonnull NotificationCenter notificationCenter,
-                       @Nonnull List<OptimizelyDecideOption> defaultDecideOptions
+                       @Nonnull List<OptimizelyDecideOption> defaultDecideOptions,
+                       @Nullable ODPManager odpManager
     ) {
         this.eventHandler = eventHandler;
         this.eventProcessor = eventProcessor;
@@ -115,6 +120,15 @@ private Optimizely(@Nonnull EventHandler eventHandler,
         this.optimizelyConfigManager = optimizelyConfigManager;
         this.notificationCenter = notificationCenter;
         this.defaultDecideOptions = defaultDecideOptions;
+        this.odpManager = odpManager;
+
+        if (odpManager != null) {
+            odpManager.getEventManager().start();
+            if (getProjectConfig() != null) {
+                updateODPSettings();
+            }
+            addUpdateConfigNotificationHandler(configNotification -> { updateODPSettings(); });
+        }
     }
 
     /**
@@ -128,8 +142,6 @@ public boolean isValid() {
         return getProjectConfig() != null;
     }
 
-
-
     /**
      * Checks if eventHandler {@link EventHandler} and projectConfigManager {@link ProjectConfigManager}
      * are Closeable {@link Closeable} and calls close on them.
@@ -141,6 +153,9 @@ public void close() {
         tryClose(eventProcessor);
         tryClose(eventHandler);
         tryClose(projectConfigManager);
+        if (odpManager != null) {
+            tryClose(odpManager);
+        }
     }
 
     //======== activate calls ========//
@@ -674,9 +689,9 @@ public OptimizelyJSON getFeatureVariableJSON(@Nonnull String featureKey,
      */
     @Nullable
     public OptimizelyJSON getFeatureVariableJSON(@Nonnull String featureKey,
-                                         @Nonnull String variableKey,
-                                         @Nonnull String userId,
-                                         @Nonnull Map<String, ?> attributes) {
+                                                 @Nonnull String variableKey,
+                                                 @Nonnull String userId,
+                                                 @Nonnull Map<String, ?> attributes) {
 
         return getFeatureVariableValueForType(
             featureKey,
@@ -688,10 +703,10 @@ public OptimizelyJSON getFeatureVariableJSON(@Nonnull String featureKey,
 
     @VisibleForTesting
     <T> T getFeatureVariableValueForType(@Nonnull String featureKey,
-                                          @Nonnull String variableKey,
-                                          @Nonnull String userId,
-                                          @Nonnull Map<String, ?> attributes,
-                                          @Nonnull String variableType) {
+                                         @Nonnull String variableKey,
+                                         @Nonnull String userId,
+                                         @Nonnull Map<String, ?> attributes,
+                                         @Nonnull String variableType) {
         if (featureKey == null) {
             logger.warn("The featureKey parameter must be nonnull.");
             return null;
@@ -878,7 +893,7 @@ public OptimizelyJSON getAllFeatureVariables(@Nonnull String featureKey,
             }
         } else {
             logger.info("User \"{}\" was not bucketed into any variation for feature flag \"{}\". " +
-                    "The default values are being returned.", userId, featureKey);
+                "The default values are being returned.", userId, featureKey);
         }
 
         Map<String, Object> valuesMap = new HashMap<String, Object>();
@@ -1142,7 +1157,7 @@ public OptimizelyConfig getOptimizelyConfig() {
      * @param userId The user ID to be used for bucketing.
      * @param attributes: A map of attribute names to current user attribute values.
      * @return An OptimizelyUserContext associated with this OptimizelyClient.
-      */
+     */
     public OptimizelyUserContext createUserContext(@Nonnull String userId,
                                                    @Nonnull Map<String, ?> attributes) {
         if (userId == null) {
@@ -1413,6 +1428,53 @@ public <T> int addNotificationHandler(Class<T> clazz, NotificationHandler<T> han
         return notificationCenter.addNotificationHandler(clazz, handler);
     }
 
+    public List<String> fetchQualifiedSegments(String userId, @Nonnull List<ODPSegmentOption> segmentOptions) {
+        if (odpManager != null) {
+            synchronized (odpManager) {
+                return odpManager.getSegmentManager().getQualifiedSegments(userId, segmentOptions);
+            }
+        }
+        logger.error("Audience segments fetch failed (ODP is not enabled).");
+        return null;
+    }
+
+    public void fetchQualifiedSegments(String userId, ODPSegmentManager.ODPSegmentFetchCallback callback, List<ODPSegmentOption> segmentOptions) {
+        if (odpManager == null) {
+            logger.error("Audience segments fetch failed (ODP is not enabled).");
+            callback.onCompleted(null);
+        } else {
+            odpManager.getSegmentManager().getQualifiedSegments(userId, callback, segmentOptions);
+        }
+    }
+
+    @Nullable
+    public ODPManager getODPManager() {
+        return odpManager;
+    }
+
+    public void sendODPEvent(@Nullable String type, @Nonnull String action, @Nullable Map<String, String> identifiers, @Nullable Map<String, Object> data) {
+        if (odpManager != null) {
+            ODPEvent event = new ODPEvent(type, action, identifiers, data);
+            odpManager.getEventManager().sendEvent(event);
+        } else {
+            logger.error("ODP event send failed (ODP is not enabled)");
+        }
+    }
+
+    public void identifyUser(@Nonnull String userId) {
+        ODPManager odpManager = getODPManager();
+        if (odpManager != null) {
+            odpManager.getEventManager().identifyUser(userId);
+        }
+    }
+
+    private void updateODPSettings() {
+        if (odpManager != null && getProjectConfig() != null) {
+            ProjectConfig projectConfig = getProjectConfig();
+            odpManager.updateSettings(projectConfig.getHostForODP(), projectConfig.getPublicKeyForODP(), projectConfig.getAllSegments());
+        }
+    }
+
     //======== Builder ========//
 
     /**
@@ -1467,6 +1529,7 @@ public static class Builder {
         private UserProfileService userProfileService;
         private NotificationCenter notificationCenter;
         private List<OptimizelyDecideOption> defaultDecideOptions;
+        private ODPManager odpManager;
 
         // For backwards compatibility
         private AtomicProjectConfigManager fallbackConfigManager = new AtomicProjectConfigManager();
@@ -1562,6 +1625,11 @@ public Builder withDefaultDecideOptions(List<OptimizelyDecideOption> defaultDeci
             return this;
         }
 
+        public Builder withODPManager(ODPManager odpManager) {
+            this.odpManager = odpManager;
+            return this;
+        }
+
         // Helper functions for making testing easier
         protected Builder withBucketing(Bucketer bucketer) {
             this.bucketer = bucketer;
@@ -1636,7 +1704,7 @@ public Optimizely build() {
                 defaultDecideOptions = Collections.emptyList();
             }
 
-            return new Optimizely(eventHandler, eventProcessor, errorHandler, decisionService, userProfileService, projectConfigManager, optimizelyConfigManager, notificationCenter, defaultDecideOptions);
+            return new Optimizely(eventHandler, eventProcessor, errorHandler, decisionService, userProfileService, projectConfigManager, optimizelyConfigManager, notificationCenter, defaultDecideOptions, odpManager);
         }
     }
 }

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

@@ -16,7 +16,9 @@
  */
 package com.optimizely.ab;
 
-import com.optimizely.ab.config.Variation;
+import com.optimizely.ab.odp.ODPManager;
+import com.optimizely.ab.odp.ODPSegmentCallback;
+import com.optimizely.ab.odp.ODPSegmentOption;
 import com.optimizely.ab.optimizelydecision.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -54,6 +56,15 @@ public OptimizelyUserContext(@Nonnull Optimizely optimizely,
                                  @Nonnull Map<String, ?> attributes,
                                  @Nullable Map<String, OptimizelyForcedDecision> forcedDecisionsMap,
                                  @Nullable List<String> qualifiedSegments) {
+        this(optimizely, userId, attributes, forcedDecisionsMap, qualifiedSegments, true);
+    }
+
+    public OptimizelyUserContext(@Nonnull Optimizely optimizely,
+                                 @Nonnull String userId,
+                                 @Nonnull Map<String, ?> attributes,
+                                 @Nullable Map<String, OptimizelyForcedDecision> forcedDecisionsMap,
+                                 @Nullable List<String> qualifiedSegments,
+                                 @Nullable Boolean shouldIdentifyUser) {
         this.optimizely = optimizely;
         this.userId = userId;
         if (attributes != null) {
@@ -66,6 +77,10 @@ public OptimizelyUserContext(@Nonnull Optimizely optimizely,
         }
 
         this.qualifiedSegments = Collections.synchronizedList( qualifiedSegments == null ? new LinkedList<>(): qualifiedSegments);
+
+        if (shouldIdentifyUser == null || shouldIdentifyUser) {
+            optimizely.identifyUser(userId);
+        }
     }
 
     public OptimizelyUserContext(@Nonnull Optimizely optimizely, @Nonnull String userId) {
@@ -85,7 +100,7 @@ public Optimizely getOptimizely() {
     }
 
     public OptimizelyUserContext copy() {
-        return new OptimizelyUserContext(optimizely, userId, attributes, forcedDecisionsMap, qualifiedSegments);
+        return new OptimizelyUserContext(optimizely, userId, attributes, forcedDecisionsMap, qualifiedSegments, false);
     }
 
     /**
@@ -282,6 +297,60 @@ public void setQualifiedSegments(List<String> qualifiedSegments) {
         this.qualifiedSegments.addAll(qualifiedSegments);
     }
 
+    /**
+     * Fetch all qualified segments for the user context.
+     * <p>
+     * The segments fetched will be saved and can be accessed at any time by calling {@link #getQualifiedSegments()}.
+     */
+    public Boolean fetchQualifiedSegments() {
+        return fetchQualifiedSegments(Collections.emptyList());
+    }
+
+    /**
+     * Fetch all qualified segments for the user context.
+     * <p>
+     * The segments fetched will be saved and can be accessed at any time by calling {@link #getQualifiedSegments()}.
+     *
+     * @param segmentOptions A set of options for fetching qualified segments.
+     */
+    public Boolean fetchQualifiedSegments(@Nonnull List<ODPSegmentOption> segmentOptions) {
+        List<String> segments = optimizely.fetchQualifiedSegments(userId, segmentOptions);
+        if (segments != null) {
+            setQualifiedSegments(segments);
+        }
+        return segments != null;
+    }
+
+    /**
+     * Fetch all qualified segments for the user context in a non-blocking manner. This method will fetch segments
+     * in a separate thread and invoke the provided callback when results are available.
+     * <p>
+     * The segments fetched will be saved and can be accessed at any time by calling {@link #getQualifiedSegments()}.
+     *
+     * @param callback A callback to invoke when results are available.
+     * @param segmentOptions A set of options for fetching qualified segments.
+     */
+    public void fetchQualifiedSegments(ODPSegmentCallback callback, List<ODPSegmentOption> segmentOptions) {
+        optimizely.fetchQualifiedSegments(userId, segments -> {
+            if (segments != null) {
+                setQualifiedSegments(segments);
+            }
+            callback.onCompleted(segments != null);
+        }, segmentOptions);
+    }
+
+    /**
+     * Fetch all qualified segments for the user context in a non-blocking manner. This method will fetch segments
+     * in a separate thread and invoke the provided callback when results are available.
+     * <p>
+     * The segments fetched will be saved and can be accessed at any time by calling {@link #getQualifiedSegments()}.
+     *
+     * @param callback A callback to invoke when results are available.
+     */
+    public void fetchQualifiedSegments(ODPSegmentCallback callback) {
+        fetchQualifiedSegments(callback, Collections.emptyList());
+    }
+
     // Utils
 
     @Override
@@ -309,5 +378,4 @@ public String toString() {
             ", attributes='" + attributes + '\'' +
             '}';
     }
-
 }

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

@@ -434,6 +434,7 @@ public List<Experiment> getExperiments() {
         return experiments;
     }
 
+    @Override
     public Set<String> getAllSegments() {
         return this.allSegments;
     }

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

@@ -24,6 +24,7 @@
 import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * ProjectConfig is an interface capturing the experiment, variation and feature definitions.
@@ -69,6 +70,8 @@ Experiment getExperimentForKey(@Nonnull String experimentKey,
 
     List<Experiment> getExperiments();
 
+    Set<String> getAllSegments();
+
     List<Experiment> getExperimentsForEventKey(String eventKey);
 
     List<FeatureFlag> getFeatureFlags();

core-api/src/main/java/com/optimizely/ab/odp/ODPApiManager.java

@@ -15,10 +15,10 @@
  */
 package com.optimizely.ab.odp;
 
-import java.util.List;
+import java.util.Set;
 
 public interface ODPApiManager {
-    String fetchQualifiedSegments(String apiKey, String apiEndpoint, String userKey, String userValue, List<String> segmentsToCheck);
+    String fetchQualifiedSegments(String apiKey, String apiEndpoint, String userKey, String userValue, Set<String> segmentsToCheck);
 
     Integer sendEvents(String apiKey, String apiEndpoint, String eventPayload);
 }

core-api/src/main/java/com/optimizely/ab/odp/ODPConfig.java

@@ -17,24 +17,24 @@
 package com.optimizely.ab.odp;
 
 import java.util.Collections;
-import java.util.List;
+import java.util.Set;
 
 public class ODPConfig {
 
     private String apiKey;
 
     private String apiHost;
 
-    private List<String> allSegments;
+    private Set<String> allSegments;
 
-    public ODPConfig(String apiKey, String apiHost, List<String> allSegments) {
+    public ODPConfig(String apiKey, String apiHost, Set<String> allSegments) {
         this.apiKey = apiKey;
         this.apiHost = apiHost;
         this.allSegments = allSegments;
     }
 
     public ODPConfig(String apiKey, String apiHost) {
-        this(apiKey, apiHost, Collections.emptyList());
+        this(apiKey, apiHost, Collections.emptySet());
     }
 
     public synchronized Boolean isReady() {
@@ -64,11 +64,11 @@ public synchronized String getApiHost() {
         return apiHost;
     }
 
-    public synchronized List<String> getAllSegments() {
+    public synchronized Set<String> getAllSegments() {
         return allSegments;
     }
 
-    public synchronized void setAllSegments(List<String> allSegments) {
+    public synchronized void setAllSegments(Set<String> allSegments) {
         this.allSegments = allSegments;
     }