prepare 1.1.0 release

.circleci/config.yml

@@ -2,6 +2,7 @@ version: 2.1
 
 orbs:
    win: circleci/windows@1.0.0
+   android: circleci/android@1.0
 
 workflows:
   test:
@@ -43,6 +44,7 @@ jobs:
       - run: java -version
       - run: ./gradlew dependencies
       - run: ./gradlew jar
+      - run: ./gradlew javadoc
       - run: ./gradlew checkstyleMain
       - persist_to_workspace:
           root: build
@@ -121,49 +123,31 @@ jobs:
           path: .\junit
 
   build-test-android:
-    # This is adapted from the CI build for android-client-sdk
-    macos:
-      xcode: "10.3.0"
-    shell: /bin/bash --login -eo pipefail
-    working_directory: ~/launchdarkly/android-client-sdk-private
-    environment:
-      TERM: dumb
-      QEMU_AUDIO_DRV: none
-      _JAVA_OPTIONS: "-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap -Xms2048m -Xmx4096m"
-      GRADLE_OPTS: "-Dorg.gradle.daemon=false"
-      JVM_OPTS: -Xmx3200m
-      ANDROID_HOME: "/usr/local/share/android-sdk"
-      ANDROID_SDK_HOME: "/usr/local/share/android-sdk"
-      ANDROID_SDK_ROOT: "/usr/local/share/android-sdk"
+    executor:
+      name: android/android-machine
+      resource-class: large
+
     steps:
       - checkout
+
+      # What we want to do here is somewhat unusual: we want Android to run all of our tests from
+      # src/test/java, but run them in the Android emulator (to prove that we're only using Java
+      # APIs that our minimum Android API version supports). Normally, only tests in
+      # src/androidTest/java would be run that way. Also, Android needs a different JUnit test
+      # runner annotation on all of the test classes. So we can't just run the test code as-is.
+      #
+      # This step copies all the code from src/test/java into src/androidTest/java, except for the
+      # base class BaseTest.java, which is already defined in src/androidTest/java to provide the
+      # necessary test runner annotation.
       - run:
