use new logging API introduced in Java SDK 5.10.0 (#18)

Author: eli-darkly

CONTRIBUTING.md

@@ -40,5 +40,9 @@ To build the library and run all unit tests:
 ./gradlew test
 ```
 
-The tests expect you to have DynamoDB running locally. The simplest way to do that is with Docker: `docker run -p 8000:8000 amazon/dynamodb-local`
+The tests expect you to have DynamoDB running locally. The simplest way to do that is with Docker:
+
+```shell
+docker run -p 8000:8000 amazon/dynamodb-local
+```
 

README.md

@@ -5,7 +5,9 @@
 
 This library provides a DynamoDB-backed persistence mechanism (data store) for the [LaunchDarkly Java SDK](https://github.com/launchdarkly/java-server-sdk), replacing the default in-memory data store.
 
-This version of the library requires at least version 5.0.0 of the LaunchDarkly Java SDK, and at least version 2.1 of the AWS SDK for Java. The minimum Java version is 8. For Java SDK 4.x, use the latest 2.x version of this library.
+This version of the library requires at least version 5.10.0 of the LaunchDarkly Java SDK, and at least version 2.1 of the AWS SDK for Java. The minimum Java version is 8.
+
+For Java SDK 5.0 through 5.9, use the latest 3.x version of this library. For Java SDK 4.x, use the latest 2.x version.
 
 If you need to use Java 7, or if you are already using AWS SDK 1.x for some other purpose, you can use the 1.x releases of this library (which are developed on the "aws-v1" branch of the repository).
 

build.gradle

@@ -38,21 +38,18 @@ allprojects {
 }
 
 ext.versions = [
-    "sdk": "5.7.0", // the *lowest* version we're compatible with
-    "dynamodb": "2.10.32",
-    "slf4j": "1.7.21"
+    "sdk": "5.10.0", // the *lowest* version we're compatible with
+    "dynamodb": "2.10.32"
 ]
 
 ext.libraries = [:]
 
 dependencies {
     api "com.launchdarkly:launchdarkly-java-server-sdk:${versions.sdk}"
     api "software.amazon.awssdk:dynamodb:${versions.dynamodb}"
-    api "org.slf4j:slf4j-api:${versions.slf4j}"
     testImplementation "org.hamcrest:hamcrest-all:1.3"
     testImplementation "junit:junit:4.12"
     testImplementation "com.launchdarkly:launchdarkly-java-server-sdk:${versions.sdk}:test" // our unit tests use helper classes from the SDK
-    testImplementation "ch.qos.logback:logback-classic:1.1.7"
     testImplementation "com.google.guava:guava:28.2-jre" // required by SDK tests, not used in this library itself
     testImplementation "com.google.code.gson:gson:2.7" // same as above
 }

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

@@ -2,6 +2,7 @@
 
 import static com.launchdarkly.sdk.server.interfaces.BigSegmentStoreTypes.createMembershipFromSegmentRefs;
 
+import com.launchdarkly.logging.LDLogger;
 import com.launchdarkly.sdk.server.interfaces.BigSegmentStore;
 import com.launchdarkly.sdk.server.interfaces.BigSegmentStoreTypes;
 
@@ -19,8 +20,15 @@ public class DynamoDbBigSegmentStoreImpl extends DynamoDbStoreImplBase implement
   private final static String METADATA_KEY = "big_segments_metadata";
   private final static String SYNC_TIME_ATTR = "synchronizedOn";
 
-  DynamoDbBigSegmentStoreImpl(DynamoDbClient client, boolean wasExistingClient, String tableName, String prefix) {
-    super(client, wasExistingClient, tableName, prefix);
+  DynamoDbBigSegmentStoreImpl(
+    DynamoDbClient client,
+    boolean wasExistingClient,
+    String tableName,
+    String prefix,
+    LDLogger baseLogger
+    ) {
+    super(client, wasExistingClient, tableName, prefix,
+      baseLogger.subLogger("BigSegments").subLogger("DynamoDb"));
   }
 
   @Override

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

@@ -123,7 +123,8 @@ public DynamoDbDataStoreBuilder existingClient(DynamoDbClient existingClient) {
   @Override
   public PersistentDataStore createPersistentDataStore(ClientContext context) {  
     DynamoDbClient client = (existingClient != null) ? existingClient : clientBuilder.build();
-    return new DynamoDbDataStoreImpl(client, existingClient != null, tableName, prefix);
+    return new DynamoDbDataStoreImpl(client, existingClient != null, tableName, prefix,
+      context.getBasic().getBaseLogger());
   }
 
   /**
@@ -133,7 +134,8 @@ public PersistentDataStore createPersistentDataStore(ClientContext context) {
   @Override
   public BigSegmentStore createBigSegmentStore(ClientContext context) {
     DynamoDbClient client = (existingClient != null) ? existingClient : clientBuilder.build();
-    return new DynamoDbBigSegmentStoreImpl(client, existingClient != null, tableName, prefix);
+    return new DynamoDbBigSegmentStoreImpl(client, existingClient != null, tableName, prefix,
+      context.getBasic().getBaseLogger());
   }
 
   @Override

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

@@ -1,14 +1,12 @@
 package com.launchdarkly.sdk.server.integrations;
 
+import com.launchdarkly.logging.LDLogger;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.DataKind;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.FullDataSet;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.KeyedItems;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.SerializedItemDescriptor;
 import com.launchdarkly.sdk.server.interfaces.PersistentDataStore;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.util.AbstractMap;
 import java.util.ArrayList;
 import java.util.HashSet;
@@ -59,8 +57,6 @@
  * </ul>
  */
 final class DynamoDbDataStoreImpl extends DynamoDbStoreImplBase implements PersistentDataStore {
-  private static final Logger logger = LoggerFactory.getLogger("com.launchdarkly.sdk.server.LDClient.DataStore.DynamoDB");
-  
   private static final String versionAttribute = "version";
   private static final String itemJsonAttribute = "item";
   private static final String deletedItemPlaceholder = "null"; // DynamoDB doesn't allow empty strings
@@ -72,8 +68,15 @@ final class DynamoDbDataStoreImpl extends DynamoDbStoreImplBase implements Persi
 
   private Runnable updateHook;
 
-  DynamoDbDataStoreImpl(DynamoDbClient client, boolean wasExistingClient, String tableName, String prefix) {
-    super(client, wasExistingClient, tableName, prefix);
+  DynamoDbDataStoreImpl(
+    DynamoDbClient client,
+    boolean wasExistingClient,
+    String tableName,
+    String prefix,
+    LDLogger baseLogger
+    ) {
+    super(client, wasExistingClient, tableName, prefix,
+      baseLogger.subLogger("DataStore").subLogger("DynamoDb"));
   }
 
   @Override
@@ -285,7 +288,7 @@ static void batchWriteRequests(DynamoDbClient client, String tableName, List<Wri
     }
   }
 
-  private static boolean checkSizeLimit(Map<String, AttributeValue> item) {
+  private boolean checkSizeLimit(Map<String, AttributeValue> item) {
     // see: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/CapacityUnitCalculations.html
     int size = 100; // fixed overhead for index data
     for (Map.Entry<String, AttributeValue> kv: item.entrySet()) {

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

@@ -2,6 +2,8 @@
 
 import static com.launchdarkly.sdk.server.integrations.CollectionHelpers.mapOf;
 
+import com.launchdarkly.logging.LDLogger;
+
 import java.io.Closeable;
 import java.io.IOException;
 import java.util.Map;
@@ -18,12 +20,20 @@ abstract class DynamoDbStoreImplBase implements Closeable {
   protected final boolean wasExistingClient;
   protected final String tableName;
   protected final String prefix;
-
-  public DynamoDbStoreImplBase(DynamoDbClient client, boolean wasExistingClient, String tableName, String prefix) {
+  protected final LDLogger logger;
+
+  public DynamoDbStoreImplBase(
+    DynamoDbClient client,
+    boolean wasExistingClient,
+    String tableName,
+    String prefix,
+    LDLogger logger
+    ) {
     this.client = client;
     this.wasExistingClient = wasExistingClient;
     this.tableName = tableName;
     this.prefix = "".equals(prefix) ? null : prefix;
+    this.logger = logger;
   }
 
   protected String prefixedNamespace(String base) {

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

@@ -5,11 +5,13 @@
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Lists;
 import com.launchdarkly.sdk.server.DataModel;
+import com.launchdarkly.sdk.server.interfaces.ClientContext;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.DataKind;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.FullDataSet;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.KeyedItems;
 import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.SerializedItemDescriptor;
 import com.launchdarkly.sdk.server.interfaces.PersistentDataStore;
+import com.launchdarkly.sdk.server.interfaces.PersistentDataStoreFactory;
 
 import org.junit.BeforeClass;
 import org.junit.Test;
@@ -19,6 +21,7 @@
 import java.util.List;
 import java.util.Map;
 
+import static com.launchdarkly.sdk.server.TestComponents.clientContext;
 import static com.launchdarkly.sdk.server.integrations.TestUtils.baseBuilder;
 import static com.launchdarkly.sdk.server.integrations.TestUtils.clearEverything;
 import static com.launchdarkly.sdk.server.integrations.TestUtils.createTableIfNecessary;
@@ -44,13 +47,8 @@ public static void setUpAll() {
   }
 
   @Override
-  protected DynamoDbDataStoreImpl makeStore() {
-    return (DynamoDbDataStoreImpl)baseBuilder().createPersistentDataStore(null);
-  }
-  
-  @Override
-  protected DynamoDbDataStoreImpl makeStoreWithPrefix(String prefix) {
-    return (DynamoDbDataStoreImpl)baseBuilder().prefix(prefix).createPersistentDataStore(null);
+  protected PersistentDataStoreFactory buildStore(String prefix) {
+    return baseBuilder().prefix(prefix);
   }
 
   @Override
@@ -104,7 +102,7 @@ private void dataStoreSkipsAndLogsTooLargeItemOnInit(
     // Initialize the store with this data set. It should not throw an exception, but instead just
     // log an error and store all the *other* items-- so the resulting state should be the same as
     // makeGoodData().
-    try (PersistentDataStore store = makeStore()) {
+    try (PersistentDataStore store = buildStore(null).createPersistentDataStore(makeClientContext())) {
       store.init(new FullDataSet<>(dataPlusBadItem));
 
       assertDataSetsEqual(goodData, getAllData(store));
@@ -117,7 +115,7 @@ private void dataStoreSkipsAndLogsTooLargeItemOnUpsert(
     FullDataSet<SerializedItemDescriptor> goodData = makeGoodData();
 
     // Initialize the store with valid data. 
-    try (PersistentDataStore store = makeStore()) {
+    try (PersistentDataStore store = buildStore(null).createPersistentDataStore(makeClientContext())) {
       store.init(goodData);
 
       assertDataSetsEqual(goodData, getAllData(store));
@@ -130,6 +128,10 @@ private void dataStoreSkipsAndLogsTooLargeItemOnUpsert(
     }
   }
 
+  private ClientContext makeClientContext() {
+    return clientContext("", baseConfig().build());
+  }
+
   private static FullDataSet<SerializedItemDescriptor> makeGoodData() {
     return new FullDataSet<SerializedItemDescriptor>(ImmutableList.of(
          new SimpleEntry<>(DataModel.FEATURES,