launchdarkly-server-sdk 6.3.0 → 8.0.0

data/lib/ldclient-rb/stream.rb

@@ -17,7 +17,7 @@ module LaunchDarkly
   # @private
   KEY_PATHS = {
     FEATURES => "/flags/",
-    SEGMENTS => "/segments/"
+    SEGMENTS => "/segments/",
   }
 
   # @private
@@ -25,6 +25,7 @@ module LaunchDarkly
     def initialize(sdk_key, config, diagnostic_accumulator = nil)
       @sdk_key = sdk_key
       @config = config
+      @data_source_update_sink = config.data_source_update_sink
       @feature_store = config.feature_store
       @initialized = Concurrent::AtomicBoolean.new(false)
       @started = Concurrent::AtomicBoolean.new(false)
@@ -41,77 +42,138 @@ module LaunchDarkly
       return @ready unless @started.make_true
 
       @config.logger.info { "[LDClient] Initializing stream connection" }
-      
+
       headers = Impl::Util.default_http_headers(@sdk_key, @config)
       opts = {
         headers: headers,
         read_timeout: READ_TIMEOUT_SECONDS,
         logger: @config.logger,
-        socket_factory: @config.socket_factory
+        socket_factory: @config.socket_factory,
+        reconnect_time: @config.initial_reconnect_delay,
       }
       log_connection_started
-      @es = SSE::Client.new(@config.stream_uri + "/all", **opts) do |conn|
+
+      uri = Util.add_payload_filter_key(@config.stream_uri + "/all", @config)
+      @es = SSE::Client.new(uri, **opts) do |conn|
         conn.on_event { |event| process_message(event) }
         conn.on_error { |err|
           log_connection_result(false)
           case err
           when SSE::Errors::HTTPStatusError
             status = err.status
+            error_info = LaunchDarkly::Interfaces::DataSource::ErrorInfo.new(
+              LaunchDarkly::Interfaces::DataSource::ErrorInfo::ERROR_RESPONSE, status, nil, Time.now)
             message = Util.http_error_message(status, "streaming connection", "will retry")
             @config.logger.error { "[LDClient] #{message}" }
-            if !Util.http_error_recoverable?(status)
+
+            if Util.http_error_recoverable?(status)
+              @data_source_update_sink&.update_status(
+                LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED,
+                error_info
+              )
+            else
               @ready.set  # if client was waiting on us, make it stop waiting - has no effect if already set
-              stop
+              stop_with_error_info error_info
             end
+          when SSE::Errors::HTTPContentTypeError, SSE::Errors::HTTPProxyError, SSE::Errors::ReadTimeoutError
+            @data_source_update_sink&.update_status(
+              LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED,
+              LaunchDarkly::Interfaces::DataSource::ErrorInfo.new(LaunchDarkly::Interfaces::DataSource::ErrorInfo::NETWORK_ERROR, 0, err.to_s, Time.now)
+            )
+
+          else
+            @data_source_update_sink&.update_status(
+              LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED,
+              LaunchDarkly::Interfaces::DataSource::ErrorInfo.new(LaunchDarkly::Interfaces::DataSource::ErrorInfo::UNKNOWN, 0, err.to_s, Time.now)
+            )
           end
         }
       end
-      
+
       @ready
     end
 
     def stop
+      stop_with_error_info
+    end
+
+    private
+
+    #
+    # @param [LaunchDarkly::Interfaces::DataSource::ErrorInfo, nil] error_info
+    #
+    def stop_with_error_info(error_info = nil)
       if @stopped.make_true
         @es.close
+        @data_source_update_sink&.update_status(LaunchDarkly::Interfaces::DataSource::Status::OFF, error_info)
         @config.logger.info { "[LDClient] Stream connection stopped" }
       end
     end
 
-    private
+    #
+    # The original implementation of this class relied on the feature store
+    # directly, which we are trying to move away from. Customers who might have
+    # instantiated this directly for some reason wouldn't know they have to set
+    # the config's sink manually, so we have to fall back to the store if the
+    # sink isn't present.
+    #
+    # The next major release should be able to simplify this structure and
+    # remove the need for fall back to the data store because the update sink
+    # should always be present.
+    #
+    def update_sink_or_data_store
+      @data_source_update_sink || @feature_store
+    end
 
     def process_message(message)
       log_connection_result(true)
       method = message.type
       @config.logger.debug { "[LDClient] Stream received #{method} message: #{message.data}" }
-      if method == PUT
-        message = JSON.parse(message.data, symbolize_names: true)
-        all_data = Impl::Model.make_all_store_data(message[:data])
-        @feature_store.init(all_data)
-        @initialized.make_true
-        @config.logger.info { "[LDClient] Stream initialized" }
-        @ready.set
-      elsif method == PATCH
-        data = JSON.parse(message.data, symbolize_names: true)
-        for kind in [FEATURES, SEGMENTS]
-          key = key_for_path(kind, data[:path])
-          if key
-            data = data[:data]
-            Impl::Model.postprocess_item_after_deserializing!(kind, data)
-            @feature_store.upsert(kind, data)
-            break
+
+      begin
+        if method == PUT
+          message = JSON.parse(message.data, symbolize_names: true)
+          all_data = Impl::Model.make_all_store_data(message[:data], @config.logger)
+          update_sink_or_data_store.init(all_data)
+          @initialized.make_true
+          @config.logger.info { "[LDClient] Stream initialized" }
+          @ready.set
+        elsif method == PATCH
+          data = JSON.parse(message.data, symbolize_names: true)
+          for kind in [FEATURES, SEGMENTS]
+            key = key_for_path(kind, data[:path])
+            if key
+              item = Impl::Model.deserialize(kind, data[:data], @config.logger)
+              update_sink_or_data_store.upsert(kind, item)
+              break
+            end
           end
-        end
-      elsif method == DELETE
-        data = JSON.parse(message.data, symbolize_names: true)
-        for kind in [FEATURES, SEGMENTS]
-          key = key_for_path(kind, data[:path])
-          if key
-            @feature_store.delete(kind, key, data[:version])
-            break
+        elsif method == DELETE
+          data = JSON.parse(message.data, symbolize_names: true)
+          for kind in [FEATURES, SEGMENTS]
+            key = key_for_path(kind, data[:path])
+            if key
+              update_sink_or_data_store.delete(kind, key, data[:version])
+              break
+            end
           end
+        else
+          @config.logger.warn { "[LDClient] Unknown message received: #{method}" }
         end
-      else
-        @config.logger.warn { "[LDClient] Unknown message received: #{method}" }
+
+        @data_source_update_sink&.update_status(LaunchDarkly::Interfaces::DataSource::Status::VALID, nil)
+      rescue JSON::ParserError => e
+        @config.logger.error { "[LDClient] JSON parsing failed for method #{method}. Ignoring event." }
+        error_info = LaunchDarkly::Interfaces::DataSource::ErrorInfo.new(
+          LaunchDarkly::Interfaces::DataSource::ErrorInfo::INVALID_DATA,
+          0,
+          e.to_s,
+          Time.now
+        )
+        @data_source_update_sink&.update_status(LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED, error_info)
+
+        # Re-raise the exception so the SSE implementation can catch it and restart the stream.
+        raise
       end
     end
 

data/lib/ldclient-rb/util.rb

@@ -2,21 +2,95 @@ require "uri"
 require "http"
 
 module LaunchDarkly
+  #
+  # A Result is used to reflect the outcome of any operation.
+  #
+  # Results can either be considered a success or a failure.
+  #
+  # In the event of success, the Result will contain an option, nullable value to hold any success value back to the
+  # calling function.
+  #
+  # If the operation fails, the Result will contain an error describing the value.
+  #
+  class Result
+    #
+    # Create a successful result with the provided value.
+    #
+    # @param value [Object, nil]
+    # @return [Result]
+    #
+    def self.success(value)
+      Result.new(value)
+    end
+
+    #
+    # Create a failed result with the provided error description.
+    #
+    # @param error [String]
+    # @param exception [Exception, nil]
+    # @return [Result]
+    #
+    def self.fail(error, exception = nil)
+      Result.new(nil, error, exception)
+    end
+
+    #
+    # Was this result successful or did it encounter an error?
+    #
+    # @return [Boolean]
+    #
+    def success?
+      @error.nil?
+    end
+
+    #
+    # @return [Object, nil] The value returned from the operation if it was successful; nil otherwise.
+    #
+    attr_reader :value
+
+    #
+    # @return [String, nil] An error description of the failure; nil otherwise
+    #
+    attr_reader :error
+
+    #
+    # @return [Exception, nil] An optional exception which caused the failure
+    #
+    attr_reader :exception
+
+    private def initialize(value, error = nil, exception = nil)
+      @value = value
+      @error = error
+      @exception = exception
+    end
+  end
+
   # @private
   module Util
-    def self.stringify_attrs(hash, attrs)
-      return hash if hash.nil?
-      ret = hash
-      changed = false
-      attrs.each do |attr|
-        value = hash[attr]
-        if !value.nil? && !value.is_a?(String)
-          ret = hash.clone if !changed
-          ret[attr] = value.to_s
-          changed = true
-        end
+    #
+    # Append the payload filter key query parameter to the provided URI.
+    #
+    # @param uri [String]
+    # @param config [Config]
+    # @return [String]
+    #
+    def self.add_payload_filter_key(uri, config)
+      return uri if config.payload_filter_key.nil?
+
+      unless config.payload_filter_key.is_a?(String) && !config.payload_filter_key.empty?
+        config.logger.warn { "[LDClient] Filter key must be a non-empty string. No filtering will be applied." }
+        return uri
+      end
+
+      begin
+        parsed = URI.parse(uri)
+        new_query_params = URI.decode_www_form(String(parsed.query)) << ["filter", config.payload_filter_key]
+        parsed.query = URI.encode_www_form(new_query_params)
+        parsed.to_s
+      rescue URI::InvalidURIError
+        config.logger.warn { "[LDClient] URI could not be parsed. No filtering will be applied." }
+        uri
       end
-      ret
     end
 
     def self.new_http_client(uri_s, config)
@@ -24,10 +98,19 @@ module LaunchDarkly
       if config.socket_factory
         http_client_options["socket_class"] = config.socket_factory
       end
-      return HTTP::Client.new(http_client_options)
+      proxy = URI.parse(uri_s).find_proxy
+      unless proxy.nil?
+        http_client_options["proxy"] = {
+          proxy_address: proxy.host,
+          proxy_port: proxy.port,
+          proxy_username: proxy.user,
+          proxy_password: proxy.password,
+        }
+      end
+      HTTP::Client.new(http_client_options)
         .timeout({
           read: config.read_timeout,
-          connect: config.connect_timeout
+          connect: config.connect_timeout,
         })
         .persistent(uri_s)
     end

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "6.3.0"
+  VERSION = "8.0.0"
 end

data/lib/ldclient-rb.rb

@@ -9,20 +9,19 @@ require "ldclient-rb/version"
 require "ldclient-rb/interfaces"
 require "ldclient-rb/util"
 require "ldclient-rb/flags_state"
+require "ldclient-rb/migrations"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/cache_store"
 require "ldclient-rb/expiring_cache"
 require "ldclient-rb/memoized_value"
 require "ldclient-rb/in_memory_store"
 require "ldclient-rb/config"
-require "ldclient-rb/newrelic"
+require "ldclient-rb/context"
+require "ldclient-rb/reference"
 require "ldclient-rb/stream"
 require "ldclient-rb/polling"
-require "ldclient-rb/user_filter"
 require "ldclient-rb/simple_lru_cache"
 require "ldclient-rb/non_blocking_thread_pool"
-require "ldclient-rb/event_summarizer"
 require "ldclient-rb/events"
 require "ldclient-rb/requestor"
-require "ldclient-rb/file_data_source"
 require "ldclient-rb/integrations"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 8.0.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-09 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: 2.2.33
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +165,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: oga
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: semantic
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +226,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -253,27 +281,42 @@ files:
 - lib/ldclient-rb.rb
 - lib/ldclient-rb/cache_store.rb
 - lib/ldclient-rb/config.rb
+- lib/ldclient-rb/context.rb
 - lib/ldclient-rb/evaluation_detail.rb
-- lib/ldclient-rb/event_summarizer.rb
 - lib/ldclient-rb/events.rb
 - lib/ldclient-rb/expiring_cache.rb
-- lib/ldclient-rb/file_data_source.rb
 - lib/ldclient-rb/flags_state.rb
 - lib/ldclient-rb/impl.rb
 - lib/ldclient-rb/impl/big_segments.rb
+- lib/ldclient-rb/impl/broadcaster.rb
+- lib/ldclient-rb/impl/context.rb
+- lib/ldclient-rb/impl/context_filter.rb
+- lib/ldclient-rb/impl/data_source.rb
+- lib/ldclient-rb/impl/data_store.rb
+- lib/ldclient-rb/impl/dependency_tracker.rb
 - lib/ldclient-rb/impl/diagnostic_events.rb
 - lib/ldclient-rb/impl/evaluator.rb
 - lib/ldclient-rb/impl/evaluator_bucketing.rb
+- lib/ldclient-rb/impl/evaluator_helpers.rb
 - lib/ldclient-rb/impl/evaluator_operators.rb
-- lib/ldclient-rb/impl/event_factory.rb
 - lib/ldclient-rb/impl/event_sender.rb
