launchdarkly-server-sdk 5.7.1 → 5.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35e90a3d6853e2a12b8cf6d3c44a5d84c397b76a
-  data.tar.gz: 58a0229a7f331cb619568c8095a9381c60753a24
+  metadata.gz: dcb72b5ad43bf4a2f4250cbe1b12fb3eaf803e66
+  data.tar.gz: bd7ceebb0ff2a746d8b773fbeb7b3e287dcbcb01
 SHA512:
-  metadata.gz: 4c2c1b2598e1ccf4a5f7f49fb4ef39974938100b4b9ea28fe910d7aea8a153d09a8e8ee978794293958c6040208fd055b271e1a4c8f4f3245e94dcc3d7c51812
-  data.tar.gz: 4d0eadc0f93a217d36f89fae7b2f5b19ce5fa78f98c36a81d6d50d782ac7fed3f451384599bb24c7b8cec80e2e0a26df42d1dd1fcbe7ce6d29906f314fd929e7
+  metadata.gz: 4f3d71bf78a2cc31574470fd57af2eee84b5222dfaddfe90160ecd2bda746e5137df3fed136d12578b01ae84364f2fd04477046964bc8f73e5bced212988c59a
+  data.tar.gz: 165bb1c1b646ca0f759bb081020a16fd78b5df014be47cb9c5386f7e99b2287dfb640b7e865230e7604886dd3ad933ebae3d82b113bce21f549e03e2875c7d03

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.8.0] - 2020-05-27
+### Added:
+- In `LaunchDarkly::Integrations::Redis::new_feature_store`, if you pass in an externally created `pool`, you can now set the new option `pool_shutdown_on_close` to `false` to indicate that the SDK should _not_ shut down this pool if the SDK is shut down. The default behavior, as before, is that it will be shut down. (Thanks, [jacobthemyth](https://github.com/launchdarkly/ruby-server-sdk/pull/158)!)
+
+## [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.
+
+### Fixed:
+- The `LDClient` constructor will fail immediately with a descriptive `ArgumentError` if you provide a `nil` SDK key in a configuration that requires an SDK key (that is, a configuration that _will_ require communicating with LaunchDarkly services). Previously, it would still fail, but without a clear error message. You are still allowed to omit the SDK key in an offline configuration. ([#154](https://github.com/launchdarkly/ruby-server-sdk/issues/154))
+- Removed a hidden dependency on `rake` which could cause your build to fail if you had a dependency on this SDK and you did not have `rake` installed. ([#155](https://github.com/launchdarkly/ruby-server-sdk/issues/155))
+- Previously a clause in a feature flag rule that used a string operator (such as "starts with") or a numeric operator (such as "greater than") could cause evaluation of the flag to completely fail and return a default value if the value on the right-hand side of the expression did not have the right data type-- for instance, "greater than" with a string value. The LaunchDarkly dashboard does not allow creation of such a rule, but it might be possible to do so via the REST API; the correct behavior of the SDK is to simply treat the expression as a non-match.
+
+## [5.7.2] - 2020-03-27
+### Fixed:
+- Fixed a bug in the 5.7.0 and 5.7.1 releases that caused analytics events not to be sent unless diagnostic events were explicitly disabled. This also caused an error to be logged: `undefined method started?`.
+
+## [5.7.1] - 2020-03-18
+### Fixed:
+- The backoff delay logic for reconnecting after a stream failure was broken so that if a failure occurred after a stream had been active for at least 60 seconds, retries would use _no_ delay, potentially causing a flood of requests and a spike in CPU usage. This bug was introduced in version 5.5.0 of the SDK.
+
 ## [5.7.0] - 2020-03-10
 ### Added:
 - The SDK now periodically sends diagnostic data to LaunchDarkly, describing the version and configuration of the SDK, the architecture and version of the runtime platform, and performance statistics. No credentials, hostnames, or other identifiable values are included. This behavior can be disabled with `Config.diagnostic_opt_out` or configured with `Config.diagnostic_recording_interval`.

data/Gemfile.lock

@@ -1,94 +1,83 @@
 PATH
   remote: .
   specs:
-    launchdarkly-server-sdk (5.7.1)
+    launchdarkly-server-sdk (5.8.1)
       concurrent-ruby (~> 1.0)
-      json (>= 1.8, < 3)
+      json (~> 2.3.1)
       ld-eventsource (= 1.0.3)
       semantic (~> 1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.0.1)
-    aws-partitions (1.128.0)
-    aws-sdk-core (3.44.2)
-      aws-eventstream (~> 1.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.388.0)
+    aws-sdk-core (3.109.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.19.0)
-      aws-sdk-core (~> 3, >= 3.39.0)
-      aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.3)
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
-    concurrent-ruby (1.1.6)
-    connection_pool (2.2.1)
-    diff-lcs (1.3)
-    diplomat (2.0.2)
-      faraday (~> 0.9)
-      json
-    docile (1.1.5)
-    faraday (0.15.4)
+    aws-sdk-dynamodb (1.55.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    deep_merge (1.2.1)
+    diff-lcs (1.4.4)
+    diplomat (2.4.2)
+      deep_merge (~> 1.0, >= 1.0.1)
+      faraday (>= 0.9, < 1.1.0)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.25)
-    ffi (1.9.25-java)
+    ffi (1.12.0)
     hitimes (1.3.1)
-    hitimes (1.3.1-java)
     http_tools (0.4.5)
     jmespath (1.4.0)
-    json (1.8.6)
-    json (1.8.6-java)
+    json (2.3.1)
     ld-eventsource (1.0.3)
       concurrent-ruby (~> 1.0)
       http_tools (~> 0.4.5)
       socketry (~> 0.5.1)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    multipart-post (2.0.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    multipart-post (2.1.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     redis (3.3.5)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
     rspec_junit_formatter (0.3.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    ruby_dep (1.5.0)
     semantic (1.6.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
     socketry (0.5.1)
       hitimes (~> 1.2)
-    timecop (0.9.1)
+    timecop (0.9.2)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
   aws-sdk-dynamodb (~> 1.18)
-  bundler (~> 1.7)
-  codeclimate-test-reporter (~> 0)
+  bundler (~> 1.17)
   connection_pool (>= 2.1.2)
   diplomat (>= 2.0.2)
+  faraday (~> 0.17)
+  ffi (<= 1.12)
   launchdarkly-server-sdk!
   listen (~> 3.0)
   redis (~> 3.3.5)

data/launchdarkly-server-sdk.gemspec

@@ -19,21 +19,27 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.extensions    = 'ext/mkrf_conf.rb'
 
   spec.add_development_dependency "aws-sdk-dynamodb", "~> 1.18"
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 0"
   spec.add_development_dependency "diplomat", ">= 2.0.2"
   spec.add_development_dependency "redis", "~> 3.3.5"
   spec.add_development_dependency "connection_pool", ">= 2.1.2"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
   spec.add_development_dependency "timecop", "~> 0.9.1"
   spec.add_development_dependency "listen", "~> 3.0" # see file_data_source.rb
+  # these are transitive dependencies of listen and consul respectively
+  # we constrain them here to make sure the ruby 2.2, 2.3, and 2.4 CI
+  # cases all pass
+  spec.add_development_dependency "ffi", "<= 1.12" # >1.12 doesnt support ruby 2.2
+  spec.add_development_dependency "faraday", "~> 0.17" # >=0.18 doesnt support ruby 2.2
 
-  spec.add_runtime_dependency "json", [">= 1.8", "< 3"]
   spec.add_runtime_dependency "semantic", "~> 1.6"
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
   spec.add_runtime_dependency "ld-eventsource", "1.0.3"
+
+  # lock json to 2.3.x as ruby libraries often remove
+  # support for older ruby versions in minor releases
+  spec.add_runtime_dependency "json", "~> 2.3.1"
 end

data/lib/ldclient-rb/evaluation.rb

@@ -140,35 +140,44 @@ module LaunchDarkly
         end,
       endsWith:
         lambda do |a, b|
-          (a.is_a? String) && (a.end_with? b)
+          (a.is_a? String) && (b.is_a? String) && (a.end_with? b)
         end,
       startsWith:
         lambda do |a, b|
-          (a.is_a? String) && (a.start_with? b)
+          (a.is_a? String) && (b.is_a? String) && (a.start_with? b)
         end,
       matches:
         lambda do |a, b|
-          (b.is_a? String) && !(Regexp.new b).match(a).nil?
+          if (b.is_a? String) && (b.is_a? String)
+            begin
+              re = Regexp.new b
+              !re.match(a).nil?
+            rescue
+              false
+            end
+          else
+            false
+          end
         end,
       contains:
         lambda do |a, b|
-          (a.is_a? String) && (a.include? b)
+          (a.is_a? String) && (b.is_a? String) && (a.include? b)
         end,
       lessThan:
         lambda do |a, b|
-          (a.is_a? Numeric) && (a < b)
+          (a.is_a? Numeric) && (b.is_a? Numeric) && (a < b)
         end,
       lessThanOrEqual:
         lambda do |a, b|
-          (a.is_a? Numeric) && (a <= b)
+          (a.is_a? Numeric) && (b.is_a? Numeric) && (a <= b)
         end,
       greaterThan:
         lambda do |a, b|
-          (a.is_a? Numeric) && (a > b)
+          (a.is_a? Numeric) && (b.is_a? Numeric) && (a > b)
         end,
       greaterThanOrEqual:
         lambda do |a, b|
-          (a.is_a? Numeric) && (a >= b)
+          (a.is_a? Numeric) && (b.is_a? Numeric) && (a >= b)
         end,
       before:
         comparator(DATE_OPERAND) { |n| n < 0 },

data/lib/ldclient-rb/events.rb

@@ -91,6 +91,7 @@ module LaunchDarkly
   # @private
   class EventProcessor
     def initialize(sdk_key, config, client = nil, diagnostic_accumulator = nil, test_properties = nil)
+      raise ArgumentError, "sdk_key must not be nil" if sdk_key.nil?  # see LDClient constructor comment on sdk_key
       @logger = config.logger
       @inbox = SizedQueue.new(config.capacity < 100 ? 100 : config.capacity)
       @flush_task = Concurrent::TimerTask.new(execution_interval: config.flush_interval) do
@@ -319,7 +320,7 @@ module LaunchDarkly
         success = flush_workers.post do
           begin
             events_out = @formatter.make_output_events(payload.events, payload.summary)
-            result = @event_sender.send_event_data(events_out.to_json, false)
+            result = @event_sender.send_event_data(events_out.to_json, "#{events_out.length} events", false)
             @disabled.value = true if result.must_shutdown
             if !result.time_from_server.nil?
               @last_known_past_time.value = (result.time_from_server.to_f * 1000).to_i
@@ -348,7 +349,7 @@ module LaunchDarkly
       uri = URI(@config.events_uri + "/diagnostic")
       diagnostic_event_workers.post do
         begin
-          @event_sender.send_event_data(event.to_json, true)
+          @event_sender.send_event_data(event.to_json, "diagnostic event", true)
         rescue => e
           Util.log_exception(@config.logger, "Unexpected error in event processor", e)
         end

data/lib/ldclient-rb/impl/event_sender.rb

@@ -18,10 +18,9 @@ module LaunchDarkly
         @retry_interval = retry_interval
       end
 
-      def send_event_data(event_data, is_diagnostic)
+      def send_event_data(event_data, description, is_diagnostic)
         uri = is_diagnostic ? @diagnostic_uri : @events_uri
         payload_id = is_diagnostic ? nil : SecureRandom.uuid
-        description = is_diagnostic ? 'diagnostic event' : "#{event_data.length} events"
         res = nil
         (0..1).each do |attempt|
           if attempt > 0
@@ -30,7 +29,7 @@ module LaunchDarkly
           end
           begin
             @client.start if !@client.started?
-            @logger.debug { "[LDClient] sending #{description}: #{body}" }
+            @logger.debug { "[LDClient] sending #{description}: #{event_data}" }
             req = Net::HTTP::Post.new(uri)
             req.content_type = "application/json"
             req.body = event_data

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/ldclient.rb

@@ -33,6 +33,16 @@ module LaunchDarkly
     # @return [LDClient] The LaunchDarkly client instance
     #
     def initialize(sdk_key, config = Config.default, wait_for_sec = 5)
+      # Note that sdk_key is normally a required parameter, and a nil value would cause the SDK to
+      # fail in most configurations. However, there are some configurations where it would be OK
+      # (offline = true, *or* we are using LDD mode or the file data source and events are disabled
+      # so we're not connecting to any LD services) so rather than try to check for all of those
+      # up front, we will let the constructors for the data source implementations implement this
+      # fail-fast as appropriate, and just check here for the part regarding events.
+      if !config.offline? && config.send_events
+        raise ArgumentError, "sdk_key must not be nil" if sdk_key.nil?
+      end
+
       @sdk_key = sdk_key
 
       @event_factory_default = EventFactory.new(false)
@@ -56,7 +66,7 @@ module LaunchDarkly
       if @config.offline? || !@config.send_events
         @event_processor = NullEventProcessor.new
       else
-        @event_processor = EventProcessor.new(sdk_key, config, diagnostic_accumulator)
+        @event_processor = EventProcessor.new(sdk_key, config, nil, diagnostic_accumulator)
       end
 
       if @config.use_ldd?
@@ -352,12 +362,13 @@ module LaunchDarkly
       if config.offline?
         return NullUpdateProcessor.new
       end
-      requestor = Requestor.new(sdk_key, config)
+      raise ArgumentError, "sdk_key must not be nil" if sdk_key.nil?  # see LDClient constructor comment on sdk_key
       if config.stream?
-        StreamProcessor.new(sdk_key, config, requestor, diagnostic_accumulator)
+        StreamProcessor.new(sdk_key, config, diagnostic_accumulator)
       else
         config.logger.info { "Disabling streaming API" }
         config.logger.warn { "You should only disable the streaming API if instructed to do so by LaunchDarkly support" }
+        requestor = Requestor.new(sdk_key, config)
         PollingProcessor.new(config, requestor)
       end
     end

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/requestor.rb

@@ -26,14 +26,6 @@ module LaunchDarkly
       @cache = @config.cache_store
     end
 
-    def request_flag(key)
-      make_request("/sdk/latest-flags/" + key)
-    end
-
-    def request_segment(key)
-      make_request("/sdk/latest-segments/" + key)
-    end
-
     def request_all_data()
       make_request("/sdk/latest-all")
     end

data/lib/ldclient-rb/stream.rb

@@ -10,10 +10,6 @@ module LaunchDarkly
   # @private
   DELETE = :delete
   # @private
-  INDIRECT_PUT = :'indirect/put'
-  # @private
-  INDIRECT_PATCH = :'indirect/patch'
-  # @private
   READ_TIMEOUT_SECONDS = 300  # 5 minutes; the stream should send a ping every 3 minutes
 
   # @private
@@ -24,11 +20,10 @@ module LaunchDarkly
 
   # @private
   class StreamProcessor
-    def initialize(sdk_key, config, requestor, diagnostic_accumulator = nil)
+    def initialize(sdk_key, config, diagnostic_accumulator = nil)
       @sdk_key = sdk_key
       @config = config
       @feature_store = config.feature_store
-      @requestor = requestor
       @initialized = Concurrent::AtomicBoolean.new(false)
       @started = Concurrent::AtomicBoolean.new(false)
       @stopped = Concurrent::AtomicBoolean.new(false)
@@ -112,24 +107,6 @@ module LaunchDarkly
             break
           end
         end
-      elsif method == INDIRECT_PUT
-        all_data = @requestor.request_all_data
-        @feature_store.init({
-          FEATURES => all_data[:flags],
-          SEGMENTS => all_data[:segments]
-        })
-        @initialized.make_true
-        @config.logger.info { "[LDClient] Stream initialized (via indirect message)" }
-      elsif method == INDIRECT_PATCH
-        key = key_for_path(FEATURES, message.data)
-        if key
-          @feature_store.upsert(FEATURES, @requestor.request_flag(key))
-        else
-          key = key_for_path(SEGMENTS, message.data)
-          if key
-            @feature_store.upsert(SEGMENTS, @requestor.request_segment(key))
-          end
-        end
       else
         @config.logger.warn { "[LDClient] Unknown message received: #{method}" }
       end

data/lib/ldclient-rb/user_filter.rb

@@ -15,8 +15,9 @@ module LaunchDarkly
       user_private_attrs = Set.new((user_props[:privateAttributeNames] || []).map(&:to_sym))
 
       filtered_user_props, removed = filter_values(user_props, user_private_attrs, ALLOWED_TOP_LEVEL_KEYS, IGNORED_TOP_LEVEL_KEYS)
-      if user_props.has_key?(:custom)
-        filtered_user_props[:custom], removed_custom = filter_values(user_props[:custom], user_private_attrs)
+      custom = user_props[:custom]
+      if !custom.nil?
+        filtered_user_props[:custom], removed_custom = filter_values(custom, user_private_attrs)
         removed.merge(removed_custom)
       end
 

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "5.7.1"
+  VERSION = "5.8.1"
 end

data/spec/evaluation_spec.rb

@@ -495,13 +495,13 @@ describe LaunchDarkly::Evaluation do
       # mixed strings and numbers
       [ :in,                 "99", 99, false ],
       [ :in,                  99, "99", false ],
-      #[ :contains,           "99", 99, false ],    # currently throws exception - would return false in Java SDK
-      #[ :startsWith,         "99", 99, false ],  # currently throws exception - would return false in Java SDK
-      #[ :endsWith,           "99", 99, false ]     # currently throws exception - would return false in Java SDK
+      [ :contains,           "99", 99, false ],
+      [ :startsWith,         "99", 99, false ],
+      [ :endsWith,           "99", 99, false ],
       [ :lessThanOrEqual,    "99", 99, false ],
-      #[ :lessThanOrEqual,    99, "99", false ],    # currently throws exception - would return false in Java SDK
+      [ :lessThanOrEqual,    99, "99", false ],
       [ :greaterThanOrEqual, "99", 99, false ],
-      #[ :greaterThanOrEqual, 99, "99", false ], # currently throws exception - would return false in Java SDK
+      [ :greaterThanOrEqual, 99, "99", false ],
       
       # regex
       [ :matches, "hello world", "hello.*rld",     true ],
@@ -509,7 +509,7 @@ describe LaunchDarkly::Evaluation do
       [ :matches, "hello world", "l+",             true ],
       [ :matches, "hello world", "(world|planet)", true ],
       [ :matches, "hello world", "aloha",          false ],
-      #[ :matches, "hello world", "***not a regex", false ]   # currently throws exception - same as Java SDK
+      [ :matches, "hello world", "***not a regex", false ],
 
       # dates
       [ :before, dateStr1, dateStr2,    true ],

data/spec/event_sender_spec.rb

@@ -27,7 +27,7 @@ module LaunchDarkly
         with_sender_and_server do |es, server|
           server.setup_ok_response("/bulk", "")
 
-          result = es.send_event_data(fake_data, false)
+          result = es.send_event_data(fake_data, "", false)
 
           expect(result.success).to be true
           expect(result.must_shutdown).to be false
@@ -49,8 +49,8 @@ module LaunchDarkly
         with_sender_and_server do |es, server|
           server.setup_ok_response("/bulk", "")
 
-          result1 = es.send_event_data(fake_data, false)
-          result2 = es.send_event_data(fake_data, false)
+          result1 = es.send_event_data(fake_data, "", false)
+          result2 = es.send_event_data(fake_data, "", false)
           expect(result1.success).to be true
           expect(result2.success).to be true
 
@@ -66,7 +66,7 @@ module LaunchDarkly
         with_sender_and_server do |es, server|
           server.setup_ok_response("/diagnostic", "")
 
-          result = es.send_event_data(fake_data, true)
+          result = es.send_event_data(fake_data, "", true)
 
           expect(result.success).to be true
           expect(result.must_shutdown).to be false
@@ -94,7 +94,7 @@ module LaunchDarkly
 
               es = make_sender(server)
 
-              result = es.send_event_data(fake_data, false)
+              result = es.send_event_data(fake_data, "", false)
               
               expect(result.success).to be true
 
@@ -116,7 +116,7 @@ module LaunchDarkly
               res.status = req_count == 2 ? 200 : status
             end
 
-            result = es.send_event_data(fake_data, false)
+            result = es.send_event_data(fake_data, "", false)
 
             expect(result.success).to be true
             expect(result.must_shutdown).to be false
@@ -141,7 +141,7 @@ module LaunchDarkly
               res.status = req_count == 3 ? 200 : status
             end
 
-            result = es.send_event_data(fake_data, false)
+            result = es.send_event_data(fake_data, "", false)
 
             expect(result.success).to be false
             expect(result.must_shutdown).to be false
@@ -164,7 +164,7 @@ module LaunchDarkly
               res.status = status
             end
 
-            result = es.send_event_data(fake_data, false)
+            result = es.send_event_data(fake_data, "", false)
 
             expect(result.success).to be false
             expect(result.must_shutdown).to be true

data/spec/events_spec.rb

@@ -408,6 +408,17 @@ describe LaunchDarkly::EventProcessor do
     end
   end
 
+  it "treats nil value for custom the same as an empty hash" do
+    with_processor_and_sender(default_config) do |ep, sender|
+      user_with_nil_custom = { key: "userkey", custom: nil }
+      e = { kind: "identify", key: "userkey", user: user_with_nil_custom }
+      ep.add_event(e)
+
+      output = flush_and_get_events(ep, sender)
+      expect(output).to contain_exactly(e)
+    end
+  end
+
   it "does a final flush when shutting down" do
     with_processor_and_sender(default_config) do |ep, sender|
       e = { kind: "identify", key: user[:key], user: user }
@@ -578,7 +589,7 @@ describe LaunchDarkly::EventProcessor do
       @diagnostic_payloads = Queue.new
     end
 
-    def send_event_data(data, is_diagnostic)
+    def send_event_data(data, description, is_diagnostic)
       (is_diagnostic ? @diagnostic_payloads : @analytics_payloads).push(JSON.parse(data, symbolize_names: true))
       @result
     end

data/spec/ldclient_end_to_end_spec.rb

@@ -0,0 +1,123 @@
+require "http_util"
+require "spec_helper"
+
+
+SDK_KEY = "sdk-key"
+
+USER = { key: 'userkey' }
+
+ALWAYS_TRUE_FLAG = { key: 'flagkey', version: 1, on: false, offVariation: 1, variations: [ false, true ] }
+DATA_WITH_ALWAYS_TRUE_FLAG = {
+  flags: { ALWAYS_TRUE_FLAG[:key  ].to_sym => ALWAYS_TRUE_FLAG },
+  segments: {}
+}
+PUT_EVENT_WITH_ALWAYS_TRUE_FLAG = "event: put\ndata:{\"data\":#{DATA_WITH_ALWAYS_TRUE_FLAG.to_json}}\n\n'"
+
+def with_client(config)
+  client = LaunchDarkly::LDClient.new(SDK_KEY, config)
+  begin
+    yield client
+  ensure
+    client.close
+  end
+end
+
+module LaunchDarkly
+  # Note that we can't do end-to-end tests in streaming mode until we have a test server that can do streaming
+  # responses, which is difficult in WEBrick.
+
+  describe "LDClient end-to-end" do
+    it "starts in polling mode" do
+      with_server do |poll_server|
+        poll_server.setup_ok_response("/sdk/latest-all", DATA_WITH_ALWAYS_TRUE_FLAG.to_json, "application/json")
+        
+        config = Config.new(
+          stream: false,
+          base_uri: poll_server.base_uri.to_s,
+          send_events: false,
+          logger: NullLogger.new
+        )
+        with_client(config) do |client|
+          expect(client.initialized?).to be true
+          expect(client.variation(ALWAYS_TRUE_FLAG[:key], USER, false)).to be true
+        end
+      end
+    end
+
+    it "fails in polling mode with 401 error" do
+      with_server do |poll_server|
+        poll_server.setup_status_response("/sdk/latest-all", 401)
+        
+        config = Config.new(
+          stream: false,
+          base_uri: poll_server.base_uri.to_s,
+          send_events: false,
+          logger: NullLogger.new
+        )
+        with_client(config) do |client|
+          expect(client.initialized?).to be false
+          expect(client.variation(ALWAYS_TRUE_FLAG[:key], USER, false)).to be false
+        end
+      end
+    end
+
+    it "sends event without diagnostics" do
+      with_server do |poll_server|
+        with_server do |events_server|
+          events_server.setup_ok_response("/bulk", "")
+          poll_server.setup_ok_response("/sdk/latest-all", '{"flags":{},"segments":{}}', "application/json")
+          
+          config = Config.new(
+            stream: false,
+            base_uri: poll_server.base_uri.to_s,
+            events_uri: events_server.base_uri.to_s,
+            diagnostic_opt_out: true,
+            logger: NullLogger.new
+          )
+          with_client(config) do |client|
+            client.identify(USER)
+            client.flush
+
+            req, body = events_server.await_request_with_body
+            expect(req.header['authorization']).to eq [ SDK_KEY ]
+            data = JSON.parse(body)
+            expect(data.length).to eq 1
+            expect(data[0]["kind"]).to eq "identify"
+          end
+        end
+      end
+    end
+
+    it "sends diagnostic event" do
+      with_server do |poll_server|
+        with_server do |events_server|
+          events_server.setup_ok_response("/bulk", "")
+          events_server.setup_ok_response("/diagnostic", "")
+          poll_server.setup_ok_response("/sdk/latest-all", '{"flags":{},"segments":{}}', "application/json")
+          
+          config = Config.new(
+            stream: false,
+            base_uri: poll_server.base_uri.to_s,
+            events_uri: events_server.base_uri.to_s,
+            logger: NullLogger.new
+          )
+          with_client(config) do |client|
+            user = { key: 'userkey' }
+            client.identify(user)
+            client.flush
+
+            req0, body0 = events_server.await_request_with_body
+            req1, body1 = events_server.await_request_with_body
+            req = req0.path == "/diagnostic" ? req0 : req1
+            body = req0.path == "/diagnostic" ? body0 : body1
+            expect(req.header['authorization']).to eq [ SDK_KEY ]
+            data = JSON.parse(body)
+            expect(data["kind"]).to eq "diagnostic-init"
+          end
+        end
+      end
+    end
+
+    # TODO: TLS tests with self-signed cert
+  end
+end

data/spec/ldclient_spec.rb

@@ -49,6 +49,46 @@ describe LaunchDarkly::LDClient do
     client.instance_variable_get(:@event_processor)
   end
 
+  describe "constructor requirement of non-nil sdk key" do
+    it "is not enforced when offline" do
+      subject.new(nil, offline_config)
+    end
+
+    it "is not enforced if use_ldd is true and send_events is false" do
+      subject.new(nil, LaunchDarkly::Config.new({ use_ldd: true, send_events: false }))
+    end
+
+    it "is not enforced if using file data and send_events is false" do
+      source = LaunchDarkly::FileDataSource.factory({})
+      subject.new(nil, LaunchDarkly::Config.new({ data_source: source, send_events: false }))
+    end
+
+    it "is enforced in streaming mode even if send_events is false" do
+      expect {
+        subject.new(nil, LaunchDarkly::Config.new({ send_events: false }))
+      }.to raise_error(ArgumentError)
+    end
+
+    it "is enforced in polling mode even if send_events is false" do
+      expect {
+        subject.new(nil, LaunchDarkly::Config.new({ stream: false, send_events: false }))
+      }.to raise_error(ArgumentError)
+    end
+
+    it "is enforced if use_ldd is true and send_events is true" do
+      expect {
+        subject.new(nil, LaunchDarkly::Config.new({ use_ldd: true }))
+      }.to raise_error(ArgumentError)
+    end
+
+    it "is enforced if using file data and send_events is true" do
+      source = LaunchDarkly::FileDataSource.factory({})
+      expect {
+        subject.new(nil, LaunchDarkly::Config.new({ data_source: source }))
+      }.to raise_error(ArgumentError)
+    end
+  end
+
   describe '#variation' do
     feature_with_value = { key: "key", on: false, offVariation: 0, variations: ["value"], version: 100,
       trackEvents: true, debugEventsUntilDate: 1000 }

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

data/spec/requestor_spec.rb

@@ -193,38 +193,4 @@ describe LaunchDarkly::Requestor do
       end
     end
   end
-
-  describe "request_flag" do
-    it "uses expected URI and headers" do
-      with_server do |server|
-        with_requestor(server.base_uri.to_s) do |requestor|
-          server.setup_ok_response("/", "{}")
-          requestor.request_flag("key")
-          expect(server.requests.count).to eq 1
-          expect(server.requests[0].unparsed_uri).to eq "/sdk/latest-flags/key"
-          expect(server.requests[0].header).to include({
-            "authorization" => [ $sdk_key ],
-            "user-agent" => [ "RubyClient/" + LaunchDarkly::VERSION ]
-          })
-        end
-      end
-    end
-  end
-
-  describe "request_segment" do
-    it "uses expected URI and headers" do
-      with_server do |server|
-        with_requestor(server.base_uri.to_s) do |requestor|
-          server.setup_ok_response("/", "{}")
-          requestor.request_segment("key")
-          expect(server.requests.count).to eq 1
-          expect(server.requests[0].unparsed_uri).to eq "/sdk/latest-segments/key"
-          expect(server.requests[0].header).to include({
-            "authorization" => [ $sdk_key ],
-            "user-agent" => [ "RubyClient/" + LaunchDarkly::VERSION ]
-          })
-        end
-      end
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
 require "ldclient-rb"
 
 $null_log = ::Logger.new($stdout)

data/spec/stream_spec.rb

@@ -4,8 +4,7 @@ require "spec_helper"
 describe LaunchDarkly::StreamProcessor do
   subject { LaunchDarkly::StreamProcessor }
   let(:config) { LaunchDarkly::Config.new }
-  let(:requestor) { double() }
-  let(:processor) { subject.new("sdk_key", config, requestor) }
+  let(:processor) { subject.new("sdk_key", config) }
 
   describe '#process_message' do
     let(:put_message) { SSE::StreamEvent.new(:put, '{"data":{"flags":{"asdf": {"key": "asdf"}},"segments":{"segkey": {"key": "segkey"}}}}') }
@@ -13,8 +12,6 @@ describe LaunchDarkly::StreamProcessor do
     let(:patch_seg_message) { SSE::StreamEvent.new(:patch, '{"path": "/segments/key", "data": {"key": "asdf", "version": 1}}') }
     let(:delete_flag_message) { SSE::StreamEvent.new(:delete, '{"path": "/flags/key", "version": 2}') }
     let(:delete_seg_message) { SSE::StreamEvent.new(:delete, '{"path": "/segments/key", "version": 2}') }
-    let(:indirect_patch_flag_message) { SSE::StreamEvent.new(:'indirect/patch', "/flags/key") }
-    let(:indirect_patch_segment_message) { SSE::StreamEvent.new(:'indirect/patch', "/segments/key") }
 
     it "will accept PUT methods" do
       processor.send(:process_message, put_message)
@@ -39,18 +36,6 @@ describe LaunchDarkly::StreamProcessor do
       processor.send(:process_message, delete_seg_message)
       expect(config.feature_store.get(LaunchDarkly::SEGMENTS, "key")).to eq(nil)
     end
-    it "will accept INDIRECT PATCH method for flags" do
-      flag = { key: 'key', version: 1 }
-      allow(requestor).to receive(:request_flag).with(flag[:key]).and_return(flag)
-      processor.send(:process_message, indirect_patch_flag_message);
-      expect(config.feature_store.get(LaunchDarkly::FEATURES, flag[:key])).to eq(flag)
-    end
-    it "will accept INDIRECT PATCH method for segments" do
-      segment = { key: 'key', version: 1 }
-      allow(requestor).to receive(:request_segment).with(segment[:key]).and_return(segment)
-      processor.send(:process_message, indirect_patch_segment_message);
-      expect(config.feature_store.get(LaunchDarkly::SEGMENTS, segment[:key])).to eq(segment)
-    end
     it "will log a warning if the method is not recognized" do
       expect(processor.instance_variable_get(:@config).logger).to receive :warn
       processor.send(:process_message, SSE::StreamEvent.new(type: :get, data: "", id: nil))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 5.8.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: diplomat
   requirement: !ruby/object:Gem::Requirement
@@ -151,25 +137,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
+        version: '1.12'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: semantic
   requirement: !ruby/object:Gem::Requirement
@@ -212,12 +206,25 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
 description: Official LaunchDarkly SDK for Ruby
 email:
 - team@launchdarkly.com
 executables: []
-extensions:
-- ext/mkrf_conf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
@@ -239,7 +246,6 @@ files:
 - LICENSE.txt
 - README.md
 - azure-pipelines.yml
-- ext/mkrf_conf.rb
 - launchdarkly-server-sdk.gemspec
 - lib/launchdarkly-server-sdk.rb
 - lib/ldclient-rb.rb
@@ -302,6 +308,7 @@ files:
 - spec/integrations/store_wrapper_spec.rb
 - spec/launchdarkly-server-sdk_spec.rb
 - spec/launchdarkly-server-sdk_spec_autoloadtest.rb
+- spec/ldclient_end_to_end_spec.rb
 - spec/ldclient_spec.rb
 - spec/newrelic_spec.rb
 - spec/polling_spec.rb
@@ -360,6 +367,7 @@ test_files:
 - spec/integrations/store_wrapper_spec.rb
 - spec/launchdarkly-server-sdk_spec.rb
 - spec/launchdarkly-server-sdk_spec_autoloadtest.rb
+- spec/ldclient_end_to_end_spec.rb
 - spec/ldclient_spec.rb
 - spec/newrelic_spec.rb
 - spec/polling_spec.rb

data/ext/mkrf_conf.rb

@@ -1,11 +0,0 @@
-require "rubygems"
-
-
-# From http://stackoverflow.com/questions/5830835/how-to-add-openssl-dependency-to-gemspec
-# the whole reason this file exists:   to return an error if openssl
-# isn't installed.
-require "openssl"
-
-f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")   # create dummy rakefile to indicate success
-f.write("task :default\n")
-f.close