prepare 5.8.1 release (#264)

* misc cleanup + test improvements

* make intVariation and doubleVariation non-nullable

* (5.0) don't use jar magic to find out our own version string

* fix test

* make intVariation and doubleVariation non-nullable

* better unit test coverage of LDClient and FeatureFlagsState

* test coverage improvements + minor fixes

* better temp file handling in file data source tests

* revert file data source implementation change for now

* revert unnecessary change

* comment about file watching on Mac

* add slight delay to avoid timing-dependent test flakiness

* test fixes/comments

* (5.0) use simpler and more stable logger names

* better instructions

* more convenient way to set EventSource logger name

* (5.0) add HTTP default headers method + some component refactoring

* don't need to pass the whole config object to describeConfiguration()

* simplify test logic for HTTP headers

* (5.0) final test coverage improvements, for now, with enforcement

* re-simplify DataBuilder

* increase timeouts

* misc fixes

* rm unnecessary override

* indents

* update benchmark code for API change

* support loading file data from a classpath resource

* update metadata so Releaser knows about 4.x branch

* minor test fixes

* make class final

* rm beta changelog items

* test data source

* more info about coverage in CONTRIBUTING.md

* misc fixes/tests

* use java-sdk-common 1.0.0

* use okhttp-eventsource 2.3.0

* use okhttp-eventsource 2.3.1 for thread fix

* fix flaky tests due to change in EventSource error reporting

* remove support for indirect put and indirect patch

* fix typo in javadoc example code

* clean up polling logic, fix status updating after an outage, don't reinit store unnecessarily (#256)

* slightly change semantics of boolean setters, improve tests, misc cleanup

* avoid NPEs if LDUser was deserialized by Gson (#257)

* avoid NPEs if LDUser was deserialized by Gson

* add test

* fix release metadata

* prepare 4.14.1 release (#200)

* Releasing version 4.14.1

* exclude Kotlin metadata from jar + fix misc Gradle problems

* update CI and Gradle to test with newer JDKs (#259)

* update okhttp to 3.14.9 (fixes incompatibility with OpenJDK 8.0.252)

* prepare 4.14.2 release (#205)

* Releasing version 4.14.2

* update okhttp to 4.8.1 (fixes incompatibility with OpenJDK 8.0.252)

* gitignore

* Bump SnakeYAML from 1.19 to 1.26 to address CVE-2017-18640

* prepare 4.14.3 release (#209)

* Releasing version 4.14.3

* comments

* only log initialization message once in polling mode

* [ch89935] Correct some logging call format strings (#264)

Also adds debug logs for full exception information in a couple locations.

* [ch90109] Remove outdated trackMetric comment from before service support. (#265)

* Fix compatibility with Java 7.

* Remove import that is no longer used.

* add Java 7 build (#267)

* prepare 4.14.4 release (#214)

* Releasing version 4.14.4

* add and use getSocketFactory

* alignment

* add socketFactory to builder

* test socket factory builder

* preserve dummy CI config file when pushing to gh-pages (#271)

* fix concatenation when base URI has a context path (#270)

* fix shaded jar builds to exclude Jackson classes and not modify Jackson return types (#268)

* add test httpClientCanUseCustomSocketFactory for DefaultFeatureRequestor

* add httpClientCanUseCustomSocketFactory() test for DefaultEventSenderTest

* add httpClientCanUseCustomSocketFactory() test to StreamProcessorTest

* pass URI to in customSocketFactory event test

* make test less ambiguous

* copy rules to new FlagBuilder instances (#273)

* Bump guava version (#274)

* Removed the guides link

* increment versions when loading file data, so FlagTracker will work (#275)

* increment versions when loading file data, so FlagTracker will work

* update doc comment about flag change events with file data

* add ability to ignore duplicate keys in file data (#276)

* add alias events (#278)

* add alias events and function
* update tests for new functionality
* update javadoc strings

* add validation of javadoc build to CI

* update commons-codec to 1.15 (#279)

* Add support for experiment rollouts

* add tests and use seed for allocating user to partition

* test serialization and add check for isExperiment

* fix PollingProcessorTest test race condition + other test issues (#282)

* use launchdarkly-java-sdk-common 1.1.0-alpha-expalloc.2

* Update src/test/java/com/launchdarkly/sdk/server/EvaluatorTest.java

Co-authored-by: Sam Stokes <[email protected]>

* Update src/test/java/com/launchdarkly/sdk/server/EvaluatorTest.java

Co-authored-by: Sam Stokes <[email protected]>

* Update src/test/java/com/launchdarkly/sdk/server/EvaluatorTest.java

Co-authored-by: Sam Stokes <[email protected]>

* Update src/test/java/com/launchdarkly/sdk/server/EvaluatorTest.java

Co-authored-by: Sam Stokes <[email protected]>

* changes per code review comments

* Please enter the commit message for your changes. Lines starting

* fix null pointer exception

* address code review comments

* address more comments

* missed a ! for isUntracked()

* fix default boolean for json

* make untracked FALSE by default

* refactoring of bucketing logic to remove the need for an extra result object (#283)

* add comment to enum

* various JSON fixes, update common-sdk (#284)

* simlpify the logic and make it match node/.Net sdks

* Update src/main/java/com/launchdarkly/sdk/server/EventFactory.java

Co-authored-by: Sam Stokes <[email protected]>

* add the same comment as the Node SDK

* Remove outdated/meaningless doc comment. (#286)

* protect against NPEs if flag/segment JSON contains a null value

* use java-sdk-common 1.2.0

* fix Jackson-related build issues (again) (#288)

* update to okhttp-eventsource patch for stream retry bug, improve tests (#289)

* update to okhttp-eventsource patch for stream retry bug, improve test

* add test for appropriate stream retry

* add public builder for FeatureFlagsState (#290)

* add public builder for FeatureFlagsState

* javadoc fixes

* clarify FileData doc comment to say you shouldn't use offline mode (#291)

* improve validation of SDK key so we won't throw an exception that contains the key (#293)

* fix javadoc link in FileData comment (#294)

* fix PollingProcessor 401 behavior and use new HTTP test helpers (#292)

* re-fix metadata to remove Jackson dependencies, also remove Class-Path from manifest (#295)

* make FeatureFlagsState.Builder.build() public (#297)

* clean up tests using java-test-helpers 1.1.0 (#296)

* use Releaser v2 config + newer CI images (#298)

* [ch123129] Fix `PollingDataSourceBuilder` example. (#299)

* Updates docs URLs

* always use US locale when parsing HTTP dates

* use Gson 2.8.9

* don't try to send more diagnostic events after an unrecoverable HTTP error

* ensure module-info file isn't copied into our jars during build

* use Gradle 7

* update build for benchmarks

* more Gradle 7 compatibility changes for benchmark job

* test with Java 17 in CI (#307)

* test with Java 17 in CI

* also test in Java 17 for Windows

* fix choco install command

* do date comparisons as absolute times, regardless of time zone (#310)

* fix suppression of nulls in JSON representations (#311)

* fix suppression of nulls in JSON representations

* distinguish between situations where we do or do not want to suppress nulls

* fix identify/track null user key check, also don't create index event for alias

* use latest java-sdk-common

* fix setting of trackEvents/trackReason in allFlagsState data when there's an experiment

* implement contract tests (#314)

* Merge Big Segments feature branch for 5.7.0 release (#316)

Includes Big Segments implementation and contract test support for the new behavior.

* Fix for pom including SDK common library as a dependency. (#317)

* Upload JUnit XML to CircleCI on failure (#320)

Fix a bug in the CircleCI config that was only uploading JUnit XML on _success_, not failure.

* Add application tag support (#319)

* Enforce 64 character limit on application tag values (#323)

* fix "wrong type" logic in evaluations when default value is null

Co-authored-by: Eli Bishop <[email protected]>
Co-authored-by: LaunchDarklyCI <[email protected]>
Co-authored-by: LaunchDarklyCI <[email protected]>
Co-authored-by: Gavin Whelan <[email protected]>
Co-authored-by: ssrm <[email protected]>
Co-authored-by: Harpo Roeder <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: Elliot <[email protected]>
Co-authored-by: Robert J. Neal <[email protected]>
Co-authored-by: Robert J. Neal <[email protected]>
Co-authored-by: Sam Stokes <[email protected]>
Co-authored-by: LaunchDarklyReleaseBot <[email protected]>
Co-authored-by: Ember Stevens <[email protected]>
Co-authored-by: ember-stevens <[email protected]>
Co-authored-by: Alex Engelberg <[email protected]>

Author: 13 people

src/main/java/com/launchdarkly/sdk/server/LDClient.java

@@ -11,6 +11,7 @@
 import com.launchdarkly.sdk.EvaluationReason;
 import com.launchdarkly.sdk.LDUser;
 import com.launchdarkly.sdk.LDValue;
+import com.launchdarkly.sdk.LDValueType;
 import com.launchdarkly.sdk.server.integrations.EventProcessorBuilder;
 import com.launchdarkly.sdk.server.interfaces.BigSegmentStoreStatusProvider;
 import com.launchdarkly.sdk.server.interfaces.BigSegmentsConfiguration;
@@ -365,64 +366,65 @@ public FeatureFlagsState allFlagsState(LDUser user, FlagsStateOption... options)
 
   @Override
   public boolean boolVariation(String featureKey, LDUser user, boolean defaultValue) {
-    return evaluate(featureKey, user, LDValue.of(defaultValue), true).booleanValue();
+    return evaluate(featureKey, user, LDValue.of(defaultValue), LDValueType.BOOLEAN).booleanValue();
   }
 
   @Override
   public int intVariation(String featureKey, LDUser user, int defaultValue) {
-    return evaluate(featureKey, user, LDValue.of(defaultValue), true).intValue();
+    return evaluate(featureKey, user, LDValue.of(defaultValue), LDValueType.NUMBER).intValue();
   }
 
   @Override
   public double doubleVariation(String featureKey, LDUser user, double defaultValue) {
-    return evaluate(featureKey, user, LDValue.of(defaultValue), true).doubleValue();
+    return evaluate(featureKey, user, LDValue.of(defaultValue), LDValueType.NUMBER).doubleValue();
   }
 
   @Override
   public String stringVariation(String featureKey, LDUser user, String defaultValue) {
-    return evaluate(featureKey, user, LDValue.of(defaultValue), true).stringValue();
+    return evaluate(featureKey, user, LDValue.of(defaultValue), LDValueType.STRING).stringValue();
   }
 
   @Override
   public LDValue jsonValueVariation(String featureKey, LDUser user, LDValue defaultValue) {
-    return evaluate(featureKey, user, LDValue.normalize(defaultValue), false);
+    return evaluate(featureKey, user, LDValue.normalize(defaultValue), null);
   }
 
   @Override
   public EvaluationDetail<Boolean> boolVariationDetail(String featureKey, LDUser user, boolean defaultValue) {
-    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue), true,
-        eventFactoryWithReasons);
+    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue),
+        LDValueType.BOOLEAN, eventFactoryWithReasons);
      return EvaluationDetail.fromValue(result.getValue().booleanValue(),
          result.getVariationIndex(), result.getReason());
   }
 
   @Override
   public EvaluationDetail<Integer> intVariationDetail(String featureKey, LDUser user, int defaultValue) {
-    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue), true,
-        eventFactoryWithReasons);
+    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue),
+        LDValueType.NUMBER, eventFactoryWithReasons);
     return EvaluationDetail.fromValue(result.getValue().intValue(),
         result.getVariationIndex(), result.getReason());
   }
 
   @Override
   public EvaluationDetail<Double> doubleVariationDetail(String featureKey, LDUser user, double defaultValue) {
-    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue), true,
-        eventFactoryWithReasons);
+    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue),
+        LDValueType.NUMBER, eventFactoryWithReasons);
     return EvaluationDetail.fromValue(result.getValue().doubleValue(),
         result.getVariationIndex(), result.getReason());
   }
 
   @Override
   public EvaluationDetail<String> stringVariationDetail(String featureKey, LDUser user, String defaultValue) {
-    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue), true,
-        eventFactoryWithReasons);
+    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.of(defaultValue),
+        LDValueType.STRING, eventFactoryWithReasons);
     return EvaluationDetail.fromValue(result.getValue().stringValue(),
         result.getVariationIndex(), result.getReason());
   }
 
   @Override
   public EvaluationDetail<LDValue> jsonValueVariationDetail(String featureKey, LDUser user, LDValue defaultValue) {
-    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.normalize(defaultValue), false, eventFactoryWithReasons);
+    Evaluator.EvalResult result = evaluateInternal(featureKey, user, LDValue.normalize(defaultValue),
+        null, eventFactoryWithReasons);
     return EvaluationDetail.fromValue(result.getValue(), result.getVariationIndex(), result.getReason());
   }
 
@@ -449,16 +451,16 @@ public boolean isFlagKnown(String featureKey) {
     return false;
   }
 
-  private LDValue evaluate(String featureKey, LDUser user, LDValue defaultValue, boolean checkType) {
-    return evaluateInternal(featureKey, user, defaultValue, checkType, eventFactoryDefault).getValue();
+  private LDValue evaluate(String featureKey, LDUser user, LDValue defaultValue, LDValueType requireType) {
+    return evaluateInternal(featureKey, user, defaultValue, requireType, eventFactoryDefault).getValue();
   }
 
   private Evaluator.EvalResult errorResult(EvaluationReason.ErrorKind errorKind, final LDValue defaultValue) {
     return new Evaluator.EvalResult(defaultValue, NO_VARIATION, EvaluationReason.error(errorKind));
   }
 
-  private Evaluator.EvalResult evaluateInternal(String featureKey, LDUser user, LDValue defaultValue, boolean checkType,
-      EventFactory eventFactory) {
+  private Evaluator.EvalResult evaluateInternal(String featureKey, LDUser user, LDValue defaultValue,
+      LDValueType requireType, EventFactory eventFactory) {
     if (!isInitialized()) {
       if (dataStore.isInitialized()) {
         Loggers.EVALUATION.warn("Evaluation called before client initialized for feature flag \"{}\"; using last known values from data store", featureKey);
@@ -496,7 +498,9 @@ private Evaluator.EvalResult evaluateInternal(String featureKey, LDUser user, LD
         evalResult.setValue(defaultValue);
       } else {
         LDValue value = evalResult.getValue(); // guaranteed not to be an actual Java null, but can be LDValue.ofNull()
-        if (checkType && !value.isNull() && !defaultValue.isNull() && defaultValue.getType() != value.getType()) {
+        if (requireType != null &&
+            !value.isNull() &&
+            value.getType() != requireType) {
           Loggers.EVALUATION.error("Feature flag evaluation expected result as {}, but got {}", defaultValue.getType(), value.getType());
           sendFlagRequestEvent(eventFactory.newUnknownFeatureRequestEvent(featureKey, user, defaultValue,
               EvaluationReason.ErrorKind.WRONG_TYPE));

src/main/java/com/launchdarkly/sdk/server/Util.java

@@ -239,6 +239,10 @@ static String applicationTagHeader(ApplicationInfo applicationInfo) {
         Loggers.MAIN.warn("Value of ApplicationInfo.{} contained invalid characters and was discarded", javaKey);
         continue;
       }
+      if (tagVal.length() > 64) {
+        Loggers.MAIN.warn("Value of ApplicationInfo.{} was longer than 64 characters and was discarded", javaKey);
+        continue;
+      }
       parts.add(tagKey + "/" + tagVal);
     }
     return String.join(" ", parts);

src/test/java/com/launchdarkly/sdk/server/LDClientEvaluationTest.java

@@ -64,13 +64,21 @@ public void boolVariationReturnsFlagValue() throws Exception {
   @Test
   public void boolVariationReturnsDefaultValueForUnknownFlag() throws Exception {
     assertFalse(client.boolVariation("key", user, false));
+
+    assertEquals(EvaluationDetail.fromValue(false, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.FLAG_NOT_FOUND)),
+        client.boolVariationDetail("key", user, false));
   }
 
   @Test
   public void boolVariationReturnsDefaultValueForWrongType() throws Exception {
     upsertFlag(dataStore, flagWithValue("key", LDValue.of("wrong")));
 
     assertFalse(client.boolVariation("key", user, false));
+
+    assertEquals(EvaluationDetail.fromValue(false, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.WRONG_TYPE)),
+        client.boolVariationDetail("key", user, false));
   }
 
   @Test
@@ -103,13 +111,21 @@ public void intVariationFromDoubleRoundsTowardZero() throws Exception {
   @Test
   public void intVariationReturnsDefaultValueForUnknownFlag() throws Exception {
     assertEquals(1, client.intVariation("key", user, 1));
+
+    assertEquals(EvaluationDetail.fromValue(1, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.FLAG_NOT_FOUND)),
+        client.intVariationDetail("key", user, 1));
   }
 
   @Test
   public void intVariationReturnsDefaultValueForWrongType() throws Exception {
     upsertFlag(dataStore, flagWithValue("key", LDValue.of("wrong")));
 
     assertEquals(1, client.intVariation("key", user, 1));
+    
+    assertEquals(EvaluationDetail.fromValue(1, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.WRONG_TYPE)),
+        client.intVariationDetail("key", user, 1));
   }
 
   @Test
@@ -129,13 +145,21 @@ public void doubleVariationReturnsFlagValueEvenIfEncodedAsInt() throws Exception
   @Test
   public void doubleVariationReturnsDefaultValueForUnknownFlag() throws Exception {
     assertEquals(1.0d, client.doubleVariation("key", user, 1.0d), 0d);
+
+    assertEquals(EvaluationDetail.fromValue(1.0d, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.FLAG_NOT_FOUND)),
+        client.doubleVariationDetail("key", user, 1.0d));
   }
 
   @Test
   public void doubleVariationReturnsDefaultValueForWrongType() throws Exception {
     upsertFlag(dataStore, flagWithValue("key", LDValue.of("wrong")));
 
     assertEquals(1.0d, client.doubleVariation("key", user, 1.0d), 0d);
+    
+    assertEquals(EvaluationDetail.fromValue(1.0d, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.WRONG_TYPE)),
+        client.doubleVariationDetail("key", user, 1.0d));
   }
 
   @Test
@@ -160,20 +184,32 @@ public void stringVariationReturnsDefaultValueForUnknownFlag() throws Exception
   @Test
   public void stringVariationWithNullDefaultReturnsDefaultValueForUnknownFlag() throws Exception {
     assertNull(client.stringVariation("key", user, null));
+
+    assertEquals(EvaluationDetail.fromValue((String)null, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.FLAG_NOT_FOUND)),
+        client.stringVariationDetail("key", user, null));
   }
 
   @Test
   public void stringVariationReturnsDefaultValueForWrongType() throws Exception {
     upsertFlag(dataStore, flagWithValue("key", LDValue.of(true)));
 
     assertEquals("a", client.stringVariation("key", user, "a"));
+    
+    assertEquals(EvaluationDetail.fromValue("a", NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.WRONG_TYPE)),
+        client.stringVariationDetail("key", user, "a"));
   }
 
   @Test
   public void stringVariationWithNullDefaultReturnsDefaultValueForWrongType() throws Exception {
     upsertFlag(dataStore, flagWithValue("key", LDValue.of(true)));
 
     assertNull(client.stringVariation("key", user, null));
+  
+    assertEquals(EvaluationDetail.fromValue((String)null, NO_VARIATION,
+        EvaluationReason.error(EvaluationReason.ErrorKind.WRONG_TYPE)),
+        client.stringVariationDetail("key", user, null));
   }
 
   @Test

src/test/java/com/launchdarkly/sdk/server/UtilTest.java

@@ -100,6 +100,8 @@ public void applicationTagHeader() {
     assertEquals("application-id/foo application-version/1.0.0", Util.applicationTagHeader(new ApplicationInfo("foo", "1.0.0")));
     // Values with invalid characters get discarded
     assertEquals("", Util.applicationTagHeader(new ApplicationInfo("invalid name", "lol!")));
+    // Values over 64 chars get discarded
+    assertEquals("", Util.applicationTagHeader(new ApplicationInfo("look-at-this-incredibly-long-application-id-like-wow-it-sure-is-verbose", null)));
     // Empty values get discarded
     assertEquals("", Util.applicationTagHeader(new ApplicationInfo("", "")));
   }