launchdarkly-server-sdk 8.6.0 → 8.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a732ff00a5e21bfc907dff44adc5bd3f1651bd80c2483273a1a9730f443448f
-  data.tar.gz: 1ca26bf847c2387ed585e07b18c6aa42a78496110a7bf9643751a0e2b04d2908
+  metadata.gz: d13d9414f9f1c60e2af1e2505cc40005da11facb98f362f6ce7c5575f92a9596
+  data.tar.gz: 94b1b3fd7e9e6f3c685f0b42c2fd798c72445df71d6e436426a89341b864bbeb
 SHA512:
-  metadata.gz: 901e6f7562f0861916bf06fd07088561713579633cc5e052ae5cf86c6acdbdd0497b55e273c2f92244a5653d0fa806c9776f92a853bad22232634489c630f85d
-  data.tar.gz: a325418b21c256a8b2d846d187e8bc91ba1e323955f460a418732b77f30354b64fc2dbfdadd04c4be4a41217779a4f217d522799ace4ce46a3ebc5019baf060c
+  metadata.gz: eafd096ae3a4257855b762e2a267560fcec2b0e96c976fff4a6aa69e113dfe178888637ea27deb963d70df2dd9933503304c010f9e96e17c2ff68b6697d976f1
+  data.tar.gz: 1ec423bf28d9bf8b6f15f0a0deb9e6b24b175fdb0f9ebc1b25987d4335ceaedfd91532539aaaf1cea9f85c954739707b971642619b40fa9cbce66f3168ed527d

data/lib/ldclient-rb/config.rb

@@ -65,6 +65,7 @@ module LaunchDarkly
       @all_attributes_private = opts[:all_attributes_private] || false
       @private_attributes = opts[:private_attributes] || []
       @send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
+      @compress_events = opts.has_key?(:compress_events) ? opts[:compress_events] : Config.default_compress_events
       @context_keys_capacity = opts[:context_keys_capacity] || Config.default_context_keys_capacity
       @context_keys_flush_interval = opts[:context_keys_flush_interval] || Config.default_context_keys_flush_interval
       @data_source = opts[:data_source]
@@ -76,7 +77,7 @@ module LaunchDarkly
       @socket_factory = opts[:socket_factory]
       @big_segments = opts[:big_segments] || BigSegmentsConfig.new(store: nil)
       @application = LaunchDarkly::Impl::Util.validate_application_info(opts[:application] || {}, @logger)
-      @payload_filter_key = opts[:payload_filter_key]
+      @payload_filter_key = LaunchDarkly::Impl::Util.validate_payload_filter_key(opts[:payload_filter_key] , @logger)
       @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
@@ -254,6 +255,17 @@ module LaunchDarkly
     #
     attr_reader :send_events
 
+    #
+    # Should the event payload sent to LaunchDarkly use gzip compression. By default this is false to prevent backward
+    # breaking compatibility issues with older versions of the relay proxy.
+    #
+    # Customers not using the relay proxy are strongly encouraged to enable this feature to reduce egress bandwidth
+    # cost.
+    #
+    # @return [Boolean]
+    #
+    attr_reader :compress_events
+
     #
     # The number of context keys that the event processor can remember at any one time. This reduces the
     # amount of duplicate context details sent in analytics events.
@@ -539,6 +551,14 @@ module LaunchDarkly
       true
     end
 
+    #
+    # The default value for {#compress_events}.
+    # @return [Boolean] false
+    #
+    def self.default_compress_events
+      false
+    end
+
     #
     # The default value for {#context_keys_capacity}.
     # @return [Integer] 1000

data/lib/ldclient-rb/events.rb

@@ -513,13 +513,13 @@ module LaunchDarkly
           evaluation: {
             key: event.key,
             value: event.evaluation.value,
+            reason: event.evaluation.reason,
           },
         }
 
         out[:evaluation][:version] = event.version unless event.version.nil?
         out[:evaluation][:default] = event.default unless event.default.nil?
         out[:evaluation][:variation] = event.evaluation.variation_index unless event.evaluation.variation_index.nil?
-        out[:evaluation][:reason] = event.evaluation.reason unless event.evaluation.reason.nil?
         out[:samplingRatio] = event.sampling_ratio unless event.sampling_ratio.nil? || event.sampling_ratio == 1
 
         measurements = []

data/lib/ldclient-rb/flags_state.rb

@@ -38,6 +38,7 @@ module LaunchDarkly
         meta[:version] = flag_state[:version]
       end
 
+      meta[:prerequisites] = flag_state[:prerequisites] unless flag_state[:prerequisites].nil? || flag_state[:prerequisites].empty?
       meta[:variation] = flag_state[:variation] unless flag_state[:variation].nil?
       meta[:trackEvents] = true if flag_state[:trackEvents]
       meta[:trackReason] = true if flag_state[:trackReason]

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

@@ -4,6 +4,56 @@ require "ldclient-rb/interfaces"
 module LaunchDarkly
   module Impl
     module DataStore
+
+      class DataKind
+        FEATURES = "features".freeze
+        SEGMENTS = "segments".freeze
+
+        FEATURE_PREREQ_FN = lambda { |flag| (flag[:prerequisites] || []).map { |p| p[:key] } }.freeze
+
+        attr_reader :namespace
+        attr_reader :priority
+
+        #
+        # @param namespace [String]
+        # @param priority [Integer]
+        #
+        def initialize(namespace:, priority:)
+          @namespace = namespace
+          @priority = priority
+        end
+
+        #
+        # Maintain the same behavior when these data kinds were standard ruby hashes.
+        #
+        # @param key [Symbol]
+        # @return [Object]
+        #
+        def [](key)
+          return priority if key == :priority
+          return namespace if key == :namespace
+          return get_dependency_keys_fn() if key == :get_dependency_keys
+          nil
+        end
+
+        #
+        # Retrieve the dependency keys for a particular data kind. Right now, this is only defined for flags.
+        #
+        def get_dependency_keys_fn()
+          return nil unless @namespace == FEATURES
+
+          FEATURE_PREREQ_FN
+        end
+
+        def eql?(other)
+          other.is_a?(DataKind) && namespace == other.namespace && priority == other.priority
+        end
+
+        def hash
+          [namespace, priority].hash
+        end
+      end
+
       class StatusProvider
         include LaunchDarkly::Interfaces::DataStore::StatusProvider
 

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

@@ -32,8 +32,16 @@ module LaunchDarkly
       def initialize(original_flag)
         @prereq_stack = EvaluatorStack.new(original_flag.key)
         @segment_stack = EvaluatorStack.new(nil)
+        @prerequisites = []
+        @depth = 0
       end
 
+      def record_evaluated_prereq_key(key)
+        @prerequisites.push(key) if @depth.zero?
+      end
+
+      attr_accessor :depth
+      attr_reader :prerequisites
       attr_reader :prereq_stack
       attr_reader :segment_stack
     end
@@ -135,7 +143,8 @@ module LaunchDarkly
       #
       # @param flag [LaunchDarkly::Impl::Model::FeatureFlag] the flag
       # @param context [LaunchDarkly::LDContext] the evaluation context
-      # @return [EvalResult] the evaluation result
+      # @return [Array<EvalResult, EvaluatorState>] the evaluation result and a state object that may be used for
+      # inspecting the evaluation process
       def evaluate(flag, context)
         state = EvaluatorState.new(flag)
 
@@ -145,11 +154,11 @@ module LaunchDarkly
         rescue EvaluationException => exn
           LaunchDarkly::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
+          return result, state
         rescue => exn
           LaunchDarkly::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
+          return result, state
         end
 
         unless result.big_segments_status.nil?
@@ -159,7 +168,7 @@ module LaunchDarkly
             detail.reason.with_big_segments_status(result.big_segments_status))
         end
         result.detail = detail
-        result
+        [result, state]
       end
 
       # @param segment [LaunchDarkly::Impl::Model::Segment]
@@ -223,13 +232,16 @@ module LaunchDarkly
               )
             end
 
+            state.record_evaluated_prereq_key(prereq_key)
             prereq_flag = @get_flag.call(prereq_key)
 
             if prereq_flag.nil?
               @logger.error { "[LDClient] Could not retrieve prerequisite flag \"#{prereq_key}\" when evaluating \"#{flag.key}\"" }
               prereq_ok = false
             else
+              state.depth += 1
               prereq_res = eval_internal(prereq_flag, context, eval_result, state)
+              state.depth -= 1
               # Note that if the prerequisite flag is off, we don't consider it a match no matter what its
               # off variation was. But we still need to evaluate it in order to generate an event.
               if !prereq_flag.on || prereq_res.variation_index != prerequisite.variation

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

@@ -2,6 +2,8 @@ require "ldclient-rb/impl/unbounded_pool"
 
 require "securerandom"
 require "http"
+require "stringio"
+require "zlib"
 
 module LaunchDarkly
   module Impl
@@ -42,14 +44,24 @@ module LaunchDarkly
               @logger.debug { "[LDClient] sending #{description}: #{event_data}" }
               headers = {}
               headers["content-type"] = "application/json"
+              headers["content-encoding"] = "gzip" if @config.compress_events
               Impl::Util.default_http_headers(@sdk_key, @config).each { |k, v| headers[k] = v }
               unless is_diagnostic
                 headers["X-LaunchDarkly-Event-Schema"] = CURRENT_SCHEMA_VERSION.to_s
                 headers["X-LaunchDarkly-Payload-ID"] = payload_id
               end
+
+              body = event_data
+              if @config.compress_events
+                gzip = Zlib::GzipWriter.new(StringIO.new)
+                gzip << event_data
+
+                body = gzip.close.string
+              end
+
               response = http_client.request("POST", uri, {
                 headers: headers,
-                body: event_data,
+                body: body,
               })
             rescue StandardError => exn
               @logger.warn { "[LDClient] Error sending events: #{exn.inspect}." }

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

@@ -75,6 +75,21 @@ module LaunchDarkly
           version: validate_application_value(app[:version], :version, logger),
         }
       end
+
+      #
+      # @param value [String, nil]
+      # @param logger [Logger]
+      # @return [String, nil]
+      #
+      def self.validate_payload_filter_key(value, logger)
+        return nil if value.nil?
+        return value if value.is_a?(String) && /^[a-zA-Z0-9][._\-a-zA-Z0-9]*$/.match?(value)
+
+        logger.warn {
+          "Invalid payload filter configured, full environment will be fetched. Ensure the filter key is not empty and was copied correctly from LaunchDarkly settings."
+        }
+        nil
+      end
     end
   end
 end

data/lib/ldclient-rb/in_memory_store.rb

@@ -11,17 +11,10 @@ module LaunchDarkly
   # to ensure data consistency during non-atomic updates.
 
   # @private
-  FEATURES = {
-    namespace: "features",
-    priority: 1,  # that is, features should be stored after segments
-    get_dependency_keys: lambda { |flag| (flag[:prerequisites] || []).map { |p| p[:key] } },
-  }.freeze
+  FEATURES = Impl::DataStore::DataKind.new(namespace: "features", priority: 1).freeze
 
   # @private
-  SEGMENTS = {
-    namespace: "segments",
-    priority: 0,
-  }.freeze
+  SEGMENTS = Impl::DataStore::DataKind.new(namespace: "segments", priority: 0).freeze
 
   # @private
   ALL_KINDS = [FEATURES, SEGMENTS].freeze

data/lib/ldclient-rb/ldclient.rb

@@ -546,7 +546,8 @@ module LaunchDarkly
           next
         end
         begin
-          detail = @evaluator.evaluate(f, context).detail
+          (eval_result, eval_state) = @evaluator.evaluate(f, context)
+          detail = eval_result.detail
         rescue => exn
           detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_EXCEPTION))
           Util.log_exception(@config.logger, "Error evaluating flag \"#{k}\" in all_flags_state", exn)
@@ -558,6 +559,7 @@ module LaunchDarkly
           value: detail.value,
           variation: detail.variation_index,
           reason: detail.reason,
+          prerequisites: eval_state.prerequisites,
           version: f[:version],
           trackEvents: f[:trackEvents] || requires_experiment_data,
           trackReason: requires_experiment_data,
@@ -705,7 +707,7 @@ module LaunchDarkly
       end
 
       begin
-        res = @evaluator.evaluate(feature, context)
+        (res, _) = @evaluator.evaluate(feature, context)
         unless res.prereq_evals.nil?
           res.prereq_evals.each do |prereq_eval|
             record_prereq_flag_eval(prereq_eval.prereq_flag, prereq_eval.prereq_of_flag, context, prereq_eval.detail, with_reasons)

data/lib/ldclient-rb/util.rb

@@ -77,11 +77,6 @@ module LaunchDarkly
     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]

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "8.6.0" # x-release-please-version
+  VERSION = "8.8.2" # 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.6.0
+  version: 8.8.2
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.57'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +268,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -376,7 +410,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby