prepare 5.3.0 release (#228)

Author: LaunchDarklyCI

src/main/java/com/launchdarkly/sdk/server/integrations/FileData.java

@@ -14,6 +14,24 @@
  * @see TestData
  */
 public abstract class FileData {
+  /**
+   * Determines how duplicate feature flag or segment keys are handled.
+   *
+   * @see FileDataSourceBuilder#duplicateKeysHandling
+   * @since 5.3.0
+   */
+  public enum DuplicateKeysHandling {
+    /**
+     * Data loading will fail if keys are duplicated across files.
+     */
+    FAIL,
+    
+    /**
+     * Keys that are duplicated across files will be ignored, and the first occurrence will be used.
+     */
+    IGNORE
+  }
+  
   /**
    * Creates a {@link FileDataSourceBuilder} which you can use to configure the file data source.
    * This allows you to use local files (or classpath resources containing file data) as a source of

src/main/java/com/launchdarkly/sdk/server/integrations/FileDataSourceBuilder.java

@@ -28,6 +28,7 @@
 public final class FileDataSourceBuilder implements DataSourceFactory {
   final List<SourceInfo> sources = new ArrayList<>(); // visible for tests
   private boolean autoUpdate = false;
+  private FileData.DuplicateKeysHandling duplicateKeysHandling = FileData.DuplicateKeysHandling.FAIL;
 
   /**
    * Adds any number of source files for loading flag data, specifying each file path as a string. The files will
@@ -101,13 +102,27 @@ public FileDataSourceBuilder autoUpdate(boolean autoUpdate) {
     this.autoUpdate = autoUpdate;
     return this;
   }
+
+  /**
+   * Specifies how to handle keys that are duplicated across files.
+   * <p>
+   * By default, data loading will fail if keys are duplicated across files ({@link FileData.DuplicateKeysHandling#FAIL}).
+   * 
+   * @param duplicateKeysHandling specifies how to handle duplicate keys
+   * @return the same factory object
+   * @since 5.3.0
+   */
+  public FileDataSourceBuilder duplicateKeysHandling(FileData.DuplicateKeysHandling duplicateKeysHandling) {
+    this.duplicateKeysHandling = duplicateKeysHandling;
+    return this;
+  }
 
   /**
    * Used internally by the LaunchDarkly client.
    */
   @Override
   public DataSource createDataSource(ClientContext context, DataSourceUpdates dataSourceUpdates) {
-    return new FileDataSourceImpl(dataSourceUpdates, sources, autoUpdate);
+    return new FileDataSourceImpl(dataSourceUpdates, sources, autoUpdate, duplicateKeysHandling);
   }
 
   static abstract class SourceInfo {

src/main/java/com/launchdarkly/sdk/server/integrations/FileDataSourceImpl.java

@@ -58,12 +58,19 @@ final class FileDataSourceImpl implements DataSource {
 
   private final DataSourceUpdates dataSourceUpdates;
   private final DataLoader dataLoader;
+  private final FileData.DuplicateKeysHandling duplicateKeysHandling;
   private final AtomicBoolean inited = new AtomicBoolean(false);
   private final FileWatcher fileWatcher;
 
-  FileDataSourceImpl(DataSourceUpdates dataSourceUpdates, List<SourceInfo> sources, boolean autoUpdate) {
+  FileDataSourceImpl(
+      DataSourceUpdates dataSourceUpdates,
+      List<SourceInfo> sources,
+      boolean autoUpdate,
+      FileData.DuplicateKeysHandling duplicateKeysHandling
+      ) {
     this.dataSourceUpdates = dataSourceUpdates;
     this.dataLoader = new DataLoader(sources);
+    this.duplicateKeysHandling = duplicateKeysHandling;
 
     FileWatcher fw = null;
     if (autoUpdate) {
@@ -97,7 +104,7 @@ public Future<Void> start() {
   }
 
   private boolean reload() {
-    DataBuilder builder = new DataBuilder(); 
+    DataBuilder builder = new DataBuilder(duplicateKeysHandling); 
     try {
       dataLoader.load(builder); 
     } catch (FileDataException e) {
@@ -262,6 +269,11 @@ public void load(DataBuilder builder) throws FileDataException
    */
   static final class DataBuilder {
     private final Map<DataKind, Map<String, ItemDescriptor>> allData = new HashMap<>();
+    private final FileData.DuplicateKeysHandling duplicateKeysHandling;
+    
+    public DataBuilder(FileData.DuplicateKeysHandling duplicateKeysHandling) {
+      this.duplicateKeysHandling = duplicateKeysHandling;
+    }
 
     public FullDataSet<ItemDescriptor> build() {
       ImmutableList.Builder<Map.Entry<DataKind, KeyedItems<ItemDescriptor>>> allBuilder = ImmutableList.builder();
@@ -278,6 +290,9 @@ public void add(DataKind kind, String key, ItemDescriptor item) throws FileDataE
         allData.put(kind, items);
       }
       if (items.containsKey(key)) {
+        if (duplicateKeysHandling == FileData.DuplicateKeysHandling.IGNORE) {
+          return;
+        }
         throw new FileDataException("in " + kind.getName() + ", key \"" + key + "\" was already defined", null, null);
       }
       items.put(key, item);

src/test/java/com/launchdarkly/sdk/server/integrations/DataLoaderTest.java

@@ -1,8 +1,5 @@
 package com.launchdarkly.sdk.server.integrations;
 
-import com.google.gson.Gson;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
 import com.launchdarkly.sdk.LDValue;
 import com.launchdarkly.sdk.server.integrations.FileDataSourceImpl.DataBuilder;
 import com.launchdarkly.sdk.server.integrations.FileDataSourceImpl.DataLoader;
@@ -29,8 +26,7 @@
 
 @SuppressWarnings("javadoc")
 public class DataLoaderTest {
-  private static final Gson gson = new Gson();
-  private DataBuilder builder = new DataBuilder();
+  private DataBuilder builder = new DataBuilder(FileData.DuplicateKeysHandling.FAIL);
 
   @Test
   public void canLoadFromFilePath() throws Exception {
@@ -75,22 +71,20 @@ public void canLoadMultipleFiles() throws Exception {
   @Test
   public void flagValueIsConvertedToFlag() throws Exception {
     DataLoader ds = new DataLoader(FileData.dataSource().filePaths(resourceFilePath("value-only.json")).sources);
-    JsonObject expected = gson.fromJson(
+    LDValue expected = LDValue.parse(
         "{\"key\":\"flag2\",\"on\":true,\"fallthrough\":{\"variation\":0},\"variations\":[\"value2\"]," +
-        "\"trackEvents\":false,\"deleted\":false,\"version\":1}",
-        JsonObject.class);
+        "\"trackEvents\":false,\"deleted\":false,\"version\":1}");
     ds.load(builder);
-    ItemDescriptor flag = toDataMap(builder.build()).get(FEATURES).get(FLAG_VALUE_1_KEY);
-    JsonObject actual = gson.toJsonTree(flag.getItem()).getAsJsonObject();
+    LDValue actual = getItemAsJson(builder, FEATURES, FLAG_VALUE_1_KEY);
     // Note, we're comparing one property at a time here because the version of the Java SDK we're
     // building against may have more properties than it did when the test was written.
-    for (Map.Entry<String, JsonElement> e: expected.entrySet()) {
-      assertThat(actual.get(e.getKey()), equalTo(e.getValue()));
+    for (String key: expected.keys()) {
+      assertThat(actual.get(key), equalTo(expected.get(key)));
     }
   }
 
   @Test
-  public void duplicateFlagKeyInFlagsThrowsException() throws Exception {
+  public void duplicateFlagKeyInFlagsThrowsExceptionByDefault() throws Exception {
     try {
       DataLoader ds = new DataLoader(FileData.dataSource().filePaths(
           resourceFilePath("flag-only.json"),
@@ -103,7 +97,7 @@ public void duplicateFlagKeyInFlagsThrowsException() throws Exception {
   }
 
   @Test
-  public void duplicateFlagKeyInFlagsAndFlagValuesThrowsException() throws Exception {
+  public void duplicateFlagKeyInFlagsAndFlagValuesThrowsExceptionByDefault() throws Exception {
     try {
       DataLoader ds = new DataLoader(FileData.dataSource().filePaths(
           resourceFilePath("flag-only.json"),
@@ -116,7 +110,7 @@ public void duplicateFlagKeyInFlagsAndFlagValuesThrowsException() throws Excepti
   }
 
   @Test
-  public void duplicateSegmentKeyThrowsException() throws Exception {
+  public void duplicateSegmentKeyThrowsExceptionByDefault() throws Exception {
     try {
       DataLoader ds = new DataLoader(FileData.dataSource().filePaths(
           resourceFilePath("segment-only.json"),
@@ -128,6 +122,35 @@ public void duplicateSegmentKeyThrowsException() throws Exception {
     }
   }
 
+  @Test
+  public void duplicateKeysCanBeAllowed() throws Exception {
+    DataBuilder data1 = new DataBuilder(FileData.DuplicateKeysHandling.IGNORE);
+    DataLoader loader1 = new DataLoader(FileData.dataSource().filePaths(
+        resourceFilePath("flag-only.json"),
+        resourceFilePath("flag-with-duplicate-key.json")
+        ).sources);
+    loader1.load(data1);
+    assertThat(getItemAsJson(data1, FEATURES, "flag1").get("on"), equalTo(LDValue.of(true))); // value from first file
+    
+    DataBuilder data2 = new DataBuilder(FileData.DuplicateKeysHandling.IGNORE);
+    DataLoader loader2 = new DataLoader(FileData.dataSource().filePaths(
+        resourceFilePath("value-with-duplicate-key.json"),
+        resourceFilePath("flag-only.json")
+        ).sources);
+    loader2.load(data2);
+    assertThat(getItemAsJson(data2, FEATURES, "flag2").get("variations"),
+        equalTo(LDValue.buildArray().add(LDValue.of("value2a")).build())); // value from first file
+    
+    DataBuilder data3 = new DataBuilder(FileData.DuplicateKeysHandling.IGNORE);
+    DataLoader loader3 = new DataLoader(FileData.dataSource().filePaths(
+        resourceFilePath("segment-only.json"),
+        resourceFilePath("segment-with-duplicate-key.json")
+        ).sources);
+    loader3.load(data3);
+    assertThat(getItemAsJson(data3, SEGMENTS, "seg1").get("included"),
+        equalTo(LDValue.buildArray().add(LDValue.of("user1")).build())); // value from first file
+  }
+  
   @Test
   public void versionsAreIncrementedForEachLoad() throws Exception {
     DataLoader ds = new DataLoader(FileData.dataSource().filePaths(
@@ -136,11 +159,11 @@ public void versionsAreIncrementedForEachLoad() throws Exception {
         resourceFilePath("value-only.json")
         ).sources);
 
-    DataBuilder data1 = new DataBuilder();
+    DataBuilder data1 = new DataBuilder(FileData.DuplicateKeysHandling.FAIL);
     ds.load(data1);
     assertVersionsMatch(data1.build(), 1);
 
-    DataBuilder data2 = new DataBuilder();
+    DataBuilder data2 = new DataBuilder(FileData.DuplicateKeysHandling.FAIL);
     ds.load(data2);
     assertVersionsMatch(data2.build(), 2);
   }
@@ -164,4 +187,9 @@ private void assertVersionsMatch(FullDataSet<ItemDescriptor> data, int expectedV
       }
     }
   }
+  
+  private LDValue getItemAsJson(DataBuilder builder, DataKind kind, String key) {
+    ItemDescriptor flag = toDataMap(builder.build()).get(kind).get(key);
+    return LDValue.parse(kind.serialize(flag));
+  }
 }

src/test/java/com/launchdarkly/sdk/server/integrations/FileDataSourceTestData.java

@@ -29,7 +29,7 @@ public class FileDataSourceTestData {
       ImmutableMap.<String, LDValue>of(FLAG_VALUE_1_KEY, FLAG_VALUE_1);
 
   public static final String FULL_SEGMENT_1_KEY = "seg1"; 
-  public static final LDValue FULL_SEGMENT_1 = LDValue.parse("{\"key\":\"seg1\",\"include\":[\"user1\"]}");
+  public static final LDValue FULL_SEGMENT_1 = LDValue.parse("{\"key\":\"seg1\",\"included\":[\"user1\"]}");
   public static final Map<String, LDValue> FULL_SEGMENTS =
       ImmutableMap.<String, LDValue>of(FULL_SEGMENT_1_KEY, FULL_SEGMENT_1);
 

src/test/resources/filesource/all-properties.json

@@ -15,7 +15,7 @@
   "segments": {
   	"seg1": {
   	  "key": "seg1",
-  	  "include": ["user1"]
+  	  "included": ["user1"]
   	}
   }
 }

src/test/resources/filesource/all-properties.yml

@@ -14,4 +14,4 @@ flagValues:
 segments:
   seg1:
     key: seg1
-    include: ["user1"]
+    included: ["user1"]

src/test/resources/filesource/flag-with-duplicate-key.json

@@ -6,7 +6,7 @@
     },
     "flag1": {
       "key": "flag1",
-      "on": true
+      "on": false
     }
   }
 }

src/test/resources/filesource/segment-only.json

@@ -2,7 +2,7 @@
   "segments": {
   	"seg1": {
   	  "key": "seg1",
-  	  "include": ["user1"]
+  	  "included": ["user1"]
   	}
   }
 }

src/test/resources/filesource/segment-only.yml

@@ -2,4 +2,4 @@
 segments:
   seg1:
     key: seg1
-    include: ["user1"]
+    included: ["user1"]