launchdarkly-server-sdk 8.11.3 → 8.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1fa7eda2bd9b051a44200581ef0467e375d74fbeccd23f94838149b01bcebb3
-  data.tar.gz: 6d1d16653bdb132f4348cc3b97e22ea7dbf45af1721a96e89221d10d46e7384e
+  metadata.gz: 00dae4e15afbdfae7536e4f3bacf356457b538efa483b6c37fa348db2aa9e904
+  data.tar.gz: 2da38d1e16b4a29ede8f1a48161a7b5092e80a86c1da5067dab61a6980903a00
 SHA512:
-  metadata.gz: f938280053627372c37235543a9204585e4c4550ec029c726d0fde1187b44d8c1351deb80722504de3f88f373ec7217c66f181169c58fb05609683c7dfbf6f77
-  data.tar.gz: bec0a20471ce7242ff8eeb6b0e535e9218492fb4caa83b7bc70d2769242ed96cb0dcf2fc56449c8a6e9380675e594ee898b3eb2aa0c896bb11c0fd1eb116219a
+  metadata.gz: d1861d29889af1455c6c337312118270cb47341738e375b6895e8ed5dda5205f88129485e1e24cd4d90efd4335cefabd2df19a4a99b160c8eacd495e17dcd124
+  data.tar.gz: 58945234ec39392e0605d6c394368dfd710082397b8fed7c1c56eeb3b7621da7a58814616eb79874fa1d9406b41438bf21ee9e488969c3d61debbb189887d536

data/lib/ldclient-rb/config.rb

@@ -1,5 +1,8 @@
 require "logger"
 require "ldclient-rb/impl/cache_store"
+require "ldclient-rb/impl/data_system/http_config_options"
+require "ldclient-rb/impl/data_system/polling"
+require "ldclient-rb/impl/data_system/streaming"
 
 module LaunchDarkly
   #
@@ -45,7 +48,7 @@ module LaunchDarkly
     # @option opts [Hash] :application See {#application}
     # @option opts [String] :payload_filter_key See {#payload_filter_key}
     # @option opts [Boolean] :omit_anonymous_contexts See {#omit_anonymous_contexts}
-    # @option opts [DataSystemConfig] :datasystem_config See {#datasystem_config}
+    # @option opts [DataSystemConfig] :data_system_config See {#data_system_config}
     # @option hooks [Array<Interfaces::Hooks::Hook]
     # @option plugins [Array<Interfaces::Plugins::Plugin]
     #
@@ -84,7 +87,7 @@ module LaunchDarkly
       @hooks = (opts[:hooks] || []).keep_if { |hook| hook.is_a? Interfaces::Hooks::Hook }
       @plugins = (opts[:plugins] || []).keep_if { |plugin| plugin.is_a? Interfaces::Plugins::Plugin }
       @omit_anonymous_contexts = opts.has_key?(:omit_anonymous_contexts) && opts[:omit_anonymous_contexts]
-      @datasystem_config = opts[:datasystem_config]
+      @data_system_config = opts[:data_system_config]
       @data_source_update_sink = nil
       @instance_id = nil
     end
@@ -440,7 +443,7 @@ module LaunchDarkly
     #
     # @return [DataSystemConfig, nil]
     #
-    attr_reader :datasystem_config
+    attr_reader :data_system_config
 
 
     #
@@ -465,7 +468,7 @@ module LaunchDarkly
     # @return [String] "https://sdk.launchdarkly.com"
     #
     def self.default_base_uri
-      "https://sdk.launchdarkly.com"
+      Impl::DataSystem::PollingDataSourceBuilder::DEFAULT_BASE_URI
     end
 
     #
@@ -473,7 +476,7 @@ module LaunchDarkly
     # @return [String] "https://stream.launchdarkly.com"
     #
     def self.default_stream_uri
-      "https://stream.launchdarkly.com"
+      Impl::DataSystem::StreamingDataSourceBuilder::DEFAULT_BASE_URI
     end
 
     #
@@ -505,7 +508,7 @@ module LaunchDarkly
     # @return [Float] 10
     #
     def self.default_read_timeout
-      10
+      Impl::DataSystem::HttpConfigOptions::DEFAULT_READ_TIMEOUT
     end
 
     #
@@ -513,7 +516,7 @@ module LaunchDarkly
     # @return [Float] 1
     #
     def self.default_initial_reconnect_delay