+- lib/ldclient-rb/impl/event_summarizer.rb
+- lib/ldclient-rb/impl/event_types.rb
+- lib/ldclient-rb/impl/flag_tracker.rb
 - lib/ldclient-rb/impl/integrations/consul_impl.rb
 - lib/ldclient-rb/impl/integrations/dynamodb_impl.rb
 - lib/ldclient-rb/impl/integrations/file_data_source.rb
 - lib/ldclient-rb/impl/integrations/redis_impl.rb
 - lib/ldclient-rb/impl/integrations/test_data/test_data_source.rb
+- lib/ldclient-rb/impl/migrations/migrator.rb
+- lib/ldclient-rb/impl/migrations/tracker.rb
+- lib/ldclient-rb/impl/model/clause.rb
+- lib/ldclient-rb/impl/model/feature_flag.rb
+- lib/ldclient-rb/impl/model/preprocessed_data.rb
+- lib/ldclient-rb/impl/model/segment.rb
 - lib/ldclient-rb/impl/model/serialization.rb
 - lib/ldclient-rb/impl/repeating_task.rb
+- lib/ldclient-rb/impl/sampler.rb
 - lib/ldclient-rb/impl/store_client_wrapper.rb
 - lib/ldclient-rb/impl/store_data_set_sorter.rb
 - lib/ldclient-rb/impl/unbounded_pool.rb
@@ -290,14 +333,13 @@ files:
 - lib/ldclient-rb/interfaces.rb
 - lib/ldclient-rb/ldclient.rb
 - lib/ldclient-rb/memoized_value.rb
-- lib/ldclient-rb/newrelic.rb
+- lib/ldclient-rb/migrations.rb
 - lib/ldclient-rb/non_blocking_thread_pool.rb
 - lib/ldclient-rb/polling.rb
-- lib/ldclient-rb/redis_store.rb
+- lib/ldclient-rb/reference.rb
 - lib/ldclient-rb/requestor.rb
 - lib/ldclient-rb/simple_lru_cache.rb
 - lib/ldclient-rb/stream.rb
-- lib/ldclient-rb/user_filter.rb
 - lib/ldclient-rb/util.rb
 - lib/ldclient-rb/version.rb
 homepage: https://github.com/launchdarkly/ruby-server-sdk
@@ -312,14 +354,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.21
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby

data/lib/ldclient-rb/event_summarizer.rb

@@ -1,55 +0,0 @@
-
-module LaunchDarkly
-  # @private
-  EventSummary = Struct.new(:start_date, :end_date, :counters)
-
-  # Manages the state of summarizable information for the EventProcessor, including the
-  # event counters and user deduplication. Note that the methods of this class are
-  # deliberately not thread-safe; the EventProcessor is responsible for enforcing
-  # synchronization across both the summarizer and the event queue.
-  #
-  # @private
-  class EventSummarizer
-    def initialize
-      clear
-    end
-
-    # Adds this event to our counters, if it is a type of event we need to count.
-    def summarize_event(event)
-      if event[:kind] == "feature"
-        counter_key = {
-          key: event[:key],
-          version: event[:version],
-          variation: event[:variation]
-        }
-        c = @counters[counter_key]
-        if c.nil?
-          @counters[counter_key] = {
-            value: event[:value],
-            default: event[:default],
-            count: 1
-          }
-        else
-          c[:count] = c[:count] + 1
-        end
-        time = event[:creationDate]
-        if !time.nil?
-          @start_date = time if @start_date == 0 || time < @start_date
-          @end_date = time if time > @end_date
-        end
-      end
-    end
-
-    # Returns a snapshot of the current summarized event data, and resets this state.
-    def snapshot
-      ret = EventSummary.new(@start_date, @end_date, @counters)
-      ret
-    end
-
-    def clear
-      @start_date = 0
-      @end_date = 0
-      @counters = {}
-    end
-  end
-end

data/lib/ldclient-rb/file_data_source.rb

@@ -1,23 +0,0 @@
-require "ldclient-rb/integrations/file_data"
-
-module LaunchDarkly
-  #
-  # Deprecated entry point for the file data source feature.
-  #
-  # The new preferred usage is {LaunchDarkly::Integrations::FileData#data_source}.
-  #
-  # @deprecated This is replaced by {LaunchDarkly::Integrations::FileData}.
-  #
-  class FileDataSource
-    #
-    # Deprecated entry point for the file data source feature.
-    #
-    # The new preferred usage is {LaunchDarkly::Integrations::FileData#data_source}.
-    #
-    # @deprecated This is replaced by {LaunchDarkly::Integrations::FileData#data_source}.
-    #
-    def self.factory(options={})
-      LaunchDarkly::Integrations::FileData.data_source(options)
-    end
-  end
-end