launchdarkly-server-sdk 7.0.4 → 7.2.0

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

@@ -1,3 +1,4 @@
+require "concurrent"
 require "ldclient-rb/interfaces"
 require "ldclient-rb/impl/store_data_set_sorter"
 
@@ -5,34 +6,45 @@ module LaunchDarkly
   module Impl
     #
     # Provides additional behavior that the client requires before or after feature store operations.
-    # Currently this just means sorting the data set for init(). In the future we may also use this
-    # to provide an update listener capability.
+    # This just means sorting the data set for init() and dealing with data store status listeners.
     #
     class FeatureStoreClientWrapper
       include Interfaces::FeatureStore
 
-      def initialize(store)
+      def initialize(store, store_update_sink, logger)
+        # @type [LaunchDarkly::Interfaces::FeatureStore]
         @store = store
+
+        @monitoring_enabled = does_store_support_monitoring?
+
+        # @type [LaunchDarkly::Impl::DataStore::UpdateSink]
+        @store_update_sink = store_update_sink
+        @logger = logger
+
+        @mutex = Mutex.new # Covers the following variables
+        @last_available = true
+        # @type [LaunchDarkly::Impl::RepeatingTask, nil]
+        @poller = nil
       end
 
       def init(all_data)
-        @store.init(FeatureStoreDataSetSorter.sort_all_collections(all_data))
+        wrapper { @store.init(FeatureStoreDataSetSorter.sort_all_collections(all_data)) }
       end
 
       def get(kind, key)
-        @store.get(kind, key)
+        wrapper { @store.get(kind, key) }
       end
 
       def all(kind)
-        @store.all(kind)
+        wrapper { @store.all(kind) }
       end
 
       def upsert(kind, item)
-        @store.upsert(kind, item)
+        wrapper { @store.upsert(kind, item) }
       end
 
       def delete(kind, key, version)
-        @store.delete(kind, key, version)
+        wrapper { @store.delete(kind, key, version) }
       end
 
       def initialized?
@@ -41,6 +53,88 @@ module LaunchDarkly
 
       def stop
         @store.stop
+        @mutex.synchronize do
+          return if @poller.nil?
+
+          @poller.stop
+          @poller = nil
+        end
+      end
+
+      def monitoring_enabled?
+        @monitoring_enabled
+      end
+
+      private def wrapper()
+        begin
+          yield
+        rescue => e
+          update_availability(false) if @monitoring_enabled
+          raise
+        end
+      end
+
+      private def update_availability(available)
+        @mutex.synchronize do
+          return if available == @last_available
+          @last_available = available
+        end
+
+        status = LaunchDarkly::Interfaces::DataStore::Status.new(available, false)
+
+        @logger.warn("Persistent store is available again") if available
+
+        @store_update_sink.update_status(status)
+
+        if available
+          @mutex.synchronize do
+            return if @poller.nil?
+
+            @poller.stop
+            @poller = nil
+          end
+
+          return
+        end
+
+        @logger.warn("Detected persistent store unavailability; updates will be cached until it recovers.")
+
+        task = Impl::RepeatingTask.new(0.5, 0, -> { self.check_availability }, @logger)
+
+        @mutex.synchronize do
+          @poller = task
+          @poller.start
+        end
+      end
+
+      private def check_availability
+        begin
+          update_availability(true) if @store.available?
+        rescue => e
+          @logger.error("Unexpected error from data store status function: #{e}")
+        end
+      end
+
+      # This methods determines whether the wrapped store can support enabling monitoring.
+      #
+      # The wrapped store must provide a monitoring_enabled method, which must
+      # be true. But this alone is not sufficient.
+      #
+      # Because this class wraps all interactions with a provided store, it can
+      # technically "monitor" any store. However, monitoring also requires that
+      # we notify listeners when the store is available again.
+      #
+      # We determine this by checking the store's `available?` method, so this
+      # is also a requirement for monitoring support.
+      #
+      # These extra checks won't be necessary once `available` becomes a part
+      # of the core interface requirements and this class no longer wraps every
+      # feature store.
+      private def does_store_support_monitoring?
+        return false unless @store.respond_to? :monitoring_enabled?
+        return false unless @store.respond_to? :available?
+
+        @store.monitoring_enabled?
       end
     end
   end

data/lib/ldclient-rb/in_memory_store.rb

@@ -23,6 +23,9 @@ module LaunchDarkly
     priority: 0,
   }.freeze
 
+  # @private
+  ALL_KINDS = [FEATURES, SEGMENTS].freeze
+
   #
   # Default implementation of the LaunchDarkly client's feature store, using an in-memory
   # cache.  This object holds feature flags and related data received from LaunchDarkly.
@@ -37,6 +40,10 @@ module LaunchDarkly
       @initialized = Concurrent::AtomicBoolean.new(false)
     end
 
+    def monitoring_enabled?
+      false
+    end
+
     def get(kind, key)
       @lock.with_read_lock do
         coll = @items[kind]

data/lib/ldclient-rb/integrations/file_data.rb

@@ -101,7 +101,7 @@ module LaunchDarkly
       #
       def self.data_source(options={})
         lambda { |sdk_key, config|
-          Impl::Integrations::FileDataSourceImpl.new(config.feature_store, config.logger, options) }
+          Impl::Integrations::FileDataSourceImpl.new(config.feature_store, config.data_source_update_sink, config.logger, options) }
       end
     end
   end

data/lib/ldclient-rb/integrations/util/store_wrapper.rb

@@ -43,6 +43,17 @@ module LaunchDarkly
           end
 
           @inited = Concurrent::AtomicBoolean.new(false)
+          @has_available_method = @core.respond_to? :available?
+        end
+
+        def monitoring_enabled?
+          @has_available_method
+        end
+
+        def available?
+          return false unless @has_available_method
+
+          @core.available?
         end
 
         def init(all_data)

data/lib/ldclient-rb/interfaces.rb

@@ -112,6 +112,269 @@ module LaunchDarkly
       #
       def stop
       end
+
+      #
+      # WARN: This isn't a required method on a FeatureStore yet. The SDK will
+      # currently check if the provided store responds to this method, and if
+      # it does, will take appropriate action based on the documented behavior
+      # below. This will become required in a future major version release of
+      # the SDK.
+      #
+      # Returns true if this data store implementation supports status
+      # monitoring.
+      #
+      # This is normally only true for persistent data stores but it could also
+      # be true for any custom {FeatureStore} implementation.
+      #
+      # Returning true means that the store guarantees that if it ever enters
+      # an invalid state (that is, an operation has failed or it knows that
+      # operations cannot succeed at the moment), it will publish a status
+      # update, and will then publish another status update once it has
+      # returned to a valid state.
+      #
+      # Custom implementations must implement `def available?` which
+      # synchronously checks if the store is available. Without this method,
+      # the SDK cannot ensure status updates will occur once the store has gone
+      # offline.
+      #
+      # The same value will be returned from
+      # {StatusProvider::monitoring_enabled?}.
+      #
+      # def monitoring_enabled? end
+
+      #
+      # WARN: This isn't a required method on a FeatureStore. The SDK will
+      # check if the provided store responds to this method, and if it does,
+      # will take appropriate action based on the documented behavior below.
+      # Usage of this method will be dropped in a future version of the SDK.
+      #
+      # Tests whether the data store seems to be functioning normally.
+      #
+      # This should not be a detailed test of different kinds of operations,
+      # but just the smallest possible operation to determine whether (for
+      # instance) we can reach the database.
+      #
+      # Whenever one of the store's other methods throws an exception, the SDK
+      # will assume that it may have become unavailable (e.g. the database
+      # connection was lost). The SDK will then call {#available?} at intervals
+      # until it returns true.
+      #
+      # @return [Boolean] true if the underlying data store is reachable
+      #
+      # def available? end
+    end
+
+    #
+    # An interface for tracking changes in feature flag configurations.
+    #
+    # An implementation of this interface is returned by {LaunchDarkly::LDClient#flag_tracker}.
+    # Application code never needs to implement this interface.
+    #
+    module FlagTracker
+      #
+      # Registers a listener to be notified of feature flag changes in general.
+      #
+      # The listener will be notified whenever the SDK receives any change to any feature flag's configuration,
+      # or to a user segment that is referenced by a feature flag. If the updated flag is used as a prerequisite
+      # for other flags, the SDK assumes that those flags may now behave differently and sends flag change events
+      # for them as well.
+      #
+      # Note that this does not necessarily mean the flag's value has changed for any particular evaluation
+      # context, only that some part of the flag configuration was changed so that it may return a
+      # different value than it previously returned for some context. If you want to track flag value changes,
+      # use {#add_flag_value_change_listener} instead.
+      #
+      # It is possible, given current design restrictions, that a listener might be notified when no change has
+      # occurred. This edge case will be addressed in a later version of the SDK. It is important to note this issue
+      # does not affect {#add_flag_value_change_listener} listeners.
+      #
+      # If using the file data source, any change in a data file will be treated as a change to every flag. Again,
+      # use {#add_flag_value_change_listener} (or just re-evaluate the flag # yourself) if you want to know whether
+      # this is a change that really affects a flag's value.
+      #
+      # Change events only work if the SDK is actually connecting to LaunchDarkly (or using the file data source).
+      # If the SDK is only reading flags from a database then it cannot know when there is a change, because
+      # flags are read on an as-needed basis.
+      #
+      # The listener will be called from a worker thread.
+      #
+      # Calling this method for an already-registered listener has no effect.
+      #
+      # @param listener [#update]
+      #
+      def add_listener(listener) end
+
+      #
+      # Unregisters a listener so that it will no longer be notified of feature flag changes.
+      #
+      # Calling this method for a listener that was not previously registered has no effect.
+      #
+      # @param listener [Object]
+      #
+      def remove_listener(listener) end
+
+      #
+      # Registers a listener to be notified of a change in a specific feature flag's value for a specific
+      # evaluation context.
+      #
+      # When you call this method, it first immediately evaluates the feature flag. It then uses
+      # {#add_listener} to start listening for feature flag configuration
+      # changes, and whenever the specified feature flag changes, it re-evaluates the flag for the same context.
+      # It then calls your listener if and only if the resulting value has changed.
+      #
+      # All feature flag evaluations require an instance of {LaunchDarkly::LDContext}. If the feature flag you are
+      # tracking does not have any context targeting rules, you must still pass a dummy context such as
+      # `LDContext.with_key("for-global-flags")`. If you do not want the user to appear on your dashboard,
+      # use the anonymous property: `LDContext.create({key: "for-global-flags", kind: "user", anonymous: true})`.
+      #
+      # The returned listener represents the subscription that was created by this method
+      # call; to unsubscribe, pass that object (not your listener) to {#remove_listener}.
+      #
+      # @param key [Symbol]
+      # @param context [LaunchDarkly::LDContext]
+      # @param listener [#update]
+      #
+      def add_flag_value_change_listener(key, context, listener) end
+    end
+
+    #
+    # Change event fired when some aspect of the flag referenced by the key has changed.
+    #
+    class FlagChange
+      attr_accessor :key
+
+      # @param [Symbol] key
+      def initialize(key)
+        @key = key
+      end
+    end
+
+    #
+    # Change event fired when the evaluated value for the specified flag key has changed.
+    #
+    class FlagValueChange
+      attr_accessor :key
+      attr_accessor :old_value
+      attr_accessor :new_value
+
+      # @param [Symbol] key
+      # @param [Object] old_value
+      # @param [Object] new_value
+      def initialize(key, old_value, new_value)
+        @key = key
+        @old_value = old_value
+        @new_value = new_value
+      end
+    end
+
+    module DataStore
+      #
+      # An interface for querying the status of a persistent data store.
+      #
+      # An implementation of this interface is returned by {LaunchDarkly::LDClient#data_store_status_provider}.
+      # Application code should not implement this interface.
+      #
+      module StatusProvider
+        #
+        # Returns the current status of the store.
+        #
+        # This is only meaningful for persistent stores, or any custom data store implementation that makes use of
+        # the status reporting mechanism provided by the SDK. For the default in-memory store, the status will always
+        # be reported as "available".
+        #
+        # @return [Status] the latest status
+        #
+        def status
+        end
+
+        #
+        # Indicates whether the current data store implementation supports status monitoring.
+        #
+        # This is normally true for all persistent data stores, and false for the default in-memory store. A true value
+        # means that any listeners added with {#add_listener} can expect to be notified if there is any error in
+        # storing data, and then notified again when the error condition is resolved. A false value means that the
+        # status is not meaningful and listeners should not expect to be notified.
+        #
+        # @return [Boolean] true if status monitoring is enabled
+        #
+        def monitoring_enabled?
+        end
+
+        #
+        # Subscribes for notifications of status changes.
+        #
+        # Applications may wish to know if there is an outage in a persistent data store, since that could mean that
+        # flag evaluations are unable to get the flag data from the store (unless it is currently cached) and therefore
+        # might return default values.
+        #
+        # If the SDK receives an exception while trying to query or update the data store, then it notifies listeners
+        # that the store appears to be offline ({Status#available} is false) and begins polling the store
+        # at intervals until a query succeeds. Once it succeeds, it notifies listeners again with {Status#available}
+        # set to true.
+        #
+        # This method has no effect if the data store implementation does not support status tracking, such as if you
+        # are using the default in-memory store rather than a persistent store.
+        #
+        # @param listener [#update] the listener to add
+        #
+        def add_listener(listener)
+        end
+
+        #
+        # Unsubscribes from notifications of status changes.
+        #
+        # This method has no effect if the data store implementation does not support status tracking, such as if you
+        # are using the default in-memory store rather than a persistent store.
+        #
+        # @param listener [Object] the listener to remove; if no such listener was added, this does nothing
+        #
+        def remove_listener(listener)
+        end
+      end
+
+      #
+      # Interface that a data store implementation can use to report information back to the SDK.
+      #
+      module UpdateSink
+        #
+        # Reports a change in the data store's operational status.
+        #
+        # This is what makes the status monitoring mechanisms in {StatusProvider} work.
+        #
+        # @param status [Status] the updated status properties
+        #
+        def update_status(status)
+        end
+      end
+
+      class Status
+        def initialize(available, stale)
+          @available = available
+          @stale = stale
+        end
+
+        #
+        # Returns true if the SDK believes the data store is now available.
+        #
+        # This property is normally true. If the SDK receives an exception while trying to query or update the data
+        # store, then it sets this property to false (notifying listeners, if any) and polls the store at intervals
+        # until a query succeeds. Once it succeeds, it sets the property back to true (again notifying listeners).
+        #
+        # @return [Boolean] true if store is available
+        #
+        attr_reader :available
+
+        #
+        # Returns true if the store may be out of date due to a previous
+        # outage, so the SDK should attempt to refresh all feature flag data
+        # and rewrite it to the store.
+        #
+        # This property is not meaningful to application code.
+        #
+        # @return [Boolean] true if data should be rewritten
+        #
+        attr_reader :stale
+      end
     end
 
     #
@@ -299,5 +562,231 @@ module LaunchDarkly
       def status
       end
     end
+
+    module DataSource
+      #
+      # An interface for querying the status of the SDK's data source. The data
+      # source is the component that receives updates to feature flag data;
+      # normally this is a streaming connection, but it could be polling or
+      # file data depending on your configuration.
+      #
+      # An implementation of this interface is returned by
+      # {LaunchDarkly::LDClient#data_source_status_provider}. Application code
+      # never needs to implement this interface.
+      #
+      module StatusProvider
+        #
+        # Returns the current status of the data source.
+        #
+        # All of the built-in data source implementations are guaranteed to update this status whenever they
+        # successfully initialize, encounter an error, or recover after an error.
+        #
+        # For a custom data source implementation, it is the responsibility of the data source to push
+        # status updates to the SDK; if it does not do so, the status will always be reported as
+        # {Status::INITIALIZING}.
+        #
+        # @return [Status]
+        #
+        def status
+        end
+
+        #
+        # Subscribes for notifications of status changes.
+        #
+        # The listener will be notified whenever any property of the status has changed. See {Status} for an
+        # explanation of the meaning of each property and what could cause it to change.
+        #
+        # Notifications will be dispatched on a worker thread. It is the listener's responsibility to return as soon as
+        # possible so as not to block subsequent notifications.
+        #
+        # @param [#update] the listener to add
+        #
+        def add_listener(listener) end
+
+        #
+        # Unsubscribes from notifications of status changes.
+        #
+        def remove_listener(listener) end
+      end
+
+      #
+      # Interface that a data source implementation will use to push data into
+      # the SDK.
+      #
+      # The data source interacts with this object, rather than manipulating
+      # the data store directly, so that the SDK can perform any other
+      # necessary operations that must happen when data is updated.
+      #
+      module UpdateSink
+        #
+        # Initializes (or re-initializes) the store with the specified set of entities. Any
+        # existing entries will be removed. Implementations can assume that this data set is up to
+        # date-- there is no need to perform individual version comparisons between the existing
+        # objects and the supplied features.
+        #
+        # If possible, the store should update the entire data set atomically. If that is not possible,
+        # it should iterate through the outer hash and then the inner hash using the existing iteration
+        # order of those hashes (the SDK will ensure that the items were inserted into the hashes in
+        # the correct order), storing each item, and then delete any leftover items at the very end.
+        #
+        # @param all_data [Hash]  a hash where each key is one of the data kind objects, and each
+        #   value is in turn a hash of string keys to entities
+        # @return [void]
+        #
+        def init(all_data) end
+
+        #
+        # Attempt to add an entity, or update an existing entity with the same key. An update
+        # should only succeed if the new item's `:version` is greater than the old one;
+        # otherwise, the method should do nothing.
+        #
+        # @param kind [Object]  the kind of entity to add or update
+        # @param item [Hash]  the entity to add or update
+        # @return [void]
+        #
+        def upsert(kind, item) end
+
+        #
+        # Attempt to delete an entity if it exists. Deletion should only succeed if the
+        # `version` parameter is greater than the existing entity's `:version`; otherwise, the
+        # method should do nothing.
+        #
+        # @param kind [Object]  the kind of entity to delete
+        # @param key [String]  the unique key of the entity
+        # @param version [Integer]  the entity must have a lower version than this to be deleted
+        # @return [void]
+        #
+        def delete(kind, key, version) end
+
+        #
+        # Informs the SDK of a change in the data source's status.
+        #
+        # Data source implementations should use this method if they have any
+        # concept of being in a valid state, a temporarily disconnected state,
+        # or a permanently stopped state.
+        #
+        # If `new_state` is different from the previous state, and/or
+        # `new_error` is non-null, the SDK will start returning the new status
+        # (adding a timestamp for the change) from {StatusProvider#status}, and
+        # will trigger status change events to any registered listeners.
+        #
+        # A special case is that if {new_state} is {Status::INTERRUPTED}, but the
+        # previous state was {Status::INITIALIZING}, the state will remain at
+        # {Status::INITIALIZING} because {Status::INTERRUPTED} is only meaningful
+        # after a successful startup.
+        #
+        # @param new_state [Symbol]
+        # @param new_error [ErrorInfo, nil]
+        #
+        def update_status(new_state, new_error) end
+      end
+
+      #
+      # Information about the data source's status and about the last status change.
+      #
+      class Status
+        #
+        # The initial state of the data source when the SDK is being initialized.
+        #
+        # If it encounters an error that requires it to retry initialization, the state will remain at
+        # {INITIALIZING} until it either succeeds and becomes {VALID}, or permanently fails and
+        # becomes {OFF}.
+        #
+
+        INITIALIZING = :initializing
+
+        #
+        # Indicates that the data source is currently operational and has not had any problems since the
+        # last time it received data.
+        #
+        # In streaming mode, this means that there is currently an open stream connection and that at least
+        # one initial message has been received on the stream. In polling mode, it means that the last poll
+        # request succeeded.
+        #
+        VALID = :valid
+
+        #
+        # Indicates that the data source encountered an error that it will attempt to recover from.
+        #
+        # In streaming mode, this means that the stream connection failed, or had to be dropped due to some
+        # other error, and will be retried after a backoff delay. In polling mode, it means that the last poll
+        # request failed, and a new poll request will be made after the configured polling interval.
+        #
+        INTERRUPTED = :interrupted
+
+        #
+        # Indicates that the data source has been permanently shut down.
+        #
+        # This could be because it encountered an unrecoverable error (for instance, the LaunchDarkly service
+        # rejected the SDK key; an invalid SDK key will never become valid), or because the SDK client was
+        # explicitly shut down.
+        #
+        OFF = :off
+
+        # @return [Symbol] The basic state
+        attr_reader :state
+        # @return [Time] timestamp of the last state transition
+        attr_reader :state_since
+        # @return [ErrorInfo, nil] a description of the last error or nil if no errors have occurred since startup
+        attr_reader :last_error
+
+        def initialize(state, state_since, last_error)
+          @state = state
+          @state_since = state_since
+          @last_error = last_error
+        end
+      end
+
+      #
+      # A description of an error condition that the data source encountered.
+      #
+      class ErrorInfo
+        #
+        # An unexpected error, such as an uncaught exception, further described by {#message}.
+        #
+        UNKNOWN = :unknown
+
+        #
+        # An I/O error such as a dropped connection.
+        #
+        NETWORK_ERROR = :network_error
+
+        #
+        # The LaunchDarkly service returned an HTTP response with an error status, available with
+        # {#status_code}.
+        #
+        ERROR_RESPONSE = :error_response
+
+        #
+        # The SDK received malformed data from the LaunchDarkly service.
+        #
+        INVALID_DATA = :invalid_data
+
+        #
+        # The data source itself is working, but when it tried to put an update into the data store, the data
+        # store failed (so the SDK may not have the latest data).
+        #
+        # Data source implementations do not need to report this kind of error; it will be automatically
+        # reported by the SDK when exceptions are detected.
+        #
+        STORE_ERROR = :store_error
+
+        # @return [Symbol] the general category of the error
+        attr_reader :kind
+        # @return [Integer] an HTTP status or zero
+        attr_reader :status_code
+        # @return [String, nil] message an error message if applicable, or nil
+        attr_reader :message
+        # @return [Time] time the error timestamp
+        attr_reader :time
+
+        def initialize(kind, status_code, message, time)
+          @kind = kind
+          @status_code = status_code
+          @message = message
+          @time = time
+        end
+      end
+    end
   end
 end