Merge pull request #42 from optimizely/mng/add-ip-anon

mikeproeng37 · Mike Ng · commit 0e268a9ac627 · 2016-12-14T14:22:31.000-08:00
Add IP anonymization to event payload.
diff --git a/core-api/src/main/java/com/optimizely/ab/config/ProjectConfig.java b/core-api/src/main/java/com/optimizely/ab/config/ProjectConfig.java
@@ -58,6 +58,7 @@ public String toString() {
     private final String projectId;
     private final String revision;
     private final String version;
+    private final boolean anonymizeIP;
     private final List<Group> groups;
     private final List<Experiment> experiments;
     private final List<Attribute> attributes;
@@ -79,18 +80,19 @@ public String toString() {
     public ProjectConfig(String accountId, String projectId, String version, String revision, List<Group> groups,
                          List<Experiment> experiments, List<Attribute> attributes, List<EventType> eventType,
                          List<Audience> audiences) {
-        this(accountId, projectId, version, revision, groups, experiments, attributes, eventType, audiences,
+        this(accountId, projectId, version, revision, groups, experiments, attributes, eventType, audiences, false,
              null);
     }
 
     public ProjectConfig(String accountId, String projectId, String version, String revision, List<Group> groups,
                          List<Experiment> experiments, List<Attribute> attributes, List<EventType> eventType,
-                         List<Audience> audiences, List<LiveVariable> liveVariables) {
+                         List<Audience> audiences, boolean anonymizeIP, List<LiveVariable> liveVariables) {
 
         this.accountId = accountId;
         this.projectId = projectId;
         this.version = version;
         this.revision = revision;
+        this.anonymizeIP = anonymizeIP;
 
         this.groups = Collections.unmodifiableList(groups);
         List<Experiment> allExperiments = new ArrayList<Experiment>();
@@ -151,6 +153,10 @@ public String getRevision() {
         return revision;
     }
 
+    public boolean getAnonymizeIP() {
+        return anonymizeIP;
+    }
+
     public List<Group> getGroups() {
         return groups;
     }
@@ -233,6 +239,7 @@ public String toString() {
                 ", projectId='" + projectId + '\'' +
                 ", revision='" + revision + '\'' +
                 ", version='" + version + '\'' +
+                ", anonymizeIP='" + anonymizeIP + '\'' +
                 ", groups=" + groups +
                 ", experiments=" + experiments +
                 ", attributes=" + attributes +
diff --git a/core-api/src/main/java/com/optimizely/ab/config/parser/JsonConfigParser.java b/core-api/src/main/java/com/optimizely/ab/config/parser/JsonConfigParser.java
@@ -73,13 +73,16 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
             List<Audience> audiences = parseAudiences(rootObject.getJSONArray("audiences"));
             List<Group> groups = parseGroups(rootObject.getJSONArray("groups"));
 
+            boolean anonymizeIP = false;
             List<LiveVariable> liveVariables = null;
             if (version.equals(ProjectConfig.Version.V3.toString())) {
                 liveVariables = parseLiveVariables(rootObject.getJSONArray("variables"));
+
+                anonymizeIP = rootObject.getBoolean("anonymizeIP");
             }
 
             return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,
-                                     audiences, liveVariables);
+                                     audiences, anonymizeIP, liveVariables);
         } catch (Exception e) {
             throw new ConfigParseException("Unable to parse datafile: " + json, e);
         }
diff --git a/core-api/src/main/java/com/optimizely/ab/config/parser/JsonSimpleConfigParser.java b/core-api/src/main/java/com/optimizely/ab/config/parser/JsonSimpleConfigParser.java
@@ -75,13 +75,16 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
             List<Audience> audiences = parseAudiences((JSONArray)parser.parse(rootObject.get("audiences").toString()));
             List<Group> groups = parseGroups((JSONArray)rootObject.get("groups"));
 
+            boolean anonymizeIP = false;
             List<LiveVariable> liveVariables = null;
             if (version.equals(ProjectConfig.Version.V3.toString())) {
                 liveVariables = parseLiveVariables((JSONArray)rootObject.get("variables"));
+
+                anonymizeIP = (Boolean)rootObject.get("anonymizeIP");
             }
 
             return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,
-                                     audiences, liveVariables);
+                                     audiences, anonymizeIP, liveVariables);
         } catch (Exception e) {
             throw new ConfigParseException("Unable to parse datafile: " + json, e);
         }
