Add support for event tag validation.

Author: Mike Davis

core-api/src/test/java/com/optimizely/ab/EventHandlerRule.java

@@ -47,6 +47,8 @@
  */
 public class EventHandlerRule implements EventHandler, TestRule {
 
+    private static final String IMPRESSION_EVENT_NAME = "campaign_activated";
+
     private LinkedList<CanonicalEvent> actualEvents;
 
     @Override
@@ -76,25 +78,29 @@ private void verify() {
         assertTrue(actualEvents.isEmpty());
     }
 
-    public void expectImpression(String experientId, String variationId, String userId) throws Exception {
+    public void expectImpression(String experientId, String variationId, String userId) {
         expectImpression(experientId, variationId, userId, Collections.emptyMap());
     }
 
-    public void expectImpression(String experientId, String variationId, String userId, Map<String, ?> attributes) throws Exception {
-        CanonicalEvent expectedEvent = new CanonicalEvent(experientId, variationId, "campaign_activated", userId, attributes);
-        verify(expectedEvent);
+    public void expectImpression(String experientId, String variationId, String userId, Map<String, ?> attributes) {
+        verify(experientId, variationId, IMPRESSION_EVENT_NAME, userId, attributes, null);
+    }
+
+    public void expectConversion(String eventName, String userId) {
+        expectConversion(eventName, userId, Collections.emptyMap());
     }
 
-    public void expectConversion(String eventName, String userId) throws Exception {
-        expectConversion(null, null, eventName, userId, Collections.emptyMap());
+    public void expectConversion(String eventName, String userId, Map<String, ?> attributes) {
+        expectConversion(eventName, userId, attributes, Collections.emptyMap());
     }
 
-    public void expectConversion(String eventName, String userId, Map<String, ?> attributes) throws Exception {
-        expectConversion(null, null, eventName, userId, attributes);
+    public void expectConversion(String eventName, String userId, Map<String, ?> attributes, Map<String, ?> tags) {
+        verify(null, null, eventName, userId, attributes, tags);
     }
 
-    public void expectConversion(String experientId, String variationId, String eventName, String userId, Map<String, ?> attributes) throws Exception {
-        CanonicalEvent expectedEvent = new CanonicalEvent(experientId, variationId, eventName, userId, attributes);
+    public void verify(String experientId, String variationId, String eventName, String userId,
+                  Map<String, ?> attributes, Map<String, ?> tags) {
+        CanonicalEvent expectedEvent = new CanonicalEvent(experientId, variationId, eventName, userId, attributes, tags);
         verify(expectedEvent);
     }
 
@@ -108,7 +114,7 @@ public void verify(CanonicalEvent expected) {
     }
 
     @Override
-    public void dispatchEvent(LogEvent logEvent) throws Exception {
+    public void dispatchEvent(LogEvent logEvent) {
         List<Visitor> visitors = logEvent.getEventBatch().getVisitors();
 
         if (visitors == null) {
@@ -135,7 +141,8 @@ public void dispatchEvent(LogEvent logEvent) throws Exception {
                             visitor.getVisitorId(),
                             visitor.getAttributes().stream()
                                 .filter(attribute -> !attribute.getKey().startsWith(RESERVED_ATTRIBUTE_PREFIX))
-                                .collect(Collectors.toMap(Attribute::getKey, Attribute::getValue))
+                                .collect(Collectors.toMap(Attribute::getKey, Attribute::getValue)),
+                            event.getTags()
                         );
 
                         actualEvents.add(actual);
@@ -151,13 +158,16 @@ private static class CanonicalEvent {
         private String eventName;
         private String visitorId;
         private Map<String, ?> attributes;
+        private Map<String, ?> tags;
 
-        public CanonicalEvent(String experimentId, String variationId, String eventName, String visitorId, Map<String, ?> attributes) {
+        public CanonicalEvent(String experimentId, String variationId, String eventName,
+                              String visitorId, Map<String, ?> attributes, Map<String, ?> tags) {
             this.experimentId = experimentId;
             this.variationId = variationId;
             this.eventName = eventName;
             this.visitorId = visitorId;
             this.attributes = attributes;
+            this.tags = tags;
         }
 
         @Override
@@ -169,12 +179,13 @@ public boolean equals(Object o) {
                 Objects.equals(variationId, that.variationId) &&
                 Objects.equals(eventName, that.eventName) &&
                 Objects.equals(visitorId, that.visitorId) &&
-                Objects.equals(attributes, that.attributes);
+                Objects.equals(attributes, that.attributes) &&
+                Objects.equals(tags, that.tags);
         }
 
         @Override
         public int hashCode() {
-            return Objects.hash(experimentId, variationId, eventName, visitorId, attributes);
+            return Objects.hash(experimentId, variationId, eventName, visitorId, attributes, tags);
         }
 
         @Override
@@ -185,6 +196,7 @@ public String toString() {
                 .add("eventName='" + eventName + "'")
                 .add("visitorId='" + visitorId + "'")
                 .add("attributes=" + attributes)
+                .add("tags=" + tags)
                 .toString();
         }
     }

core-api/src/test/java/com/optimizely/ab/OptimizelyTest.java

@@ -1131,7 +1131,7 @@ public void trackEventWithEventTags() throws Exception {
             validProjectConfig.getEventNameMapping().get(EVENT_BASIC_EVENT_KEY) :
             validProjectConfig.getEventTypes().get(0);
 
-        Map<String, Object> eventTags = new HashMap<String, Object>();
+        Map<String, Object> eventTags = new HashMap<>();
         eventTags.put("int_param", 123);
         eventTags.put("string_param", "123");
         eventTags.put("boolean_param", false);
@@ -1143,7 +1143,7 @@ public void trackEventWithEventTags() throws Exception {
 
         // call track
         optimizely.track(eventType.getKey(), genericUserId, Collections.emptyMap(), eventTags);
-        eventHandler.expectConversion(eventType.getKey(), genericUserId);
+        eventHandler.expectConversion(eventType.getKey(), genericUserId, Collections.emptyMap(), eventTags);
 
         // TODO capture event tags.
     }
@@ -1168,7 +1168,7 @@ public void trackEventWithNullEventTags() throws Exception {
 
         // call track
         optimizely.track(eventType.getKey(), genericUserId, Collections.emptyMap(), null);
-        eventHandler.expectConversion(eventType.getKey(), genericUserId);
+        eventHandler.expectConversion(eventType.getKey(), genericUserId, Collections.emptyMap(), null);
 
         // TODO capture event tags.
     }