launchdarkly-server-sdk 5.7.1 → 5.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35e90a3d6853e2a12b8cf6d3c44a5d84c397b76a
-  data.tar.gz: 58a0229a7f331cb619568c8095a9381c60753a24
+  metadata.gz: 3dd5750bde3461f500b79c5542aa1e7bd3c0f54a
+  data.tar.gz: 5f83fba1e17f45975823cae9a6d011a3e4ef22ec
 SHA512:
-  metadata.gz: 4c2c1b2598e1ccf4a5f7f49fb4ef39974938100b4b9ea28fe910d7aea8a153d09a8e8ee978794293958c6040208fd055b271e1a4c8f4f3245e94dcc3d7c51812
-  data.tar.gz: 4d0eadc0f93a217d36f89fae7b2f5b19ce5fa78f98c36a81d6d50d782ac7fed3f451384599bb24c7b8cec80e2e0a26df42d1dd1fcbe7ce6d29906f314fd929e7
+  metadata.gz: eb39d85a5ad9f752729e0ebf0431c4c76b7b23c9fabec7d9494cfef30946f10f9c8e6a4f3d575fb1d9203c4ad21c53e4db796e878be173f306ae74f3c3c5c5a7
+  data.tar.gz: '07278a34c36c2f952a0e1c503f019959cbd0b45ba13c6cc021cc8a83ddd2895df5650e7c5adafe3ad0bea6e09497831d21581b74ccffd9e3f236770548ea44c8'

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.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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    launchdarkly-server-sdk (5.7.1)
+    launchdarkly-server-sdk (5.7.2)
       concurrent-ruby (~> 1.0)
       json (>= 1.8, < 3)
       ld-eventsource (= 1.0.3)

data/lib/ldclient-rb/events.rb

@@ -319,7 +319,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 +348,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/ldclient.rb

@@ -56,7 +56,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?

data/lib/ldclient-rb/version.rb

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

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

@@ -578,7 +578,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 5.7.2
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -302,6 +302,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 +361,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