-      1
+      Impl::DataSystem::StreamingDataSourceBuilder::DEFAULT_INITIAL_RECONNECT_DELAY
     end
 
     #
@@ -521,7 +524,7 @@ module LaunchDarkly
     # @return [Float] 2
     #
     def self.default_connect_timeout
-      2
+      Impl::DataSystem::HttpConfigOptions::DEFAULT_CONNECT_TIMEOUT
     end
 
     #
@@ -575,7 +578,7 @@ module LaunchDarkly
     # @return [Float] 30
     #
     def self.default_poll_interval
-      30
+      Impl::DataSystem::PollingDataSourceBuilder::DEFAULT_POLL_INTERVAL
     end
 
     #
@@ -699,35 +702,29 @@ module LaunchDarkly
   #
   class DataSystemConfig
     #
-    # @param initializers [Array<Proc(Config) => LaunchDarkly::Interfaces::DataSystem::Initializer>, nil] The (optional) array of builder procs
-    # @param primary_synchronizer [Proc(Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil] The (optional) builder proc for primary synchronizer
-    # @param secondary_synchronizer [Proc(Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil] The (optional) builder proc for secondary synchronizer
+    # @param initializers [Array<#build(String, Config)>, nil] The (optional) array of builders
+    # @param synchronizers [Array<#build(String, Config)>, nil] The (optional) array of synchronizer builders
     # @param data_store_mode [Symbol] The (optional) data store mode
     # @param data_store [LaunchDarkly::Interfaces::FeatureStore, nil] The (optional) data store
-    # @param fdv1_fallback_synchronizer [Proc(Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil]
-    #   The (optional) builder proc for FDv1-compatible fallback synchronizer
+    # @param fdv1_fallback_synchronizer [#build(String, Config), nil]
+    #   The (optional) builder for FDv1-compatible fallback synchronizer
     #
-    def initialize(initializers: nil, primary_synchronizer: nil, secondary_synchronizer: nil,
+    def initialize(initializers: nil, synchronizers: nil,
                    data_store_mode: LaunchDarkly::Interfaces::DataSystem::DataStoreMode::READ_ONLY, data_store: nil, fdv1_fallback_synchronizer: nil)
       @initializers = initializers
-      @primary_synchronizer = primary_synchronizer
-      @secondary_synchronizer = secondary_synchronizer
+      @synchronizers = synchronizers
       @data_store_mode = data_store_mode
       @data_store = data_store
       @fdv1_fallback_synchronizer = fdv1_fallback_synchronizer
     end
 
-    # The initializers for the data system. Each proc takes sdk_key and Config and returns an Initializer.
-    # @return [Array<Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Initializer>, nil]
+    # The initializer builders for the data system. Each builder responds to build(sdk_key, config) and returns an Initializer.
+    # @return [Array<#build(String, Config)>, nil]
     attr_reader :initializers
 
-    # The primary synchronizer builder. Takes sdk_key and Config and returns a Synchronizer.
-    # @return [Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil]
-    attr_reader :primary_synchronizer
-
-    # The secondary synchronizer builder. Takes sdk_key and Config and returns a Synchronizer.
-    # @return [Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil]
-    attr_reader :secondary_synchronizer
+    # The synchronizer builders for the data system. Each builder responds to build(sdk_key, config) and returns a Synchronizer.
+    # @return [Array<#build(String, Config)>, nil]
+    attr_reader :synchronizers
 
     # The data store mode.
     # @return [Symbol]
@@ -737,8 +734,8 @@ module LaunchDarkly
     # @return [LaunchDarkly::Interfaces::FeatureStore, nil]
     attr_reader :data_store
 
-    # The FDv1-compatible fallback synchronizer builder. Takes sdk_key and Config and returns a Synchronizer.
-    # @return [Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil]
+    # The FDv1-compatible fallback synchronizer builder. Responds to build(sdk_key, config) and returns a Synchronizer.
+    # @return [#build(String, Config), nil]
     attr_reader :fdv1_fallback_synchronizer
   end
 end

data/lib/ldclient-rb/data_system.rb

@@ -3,6 +3,7 @@
 require 'ldclient-rb/interfaces/data_system'
 require 'ldclient-rb/config'
 require 'ldclient-rb/impl/data_system/polling'
+require 'ldclient-rb/impl/data_system/streaming'
 
 module LaunchDarkly
   #
@@ -17,8 +18,7 @@ module LaunchDarkly
     class ConfigBuilder
       def initialize
         @initializers = nil
-        @primary_synchronizer = nil
-        @secondary_synchronizer = nil
+        @synchronizers = nil
         @fdv1_fallback_synchronizer = nil
         @data_store_mode = LaunchDarkly::Interfaces::DataSystem::DataStoreMode::READ_ONLY
         @data_store = nil
@@ -27,8 +27,8 @@ module LaunchDarkly
       #
       # Sets the initializers for the data system.
       #
-      # @param initializers [Array<Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Initializer>]
-      #   Array of builder procs that take sdk_key and Config and return an Initializer
+      # @param initializers [Array<#build(String, Config)>]
+      #   Array of builders that respond to build(sdk_key, config) and return an Initializer
       # @return [ConfigBuilder] self for chaining
       #
       def initializers(initializers)
@@ -39,14 +39,12 @@ module LaunchDarkly
       #
       # Sets the synchronizers for the data system.
       #
-      # @param primary [Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer] Builder proc that takes sdk_key and Config and returns the primary Synchronizer
-      # @param secondary [Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer, nil]
-      #   Builder proc that takes sdk_key and Config and returns the secondary Synchronizer
+      # @param synchronizers [Array<#build(String, Config)>]
+      #   Array of builders that respond to build(sdk_key, config) and return a Synchronizer
       # @return [ConfigBuilder] self for chaining
       #
-      def synchronizers(primary, secondary = nil)
-        @primary_synchronizer = primary
-        @secondary_synchronizer = secondary
+      def synchronizers(synchronizers)
+        @synchronizers = synchronizers
         self
       end
 
@@ -54,8 +52,7 @@ module LaunchDarkly
       # Configures the SDK with a fallback synchronizer that is compatible with
       # the Flag Delivery v1 API.
       #
-      # @param fallback [Proc(String, Config) => LaunchDarkly::Interfaces::DataSystem::Synchronizer]
-      #   Builder proc that takes sdk_key and Config and returns the fallback Synchronizer
+      # @param fallback [#build(String, Config)] Builder that responds to build(sdk_key, config) and returns the fallback Synchronizer
       # @return [ConfigBuilder] self for chaining
       #
       def fdv1_compatible_synchronizer(fallback)
@@ -80,17 +77,11 @@ module LaunchDarkly
       # Builds the data system configuration.
       #
       # @return [DataSystemConfig]
-      # @raise [ArgumentError] if configuration is invalid
       #
       def build
-        if @secondary_synchronizer && @primary_synchronizer.nil?
-          raise ArgumentError, "Primary synchronizer must be set if secondary is set"
-        end
-
         DataSystemConfig.new(
           initializers: @initializers,
-          primary_synchronizer: @primary_synchronizer,
-          secondary_synchronizer: @secondary_synchronizer,
+          synchronizers: @synchronizers,
           data_store_mode: @data_store_mode,
           data_store: @data_store,
           fdv1_fallback_synchronizer: @fdv1_fallback_synchronizer
@@ -99,43 +90,36 @@ module LaunchDarkly
     end
 
     #
-    # Returns a builder proc for creating a polling data source.
+    # Returns a builder for creating a polling data source.
     # This is a building block that can be used with {ConfigBuilder#initializers}
     # or {ConfigBuilder#synchronizers} to create custom data system configurations.
     #
-    # @return [Proc] A proc that takes (sdk_key, config) and returns a polling data source
+    # @return [LaunchDarkly::Impl::DataSystem::PollingDataSourceBuilder]
     #
     def self.polling_ds_builder
-      lambda do |sdk_key, config|
-        LaunchDarkly::Impl::DataSystem::PollingDataSourceBuilder.new(sdk_key, config).build
-      end
+      LaunchDarkly::Impl::DataSystem::PollingDataSourceBuilder.new
     end
 
     #
-    # Returns a builder proc for creating an FDv1 fallback polling data source.
+    # Returns a builder for creating an FDv1 fallback polling data source.
     # This is a building block that can be used with {ConfigBuilder#fdv1_compatible_synchronizer}
     # to provide FDv1 compatibility in custom data system configurations.
     #
-    # @return [Proc] A proc that takes (sdk_key, config) and returns an FDv1 polling data source
+    # @return [LaunchDarkly::Impl::DataSystem::FDv1PollingDataSourceBuilder]
     #
     def self.fdv1_fallback_ds_builder
-      lambda do |sdk_key, config|
-        LaunchDarkly::Impl::DataSystem::FDv1PollingDataSourceBuilder.new(sdk_key, config).build
-      end
+      LaunchDarkly::Impl::DataSystem::FDv1PollingDataSourceBuilder.new
     end
 
     #
-    # Returns a builder proc for creating a streaming data source.
+    # Returns a builder for creating a streaming data source.
     # This is a building block that can be used with {ConfigBuilder#synchronizers}
     # to create custom data system configurations.
     #
-    # @return [Proc] A proc that takes (sdk_key, config) and returns a streaming data source
+    # @return [LaunchDarkly::Impl::DataSystem::StreamingDataSourceBuilder]
     #
     def self.streaming_ds_builder
-      # TODO(fdv2): Implement streaming data source builder
-      lambda do |_sdk_key, _config|
-        raise NotImplementedError, "Streaming data source not yet implemented for FDv2"
-      end
+      LaunchDarkly::Impl::DataSystem::StreamingDataSourceBuilder.new
     end
 
     #
@@ -159,7 +143,7 @@ module LaunchDarkly
 
       builder = ConfigBuilder.new
       builder.initializers([polling_builder])
-      builder.synchronizers(streaming_builder, polling_builder)
+      builder.synchronizers([streaming_builder, polling_builder])
       builder.fdv1_compatible_synchronizer(fallback)
 
       builder
@@ -177,7 +161,7 @@ module LaunchDarkly
       fallback = fdv1_fallback_ds_builder
 
       builder = ConfigBuilder.new
-      builder.synchronizers(streaming_builder)
+      builder.synchronizers([streaming_builder])
       builder.fdv1_compatible_synchronizer(fallback)
 
       builder
@@ -195,7 +179,7 @@ module LaunchDarkly
       fallback = fdv1_fallback_ds_builder
 
       builder = ConfigBuilder.new
-      builder.synchronizers(polling_builder)
+      builder.synchronizers([polling_builder])
       builder.fdv1_compatible_synchronizer(fallback)
 
       builder

data/lib/ldclient-rb/events.rb

@@ -156,7 +156,7 @@ module LaunchDarkly
       @inbox_full = Concurrent::AtomicBoolean.new(false)
 
       event_sender = (test_properties || {})[:event_sender] ||
-        Impl::EventSender.new(sdk_key, config, client || Impl::Util.new_http_client(config.events_uri, config))
+        Impl::EventSender.new(sdk_key, config)
 
       @timestamp_fn = (test_properties || {})[:timestamp_fn] || proc { Impl::Util.current_time_millis }
       @omit_anonymous_contexts = config.omit_anonymous_contexts

data/lib/ldclient-rb/impl/data_source/requestor.rb

@@ -1,5 +1,6 @@
 require "ldclient-rb/impl/model/serialization"
 require "ldclient-rb/impl/util"
+require "ldclient-rb/impl/data_system/http_config_options"
 
 require "concurrent/atomics"
 require "json"
@@ -26,7 +27,13 @@ module LaunchDarkly
         def initialize(sdk_key, config)
           @sdk_key = sdk_key
           @config = config
-          @http_client = Impl::Util.new_http_client(config.base_uri, config)
+          @http_config = DataSystem::HttpConfigOptions.new(
+            base_uri: config.base_uri,
+            socket_factory: config.socket_factory,
+            read_timeout: config.read_timeout,
+            connect_timeout: config.connect_timeout
+          )
+          @http_client = Impl::Util.new_http_client(@http_config)
             .use(:auto_inflate)
             .headers("Accept-Encoding" => "gzip")
           @cache = @config.cache_store
@@ -48,7 +55,7 @@ module LaunchDarkly
 
         def make_request(path)
           uri = URI(
-            Util.add_payload_filter_key(@config.base_uri + path, @config)
+            Util.add_payload_filter_key(@http_config.base_uri + path, @config)
           )
           headers = {}
           Impl::Util.default_http_headers(@sdk_key, @config).each { |k, v| headers[k] = v }

data/lib/ldclient-rb/impl/data_source/status_provider.rb

@@ -54,6 +54,11 @@ module LaunchDarkly
               new_state = LaunchDarkly::Interfaces::DataSource::Status::INITIALIZING
             end
 
+            # Special handling: You can't go back to INITIALIZING after being anything else
+            if new_state == LaunchDarkly::Interfaces::DataSource::Status::INITIALIZING && !old_status.state.nil?
+              new_state = old_status.state
+            end
+
             # No change if state is the same and no error
             return if new_state == old_status.state && new_error.nil?
 

data/lib/ldclient-rb/impl/data_store/in_memory_feature_store.rb

@@ -28,7 +28,7 @@ module LaunchDarkly
             items_of_kind = @items[kind]
             return nil if items_of_kind.nil?
 
-            item = items_of_kind[key]
+            item = items_of_kind[key.to_sym]
             return nil if item.nil?
             return nil if item[:deleted]
 

data/lib/ldclient-rb/impl/data_store/status_provider.rb

@@ -10,12 +10,6 @@ module LaunchDarkly
       #
       # StatusProviderV2 is the FDv2-specific implementation of {LaunchDarkly::Interfaces::DataStore::StatusProvider}.
       #
-      # This type is not stable, and not subject to any backwards
-      # compatibility guarantees or semantic versioning. It is not suitable for production usage.
-      #
-      # Do not use it.
-      # You have been warned.
-      #
       class StatusProviderV2
         include LaunchDarkly::Interfaces::DataStore::StatusProvider
 

data/lib/ldclient-rb/impl/data_store/store.rb

@@ -284,7 +284,7 @@ module LaunchDarkly
         # Convert a list of Changes to the pre-existing format used by FeatureStore.
         #
         # @param changes [Array<LaunchDarkly::Interfaces::DataSystem::Change>] List of changes
-        # @return [Hash{DataKind => Hash{String => Hash}}] Hash suitable for FeatureStore operations
+        # @return [Hash{DataKind => Hash{Symbol => Hash}}] Hash suitable for FeatureStore operations
         #
         private def changes_to_store_data(changes)
           all_data = {
@@ -307,7 +307,7 @@ module LaunchDarkly
         #
         # Reset dependency tracker with new full data set.
         #
-        # @param all_data [Hash{DataKind => Hash{String => Hash}}] Hash of data kinds to items
+        # @param all_data [Hash{DataKind => Hash{Symbol => Hash}}] Hash of data kinds to items
         # @return [void]
         #
         private def reset_dependency_tracker(all_data)

data/lib/ldclient-rb/impl/data_system/data_source_builder_common.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "ldclient-rb/impl/data_system/http_config_options"
+
+module LaunchDarkly
+  module Impl
+    module DataSystem
+      #
+      # DataSourceBuilderCommon is a mixin that provides common HTTP configuration
+      # setters for data source builders (polling and streaming).
+      #
+      # Each builder that includes this module must define a DEFAULT_BASE_URI constant.
+      #
+      module DataSourceBuilderCommon
+        #
+        # Sets the base URI for HTTP requests.
+        #
+        # @param uri [String]
+        # @return [self]
+        #
+        def base_uri(uri)
+          @base_uri = uri
+          self
+        end
+
+        #
+        # Sets a custom socket factory for HTTP connections.
+        #
+        # @param factory [Object]
+        # @return [self]
+        #
+        def socket_factory(factory)
+          @socket_factory = factory
+          self
+        end
+
+        #
+        # Sets the read timeout for HTTP connections.
+        #
+        # @param timeout [Float] Timeout in seconds
+        # @return [self]
+        #
+        def read_timeout(timeout)
+          @read_timeout = timeout
+          self
+        end
+
+        #
+        # Sets the connect timeout for HTTP connections.
+        #
+        # @param timeout [Float] Timeout in seconds
+        # @return [self]
+        #
+        def connect_timeout(timeout)
+          @connect_timeout = timeout
+          self
+        end
+
+        #
+        # Builds an HttpConfigOptions instance from the current builder settings.
+        # Uses self.class::DEFAULT_BASE_URI if base_uri was not explicitly set.
+        # Read/connect timeouts default to HttpConfigOptions defaults if not set.
+        #
+        # @return [HttpConfigOptions]
+        #
+        private def build_http_config
+          HttpConfigOptions.new(
+            base_uri: (@base_uri || self.class::DEFAULT_BASE_URI).chomp("/"),
+            socket_factory: @socket_factory,
+            read_timeout: @read_timeout,
+            connect_timeout: @connect_timeout
+          )
+        end
+      end
+    end
+  end
+end