launchdarkly-server-sdk 8.7.1 → 8.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1692535bf245c0627c6e08cb87f168b11d7518d895bf9faacb2858da227f9d70
-  data.tar.gz: fa60f044217ac286dd817b325ea87c431ce0399decc5ee84741638959b1a5697
+  metadata.gz: 508b6894ca8b1448c28d0358429561282e11b08569750eb2bc6200fa25b7a9ea
+  data.tar.gz: 335c7acd3d8903907489b88488976fdbe399f3f60e7a8ee4a1b99f525a42b2a0
 SHA512:
-  metadata.gz: 92fc2011f8a0a8ca594863155081e60abfdeec0be8d50a1ebf051ed0a7a97406eac7560a12cf9a5c2beed7de71b58ff0dc720569b67f65f2f582fb2f7b1528c0
-  data.tar.gz: e6a8b529997e0df8dfdf2a1b82c716211661bbeece2b50777146b5c6fdb7c8d97f69d23057ad6586b0730c9717fcb15b07a9808213da21ad7f9fbc91595c91f9
+  metadata.gz: 1656cd73d98bbfabf94b0efb14a07254c8018eee30e204fa0eca1ab531f8b314cb044404a023e6e51c04c967e46d2cecab8db880785540cd072c72e220152cad
+  data.tar.gz: 59fa0d6dff4c5ae6f366dca1da7831370c7838145bd4f21883ef74deb1897ebe76f26a8851b75beccace2d242bb0531d374a3cd047ff45638b1a445d2dd56b8d

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)
+          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/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/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "8.7.1" # x-release-please-version
+  VERSION = "8.8.1" # 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.7.1
+  version: 8.8.1
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb