launchdarkly-server-sdk 6.2.5 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f1b216e5ae2518b79aae9613ecd04b02ed525ea2d25084df805eae7d92cb219
-  data.tar.gz: 317db7e14a292968b245e39e3cd4be33206fd8085c8ebd04be43f1c987434228
+  metadata.gz: e189d76d654dbf73dc95e9cea758b81bc0df93d9012ebb6560d0994e6dff227c
+  data.tar.gz: fc8bdc8b9affee0e51ef233c217cfa4a3c7fbdbceb4694c38c5a2e90155205ed
 SHA512:
-  metadata.gz: 5d9182ccde6530f67df30fd8a238e9b510e89dc235cf76c45140cb6eaa36b8e342a44a98595b8c86f171c8f6f1cc74291f3c2ebf11ac274f2a1e46d64798318c
-  data.tar.gz: 4b54fc711795c06e3bdabb9dd593af8499aa8e8c28eec1f9db508a5a6c5288cd0268b7ce9d324c892425ffcf080f0ad21e78060a74e0186f19998bd40f076943
+  metadata.gz: 7fb89d48c3185f7019cd170f36f571b1ca2f7de130c624d6301fbfd30d46a0ae7a986494393ab290fa23b66511ce676b660533e1ad23d3a9e01fb037e20db6c4
+  data.tar.gz: 7e706747d2fcd1ab299a76eca7bf26908dbe97972b8c1ea74cfae6bc6aaffe866ddfc157b26675eb44fb22044c74efff88e7c5c4bf8dc0e75fa93dfe0ddbea8a

data/README.md

@@ -3,8 +3,7 @@ LaunchDarkly Server-side SDK for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/launchdarkly-server-sdk.svg)](http://badge.fury.io/rb/launchdarkly-server-sdk)
 
-[![Circle CI](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/master.svg?style=svg)](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/master)
-[![Security](https://hakiri.io/github/launchdarkly/ruby-server-sdk/master.svg)](https://hakiri.io/github/launchdarkly/ruby-server-sdk/master)
+[![Circle CI](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/main.svg?style=svg)](https://circleci.com/gh/launchdarkly/ruby-server-sdk/tree/main)
 [![RubyDoc](https://img.shields.io/static/v1?label=docs+-+all+versions&message=reference&color=00add8)](https://www.rubydoc.info/gems/launchdarkly-server-sdk)
 [![GitHub Pages](https://img.shields.io/static/v1?label=docs+-+latest&message=reference&color=00add8)](https://launchdarkly.github.io/ruby-server-sdk)
 

data/lib/ldclient-rb/config.rb

@@ -13,6 +13,18 @@ module LaunchDarkly
     #
     # Constructor for creating custom LaunchDarkly configurations.
     #
+    # `user_keys_capacity` and `user_keys_flush_interval` are deprecated
+    # configuration options. They exist to maintain backwards compatibility
+    # with previous configurations. Newer code should prefer their replacement
+    # options -- `context_keys_capacity` and `context_keys_flush_interval`.
+    #
+    # In the event both the user and context variations are provided, the
+    # context specific configuration option will take precedence.
+    #
+    # Similarly, `private_attribute_names` is deprecated. Newer code should
+    # prefer `private_attributes`. If both are provided, `private_attributes`
+    # will take precedence.
+    #
     # @param opts [Hash] the configuration options
     # @option opts [Logger] :logger See {#logger}.
     # @option opts [String] :base_uri ("https://sdk.launchdarkly.com") See {#base_uri}.
@@ -21,6 +33,7 @@ module LaunchDarkly
     # @option opts [Integer] :capacity (10000) See {#capacity}.
     # @option opts [Float] :flush_interval (30) See {#flush_interval}.
     # @option opts [Float] :read_timeout (10) See {#read_timeout}.
+    # @option opts [Float] :initial_reconnect_delay (1) See {#initial_reconnect_delay}.
     # @option opts [Float] :connect_timeout (2) See {#connect_timeout}.
     # @option opts [Object] :cache_store See {#cache_store}.
     # @option opts [Object] :feature_store See {#feature_store}.
@@ -30,18 +43,20 @@ module LaunchDarkly
     # @option opts [Boolean] :stream (true) See {#stream?}.
     # @option opts [Boolean] all_attributes_private (false) See {#all_attributes_private}.
     # @option opts [Array] :private_attribute_names See {#private_attribute_names}.
+    # @option opts [Array] :private_attributes See {#private_attributes}.
     # @option opts [Boolean] :send_events (true) See {#send_events}.
     # @option opts [Integer] :user_keys_capacity (1000) See {#user_keys_capacity}.
+    # @option opts [Integer] :context_keys_capacity (1000) See {#context_keys_capacity}.
     # @option opts [Float] :user_keys_flush_interval (300) See {#user_keys_flush_interval}.
-    # @option opts [Boolean] :inline_users_in_events (false) See {#inline_users_in_events}.
+    # @option opts [Float] :context_keys_flush_interval (300) See {#context_keys_flush_interval}.
     # @option opts [Object] :data_source See {#data_source}.
-    # @option opts [Object] :update_processor Obsolete synonym for `data_source`.
-    # @option opts [Object] :update_processor_factory Obsolete synonym for `data_source`.
     # @option opts [Boolean] :diagnostic_opt_out (false) See {#diagnostic_opt_out?}.
     # @option opts [Float] :diagnostic_recording_interval (900) See {#diagnostic_recording_interval}.
     # @option opts [String] :wrapper_name See {#wrapper_name}.
     # @option opts [String] :wrapper_version See {#wrapper_version}.
     # @option opts [#open] :socket_factory See {#socket_factory}.
+    # @option opts [BigSegmentsConfig] :big_segments See {#big_segments}.
+    # @option opts [Hash] :application See {#application}
     #
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
@@ -53,26 +68,26 @@ module LaunchDarkly
       @flush_interval = opts[:flush_interval] || Config.default_flush_interval
       @connect_timeout = opts[:connect_timeout] || Config.default_connect_timeout
       @read_timeout = opts[:read_timeout] || Config.default_read_timeout
+      @initial_reconnect_delay = opts[:initial_reconnect_delay] || Config.default_initial_reconnect_delay
       @feature_store = opts[:feature_store] || Config.default_feature_store
       @stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
       @use_ldd = opts.has_key?(:use_ldd) ? opts[:use_ldd] : Config.default_use_ldd
       @offline = opts.has_key?(:offline) ? opts[:offline] : Config.default_offline
       @poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > Config.default_poll_interval ? opts[:poll_interval] : Config.default_poll_interval
       @all_attributes_private = opts[:all_attributes_private] || false
-      @private_attribute_names = opts[:private_attribute_names] || []
+      @private_attributes = opts[:private_attributes] || opts[:private_attribute_names] || []
       @send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
-      @user_keys_capacity = opts[:user_keys_capacity] || Config.default_user_keys_capacity
-      @user_keys_flush_interval = opts[:user_keys_flush_interval] || Config.default_user_keys_flush_interval
-      @inline_users_in_events = opts[:inline_users_in_events] || false
-      @data_source = opts[:data_source] || opts[:update_processor] || opts[:update_processor_factory]
-      @update_processor = opts[:update_processor]
-      @update_processor_factory = opts[:update_processor_factory]
+      @context_keys_capacity = opts[:context_keys_capacity] || opts[:user_keys_capacity] || Config.default_context_keys_capacity
+      @context_keys_flush_interval = opts[:context_keys_flush_interval] || opts[:user_keys_flush_interval] || Config.default_user_keys_flush_interval
+      @data_source = opts[:data_source]
       @diagnostic_opt_out = opts.has_key?(:diagnostic_opt_out) && opts[:diagnostic_opt_out]
       @diagnostic_recording_interval = opts.has_key?(:diagnostic_recording_interval) && opts[:diagnostic_recording_interval] > Config.minimum_diagnostic_recording_interval ?
         opts[:diagnostic_recording_interval] : Config.default_diagnostic_recording_interval
       @wrapper_name = opts[:wrapper_name]
       @wrapper_version = opts[:wrapper_version]
       @socket_factory = opts[:socket_factory]
+      @big_segments = opts[:big_segments] || BigSegmentsConfig.new(store: nil)
+      @application = LaunchDarkly::Impl::Util.validate_application_info(opts[:application] || {}, @logger)
     end
 
     #
@@ -120,7 +135,7 @@ module LaunchDarkly
     def use_ldd?
       @use_ldd
     end
-    
+
     #
     # Whether the client should be initialized in offline mode. In offline mode, default values are
     # returned for all flags and no remote network requests are made.
@@ -178,6 +193,13 @@ module LaunchDarkly
     #
     attr_reader :read_timeout
 
+    #
+    # The initial delay before reconnecting after an error in the SSE client.
+    # This only applies to the streaming connection.
+    # @return [Float]
+    #
+    attr_reader :initial_reconnect_delay
+
     #
     # The connect timeout for network connections in seconds.
     # @return [Float]
@@ -196,28 +218,37 @@ module LaunchDarkly
     attr_reader :feature_store
 
     #
-    # True if all user attributes (other than the key) should be considered private. This means
+    # True if all context attributes (other than the key) should be considered private. This means
     # that the attribute values will not be sent to LaunchDarkly in analytics events and will not
     # appear on the LaunchDarkly dashboard.
     # @return [Boolean]
-    # @see #private_attribute_names
+    # @see #private_attributes
     #
     attr_reader :all_attributes_private
 
     #
-    # A list of user attribute names that should always be considered private. This means that the
+    # A list of context attribute names that should always be considered private. This means that the
     # attribute values will not be sent to LaunchDarkly in analytics events and will not appear on
     # the LaunchDarkly dashboard.
     #
-    # You can also specify the same behavior for an individual flag evaluation by storing an array
-    # of attribute names in the `:privateAttributeNames` property (note camelcase name) of the
-    # user object.
+    # You can also specify the same behavior for an individual flag evaluation
+    # by providing the context object with a list of private attributes.
+    #
+    # @see https://docs.launchdarkly.com/sdk/features/user-context-config#using-private-attributes
     #
     # @return [Array<String>]
     # @see #all_attributes_private
     #
-    attr_reader :private_attribute_names
-    
+    attr_reader :private_attributes
+
+    #
+    # @deprecated Backwards compatibility alias for #private_attributes.
+    #
+    # @return [Integer]
+    # @see #private_attributes
+    #
+    alias :private_attribute_names :private_attributes
+
     #
     # Whether to send events back to LaunchDarkly. This differs from {#offline?} in that it affects
     # only the sending of client-side events, not streaming or polling for events from the server.
@@ -226,27 +257,35 @@ module LaunchDarkly
     attr_reader :send_events
 
     #
-    # The number of user keys that the event processor can remember at any one time. This reduces the
-    # amount of duplicate user details sent in analytics 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.
+    # @return [Integer]
+    # @see #context_keys_flush_interval
+    #
+    attr_reader :context_keys_capacity
+
+    #
+    # @deprecated Backwards compatibility alias for #context_keys_capacity.
+    #
     # @return [Integer]
-    # @see #user_keys_flush_interval
+    # @see #context_keys_flush_interval
     #
-    attr_reader :user_keys_capacity
+    alias :user_keys_capacity :context_keys_capacity
 
     #
-    # The interval in seconds at which the event processor will reset its set of known user keys.
+    # The interval in seconds at which the event processor will reset its set of known context keys.
     # @return [Float]
-    # @see #user_keys_capacity
+    # @see #context_keys_capacity
     #
-    attr_reader :user_keys_flush_interval
+    attr_reader :context_keys_flush_interval
 
     #
-    # Whether to include full user details in every analytics event. By default, events will only
-    # include the user key, except for one "index" event that provides the full details for the user.
-    # The only reason to change this is if you are using the Analytics Data Stream.
-    # @return [Boolean]
+    # @deprecated Backwards compatibility alias for #context_keys_flush_interval.
     #
-    attr_reader :inline_users_in_events
+    # @return [Integer]
+    # @see #context_keys_flush_interval
+    #
+    alias :user_keys_flush_interval :context_keys_flush_interval
 
     #
     # An object that is responsible for receiving feature flag data from LaunchDarkly. By default,
@@ -258,15 +297,38 @@ module LaunchDarkly
     # object.
     #
     # @return [LaunchDarkly::Interfaces::DataSource|lambda]
-    # @see FileDataSource
+    # @see LaunchDarkly::Integrations::FileData
+    # @see LaunchDarkly::Integrations::TestData
     #
     attr_reader :data_source
 
-    # @deprecated This is replaced by {#data_source}.
-    attr_reader :update_processor
-    
-    # @deprecated This is replaced by {#data_source}.
-    attr_reader :update_processor_factory
+    #
+    # Configuration options related to Big Segments.
+    #
+    # Big Segments are a specific type of segments. For more information, read the LaunchDarkly
+    # documentation: https://docs.launchdarkly.com/home/users/big-segments
+    #
+    # @return [BigSegmentsConfig]
+    #
+    attr_reader :big_segments
+
+    #
+    # An object that allows configuration of application metadata.
+    #
+    # Application metadata may be used in LaunchDarkly analytics or other product features, but does not affect feature flag evaluations.
+    #
+    # If you want to set non-default values for any of these fields, provide the appropriately configured hash to the {Config} object.
+    #
+    # @example Configuring application information
+    #   opts[:application] = {
+    #     id: "MY APPLICATION ID",
+    #     version: "MY APPLICATION VERSION"
+    #   }
+    #   config = LDConfig.new(opts)
+    #
+    # @return [Hash]
+    #
+    attr_reader :application
 
     #
     # Set to true to opt out of sending diagnostics data.
@@ -382,6 +444,14 @@ module LaunchDarkly
       10
     end
 
+    #
+    # The default value for {#initial_reconnect_delay}.
+    # @return [Float] 1
+    #
+    def self.default_initial_reconnect_delay
+      1
+    end
+
     #
     # The default value for {#connect_timeout}.
     # @return [Float] 10
@@ -396,8 +466,8 @@ module LaunchDarkly
     #
     def self.default_logger
       if defined?(Rails) && Rails.respond_to?(:logger)
-        Rails.logger 
-      else 
+        Rails.logger
+      else
         log = ::Logger.new($stdout)
         log.level = ::Logger::WARN
         log
@@ -453,21 +523,33 @@ module LaunchDarkly
     end
 
     #
-    # The default value for {#user_keys_capacity}.
+    # The default value for {#context_keys_capacity}.
     # @return [Integer] 1000
     #
-    def self.default_user_keys_capacity
+    def self.default_context_keys_capacity
       1000
     end
 
     #
-    # The default value for {#user_keys_flush_interval}.
+    # The default value for {#context_keys_flush_interval}.
     # @return [Float] 300
     #
-    def self.default_user_keys_flush_interval
+    def self.default_context_keys_flush_interval
       300
     end
 
+    class << self
+      #
+      # @deprecated Backwards compatibility alias for #default_context_keys_capacity
+      #
+      alias :default_user_keys_capacity :default_context_keys_capacity
+
+      #
+      # @deprecated Backwards compatibility alias for #default_context_keys_flush_interval
+      #
+      alias :default_user_keys_flush_interval :default_context_keys_flush_interval
+    end
+
     #
     # The default value for {#diagnostic_recording_interval}.
     # @return [Float] 900
@@ -484,4 +566,82 @@ module LaunchDarkly
       60
     end
   end
+
+  #
+  # Configuration options related to Big Segments.
+  #
+  # Big Segments are a specific type of segments. For more information, read the LaunchDarkly
+  # documentation: https://docs.launchdarkly.com/home/users/big-segments
+  #
+  # If your application uses Big Segments, you will need to create a `BigSegmentsConfig` that at a
+  # minimum specifies what database integration to use, and then pass the `BigSegmentsConfig`
+  # object as the `big_segments` parameter when creating a {Config}.
+  #
+  # @example Configuring Big Segments with Redis
+  #     store = LaunchDarkly::Integrations::Redis::new_big_segments_store(redis_url: "redis://my-server")
+  #     config = LaunchDarkly::Config.new(big_segments:
+  #       LaunchDarkly::BigSegmentsConfig.new(store: store))
+  #     client = LaunchDarkly::LDClient.new(my_sdk_key, config)
+  #
+  class BigSegmentsConfig
+    DEFAULT_CONTEXT_CACHE_SIZE = 1000
+    DEFAULT_CONTEXT_CACHE_TIME = 5
+    DEFAULT_STATUS_POLL_INTERVAL = 5
+    DEFAULT_STALE_AFTER = 2 * 60
+
+    #
+    # Constructor for setting Big Segments options.
+    #
+    # @param store [LaunchDarkly::Interfaces::BigSegmentStore] the data store implementation
+    # @param context_cache_size [Integer] See {#context_cache_size}.
+    # @param context_cache_time [Float] See {#context_cache_time}.
+    # @param status_poll_interval [Float] See {#status_poll_interval}.
+    # @param stale_after [Float] See {#stale_after}.
+    #
+    def initialize(store:, context_cache_size: nil, context_cache_time: nil, status_poll_interval: nil, stale_after: nil)
+      @store = store
+      @context_cache_size = context_cache_size.nil? ? DEFAULT_CONTEXT_CACHE_SIZE : context_cache_size
+      @context_cache_time = context_cache_time.nil? ? DEFAULT_CONTEXT_CACHE_TIME : context_cache_time
+      @status_poll_interval = status_poll_interval.nil? ? DEFAULT_STATUS_POLL_INTERVAL : status_poll_interval
+      @stale_after = stale_after.nil? ? DEFAULT_STALE_AFTER : stale_after
+    end
+
+    # The implementation of {LaunchDarkly::Interfaces::BigSegmentStore} that will be used to
+    # query the Big Segments database.
+    # @return [LaunchDarkly::Interfaces::BigSegmentStore]
+    attr_reader :store
+
+    # The maximum number of contexts whose Big Segment state will be cached by the SDK at any given time.
+    # @return [Integer]
+    attr_reader :context_cache_size
+
+    #
+    # @deprecated Backwards compatibility alias for #context_cache_size
+    #
+    # @return [Integer]
+    #
+    alias :user_cache_size :context_cache_size
+
+    # The maximum length of time (in seconds) that the Big Segment state for a context will be cached
+    # by the SDK.
+    # @return [Float]
+    attr_reader :context_cache_time
+
+    #
+    # @deprecated Backwards compatibility alias for #context_cache_time
+    #
+    # @return [Float]
+    #
+    alias :user_cache_time :context_cache_time
+
+    # The interval (in seconds) at which the SDK will poll the Big Segment store to make sure it is
+    # available and to determine how long ago it was updated.
+    # @return [Float]
+    attr_reader :status_poll_interval
+
+    # The maximum length of time between updates of the Big Segments data before the data is
+    # considered out of date.
+    # @return [Float]
+    attr_reader :stale_after
+  end
 end