launchdarkly-server-sdk 5.7.4 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b374a5f119d3ba9ba2c787bd15e8192284726cd8
-  data.tar.gz: 12e5367e8ce7c10e5d5096429bca1154f1511187
+  metadata.gz: 70c964dad6b0915f006bee0d90160fe04bdd4853
+  data.tar.gz: f80c3dfe18ad4a70c0d7156ab06b748ffc897ae9
 SHA512:
-  metadata.gz: e6495effad7b943a428d93d149dfc736d1352c981f650249a724a14d2a9063ac1ec1167640dc6a0fe84fc85cccc50f2b929e0289c1c494252794762244e9341d
-  data.tar.gz: 6fb1b6965ed4bb12b316d8115b73590db0f913b614acefb277db00a32e82853670ba4b2e693445e1190ccdc16e2f53d0eaeae8e228485835bf709712832a69a3
+  metadata.gz: 8a31c4b4a77caec7e64b54b18aabdecb12f2b5a44432d4ef74c94c2a1b57dff8a4cbf38f8dc894be8fec6f999bdc8bb62ff6095d1670ac892969329c435c9ff7
+  data.tar.gz: 2e21c5ad0cb881d99c905eaefc8952024d8fc12a1f28b1b2f4100cb39a95cdfa65d77b4a2067f3843ca9c79a446e6b071dd9c2470f2d0d0afba64d86365eb6cd

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.7.4] - 2020-05-04
+### Fixed:
+- Setting a user's `custom` property explicitly to `nil`, rather than omitting it entirely or setting it to an empty hash, would cause the SDK to log an error and drop the current batch of analytics events. Now, it will be treated the same as an empty hash. ([#147](https://github.com/launchdarkly/ruby-server-sdk/issues/147))
+
 ## [5.7.3] - 2020-04-27
 ### Changed:
 - Previously, installing the SDK in an environment that did not have `openssl` would cause a failure at build time. The SDK still requires `openssl` at runtime, but this check has been removed because it caused the `rake` problem mentioned below, and because `openssl` is normally bundled in modern Ruby versions.

data/Gemfile.lock

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

data/lib/ldclient-rb/impl/integrations/redis_impl.rb

@@ -33,6 +33,8 @@ module LaunchDarkly
             @pool = opts[:pool] || ConnectionPool.new(size: max_connections) do
               ::Redis.new(@redis_opts)
             end
+            # shutdown pool on close unless the client passed a custom pool and specified not to shutdown
+            @pool_shutdown_on_close = (!opts[:pool] || opts.fetch(:pool_shutdown_on_close, true))
             @prefix = opts[:prefix] || LaunchDarkly::Integrations::Redis::default_prefix
             @logger = opts[:logger] || Config.default_logger
             @test_hook = opts[:test_hook]  # used for unit tests, deliberately undocumented
@@ -118,6 +120,7 @@ module LaunchDarkly
 
           def stop
             if @stopped.make_true
+              return unless @pool_shutdown_on_close
               @pool.shutdown { |redis| redis.close }
             end
           end

data/lib/ldclient-rb/integrations/redis.rb

@@ -45,6 +45,9 @@ module LaunchDarkly
       # @option opts [Integer] :expiration (15)  expiration time for the in-memory cache, in seconds; 0 for no local caching
       # @option opts [Integer] :capacity (1000)  maximum number of items in the cache
       # @option opts [Object] :pool  custom connection pool, if desired
+      # @option opts [Boolean] :pool_shutdown_on_close whether calling `close` should shutdown the custom connection pool;
+      #   this is true by default, and should be set to false only if you are managing the pool yourself and want its
+      #   lifecycle to be independent of the SDK client
       # @return [LaunchDarkly::Interfaces::FeatureStore]  a feature store object
       #
       def self.new_feature_store(opts)

data/lib/ldclient-rb/redis_store.rb

@@ -35,6 +35,7 @@ module LaunchDarkly
     # @option opts [Integer] :expiration  expiration time for the in-memory cache, in seconds; 0 for no local caching
     # @option opts [Integer] :capacity  maximum number of feature flags (or related objects) to cache locally
     # @option opts [Object] :pool  custom connection pool, if desired
+    # @option opts [Boolean] :pool_shutdown_on_close whether calling `close` should shutdown the custom connection pool.
     #
     def initialize(opts = {})
       core = LaunchDarkly::Impl::Integrations::Redis::RedisFeatureStoreCore.new(opts)

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "5.7.4"
+  VERSION = "5.8.0"
 end

data/spec/redis_feature_store_spec.rb

@@ -1,3 +1,4 @@
+require "connection_pool"
 require "feature_store_spec_base"
 require "json"
 require "redis"
@@ -27,11 +28,11 @@ end
 
 describe LaunchDarkly::RedisFeatureStore do
   subject { LaunchDarkly::RedisFeatureStore }
-  
+
   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.
-  
+
   context "real Redis with local cache" do
     include_examples "feature_store", method(:create_redis_store), method(:clear_all_data)
   end
@@ -59,7 +60,7 @@ describe LaunchDarkly::RedisFeatureStore do
     flag = { key: "foo", version: 1 }
     test_hook = make_concurrent_modifier_test_hook(other_client, flag, 2, 4)
     store = create_redis_store({ test_hook: test_hook })
-    
+
     begin
       store.init(LaunchDarkly::FEATURES => { flag[:key] => flag })
 
@@ -77,7 +78,7 @@ describe LaunchDarkly::RedisFeatureStore do
     flag = { key: "foo", version: 1 }
     test_hook = make_concurrent_modifier_test_hook(other_client, flag, 3, 3)
     store = create_redis_store({ test_hook: test_hook })
-    
+
     begin
       store.init(LaunchDarkly::FEATURES => { flag[:key] => flag })
 
@@ -89,4 +90,32 @@ describe LaunchDarkly::RedisFeatureStore do
       other_client.close
     end
   end
+
+  it "shuts down a custom Redis pool by default" do
+    unowned_pool = ConnectionPool.new(size: 1, timeout: 1) { Redis.new({ url: "redis://localhost:6379" }) }
+    store = create_redis_store({ pool: unowned_pool })
+
+    begin
+      store.init(LaunchDarkly::FEATURES => { })
+      store.stop
+
+      expect { unowned_pool.with {} }.to raise_error(ConnectionPool::PoolShuttingDownError)
+    ensure
+      unowned_pool.shutdown { |conn| conn.close }
+    end
+  end
+
+  it "doesn't shut down a custom Redis pool if pool_shutdown_on_close = false" do
+    unowned_pool = ConnectionPool.new(size: 1, timeout: 1) { Redis.new({ url: "redis://localhost:6379" }) }
+    store = create_redis_store({ pool: unowned_pool, pool_shutdown_on_close: false })
+
+    begin
+      store.init(LaunchDarkly::FEATURES => { })
+      store.stop
+
+      expect { unowned_pool.with {} }.not_to raise_error(ConnectionPool::PoolShuttingDownError)
+    ensure
+      unowned_pool.shutdown { |conn| conn.close }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 5.7.4
+  version: 5.8.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb