Merge pull request #528 from splitio/imp-toggle-rename-field

chillaq · web-flow · commit baa91fb917c8 · 2025-01-02T12:37:35.000-08:00
renamed trackImpressions field
diff --git a/client/src/main/java/io/split/client/api/SplitView.java b/client/src/main/java/io/split/client/api/SplitView.java
@@ -26,7 +26,7 @@ public class SplitView {
     public Map<String, String> configs;
     public List<String> sets;
     public String defaultTreatment;
-    public boolean trackImpressions;
+    public boolean impressionsDisabled;
 
     public static SplitView fromParsedSplit(ParsedSplit parsedSplit) {
         SplitView splitView = new SplitView();
@@ -47,7 +47,7 @@ public static SplitView fromParsedSplit(ParsedSplit parsedSplit) {
 
         splitView.treatments = new ArrayList<String>(treatments);
         splitView.configs = parsedSplit.configurations() == null? Collections.<String, String>emptyMap() : parsedSplit.configurations() ;
-        splitView.trackImpressions = parsedSplit.trackImpressions();
+        splitView.impressionsDisabled = parsedSplit.impressionsDisabled();
 
         return splitView;
     }
diff --git a/client/src/main/java/io/split/client/dtos/DecoratedImpression.java b/client/src/main/java/io/split/client/dtos/DecoratedImpression.java
@@ -4,15 +4,15 @@
 
 public class DecoratedImpression {
     private Impression impression;
-    private boolean track;
+    private boolean disabled;
 
-    public DecoratedImpression(Impression impression, boolean track) {
+    public DecoratedImpression(Impression impression, boolean disabled) {
         this.impression = impression;
-        this.track = track;
+        this.disabled = disabled;
     }
 
     public Impression impression() { return this.impression;}
 
-    public boolean track() { return this.track;}
+    public boolean disabled() { return this.disabled;}
 }
 
diff --git a/client/src/main/java/io/split/client/dtos/Split.java b/client/src/main/java/io/split/client/dtos/Split.java
@@ -18,7 +18,7 @@ public class Split {
     public int algo;
     public Map<String, String> configurations;
     public HashSet<String> sets;
-    public Boolean trackImpressions = null;
+    public Boolean impressionsDisabled = null;
 
     @Override
     public String toString() {
diff --git a/client/src/main/java/io/split/client/impressions/ImpressionsManagerImpl.java b/client/src/main/java/io/split/client/impressions/ImpressionsManagerImpl.java
@@ -132,7 +132,7 @@ public void track(List<DecoratedImpression> decoratedImpressions) {
 
         for (int i = 0; i < decoratedImpressions.size(); i++) {
             ImpressionsResult impressionsResult;
-            if (decoratedImpressions.get(i).track()) {
+            if (!decoratedImpressions.get(i).disabled()) {
                 impressionsResult = _processImpressionStrategy.process(Stream.of(
                         decoratedImpressions.get(i).impression()).collect(Collectors.toList()));
             } else {
diff --git a/client/src/main/java/io/split/engine/evaluator/EvaluatorImp.java b/client/src/main/java/io/split/engine/evaluator/EvaluatorImp.java
@@ -91,7 +91,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu
                         Labels.KILLED,
                         parsedSplit.changeNumber(),
                         config,
-                        parsedSplit.trackImpressions());
+                        parsedSplit.impressionsDisabled());
             }
 
             /*
@@ -117,7 +117,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu
                             String config = parsedSplit.configurations() != null ?
                                     parsedSplit.configurations().get(parsedSplit.defaultTreatment()) : null;
                             return new TreatmentLabelAndChangeNumber(parsedSplit.defaultTreatment(), Labels.NOT_IN_SPLIT,
-                                    parsedSplit.changeNumber(), config, parsedSplit.trackImpressions());
+                                    parsedSplit.changeNumber(), config, parsedSplit.impressionsDisabled());
                         }
 
                     }
@@ -132,7 +132,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu
                             parsedCondition.label(),
                             parsedSplit.changeNumber(),
                             config,
-                            parsedSplit.trackImpressions());
+                            parsedSplit.impressionsDisabled());
                 }
             }
 
@@ -142,7 +142,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu
                     Labels.DEFAULT_RULE,
                     parsedSplit.changeNumber(),
                     config,
-                    parsedSplit.trackImpressions());
+                    parsedSplit.impressionsDisabled());
         } catch (Exception e) {
             throw new ChangeNumberExceptionWrapper(e, parsedSplit.changeNumber());
         }
diff --git a/client/src/main/java/io/split/engine/experiments/ParsedSplit.java b/client/src/main/java/io/split/engine/experiments/ParsedSplit.java
@@ -32,7 +32,7 @@ public class ParsedSplit {
     private final int _algo;
     private final Map<String, String> _configurations;
     private final HashSet<String> _flagSets;
-    private final boolean _trackImpressions;
+    private final boolean _impressionsDisabled;
 
     public static ParsedSplit createParsedSplitForTests(
             String feature,
@@ -44,7 +44,7 @@ public static ParsedSplit createParsedSplitForTests(
             long changeNumber,
             int algo,
             HashSet<String> flagSets,
-            boolean trackImpressions
+            boolean impressionsDisabled
     ) {
         return new ParsedSplit(
                 feature,
@@ -59,7 +59,7 @@ public static ParsedSplit createParsedSplitForTests(
                 algo,
                 null,
                 flagSets,
-                trackImpressions
+                impressionsDisabled
         );
     }
 
@@ -74,7 +74,7 @@ public static ParsedSplit createParsedSplitForTests(
             int algo,
             Map<String, String> configurations,
             HashSet<String> flagSets,
-            boolean trackImpressions
+            boolean impressionsDisabled
     ) {
         return new ParsedSplit(
                 feature,
@@ -89,7 +89,7 @@ public static ParsedSplit createParsedSplitForTests(
                 algo,
                 configurations,
                 flagSets,
-                trackImpressions
+                impressionsDisabled
         );
     }
 
@@ -106,7 +106,7 @@ public ParsedSplit(
             int algo,
             Map<String, String> configurations,
             HashSet<String> flagSets,
-            boolean trackImpressions
+            boolean impressionsDisabled
     ) {
         _split = feature;
         _seed = seed;
@@ -123,7 +123,7 @@ public ParsedSplit(
         _trafficAllocationSeed = trafficAllocationSeed;
         _configurations = configurations;
         _flagSets = flagSets;
-        _trackImpressions = trackImpressions;
+        _impressionsDisabled = impressionsDisabled;
     }
 
     public String feature() {
@@ -167,8 +167,8 @@ public Map<String, String> configurations() {
         return _configurations;
     }
 
-    public boolean trackImpressions() {
-        return _trackImpressions;
+    public boolean impressionsDisabled() {
+        return _impressionsDisabled;
     }
 
     @Override
@@ -183,7 +183,7 @@ public int hashCode() {
         result = 31 * result + (int)(_changeNumber ^ (_changeNumber >>> 32));
         result = 31 * result + (_algo ^ (_algo >>> 32));
         result = 31 * result + (_configurations == null? 0 : _configurations.hashCode());
-        result = 31 * result + (_trackImpressions ? 1 : 0);
+        result = 31 * result + (_impressionsDisabled ? 1 : 0);
         return result;
     }
 
@@ -204,7 +204,7 @@ public boolean equals(Object obj) {
                 && _changeNumber == other._changeNumber
                 && _algo == other._algo
                 && _configurations == null ? other._configurations == null : _configurations.equals(other._configurations)
-                && _trackImpressions == other._trackImpressions;
+                && _impressionsDisabled == other._impressionsDisabled;
     }
 
     @Override
@@ -228,8 +228,8 @@ public String toString() {
         bldr.append(_algo);
         bldr.append(", config:");
         bldr.append(_configurations);
-        bldr.append(", trackImpressions:");
-        bldr.append(_trackImpressions);
+        bldr.append(", impressionsDisabled:");
+        bldr.append(_impressionsDisabled);
         return bldr.toString();
 
     }
diff --git a/client/src/main/java/io/split/engine/experiments/SplitParser.java b/client/src/main/java/io/split/engine/experiments/SplitParser.java
@@ -66,9 +66,9 @@ public ParsedSplit parse(Split split) {
 
     private ParsedSplit parseWithoutExceptionHandling(Split split) {
         List<ParsedCondition> parsedConditionList = Lists.newArrayList();
-        if (Objects.isNull(split.trackImpressions)) {
-            _log.debug("trackImpressions field not detected for Feature flag `" + split.name + "`, setting it to `true`.");
-            split.trackImpressions = true;
+        if (Objects.isNull(split.impressionsDisabled)) {
+            _log.debug("impressionsDisabled field not detected for Feature flag `" + split.name + "`, setting it to `false`.");
+            split.impressionsDisabled = false;
         }
         for (Condition condition : split.conditions) {
             List<Partition> partitions = condition.partitions;
@@ -95,7 +95,7 @@ private ParsedSplit parseWithoutExceptionHandling(Split split) {
                 split.algo,
                 split.configurations,
                 split.sets,
-                split.trackImpressions);
+                split.impressionsDisabled);
     }
 
     private boolean checkUnsupportedMatcherExist(List<io.split.client.dtos.Matcher> matchers) {
diff --git a/client/src/main/java/io/split/storages/memory/InMemoryCacheImp.java b/client/src/main/java/io/split/storages/memory/InMemoryCacheImp.java
@@ -131,7 +131,7 @@ public void kill(String splitName, String defaultTreatment, long changeNumber) {
                 parsedSplit.algo(),
                 parsedSplit.configurations(),
                 parsedSplit.flagSets(),
-                parsedSplit.trackImpressions()
+                parsedSplit.impressionsDisabled()
                 );
 
         _concurrentMap.put(splitName, updatedSplit);
diff --git a/client/src/test/java/io/split/client/SplitManagerImplTest.java b/client/src/test/java/io/split/client/SplitManagerImplTest.java
@@ -65,7 +65,7 @@ public void splitCallWithExistentSplit() {
         String existent = "existent";
 
         SplitCacheConsumer splitCacheConsumer = mock(SplitCacheConsumer.class);
-        ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off", Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, new HashSet<>(), true);
+        ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off", Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, new HashSet<>(), false);
         when(splitCacheConsumer.get(existent)).thenReturn(response);
 
         SplitManagerImpl splitManager = new SplitManagerImpl(splitCacheConsumer,
@@ -91,7 +91,7 @@ public void splitCallWithExistentSplitAndConfigs() {
         Map<String, String> configurations = new HashMap<>();
         configurations.put(Treatments.OFF, "{\"size\" : 30}");
 
-        ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off", Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, configurations, new HashSet<>(), true);
+        ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off", Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, configurations, new HashSet<>(), false);
         when(splitCacheConsumer.get(existent)).thenReturn(response);
 
         SplitManagerImpl splitManager = new SplitManagerImpl(splitCacheConsumer,
@@ -127,7 +127,7 @@ public void splitsCallWithSplit() {
         List<ParsedSplit> parsedSplits = Lists.newArrayList();
         SDKReadinessGates gates = mock(SDKReadinessGates.class);
         when(gates.isSDKReady()).thenReturn(false);
-        ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off", Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, new HashSet<>(), true);
+        ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off", Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, new HashSet<>(), false);
         parsedSplits.add(response);
 
         when(splitCacheConsumer.getAll()).thenReturn(parsedSplits);
@@ -202,7 +202,7 @@ public void splitCallWithExistentSets() {
         String existent = "existent";
         SplitCacheConsumer splitCacheConsumer = mock(SplitCacheConsumer.class);
         ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off",
-                Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, new HashSet<>(Arrays.asList("set1", "set2", "set3")), true);
+                Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, new HashSet<>(Arrays.asList("set1", "set2", "set3")), false);
         when(splitCacheConsumer.get(existent)).thenReturn(response);
 
         SplitManagerImpl splitManager = new SplitManagerImpl(splitCacheConsumer,
@@ -217,7 +217,7 @@ public void splitCallWithEmptySets() {
         String existent = "existent";
         SplitCacheConsumer splitCacheConsumer = mock(SplitCacheConsumer.class);
         ParsedSplit response = ParsedSplit.createParsedSplitForTests("FeatureName", 123, true, "off",
-                Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, null, true);
+                Lists.newArrayList(getTestCondition("off")), "traffic", 456L, 1, null, false);
         when(splitCacheConsumer.get(existent)).thenReturn(response);
 
         SplitManagerImpl splitManager = new SplitManagerImpl(splitCacheConsumer,
@@ -246,10 +246,10 @@ public void ImpressionToggleParseTest() throws IOException {
                 mock(SDKReadinessGates.class), TELEMETRY_STORAGE);
 
         SplitView splitView = splitManager.split("without_impression_toggle");
-        assertTrue(splitView.trackImpressions);
+        assertFalse(splitView.impressionsDisabled);
         splitView = splitManager.split("impression_toggle_on");
-        assertTrue(splitView.trackImpressions);
+        assertFalse(splitView.impressionsDisabled);
         splitView = splitManager.split("impression_toggle_off");
-        assertFalse(splitView.trackImpressions);
+        assertTrue(splitView.impressionsDisabled);
     }
 }
diff --git a/client/src/test/java/io/split/client/impressions/ImpressionsManagerImplTest.java b/client/src/test/java/io/split/client/impressions/ImpressionsManagerImplTest.java
diff --git a/client/src/test/java/io/split/engine/experiments/SplitParserTest.java b/client/src/test/java/io/split/engine/experiments/SplitParserTest.java
diff --git a/client/src/test/resources/splits_imp_toggle.json b/client/src/test/resources/splits_imp_toggle.json

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu`
`91`	`91`	`Labels.KILLED,`
`92`	`92`	`parsedSplit.changeNumber(),`
`93`	`93`	`config,`
`94`		`- parsedSplit.trackImpressions());`
	`94`	`+ parsedSplit.impressionsDisabled());`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/*`
`@@ -117,7 +117,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu`
`117`	`117`	`String config = parsedSplit.configurations() != null ?`
`118`	`118`	`parsedSplit.configurations().get(parsedSplit.defaultTreatment()) : null;`
`119`	`119`	`return new TreatmentLabelAndChangeNumber(parsedSplit.defaultTreatment(), Labels.NOT_IN_SPLIT,`
`120`		`- parsedSplit.changeNumber(), config, parsedSplit.trackImpressions());`
	`120`	`+ parsedSplit.changeNumber(), config, parsedSplit.impressionsDisabled());`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`}`
`@@ -132,7 +132,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu`
`132`	`132`	`parsedCondition.label(),`
`133`	`133`	`parsedSplit.changeNumber(),`
`134`	`134`	`config,`
`135`		`- parsedSplit.trackImpressions());`
	`135`	`+ parsedSplit.impressionsDisabled());`
`136`	`136`	`}`
`137`	`137`	`}`
`138`	`138`
`@@ -142,7 +142,7 @@ private TreatmentLabelAndChangeNumber getTreatment(String matchingKey, String bu`
`142`	`142`	`Labels.DEFAULT_RULE,`
`143`	`143`	`parsedSplit.changeNumber(),`
`144`	`144`	`config,`
`145`		`- parsedSplit.trackImpressions());`
	`145`	`+ parsedSplit.impressionsDisabled());`
`146`	`146`	`} catch (Exception e) {`
`147`	`147`	`throw new ChangeNumberExceptionWrapper(e, parsedSplit.changeNumber());`
`148`	`148`	`}`