diff --git a/core-api/src/main/java/com/optimizely/ab/config/parser/ProjectConfigGsonDeserializer.java b/core-api/src/main/java/com/optimizely/ab/config/parser/ProjectConfigGsonDeserializer.java
@@ -72,14 +72,17 @@ public ProjectConfig deserialize(JsonElement json, Type typeOfT, JsonDeserializa
         List<Audience> audiences =
             context.deserialize(jsonObject.get("audiences").getAsJsonArray(), audienceType);
 
+        boolean anonymizeIP = false;
         // live variables should be null if using V1
         List<LiveVariable> liveVariables = null;
         if (version.equals(ProjectConfig.Version.V3.toString())) {
             Type liveVariablesType = new TypeToken<List<LiveVariable>>() {}.getType();
             liveVariables = context.deserialize(jsonObject.getAsJsonArray("variables"), liveVariablesType);
+
+            anonymizeIP = jsonObject.get("anonymizeIP").getAsBoolean();
         }
 
         return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,
-                                 audiences, liveVariables);
+                                 audiences, anonymizeIP, liveVariables);
     }
 }
diff --git a/core-api/src/main/java/com/optimizely/ab/config/parser/ProjectConfigJacksonDeserializer.java b/core-api/src/main/java/com/optimizely/ab/config/parser/ProjectConfigJacksonDeserializer.java
@@ -68,13 +68,15 @@ public ProjectConfig deserialize(JsonParser parser, DeserializationContext conte
         List<Audience> audiences = mapper.readValue(node.get("audiences").toString(),
                                                     new TypeReference<List<Audience>>() {});
 
+        boolean anonymizeIP = false;
         List<LiveVariable> liveVariables = null;
         if (version.equals(ProjectConfig.Version.V3.toString())) {
             liveVariables = mapper.readValue(node.get("variables").toString(),
                                              new TypeReference<List<LiveVariable>>() {});
+            anonymizeIP = node.get("anonymizeIP").asBoolean();
         }
 
         return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,
-                                 audiences, liveVariables);
+                                 audiences, anonymizeIP, liveVariables);
     }
 }
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/EventBuilderV2.java b/core-api/src/main/java/com/optimizely/ab/event/internal/EventBuilderV2.java
@@ -51,8 +51,8 @@ public class EventBuilderV2 extends EventBuilder {
 
     private static final Logger logger = LoggerFactory.getLogger(EventBuilderV2.class);
 
-    static final String IMPRESSION_ENDPOINT = "https://p13nlog.dz.optimizely.com/log/decision";
-    static final String CONVERSION_ENDPOINT = "https://p13nlog.dz.optimizely.com/log/event";
+    static final String IMPRESSION_ENDPOINT = "https://logx.optimizely.com/log/decision";
+    static final String CONVERSION_ENDPOINT = "https://logx.optimizely.com/log/event";
 
     @VisibleForTesting
     public final ClientEngine clientEngine;
@@ -95,6 +95,7 @@ public LogEvent createImpressionEvent(@Nonnull ProjectConfig projectConfig,
         impressionPayload.setUserFeatures(createFeatures(attributes, projectConfig));
         impressionPayload.setClientEngine(clientEngine);
         impressionPayload.setClientVersion(clientVersion);
+        impressionPayload.setAnonymizeIP(projectConfig.getAnonymizeIP());
 
         String payload = this.serializer.serialize(impressionPayload);
         return new LogEvent(RequestMethod.POST, IMPRESSION_ENDPOINT, Collections.<String, String>emptyMap(), payload);
@@ -133,6 +134,7 @@ public LogEvent createConversionEvent(@Nonnull ProjectConfig projectConfig,
 
         conversionPayload.setEventFeatures(Collections.<Feature>emptyList());
         conversionPayload.setIsGlobalHoldback(false);
+        conversionPayload.setAnonymizeIP(projectConfig.getAnonymizeIP());
         conversionPayload.setClientEngine(clientEngine);
         conversionPayload.setClientVersion(clientVersion);
 
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/payload/Conversion.java b/core-api/src/main/java/com/optimizely/ab/event/internal/payload/Conversion.java
@@ -31,12 +31,13 @@ public class Conversion extends Event {
     private List<EventMetric> eventMetrics;
     private List<Feature> eventFeatures;
     private boolean isGlobalHoldback;
+    private boolean anonymizeIP;
 
     public Conversion() { }
 
     public Conversion(String visitorId, long timestamp, String projectId, String accountId, List<Feature> userFeatures,
                       List<LayerState> layerStates, String eventEntityId, String eventName,
-                      List<EventMetric> eventMetrics, List<Feature> eventFeatures, boolean isGlobalHoldback) {
+                      List<EventMetric> eventMetrics, List<Feature> eventFeatures, boolean isGlobalHoldback, boolean anonymizeIP) {
         this.visitorId = visitorId;
         this.timestamp = timestamp;
         this.projectId = projectId;
@@ -48,6 +49,7 @@ public Conversion(String visitorId, long timestamp, String projectId, String acc
         this.eventMetrics = eventMetrics;
         this.eventFeatures = eventFeatures;
         this.isGlobalHoldback = isGlobalHoldback;
+        this.anonymizeIP = anonymizeIP;
     }
 
     public String getVisitorId() {
@@ -138,6 +140,10 @@ public void setIsGlobalHoldback(boolean globalHoldback) {
         this.isGlobalHoldback = globalHoldback;
     }
 
+    public boolean getAnonymizeIP() { return anonymizeIP; }
+
+    public void setAnonymizeIP(boolean anonymizeIP) { this.anonymizeIP = anonymizeIP; }
+
     @Override
     public boolean equals(Object other) {
         if (!(other instanceof Conversion))
@@ -192,6 +198,7 @@ public String toString() {
                 ", eventMetrics=" + eventMetrics +
                 ", eventFeatures=" + eventFeatures +
                 ", isGlobalHoldback=" + isGlobalHoldback +
+                ", anonymizeIP=" + anonymizeIP +
                 ", clientEngine='" + clientEngine +
                 ", clientVersion='" + clientVersion + '}';
     }
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/payload/Impression.java b/core-api/src/main/java/com/optimizely/ab/event/internal/payload/Impression.java
@@ -28,11 +28,12 @@ public class Impression extends Event {
     private String layerId;
     private String accountId;
     private List<Feature> userFeatures;
+    private boolean anonymizeIP;
 
     public Impression() { }
 
     public Impression(String visitorId, long timestamp, boolean isGlobalHoldback, String projectId, Decision decision,
-                      String layerId, String accountId, List<Feature> userFeatures) {
+                      String layerId, String accountId, List<Feature> userFeatures, boolean anonymizeIP) {
         this.visitorId = visitorId;
         this.timestamp = timestamp;
         this.isGlobalHoldback = isGlobalHoldback;
@@ -41,6 +42,7 @@ public Impression(String visitorId, long timestamp, boolean isGlobalHoldback, St
         this.layerId = layerId;
         this.accountId = accountId;
         this.userFeatures = userFeatures;
+        this.anonymizeIP = anonymizeIP;
     }
 
     public String getVisitorId() {
@@ -107,6 +109,14 @@ public void setUserFeatures(List<Feature> userFeatures) {
         this.userFeatures = userFeatures;
     }
 
+    public boolean getAnonymizeIP() {
+        return anonymizeIP;
+    }
+
+    public void setAnonymizeIP(boolean anonymizeIP) {
+        this.anonymizeIP = anonymizeIP;
+    }
+
     @Override
     public boolean equals(Object other) {
         if (!(other instanceof Impression))
@@ -147,6 +157,7 @@ public String toString() {
                 "visitorId='" + visitorId + '\'' +
                 ", timestamp=" + timestamp +
                 ", isGlobalHoldback=" + isGlobalHoldback +
+                ", anonymizeIP=" + anonymizeIP +
                 ", projectId='" + projectId + '\'' +
                 ", decision=" + decision +
                 ", layerId='" + layerId + '\'' +
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/serializer/JsonSimpleSerializer.java b/core-api/src/main/java/com/optimizely/ab/event/internal/serializer/JsonSimpleSerializer.java
@@ -48,6 +48,7 @@ private JSONObject serializeImpression(Impression impression) {
         jsonObject.put("visitorId", impression.getVisitorId());
         jsonObject.put("timestamp", impression.getTimestamp());
         jsonObject.put("isGlobalHoldback", impression.getIsGlobalHoldback());
+        jsonObject.put("anonymizeIP", impression.getAnonymizeIP());
         jsonObject.put("projectId", impression.getProjectId());
         jsonObject.put("decision", serializeDecision(impression.getDecision()));
         jsonObject.put("layerId", impression.getLayerId());
@@ -72,6 +73,7 @@ private JSONObject serializeConversion(Conversion conversion) {
         jsonObject.put("eventMetrics", serializeEventMetrics(conversion.getEventMetrics()));
         jsonObject.put("eventFeatures", serializeFeatures(conversion.getEventFeatures()));
         jsonObject.put("isGlobalHoldback", conversion.getIsGlobalHoldback());
+        jsonObject.put("anonymizeIP", conversion.getAnonymizeIP());
         jsonObject.put("clientEngine", conversion.getClientEngine());
         jsonObject.put("clientVersion", conversion.getClientVersion());
 
diff --git a/core-api/src/test/java/com/optimizely/ab/config/ProjectConfigTest.java b/core-api/src/test/java/com/optimizely/ab/config/ProjectConfigTest.java
@@ -30,6 +30,7 @@
 
 import static java.util.Arrays.asList;
 import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 
@@ -179,4 +180,15 @@ public void verifyGetVariationToLiveVariableUsageInstanceMapping() throws Except
         assertThat(projectConfig.getVariationToLiveVariableUsageInstanceMapping(),
                    is(expectedVariationToLiveVariableUsageInstanceMapping));
     }
+
+    /**
+     * Asserts that anonymizeIP is set to false if not explicitly passed into the constructor (in the case of V1 or V2
+     * projects).
+     * @throws Exception
+     */
+    @Test
+    public void verifyAnonymizeIPIsFalseByDefault() throws Exception {
+        ProjectConfig v2ProjectConfig = ProjectConfigTestUtils.validProjectConfigV2();
+        assertFalse(v2ProjectConfig.getAnonymizeIP());
+    }
 }
diff --git a/core-api/src/test/java/com/optimizely/ab/config/ProjectConfigTestUtils.java b/core-api/src/test/java/com/optimizely/ab/config/ProjectConfigTestUtils.java
@@ -437,7 +437,7 @@ private static ProjectConfig generateValidProjectConfigV3() {
         );
 
         return new ProjectConfig("789", "1234", "3", "42", groups, experiments, attributes, events, audiences,
-                                 liveVariables);
+                                 true, liveVariables);
     }
 
     private static final ProjectConfig NO_AUDIENCE_PROJECT_CONFIG_V3 = generateNoAudienceProjectConfigV3();
@@ -474,7 +474,7 @@ private static ProjectConfig generateNoAudienceProjectConfigV3() {
                                         new EventType("099", "clicked_purchase", multipleExperimentIds));
 
         return new ProjectConfig("789", "1234", "3", "42", Collections.<Group>emptyList(), experiments, attributes,
-                                 events, Collections.<Audience>emptyList(), Collections.<LiveVariable>emptyList());
+                                 events, Collections.<Audience>emptyList(), true, Collections.<LiveVariable>emptyList());
     }
 
     private ProjectConfigTestUtils() { }
diff --git a/core-api/src/test/java/com/optimizely/ab/event/internal/EventBuilderV2Test.java b/core-api/src/test/java/com/optimizely/ab/event/internal/EventBuilderV2Test.java
@@ -90,6 +90,7 @@ public void createImpressionEvent() throws Exception {
         assertThat(impression.getVisitorId(), is(userId));
         assertThat((double)impression.getTimestamp(), closeTo((double)System.currentTimeMillis(), 60.0));
         assertFalse(impression.getIsGlobalHoldback());
+        assertThat(impression.getAnonymizeIP(), is(projectConfig.getAnonymizeIP()));
         assertThat(impression.getProjectId(), is(projectConfig.getProjectId()));
         assertThat(impression.getDecision(), is(expectedDecision));
         assertThat(impression.getLayerId(), is(activatedExperiment.getLayerId()));
@@ -207,6 +208,7 @@ public void createConversionEvent() throws Exception {
         assertThat(conversion.getEventMetrics(), is(Collections.<EventMetric>emptyList()));
         assertThat(conversion.getEventFeatures(), is(Collections.<Feature>emptyList()));
         assertFalse(conversion.getIsGlobalHoldback());
+        assertThat(conversion.getAnonymizeIP(), is(projectConfig.getAnonymizeIP()));
         assertThat(conversion.getClientEngine(), is(ClientEngine.JAVA_SDK.getClientEngineValue()));
         assertThat(conversion.getClientVersion(), is(BuildVersionInfo.VERSION));
     }
diff --git a/core-api/src/test/java/com/optimizely/ab/event/internal/serializer/SerializerTestUtils.java b/core-api/src/test/java/com/optimizely/ab/event/internal/serializer/SerializerTestUtils.java
@@ -73,6 +73,7 @@ static Impression generateImpression() {
         impression.setDecision(decision);
         impression.setUserFeatures(userFeatures);
         impression.setClientVersion("0.1.1");
+        impression.setAnonymizeIP(true);
 
         return impression;
     }
@@ -91,6 +92,7 @@ static Conversion generateConversion() {
         conversion.setEventFeatures(eventFeatures);
         conversion.setIsGlobalHoldback(isGlobalHoldback);
         conversion.setClientVersion("0.1.1");
+        conversion.setAnonymizeIP(true);
 
         return conversion;
     }
diff --git a/core-api/src/test/resources/config/valid-project-config-v3.json b/core-api/src/test/resources/config/valid-project-config-v3.json
@@ -3,6 +3,7 @@
   "projectId": "1234",
   "version": "3",
   "revision": "42",
+  "anonymizeIP": true,
   "experiments": [
     {
       "id": "223",
diff --git a/core-api/src/test/resources/serializer/conversion.json b/core-api/src/test/resources/serializer/conversion.json
@@ -33,6 +33,7 @@
   ],
   "eventFeatures": [],
   "isGlobalHoldback": false,
+  "anonymizeIP": true,
   "clientEngine": "java-sdk",
   "clientVersion": "0.1.1"
 }
diff --git a/core-api/src/test/resources/serializer/impression.json b/core-api/src/test/resources/serializer/impression.json
@@ -2,6 +2,7 @@
   "visitorId": "testvisitor",
   "timestamp": 12345,
   "isGlobalHoldback": false,
+  "anonymizeIP": true,
   "projectId": "1",
   "decision": {
     "variationId": "4",

Original file line number	Diff line number	Diff line change
`@@ -72,14 +72,17 @@ public ProjectConfig deserialize(JsonElement json, Type typeOfT, JsonDeserializa`
`72`	`72`	`List<Audience> audiences =`
`73`	`73`	`context.deserialize(jsonObject.get("audiences").getAsJsonArray(), audienceType);`
`74`	`74`
	`75`	`+ boolean anonymizeIP = false;`
`75`	`76`	`// live variables should be null if using V1`
`76`	`77`	`List<LiveVariable> liveVariables = null;`
`77`	`78`	`if (version.equals(ProjectConfig.Version.V3.toString())) {`
`78`	`79`	`Type liveVariablesType = new TypeToken<List<LiveVariable>>() {}.getType();`
`79`	`80`	`liveVariables = context.deserialize(jsonObject.getAsJsonArray("variables"), liveVariablesType);`
	`81`	`+`
	`82`	`+ anonymizeIP = jsonObject.get("anonymizeIP").getAsBoolean();`
`80`	`83`	`}`
`81`	`84`
`82`	`85`	`return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,`
`83`		`- audiences, liveVariables);`
	`86`	`+ audiences, anonymizeIP, liveVariables);`
`84`	`87`	`}`
`85`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,13 +68,15 @@ public ProjectConfig deserialize(JsonParser parser, DeserializationContext conte`
`68`	`68`	`List<Audience> audiences = mapper.readValue(node.get("audiences").toString(),`
`69`	`69`	`new TypeReference<List<Audience>>() {});`
`70`	`70`
	`71`	`+ boolean anonymizeIP = false;`
`71`	`72`	`List<LiveVariable> liveVariables = null;`
`72`	`73`	`if (version.equals(ProjectConfig.Version.V3.toString())) {`
`73`	`74`	`liveVariables = mapper.readValue(node.get("variables").toString(),`
`74`	`75`	`new TypeReference<List<LiveVariable>>() {});`
	`76`	`+ anonymizeIP = node.get("anonymizeIP").asBoolean();`
`75`	`77`	`}`
`76`	`78`
`77`	`79`	`return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,`
`78`		`- audiences, liveVariables);`
	`80`	`+ audiences, anonymizeIP, liveVariables);`
`79`	`81`	`}`
`80`	`82`	`}`