updates for SDK 5.0 API + simplify build (#8)

Author: eli-darkly

.circleci/config.yml

@@ -1,13 +1,17 @@
-version: 2
+version: 2.1
+
+orbs:
+   win: circleci/[email protected]
 
 workflows:
   version: 2
   test:
     jobs:
-      - build
+      - build-test-linux
+      - build-test-windows
 
 jobs:
-  build:
+  build-test-linux:
     docker:
       - image: circleci/java
       - image: amazon/dynamodb-local
@@ -25,3 +29,43 @@ jobs:
           path: ~/junit
       - store_artifacts:
           path: ~/junit
+
+  build-test-windows:
+    executor:
+      name: win/vs2019
+      shell: powershell.exe
+    steps:
+      - checkout
+      - run:
+          name: install OpenJDK
+          command: |
+            $ProgressPreference = "SilentlyContinue"  # prevents console errors from CircleCI host
+            iwr -outf openjdk.msi https://developers.redhat.com/download-manager/file/java-11-openjdk-11.0.5.10-2.windows.redhat.x86_64.msi
+            Start-Process msiexec.exe -Wait -ArgumentList '/I openjdk.msi /quiet'
+      - run:
+          name: set up DynamoDB
+          command: |
+            $ProgressPreference = "SilentlyContinue"
+            iwr -outf dynamo.zip https://s3-us-west-2.amazonaws.com/dynamodb-local/dynamodb_local_latest.zip
+            mkdir dynamo
+            Expand-Archive -Path dynamo.zip -DestinationPath dynamo
+      - run:
+          name: run DynamoDB
+          command: |
+            cd dynamo
+            javaw -D"java.library.path=./DynamoDBLocal_lib" -jar DynamoDBLocal.jar
+          background: true
+      - run:
+          name: build and test
+          command: |
+            cp gradle.properties.example gradle.properties
+            .\gradlew.bat --no-daemon test  # must use --no-daemon because CircleCI in Windows will hang if there's a daemon running
+      - run:
+          name: save test results
+          command: |
+            mkdir .\junit
+            cp build/test-results/test/*.xml junit
+      - store_test_results:
+          path: .\junit
+      - store_artifacts:
+          path: .\junit

CONTRIBUTING.md

@@ -1,4 +1,44 @@
-Contributing to this library
-============================
+# Contributing to this library
 
 The source code for this library is [here](https://github.com/launchdarkly/java-client-dynamodb). We encourage pull-requests and other contributions from the community. Since this library is meant to be used in conjunction with the LaunchDarkly Java SDK, you may want to look at the [Java SDK source code](https://github.com/launchdarkly/java-client) and our [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide).
+
+## Submitting bug reports and feature requests
+ 
+The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/java-server-sdk-dynamodb/issues) in this repository. Bug reports and feature requests specific to this project should be filed in the issue tracker. The SDK team will respond to all newly filed issues within two business days.
+ 
+## Submitting pull requests
+ 
+We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+ 
+## Build instructions
+ 
+### Prerequisites
+ 
+The library builds with [Gradle](https://gradle.org/) and should be built against Java 8.
+ 
+### Building
+
+To build the library without running any tests:
+```
+./gradlew jar
+```
+
+If you wish to clean your working directory between builds, you can clean it by running:
+```
+./gradlew clean
+```
+
+If you wish to use an interim build in another Maven/Gradle project such as [hello-java](https://github.com/launchdarkly/hello-java), you will likely want to publish the artifact to your local Maven repository so that your other project can access it.
+```
+./gradlew publishToMavenLocal
+```
+
+### Testing
+ 
+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`
+

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 is for use with LaunchDarkly Java SDK versions greater than or equal to 4.12.0 and less than 5.0; for Java SDK 5.0 and above, the minimum version of this library is 3.0. It requires at least version 2.1 of the AWS SDK for Java. The minimum Java version is 8 (because that is the minimum Java version of the AWS SDK 2.x). 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).
+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.
+
+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).
 
 See the [API documentation](https://launchdarkly.github.io/java-server-sdk-dynamodb) for details on classes and methods.
 
@@ -17,12 +19,12 @@ This assumes that you have already installed the LaunchDarkly Java SDK.
 
 1. In DynamoDB, create a table which has the following schema: a partition key called "namespace" and a sort key called "key", both with a string type. The LaunchDarkly library does not create the table automatically, because it has no way of knowing what additional properties (such as permissions and throughput) you would want it to have.
 
-2. Add this library to your project:
+2. Add this library to your project (updating the version number to use the [latest release](https://github.com/launchdarkly/java-server-sdk-dynamodb/releases)):
 
         <dependency>
           <groupId>com.launchdarkly</groupId>
           <artifactId>launchdarkly-java-server-sdk-dynamodb-store</artifactId>
-          <version>2.1.0</version>
+          <version>3.0.0</version>
         </dependency>
 
 3. If you do not already have the AWS SDK in your project, add the DynamoDB part of it. (This needs to be added separately, rather than being included in the LaunchDarkly jar, because AWS classes are exposed in the public interface.)
@@ -35,44 +37,37 @@ This assumes that you have already installed the LaunchDarkly Java SDK.
 
 4. Import the LaunchDarkly package and the package for this library:
 
-        import com.launchdarkly.client.*;
-        import com.launchdarkly.client.integrations.*;
+        import com.launchdarkly.sdk.server.*;
+        import com.launchdarkly.sdk.server.integrations.*;
 
 5. When configuring your SDK client, add the DynamoDB feature store:
 
-        DynamoDbDataStoreBuilder dynamoDbStore = DynamoDb.dataStore("my-table-name");
-        
         LDConfig config = new LDConfig.Builder()
-            .dataStore(Components.persistentDataStore(dynamoDbStore))
+            .dataStore(
+                Components.persistentDataStore(
+                    DynamoDb.dataStore("my-table-name")
+                )
+            )
             .build();
-        
-        LDClient client = new LDClient("YOUR SDK KEY", config);
 
 By default, the DynamoDB client will try to get your AWS credentials and region name from environment variables and/or local configuration files, as described in the AWS SDK documentation. There are methods in `DynamoDbDataStoreBuilder` for changing the configuration options. Alternatively, if you already have a fully configured DynamoDB client object, you can tell LaunchDarkly to use that:
 
-        DynamoDbDataStoreBuilder dynamoDbStore = DynamoDb.dataStore("my-table-name")
-            .existingClient(myDynamoDbClientInstance);
+                Components.persistentDataStore(
+                    DynamoDb.dataStore("my-table-name").existingClient(myDynamoDbClientInstance)
+                )
 
 ## Caching behavior
 
-To reduce traffic to DynamoDB, there is an optional in-memory cache that retains the last known data for a configurable amount of time. This is on by default; to turn it off (and guarantee that the latest feature flag data will always be retrieved from DynamoDB for every flag evaluation), configure the store as follows:
-
-By default, for any persistent data store, the Java SDK uses an in-memory cache to reduce traffic to the database; this retains the last known data for a configurable amount of time. To change the caching behavior or disable caching, use the `PersistentDataStoreBuilder` methods:
-
-        LDConfig configWithLongerCacheTtl = new LDConfig.Builder()
-            .dataStore(
-                Components.persistentDataStore(dynamoDbStore).cacheSeconds(60)
-            )
-            .build();
+The LaunchDarkly SDK has a standard caching mechanism for any persistent data store, to reduce database traffic. This is configured through the SDK's `PersistentDataStoreBuilder` class as described the SDK documentation. For instance, to specify a cache TTL of 5 minutes:
 
-        LDConfig configWithNoCaching = new LDConfig.Builder()
+        LDConfig config = new LDConfig.Builder()
             .dataStore(
-                Components.persistentDataStore(dynamoDbStore).noCaching()
+                Components.persistentDataStore(
+                    DynamoDb.dataStore("my-table-name")
+                ).cacheTime(Duration.ofMinutes(5))
             )
             .build();
 
-For other ways to control the behavior of the cache, see `PersistentDataStoreBuilder` in the Java SDK.
-
 ## About LaunchDarkly
 
 * LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can: