Releases/v0.7.0 beta (#6)

* Moving participant init to client init

* Changing participant builder pattern

* Audience filtering on user attributes plus tests

* Adding uid to allocation store methods

* Changing back dependencies

* Fixing typo

* Making sure all allocations are searched

* Changing log level of AscendKeyError

* Rewording changelog

* Updating README

* Changing date in changelog

* Per Tinou's comment; implementing cache with LinkedHashMap

* Fixing cache bug

* Accidentally renamed public method

Author: FrazerBayley

.gitignore

@@ -6,4 +6,5 @@
 /build
 /captures
 .externalNativeBuild
-/out
+/out
+/scratch

CHANGELOG.md

@@ -3,6 +3,17 @@
 
 All updates that affect the released version of the Ascend Java Client will be detailed here. This project adheres to [Semantic Versioning](http://semver.org).
 
-## [0.6.0] - 2019-04-16
+## [0.7.0-beta] - 2019-05-29
+### Fixed 
+- Participant's now initialize with the client instead of getting reused like before.
+- Stack traces are now logged upon exceptions.
+### Deprecated 
+- Deprecating setAscendParticipant method in the AscendConfig builder in favor of passing the participant into the
+AscendClient init method.
+### Added
+- Added audience filters, allowing for filtering of the participant through user attributes.
+- AllocationStore now requires a unique user id to be given with the allocation to be stored.
+
+## [0.6.0-beta] - 2019-04-16
 ### Added
 - Deprecating the implementations AsyncHttpClientImpl and OkHttpClientImpl in favor of the implementations AsyncHttpClient and OkHttpClient. The new implementations provide more options when constructing an HttpClient.

README.md

@@ -15,7 +15,7 @@
         <dependency>
           <groupId>ai.evolv</groupId>
           <artifactId>ascend-sdk</artifactId>
-          <version>0.5.1</version>
+          <version>0.7.0</version>
         </dependency>
     ```
 

build.gradle

@@ -7,7 +7,7 @@ plugins {
 
 group = "ai.evolv"
 archivesBaseName = "ascend-sdk"
-version = "0.6.0"
+version = "0.7.0"
 
 sourceCompatibility = 1.8
 

src/main/java/ai/evolv/Allocations.java

@@ -10,45 +10,68 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashSet;
-import java.util.Map;
+import java.util.List;
 import java.util.Set;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 class Allocations {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(Allocations.class);
+
     private final JsonArray allocations;
 
+    private final Audience audience = new Audience();
+
     Allocations(JsonArray allocations) {
         this.allocations = allocations;
     }
 
-    <T> T getValueFromGenome(String key, Class<T> cls) throws AscendKeyError {
+    <T> T getValueFromAllocations(String key, Class<T> cls, AscendParticipant participant)
+            throws AscendKeyError {
         ArrayList<String> keyParts = new ArrayList<>(Arrays.asList(key.split("\\.")));
-        JsonElement value = getGenomeFromAllocations().get("genome");
-        for (String part : keyParts) {
-            JsonObject jsonObject = value.getAsJsonObject();
-            value = jsonObject.get(part);
+        if (keyParts.isEmpty()) {
+            throw new AscendKeyError("Key provided was empty.");
+        }
 
-            if (value == null) {
-                throw new AscendKeyError("Could not find value for key:" + key);
+        for (JsonElement a : allocations) {
+            JsonObject allocation = a.getAsJsonObject();
+            if (!audience.filter(participant.getUserAttributes(), allocation)) {
+                try {
+                    JsonElement element = getElementFromGenome(allocation.get("genome"), keyParts);
+                    return new Gson().fromJson(element, cls);
+                } catch (AscendKeyError e) {
+                    LOGGER.debug(String.format("Unable to find key %s in experiment %s.",
+                            keyParts.toString(), allocation.get("eid").getAsString()), e);
+                    continue;
+                }
             }
+
+            LOGGER.debug(String.format("Participant was filtered from experiment %s",
+                    allocation.get("eid").getAsString()));
         }
 
-        Gson gson = new Gson();
-        return gson.fromJson(value, cls);
+        throw new AscendKeyError(String.format("No value was found in any allocations for key: %s",
+                keyParts.toString()));
     }
 
-    JsonObject getGenomeFromAllocations() {
-        JsonObject genome = new JsonObject();
-        for (JsonElement allocation : allocations) {
-            JsonObject originalGenome = allocation.getAsJsonObject().getAsJsonObject("genome");
-            Set<Map.Entry<String, JsonElement>> entrySet = originalGenome.entrySet();
-            for (Map.Entry<String, JsonElement> entry : entrySet) {
-                genome.add(entry.getKey(), originalGenome.get(entry.getKey()));
+    private JsonElement getElementFromGenome(JsonElement genome, List<String> keyParts)
+            throws AscendKeyError {
+        JsonElement element = genome;
+        if (element == null) {
+            throw new AscendKeyError("Allocation genome was empty.");
+        }
+
+        for (String part : keyParts) {
+            JsonObject object = element.getAsJsonObject();
+            element = object.get(part);
+            if (element == null) {
+                throw new AscendKeyError("Could not find value for key: " + keyParts.toString());
             }
         }
-        JsonObject genomeWrapped = new JsonObject();
-        genomeWrapped.add("genome", genome);
-        return genomeWrapped;
+
+        return element;
     }
 
     /**

src/main/java/ai/evolv/Allocator.java

@@ -1,7 +1,5 @@
 package ai.evolv;
 
-import ai.evolv.exceptions.AscendRuntimeException;
-
 import com.google.gson.JsonArray;
 import com.google.gson.JsonParser;
 
@@ -15,7 +13,7 @@
 
 class Allocator {
 
-    private static Logger logger = LoggerFactory.getLogger(Allocator.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(Allocator.class);
 
     enum AllocationStatus {
         FETCHING, RETRIEVED, FAILED
@@ -24,7 +22,7 @@ enum AllocationStatus {
     private final ExecutionQueue executionQueue;
     private final AscendAllocationStore store;
     private final AscendConfig config;
-    private final AscendParticipant ascendParticipant;
+    private final AscendParticipant participant;
     private final EventEmitter eventEmitter;
     private final HttpClient httpClient;
 
@@ -33,14 +31,14 @@ enum AllocationStatus {
 
     private AllocationStatus allocationStatus;
 
-    Allocator(AscendConfig config) {
+    Allocator(AscendConfig config, AscendParticipant participant) {
         this.executionQueue = config.getExecutionQueue();
         this.store = config.getAscendAllocationStore();
         this.config = config;
-        this.ascendParticipant = config.getAscendParticipant();
+        this.participant = participant;
         this.httpClient = config.getHttpClient();
         this.allocationStatus = AllocationStatus.FETCHING;
-        this.eventEmitter = new EventEmitter(config);
+        this.eventEmitter = new EventEmitter(config, participant);
 
     }
 
@@ -61,14 +59,14 @@ String createAllocationsUrl() {
             String path = String.format("//%s/%s/%s/allocations", config.getDomain(),
                     config.getVersion(),
                     config.getEnvironmentId());
-            String queryString = String.format("uid=%s&sid=%s", ascendParticipant.getUserId(),
-                    ascendParticipant.getSessionId());
+            String queryString = String.format("uid=%s&sid=%s", participant.getUserId(),
+                    participant.getSessionId());
             URI uri = new URI(config.getHttpScheme(), null, path, queryString, null);
             URL url = uri.toURL();
 
             return url.toString();
         } catch (Exception e) {
-            logger.error(e.getMessage());
+            LOGGER.error("There was an issue creating the allocations url.", e);
             return "";
         }
     }
@@ -80,12 +78,12 @@ CompletableFuture<JsonArray> fetchAllocations() {
             JsonParser parser = new JsonParser();
             JsonArray allocations = parser.parse(responseBody).getAsJsonArray();
 
-            JsonArray previousAllocations = store.get();
+            JsonArray previousAllocations = store.get(participant.getUserId());
             if (allocationsNotEmpty(previousAllocations)) {
                 allocations = Allocations.reconcileAllocations(previousAllocations, allocations);
             }
 
-            store.put(allocations);
+            store.put(participant.getUserId(), allocations);
             allocationStatus = AllocationStatus.RETRIEVED;
 
             if (confirmationSandbagged) {
@@ -96,60 +94,40 @@ CompletableFuture<JsonArray> fetchAllocations() {
                 eventEmitter.contaminate(allocations);
             }
 
-            // could throw an exception due to customer's action logic
-            try {
-                executionQueue.executeAllWithValuesFromAllocations(allocations);
-            } catch (Exception e) {
-                throw new AscendRuntimeException(e);
-            }
+            executionQueue.executeAllWithValuesFromAllocations(allocations);
 
             return allocations;
-        }).handle((result, ex) -> {
-            if (ex != null && ex.getCause() instanceof AscendRuntimeException) {
-                // surface any customer implementation errors
-                logger.error(ex.getCause().getCause().toString());
-                return result;
-            } else if (ex != null && result == null) {
-                return resolveAllocationFailure();
-            } else {
-                return result;
-            }
+        }).exceptionally(e -> {
+            LOGGER.error("There was an exception while retrieving allocations.", e);
+            return resolveAllocationFailure();
         });
     }
 
     JsonArray resolveAllocationFailure() {
-        logger.warn("There was an error while making an allocation request.");
-
-        JsonArray allocations = store.get();
-        if (allocationsNotEmpty(allocations)) {
-            logger.warn("Falling back to participant's previous allocation.");
-
+        JsonArray previousAllocations = store.get(participant.getUserId());
+        if (allocationsNotEmpty(previousAllocations)) {
+            LOGGER.debug("Falling back to participant's previous allocation.");
             if (confirmationSandbagged) {
-                eventEmitter.confirm(allocations);
+                eventEmitter.confirm(previousAllocations);
             }
 
             if (contaminationSandbagged) {
-                eventEmitter.contaminate(allocations);
+                eventEmitter.contaminate(previousAllocations);
             }
 
             allocationStatus = AllocationStatus.RETRIEVED;
-            executionQueue.executeAllWithValuesFromAllocations(allocations);
+            executionQueue.executeAllWithValuesFromAllocations(previousAllocations);
         } else {
-            logger.warn("Falling back to the supplied defaults.");
-
+            LOGGER.debug("Falling back to the supplied defaults.");
             allocationStatus = AllocationStatus.FAILED;
             executionQueue.executeAllWithValuesFromDefaults();
-
-            allocations = new JsonArray();
+            previousAllocations = new JsonArray();
         }
 
-        return allocations;
+        return previousAllocations;
     }
 
     static boolean allocationsNotEmpty(JsonArray allocations) {
         return allocations != null && allocations.size() > 0;
     }
-
-
-
 }

src/main/java/ai/evolv/AscendAllocationStore.java

@@ -10,17 +10,19 @@ public interface AscendAllocationStore {
      *     Retrieves a JsonArray that represents the participant's allocations.
      *     If there are no stored allocations, should return an empty JsonArray.
      * </p>
-     * @return a participant's allocations
+     * @param uid the participant's unique id
+     * @return an allocation if one exists else an empty JsonArray
      */
-    JsonArray get();
+    JsonArray get(String uid);
 
     /**
      * Stores a JsonArray.
      * <p>
      *     Stores the given JsonArray.
      * </p>
-     * @param allocations a participant's allocations
+     * @param uid the participant's unique id
+     * @param allocations the participant's allocations
      */
-    void put(JsonArray allocations);
+    void put(String uid, JsonArray allocations);
 
 }

src/main/java/ai/evolv/AscendClientFactory.java

@@ -13,29 +13,50 @@ public class AscendClientFactory {
 
     /**
      * Creates instances of the AscendClient.
+     *
      * @param config an instance of AscendConfig
      * @return an instance of AscendClient
      */
     public static AscendClient init(AscendConfig config) {
-        LOGGER.info("Initializing Ascend Client.");
+        LOGGER.debug("Initializing Ascend Client.");
+        AscendParticipant participant = config.getAscendParticipant();
+        if (participant == null) {
+            participant = AscendParticipant.builder().build();
+        }
 
-        AscendAllocationStore store = config.getAscendAllocationStore();
-        Allocator allocator = new Allocator(config);
+        return AscendClientFactory.createClient(config, participant);
+    }
+
+    /**
+     * Creates instances of the AscendClient.
+     *
+     * @param config general configurations for the SDK
+     * @param participant the participant for the initialized client
+     * @return an instance of AscendClient
+     */
+    public static AscendClient init(AscendConfig config, AscendParticipant participant) {
+        LOGGER.debug("Initializing Ascend Client.");
+        return AscendClientFactory.createClient(config, participant);
+    }
 
-        JsonArray previousAllocations = store.get();
+    private static AscendClient createClient(AscendConfig config, AscendParticipant participant) {
+        AscendAllocationStore store = config.getAscendAllocationStore();
+        JsonArray previousAllocations = store.get(participant.getUserId());
         boolean reconciliationNeeded = false;
         if (Allocator.allocationsNotEmpty(previousAllocations)) {
-            String storedUserId = previousAllocations.get(0)
-                    .getAsJsonObject().get("uid")
-                    .getAsString();
-            config.getAscendParticipant().setUserId(storedUserId);
             reconciliationNeeded = true;
         }
 
-        // fetch and reconcile allocations asynchronously
-        CompletableFuture<JsonArray> fetchedAllocations = allocator.fetchAllocations();
+        Allocator allocator = new Allocator(config, participant);
 
-        return new AscendClientImpl(config, new EventEmitter(config), fetchedAllocations,
-                allocator, reconciliationNeeded);
+        // fetch and reconcile allocations asynchronously
+        CompletableFuture<JsonArray> futureAllocations = allocator.fetchAllocations();
+
+        return new AscendClientImpl(config,
+                new EventEmitter(config, participant),
+                futureAllocations,
+                allocator,
+                reconciliationNeeded,
+                participant);
     }
 }