launchdarkly
diff --git a/‎.circleci/config.yml‎
Lines changed: 20 additions & 9 deletions b/‎.circleci/config.yml‎
Lines changed: 20 additions & 9 deletions
diff --git a/‎Makefile‎
Lines changed: 19 additions & 0 deletions b/‎Makefile‎
Lines changed: 19 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 0 additions & 1 deletion b/‎README.md‎
Lines changed: 0 additions & 1 deletion
diff --git a/‎contract-tests/Gemfile‎
Lines changed: 10 additions & 0 deletions b/‎contract-tests/Gemfile‎
Lines changed: 10 additions & 0 deletions
diff --git a/‎contract-tests/README.md‎
Lines changed: 7 additions & 0 deletions b/‎contract-tests/README.md‎
Lines changed: 7 additions & 0 deletions
diff --git a/‎contract-tests/client_entity.rb‎
Lines changed: 92 additions & 0 deletions b/‎contract-tests/client_entity.rb‎
Lines changed: 92 additions & 0 deletions
diff --git a/‎contract-tests/service.rb‎
Lines changed: 112 additions & 0 deletions b/‎contract-tests/service.rb‎
Lines changed: 112 additions & 0 deletions
diff --git a/‎launchdarkly-server-sdk.gemspec‎
Lines changed: 1 addition & 1 deletion b/‎launchdarkly-server-sdk.gemspec‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎lib/ldclient-rb/config.rb‎
Lines changed: 17 additions & 0 deletions b/‎lib/ldclient-rb/config.rb‎
Lines changed: 17 additions & 0 deletions
@@ -17,8 +17,8 @@ workflows:
           name: Ruby 3.0
           docker-image: cimg/ruby:3.0
       - build-test-linux:
-          name: JRuby 9.2
-          docker-image: jruby:9.2-jdk
+          name: JRuby 9.3
+          docker-image: jruby:9.3-jdk
           jruby: true
 
 jobs:
@@ -41,19 +41,30 @@ jobs:
       - when:
           condition: <<parameters.jruby>>
           steps:
-            - run: gem install jruby-openssl  # required by bundler, no effect on Ruby MRI
+            - run: gem install jruby-openssl -v 0.11.0  # required by bundler, no effect on Ruby MRI
             - run: apt-get update -y && apt-get install -y build-essential
       - when:
           condition:
              not: <<parameters.jruby>>
           steps:
             - run: sudo apt-get update -y && sudo apt-get install -y build-essential
       - run: ruby -v
-      - run: gem install bundler -v 2.2.10
-      - run: bundle _2.2.10_ install
-      - run: mkdir ./rspec
-      - run: bundle _2.2.10_ exec rspec --format documentation --format RspecJunitFormatter -o ./rspec/rspec.xml spec
+      - run: gem install bundler -v 2.2.33
+      - run: bundle _2.2.33_ install
+      - run: mkdir /tmp/circle-artifacts
+      - run: bundle _2.2.33_ exec rspec --format documentation --format RspecJunitFormatter -o /tmp/circle-artifacts/rspec.xml spec
+
+      - when:
+          condition:
+             not: <<parameters.jruby>>
+          steps:
+            - run: make build-contract-tests
+            - run:
+                command: make start-contract-test-service
+                background: true
+            - run: TEST_HARNESS_PARAMS="-junit /tmp/circle-artifacts/contract-tests-junit.xml" make run-contract-tests
+
       - store_test_results:
-          path: ./rspec
+          path: /tmp/circle-artifacts
       - store_artifacts:
