feat(flag-decisions): Add support for sending flag decisions along with decision metadata.

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

@@ -216,31 +216,65 @@ private Variation activate(@Nullable ProjectConfig projectConfig,
             return null;
         }
 
-        sendImpression(projectConfig, experiment, userId, copiedAttributes, variation);
+        sendImpression(projectConfig, experiment, userId, copiedAttributes, variation, "experiment");
 
         return variation;
     }
 
+    /**
+     * Creates and sends impression event.
+     *
+     * @param projectConfig      the current projectConfig
+     * @param experiment         the experiment user bucketed into and dispatch an impression event
+     * @param userId             the ID of the user
+     * @param filteredAttributes the attributes of the user
+     * @param variation          the variation that was returned from activate.
+     * @param ruleType           It can either be experiment in case impression event is sent from activate or it's feature-test or rollout
+     */
     private void sendImpression(@Nonnull ProjectConfig projectConfig,
                                 @Nonnull Experiment experiment,
                                 @Nonnull String userId,
                                 @Nonnull Map<String, ?> filteredAttributes,
-                                @Nonnull Variation variation) {
-        if (!experiment.isRunning()) {
-            logger.info("Experiment has \"Launched\" status so not dispatching event during activation.");
-            return;
-        }
+                                @Nonnull Variation variation,
+                                @Nonnull String ruleType) {
+        sendImpression(projectConfig, experiment, userId, filteredAttributes, variation, "", ruleType);
+    }
+
+    /**
+     * Creates and sends impression event.
+     *
+     * @param projectConfig      the current projectConfig
+     * @param experiment         the experiment user bucketed into and dispatch an impression event
+     * @param userId             the ID of the user
+     * @param filteredAttributes the attributes of the user
+     * @param variation          the variation that was returned from activate.
+     * @param flagKey            It can either be empty if ruleType is experiment or it's feature key in case ruleType is feature-test or rollout
+     * @param ruleType           It can either be experiment in case impression event is sent from activate or it's feature-test or rollout
+     */
+    private void sendImpression(@Nonnull ProjectConfig projectConfig,
+                                @Nonnull Experiment experiment,
+                                @Nonnull String userId,
+                                @Nonnull Map<String, ?> filteredAttributes,
+                                @Nonnull Variation variation,
+                                @Nonnull String flagKey,
+                                @Nonnull String ruleType) {
 
         UserEvent userEvent = UserEventFactory.createImpressionEvent(
             projectConfig,
             experiment,
             variation,
             userId,
-            filteredAttributes);
+            filteredAttributes,
+            flagKey,
+            ruleType);
 
+        if (userEvent == null) {
+            return;
+        }
         eventProcessor.process(userEvent);
-        logger.info("Activating user \"{}\" in experiment \"{}\".", userId, experiment.getKey());
-
+        if (experiment != null) {
+            logger.info("Activating user \"{}\" in experiment \"{}\".", userId, experiment.getKey());
+        }
         // Kept For backwards compatibility.
         // This notification is deprecated and the new DecisionNotifications
         // are sent via their respective method calls.
@@ -386,16 +420,22 @@ private Boolean isFeatureEnabled(@Nonnull ProjectConfig projectConfig,
         FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, userId, copiedAttributes, projectConfig);
         Boolean featureEnabled = false;
         SourceInfo sourceInfo = new RolloutSourceInfo();
