launchdarkly-server-sdk 7.0.2 → 8.4.2

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

@@ -0,0 +1,58 @@
+require "concurrent"
+require "ldclient-rb/interfaces"
+require "forwardable"
+
+module LaunchDarkly
+  module Impl
+    class FlagTracker
+      include LaunchDarkly::Interfaces::FlagTracker
+
+      extend Forwardable
+      def_delegators :@broadcaster, :add_listener, :remove_listener
+
+      def initialize(broadcaster, eval_fn)
+        @broadcaster = broadcaster
+        @eval_fn = eval_fn
+      end
+
+      def add_flag_value_change_listener(key, context, listener)
+        flag_change_listener = FlagValueChangeAdapter.new(key, context, listener, @eval_fn)
+        add_listener(flag_change_listener)
+
+        flag_change_listener
+      end
+
+      #
+      # An adapter which turns a normal flag change listener into a flag value change listener.
+      #
+      class FlagValueChangeAdapter
+        # @param [Symbol] flag_key
+        # @param [LaunchDarkly::LDContext] context
+        # @param [#update] listener
+        # @param [#call] eval_fn
+        def initialize(flag_key, context, listener, eval_fn)
+          @flag_key = flag_key
+          @context = context
+          @listener = listener
+          @eval_fn = eval_fn
+          @value = Concurrent::AtomicReference.new(@eval_fn.call(@flag_key, @context))
+        end
+
+        #
+        # @param [LaunchDarkly::Interfaces::FlagChange] flag_change
+        #
+        def update(flag_change)
+          return unless flag_change.key == @flag_key
+
+          new_eval = @eval_fn.call(@flag_key, @context)
+          old_eval = @value.get_and_set(new_eval)
+
+          return if new_eval == old_eval
+
+          @listener.update(
+            LaunchDarkly::Interfaces::FlagValueChange.new(@flag_key, old_eval, new_eval))
+        end
+      end
+    end
+  end
+end

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

@@ -119,6 +119,18 @@ module LaunchDarkly
             end
           end
 
+          def available?
+            # Most implementations use the initialized_internal? method as a
+            # proxy for this check. However, since `initialized_internal?`
+            # catches a KeyNotFound exception, and that exception can be raised
+            # when the server goes away, we have to modify our behavior
+            # slightly.
+            Diplomat::Kv.get(inited_key, {}, :return, :return)
+            true
+          rescue
+            false
+          end
+
           def stop
             # There's no Consul client instance to dispose of
           end

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

@@ -62,6 +62,14 @@ module LaunchDarkly
             "DynamoDBFeatureStore"
           end
 
+          def available?
+            resp = get_item_by_keys(inited_key, inited_key)
+            !resp.item.nil? && resp.item.length > 0
+            true
+          rescue
+            false
+          end
+
           def init_internal(all_data)
             # Start by reading the existing keys; we will later delete any of these that weren't in all_data.
             unused_old_keys = read_existing_keys(all_data.keys)

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

@@ -18,10 +18,18 @@ module LaunchDarkly
           require 'listen'
           @@have_listen = true
         rescue LoadError
+          # Ignored
         end
 
-        def initialize(feature_store, logger, options={})
-          @feature_store = feature_store
+        #
+        # @param data_store [LaunchDarkly::Interfaces::FeatureStore]
+        # @param data_source_update_sink [LaunchDarkly::Interfaces::DataSource::UpdateSink, nil] Might be nil for backwards compatibility reasons.
+        # @param logger [Logger]
+        # @param options [Hash]
+        #
+        def initialize(data_store, data_source_update_sink, logger, options={})
+          @data_store = data_source_update_sink || data_store
+          @data_source_update_sink = data_source_update_sink
           @logger = logger
           @paths = options[:paths] || []
           if @paths.is_a? String
@@ -80,10 +88,15 @@ module LaunchDarkly
               load_file(path, all_data)
             rescue => exn
               LaunchDarkly::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)
+              )
               return
             end
           end
-          @feature_store.init(all_data)
+          @data_store.init(all_data)
+          @data_source_update_sink&.update_status(LaunchDarkly::Interfaces::DataSource::Status::VALID, nil)
           @initialized.make_true
         end
 

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

@@ -1,3 +1,4 @@
+require "ldclient-rb/interfaces"
 require "concurrent/atomics"
 require "json"
 
@@ -42,6 +43,14 @@ module LaunchDarkly
             @wrapper = LaunchDarkly::Integrations::Util::CachingStoreWrapper.new(core, opts)
           end
 
+          def monitoring_enabled?
+            true
+          end
+
+          def available?
+            @wrapper.available?
+          end
+
           #
           # Default value for the `redis_url` constructor parameter; points to an instance of Redis
           # running at `localhost` with its default port.
@@ -103,13 +112,13 @@ module LaunchDarkly
             @pool = create_redis_pool(opts)
 
             # shutdown pool on close unless the client passed a custom pool and specified not to shutdown
-            @pool_shutdown_on_close = (!opts[:pool] || opts.fetch(:pool_shutdown_on_close, true))
+            @pool_shutdown_on_close = !opts[:pool] || opts.fetch(:pool_shutdown_on_close, true)
 
             @prefix = opts[:prefix] || LaunchDarkly::Integrations::Redis::default_prefix
             @logger = opts[:logger] || Config.default_logger
             @test_hook = opts[:test_hook]  # used for unit tests, deliberately undocumented
 
-            @stopped = Concurrent::AtomicBoolean.new()
+            @stopped = Concurrent::AtomicBoolean.new
 
             with_connection do |redis|
               @logger.info("#{description}: using Redis instance at #{redis.connection[:host]}:#{redis.connection[:port]} and prefix: #{@prefix}")
@@ -154,6 +163,14 @@ module LaunchDarkly
             @test_hook = opts[:test_hook]  # used for unit tests, deliberately undocumented
           end
 
+          def available?
+            # We don't care what the status is, only that we can connect
+            initialized_internal?
+            true
+          rescue
+            false
+          end
+
           def description
             "RedisFeatureStore"
           end

data/lib/ldclient-rb/impl/migrations/migrator.rb

@@ -0,0 +1,287 @@
+require 'thread'
+
+module LaunchDarkly
+  module Impl
+    module Migrations
+
+      #
+      # A migration config stores references to callable methods which execute customer defined read or write
+      # operations on old or new origins of information. For read operations, an optional comparison function also be
+      # defined.
+      #
+      class MigrationConfig
+        #
+        # @param old [#call] Refer to {#old}
+        # @param new [#call] Refer to {#new}
+        # @param comparison [#call, nil] Refer to {#comparison}
+        #
+        def initialize(old, new, comparison)
+          @old = old
+          @new = new
+          @comparison = comparison
+        end
+
+        #
+        # Callable which receives a nullable payload parameter and returns an {LaunchDarkly::Result}.
+        #
+        # This function call should affect the old migration origin when called.
+        #
+        # @return [#call]
+        #
+        attr_reader :old
+
+        #
+        # Callable which receives a nullable payload parameter and returns an {LaunchDarkly::Result}.
+        #
+        # This function call should affect the new migration origin when called.
+        #
+        # @return [#call]
+        #
+        attr_reader :new
+
+        #
+        # Optional callable which receives two objects of any kind and returns a boolean representing equality.
+        #
+        # The result of this comparison can be sent upstream to LaunchDarkly to enhance migration observability.
+        #
+        # @return [#call, nil]
+        #
+        attr_reader :comparison
+      end
+
+      #
+      # An implementation of the [LaunchDarkly::Interfaces::Migrations::Migrator] interface, capable of supporting
+      # feature-flag backed technology migrations.
+      #
+      class Migrator
+        include LaunchDarkly::Interfaces::Migrations::Migrator
+
+        #
+        # @param client [LaunchDarkly::LDClient]
+        # @param read_execution_order [Symbol]
+        # @param read_config [MigrationConfig]
+        # @param write_config [MigrationConfig]
+        # @param measure_latency [Boolean]
+        # @param measure_errors [Boolean]
+        #
+        def initialize(client, read_execution_order, read_config, write_config, measure_latency, measure_errors)
+          @client = client
+          @read_execution_order = read_execution_order
+          @read_config = read_config
+          @write_config = write_config
+          @measure_latency = measure_latency
+          @measure_errors = measure_errors
+          @sampler = LaunchDarkly::Impl::Sampler.new(Random.new)
+        end
+
+        #
+        # Perform the configured read operations against the appropriate old and/or new origins.
+        #
+        # @param key [String] The migration-based flag key to use for determining migration stages
+        # @param context [LaunchDarkly::LDContext] The context to use for evaluating the migration flag
+        # @param default_stage [Symbol] The stage to fallback to if one could not be determined for the requested flag
+        # @param payload [String] An optional payload to pass through to the configured read operations.
+        #
+        # @return [LaunchDarkly::Migrations::OperationResult]
+        #
+        def read(key, context, default_stage, payload = nil)
+          stage, tracker = @client.migration_variation(key, context, default_stage)
+          tracker.operation(LaunchDarkly::Migrations::OP_READ)
+
+          old = Executor.new(@client.logger, LaunchDarkly::Migrations::ORIGIN_OLD, @read_config.old, tracker, @measure_latency, @measure_errors, payload)
+          new = Executor.new(@client.logger, LaunchDarkly::Migrations::ORIGIN_NEW, @read_config.new, tracker, @measure_latency, @measure_errors, payload)
+
+          case stage
+          when LaunchDarkly::Migrations::STAGE_OFF
+            result = old.run
+          when LaunchDarkly::Migrations::STAGE_DUALWRITE
+            result = old.run
+          when LaunchDarkly::Migrations::STAGE_SHADOW
+            result = read_both(old, new, @read_config.comparison, @read_execution_order, tracker)
+          when LaunchDarkly::Migrations::STAGE_LIVE
+            result = read_both(new, old, @read_config.comparison, @read_execution_order, tracker)
+          when LaunchDarkly::Migrations::STAGE_RAMPDOWN
+            result = new.run
+          when LaunchDarkly::Migrations::STAGE_COMPLETE
+            result = new.run
+          else
+            result = LaunchDarkly::Migrations::OperationResult.new(
+              LaunchDarkly::Migrations::ORIGIN_OLD,
+              LaunchDarkly::Result.fail("invalid stage #{stage}; cannot execute read")
+            )
+          end
+
+          @client.track_migration_op(tracker)
+
+          result
+        end
+
+        #
+        # Perform the configured write operations against the appropriate old and/or new origins.
+        #
+        # @param key [String] The migration-based flag key to use for determining migration stages
+        # @param context [LaunchDarkly::LDContext] The context to use for evaluating the migration flag
+        # @param default_stage [Symbol] The stage to fallback to if one could not be determined for the requested flag
+        # @param payload [String] An optional payload to pass through to the configured write operations.
+        #
+        # @return [LaunchDarkly::Migrations::WriteResult]
+        #
+        def write(key, context, default_stage, payload = nil)
+          stage, tracker = @client.migration_variation(key, context, default_stage)
+          tracker.operation(LaunchDarkly::Migrations::OP_WRITE)
+
+          old = Executor.new(@client.logger, LaunchDarkly::Migrations::ORIGIN_OLD, @write_config.old, tracker, @measure_latency, @measure_errors, payload)
+          new = Executor.new(@client.logger, LaunchDarkly::Migrations::ORIGIN_NEW, @write_config.new, tracker, @measure_latency, @measure_errors, payload)
+
+          case stage
+          when LaunchDarkly::Migrations::STAGE_OFF
+            result = old.run()
+            write_result = LaunchDarkly::Migrations::WriteResult.new(result)
+          when LaunchDarkly::Migrations::STAGE_DUALWRITE
+            authoritative_result, nonauthoritative_result = write_both(old, new, tracker)
+            write_result = LaunchDarkly::Migrations::WriteResult.new(authoritative_result, nonauthoritative_result)
+          when LaunchDarkly::Migrations::STAGE_SHADOW
+            authoritative_result, nonauthoritative_result = write_both(old, new, tracker)
+            write_result = LaunchDarkly::Migrations::WriteResult.new(authoritative_result, nonauthoritative_result)
+          when LaunchDarkly::Migrations::STAGE_LIVE
+            authoritative_result, nonauthoritative_result = write_both(new, old, tracker)
+            write_result = LaunchDarkly::Migrations::WriteResult.new(authoritative_result, nonauthoritative_result)
+          when LaunchDarkly::Migrations::STAGE_RAMPDOWN
+            authoritative_result, nonauthoritative_result = write_both(new, old, tracker)
+            write_result = LaunchDarkly::Migrations::WriteResult.new(authoritative_result, nonauthoritative_result)
+          when LaunchDarkly::Migrations::STAGE_COMPLETE
+            result = new.run()
+            write_result = LaunchDarkly::Migrations::WriteResult.new(result)
+          else
+            result = LaunchDarkly::Migrations::OperationResult.fail(
+              LaunchDarkly::Migrations::ORIGIN_OLD,
+              LaunchDarkly::Result.fail("invalid stage #{stage}; cannot execute write")
+            )
+            write_result = LaunchDarkly::Migrations::WriteResult.new(result)
+          end
+
+          @client.track_migration_op(tracker)
+
+          write_result
+        end
+
+        #
+        # Execute both read methods in accordance with the requested execution order.
+        #
+        # This method always returns the {LaunchDarkly::Migrations::OperationResult} from running the authoritative read operation. The
+        # non-authoritative executor may fail but it will not affect the return value.
+        #
+        # @param authoritative [Executor]
+        # @param nonauthoritative [Executor]
+        # @param comparison [#call]
+        # @param execution_order [Symbol]
+        # @param tracker [LaunchDarkly::Interfaces::Migrations::OpTracker]
+        #
+        # @return [LaunchDarkly::Migrations::OperationResult]
+        #
+        private def read_both(authoritative, nonauthoritative, comparison, execution_order, tracker)
+          authoritative_result = nil
+          nonauthoritative_result = nil
+
+          case execution_order
+          when LaunchDarkly::Migrations::MigratorBuilder::EXECUTION_PARALLEL
+            auth_handler = Thread.new { authoritative_result = authoritative.run }
+            nonauth_handler = Thread.new { nonauthoritative_result = nonauthoritative.run }
+
+            auth_handler.join()
+            nonauth_handler.join()
+          when LaunchDarkly::Migrations::MigratorBuilder::EXECUTION_RANDOM && @sampler.sample(2)
+            nonauthoritative_result = nonauthoritative.run
+            authoritative_result = authoritative.run
+          else
+            authoritative_result = authoritative.run
+            nonauthoritative_result = nonauthoritative.run
+          end
+
+          return authoritative_result if comparison.nil?
+
+          if authoritative_result.success? && nonauthoritative_result.success?
+            tracker.consistent(->{ comparison.call(authoritative_result.value, nonauthoritative_result.value) })
+          end
+
+          authoritative_result
+        end
+
+        #
+        # Execute both operations sequentially.
+        #
+        # If the authoritative executor fails, do not run the non-authoritative one. As a result, this method will
+        # always return an authoritative {LaunchDarkly::Migrations::OperationResult} as the first value, and optionally the non-authoritative
+        # {LaunchDarkly::Migrations::OperationResult} as the second value.
+        #
+        # @param authoritative [Executor]
+        # @param nonauthoritative [Executor]
+        # @param tracker [LaunchDarkly::Interfaces::Migrations::OpTracker]
+        #
+        # @return [Array<LaunchDarkly::Migrations::OperationResult, [LaunchDarkly::Migrations::OperationResult, nil]>]
+        #
+        private def write_both(authoritative, nonauthoritative, tracker)
+          authoritative_result = authoritative.run()
+          tracker.invoked(authoritative.origin)
+
+          return authoritative_result, nil unless authoritative_result.success?
+
+          nonauthoritative_result = nonauthoritative.run()
+          tracker.invoked(nonauthoritative.origin)
+
+          [authoritative_result, nonauthoritative_result]
+        end
+      end
+
+      #
+      # Utility class for executing migration operations while also tracking our built-in migration measurements.
+      #
+      class Executor
+        #
+        # @return [Symbol]
+        #
+        attr_reader :origin
+
+        #
+        # @param origin [Symbol]
+        # @param fn [#call]
+        # @param tracker [LaunchDarkly::Interfaces::Migrations::OpTracker]
+        # @param measure_latency [Boolean]
+        # @param measure_errors [Boolean]
+        # @param payload [Object, nil]
+        #
+        def initialize(logger, origin, fn, tracker, measure_latency, measure_errors, payload)
+          @logger = logger
+          @origin = origin
+          @fn = fn
+          @tracker = tracker
+          @measure_latency = measure_latency
+          @measure_errors = measure_errors
+          @payload = payload
+        end
+
+        #
+        # Execute the configured operation and track any available measurements.
+        #
+        # @return [LaunchDarkly::Migrations::OperationResult]
+        #
+        def run()
+          start = Time.now
+
+          begin
+            result = @fn.call(@payload)
+          rescue => e
+            LaunchDarkly::Util.log_exception(@logger, "Unexpected error running method for '#{origin}' origin", e)
+            result = LaunchDarkly::Result.fail("'#{origin}' operation raised an exception", e)
+          end
+
+          @tracker.latency(@origin, (Time.now - start) * 1_000) if @measure_latency
+          @tracker.error(@origin) if @measure_errors && !result.success?
+          @tracker.invoked(@origin)
+
+          LaunchDarkly::Migrations::OperationResult.new(@origin, result)
+        end
+      end
+    end
+  end
+end

data/lib/ldclient-rb/impl/migrations/tracker.rb

@@ -0,0 +1,136 @@
+require "set"
+require "ldclient-rb/impl/sampler"
+require "logger"
+
+module LaunchDarkly
+  module Impl
+    module Migrations
+      class OpTracker
+        include LaunchDarkly::Interfaces::Migrations::OpTracker
+
+        #
+        # @param logger [Logger] logger
+        # @param key [string] key
+        # @param flag [LaunchDarkly::Impl::Model::FeatureFlag] flag
+        # @param context [LaunchDarkly::LDContext] context
+        # @param detail [LaunchDarkly::EvaluationDetail] detail
+        # @param default_stage [Symbol] default_stage
+        #
+        def initialize(logger, key, flag, context, detail, default_stage)
+          @logger = logger
+          @key = key
+          @flag = flag
+          @context = context
+          @detail = detail
+          @default_stage = default_stage
+          @sampler = LaunchDarkly::Impl::Sampler.new(Random.new)
+
+          @mutex = Mutex.new
+
+          # @type [Symbol, nil]
+          @operation = nil
+
+          # @type [Set<Symbol>]
+          @invoked = Set.new
+          # @type [Boolean, nil]
+          @consistent = nil
+
+          # @type [Int]
+          @consistent_ratio = @flag&.migration_settings&.check_ratio
+          @consistent_ratio = 1 if @consistent_ratio.nil?
+
+          # @type [Set<Symbol>]
+          @errors = Set.new
+          # @type [Hash<Symbol, Float>]
+          @latencies = Hash.new
+        end
+
+        def operation(operation)
+          return unless LaunchDarkly::Migrations::VALID_OPERATIONS.include? operation
+
+          @mutex.synchronize do
+            @operation = operation
+          end
+        end
+
+        def invoked(origin)
+          return unless LaunchDarkly::Migrations::VALID_ORIGINS.include? origin
+
+          @mutex.synchronize do
+            @invoked.add(origin)
+          end
+        end
+
+        def consistent(is_consistent)
+          @mutex.synchronize do
+            if @sampler.sample(@consistent_ratio)
+              begin
+                @consistent = is_consistent.call
+              rescue => e
+                LaunchDarkly::Util.log_exception(@logger, "Exception raised during consistency check; failed to record measurement", e)
+              end
+            end
+          end
+        end
+
+        def error(origin)
+          return unless LaunchDarkly::Migrations::VALID_ORIGINS.include? origin
+
+          @mutex.synchronize do
+            @errors.add(origin)
+          end
+        end
+
+        def latency(origin, duration)
+          return unless LaunchDarkly::Migrations::VALID_ORIGINS.include? origin
+          return unless duration.is_a? Numeric
+          return if duration < 0
+
+          @mutex.synchronize do
+            @latencies[origin] = duration
+          end
+        end
+
+        def build
+          @mutex.synchronize do
+            return "operation cannot contain an empty key" if @key.empty?
+            return "operation not provided" if @operation.nil?
+            return "no origins were invoked" if @invoked.empty?
+            return "provided context was invalid" unless @context.valid?
+
+            result = check_invoked_consistency
+            return result unless result == true
+
+            LaunchDarkly::Impl::MigrationOpEvent.new(
+              LaunchDarkly::Impl::Util.current_time_millis,
+              @context,
+              @key,
+              @flag,
+              @operation,
+              @default_stage,
+              @detail,
+              @invoked,
+              @consistent,
+              @consistent_ratio,
+              @errors,
+              @latencies
+            )
+          end
+        end
+
+        private def check_invoked_consistency
+          LaunchDarkly::Migrations::VALID_ORIGINS.each do |origin|
+            next if @invoked.include? origin
+
+            return "provided latency for origin '#{origin}' without recording invocation" if @latencies.include? origin
+            return "provided error for origin '#{origin}' without recording invocation" if @errors.include? origin
+          end
+
+          return "provided consistency without recording both invocations" if !@consistent.nil? && @invoked.size != 2
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/ldclient-rb/impl/model/feature_flag.rb

@@ -26,6 +26,10 @@ module LaunchDarkly
           @version = data[:version]
           @deleted = !!data[:deleted]
           return if @deleted
+          migration_settings = data[:migration] || {}
+          @migration_settings = MigrationSettings.new(migration_settings[:checkRatio])
+          @sampling_ratio = data[:samplingRatio]
+          @exclude_from_summaries = !!data[:excludeFromSummaries]
           @variations = data[:variations] || []
           @on = !!data[:on]
           fallthrough = data[:fallthrough] || {}
@@ -33,7 +37,7 @@ module LaunchDarkly
           @off_variation = data[:offVariation]
           check_variation_range(self, errors, @off_variation, "off variation")
           @prerequisites = (data[:prerequisites] || []).map do |prereq_data|
-            Prerequisite.new(prereq_data, self, errors)
+            Prerequisite.new(prereq_data, self)
           end
           @targets = (data[:targets] || []).map do |target_data|
             Target.new(target_data, self, errors)
@@ -63,6 +67,12 @@ module LaunchDarkly
         attr_reader :version
         # @return [Boolean]
         attr_reader :deleted
+        # @return [MigrationSettings, nil]
+        attr_reader :migration_settings
+        # @return [Integer, nil]
+        attr_reader :sampling_ratio
+        # @return [Boolean, nil]
+        attr_reader :exclude_from_summaries
         # @return [Array]
         attr_reader :variations
         # @return [Boolean]
@@ -108,13 +118,12 @@ module LaunchDarkly
       end
 
       class Prerequisite
-        def initialize(data, flag, errors_out = nil)
+        def initialize(data, flag)
           @data = data
           @key = data[:key]
           @variation = data[:variation]
           @failure_result = EvaluatorHelpers.evaluation_detail_for_off_variation(flag,
             EvaluationReason::prerequisite_failed(@key))
-          check_variation_range(flag, errors_out, @variation, "prerequisite")
         end
 
         # @return [Hash]
@@ -173,6 +182,19 @@ module LaunchDarkly
         attr_reader :variation_or_rollout
       end
 
+
+      class MigrationSettings
+        #
+        # @param check_ratio [Int, nil]
+        #
+        def initialize(check_ratio)
+          @check_ratio = check_ratio
+        end
+
+        # @return [Integer, nil]
+        attr_reader :check_ratio
+      end
+
       class VariationOrRollout
         def initialize(variation, rollout_data, flag = nil, errors_out = nil, description = nil)
           @variation = variation

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

@@ -16,9 +16,8 @@ module LaunchDarkly
 
       def start
         @worker = Thread.new do
-          if @start_delay
-            sleep(@start_delay)
-          end
+          sleep(@start_delay) unless @start_delay.nil? || @start_delay == 0
+
           until @stopped.value do
             started_at = Time.now
             begin