launchdarkly-server-sdk 8.15.1 → 8.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b22ffc1ba131d82969abf4c5e6b04ab80d18a5112393a41f59a3b7217e9633
-  data.tar.gz: 52e8d3a1615a43d15d9fa548db9568456409c3cbfd716f558635c7377b35987f
+  metadata.gz: 74715a28fdf3d75b188d4689034d3e297d90facb6084422f9fdc7dca4f007e81
+  data.tar.gz: 51b24db08e38873412290d8ed0860ea2ae9c7004aa4368a2a943029c347ef5a5
 SHA512:
-  metadata.gz: b632a4958bab5ad77398d87cf3b018e0fe35c37e53b5590dc330b6c395a6fe22f0fc50ef820182b197179ac9c933356bf1a718b8f5bdcd4d8b40d3daae8367b5
-  data.tar.gz: 22284f8464984ed1de431109260354d8285ae2079a47429a62e2e8fb49abb954e4d75c220cf264a9409b20bcd0ddc2cb6ca167c8ddd481bf8d769e08b5642362
+  metadata.gz: 1f1975f00b4a78aca6b008963654b6e1a6496e09b8634625bdd8c8af34a5d4b9a73788f3b107b076f751811e4b8f9209ffbc2203b0e8f098cccc4df629898122
+  data.tar.gz: 7e55a4a3997de7f46c5e5157d354f35990878645d1ac957f673903fa96bb523342d7dd33a0e780000fc53828d2519cdc049df24b661c208bb1fbe0ffb8ac3ba0

data/lib/ldclient-rb/config.rb

@@ -362,6 +362,9 @@ module LaunchDarkly
     # This payload filter key only applies to the default streaming and polling data sources. It will not affect TestData or FileData
     # data sources, nor will it be applied to any data source provided through the {#data_source} config property.
     #
+    # Payload filtering is not supported with the FDv2 data system, so this key has no effect on requests made by FDv2
+    # data sources.
+    #
     attr_reader :payload_filter_key
 
     #

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

@@ -54,6 +54,11 @@ module LaunchDarkly
           @config = config
           @data_system_config = data_system_config
           @logger = config.logger
+
+          unless config.payload_filter_key.nil?
+            @logger.warn { "[LDClient] Payload filtering is not supported with the FDv2 data system; the configured payload filter has no effect on FDv2 requests" }
+          end
+
           @synchronizer_builders = data_system_config.synchronizers || []
           @fdv1_fallback_synchronizer_builder = data_system_config.fdv1_fallback_synchronizer
           @disabled = @config.offline?

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

@@ -4,22 +4,39 @@ require "concurrent/atomics"
 
 module LaunchDarkly
   module Impl
+    #
+    # Runs a task again and again on a worker thread, with a fixed interval
+    # between runs.
+    #
+    # The worker waits on an event instead of calling `sleep`, so `stop` can
+    # wake it at once even if `stop` runs before the worker starts waiting.
+    #
+    # @private
+    #
     class RepeatingTask
       attr_reader :name
 
+      #
+      # @param interval [Numeric] seconds between the start of one run and the start of the next
+      # @param start_delay [Numeric, nil] seconds to wait before the first run
+      # @param task [Proc] the code to run
+      # @param logger [Logger]
+      # @param name [String] the name given to the worker thread
+      #
       def initialize(interval, start_delay, task, logger, name)
         @interval = interval
         @start_delay = start_delay
         @task = task
         @logger = logger
         @stopped = Concurrent::AtomicBoolean.new(false)
+        @stop_event = Concurrent::Event.new
         @worker = nil
         @name = name
       end
 
       def start
         @worker = Thread.new do
-          sleep(@start_delay) unless @start_delay.nil? || @start_delay == 0
+          @stop_event.wait(@start_delay) unless @start_delay.nil? || @start_delay == 0
 
           until @stopped.value do
             started_at = Time.now
@@ -29,19 +46,23 @@ module LaunchDarkly
               Impl::Util.log_exception(@logger, "Uncaught exception from repeating task", e)
             end
             delta = @interval - (Time.now - started_at)
-            if delta > 0
-              sleep(delta)
-            end
+            @stop_event.wait(delta) if delta > 0
           end
         end
 
         @worker.name = @name
       end
 
+      #
+      # Stops the worker thread and waits for it to finish.
+      #
+      # This method is safe to call more than once, before `start`, and from
+      # inside the task itself.
+      #
       def stop
         if @stopped.make_true
+          @stop_event.set
           if @worker && @worker.alive? && @worker != Thread.current
-            @worker.run  # causes the thread to wake up if it's currently in a sleep
             @worker.join
           end
         end

data/lib/ldclient-rb/integrations/test_data/flag_builder.rb

@@ -487,7 +487,7 @@ module LaunchDarkly
         #
         class FlagRuleBuilder
           # @api private
-          FlagRuleClause = Struct.new(:contextKind, :attribute, :op, :values, :negate, keyword_init: true) # rubocop:disable Naming/MethodName:
+          FlagRuleClause = Struct.new(:contextKind, :attribute, :op, :values, :negate, keyword_init: true) # rubocop:disable Naming/MethodName
 
           # @api private
           def initialize(flag_builder)

data/lib/ldclient-rb/ldclient.rb

@@ -33,10 +33,6 @@ module LaunchDarkly
 
     def_delegators :@config, :logger
 
-    # @!method flush
-    #   Delegates to {LaunchDarkly::EventProcessorMethods#flush}.
-    def_delegator :@event_processor, :flush
-
     # @!method data_store_status_provider
     #   Delegates to the data system {LaunchDarkly::Impl::DataSystem#data_store_status_provider}.
     #   @return [LaunchDarkly::Interfaces::DataStore::StatusProvider]
@@ -79,6 +75,12 @@ module LaunchDarkly
       config.instance_id = SecureRandom.uuid
       @config = config
 
+      # The pid of the process that owns this client's background threads. A child process that
+      # inherits this client after a fork has a different pid. See #check_forked.
+      @owner_pid = Process.pid
+      # The pid of the process in which the fork warning was last logged, or nil.
+      @fork_warned_pid = Concurrent::AtomicReference.new(nil)
+
       start_up(wait_for_sec)
     end
 
@@ -97,6 +99,10 @@ module LaunchDarkly
     # reason, it is recommended that any listener or hook integrations be added postfork unless you are certain it can
     # survive the forking process.
     #
+    # If the SDK is used in a forked child process before this method is called, it logs a warning once per process.
+    # The warning says that flag updates and analytics events will not work until `postfork` is called. Calling this
+    # method clears that condition for the current process.
+    #
     # @param wait_for_sec [Float] maximum time (in seconds) to wait for initialization
     #
     def postfork(wait_for_sec = 5)
@@ -105,9 +111,51 @@ module LaunchDarkly
       @big_segment_store_manager = nil
       @flag_tracker = nil
 
+      @owner_pid = Process.pid
+      @fork_warned_pid.set(nil)
+
       start_up(wait_for_sec)
     end
 
+    FORK_WARNING_MESSAGE = "[LDClient] This process was forked after the LDClient was created. Background threads do not " +
+      "survive a fork, so flag updates and analytics events will not work in this process. Call LDClient#postfork after forking."
+    private_constant :FORK_WARNING_MESSAGE
+
+    #
+    # Log a warning once per process if this client is used in a process that was forked after the client was created.
+    #
+    # Ruby threads do not survive a fork. A child process that inherits a client has no stream thread, no event
+    # dispatcher thread, and no timer tasks, so flag updates and analytics events stop working. The SDK does not
+    # repair this by itself; the application must call {#postfork}.
+    #
+    # The check compares the current pid with the pid recorded in the constructor or in {#postfork}. It is a single
+    # `getpid` call, which is cheap compared to a flag evaluation. The "already warned" state is stored as the pid in
+    # which the warning was logged, not as a boolean. A boolean would be copied into every child on fork, so a
+    # grandchild process would inherit "already warned" from its parent and never get its own warning.
+    #
+    private def check_forked
+      pid = Process.pid
+      return if pid == @owner_pid
+      return unless fork_breaks_client?
+
+      if @fork_warned_pid.get_and_set(pid) != pid
+        @config.logger.warn { FORK_WARNING_MESSAGE }
+      end
+    end
+
+    #
+    # Return true if this configuration needs background threads. Offline mode has none. LDD mode with events
+    # disabled reads flags from the persistent store and sends nothing, so a fork does not break it.
+    #
+    # @return [Boolean]
+    #
+    private def fork_breaks_client?
+      return false if @config.offline?
+      return false if @config.use_ldd? && !@config.send_events
+
+      true
+    end
+
     private def start_up(wait_for_sec)
       environment_metadata = get_environment_metadata
       plugin_hooks = get_plugin_hooks(environment_metadata)
@@ -281,6 +329,7 @@ module LaunchDarkly
     # @return the variation for the provided context, or the default value if there's an error
     #
     def variation(key, context, default)
+      check_forked
       context = Impl::Context::make_context(context)
       result = evaluate_with_hooks(key, context, default, :variation) do
         detail, _, _ = variation_with_flag(key, context, default)
@@ -314,6 +363,7 @@ module LaunchDarkly
     # @return [EvaluationDetail] an object describing the result
     #
     def variation_detail(key, context, default)
+      check_forked
       context = Impl::Context::make_context(context)
       result = evaluate_with_hooks(key, context, default, :variation_detail) do
         detail, _, _ = evaluate_internal(key, context, default, true)
@@ -439,6 +489,7 @@ module LaunchDarkly
     # @return [Array<Symbol, Interfaces::Migrations::OpTracker>]
     #
     def migration_variation(key, context, default_stage)
+      check_forked
       unless Migrations::VALID_STAGES.include? default_stage
         @config.logger.error { "[LDClient] default_stage #{default_stage} is not a valid stage; continuing with 'off' as default" }
         default_stage = Migrations::STAGE_OFF
@@ -480,6 +531,7 @@ module LaunchDarkly
     # @return [void]
     #
     def identify(context)
+      check_forked
       context = LaunchDarkly::Impl::Context.make_context(context)
       unless context.valid?
         @config.logger.warn("Identify called with invalid context: #{context.error}")
@@ -516,6 +568,7 @@ module LaunchDarkly
     # @return [void]
     #
     def track(event_name, context, data = nil, metric_value = nil)
+      check_forked
       context = LaunchDarkly::Impl::Context.make_context(context)
       unless context.valid?
         @config.logger.warn("Track called with invalid context: #{context.error}")
@@ -536,6 +589,7 @@ module LaunchDarkly
     # @param tracker [LaunchDarkly::Interfaces::Migrations::OpTracker]
     #
     def track_migration_op(tracker)
+      check_forked
       unless tracker.is_a? LaunchDarkly::Interfaces::Migrations::OpTracker
         @config.logger.error { "invalid op tracker received in track_migration_op" }
         return
@@ -571,6 +625,8 @@ module LaunchDarkly
     def all_flags_state(context, options={})
       return FeatureFlagsState.new(false) if @config.offline?
 
+      check_forked
+
       unless initialized?
         if @data_system.store.initialized?
             @config.logger.warn { "Called all_flags_state before client initialization; using last known values from data store" }
@@ -628,11 +684,24 @@ module LaunchDarkly
       state
     end
 
+    #
+    # Tells the client that all pending analytics events should be delivered as soon as possible.
+    #
+    # Delegates to {LaunchDarkly::EventProcessorMethods#flush}.
+    #
+    # @return [void]
+    #
+    def flush
+      check_forked
+      @event_processor.flush
+    end
+
     #
     # Releases all network connections and other resources held by the client, making it no longer usable.
     #
     # @return [void]
     def close
+      check_forked
       @config.logger.info { "[LDClient] Closing LaunchDarkly client..." }
       @data_system.stop
       @event_processor.stop

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "8.15.1" # x-release-please-version
+  VERSION = "8.17.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.15.1
+  version: 8.17.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-28 00:00:00.000000000 Z
+date: 2026-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb