launchdarkly-server-sdk 5.6.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 502749fe2b55f4a3116ea223872835e76f7f698b
-  data.tar.gz: 9ab5eae90b672dc39db4c3487bd67aa32878b467
+  metadata.gz: 634c7b652bbff689dc0d705f75536ee40e76648f
+  data.tar.gz: 7c932f06ef8f16e2f5a13f7c34d19aa834acfeb0
 SHA512:
-  metadata.gz: a4f9f6642ab989aab6069924fc8b9f543123672cf475be58b72e1410a2563f246ce40d0cfef34dad0c77c37e28d695d05368c719df889eb5766d3618b19848b3
-  data.tar.gz: 8c3af4780de0251380f194c8e4c4c3ce359f2a1612763e45a2a8b2eadab3d0dd20f83d5f0d60f8efb45759f5f8a4af7ccc6143085d2999065e4ca8791cf50291
+  metadata.gz: 81c83640f62d49bed5f91cf9b77f551d0df663491ed96fbfadc69a68a5a09787667c26554a09098bad9b8ba4ef55c78b2e15ab7743c99a3ba43c80b3de48723c
+  data.tar.gz: 72adc3f1ff659659c2093b3f81e680de298a15f20a43df7cc958c9a62040a8670e18505e604254f48401eb8fa5618d61873b7a22ba43fe1fe3a463f16f265a3f

data/.github/pull_request_template.md

@@ -0,0 +1,21 @@
+**Requirements**
+
+- [ ] I have added test coverage for new or changed functionality
+- [ ] I have followed the repository's [pull request submission guidelines](../blob/master/CONTRIBUTING.md#submitting-pull-requests)
+- [ ] I have validated my changes against all supported platform versions
+
+**Related issues**
+
+Provide links to any issues in this repository or elsewhere relating to this pull request.
+
+**Describe the solution you've provided**
+
+Provide a clear and concise description of what you expect to happen.
+
+**Describe alternatives you've considered**
+
+Provide a clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context about the pull request here.

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
-## [5.6.0] - 2019-08-20
+## [5.6.0] - 2019-08-28
 ### Added:
 - Added support for upcoming LaunchDarkly experimentation features. See `LDClient.track()`.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    launchdarkly-server-sdk (5.6.0)
+    launchdarkly-server-sdk (5.6.1)
       concurrent-ruby (~> 1.0)
       json (>= 1.8, < 3)
       ld-eventsource (= 1.0.1)

data/lib/ldclient-rb/evaluation.rb

@@ -323,20 +323,28 @@ module LaunchDarkly
     end
 
     def variation_index_for_user(flag, rule, user)
-      if !rule[:variation].nil? # fixed variation
-        return rule[:variation]
-      elsif !rule[:rollout].nil? # percentage rollout
+      variation = rule[:variation]
+      return variation if !variation.nil? # fixed variation
+      rollout = rule[:rollout]
+      return nil if rollout.nil?
+      variations = rollout[:variations]
+      if !variations.nil? && variations.length > 0 # percentage rollout
         rollout = rule[:rollout]
         bucket_by = rollout[:bucketBy].nil? ? "key" : rollout[:bucketBy]
         bucket = bucket_user(user, flag[:key], bucket_by, flag[:salt])
         sum = 0;
-        rollout[:variations].each do |variate|
+        variations.each do |variate|
           sum += variate[:weight].to_f / 100000.0
           if bucket < sum
             return variate[:variation]
           end
         end
-        nil
+        # The user's bucket value was greater than or equal to the end of the last bucket. This could happen due
+        # to a rounding error, or due to the fact that we are scaling to 100000 rather than 99999, or the flag
+        # data could contain buckets that don't actually add up to 100000. Rather than returning an error in
+        # this case (or changing the scaling, which would potentially change the results for *all* users), we
+        # will simply put the user in the last bucket.
+        variations[-1][:variation]
       else # the rule isn't well-formed
         nil
       end

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "5.6.0"
+  VERSION = "5.6.1"
 end

data/spec/evaluation_spec.rb

@@ -560,6 +560,58 @@ describe LaunchDarkly::Evaluation do
     end
   end
 
+  describe "variation_index_for_user" do
+    it "matches bucket" do
+      user = { key: "userkey" }
+      flag_key = "flagkey"
+      salt = "salt"
+
+      # First verify that with our test inputs, the bucket value will be greater than zero and less than 100000,
+      # so we can construct a rollout whose second bucket just barely contains that value
+      bucket_value = (bucket_user(user, flag_key, "key", salt) * 100000).truncate()
+      expect(bucket_value).to be > 0
+      expect(bucket_value).to be < 100000
+
+      bad_variation_a = 0
+      matched_variation = 1
+      bad_variation_b = 2
+      rule = {
+        rollout: {
+          variations: [
+            { variation: bad_variation_a, weight: bucket_value }, # end of bucket range is not inclusive, so it will *not* match the target value
+            { variation: matched_variation, weight: 1 }, # size of this bucket is 1, so it only matches that specific value
+            { variation: bad_variation_b, weight: 100000 - (bucket_value + 1) }
+          ]
+        }
+      }
+      flag = { key: flag_key, salt: salt }
+
+      result_variation = variation_index_for_user(flag, rule, user)
+      expect(result_variation).to be matched_variation
+    end
+
+    it "uses last bucket if bucket value is equal to total weight" do
+      user = { key: "userkey" }
+      flag_key = "flagkey"
+      salt = "salt"
+
+      bucket_value = (bucket_user(user, flag_key, "key", salt) * 100000).truncate()
+
+      # We'll construct a list of variations that stops right at the target bucket value
+      rule = {
+        rollout: {
+          variations: [
+            { variation: 0, weight: bucket_value }
+          ]
+        }
+      }
+      flag = { key: flag_key, salt: salt }
+
+      result_variation = variation_index_for_user(flag, rule, user)
+      expect(result_variation).to be 0
+    end
+  end
+
   describe "bucket_user" do
     it "gets expected bucket values for specific keys" do
       user = { key: "userKeyA" }

data/spec/integrations/consul_feature_store_spec.rb

@@ -28,7 +28,7 @@ end
 
 
 describe "Consul feature store" do
-  return if ENV['LD_SKIP_DATABASE_TESTS'] == '1'
+  break if ENV['LD_SKIP_DATABASE_TESTS'] == '1'
   
   # These tests will all fail if there isn't a local Consul instance running.
   

data/spec/integrations/dynamodb_feature_store_spec.rb

@@ -89,7 +89,7 @@ end
 
 
 describe "DynamoDB feature store" do
-  return if ENV['LD_SKIP_DATABASE_TESTS'] == '1'
+  break if ENV['LD_SKIP_DATABASE_TESTS'] == '1'
 
   # These tests will all fail if there isn't a local DynamoDB instance running.
   

data/spec/redis_feature_store_spec.rb

@@ -31,7 +31,7 @@ end
 describe LaunchDarkly::RedisFeatureStore do
   subject { LaunchDarkly::RedisFeatureStore }
   
-  return if ENV['LD_SKIP_DATABASE_TESTS'] == '1'
+  break if ENV['LD_SKIP_DATABASE_TESTS'] == '1'
 
   # These tests will all fail if there isn't a Redis instance running on the default port.
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -237,6 +237,7 @@ files:
 - ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".hound.yml"
 - ".ldrelease/config.yml"