+        if (featureDecision.decisionSource != null) {
+            decisionSource = featureDecision.decisionSource;
+        }
+        sendImpression(
+            projectConfig,
+            featureDecision.experiment,
+            userId,
+            copiedAttributes,
+            featureDecision.variation,
+            featureKey,
+            decisionSource.toString());
 
         if (featureDecision.variation != null) {
+            // This information is only necessary for feature tests.
+            // For rollouts experiments and variations are an implementation detail only.
             if (featureDecision.decisionSource.equals(FeatureDecision.DecisionSource.FEATURE_TEST)) {
-                sendImpression(
-                    projectConfig,
-                    featureDecision.experiment,
-                    userId,
-                    copiedAttributes,
-                    featureDecision.variation);
-                decisionSource = featureDecision.decisionSource;
                 sourceInfo = new FeatureTestSourceInfo(featureDecision.experiment.getKey(), featureDecision.variation.getKey());
             } else {
                 logger.info("The user \"{}\" is not included in an experiment for feature \"{}\".",

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

@@ -61,6 +61,7 @@ public class DatafileProjectConfig implements ProjectConfig {
     private final String revision;
     private final String version;
     private final boolean anonymizeIP;
+    private final boolean sendFlagDecisions;
     private final Boolean botFiltering;
     private final List<Attribute> attributes;
     private final List<Audience> audiences;
@@ -103,6 +104,7 @@ public DatafileProjectConfig(String accountId, String projectId, String version,
         this(
             accountId,
             anonymizeIP,
+            false,
             null,
             projectId,
             revision,
@@ -121,6 +123,7 @@ public DatafileProjectConfig(String accountId, String projectId, String version,
     // v4 constructor
     public DatafileProjectConfig(String accountId,
                                  boolean anonymizeIP,
+                                 boolean sendFlagDecisions,
                                  Boolean botFiltering,
                                  String projectId,
                                  String revision,
@@ -139,6 +142,7 @@ public DatafileProjectConfig(String accountId,
         this.version = version;
         this.revision = revision;
         this.anonymizeIP = anonymizeIP;
+        this.sendFlagDecisions = sendFlagDecisions;
         this.botFiltering = botFiltering;
 
         this.attributes = Collections.unmodifiableList(attributes);
@@ -322,6 +326,9 @@ public String getRevision() {
         return revision;
     }
 
+    @Override
+    public boolean getSendFlagDecisions() { return sendFlagDecisions; }
+
     @Override
     public boolean getAnonymizeIP() {
         return anonymizeIP;

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

@@ -55,6 +55,8 @@ Experiment getExperimentForKey(@Nonnull String experimentKey,
 
     String getRevision();
 
+    boolean getSendFlagDecisions();
+
     boolean getAnonymizeIP();
 
     Boolean getBotFiltering();

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2019, Optimizely and contributors
+ *    Copyright 2016-2020, 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.
@@ -83,9 +83,11 @@ public ProjectConfig deserialize(JsonElement json, Type typeOfT, JsonDeserializa
             anonymizeIP = jsonObject.get("anonymizeIP").getAsBoolean();
         }
 
+
         List<FeatureFlag> featureFlags = null;
         List<Rollout> rollouts = null;
         Boolean botFiltering = null;
+        boolean sendFlagDecisions = false;
         if (datafileVersion >= Integer.parseInt(DatafileProjectConfig.Version.V4.toString())) {
             Type featureFlagsType = new TypeToken<List<FeatureFlag>>() {
             }.getType();
@@ -95,11 +97,14 @@ public ProjectConfig deserialize(JsonElement json, Type typeOfT, JsonDeserializa
             rollouts = context.deserialize(jsonObject.get("rollouts").getAsJsonArray(), rolloutsType);
             if (jsonObject.has("botFiltering"))
                 botFiltering = jsonObject.get("botFiltering").getAsBoolean();
+            if (jsonObject.has("sendFlagDecisions"))
+                sendFlagDecisions = jsonObject.get("sendFlagDecisions").getAsBoolean();
         }
 
         return new DatafileProjectConfig(
             accountId,
             anonymizeIP,
+            sendFlagDecisions,
             botFiltering,
             projectId,
             revision,

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

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2019, Optimizely and contributors
+ *    Copyright 2016-2020, 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.
@@ -64,17 +64,22 @@ public DatafileProjectConfig deserialize(JsonParser parser, DeserializationConte
         List<FeatureFlag> featureFlags = null;
         List<Rollout> rollouts = null;
         Boolean botFiltering = null;
+        boolean sendFlagDecisions = false;
         if (datafileVersion >= Integer.parseInt(DatafileProjectConfig.Version.V4.toString())) {
             featureFlags = JacksonHelpers.arrayNodeToList(node.get("featureFlags"), FeatureFlag.class, codec);
             rollouts = JacksonHelpers.arrayNodeToList(node.get("rollouts"), Rollout.class, codec);
             if (node.hasNonNull("botFiltering")) {
                 botFiltering = node.get("botFiltering").asBoolean();
             }
+            if (node.hasNonNull("sendFlagDecisions")) {
+                sendFlagDecisions = node.get("sendFlagDecisions").asBoolean();
+            }
         }
 
         return new DatafileProjectConfig(
             accountId,
             anonymizeIP,
+            sendFlagDecisions,
             botFiltering,
             projectId,
             revision,

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

@@ -73,16 +73,20 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
             List<FeatureFlag> featureFlags = null;
             List<Rollout> rollouts = null;
             Boolean botFiltering = null;
+            boolean sendFlagDecisions = false;
             if (datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString())) {
                 featureFlags = parseFeatureFlags(rootObject.getJSONArray("featureFlags"));
                 rollouts = parseRollouts(rootObject.getJSONArray("rollouts"));
                 if (rootObject.has("botFiltering"))
                     botFiltering = rootObject.getBoolean("botFiltering");
+                if (rootObject.has("sendFlagDecisions"))
+                    sendFlagDecisions = rootObject.getBoolean("sendFlagDecisions");
             }
 
             return new DatafileProjectConfig(
                 accountId,
                 anonymizeIP,
+                sendFlagDecisions,
                 botFiltering,
                 projectId,
                 revision,

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

@@ -80,16 +80,20 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
             List<FeatureFlag> featureFlags = null;
             List<Rollout> rollouts = null;
             Boolean botFiltering = null;
+            boolean sendFlagDecisions = false;
             if (datafileVersion >= Integer.parseInt(DatafileProjectConfig.Version.V4.toString())) {
                 featureFlags = parseFeatureFlags((JSONArray) rootObject.get("featureFlags"));
                 rollouts = parseRollouts((JSONArray) rootObject.get("rollouts"));
                 if (rootObject.containsKey("botFiltering"))
                     botFiltering = (Boolean) rootObject.get("botFiltering");
+                if (rootObject.containsKey("sendFlagDecisions"))
+                    sendFlagDecisions = (Boolean) rootObject.get("sendFlagDecisions");
             }
 
             return new DatafileProjectConfig(
                 accountId,
                 anonymizeIP,
+                sendFlagDecisions,
                 botFiltering,
                 projectId,
                 revision,

core-api/src/main/java/com/optimizely/ab/event/internal/EventFactory.java

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2016-2019, Optimizely and contributors
+ *    Copyright 2016-2020, 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.
@@ -99,6 +99,7 @@ private static Visitor createVisitor(ImpressionEvent impressionEvent) {
             .setCampaignId(impressionEvent.getLayerId())
             .setExperimentId(impressionEvent.getExperimentId())
             .setVariationId(impressionEvent.getVariationId())
+            .setMetadata(impressionEvent.getMetadata())
             .setIsCampaignHoldback(false)
             .build();
 

core-api/src/main/java/com/optimizely/ab/event/internal/ImpressionEvent.java

@@ -1,6 +1,6 @@
 /**
  *
- *    Copyright 2019, Optimizely and contributors
+ *    Copyright 2019-2020, 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,8 @@
  */
 package com.optimizely.ab.event.internal;
 
+import com.optimizely.ab.event.internal.payload.DecisionMetadata;
+
 import java.util.StringJoiner;
 
 /**
@@ -28,19 +30,22 @@ public class ImpressionEvent extends BaseEvent implements UserEvent {
     private final String experimentKey;
     private final String variationKey;
     private final String variationId;
+    private final DecisionMetadata metadata;
 
     private ImpressionEvent(UserContext userContext,
                             String layerId,
                             String experimentId,
                             String experimentKey,
                             String variationKey,
-                            String variationId) {
+                            String variationId,
+                            DecisionMetadata metadata) {
         this.userContext = userContext;
         this.layerId = layerId;
         this.experimentId = experimentId;
         this.experimentKey = experimentKey;
         this.variationKey = variationKey;
         this.variationId = variationId;
+        this.metadata = metadata;
     }
 
     @Override
@@ -68,6 +73,8 @@ public String getVariationId() {
         return variationId;
     }
 
+    public DecisionMetadata getMetadata() { return metadata; }
+
     public static class Builder {
 
         private UserContext userContext;
@@ -76,6 +83,7 @@ public static class Builder {
         private String experimentKey;
         private String variationKey;
         private String variationId;
+        private DecisionMetadata metadata;
 
         public Builder withUserContext(UserContext userContext) {
             this.userContext = userContext;
@@ -107,8 +115,13 @@ public Builder withVariationId(String variationId) {
             return this;
         }
 
+        public Builder withMetadata(DecisionMetadata metadata) {
+            this.metadata = metadata;
+            return this;
+        }
+
         public ImpressionEvent build() {
-            return new ImpressionEvent(userContext, layerId, experimentId, experimentKey, variationKey, variationId);
+            return new ImpressionEvent(userContext, layerId, experimentId, experimentKey, variationKey, variationId, metadata);
         }
     }