launchdarkly-server-sdk 8.9.0 → 8.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71cc03d71aa917c1f2ac00b689bddfe0efddb535d3e7c2cd227ef0796f1a77bb
-  data.tar.gz: 37380c38265a220fdf591a34671492e5a3fb9825f29959b3b46ed0b435a43654
+  metadata.gz: a7101bb1e494892e6f290ea8293e1daa88cc9b1652714b1e784f7f65e68168a4
+  data.tar.gz: 5420c9a6aa5b7492a84a583fe362d02919f61422b3d5d859db44d86496fbbc3d
 SHA512:
-  metadata.gz: 7e0263a677a3d559e9138384a2fcc7eee7651a59c59792104b17e7f9b34b4f169f9a77e71dd91cc03e23d48ce321bc1a8d60379f18a07b96f7c0550bdcfb5c6c
-  data.tar.gz: 9fc01d2f4972879bb3ac598f59a82e3c0d4409d70fe32b2768eaa6acf554380311819244f435a2207eef34ba039bb49af5ab886967b93273827627613528d823
+  metadata.gz: 004c17af7aea8861d1de40dac99ae89e7ca8be8d21d99605e36c6225cc1e7b419948f30542ab500ca410b616331ede1c8acea165c324bd05db7086e344dd0cb8
+  data.tar.gz: e5433a32db3b0458b369d75adaf18978dd8dee3aa0252de12287aab1a54c4b71c3756003b9c73b3081c12fec07230fdd1406ba76f0acb7f125c87931d244cb6b

data/lib/ldclient-rb/config.rb

@@ -81,6 +81,7 @@ module LaunchDarkly
       @hooks = (opts[:hooks] || []).keep_if { |hook| hook.is_a? Interfaces::Hooks::Hook }
       @omit_anonymous_contexts = opts.has_key?(:omit_anonymous_contexts) && opts[:omit_anonymous_contexts]
       @data_source_update_sink = nil
+      @instance_id = nil
     end
 
     #
@@ -97,6 +98,18 @@ module LaunchDarkly
     #
     attr_accessor :data_source_update_sink
 
+
+    #
+    # Returns the unique identifier for this instance of the SDK.
+    #
+    # This property should only be set by the SDK. Long term access of this
+    # property is not supported; it is temporarily being exposed to maintain
+    # backwards compatibility while the SDK structure is updated.
+    #
+    # @private
+    #
+    attr_accessor :instance_id
+
     #
     # The base URL for the LaunchDarkly server. This is configurable mainly for testing
     # purposes; most users should use the default value.

data/lib/ldclient-rb/impl/integrations/consul_impl.rb

@@ -10,6 +10,7 @@ module LaunchDarkly
         class ConsulFeatureStoreCore
           begin
             require "diplomat"
+            require "ostruct"
             CONSUL_ENABLED = true
           rescue ScriptError, StandardError
             CONSUL_ENABLED = false

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

@@ -11,6 +11,9 @@ module LaunchDarkly
 
       def self.default_http_headers(sdk_key, config)
         ret = { "Authorization" => sdk_key, "User-Agent" => "RubyClient/" + LaunchDarkly::VERSION }
+
+        ret["X-LaunchDarkly-Instance-Id"] = config.instance_id unless config.instance_id.nil?
+
         if config.wrapper_name
           ret["X-LaunchDarkly-Wrapper"] = config.wrapper_name +
             (config.wrapper_version ? "/" + config.wrapper_version : "")

data/lib/ldclient-rb/ldclient.rb

@@ -13,6 +13,7 @@ require "concurrent/atomics"
 require "digest/sha1"
 require "forwardable"
 require "logger"
+require "securerandom"
 require "benchmark"
 require "json"
 require "openssl"
@@ -56,25 +57,57 @@ module LaunchDarkly
       end
 
       @sdk_key = sdk_key
-      @hooks = Concurrent::Array.new(config.hooks)
+      config.instance_id = SecureRandom.uuid
+      @config = config
+
+      start_up(wait_for_sec)
+    end
+
+    #
+    # Re-initializes an existing client after a process fork.
+    #
+    # The SDK relies on multiple background threads to operate correctly. When a process forks, `these threads are not
+    # available to the child <https://apidock.com/ruby/Process/fork/class>`.
+    #
+    # As a result, the SDK will not function correctly in the child process until it is re-initialized.
+    #
+    # This method is effectively equivalent to instantiating a new client. Future iterations of the SDK will provide
+    # increasingly efficient re-initializing improvements.
+    #
+    # Note that any configuration provided to the SDK will need to survive the forking process independently. For this
+    # reason, it is recommended that any listener or hook integrations be added postfork unless you are certain it can
+    # survive the forking process.
+    #
+    # @param wait_for_sec [Float] maximum time (in seconds) to wait for initialization
+    #
+    def postfork(wait_for_sec = 5)
+      @data_source = nil
+      @event_processor = nil
+      @big_segment_store_manager = nil
+
+      start_up(wait_for_sec)
+    end
+
+    private def start_up(wait_for_sec)
+      @hooks = Concurrent::Array.new(@config.hooks)
 
       @shared_executor = Concurrent::SingleThreadExecutor.new
 
-      data_store_broadcaster = LaunchDarkly::Impl::Broadcaster.new(@shared_executor, config.logger)
+      data_store_broadcaster = LaunchDarkly::Impl::Broadcaster.new(@shared_executor, @config.logger)
       store_sink = LaunchDarkly::Impl::DataStore::UpdateSink.new(data_store_broadcaster)
 
       # We need to wrap the feature store object with a FeatureStoreClientWrapper in order to add
       # some necessary logic around updates. Unfortunately, we have code elsewhere that accesses
       # the feature store through the Config object, so we need to make a new Config that uses
       # the wrapped store.
-      @store = Impl::FeatureStoreClientWrapper.new(config.feature_store, store_sink, config.logger)
-      updated_config = config.clone
+      @store = Impl::FeatureStoreClientWrapper.new(@config.feature_store, store_sink, @config.logger)
+      updated_config = @config.clone
       updated_config.instance_variable_set(:@feature_store, @store)
       @config = updated_config
 
       @data_store_status_provider = LaunchDarkly::Impl::DataStore::StatusProvider.new(@store, store_sink)
 
-      @big_segment_store_manager = Impl::BigSegmentStoreManager.new(config.big_segments, @config.logger)
+      @big_segment_store_manager = Impl::BigSegmentStoreManager.new(@config.big_segments, @config.logger)
       @big_segment_store_status_provider = @big_segment_store_manager.status_provider
 
       get_flag = lambda { |key| @store.get(FEATURES, key) }
@@ -83,7 +116,7 @@ module LaunchDarkly
       @evaluator = LaunchDarkly::Impl::Evaluator.new(get_flag, get_segment, get_big_segments_membership, @config.logger)
 
       if !@config.offline? && @config.send_events && !@config.diagnostic_opt_out?
-        diagnostic_accumulator = Impl::DiagnosticAccumulator.new(Impl::DiagnosticAccumulator.create_diagnostic_id(sdk_key))
+        diagnostic_accumulator = Impl::DiagnosticAccumulator.new(Impl::DiagnosticAccumulator.create_diagnostic_id(@sdk_key))
       else
         diagnostic_accumulator = nil
       end
@@ -91,7 +124,7 @@ module LaunchDarkly
       if @config.offline? || !@config.send_events
         @event_processor = NullEventProcessor.new
       else
-        @event_processor = EventProcessor.new(sdk_key, config, nil, diagnostic_accumulator)
+        @event_processor = EventProcessor.new(@sdk_key, @config, nil, diagnostic_accumulator)
       end
 
       if @config.use_ldd?
@@ -115,9 +148,9 @@ module LaunchDarkly
         # Currently, data source factories take two parameters unless they need to be aware of diagnostic_accumulator, in
         # which case they take three parameters. This will be changed in the future to use a less awkware mechanism.
         if data_source_or_factory.arity == 3
-          @data_source = data_source_or_factory.call(sdk_key, @config, diagnostic_accumulator)
+          @data_source = data_source_or_factory.call(@sdk_key, @config, diagnostic_accumulator)
         else
-          @data_source = data_source_or_factory.call(sdk_key, @config)
+          @data_source = data_source_or_factory.call(@sdk_key, @config)
         end
       else
         @data_source = data_source_or_factory

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "8.9.0" # x-release-please-version
+  VERSION = "8.10.0" # x-release-please-version
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 8.9.0
+  version: 8.10.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb