adjust requires and implementations

jsonbailey · jsonbailey · commit fe3c9f7c6aac · 2025-12-04T18:26:34.000Z
diff --git a/lib/ldclient-rb.rb b/lib/ldclient-rb.rb
@@ -5,23 +5,14 @@
 module LaunchDarkly
 end
 
-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"
+# Public APIs - these define the main interfaces users interact with
 require "ldclient-rb/config"
 require "ldclient-rb/context"
-require "ldclient-rb/reference"
-require "ldclient-rb/stream"
-require "ldclient-rb/polling"
-require "ldclient-rb/simple_lru_cache"
-require "ldclient-rb/non_blocking_thread_pool"
-require "ldclient-rb/events"
-require "ldclient-rb/requestor"
+require "ldclient-rb/flags_state"
 require "ldclient-rb/integrations"
+require "ldclient-rb/interfaces"
+require "ldclient-rb/ldclient"
+require "ldclient-rb/migrations"
+require "ldclient-rb/reference"
+require "ldclient-rb/util"
+require "ldclient-rb/version"
diff --git a/lib/ldclient-rb/config.rb b/lib/ldclient-rb/config.rb
@@ -1,4 +1,5 @@
 require "logger"
+require "ldclient-rb/impl/cache_store"
 
 module LaunchDarkly
   #
@@ -477,7 +478,7 @@ def self.default_events_uri
     # @return [Object] the Rails cache if in Rails, or a simple in-memory implementation otherwise
     #
     def self.default_cache_store
-      defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
+      defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : Impl::ThreadSafeMemoryStore.new
     end
 
     #
diff --git a/lib/ldclient-rb/events.rb b/lib/ldclient-rb/events.rb
@@ -3,6 +3,8 @@
 require "ldclient-rb/impl/event_sender"
 require "ldclient-rb/impl/event_summarizer"
 require "ldclient-rb/impl/event_types"
+require "ldclient-rb/impl/non_blocking_thread_pool"
+require "ldclient-rb/impl/simple_lru_cache"
 require "ldclient-rb/impl/util"
 
 require "concurrent"
@@ -141,7 +143,7 @@ def initialize(sdk_key, config, client = nil, diagnostic_accumulator = nil, test
       @inbox_full = Concurrent::AtomicBoolean.new(false)
 
       event_sender = (test_properties || {})[:event_sender] ||
-        Impl::EventSender.new(sdk_key, config, client || Util.new_http_client(config.events_uri, config))
+        Impl::EventSender.new(sdk_key, config, client || Impl::Util.new_http_client(config.events_uri, config))
 
       @timestamp_fn = (test_properties || {})[:timestamp_fn] || proc { Impl::Util.current_time_millis }
       @omit_anonymous_contexts = config.omit_anonymous_contexts
@@ -235,18 +237,18 @@ def initialize(inbox, sdk_key, config, diagnostic_accumulator, event_sender)
       @event_sender = event_sender
       @sampler = LaunchDarkly::Impl::Sampler.new(Random.new)
 
-      @context_keys = SimpleLRUCacheSet.new(config.context_keys_capacity)
+      @context_keys = Impl::SimpleLRUCacheSet.new(config.context_keys_capacity)
       @formatter = EventOutputFormatter.new(config)
       @disabled = Concurrent::AtomicBoolean.new(false)
       @last_known_past_time = Concurrent::AtomicReference.new(0)
       @deduplicated_contexts = 0
       @events_in_last_batch = 0
 
       outbox = EventBuffer.new(config.capacity, config.logger)
-      flush_workers = NonBlockingThreadPool.new(MAX_FLUSH_WORKERS, 'LD/EventDispatcher/FlushWorkers')
+      flush_workers = Impl::NonBlockingThreadPool.new(MAX_FLUSH_WORKERS, 'LD/EventDispatcher/FlushWorkers')
 
       if !@diagnostic_accumulator.nil?
-        diagnostic_event_workers = NonBlockingThreadPool.new(1, 'LD/EventDispatcher/DiagnosticEventWorkers')
+        diagnostic_event_workers = Impl::NonBlockingThreadPool.new(1, 'LD/EventDispatcher/DiagnosticEventWorkers')
         init_event = @diagnostic_accumulator.create_init_event(config)
         send_diagnostic_event(init_event, diagnostic_event_workers)
       else
@@ -383,7 +385,7 @@ def trigger_flush(outbox, flush_workers)
               @last_known_past_time.value = (result.time_from_server.to_f * 1000).to_i
             end
           rescue => e
-            Util.log_exception(@config.logger, "Unexpected error in event processor", e)
+            Impl::Util.log_exception(@config.logger, "Unexpected error in event processor", e)
           end
         end
         outbox.clear if success # Reset our internal state, these events now belong to the flush worker
diff --git a/lib/ldclient-rb/impl/big_segments.rb b/lib/ldclient-rb/impl/big_segments.rb
@@ -1,8 +1,8 @@
 require "ldclient-rb/config"
-require "ldclient-rb/expiring_cache"
+require "ldclient-rb/impl/expiring_cache"
 require "ldclient-rb/impl/repeating_task"
+require "ldclient-rb/impl/util"
 require "ldclient-rb/interfaces"
-require "ldclient-rb/util"
 
 require "digest"
 
@@ -45,7 +45,7 @@ def get_context_membership(context_key)
             membership = EMPTY_MEMBERSHIP if membership.nil?
             @cache[context_key] = membership
           rescue => e
-            LaunchDarkly::Util.log_exception(@logger, "Big Segment store membership query returned error", e)
+            Impl::Util.log_exception(@logger, "Big Segment store membership query returned error", e)
             return BigSegmentMembershipResult.new(nil, BigSegmentsStatus::STORE_ERROR)
           end
         end
@@ -67,7 +67,7 @@ def poll_store_and_update_status
             metadata = @store.get_metadata
             new_status = Interfaces::BigSegmentStoreStatus.new(true, !metadata || stale?(metadata.last_up_to_date))
           rescue => e
-            LaunchDarkly::Util.log_exception(@logger, "Big Segment store status query returned error", e)
+            Impl::Util.log_exception(@logger, "Big Segment store status query returned error", e)
           end
         end
         @last_status = new_status
diff --git a/lib/ldclient-rb/impl/data_source/requestor.rb b/lib/ldclient-rb/impl/data_source/requestor.rb
@@ -1,4 +1,5 @@
 require "ldclient-rb/impl/model/serialization"
+require "ldclient-rb/impl/util"
 
 require "concurrent/atomics"
 require "json"
@@ -27,7 +28,7 @@ class Requestor
         def initialize(sdk_key, config)
           @sdk_key = sdk_key
           @config = config
-          @http_client = LaunchDarkly::Util.new_http_client(config.base_uri, config)
+          @http_client = Impl::Util.new_http_client(config.base_uri, config)
             .use(:auto_inflate)
             .headers("Accept-Encoding" => "gzip")
           @cache = @config.cache_store
diff --git a/lib/ldclient-rb/impl/data_store.rb b/lib/ldclient-rb/impl/data_store.rb
@@ -4,7 +4,6 @@
 module LaunchDarkly
   module Impl
     module DataStore
-
       class DataKind
         FEATURES = "features".freeze
         SEGMENTS = "segments".freeze
diff --git a/lib/ldclient-rb/impl/evaluator.rb b/lib/ldclient-rb/impl/evaluator.rb
@@ -4,6 +4,7 @@
 require "ldclient-rb/impl/evaluator_operators"
 require "ldclient-rb/impl/model/feature_flag"
 require "ldclient-rb/impl/model/segment"
+require "ldclient-rb/impl/util"
 
 module LaunchDarkly
   module Impl
@@ -152,11 +153,11 @@ def evaluate(flag, context)
         begin
           detail = eval_internal(flag, context, result, state)
         rescue EvaluationException => exn
-          LaunchDarkly::Util.log_exception(@logger, "Unexpected error when evaluating flag #{flag.key}", exn)
+          Impl::Util.log_exception(@logger, "Unexpected error when evaluating flag #{flag.key}", exn)
           result.detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(exn.error_kind))
           return result, state
         rescue => exn
-          LaunchDarkly::Util.log_exception(@logger, "Unexpected error when evaluating flag #{flag.key}", exn)
+          Impl::Util.log_exception(@logger, "Unexpected error when evaluating flag #{flag.key}", exn)
           result.detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_EXCEPTION))
           return result, state
         end
diff --git a/lib/ldclient-rb/impl/event_sender.rb b/lib/ldclient-rb/impl/event_sender.rb
@@ -1,4 +1,5 @@
 require "ldclient-rb/impl/unbounded_pool"
+require "ldclient-rb/impl/util"
 
 require "securerandom"
 require "http"
@@ -21,7 +22,7 @@ def initialize(sdk_key, config, http_client = nil, retry_interval = DEFAULT_RETR
         @logger = config.logger
         @retry_interval = retry_interval
         @http_client_pool = UnboundedPool.new(
-          lambda { LaunchDarkly::Util.new_http_client(@config.events_uri, @config) },
+          lambda { Impl::Util.new_http_client(@config.events_uri, @config) },
           lambda { |client| client.close })
       end
 
@@ -81,9 +82,9 @@ def send_event_data(event_data, description, is_diagnostic)
               end
               return EventSenderResult.new(true, false, res_time)
             end
-            must_shutdown = !LaunchDarkly::Util.http_error_recoverable?(status)
+            must_shutdown = !Impl::Util.http_error_recoverable?(status)
             can_retry = !must_shutdown && attempt == 0
-            message = LaunchDarkly::Util.http_error_message(status, "event delivery", can_retry ? "will retry" : "some events were dropped")
+            message = Impl::Util.http_error_message(status, "event delivery", can_retry ? "will retry" : "some events were dropped")
             @logger.error { "[LDClient] #{message}" }
             if must_shutdown
               return EventSenderResult.new(false, true, nil)
diff --git a/lib/ldclient-rb/impl/integrations/file_data_source.rb b/lib/ldclient-rb/impl/integrations/file_data_source.rb
@@ -1,5 +1,5 @@
 require 'ldclient-rb/in_memory_store'
-require 'ldclient-rb/util'
+require 'ldclient-rb/impl/util'
 
 require 'concurrent/atomics'
 require 'json'
@@ -82,7 +82,7 @@ def load_all
             begin
               load_file(path, all_data)
             rescue => exn
-              LaunchDarkly::Util.log_exception(@logger, "Unable to load flag data from \"#{path}\"", exn)
+              Impl::Util.log_exception(@logger, "Unable to load flag data from \"#{path}\"", exn)
               @data_source_update_sink&.update_status(
                 LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED,
                 LaunchDarkly::Interfaces::DataSource::ErrorInfo.new(LaunchDarkly::Interfaces::DataSource::ErrorInfo::INVALID_DATA, 0, exn.to_s, Time.now)
@@ -212,7 +212,7 @@ def initialize(resolved_paths, interval, reloader, logger)
                   end
                   reloader.call if changed
                 rescue => exn
-                  LaunchDarkly::Util.log_exception(logger, "Unexpected exception in FileDataSourcePoller", exn)
+                  Impl::Util.log_exception(logger, "Unexpected exception in FileDataSourcePoller", exn)
                 end
               end
             end
diff --git a/lib/ldclient-rb/impl/migrations/migrator.rb b/lib/ldclient-rb/impl/migrations/migrator.rb
@@ -1,4 +1,5 @@
 require 'thread'
+require 'ldclient-rb/impl/util'
 
 module LaunchDarkly
   module Impl
@@ -274,7 +275,7 @@ def run()
           begin
             result = @fn.call(@payload)
           rescue => e
-            LaunchDarkly::Util.log_exception(@logger, "Unexpected error running method for '#{origin}' origin", e)
+            Impl::Util.log_exception(@logger, "Unexpected error running method for '#{origin}' origin", e)
             result = LaunchDarkly::Result.fail("'#{origin}' operation raised an exception", e)
           end
 
diff --git a/lib/ldclient-rb/impl/migrations/tracker.rb b/lib/ldclient-rb/impl/migrations/tracker.rb
@@ -1,5 +1,6 @@
 require "set"
 require "ldclient-rb/impl/sampler"
+require "ldclient-rb/impl/util"
 require "logger"
 
 module LaunchDarkly
@@ -67,7 +68,7 @@ def consistent(is_consistent)
               begin
                 @consistent = is_consistent.call
               rescue => e
-                LaunchDarkly::Util.log_exception(@logger, "Exception raised during consistency check; failed to record measurement", e)
+                Impl::Util.log_exception(@logger, "Exception raised during consistency check; failed to record measurement", e)
               end
             end
           end
diff --git a/lib/ldclient-rb/impl/repeating_task.rb b/lib/ldclient-rb/impl/repeating_task.rb
@@ -1,4 +1,4 @@
-require "ldclient-rb/util"
+require "ldclient-rb/impl/util"
 
 require "concurrent/atomics"
 
@@ -26,7 +26,7 @@ def start
             begin
               @task.call
             rescue => e
-              LaunchDarkly::Util.log_exception(@logger, "Uncaught exception from repeating task", e)
+              Impl::Util.log_exception(@logger, "Uncaught exception from repeating task", e)
             end
             delta = @interval - (Time.now - started_at)
             if delta > 0
diff --git a/lib/ldclient-rb/impl/util.rb b/lib/ldclient-rb/impl/util.rb
@@ -1,3 +1,6 @@
+require "uri"
+require "http"
+
 module LaunchDarkly
   module Impl
     module Util
@@ -93,6 +96,68 @@ def self.validate_payload_filter_key(value, logger)
         }
         nil
       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?
+
+        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
+      end
+
+      def self.new_http_client(uri_s, config)
+        http_client_options = {}
+        if config.socket_factory
+          http_client_options["socket_class"] = config.socket_factory
+        end
+        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,
+          })
+          .persistent(uri_s)
+      end
+
+      def self.log_exception(logger, message, exc)
+        logger.error { "[LDClient] #{message}: #{exc.inspect}" }
+        logger.debug { "[LDClient] Exception trace: #{exc.backtrace}" }
+      end
+
+      def self.http_error_recoverable?(status)
+        if status >= 400 && status < 500
+          status == 400 || status == 408 || status == 429
+        else
+          true
+        end
+      end
+
+      def self.http_error_message(status, context, recoverable_message)
+        desc = (status == 401 || status == 403) ? " (invalid SDK key)" : ""
+        message = http_error_recoverable?(status) ? recoverable_message : "giving up permanently"
+        "HTTP error #{status}#{desc} for #{context} - #{message}"
+      end
     end
   end
 end
diff --git a/lib/ldclient-rb/in_memory_store.rb b/lib/ldclient-rb/in_memory_store.rb
@@ -1,4 +1,5 @@
 require "concurrent/atomics"
+require "ldclient-rb/impl/data_store"
 
 module LaunchDarkly
 
diff --git a/lib/ldclient-rb/integrations/util/store_wrapper.rb b/lib/ldclient-rb/integrations/util/store_wrapper.rb
@@ -1,6 +1,7 @@
 require "concurrent/atomics"
 
-require "ldclient-rb/expiring_cache"
+require "ldclient-rb/impl/expiring_cache"
+require "ldclient-rb/interfaces"
 
 module LaunchDarkly
   module Integrations
@@ -37,7 +38,7 @@ def initialize(core, opts)
           expiration_seconds = opts[:expiration] || 15
           if expiration_seconds > 0
             capacity = opts[:capacity] || 1000
-            @cache = ExpiringCache.new(capacity, expiration_seconds)
+            @cache = Impl::ExpiringCache.new(capacity, expiration_seconds)
           else
             @cache = nil
           end
diff --git a/lib/ldclient-rb/ldclient.rb b/lib/ldclient-rb/ldclient.rb
@@ -5,6 +5,8 @@
 require "ldclient-rb/impl/data_source/null_processor"
 require "ldclient-rb/impl/diagnostic_events"
 require "ldclient-rb/impl/evaluator"
+require "ldclient-rb/events"
+require "ldclient-rb/in_memory_store"
 require "ldclient-rb/impl/evaluation_with_hook_result"
 require "ldclient-rb/impl/flag_tracker"
 require "ldclient-rb/impl/store_client_wrapper"
@@ -715,12 +717,12 @@ def create_default_data_source(sdk_key, config, diagnostic_accumulator)
       end
       raise ArgumentError, "sdk_key must not be nil" if sdk_key.nil?  # see LDClient constructor comment on sdk_key
       if config.stream?
-        StreamProcessor.new(sdk_key, config, diagnostic_accumulator)
+        Impl::DataSource::StreamProcessor.new(sdk_key, config, diagnostic_accumulator)
       else
         config.logger.info { "Disabling streaming API" }
         config.logger.warn { "You should only disable the streaming API if instructed to do so by LaunchDarkly support" }
-        requestor = Requestor.new(sdk_key, config)
-        PollingProcessor.new(config, requestor)
+        requestor = Impl::DataSource::Requestor.new(sdk_key, config)
+        Impl::DataSource::PollingProcessor.new(config, requestor)
       end
     end
 
diff --git a/lib/ldclient-rb/util.rb b/lib/ldclient-rb/util.rb
diff --git a/spec/config_spec.rb b/spec/config_spec.rb
diff --git a/spec/polling_spec.rb b/spec/polling_spec.rb
diff --git a/spec/requestor_spec.rb b/spec/requestor_spec.rb
diff --git a/spec/simple_lru_cache_spec.rb b/spec/simple_lru_cache_spec.rb
diff --git a/spec/store_spec.rb b/spec/store_spec.rb
diff --git a/spec/stream_spec.rb b/spec/stream_spec.rb
diff --git a/spec/util_spec.rb b/spec/util_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`require "logger"`
	`2`	`+require "ldclient-rb/impl/cache_store"`
`2`	`3`
`3`	`4`	`module LaunchDarkly`
`4`	`5`	`#`
`@@ -477,7 +478,7 @@ def self.default_events_uri`
`477`	`478`	`# @return [Object] the Rails cache if in Rails, or a simple in-memory implementation otherwise`
`478`	`479`	`#`
`479`	`480`	`def self.default_cache_store`
`480`		`- defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new`
	`481`	`+ defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : Impl::ThreadSafeMemoryStore.new`
`481`	`482`	`end`
`482`	`483`
`483`	`484`	`#`