prepare 4.4.0 release (#140)

Author: eli-darkly

src/main/java/com/launchdarkly/client/FeatureFlagsState.java

@@ -33,16 +33,16 @@ public class FeatureFlagsState {
   static class FlagMetadata {
     final Integer variation;
     final EvaluationReason reason;
-    final int version;
-    final boolean trackEvents;
+    final Integer version;
+    final Boolean trackEvents;
     final Long debugEventsUntilDate;
 
-    FlagMetadata(Integer variation, EvaluationReason reason, int version, boolean trackEvents,
+    FlagMetadata(Integer variation, EvaluationReason reason, Integer version, boolean trackEvents,
         Long debugEventsUntilDate) {
       this.variation = variation;
       this.reason = reason;
       this.version = version;
-      this.trackEvents = trackEvents;
+      this.trackEvents = trackEvents ? Boolean.TRUE : null;
       this.debugEventsUntilDate = debugEventsUntilDate;
     }
 
@@ -51,8 +51,8 @@ public boolean equals(Object other) {
       if (other instanceof FlagMetadata) {
         FlagMetadata o = (FlagMetadata)other;
         return Objects.equal(variation, o.variation) &&
-            version == o.version &&
-            trackEvents == o.trackEvents &&
+            Objects.equal(version, o.version) &&
+            Objects.equal(trackEvents, o.trackEvents) &&
             Objects.equal(debugEventsUntilDate, o.debugEventsUntilDate);
       }
       return false;
@@ -131,10 +131,12 @@ static class Builder {
     private Map<String, JsonElement> flagValues = new HashMap<>();
     private Map<String, FlagMetadata> flagMetadata = new HashMap<>();
     private final boolean saveReasons;
+    private final boolean detailsOnlyForTrackedFlags;
     private boolean valid = true;
 
     Builder(FlagsStateOption... options) {
       saveReasons = FlagsStateOption.hasOption(options, FlagsStateOption.WITH_REASONS);
+      detailsOnlyForTrackedFlags = FlagsStateOption.hasOption(options, FlagsStateOption.DETAILS_ONLY_FOR_TRACKED_FLAGS);
     }
 
     Builder valid(boolean valid) {
@@ -144,9 +146,14 @@ Builder valid(boolean valid) {
 
     Builder addFlag(FeatureFlag flag, EvaluationDetail<JsonElement> eval) {
       flagValues.put(flag.getKey(), eval.getValue());
+      final boolean flagIsTracked = flag.isTrackEvents() ||
+          (flag.getDebugEventsUntilDate() != null && flag.getDebugEventsUntilDate() > System.currentTimeMillis());
+      final boolean wantDetails = !detailsOnlyForTrackedFlags || flagIsTracked;
       FlagMetadata data = new FlagMetadata(eval.getVariationIndex(),
-          saveReasons ? eval.getReason() : null,
-          flag.getVersion(), flag.isTrackEvents(), flag.getDebugEventsUntilDate());
+          (saveReasons && wantDetails) ? eval.getReason() : null,
+          wantDetails ? flag.getVersion() : null,
+          flag.isTrackEvents(),
+          flag.getDebugEventsUntilDate());
       flagMetadata.put(flag.getKey(), data);
       return this;
     }

src/main/java/com/launchdarkly/client/FlagsStateOption.java

@@ -27,6 +27,14 @@ public String toString() {
    */
   public static final FlagsStateOption WITH_REASONS = new FlagsStateOption("WITH_REASONS");
 
+  /**
+   * Specifies that any flag metadata that is normally only used for event generation - such as flag versions and
+   * evaluation reasons - should be omitted for any flag that does not have event tracking or debugging turned on.
+   * This reduces the size of the JSON data if you are passing the flag state to the front end.
+   * @since 4.4.0
+   */
+  public static final FlagsStateOption DETAILS_ONLY_FOR_TRACKED_FLAGS = new FlagsStateOption("DETAILS_ONLY_FOR_TRACKED_FLAGS");
+  
   static boolean hasOption(FlagsStateOption[] options, FlagsStateOption option) {
     for (FlagsStateOption o: options) {
       if (o == option) {

src/test/java/com/launchdarkly/client/FeatureFlagsStateTest.java

@@ -89,7 +89,7 @@ public void canConvertToJson() {
     String json = "{\"key1\":\"value1\",\"key2\":\"value2\"," +
         "\"$flagsState\":{" +
           "\"key1\":{" +
-            "\"variation\":0,\"version\":100,\"reason\":{\"kind\":\"OFF\"},\"trackEvents\":false" +
+            "\"variation\":0,\"version\":100,\"reason\":{\"kind\":\"OFF\"}" +  // note, "trackEvents: false" is omitted
           "},\"key2\":{" +
             "\"variation\":1,\"version\":200,\"reason\":{\"kind\":\"FALLTHROUGH\"},\"trackEvents\":true,\"debugEventsUntilDate\":1000" +
           "}" +

src/test/java/com/launchdarkly/client/LDClientEvaluationTest.java

@@ -293,7 +293,7 @@ public void allFlagsStateReturnsState() throws Exception {
     String json = "{\"key1\":\"value1\",\"key2\":\"value2\"," +
         "\"$flagsState\":{" +
           "\"key1\":{" +
-            "\"variation\":0,\"version\":100,\"trackEvents\":false" +
+            "\"variation\":0,\"version\":100" +
           "},\"key2\":{" +
             "\"variation\":1,\"version\":200,\"trackEvents\":true,\"debugEventsUntilDate\":1000" +
           "}" +
@@ -350,7 +350,7 @@ public void allFlagsStateReturnsStateWithReasons() {
     String json = "{\"key1\":\"value1\",\"key2\":\"value2\"," +
         "\"$flagsState\":{" +
           "\"key1\":{" +
-            "\"variation\":0,\"version\":100,\"reason\":{\"kind\":\"OFF\"},\"trackEvents\":false" +
+            "\"variation\":0,\"version\":100,\"reason\":{\"kind\":\"OFF\"}" +
           "},\"key2\":{" +
             "\"variation\":1,\"version\":200,\"reason\":{\"kind\":\"FALLTHROUGH\"},\"trackEvents\":true,\"debugEventsUntilDate\":1000" +
           "}" +
@@ -361,6 +361,54 @@ public void allFlagsStateReturnsStateWithReasons() {
     assertEquals(expected, gson.toJsonTree(state));
   }
 
+  @Test
+  public void allFlagsStateCanOmitDetailsForUntrackedFlags() {
+    long futureTime = System.currentTimeMillis() + 1000000;
+    FeatureFlag flag1 = new FeatureFlagBuilder("key1")
+        .version(100)
+        .trackEvents(false)
+        .on(false)
+        .offVariation(0)
+        .variations(js("value1"))
+        .build();
+    FeatureFlag flag2 = new FeatureFlagBuilder("key2")
+        .version(200)
+        .trackEvents(true)
+        .on(true)
+        .fallthrough(fallthroughVariation(1))
+        .variations(js("off"), js("value2"))
+        .build();
+    FeatureFlag flag3 = new FeatureFlagBuilder("key3")
+        .version(300)
+        .trackEvents(false)
+        .debugEventsUntilDate(futureTime)  // event tracking is turned on temporarily even though trackEvents is false 
+        .on(false)
+        .offVariation(0)
+        .variations(js("value3"))
+        .build();
+    featureStore.upsert(FEATURES, flag1);
+    featureStore.upsert(FEATURES, flag2);
+    featureStore.upsert(FEATURES, flag3);
+
+    FeatureFlagsState state = client.allFlagsState(user, FlagsStateOption.WITH_REASONS, FlagsStateOption.DETAILS_ONLY_FOR_TRACKED_FLAGS);
+    assertTrue(state.isValid());
+    
+    String json = "{\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":\"value3\"," +
+        "\"$flagsState\":{" +
+          "\"key1\":{" +
+            "\"variation\":0" +  // note, version and reason are omitted, and so is trackEvents: false
+          "},\"key2\":{" +
+            "\"variation\":1,\"version\":200,\"reason\":{\"kind\":\"FALLTHROUGH\"},\"trackEvents\":true" +
+          "},\"key3\":{" +
+            "\"variation\":0,\"version\":300,\"reason\":{\"kind\":\"OFF\"},\"debugEventsUntilDate\":" + futureTime +
+          "}" +
+        "}," +
+        "\"$valid\":true" +
+      "}";
+    JsonElement expected = gson.fromJson(json, JsonElement.class);
+    assertEquals(expected, gson.toJsonTree(state));    
+  }
+  
   @Test
   public void allFlagsStateReturnsEmptyStateForNullUser() throws Exception {
     featureStore.upsert(FEATURES, flagWithValue("key", js("value")));