launchdarkly-server-sdk 8.10.2 → 8.11.0

data/lib/ldclient-rb/interfaces/feature_store.rb

@@ -0,0 +1,162 @@
+module LaunchDarkly
+  module Interfaces
+    #
+    # Mixin that defines the required methods of a feature store implementation. The LaunchDarkly
+    # client uses the feature store to persist feature flags and related objects received from
+    # the LaunchDarkly service. Implementations must support concurrent access and updates.
+    # For more about how feature stores can be used, see:
+    # [Using a persistent feature store](https://docs.launchdarkly.com/sdk/features/storing-data#ruby).
+    #
+    # An entity that can be stored in a feature store is a hash that can be converted to and from
+    # JSON, and that has at a minimum the following properties: `:key`, a string that is unique
+    # among entities of the same kind; `:version`, an integer that is higher for newer data;
+    # `:deleted`, a boolean (optional, defaults to false) that if true means this is a
+    # placeholder for a deleted entity.
+    #
+    # To represent the different kinds of objects that can be stored, such as feature flags and
+    # segments, the SDK will provide a "kind" object; this is a hash with a single property,
+    # `:namespace`, which is a short string unique to that kind. This string can be used as a
+    # collection name or a key prefix.
+    #
+    # The default implementation is {LaunchDarkly::InMemoryFeatureStore}. Several implementations
+    # that use databases can be found in {LaunchDarkly::Integrations}. If you want to write a new
+    # implementation, see {LaunchDarkly::Integrations::Util} for tools that can make this task
+    # simpler.
+    #
+    module FeatureStore
+      #
+      # 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
+
+      #
+      # Returns the entity to which the specified key is mapped, if any.
+      #
+      # @param kind [Object]  the kind of entity to get
+      # @param key [String]  the unique key of the entity to get
+      # @return [Hash]  the entity; nil if the key was not found, or if the stored entity's
+      #   `:deleted` property was true
+      #
+      def get(kind, key)
+      end
+
+      #
+      # Returns all stored entities of the specified kind, not including deleted entities.
+      #
+      # @param kind [Object]  the kind of entity to get
+      # @return [Hash]  a hash where each key is the entity's `:key` property and each value
+      #   is the entity
+      #
+      def all(kind)
+      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
+
+      #
+      # Checks whether this store has been initialized. That means that `init` has been called
+      # either by this process, or (if the store can be shared) by another process. This
+      # method will be called frequently, so it should be efficient. You can assume that if it
+      # has returned true once, it can continue to return true, i.e. a store cannot become
+      # uninitialized again.
+      #
+      # @return [Boolean]  true if the store is in an initialized state
+      #
+      def initialized?
+      end
+
+      #
+      # Performs any necessary cleanup to shut down the store when the client is being shut down.
+      #
+      # @return [void]
+      #
+      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
+  end
+end

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

@@ -0,0 +1,106 @@
+module LaunchDarkly
+  module Interfaces
+    #
+    # 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
+  end
+end

data/lib/ldclient-rb/interfaces/hooks.rb

@@ -0,0 +1,88 @@
+module LaunchDarkly
+  module Interfaces
+    module Hooks
+      #
+      # Mixin for extending SDK functionality via hooks.
+      #
+      # All provided hook implementations **MUST** include this mixin. Hooks without this mixin will be ignored.
+      #
+      # This mixin includes default implementations for all hook handlers. This allows LaunchDarkly to expand the list
+      # of hook handlers without breaking customer integrations.
+      #
+      module Hook
+        #
+        # Get metadata about the hook implementation.
+        #
+        # @return [Metadata]
+        #
+        def metadata
+          Metadata.new('UNDEFINED')
+        end
+
+        #
+        # The before method is called during the execution of a variation method before the flag value has been
+        # determined. The method is executed synchronously.
+        #
+        # @param evaluation_series_context [EvaluationSeriesContext] Contains information about the evaluation being
+        # performed. This is not mutable.
+        # @param data [Hash] A record associated with each stage of hook invocations. Each stage is called with the data
+        # of the previous stage for a series. The input record should not be modified.
+        # @return [Hash] Data to use when executing the next state of the hook in the evaluation series.
+        #
+        def before_evaluation(evaluation_series_context, data)
+          data
+        end
+
+        #
+        # The after method is called during the execution of the variation method after the flag value has been
+        # determined. The method is executed synchronously.
+        #
+        # @param evaluation_series_context [EvaluationSeriesContext] Contains read-only information about the evaluation
+        # being performed.
+        # @param data [Hash] A record associated with each stage of hook invocations. Each stage is called with the data
+        # of the previous stage for a series.
+        # @param detail [LaunchDarkly::EvaluationDetail] The result of the evaluation. This value should not be
+        # modified.
+        # @return [Hash] Data to use when executing the next state of the hook in the evaluation series.
+        #
+        def after_evaluation(evaluation_series_context, data, detail)
+          data
+        end
+      end
+
+      #
+      # Metadata data class used for annotating hook implementations.
+      #
+      class Metadata
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
+      end
+
+      #
+      # Contextual information that will be provided to handlers during evaluation series.
+      #
+      class EvaluationSeriesContext
+        attr_reader :key
+        attr_reader :context
+        attr_reader :default_value
+        attr_reader :method
+
+        #
+        # @param key [String]
+        # @param context [LaunchDarkly::LDContext]
+        # @param default_value [any]
+        # @param method [Symbol]
+        #
+        def initialize(key, context, default_value, method)
+          @key = key
+          @context = context
+          @default_value = default_value
+          @method = method
+        end
+      end
+    end
+  end
+end

data/lib/ldclient-rb/interfaces/migrations.rb

@@ -0,0 +1,100 @@
+module LaunchDarkly
+  module Interfaces
+    #
+    # Namespace for feature-flag based technology migration support.
+    #
+    module Migrations
+      #
+      # A migrator is the interface through which migration support is executed. A migrator is configured through the
+      # {LaunchDarkly::Migrations::MigratorBuilder} class.
+      #
+      module Migrator
+        #
+        # Uses the provided flag key and context to execute a migration-backed read operation.
+        #
+        # @param key [String]
+        # @param context [LaunchDarkly::LDContext]
+        # @param default_stage [Symbol]
+        # @param payload [Object, nil]
+        #
+        # @return [LaunchDarkly::Migrations::OperationResult]
+        #
+        def read(key, context, default_stage, payload = nil) end
+
+        #
+        # Uses the provided flag key and context to execute a migration-backed write operation.
+        #
+        # @param key [String]
+        # @param context [LaunchDarkly::LDContext]
+        # @param default_stage [Symbol]
+        # @param payload [Object, nil]
+        #
+        # @return [LaunchDarkly::Migrations::WriteResult]
+        #
+        def write(key, context, default_stage, payload = nil) end
+      end
+
+      #
+      # An OpTracker is responsible for managing the collection of measurements that which a user might wish to record
+      # throughout a migration-assisted operation.
+      #
+      # Example measurements include latency, errors, and consistency.
+      #
+      # This data can be provided to the {LaunchDarkly::LDClient.track_migration_op} method to relay this metric
+      # information upstream to LaunchDarkly services.
+      #
+      module OpTracker
+        #
+        # Sets the migration related operation associated with these tracking measurements.
+        #
+        # @param [Symbol] op The read or write operation symbol.
+        #
+        def operation(op) end
+
+        #
+        # Allows recording which origins were called during a migration.
+        #
+        # @param [Symbol] origin Designation for the old or new origin.
+        #
+        def invoked(origin) end
+
+        #
+        # Allows recording the results of a consistency check.
+        #
+        # This method accepts a callable which should take no parameters and return a single boolean to represent the
+        # consistency check results for a read operation.
+        #
+        # A callable is provided in case sampling rules do not require consistency checking to run. In this case, we can
+        # avoid the overhead of a function by not using the callable.
+        #
+        # @param [#call] is_consistent closure to return result of comparison check
+        #
+        def consistent(is_consistent) end
+
+        #
+        # Allows recording whether an error occurred during the operation.
+        #
+        # @param [Symbol] origin Designation for the old or new origin.
+        #
+        def error(origin) end
+
+        #
+        # Allows tracking the recorded latency for an individual operation.
+        #
+        # @param [Symbol] origin Designation for the old or new origin.
+        # @param [Float] duration Duration measurement in milliseconds (ms).
+        #
+        def latency(origin, duration) end
+
+        #
+        # Creates an instance of {LaunchDarkly::Impl::MigrationOpEventData}.
+        #
+        # @return [LaunchDarkly::Impl::MigrationOpEvent, String] A migration op event or a string describing the error.
+        # failure.
+        #
+        def build
+        end
+      end
+    end
+  end
+end

data/lib/ldclient-rb/interfaces/plugins.rb

@@ -0,0 +1,136 @@
+module LaunchDarkly
+  module Interfaces
+    module Plugins
+      #
+      # Metadata about the SDK.
+      #
+      class SdkMetadata
+        # The id of the SDK (e.g., "ruby-server-sdk")
+        # @return [String]
+        attr_reader :name
+
+        # The version of the SDK
+        # @return [String]
+        attr_reader :version
+
+        # The wrapper name if this SDK is a wrapper
+        # @return [String, nil]
+        attr_reader :wrapper_name
+
+        # The wrapper version if this SDK is a wrapper
+        # @return [String, nil]
+        attr_reader :wrapper_version
+
+        def initialize(name:, version:, wrapper_name: nil, wrapper_version: nil)
+          @name = name
+          @version = version
+          @wrapper_name = wrapper_name
+          @wrapper_version = wrapper_version
+        end
+      end
+
+      #
+      # Metadata about the application using the SDK.
+      #
+      class ApplicationMetadata
+        # The id of the application
+        # @return [String, nil]
+        attr_reader :id
+
+        # The version of the application
+        # @return [String, nil]
+        attr_reader :version
+
+        def initialize(id: nil, version: nil)
+          @id = id
+          @version = version
+        end
+      end
+
+      #
+      # Metadata about the environment in which the SDK is running.
+      #
+      class EnvironmentMetadata
+        # Information about the SDK
+        # @return [SdkMetadata]
+        attr_reader :sdk
+
+        # Information about the application
+        # @return [ApplicationMetadata, nil]
+        attr_reader :application
+
+        # The SDK key used to initialize the SDK
+        # @return [String, nil]
+        attr_reader :sdk_key
+
+        def initialize(sdk:, application: nil, sdk_key: nil)
+          @sdk = sdk
+          @application = application
+          @sdk_key = sdk_key
+        end
+      end
+
+      #
+      # Metadata about a plugin implementation.
+      #
+      class PluginMetadata
+        # A name representing the plugin instance
+        # @return [String]
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
+      end
+
+      #
+      # Mixin for extending SDK functionality via plugins.
+      #
+      # All provided plugin implementations **MUST** include this mixin. Plugins without this mixin will be ignored.
+      #
+      # This mixin includes default implementations for optional methods. This allows LaunchDarkly to expand the list
+      # of plugin methods without breaking customer integrations.
+      #
+      # Plugins provide an interface which allows for initialization, access to credentials, and hook registration
+      # in a single interface.
+      #
+      module Plugin
+        #
+        # Get metadata about the plugin implementation.
+        #
+        # @return [PluginMetadata]
+        #
+        def metadata
+          PluginMetadata.new('UNDEFINED')
+        end
+
+        #
+        # Register the plugin with the SDK client.
+        #
+        # This method is called during SDK initialization to allow the plugin to set up any necessary integrations,
+        # register hooks, or perform other initialization tasks.
+        #
+        # @param client [LDClient] The LDClient instance
+        # @param environment_metadata [EnvironmentMetadata] Metadata about the environment in which the SDK is running
+        # @return [void]
+        #
+        def register(client, environment_metadata)
+          # Default implementation does nothing
+        end
+
+        #
+        # Get a list of hooks that this plugin provides.
+        #
+        # This method is called before register() to collect all hooks from plugins. The hooks returned will be
+        # added to the SDK's hook configuration.
+        #
+        # @param environment_metadata [EnvironmentMetadata] Metadata about the environment in which the SDK is running
+        # @return [Array<Interfaces::Hooks::Hook>] A list of hooks to be registered with the SDK
+        #
+        def get_hooks(environment_metadata)
+          []
+        end
+      end
+    end
+  end
+end