-          path: ./rspec
+          path: /tmp/circle-artifacts
@@ -0,0 +1,19 @@
+TEMP_TEST_OUTPUT=/tmp/contract-test-service.log
+
+build-contract-tests:
+	@cd contract-tests && bundle _2.2.33_ install
+
+start-contract-test-service:
+	@cd contract-tests && bundle _2.2.33_ exec ruby service.rb
+
+start-contract-test-service-bg:
+	@echo "Test service output will be captured in $(TEMP_TEST_OUTPUT)"
+	@make start-contract-test-service >$(TEMP_TEST_OUTPUT) 2>&1 &
+
+run-contract-tests:
+	@curl -s https://raw.githubusercontent.com/launchdarkly/sdk-test-harness/v1.0.0/downloader/run.sh \
+      | VERSION=v1 PARAMS="-url http://localhost:9000 -debug -stop-service-at-end $(TEST_HARNESS_PARAMS)" sh
+
+contract-tests: build-contract-tests start-contract-test-service-bg run-contract-tests
+
+.PHONY: build-contract-tests start-contract-test-service run-contract-tests contract-tests
@@ -4,7 +4,6 @@ LaunchDarkly Server-side SDK for Ruby
 [![Gem Version](https://badge.fury.io/rb/launchdarkly-server-sdk.svg)](http://badge.fury.io/rb/launchdarkly-server-sdk)
 
 [![Circle CI](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/master.svg?style=svg)](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/master)
-[![Security](https://hakiri.io/github/launchdarkly/ruby-server-sdk/master.svg)](https://hakiri.io/github/launchdarkly/ruby-server-sdk/master)
 [![RubyDoc](https://img.shields.io/static/v1?label=docs+-+all+versions&message=reference&color=00add8)](https://www.rubydoc.info/gems/launchdarkly-server-sdk)
 [![GitHub Pages](https://img.shields.io/static/v1?label=docs+-+latest&message=reference&color=00add8)](https://launchdarkly.github.io/ruby-server-sdk)
 
 
@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'launchdarkly-server-sdk', path: '..'
+
+gem 'sinatra', '~> 2.1'
+# Sinatra can work with several server frameworks. In JRuby, we have to use glassfish (which
+# is only available in JRuby). Otherwise we use thin (which is not available in JRuby).
+gem 'glassfish', :platforms => :jruby
+gem 'thin', :platforms => :ruby
+gem 'json'
@@ -0,0 +1,7 @@
+# SDK contract test service
+
+This directory contains an implementation of the cross-platform SDK testing protocol defined by https://github.com/launchdarkly/sdk-test-harness. See that project's `README` for details of this protocol, and the kinds of SDK capabilities that are relevant to the contract tests. This code should not need to be updated unless the SDK has added or removed such capabilities.
+
+To run these tests locally, run `make contract-tests` from the SDK project root directory. This downloads the correct version of the test harness tool automatically.
+
+Or, to test against an in-progress local version of the test harness, run `make start-contract-test-service` from the SDK project root directory; then, in the root directory of the `sdk-test-harness` project, build the test harness and run it from the command line.
@@ -0,0 +1,92 @@
+require 'ld-eventsource'
+require 'json'
+require 'net/http'
+
+class ClientEntity
+  def initialize(log, config)
+    @log = log
+
+    opts = {}
+
+    opts[:logger] = log
+
+    if config[:streaming]
+      streaming = config[:streaming]
+      opts[:stream_uri] = streaming[:baseUri] if !streaming[:baseUri].nil?
+      opts[:initial_reconnect_delay] = streaming[:initialRetryDelayMs] / 1_000.0 if !streaming[:initialRetryDelayMs].nil?
+    end
+
+    if config[:events]
+      events = config[:events]
+      opts[:events_uri] = events[:baseUri] if events[:baseUri]
+      opts[:capacity] = events[:capacity] if events[:capacity]
+      opts[:diagnostic_opt_out] = !events[:enableDiagnostics]
+      opts[:all_attributes_private]  = !!events[:allAttributesPrivate]
+      opts[:private_attribute_names] = events[:globalPrivateAttributes]
+      opts[:flush_interval] = (events[:flushIntervalMs] / 1_000) if events.has_key? :flushIntervalMs
+      opts[:inline_users_in_events] =  events[:inlineUsers] || false
+    else
+      opts[:send_events] = false
+    end
+
+    startWaitTimeMs = config[:startWaitTimeMs] || 5_000
+
+    @client = LaunchDarkly::LDClient.new(
+      config[:credential],
+      LaunchDarkly::Config.new(opts),
+      startWaitTimeMs / 1_000.0)
+  end
+
+  def initialized?
+    @client.initialized?
+  end
+
+  def evaluate(params)
+    response = {}
+
+    if params[:detail]
+      detail = @client.variation_detail(params[:flagKey], params[:user], params[:defaultValue])
+      response[:value] = detail.value
+      response[:variationIndex] = detail.variation_index
+      response[:reason] = detail.reason
+    else
+      response[:value] = @client.variation(params[:flagKey], params[:user], params[:defaultValue])
+    end
+
+    response
+  end
+
+  def evaluate_all(params)
+    opts = {}
+    opts[:client_side_only] = params[:clientSideOnly] || false
+    opts[:with_reasons] = params[:withReasons] || false
+    opts[:details_only_for_tracked_flags] = params[:detailsOnlyForTrackedFlags] || false
+
+    @client.all_flags_state(params[:user], opts)
+  end
+
+  def track(params)
+    @client.track(params[:eventKey], params[:user], params[:data], params[:metricValue])
+  end
+
+  def identify(params)
+    @client.identify(params[:user])
+  end
+
+  def alias(params)
+    @client.alias(params[:user], params[:previousUser])
+  end
+
+  def flush_events
+    @client.flush
+  end
+
+  def log
+    @log
+  end
+
+  def close
+    @client.close
+    @log.info("Test ended")
+  end
+end
@@ -0,0 +1,112 @@
+require 'launchdarkly-server-sdk'
+require 'json'
+require 'logger'
+require 'net/http'
+require 'sinatra'
+
+require './client_entity.rb'
+
+configure :development do
+  disable :show_exceptions
+end
+
+$log = Logger.new(STDOUT)
+$log.formatter = proc {|severity, datetime, progname, msg|
+  "[GLOBAL] #{datetime.strftime('%Y-%m-%d %H:%M:%S.%3N')} #{severity} #{progname} #{msg}\n"
+}
+
+set :port, 9000
+set :logging, false
+
+clients = {}
+clientCounter = 0
+
+get '/' do
+  {
+    capabilities: [
+      'server-side',
+      'all-flags-with-reasons',
+      'all-flags-client-side-only',
+      'all-flags-details-only-for-tracked-flags',
+    ]
+  }.to_json
+end
+
+delete '/' do
+  $log.info("Test service has told us to exit")
+  Thread.new { sleep 1; exit }
+  return 204
+end
+
+post '/' do
+  opts = JSON.parse(request.body.read, :symbolize_names => true)
+  tag = "[#{opts[:tag]}]"
+
+  clientCounter += 1
+  clientId = clientCounter.to_s
+
+  log = Logger.new(STDOUT)
+  log.formatter = proc {|severity, datetime, progname, msg|
+    "#{tag} #{datetime.strftime('%Y-%m-%d %H:%M:%S.%3N')} #{severity} #{progname} #{msg}\n"
+  }
+
+  log.info("Starting client")
+  log.debug("Parameters: #{opts}")
+
+  client = ClientEntity.new(log, opts[:configuration])
+
+  if !client.initialized? && opts[:configuration][:initCanFail] == false
+    client.close()
+    return [500, nil, "Failed to initialize"]
+  end
+
+  clientResourceUrl = "/clients/#{clientId}"
+  clients[clientId] = client
+  return [201, {'Location' => clientResourceUrl}, nil]
+end
+
+post '/clients/:id' do |clientId|
+  client = clients[clientId]
+  return 404 if client.nil?
+
+  params = JSON.parse(request.body.read, :symbolize_names => true)
+
+  client.log.info("Processing request for client #{clientId}")
+  client.log.debug("Parameters: #{params}")
+
+  case params[:command]
+  when "evaluate"
+    response = client.evaluate(params[:evaluate])
+    return [200, nil, response.to_json]
+  when "evaluateAll"
+    response = {:state => client.evaluate_all(params[:evaluateAll])}
+    return [200, nil, response.to_json]
+  when "customEvent"
+    client.track(params[:customEvent])
+    return 201
+  when "identifyEvent"
+    client.identify(params[:identifyEvent])
+    return 201
+  when "aliasEvent"
+    client.alias(params[:aliasEvent])
+    return 201
+  when "flushEvents"
+    client.flush_events
+    return 201
+  end
+
+  return [400, nil, {:error => "Unknown command requested"}.to_json]
+end
+
+delete '/clients/:id' do |clientId|
+  client = clients[clientId]
+  return 404 if client.nil?
+  clients.delete(clientId)
+  client.close
+
+  return 204
+end
+
+error do
+  env['sinatra.error'].message
+end
@@ -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.2.10"
+  spec.add_development_dependency "bundler", "2.2.33"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "diplomat", "~> 2.4.2"
   spec.add_development_dependency "redis", "~> 4.2"
 
@@ -21,6 +21,7 @@ class Config
     # @option opts [Integer] :capacity (10000) See {#capacity}.
     # @option opts [Float] :flush_interval (30) See {#flush_interval}.
     # @option opts [Float] :read_timeout (10) See {#read_timeout}.
+    # @option opts [Float] :initial_reconnect_delay (1) See {#initial_reconnect_delay}.
     # @option opts [Float] :connect_timeout (2) See {#connect_timeout}.
     # @option opts [Object] :cache_store See {#cache_store}.
     # @option opts [Object] :feature_store See {#feature_store}.
@@ -54,6 +55,7 @@ def initialize(opts = {})
       @flush_interval = opts[:flush_interval] || Config.default_flush_interval
       @connect_timeout = opts[:connect_timeout] || Config.default_connect_timeout
       @read_timeout = opts[:read_timeout] || Config.default_read_timeout
+      @initial_reconnect_delay = opts[:initial_reconnect_delay] || Config.default_initial_reconnect_delay
       @feature_store = opts[:feature_store] || Config.default_feature_store
       @stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
       @use_ldd = opts.has_key?(:use_ldd) ? opts[:use_ldd] : Config.default_use_ldd
@@ -180,6 +182,13 @@ def offline?
     #
     attr_reader :read_timeout
 
+    #
+    # The initial delay before reconnecting after an error in the SSE client.
+    # This only applies to the streaming connection.
+    # @return [Float]
+    #
+    attr_reader :initial_reconnect_delay
+
     #
     # The connect timeout for network connections in seconds.
     # @return [Float]
@@ -395,6 +404,14 @@ def self.default_read_timeout
       10
     end
 
+    #
+    # The default value for {#initial_reconnect_delay}.
+    # @return [Float] 1
+    #
+    def self.default_initial_reconnect_delay
+      1
+    end
+
     #
     # The default value for {#connect_timeout}.
     # @return [Float] 10