Refact: ODPAPIManager now returns fetchQualifiedSegments list instead of string

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2022, Optimizely Inc. and contributors
+ *    Copyright 2022-2023, 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,10 +15,11 @@
  */
 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, Set<String> segmentsToCheck);
+    List<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/ODPEventManager.java

@@ -108,7 +108,11 @@ public void identifyUser(@Nullable String vuid, @Nullable String userId) {
             identifiers.put(ODPUserKey.VUID.getKeyString(), vuid);
         }
         if (userId != null) {
-            identifiers.put(ODPUserKey.FS_USER_ID.getKeyString(), userId);
+            if (isVuid(userId)) {
+                        identifiers.put(ODPUserKey.VUID.getKeyString(), userId);
+            } else {
+                        identifiers.put(ODPUserKey.FS_USER_ID.getKeyString(), userId);
+            }
         }
         ODPEvent event = new ODPEvent("fullstack", "identified", identifiers, null);
         sendEvent(event);
@@ -125,7 +129,7 @@ public void sendEvent(ODPEvent event) {
     }
 
     @VisibleForTesting
-    Map<String, Object> augmentCommonData(Map<String, Object> sourceData) {
+    protected Map<String, Object> augmentCommonData(Map<String, Object> sourceData) {
         // priority: sourceData > userCommonData > sdkCommonData
 
         Map<String, Object> data = new HashMap<>();
@@ -140,7 +144,7 @@ Map<String, Object> augmentCommonData(Map<String, Object> sourceData) {
     }
 
     @VisibleForTesting
-    Map<String, String> augmentCommonIdentifiers(Map<String, String> sourceIdentifiers) {
+    protected Map<String, String> augmentCommonIdentifiers(Map<String, String> sourceIdentifiers) {
         // priority: sourceIdentifiers > userCommonIdentifiers
 
         Map<String, String> identifiers = new HashMap<>();
@@ -149,6 +153,10 @@ Map<String, String> augmentCommonIdentifiers(Map<String, String> sourceIdentifie
         return identifiers;
     }
 
+    private boolean isVuid(String userId) {
+        return userId.startsWith("vuid_");
+    }
+
     private void processEvent(ODPEvent event) {
         if (!isRunning) {
             logger.warn("Failed to Process ODP Event. ODPEventManager is not running");

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2022, Optimizely
+ *    Copyright 2022-2023, Optimizely
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -89,16 +89,7 @@ public List<String> getQualifiedSegments(ODPUserKey userKey, String userValue, L
 
         logger.debug("ODP Cache Miss. Making a call to ODP Server.");
 
-        ResponseJsonParser parser = ResponseJsonParserFactory.getParser();
-        String qualifiedSegmentsResponse = apiManager.fetchQualifiedSegments(odpConfig.getApiKey(), odpConfig.getApiHost() + SEGMENT_URL_PATH, userKey.getKeyString(), userValue, odpConfig.getAllSegments());
-        try {
-            qualifiedSegments = parser.parseQualifiedSegments(qualifiedSegmentsResponse);
-        } catch (Exception e) {
-            logger.error("Audience segments fetch failed (Error Parsing Response)");
-            logger.debug(e.getMessage());
-            qualifiedSegments = null;
-        }
-
+        qualifiedSegments = apiManager.fetchQualifiedSegments(odpConfig.getApiKey(), odpConfig.getApiHost() + SEGMENT_URL_PATH, userKey.getKeyString(), userValue, odpConfig.getAllSegments());
         if (qualifiedSegments != null && !options.contains(ODPSegmentOption.IGNORE_CACHE)) {
             segmentsCache.save(cacheKey, qualifiedSegments);
         }

core-api/src/test/java/com/optimizely/ab/odp/ODPManagerTest.java

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2022, Optimizely
+ *    Copyright 2022-2023, Optimizely
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -24,13 +24,14 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 
 import static org.mockito.Matchers.*;
 import static org.mockito.Mockito.*;
 import static org.junit.Assert.*;
 
 public class ODPManagerTest {
-    private static final String API_RESPONSE = "{\"data\":{\"customer\":{\"audiences\":{\"edges\":[{\"node\":{\"name\":\"segment1\",\"state\":\"qualified\"}},{\"node\":{\"name\":\"segment2\",\"state\":\"qualified\"}}]}}}}";
+    private static final List<String> API_RESPONSE = Arrays.asList(new String[]{"segment1", "segment2"});
 
     @Mock
     ODPApiManager mockApiManager;

core-api/src/test/java/com/optimizely/ab/odp/ODPSegmentManagerTest.java

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2022, Optimizely
+ *    Copyright 2022-2023, Optimizely
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public class ODPSegmentManagerTest {
     @Mock
     ODPApiManager mockApiManager;
 
-    private static final String API_RESPONSE = "{\"data\":{\"customer\":{\"audiences\":{\"edges\":[{\"node\":{\"name\":\"segment1\",\"state\":\"qualified\"}},{\"node\":{\"name\":\"segment2\",\"state\":\"qualified\"}}]}}}}";
+    private static final List<String> API_RESPONSE = Arrays.asList(new String[]{"segment1", "segment2"});
 
     @Before
     public void setup() {

core-httpclient-impl/src/main/java/com/optimizely/ab/odp/DefaultODPApiManager.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2022, Optimizely Inc. and contributors
+ *    Copyright 2022-2023, 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.
@@ -17,6 +17,8 @@
 
 import com.optimizely.ab.OptimizelyHttpClient;
 import com.optimizely.ab.annotations.VisibleForTesting;
+import com.optimizely.ab.odp.parser.ResponseJsonParser;
+import com.optimizely.ab.odp.parser.ResponseJsonParserFactory;
 import org.apache.http.StatusLine;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpPost;
@@ -28,6 +30,7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.util.Iterator;
+import java.util.List;
 import java.util.Set;
 
 public class DefaultODPApiManager implements ODPApiManager {
@@ -144,7 +147,7 @@ String getSegmentsStringForRequest(Set<String> segmentsList) {
      }
     */
     @Override
-    public String fetchQualifiedSegments(String apiKey, String apiEndpoint, String userKey, String userValue, Set<String> segmentsToCheck) {
+    public List<String> fetchQualifiedSegments(String apiKey, String apiEndpoint, String userKey, String userValue, Set<String> segmentsToCheck) {
         HttpPost request = new HttpPost(apiEndpoint);
         String segmentsString = getSegmentsStringForRequest(segmentsToCheck);
 
@@ -174,11 +177,14 @@ public String fetchQualifiedSegments(String apiKey, String apiEndpoint, String u
             closeHttpResponse(response);
             return null;
         }
-
+        ResponseJsonParser parser = ResponseJsonParserFactory.getParser();
         try {
-            return EntityUtils.toString(response.getEntity());
+            return parser.parseQualifiedSegments(EntityUtils.toString(response.getEntity()));
         } catch (IOException e) {
             logger.error("Error converting ODP segments response to string", e);
+        } catch (Exception e) {
+            logger.error("Audience segments fetch failed (Error Parsing Response)");
+            logger.debug(e.getMessage());
         } finally {
             closeHttpResponse(response);
         }
@@ -201,7 +207,6 @@ public String fetchQualifiedSegments(String apiKey, String apiEndpoint, String u
         "type": "fullstack"
       }
     ]
-
     Returns:
     1. null, When there was a non-recoverable error and no retry is needed.
     2. 0 If an unexpected error occurred and retrying can be useful.

core-httpclient-impl/src/test/java/com/optimizely/ab/odp/DefaultODPApiManagerTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2022, Optimizely Inc. and contributors
+ *    Copyright 2022-2023, 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.
@@ -30,13 +30,15 @@
 
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 
 import static org.junit.Assert.*;
 import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.*;
 
 public class DefaultODPApiManagerTest {
-    private static final String validResponse = "{\"data\":{\"customer\":{\"audiences\":{\"edges\":[{\"node\":{\"name\":\"has_email\",\"state\":\"qualified\"}},{\"node\":{\"name\":\"has_email_opted_in\",\"state\":\"qualified\"}}]}}}}";
+    private static final List<String> validResponse = Arrays.asList(new String[] {"has_email", "has_email_opted_in"});
+    private static final String validRequestResponse = "{\"data\":{\"customer\":{\"audiences\":{\"edges\":[{\"node\":{\"name\":\"has_email\",\"state\":\"qualified\"}},{\"node\":{\"name\":\"has_email_opted_in\",\"state\":\"qualified\"}}]}}}}";
 
     @Rule
     public LogbackVerifier logbackVerifier = new LogbackVerifier();
@@ -55,7 +57,7 @@ private void setupHttpClient(int statusCode) throws Exception {
 
         when(statusLine.getStatusCode()).thenReturn(statusCode);
         when(httpResponse.getStatusLine()).thenReturn(statusLine);
-        when(httpResponse.getEntity()).thenReturn(new StringEntity(validResponse));
+        when(httpResponse.getEntity()).thenReturn(new StringEntity(validRequestResponse));
 
         when(mockHttpClient.execute(any(HttpPost.class)))
             .thenReturn(httpResponse);
@@ -99,19 +101,19 @@ public void generateCorrectRequestBody() throws Exception {
     @Test
     public void returnResponseStringWhenStatusIs200() throws Exception {
         ODPApiManager apiManager = new DefaultODPApiManager(mockHttpClient);
-        String responseString = apiManager.fetchQualifiedSegments("key", "endPoint", "fs_user_id", "test_user", new HashSet<>(Arrays.asList("segment_1", "segment_2")));
+        List<String> response = apiManager.fetchQualifiedSegments("key", "endPoint", "fs_user_id", "test_user", new HashSet<>(Arrays.asList("segment_1", "segment_2")));
         verify(mockHttpClient, times(1)).execute(any(HttpPost.class));
-        assertEquals(validResponse, responseString);
+        assertEquals(validResponse, response);
     }
 
     @Test
     public void returnNullWhenStatusIsNot200AndLogError() throws Exception {
         setupHttpClient(500);
         ODPApiManager apiManager = new DefaultODPApiManager(mockHttpClient);
-        String responseString = apiManager.fetchQualifiedSegments("key", "endPoint", "fs_user_id", "test_user", new HashSet<>(Arrays.asList("segment_1", "segment_2")));
+        List<String> response = apiManager.fetchQualifiedSegments("key", "endPoint", "fs_user_id", "test_user", new HashSet<>(Arrays.asList("segment_1", "segment_2")));
         verify(mockHttpClient, times(1)).execute(any(HttpPost.class));
         logbackVerifier.expectMessage(Level.ERROR, "Unexpected response from ODP server, Response code: 500, null");
-        assertNull(responseString);
+        assertNull(response);
     }
 
     @Test