ldclient-rb 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f975d234beca67eed5238b9e693fdfb39de00e
-  data.tar.gz: 93e6c8e3de9f9394f1cf9acb64218fda1b873ff6
+  metadata.gz: 743c38bedf7c153667c5a38fcc2deaffd557f09d
+  data.tar.gz: c352ed4f8c412e2c19edcbe94d5813a2478ddade
 SHA512:
-  metadata.gz: 1aacb9669181a5cee75fcfdad3170a195bd43bb572203251daa0fd892e94ecf95bd8627ee124fa961884a44d38209271e9f9fbb094a7773b123328d33011e6ab
-  data.tar.gz: 12b7baa6f4176b357b11307faf9588a918e34059d1a5bc2fc97e5c6076f25ad1b5d5f13b328b4295d4c1bd4a90dfb3fa02daf75549886948e5311c2b91753bed
+  metadata.gz: 6add89667ba084d57d7e49b52ced7ff279aa491aabc2285354353ce6b6f8393f14c04bef18062b1762ab6cf0bc97b27060009e589f78523fe8acaba9c9ff4a3d
+  data.tar.gz: 0a46454ca002c7fc35d15fc2343097727552cdc81ef517d96032befe77a451ddbd9e3f99b048cec5e132480c4ebb124685a8cdd282c6982f1c40844ceef7313b

data/.circleci/config.yml

@@ -8,7 +8,8 @@ workflows:
       - test-2.2
       - test-2.3
       - test-2.4
-      - test-jruby-9.1
+      - test-2.5
+      - test-jruby-9.2
 
 ruby-docker-template: &ruby-docker-template
   steps:
@@ -17,6 +18,7 @@ ruby-docker-template: &ruby-docker-template
         if [[ $CIRCLE_JOB == test-jruby* ]]; then
           gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
         fi
+    - run: ruby -v
     - run: gem install bundler
     - run: bundle install
     - run: mkdir ./rspec
@@ -40,9 +42,14 @@ jobs:
   test-2.4:
     <<: *ruby-docker-template
     docker:
-      - image: circleci/ruby:2.4.3-jessie
+      - image: circleci/ruby:2.4.4-stretch
       - image: redis
-  test-jruby-9.1:
+  test-2.5:
+    <<: *ruby-docker-template
+    docker:
+      - image: circleci/ruby:2.5.1-stretch
+      - image: redis
+  test-jruby-9.2:
     <<: *ruby-docker-template
     docker:
       - image: circleci/jruby:9-jdk
@@ -54,7 +61,7 @@ jobs:
     machine:
       image: circleci/classic:latest
     environment:
-      - RUBIES: "ruby-2.1.9 ruby-2.0.0 ruby-1.9.3 jruby-9.0.5.0"
+      - RUBIES: "jruby-9.1.17.0"
     steps:
       - run: sudo apt-get -q update
       - run: sudo apt-get -qy install redis-server

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.0.0] - 2018-06-26
+### Changed:
+- The client no longer uses Celluloid for streaming I/O. Instead, it uses [socketry](https://github.com/socketry/socketry).
+- The client now treats most HTTP 4xx errors as unrecoverable: that is, after receiving such an error, it will not make any more HTTP requests for the lifetime of the client instance, in effect taking the client offline. This is because such errors indicate either a configuration problem (invalid SDK key) or a bug, which is not likely to resolve without a restart or an upgrade. This does not apply if the error is 400, 408, 429, or any 5xx error.
+- During initialization, if the client receives any of the unrecoverable errors described above, the client constructor will return immediately; previously it would continue waiting until a timeout. The `initialized?` method will return false in this case.
+
+### Removed:
+- The SDK no longer supports Ruby versions below 2.2.6, or JRuby below 9.1.16.
+
 ## [4.0.0] - 2018-05-10
 
 ### Changed:

data/README.md

@@ -7,15 +7,19 @@ LaunchDarkly SDK for Ruby
 [![Test Coverage](https://codeclimate.com/github/launchdarkly/ruby-client/badges/coverage.svg)](https://codeclimate.com/github/launchdarkly/ruby-client/coverage)
 [![security](https://hakiri.io/github/launchdarkly/ruby-client/master.svg)](https://hakiri.io/github/launchdarkly/ruby-client/master)
 
+Supported Ruby versions
+-----------------------
+
+This version of the LaunchDarkly SDK has a minimum Ruby version of 2.2.6, or 9.1.6 for JRuby.
+
 Quick setup
 -----------
 
 0. Install the Ruby SDK with `gem`
 
 ```shell
-gem install ldclient-rb --prerelease
+gem install ldclient-rb
 ```
-Note: The `--prerelease` flag is there to satisfy the dependency of celluloid 0.18pre which we have tested extensively and have found stable in our use case.  Unfortunately, the upstream provider has not promoted this version to stable yet.   See [here](https://github.com/celluloid/celluloid/issues/762)  This is not required for use in a Gemfile.
 
 1. Require the LaunchDarkly client:
 
@@ -79,7 +83,7 @@ Note that this gem will automatically switch to using the Rails logger it is det
 
 HTTPS proxy
 ------------
-The Ruby SDK uses Faraday to handle all of its network traffic. Faraday provides built-in support for the use of an  HTTPS proxy. If the HTTPS_PROXY environment variable is present then the SDK will proxy all network requests through the URL provided.
+The Ruby SDK uses Faraday and Socketry to handle its network traffic. Both of these provide built-in support for the use of an  HTTPS proxy. If the HTTPS_PROXY environment variable is present then the SDK will proxy all network requests through the URL provided.
 
 How to set the HTTPS_PROXY environment variable on Mac/Linux systems:
 ```

data/ldclient-rb.gemspec

@@ -26,36 +26,18 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0"
   spec.add_development_dependency "redis", "~> 3.3.5"
   spec.add_development_dependency "connection_pool", ">= 2.1.2"
-  if RUBY_VERSION >= "2.0.0"
-    spec.add_development_dependency "rake", "~> 10.0"
-    spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
-  else
-    spec.add_development_dependency "rake", "12.1.0"
-    # higher versions of rake fail to install in JRuby 1.7
-  end
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
   spec.add_development_dependency "timecop", "~> 0.9.1"
 
   spec.add_runtime_dependency "json", [">= 1.8", "< 3"]
-  if RUBY_VERSION >= "2.1.0"
-    spec.add_runtime_dependency "faraday", [">= 0.9", "< 2"]
-    spec.add_runtime_dependency "faraday-http-cache", [">= 1.3.0", "< 3"]
-  else
-    spec.add_runtime_dependency "faraday", [">= 0.9", "< 0.14.0"]
-    spec.add_runtime_dependency "faraday-http-cache", [">= 1.3.0", "< 2"]
-  end
+  spec.add_runtime_dependency "faraday", [">= 0.9", "< 2"]
+  spec.add_runtime_dependency "faraday-http-cache", [">= 1.3.0", "< 3"]
   spec.add_runtime_dependency "semantic", "~> 1.6.0"
   spec.add_runtime_dependency "thread_safe", "~> 0.3"
   spec.add_runtime_dependency "net-http-persistent", "~> 2.9"
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0.4"
   spec.add_runtime_dependency "hashdiff", "~> 0.2"
-  spec.add_runtime_dependency "ld-celluloid-eventsource", "~> 0.11.0"
-  spec.add_runtime_dependency "celluloid", "~> 0.18.0.pre" # transitive dep; specified here for more control
-
-  if RUBY_VERSION >= "2.2.2"
-    spec.add_runtime_dependency "nio4r", "< 3" # for maximum ruby version compatibility.
-  else
-    spec.add_runtime_dependency "nio4r", "~> 1.1" # for maximum ruby version compatibility.
-  end
-
-  spec.add_runtime_dependency "waitutil", "0.2"
+  spec.add_runtime_dependency "http_tools", '~> 0.4.5'
+  spec.add_runtime_dependency "socketry", "~> 0.5.1"
 end

data/lib/ldclient-rb.rb

@@ -1,4 +1,5 @@
 require "ldclient-rb/version"
+require "ldclient-rb/util"
 require "ldclient-rb/evaluation"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/cache_store"

data/lib/ldclient-rb/events.rb

@@ -222,17 +222,24 @@ module LaunchDarkly
       if !payload.events.empty? || !payload.summary.counters.empty?
         # If all available worker threads are busy, success will be false and no job will be queued.
         success = flush_workers.post do
-          resp = EventPayloadSendTask.new.run(@sdk_key, @config, @client, payload, @formatter)
-          handle_response(resp) if !resp.nil?
+          begin
+            resp = EventPayloadSendTask.new.run(@sdk_key, @config, @client, payload, @formatter)
+            handle_response(resp) if !resp.nil?
+          rescue => e
+            @config.logger.warn { "[LDClient] Unexpected error in event processor: #{e.inspect}. \nTrace: #{e.backtrace}" }
+          end
         end
         buffer.clear if success # Reset our internal state, these events now belong to the flush worker
       end
     end
 
     def handle_response(res)
-      if res.status == 401
-        @config.logger.error { "[LDClient] Received 401 error, no further events will be posted since SDK key is invalid" }
-        @disabled.value = true
+      if res.status >= 400
+        message = Util.http_error_message(res.status, "event delivery", "some events were dropped")
+        @config.logger.error { "[LDClient] #{message}" }
+        if !Util.http_error_recoverable?(res.status)
+          @disabled.value = true
+        end
       else
         if !res.headers.nil? && res.headers.has_key?("Date")
           begin
@@ -309,8 +316,7 @@ module LaunchDarkly
           next
         end
         if res.status < 200 || res.status >= 300
-          config.logger.error { "[LDClient] Unexpected status code while processing events: #{res.status}" }
-          if res.status >= 500
+          if Util.http_error_recoverable?(res.status)
             next
           end
         end

data/lib/ldclient-rb/ldclient.rb

@@ -1,7 +1,7 @@
+require "concurrent/atomics"
 require "digest/sha1"
 require "logger"
 require "benchmark"
-require "waitutil"
 require "json"
 require "openssl"
 
@@ -41,7 +41,9 @@ module LaunchDarkly
 
       requestor = Requestor.new(sdk_key, config)
 
-      if !@config.offline?
+      if @config.offline?
+        @update_processor = NullUpdateProcessor.new
+      else
         if @config.update_processor.nil?
           if @config.stream?
             @update_processor = StreamProcessor.new(sdk_key, config, requestor)
@@ -53,16 +55,15 @@ module LaunchDarkly
         else
           @update_processor = @config.update_processor
         end
-        @update_processor.start
       end
 
-      if !@config.offline? && wait_for_sec > 0
-        begin
-          WaitUtil.wait_for_condition("LaunchDarkly client initialization", timeout_sec: wait_for_sec, delay_sec: 0.1) do
-            initialized?
-          end
-        rescue WaitUtil::TimeoutError
+      ready = @update_processor.start
+      if wait_for_sec > 0
+        ok = ready.wait(wait_for_sec)
+        if !ok
           @config.logger.error { "[LDClient] Timeout encountered waiting for LaunchDarkly client initialization" }
+        elsif !@update_processor.initialized?
+          @config.logger.error { "[LDClient] LaunchDarkly client initialization failed" }
         end
       end
     end
@@ -220,9 +221,7 @@ module LaunchDarkly
     # @return [void]
     def close
       @config.logger.info { "[LDClient] Closing LaunchDarkly client..." }
-      if not @config.offline?
-        @update_processor.stop
-      end
+      @update_processor.stop
       @event_processor.stop
       @store.stop
     end
@@ -255,4 +254,22 @@ module LaunchDarkly
 
     private :evaluate, :log_exception, :sanitize_user, :make_feature_event
   end
+
+  #
+  # Used internally when the client is offline.
+  #
+  class NullUpdateProcessor
+    def start
+      e = Concurrent::Event.new
+      e.set
+      e
+    end
+
+    def initialized?
+      true
+    end
+
+    def stop
+    end
+  end
 end

data/lib/ldclient-rb/polling.rb

@@ -9,6 +9,7 @@ module LaunchDarkly
       @initialized = Concurrent::AtomicBoolean.new(false)
       @started = Concurrent::AtomicBoolean.new(false)
       @stopped = Concurrent::AtomicBoolean.new(false)
+      @ready = Concurrent::Event.new
     end
 
     def initialized?
@@ -16,9 +17,10 @@ module LaunchDarkly
     end
 
     def start
-      return unless @started.make_true
+      return @ready unless @started.make_true
       @config.logger.info { "[LDClient] Initializing polling connection" }
       create_worker
+      @ready
     end
 
     def stop
@@ -39,6 +41,7 @@ module LaunchDarkly
         })
         if @initialized.make_true
           @config.logger.info { "[LDClient] Polling connection initialized" }
+          @ready.set
         end
       end
     end
@@ -47,20 +50,24 @@ module LaunchDarkly
       @worker = Thread.new do
         @config.logger.debug { "[LDClient] Starting polling worker" }
         while !@stopped.value do
+          started_at = Time.now
           begin
-            started_at = Time.now
             poll
-            delta = @config.poll_interval - (Time.now - started_at)
-            if delta > 0
-              sleep(delta)
+          rescue UnexpectedResponseError => e
+            message = Util.http_error_message(e.status, "polling request", "will retry")
+            @config.logger.error { "[LDClient] #{message}" };
+            if !Util.http_error_recoverable?(e.status)
+              @ready.set  # if client was waiting on us, make it stop waiting - has no effect if already set
+              stop
             end
-          rescue InvalidSDKKeyError
-            @config.logger.error { "[LDClient] Received 401 error, no further polling requests will be made since SDK key is invalid" };
-            stop
           rescue StandardError => exn
             @config.logger.error { "[LDClient] Exception while polling: #{exn.inspect}" }
             # TODO: log_exception(__method__.to_s, exn)
           end
+          delta = @config.poll_interval - (Time.now - started_at)
+          if delta > 0
+            sleep(delta)
+          end
         end
       end
     end

data/lib/ldclient-rb/requestor.rb

@@ -4,7 +4,14 @@ require "faraday/http_cache"
 
 module LaunchDarkly
 
-  class InvalidSDKKeyError < StandardError
+  class UnexpectedResponseError < StandardError
+    def initialize(status)
+      @status = status
+    end
+
+    def status
+      @status
+    end
   end
 
   class Requestor
@@ -13,7 +20,7 @@ module LaunchDarkly
       @config = config
       @client = Faraday.new do |builder|
         builder.use :http_cache, store: @config.cache_store
-
+        
         builder.adapter :net_http_persistent
       end
     end
@@ -44,19 +51,8 @@ module LaunchDarkly
 
       @config.logger.debug { "[LDClient] Got response from uri: #{uri}\n\tstatus code: #{res.status}\n\theaders: #{res.headers}\n\tbody: #{res.body}" }
 
-      if res.status == 401
-        @config.logger.error { "[LDClient] Invalid SDK key" }
-        raise InvalidSDKKeyError
-      end
-
-      if res.status == 404
-        @config.logger.error { "[LDClient] Resource not found" }
-        return nil
-      end
-
       if res.status < 200 || res.status >= 300
-        @config.logger.error { "[LDClient] Unexpected status code #{res.status}" }
-        return nil
+        raise UnexpectedResponseError.new(res.status)
       end
 
       JSON.parse(res.body, symbolize_names: true)

data/lib/ldclient-rb/stream.rb

@@ -1,6 +1,6 @@
 require "concurrent/atomics"
 require "json"
-require "celluloid/eventsource"
+require "sse_client"
 
 module LaunchDarkly
   PUT = :put
@@ -24,6 +24,7 @@ module LaunchDarkly
       @initialized = Concurrent::AtomicBoolean.new(false)
       @started = Concurrent::AtomicBoolean.new(false)
       @stopped = Concurrent::AtomicBoolean.new(false)
+      @ready = Concurrent::Event.new
     end
 
     def initialized?
@@ -31,37 +32,34 @@ module LaunchDarkly
     end
 
     def start
-      return unless @started.make_true
+      return @ready unless @started.make_true
 
       @config.logger.info { "[LDClient] Initializing stream connection" }
       
-      headers = 
-      {
+      headers = {
         'Authorization' => @sdk_key,
         'User-Agent' => 'RubyClient/' + LaunchDarkly::VERSION
       }
-      opts = {:headers => headers, :with_credentials => true, :proxy => @config.proxy, :read_timeout => READ_TIMEOUT_SECONDS}
-      @es = Celluloid::EventSource.new(@config.stream_uri + "/all", opts) do |conn|
-        conn.on(PUT) { |message| process_message(message, PUT) }
-        conn.on(PATCH) { |message| process_message(message, PATCH) }
-        conn.on(DELETE) { |message| process_message(message, DELETE) }
-        conn.on(INDIRECT_PUT) { |message| process_message(message, INDIRECT_PUT) }
-        conn.on(INDIRECT_PATCH) { |message| process_message(message, INDIRECT_PATCH) }
+      opts = {
+        headers: headers,
+        proxy: @config.proxy,
+        read_timeout: READ_TIMEOUT_SECONDS,
+        logger: @config.logger
+      }
+      @es = SSE::SSEClient.new(@config.stream_uri + "/all", opts) do |conn|
+        conn.on_event { |event| process_message(event, event.type) }
         conn.on_error { |err|
-          @config.logger.error { "[LDClient] Unexpected status code #{err[:status_code]} from streaming connection" }
-          if err[:status_code] == 401
-            @config.logger.error { "[LDClient] Received 401 error, no further streaming connection will be made since SDK key is invalid" }
+          status = err[:status_code]
+          message = Util.http_error_message(status, "streaming connection", "will retry")
+          @config.logger.error { "[LDClient] #{message}" }
+          if !Util.http_error_recoverable?(status)
+            @ready.set  # if client was waiting on us, make it stop waiting - has no effect if already set
             stop
           end
         }
       end
-    end
-
-    def stop
-      if @stopped.make_true
-        @es.close
-        @config.logger.info { "[LDClient] Stream connection stopped" }
-      end
+      
+      @ready
     end
 
     def stop
@@ -83,21 +81,22 @@ module LaunchDarkly
         })
         @initialized.make_true
         @config.logger.info { "[LDClient] Stream initialized" }
+        @ready.set
       elsif method == PATCH
-        message = JSON.parse(message.data, symbolize_names: true)
+        data = JSON.parse(message.data, symbolize_names: true)
         for kind in [FEATURES, SEGMENTS]
-          key = key_for_path(kind, message[:path])
+          key = key_for_path(kind, data[:path])
           if key
-            @feature_store.upsert(kind, message[:data])
+            @feature_store.upsert(kind, data[:data])
             break
           end
         end
       elsif method == DELETE
-        message = JSON.parse(message.data, symbolize_names: true)
+        data = JSON.parse(message.data, symbolize_names: true)
         for kind in [FEATURES, SEGMENTS]
-          key = key_for_path(kind, message[:path])
+          key = key_for_path(kind, data[:path])
           if key
-            @feature_store.delete(kind, key, message[:version])
+            @feature_store.delete(kind, key, data[:version])
             break
           end
         end