launchdarkly-server-sdk 6.2.0 → 6.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ee671939e04661c649d31502496cc33cd8844002c9af06864db9f322a81ec56
-  data.tar.gz: f5f77f10a6c487e1846f8d86201e9456b04bfb03950c751a328a7d3b9c3b8597
+  metadata.gz: 326e10ac69bf7d73c5727c555a2981b7d271d1651d9521b976005d93646a188b
+  data.tar.gz: 608205f6ac545e410aaa9e507180b8ad097ebe1ed23c6dc011b2c522209d9e3f
 SHA512:
-  metadata.gz: 6dc025a98ed3ab25bfe14baa878ff36beb34875caafee9c1979c724d58af9d08ca2596615cb31819dbb150fdeffd17b597f76e19cf2f09962dc1095ffe686ea7
-  data.tar.gz: 5d22b72feb1b46e7537f00b3959c72368d94c6606db640df1a7a9b17e1b01b952f1d34ea260e8d20b661fdee558975a9e034087e0d785aacd297d20ab15e9944
+  metadata.gz: a1b648a1d796ad1b65feffd9ee83fcd3dcb63c3146d513e44173d5cb6da32fd29b993d8b7343957094b801b69da5c0873b458fb568e6d174e4c402e158d129c4
+  data.tar.gz: 433d7761a4386538c25a8db6a0520b7d1e8c7184dcc9967e9770bbf5639e3f0a74476f2a0ef20f50bf53a5c6da4df62aacfd444f5fad5cfb1d64bc73a113374f

data/.circleci/config.yml

@@ -20,10 +20,13 @@ jobs:
       LD_RELEASE_DOCS_TITLE: ""
       LD_RELEASE_PROJECT: "ruby-server-sdk"
       LD_RELEASE_PROJECT_TEMPLATE: "ruby"
-      LD_RELEASE_VERSION: "6.2.0"
+      LD_RELEASE_VERSION: "6.2.4"
       LD_SKIP_DATABASE_TESTS: "1"
     steps:
       - checkout
+      - run:
+          name: "Releaser: prepare"
+          command: .ldrelease/circleci/mac/execute.sh prepare .ldrelease/circleci/template/prepare.sh
       - run:
           name: "Releaser: build"
           command: .ldrelease/circleci/mac/execute.sh build .ldrelease/circleci/template/build.sh

data/.ldrelease/circleci/template/build.sh

@@ -7,20 +7,10 @@ set -ue
 echo "Using gem $(gem --version)"
 
 #shellcheck source=/dev/null
-source "$(dirname "$0")/set-gem-home.sh"
-
-# If the gemspec specifies a certain version of bundler, we need to make sure we install that version.
-echo "Installing bundler"
-GEMSPEC_BUNDLER_VERSION=$(sed -n -e "s/.*['\"]bundler['\"], *['\"]\([^'\"]*\)['\"]/\1/p" ./*.gemspec | tr -d ' ')
-if [ -n "${GEMSPEC_BUNDLER_VERSION}" ]; then
-  GEMSPEC_OPTIONS="-v ${GEMSPEC_BUNDLER_VERSION}"
-else
-  GEMSPEC_OPTIONS=""
-fi
-gem install bundler ${GEMSPEC_OPTIONS} || { echo "installing bundler failed" >&2; exit 1; }
+source "$(dirname "$0")/gems-setup.sh"
 
 echo; echo "Installing dependencies"
-bundle install
+${BUNDLER_COMMAND} install
 
 # Build Ruby Gem - this assumes there is a single .gemspec file in the main project directory
 # Note that the gemspec must be able to get the project version either from $LD_RELEASE_VERSION,

data/.ldrelease/circleci/template/gems-setup.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# helper script to set GEM_HOME, PATH, and BUNDLER_COMMAND for Ruby - must be sourced, not executed
+
+mkdir -p "${LD_RELEASE_TEMP_DIR}/gems"
+export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
+export PATH="${GEM_HOME}/bin:${PATH}"
+
+# also, determine whether we'll need to run a specific version of Bundler
+
+GEMSPEC_BUNDLER_VERSION=$(sed -n -e "s/.*['\"]bundler['\"], *['\"]\([^'\"]*\)['\"]/\1/p" ./*.gemspec | tr -d ' ')
+if [ -n "${GEMSPEC_BUNDLER_VERSION}" ]; then
+  BUNDLER_COMMAND="bundler _${GEMSPEC_BUNDLER_VERSION}_"
+else
+  BUNDLER_COMMAND="bundler"
+fi

data/.ldrelease/circleci/template/prepare.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -ue
+
+echo "Using gem $(gem --version)"
+
+#shellcheck source=/dev/null
+source "$(dirname "$0")/gems-setup.sh"
+
+# If the gemspec specifies a certain version of bundler, we need to make sure we install that version.
+echo "Installing bundler"
+if [ -n "${GEMSPEC_BUNDLER_VERSION:-}" ]; then
+  GEMSPEC_OPTIONS="-v ${GEMSPEC_BUNDLER_VERSION}"
+else
+  GEMSPEC_OPTIONS=""
+fi
+gem install bundler ${GEMSPEC_OPTIONS} || { echo "installing bundler failed" >&2; exit 1; }

data/.ldrelease/circleci/template/publish.sh

@@ -4,17 +4,13 @@ set -ue
 
 # Standard publish.sh for Ruby-based projects - we can assume build.sh has already been run
 
-export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
+#shellcheck source=/dev/null
+source "$(dirname "$0")/gems-setup.sh"
 
 # If we're running in CircleCI, the RubyGems credentials will be in an environment
-# variable and need to be copied to a file
-if [ -n "${LD_RELEASE_RUBYGEMS_API_KEY}" ]; then
-  mkdir -p ~/.gem
-  cat >~/.gem/credentials <<EOF
----
-:rubygems_api_key: $LD_RELEASE_RUBYGEMS_API_KEY
-EOF
-  chmod 0600 ~/.gem/credentials
+# variable and should be copied to the variable the gem command expects
+if [ -n "${LD_RELEASE_RUBYGEMS_API_KEY:-}" ]; then
+  export GEM_HOST_API_KEY="${LD_RELEASE_RUBYGEMS_API_KEY}"
 fi
 
 # Since all Releaser builds are clean builds, we can assume that the only .gem file here

data/.ldrelease/circleci/template/test.sh

@@ -5,6 +5,6 @@ set -ue
 # Standard test.sh for Ruby-based projects
 
 #shellcheck source=/dev/null
-source "$(dirname "$0")/set-gem-home.sh"
+source "$(dirname "$0")/gems-setup.sh"
 
-bundle exec rspec spec
+${BUNDLER_COMMAND} exec rspec spec

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [6.2.3] - 2021-08-06
+### Fixed:
+- Diagnostic events did not properly set the `usingProxy` attribute when a proxy was configured with the `HTTPS_PROXY` environment variable. ([#182](https://github.com/launchdarkly/ruby-server-sdk/issues/182))
+
+## [6.2.2] - 2021-07-23
+### Fixed:
+- Enabling debug logging in polling mode could cause polling to fail with a `NameError`. (Thanks, [mmurphy-notarize](https://github.com/launchdarkly/ruby-server-sdk/pull/180)!)
+
+## [6.2.1] - 2021-07-15
+### Changed:
+- If `variation` or `variation_detail` is called with a user object that has no `key` (an invalid condition that will always result in the default value being returned), the SDK now logs a `warn`-level message to alert you to this incorrect usage. This makes the Ruby SDK's logging behavior consistent with the other server-side LaunchDarkly SDKs. ([#177](https://github.com/launchdarkly/ruby-server-sdk/issues/177))
+
+## [6.2.0] - 2021-06-17
+### Added:
+- The SDK now supports the ability to control the proportion of traffic allocation to an experiment. This works in conjunction with a new platform feature now available to early access customers.
+
 ## [6.1.1] - 2021-05-27
 ### Fixed:
 - Calling `variation` with a nil user parameter is invalid, causing the SDK to log an error and return a fallback value, but the SDK was still sending an analytics event for this. An event without a user is meaningless and can't be processed by LaunchDarkly. This is now fixed so the SDK will not send one.

data/launchdarkly-server-sdk.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.5.0"
 
   spec.add_development_dependency "aws-sdk-dynamodb", "~> 1.57"
-  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "bundler", "2.2.10"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "diplomat", "~> 2.4.2"
   spec.add_development_dependency "redis", "~> 4.2"
@@ -36,10 +36,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "semantic", "~> 1.6"
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.1"
-  spec.add_runtime_dependency "ld-eventsource", "~> 2.0"
+  spec.add_runtime_dependency "ld-eventsource", "2.0.1"
 
-  # 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"
-  spec.add_runtime_dependency "http", "~> 4.4.1"
+  spec.add_runtime_dependency "json", "~> 2.3"
+  spec.add_runtime_dependency "http", ">= 4.4.0", "< 6.0.0"
 end

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

@@ -79,7 +79,7 @@ module LaunchDarkly
           streamingDisabled: !config.stream?,
           userKeysCapacity: config.user_keys_capacity,
           userKeysFlushIntervalMillis: self.seconds_to_millis(config.user_keys_flush_interval),
-          usingProxy: ENV.has_key?('http_proxy') || ENV.has_key?('https_proxy') || ENV.has_key?('HTTP_PROXY'),
+          usingProxy: ENV.has_key?('http_proxy') || ENV.has_key?('https_proxy') || ENV.has_key?('HTTP_PROXY') || ENV.has_key?('HTTPS_PROXY'),
           usingRelayDaemon: config.use_ldd?,
         }
         ret

data/lib/ldclient-rb/ldclient.rb

@@ -407,6 +407,12 @@ module LaunchDarkly
         return detail
       end
 
+      if user[:key].nil?
+        @config.logger.warn { "[LDClient] Variation called with nil user key; returning default value" }
+        detail = Evaluator.error_result(EvaluationReason::ERROR_USER_NOT_SPECIFIED, default)
+        return detail
+      end
+
       if !initialized?
         if @store.initialized?
           @config.logger.warn { "[LDClient] Client has not finished initializing; using last known values from feature store" }

data/lib/ldclient-rb/requestor.rb

@@ -60,9 +60,9 @@ module LaunchDarkly
         headers: headers
       })
       status = response.status.code
-      @config.logger.debug { "[LDClient] Got response from uri: #{uri}\n\tstatus code: #{status}\n\theaders: #{response.headers}\n\tbody: #{res.to_s}" }
       # must fully read body for persistent connections
       body = response.to_s
+      @config.logger.debug { "[LDClient] Got response from uri: #{uri}\n\tstatus code: #{status}\n\theaders: #{response.headers.to_h}\n\tbody: #{body}" }
       if status == 304 && !cached.nil?
         body = cached.body
       else

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "6.2.0"
+  VERSION = "6.2.4"
 end

data/spec/diagnostic_events_spec.rb

@@ -79,13 +79,15 @@ module LaunchDarkly
           end
         end
 
-        it "detects proxy" do
-          begin
-            ENV["http_proxy"] = 'http://my-proxy'
-            event = default_acc.create_init_event(Config.new)
-            expect(event[:configuration][:usingProxy]).to be true
-          ensure
-            ENV["http_proxy"] = nil
+        ['http_proxy', 'https_proxy', 'HTTP_PROXY', 'HTTPS_PROXY'].each do |name|
+          it "detects proxy #{name}" do
+            begin
+              ENV[name] = 'http://my-proxy'
+              event = default_acc.create_init_event(Config.new)
+              expect(event[:configuration][:usingProxy]).to be true
+            ensure
+              ENV[name] = nil
+            end
           end
         end
 

data/spec/ldclient_spec.rb

@@ -171,20 +171,12 @@ describe LaunchDarkly::LDClient do
       client.variation("key", user_anonymous, "default")
     end
 
-    it "queues a feature event for an existing feature when user key is nil" do
+    it "does not queue a feature event for an existing feature when user key is nil" do
       config.feature_store.init({ LaunchDarkly::FEATURES => {} })
       config.feature_store.upsert(LaunchDarkly::FEATURES, feature_with_value)
       bad_user = { name: "Bob" }
-      expect(event_processor).to receive(:add_event).with(hash_including(
-        kind: "feature",
-        key: "key",
-        version: 100,
-        user: bad_user,
-        value: "default",
-        default: "default",
-        trackEvents: true,
-        debugEventsUntilDate: 1000
-      ))
+      expect(event_processor).not_to receive(:add_event)
+      expect(logger).to receive(:warn)
       client.variation("key", bad_user, "default")
     end
 

data/spec/requestor_spec.rb

@@ -40,6 +40,19 @@ describe LaunchDarkly::Requestor do
       end
     end
 
+    it "logs debug output" do
+      logger = ::Logger.new($stdout)
+      logger.level = ::Logger::DEBUG
+      with_server do |server|
+        with_requestor(server.base_uri.to_s, { logger: logger }) do |requestor|
+          server.setup_ok_response("/", { flags: { x: { key: "y" } } }.to_json)
+          expect do
+            requestor.request_all_data()
+          end.to output(/\[LDClient\] Got response from uri\:/).to_stdout_from_any_process
+        end
+      end
+    end
+
     it "sends etag from previous response" do
       etag = "xyz"
       with_server do |server|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.2.4
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -196,44 +196,50 @@ dependencies:
   name: ld-eventsource
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: 6.0.0
 description: Official LaunchDarkly SDK for Ruby
 email:
 - team@launchdarkly.com
@@ -252,8 +258,9 @@ files:
 - ".ldrelease/circleci/linux/execute.sh"
 - ".ldrelease/circleci/mac/execute.sh"
 - ".ldrelease/circleci/template/build.sh"
+- ".ldrelease/circleci/template/gems-setup.sh"
+- ".ldrelease/circleci/template/prepare.sh"
 - ".ldrelease/circleci/template/publish.sh"
-- ".ldrelease/circleci/template/set-gem-home.sh"
 - ".ldrelease/circleci/template/test.sh"
 - ".ldrelease/circleci/template/update-version.sh"
 - ".ldrelease/circleci/windows/execute.ps1"

data/.ldrelease/circleci/template/set-gem-home.sh

@@ -1,7 +0,0 @@
-#!/bin/bash
-
-# helper script to set GEM_HOME and PATH for Ruby - must be sourced, not executed
-
-mkdir -p "${LD_RELEASE_TEMP_DIR}/gems"
-export GEM_HOME="${LD_RELEASE_TEMP_DIR}/gems"
-export PATH="${GEM_HOME}/bin:${PATH}"