Merge pull request #542 from splitio/feature/impression-properties

Feature/impression properties

Author: chillaq

client/src/main/java/io/split/client/SplitClient.java

@@ -124,7 +124,7 @@ public class SplitFactoryImpl implements SplitFactory {
     private static final org.slf4j.Logger _log = LoggerFactory.getLogger(SplitFactoryImpl.class);
     private static final String LEGACY_LOG_MESSAGE = "The sdk initialize in localhost mode using Legacy file. The splitFile or "
             +
-            "inputStream doesn't add it to the config.";
+            "inputStream are not added to the config.";
     private final static long SSE_CONNECT_TIMEOUT = 30000;
     private final static long SSE_SOCKET_TIMEOUT = 70000;
 

client/src/main/java/io/split/client/SplitClientImpl.java

@@ -0,0 +1,14 @@
+package io.split.client.dtos;
+
+import java.util.Map;
+
+public class EvaluationOptions {
+    private Map<String, Object> _properties;
+
+    public EvaluationOptions(Map<String, Object> properties) {
+        _properties = properties;
+    }
+    public Map<String, Object> getProperties() {
+        return _properties;
+    }
+}

client/src/main/java/io/split/client/SplitFactoryImpl.java

@@ -15,6 +15,7 @@ public class KeyImpression {
     /* package private */ static final String FIELD_TIME = "m";
     /* package private */ static final String FIELD_CHANGE_NUMBER = "c";
     /* package private */ static final String FIELD_PREVIOUS_TIME = "pt";
+    /* package private */ static final String FIELD_PROPERTIES = "properties";
 
     public transient String feature; // Non-serializable
 
@@ -39,6 +40,9 @@ public class KeyImpression {
     @SerializedName(FIELD_PREVIOUS_TIME)
     public Long previousTime;
 
+    @SerializedName(FIELD_PROPERTIES)
+    public String properties;
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
@@ -50,6 +54,7 @@ public boolean equals(Object o) {
         if (!Objects.equals(feature, that.feature)) return false;
         if (!keyName.equals(that.keyName)) return false;
         if (!treatment.equals(that.treatment)) return false;
+        if (properties != null && !properties.equals(that.properties)) return false;
 
         if (bucketingKey == null) {
             return that.bucketingKey == null;
@@ -78,6 +83,7 @@ public static KeyImpression fromImpression(Impression i) {
         ki.treatment = i.treatment();
         ki.label = i.appliedRule();
         ki.previousTime = i.pt();
+        ki.properties = i.properties();
         return ki;
     }
 }

client/src/main/java/io/split/client/dtos/EvaluationOptions.java

@@ -16,10 +16,11 @@ public class Impression {
     private final Long _changeNumber;
     private Long _pt;
     private final Map<String, Object> _attributes;
+    private final String _properties;
 
 
     public Impression(String key, String bucketingKey, String featureFlag, String treatment, long time, String appliedRule,
-                      Long changeNumber, Map<String, Object> atributes) {
+                      Long changeNumber, Map<String, Object> atributes, String properties) {
         _key = key;
         _bucketingKey = bucketingKey;
         _split = featureFlag;
@@ -28,6 +29,7 @@ public Impression(String key, String bucketingKey, String featureFlag, String tr
         _appliedRule = appliedRule;
         _changeNumber = changeNumber;
         _attributes = atributes;
+        _properties = properties;
     }
 
     public String key() {
@@ -67,4 +69,8 @@ public Long pt() {
     }
 
     public Impression withPreviousTime(Long pt) { _pt = pt; return this; }
+
+    public String properties() {
+        return _properties;
+    }
 }

client/src/main/java/io/split/client/dtos/KeyImpression.java

@@ -19,6 +19,9 @@ public ProcessImpressionDebug(boolean listenerEnabled, ImpressionObserver impres
     @Override
     public ImpressionsResult process(List<Impression> impressions) {
         for(Impression impression : impressions) {
+            if (impression.properties() != null) {
+                continue;
+            }
             impression.withPreviousTime(_impressionObserver.testAndSet(impression));
         }
         List<Impression> impressionForListener =  this._listenerEnabled ? impressions : null;

client/src/main/java/io/split/client/impressions/Impression.java

@@ -32,12 +32,14 @@ public ProcessImpressionOptimized(boolean listenerEnabled, ImpressionObserver im
     public ImpressionsResult process(List<Impression> impressions) {
         List<Impression> impressionsToQueue = new ArrayList<>();
         for(Impression impression : impressions) {
-            impression = impression.withPreviousTime(_impressionObserver.testAndSet(impression));
-            if(!Objects.isNull(impression.pt()) && impression.pt() != 0){
-                _impressionCounter.inc(impression.split(), impression.time(), 1);
-            }
-            if(shouldntQueueImpression(impression)) {
-                continue;
+            if (impression.properties() == null) {
+                impression = impression.withPreviousTime(_impressionObserver.testAndSet(impression));
+                if (!Objects.isNull(impression.pt()) && impression.pt() != 0) {
+                    _impressionCounter.inc(impression.split(), impression.time(), 1);
+                }
+                if (shouldntQueueImpression(impression)) {
+                    continue;
+                }
             }
             impressionsToQueue.add(impression);
         }

client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionDebug.java

@@ -0,0 +1,21 @@
+package io.split.inputValidation;
+
+import java.util.Map;
+
+public class ImpressionPropertiesValidator {
+    ImpressionPropertiesValidator() {
+        throw new IllegalStateException("Utility class");
+    }
+
+    public static ImpressionPropertiesValidatorResult propertiesAreValid(Map<String, Object> properties) {
+        EventsValidator.EventValidatorResult result = EventsValidator.propertiesAreValid(properties);
+        return new ImpressionPropertiesValidatorResult(result.getSuccess(), result.getEventSize(), result.getValue());
+    }
+
+    public static class ImpressionPropertiesValidatorResult extends EventsValidator.EventValidatorResult {
+        public ImpressionPropertiesValidatorResult(boolean success, int eventSize, Map<String, Object> value) {
+            super(success, eventSize, value);
+        }
+    }
+}
+

client/src/main/java/io/split/client/impressions/strategy/ProcessImpressionOptimized.java

@@ -565,7 +565,7 @@ public void attributesWork() {
         );
 
         assertEquals("on", client.getTreatment("adil@codigo.com", test));
-        assertEquals("on", client.getTreatment("adil@codigo.com", test, null));
+        assertEquals("on", client.getTreatment("adil@codigo.com", test, new HashMap<>()));
         assertEquals("on", client.getTreatment("adil@codigo.com", test, ImmutableMap.<String, Object>of()));
         assertEquals("on", client.getTreatment("pato@codigo.com", test, ImmutableMap.<String, Object>of("age", 10)));
         assertEquals("off", client.getTreatment("pato@codigo.com", test, ImmutableMap.<String, Object>of("age", 9)));
@@ -599,7 +599,7 @@ public void attributesWork2() {
         );
 
         assertEquals("off", client.getTreatment("adil@codigo.com", test));
-        assertEquals("off", client.getTreatment("adil@codigo.com", test, null));
+        assertEquals("off", client.getTreatment("adil@codigo.com", test, new HashMap<>()));
         assertEquals("off", client.getTreatment("adil@codigo.com", test, ImmutableMap.<String, Object>of()));
 
         assertEquals("off", client.getTreatment("pato@codigo.com", test, ImmutableMap.<String, Object>of("age", 10)));
@@ -634,7 +634,7 @@ public void attributesGreaterThanNegativeNumber() {
         );
 
         assertEquals("off", client.getTreatment("adil@codigo.com", test));
-        assertEquals("off", client.getTreatment("adil@codigo.com", test, null));
+        assertEquals("off", client.getTreatment("adil@codigo.com", test, new HashMap<>()));
         assertEquals("off", client.getTreatment("adil@codigo.com", test, ImmutableMap.<String, Object>of()));
         assertEquals("off", client.getTreatment("pato@codigo.com", test, ImmutableMap.<String, Object>of("age", 10)));
         assertEquals("on", client.getTreatment("pato@codigo.com", test, ImmutableMap.<String, Object>of("age", -20)));
@@ -671,7 +671,7 @@ public void attributesForSets() {
         );
 
         assertEquals("off", client.getTreatment("adil@codigo.com", test));
-        assertEquals("off", client.getTreatment("adil@codigo.com", test, null));
+        assertEquals("off", client.getTreatment("adil@codigo.com", test, new HashMap<>()));
 
         assertEquals("off", client.getTreatment("adil@codigo.com", test, ImmutableMap.<String, Object>of()));
         assertEquals("off", client.getTreatment("pato@codigo.com", test, ImmutableMap.<String, Object>of("products", Lists.newArrayList())));
@@ -1486,6 +1486,7 @@ public void worksAndHasConfigByFlagSetTryKetTreatmentWithKey() {
             assertEquals("on", client.getTreatmentsByFlagSet(randomKey, "set1", new HashMap<>()).get(test));
             assertEquals("{\"size\" : 30}", client.getTreatmentsWithConfigByFlagSet(key, "set1", attributes).get(test).config());
         }
+        assertEquals("on", client.getTreatmentsByFlagSet("randomKey", "set1").get(test));
     }
 
     @Test
@@ -1894,11 +1895,13 @@ public void testTreatmentsByFlagSet() {
         Map<String, String> getTreatmentResult;
         for (int i = 0; i < numKeys; i++) {
             String randomKey = RandomStringUtils.random(10);
-            getTreatmentResult = client.getTreatmentsByFlagSet(randomKey, "set1", null);
+            getTreatmentResult = client.getTreatmentsByFlagSet(randomKey, "set1", new HashMap<>());
             assertEquals("on", getTreatmentResult.get(test));
         }
         verify(splitCacheConsumer, times(numKeys)).fetchMany(new ArrayList<>(Arrays.asList(test)));
         verify(TELEMETRY_STORAGE, times(5)).recordLatency(Mockito.anyObject(), Mockito.anyLong());
+        getTreatmentResult = client.getTreatmentsByFlagSet("randomKey", "set1");
+        assertEquals("on", getTreatmentResult.get(test));
     }
 
     @Test
@@ -1927,7 +1930,7 @@ public void testTreatmentsByFlagSetInvalid() {
                 new EvaluatorImp(splitCacheConsumer, segmentCacheConsumer), TELEMETRY_STORAGE, TELEMETRY_STORAGE,
                 flagSetsFilter
         );
-        assertTrue(client.getTreatmentsByFlagSet(RandomStringUtils.random(10), "", null).isEmpty());
+        assertTrue(client.getTreatmentsByFlagSet(RandomStringUtils.random(10), "", new HashMap<>()).isEmpty());
     }
 
     @Test
@@ -1974,12 +1977,15 @@ public void testTreatmentsByFlagSets() {
         Map<String, String> getTreatmentResult;
         for (int i = 0; i < numKeys; i++) {
             String randomKey = RandomStringUtils.random(10);
-            getTreatmentResult = client.getTreatmentsByFlagSets(randomKey, Arrays.asList("set1", "set3"), null);
+            getTreatmentResult = client.getTreatmentsByFlagSets(randomKey, Arrays.asList("set1", "set3"), new HashMap<>());
             assertEquals("on", getTreatmentResult.get(test));
             assertEquals("on", getTreatmentResult.get(test2));
         }
         verify(splitCacheConsumer, times(numKeys)).fetchMany(new ArrayList<>(Arrays.asList(test2, test)));
         verify(TELEMETRY_STORAGE, times(5)).recordLatency(Mockito.anyObject(), Mockito.anyLong());
+        getTreatmentResult = client.getTreatmentsByFlagSets("key", Arrays.asList("set1", "set3"));
+        assertEquals("on", getTreatmentResult.get(test));
+        assertEquals("on", getTreatmentResult.get(test2));
     }
 
     @Test
@@ -2030,6 +2036,12 @@ public void treatmentsWorksAndHasConfigFlagSet() {
         assertEquals("control", result.get(test2).treatment());
 
         verify(splitCacheConsumer, times(1)).fetchMany(anyList());
+
+        result = client.getTreatmentsWithConfigByFlagSet("randomKey", "set1");
+        assertEquals(2, result.size());
+        assertEquals(configurations.get("on"), result.get(test).config());
+        assertNull(result.get(test2).config());
+        assertEquals("control", result.get(test2).treatment());
     }
 
     @Test
@@ -2081,4 +2093,89 @@ public void treatmentsWorksAndHasConfigFlagSets() {
 
         verify(splitCacheConsumer, times(1)).fetchMany(anyList());
     }
+
+    @Test
+    public void impressionPropertiesTest() {
+        String test = "test1";
+
+        ParsedCondition age_equal_to_0_should_be_on = new ParsedCondition(ConditionType.ROLLOUT,
+                CombiningMatcher.of("age", new EqualToMatcher(-20, DataType.NUMBER)),
+                Lists.newArrayList(partition("on", 100)),
+                "foolabel"
+        );
+
+        List<ParsedCondition> conditions = Lists.newArrayList(age_equal_to_0_should_be_on);
+        ParsedSplit parsedSplit = ParsedSplit.createParsedSplitForTests(test, 123, false, Treatments.OFF, conditions, null, 1, 1, new HashSet<>(Arrays.asList("set")), true);
+        Map<String, ParsedSplit> parsedSplits = new HashMap<>();
+        parsedSplits.put(test, parsedSplit);
+
+        SplitCacheConsumer splitCacheConsumer = mock(SplitCacheConsumer.class);
+        SegmentCacheConsumer segmentCacheConsumer = mock(SegmentCacheConsumer.class);
+        when(splitCacheConsumer.get(test)).thenReturn(parsedSplit);
+        when(splitCacheConsumer.fetchMany(Arrays.asList(test))).thenReturn(parsedSplits);
+        Map<String, HashSet<String>> splits = new HashMap<>();
+        splits.put("set", new HashSet<>(Arrays.asList(test)));
+        when(splitCacheConsumer.getNamesByFlagSets(Arrays.asList("set"))).thenReturn(splits);
+
+        SDKReadinessGates gates = mock(SDKReadinessGates.class);
+        ImpressionsManager impressionsManager = mock(ImpressionsManager.class);
+        SplitClientImpl client = new SplitClientImpl(
+                mock(SplitFactory.class),
+                splitCacheConsumer,
+                impressionsManager,
+                NoopEventsStorageImp.create(),
+                config,
+                gates,
+                new EvaluatorImp(splitCacheConsumer, segmentCacheConsumer), TELEMETRY_STORAGE, TELEMETRY_STORAGE,
+                new FlagSetsFilterImpl(new HashSet<>())
+        );
+        Map<String, Object> attributes = ImmutableMap.<String, Object>of("age", -20, "acv", "1000000");
+        EvaluationOptions properties = new EvaluationOptions(new HashMap<String, Object>()
+        {{
+            put("prop2", "val2");
+            put("prop1", "val1");
+        }});
+        Map<String, String> result = new HashMap<>();
+        result.put(test, Treatments.ON);
+        List<String> split_names =  Arrays.asList(test);
+
+        assertEquals("on", client.getTreatment("pato@codigo.com", test, attributes, properties));
+        assertEquals("on", client.getTreatmentWithConfig("bilal1@codigo.com", test, attributes, properties).treatment());
+        assertEquals("on", client.getTreatments("bilal2@codigo.com", Arrays.asList(test), attributes, properties).get(test));
+        assertEquals("on", client.getTreatmentsWithConfig("bilal3@codigo.com", Arrays.asList(test), attributes, properties).get(test).treatment());
+        assertEquals("on", client.getTreatmentsByFlagSet("bilal4@codigo.com", "set", attributes, properties).get(test));
+        assertEquals("on", client.getTreatmentsByFlagSets("bilal5@codigo.com", Arrays.asList("set"), attributes, properties).get(test));
+        assertEquals("on", client.getTreatmentsWithConfigByFlagSet("bilal6@codigo.com", "set", attributes, properties).get(test).treatment());
+        assertEquals("on", client.getTreatmentsWithConfigByFlagSets("bilal7@codigo.com", Arrays.asList("set"), attributes, properties).get(test).treatment());
+        assertEquals("on", client.getTreatment(new Key("bilal8@codigo.com", "bilal8@codigo.com"), test, attributes, properties));
+        assertEquals("on", client.getTreatmentWithConfig(new Key("bilal9@codigo.com", "bilal9@codigo.com"), test, attributes, properties).treatment());
+        assertEquals("on", client.getTreatments(new Key("bilal10@codigo.com", "bilal10@codigo.com"), Arrays.asList(test), attributes, properties).get(test));
+        assertEquals("on", client.getTreatmentsWithConfig(new Key("bilal11@codigo.com", "bilal11@codigo.com"), Arrays.asList(test), attributes, properties).get(test).treatment());
+        assertEquals("on", client.getTreatmentsByFlagSet(new Key("bilal12@codigo.com", "bilal12@codigo.com"), "set", attributes, properties).get(test));
+        assertEquals("on", client.getTreatmentsByFlagSets(new Key("bilal13@codigo.com", "bilal13@codigo.com"), Arrays.asList("set"), attributes, properties).get(test));
+        assertEquals("on", client.getTreatmentsWithConfigByFlagSet(new Key("bilal14@codigo.com", "bilal14@codigo.com"), "set", attributes, properties).get(test).treatment());
+        assertEquals("on", client.getTreatmentsWithConfigByFlagSets(new Key("bilal15@codigo.com", "bilal15@codigo.com"), Arrays.asList("set"), attributes, properties).get(test).treatment());
+        assertEquals("off", client.getTreatment("bilal16@codigo.com", test, properties));
+        assertEquals("off", client.getTreatmentWithConfig("bilal17@codigo.com", test, properties).treatment());
+        assertEquals("off", client.getTreatments("bilal18@codigo.com", Arrays.asList(test), properties).get(test));
+        assertEquals("off", client.getTreatmentsWithConfig("bilal19@codigo.com", Arrays.asList(test), properties).get(test).treatment());
+        assertEquals("off", client.getTreatmentsByFlagSet("bilal20@codigo.com", "set", properties).get(test));
+        assertEquals("off", client.getTreatmentsByFlagSets("bilal21@codigo.com", Arrays.asList("set"), properties).get(test));
+        assertEquals("off", client.getTreatmentsWithConfigByFlagSet("bilal22@codigo.com", "set", properties).get(test).treatment());
+        assertEquals("off", client.getTreatmentsWithConfigByFlagSets("bilal23@codigo.com", Arrays.asList("set"), properties).get(test).treatment());
+
+        ArgumentCaptor<List> impressionCaptor = ArgumentCaptor.forClass(List.class);
+        verify(impressionsManager, times(24)).track(impressionCaptor.capture());
+        assertNotNull(impressionCaptor.getValue());
+
+        DecoratedImpression impression = (DecoratedImpression) impressionCaptor.getAllValues().get(0).get(0);
+        assertEquals("pato@codigo.com", impression.impression().key());
+        assertEquals("{\"prop2\":\"val2\",\"prop1\":\"val1\"}", impression.impression().properties());
+
+        for (int i=1; i<=23; i++) {
+            impression = (DecoratedImpression) impressionCaptor.getAllValues().get(i).get(0);
+            assertEquals("bilal" + i + "@codigo.com", impression.impression().key());
+            assertEquals("{\"prop2\":\"val2\",\"prop1\":\"val1\"}", impression.impression().properties());
+        }
+    }
 }