-          name: Install Android tools
-          command: ./scripts/install-android-tools.sh
-      - run:
-          name: Start Android environment
-          command: ./scripts/start-android-env.sh
-          background: true
-          timeout: 1200
-          no_output_timeout: 20m
-      - run:
-          name: Wait for Android environment
-          command: ./scripts/started-android-env.sh
-      - run:
-          name: Run tests
-          command: ./scripts/run-android-tests.sh
-          no_output_timeout: 20m
-      - run:
-          name: Save test results
-          command: |
-            mkdir -p ~/test-results
-            cp -r ./build/outputs/androidTest-results/* ~/test-results/
-          when: always
-      - run:
-          name: Stop Android environment
-          command: ./scripts/stop-android-env.sh
-          when: always
+          name: Copy tests
+          command: rsync -r ./src/test/java/ ./src/androidTest/java/ --exclude='BaseTest.java'
+
+      - android/start-emulator-and-run-tests:
+          system-image: system-images;android-21;default;x86
+          max-tries: 1
+          post-emulator-launch-assemble-command: ./gradlew -b build-android.gradle :assembleAndroidTest
+          test-command: ./gradlew -b build-android.gradle :connectedAndroidTest
+
       - store_test_results:
-            path: ~/test-results
-      - store_artifacts:
-            path: ~/artifacts
+          path: ./build/outputs/androidTest-results

.gitignore

@@ -1,7 +1,8 @@
 # Eclipse project files
 .classpath
 .project
-
+.settings
+
 # Intellij project files
 *.iml
 *.ipr

README.md

@@ -26,4 +26,3 @@ See [Contributing](https://github.com/launchdarkly/dotnet-sdk-common/blob/master
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides
     * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
     * [blog.launchdarkly.com](https://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
-    * [Feature Flagging Guide](https://github.com/launchdarkly/featureflags/  "Feature Flagging Guide") for best practices and strategies

build.gradle

@@ -87,10 +87,11 @@ jacocoTestCoverageVerification {
 			// The key for each of these items is the complete method signature minus the "com.launchdarkly.sdk." prefix.
 			"EvaluationReason.error(com.launchdarkly.sdk.EvaluationReason.ErrorKind)": 1,
 			"EvaluationReasonTypeAdapter.parse(com.google.gson.stream.JsonReader)": 1,
-			"EvaluationDetailTypeAdapterFactory.EvaluationDetailTypeAdapter.read(com.google.gson.stream.JsonReader)": 1,
 			"LDValue.equals(java.lang.Object)": 1,
-			"LDValueTypeAdapter.read(com.google.gson.stream.JsonReader)": 3,
-			"json.JsonSerialization.getDeserializableClasses()": -1
+			"LDValueTypeAdapter.read(com.google.gson.stream.JsonReader)": 1,
+			"json.JsonSerialization.getDeserializableClasses()": -1,
+			"json.LDGson.LDTypeAdapter.write(com.google.gson.stream.JsonWriter, java.lang.Object)": 1,
+			"json.LDJackson.GsonReaderToJacksonParserAdapter.peekInternal()": 3
 		]
 
 		knownMissedLinesForMethods.each { partialSignature, maxMissedLines ->

src/main/java/com/launchdarkly/sdk/EvaluationDetailTypeAdapterFactory.java

@@ -59,6 +59,7 @@ public void write(JsonWriter out, EvaluationDetail<T> value) throws IOException
       out.endObject();
     }
 
+    @SuppressWarnings("unchecked")
     @Override
     public EvaluationDetail<T> read(JsonReader in) throws IOException {
       T value = null;
@@ -85,8 +86,10 @@ public EvaluationDetail<T> read(JsonReader in) throws IOException {
       }
       in.endObject();
 
+      if (value == null && valueType == LDValue.class) {
+        value = (T)LDValue.ofNull(); // normalize to get around gson's habit of skipping the TypeAdapter for nulls 
+      }
       return EvaluationDetail.fromValue(value, variation, reason);
     }
-
   }
 }

src/main/java/com/launchdarkly/sdk/EvaluationReasonTypeAdapter.java

@@ -8,7 +8,7 @@
 
 import java.io.IOException;
 
-import static com.launchdarkly.sdk.Helpers.readNonNullableString;
+import static com.launchdarkly.sdk.Helpers.readEnum;
 import static com.launchdarkly.sdk.Helpers.readNullableString;
 
 final class EvaluationReasonTypeAdapter extends TypeAdapter<EvaluationReason> {
@@ -29,7 +29,7 @@ static EvaluationReason parse(JsonReader reader) throws IOException {
       String key = reader.nextName();
       switch (key) { // COVERAGE: may have spurious "branches missed" warning, see https://stackoverflow.com/questions/28013717/eclemma-branch-coverage-for-switch-7-of-19-missed
       case "kind":
-        kind = Enum.valueOf(EvaluationReason.Kind.class, readNonNullableString(reader));
+        kind = readEnum(EvaluationReason.Kind.class, reader);
         break;
       case "ruleIndex":
         ruleIndex = reader.nextInt();
@@ -41,7 +41,7 @@ static EvaluationReason parse(JsonReader reader) throws IOException {
         prereqKey = reader.nextString();
         break;
       case "errorKind":
-        errorKind = Enum.valueOf(EvaluationReason.ErrorKind.class, readNonNullableString(reader));
+        errorKind = readEnum(EvaluationReason.ErrorKind.class, reader);
         break;
       default:
         reader.skipValue(); // ignore any unexpected property

src/main/java/com/launchdarkly/sdk/Helpers.java

@@ -56,4 +56,13 @@ static String readNonNullableString(JsonReader reader) throws IOException {
       throw new JsonParseException("expected string value");
     }
   }
+
+  static <T extends Enum<T>> T readEnum(Class<T> enumClass, JsonReader reader) throws IOException {
+    String s = readNonNullableString(reader);
+    try {
+      return Enum.valueOf(enumClass, s);
+    } catch (IllegalArgumentException e) {
+      throw new JsonParseException(String.format("unsupported value \"%s\" for %s", s, enumClass));
+    }
+  }
 }