launchdarkly-server-sdk 8.4.2 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c04f38ba70b95c1446fc0aaffd2f3020e208501e9ede2313b559848792c1bf81
-  data.tar.gz: 6dd37514e2588d78c995702af1d66d6f00cdc3762ce4908690a2a4e13ab5c46d
+  metadata.gz: 2a732ff00a5e21bfc907dff44adc5bd3f1651bd80c2483273a1a9730f443448f
+  data.tar.gz: 1ca26bf847c2387ed585e07b18c6aa42a78496110a7bf9643751a0e2b04d2908
 SHA512:
-  metadata.gz: 40f20870dfa777687da11f7611255ee7f15dde800c7ac9860e5a673643c9d7d19841932162fcabef1d57e6a9ab7710fb3d06ea72567336a5c26ecb0cdd220f74
-  data.tar.gz: bbf303fc081003f0a5e71f2fd38dc48f707958c5c33f6f450982db6c3fecb7076f287460d597414b52c8e4181d95c55babd599fca7877bebe4ff9d82d38e6dd5
+  metadata.gz: 901e6f7562f0861916bf06fd07088561713579633cc5e052ae5cf86c6acdbdd0497b55e273c2f92244a5653d0fa806c9776f92a853bad22232634489c630f85d
+  data.tar.gz: a325418b21c256a8b2d846d187e8bc91ba1e323955f460a418732b77f30354b64fc2dbfdadd04c4be4a41217779a4f217d522799ace4ce46a3ebc5019baf060c

data/lib/ldclient-rb/config.rb

@@ -43,6 +43,7 @@ module LaunchDarkly
     # @option opts [BigSegmentsConfig] :big_segments See {#big_segments}.
     # @option opts [Hash] :application See {#application}
     # @option opts [String] :payload_filter_key See {#payload_filter_key}
+    # @option opts [Boolean] :omit_anonymous_contexts See {#omit_anonymous_contexts}
     # @option hooks [Array<Interfaces::Hooks::Hook]
     #
     def initialize(opts = {})
@@ -77,6 +78,7 @@ module LaunchDarkly
       @application = LaunchDarkly::Impl::Util.validate_application_info(opts[:application] || {}, @logger)
       @payload_filter_key = opts[:payload_filter_key]
       @hooks = (opts[:hooks] || []).keep_if { |hook| hook.is_a? Interfaces::Hooks::Hook }
+      @omit_anonymous_contexts = opts.has_key?(:omit_anonymous_contexts) && opts[:omit_anonymous_contexts]
       @data_source_update_sink = nil
     end
 
@@ -385,6 +387,15 @@ module LaunchDarkly
     #
     attr_reader :hooks
 
+    #
+    # Sets whether anonymous contexts should be omitted from index and identify events.
+    #
+    # The default value is false. Anonymous contexts will be included in index and identify events.
+    # @return [Boolean]
+    #
+    attr_reader :omit_anonymous_contexts
+
+
     #
     # The default LaunchDarkly client configuration. This configuration sets
     # reasonable defaults for most users.

data/lib/ldclient-rb/context.rb

@@ -101,6 +101,26 @@ module LaunchDarkly
       @error.nil?
     end
 
+    #
+    # For a multi-kind context:
+    #
+    # A multi-kind context is made up of two or more single-kind contexts. This method will first discard any
+    # single-kind contexts which are anonymous. It will then create a new multi-kind context from the remaining
+    # single-kind contexts. This may result in an invalid context (e.g. all single-kind contexts are anonymous).
+    #
+    # For a single-kind context:
+    #
+    # If the context is not anonymous, this method will return the current context as is and unmodified.
+    #
+    # If the context is anonymous, this method will return an invalid context.
+    #
+    def without_anonymous_contexts
+      contexts = multi_kind? ? @contexts : [self]
+      contexts = contexts.reject { |c| c.anonymous }
+
+      LDContext.create_multi(contexts)
+    end
+
     #
     # Returns a hash mapping each context's kind to its key.
     #
@@ -334,6 +354,49 @@ module LaunchDarkly
       multi_kind? ? individual_context(key.to_s) : get_value(key)
     end
 
+    #
+    # Convert the LDContext to a JSON string.
+    #
+    # @param args [Array]
+    # @return [String]
+    #
+    def to_json(*args)
+      JSON.generate(to_h, *args)
+    end
+
+    #
+    # Convert the LDContext to a hash. If the LDContext is invalid, the hash will contain an error key with the error
+    # message.
+    #
+    # @return [Hash]
+    #
+    def to_h
+      return {error: error} unless valid?
+      return hash_single_kind unless multi_kind?
+
+      hash = {kind: 'multi'}
+      @contexts.each do |context|
+        single_kind_hash = context.to_h
+        kind = single_kind_hash.delete(:kind)
+        hash[kind] = single_kind_hash
+      end
+
+      hash
+    end
+
+    protected def hash_single_kind
+      hash = attributes.nil? ? {} : attributes.clone
+
+      hash[:kind] = kind
+      hash[:key] = key
+
+      hash[:name] = name unless name.nil?
+      hash[:anonymous] = anonymous if anonymous
+      hash[:_meta] = {privateAttributes: private_attributes} unless private_attributes.empty?
+
+      hash
+    end
+
     #
     # Retrieve the value of any top level, addressable attribute.
     #

data/lib/ldclient-rb/events.rb

@@ -144,6 +144,7 @@ module LaunchDarkly
         Impl::EventSender.new(sdk_key, config, client || Util.new_http_client(config.events_uri, config))
 
       @timestamp_fn = (test_properties || {})[:timestamp_fn] || proc { Impl::Util.current_time_millis }
+      @omit_anonymous_contexts = config.omit_anonymous_contexts
 
       EventDispatcher.new(@inbox, sdk_key, config, diagnostic_accumulator, event_sender)
     end
@@ -167,7 +168,8 @@ module LaunchDarkly
     end
 
     def record_identify_event(context)
-      post_to_inbox(LaunchDarkly::Impl::IdentifyEvent.new(timestamp, context))
+      target_context = !@omit_anonymous_contexts ? context : context.without_anonymous_contexts
+      post_to_inbox(LaunchDarkly::Impl::IdentifyEvent.new(timestamp, target_context)) if target_context.valid?
     end
 
     def record_custom_event(context, key, data = nil, metric_value = nil)
@@ -319,16 +321,27 @@ module LaunchDarkly
         will_add_full_event = true
       end
 
-      # For each context we haven't seen before, we add an index event - unless this is already
-      # an identify event for that context.
-      if !event.context.nil? && !notice_context(event.context) && !event.is_a?(LaunchDarkly::Impl::IdentifyEvent) && !event.is_a?(LaunchDarkly::Impl::MigrationOpEvent)
-        outbox.add_event(LaunchDarkly::Impl::IndexEvent.new(event.timestamp, event.context))
+      get_indexable_context(event) do |ctx|
+        outbox.add_event(LaunchDarkly::Impl::IndexEvent.new(event.timestamp, ctx))
       end
 
       outbox.add_event(event) if will_add_full_event && @sampler.sample(event.sampling_ratio.nil? ? 1 : event.sampling_ratio)
       outbox.add_event(debug_event) if !debug_event.nil? && @sampler.sample(event.sampling_ratio.nil? ? 1 : event.sampling_ratio)
     end
 
+    private def get_indexable_context(event, &block)
+      return if event.context.nil?
+
+      context = !@config.omit_anonymous_contexts ? event.context : event.context.without_anonymous_contexts
+      return unless context.valid?
+
+      return if notice_context(context)
+      return if event.is_a?(LaunchDarkly::Impl::IdentifyEvent)
+      return if event.is_a?(LaunchDarkly::Impl::MigrationOpEvent)
+
+      yield context unless block.nil?
+    end
+
     #
     # Add to the set of contexts we've noticed, and return true if the context
     # was already known to us.

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

@@ -36,18 +36,13 @@ module LaunchDarkly
             @paths = [ @paths ]
           end
           @auto_update = options[:auto_update]
-          if @auto_update && @@have_listen && !options[:force_polling] # force_polling is used only for tests
-            # We have seen unreliable behavior in the 'listen' gem in JRuby 9.1 (https://github.com/guard/listen/issues/449).
-            # Therefore, on that platform we'll fall back to file polling instead.
-            if defined?(JRUBY_VERSION) && JRUBY_VERSION.start_with?("9.1.")
-              @use_listen = false
-            else
-              @use_listen = true
-            end
-          end
+          @use_listen = @auto_update && @@have_listen && !options[:force_polling]
           @poll_interval = options[:poll_interval] || 1
           @initialized = Concurrent::AtomicBoolean.new(false)
           @ready = Concurrent::Event.new
+
+          @version_lock = Mutex.new
+          @last_version = 1
         end
 
         def initialized?
@@ -101,14 +96,22 @@ module LaunchDarkly
         end
 
         def load_file(path, all_data)
+          version = 1
+          @version_lock.synchronize {
+            version = @last_version
+            @last_version += 1
+          }
+
           parsed = parse_content(IO.read(path))
           (parsed[:flags] || {}).each do |key, flag|
+            flag[:version] = version
             add_item(all_data, FEATURES, flag)
           end
           (parsed[:flagValues] || {}).each do |key, value|
-            add_item(all_data, FEATURES, make_flag_with_value(key.to_s, value))
+            add_item(all_data, FEATURES, make_flag_with_value(key.to_s, value, version))
           end
           (parsed[:segments] || {}).each do |key, segment|
+            segment[:version] = version
             add_item(all_data, SEGMENTS, segment)
           end
         end
@@ -142,10 +145,11 @@ module LaunchDarkly
           items[key] = Model.deserialize(kind, item)
         end
 
-        def make_flag_with_value(key, value)
+        def make_flag_with_value(key, value, version)
           {
             key: key,
             on: true,
+            version: version,
             fallthrough: { variation: 0 },
             variations: [ value ],
           }

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

@@ -93,7 +93,7 @@ module LaunchDarkly
       #   Note that the default implementation of this feature is based on polling the filesystem,
       #   which may not perform well. If you install the 'listen' gem (not included by default, to
       #   avoid adding unwanted dependencies to the SDK), its native file watching mechanism will be
-      #   used instead. However, 'listen' will not be used in JRuby 9.1 due to a known instability.
+      #   used instead.
       # @option options [Float] :poll_interval  The minimum interval, in seconds, between checks for
       #   file modifications - used only if auto_update is true, and if the native file-watching
       #   mechanism from 'listen' is not being used. The default value is 1 second.

data/lib/ldclient-rb/ldclient.rb

@@ -124,13 +124,18 @@ module LaunchDarkly
       end
 
       ready = @data_source.start
-      if wait_for_sec > 0
-        ok = ready.wait(wait_for_sec)
-        if !ok
-          @config.logger.error { "[LDClient] Timeout encountered waiting for LaunchDarkly client initialization" }
-        elsif !@data_source.initialized?
-          @config.logger.error { "[LDClient] LaunchDarkly client initialization failed" }
-        end
+
+      return unless wait_for_sec > 0
+
+      if wait_for_sec > 60
+        @config.logger.warn { "[LDClient] Client was configured to block for up to #{wait_for_sec} seconds when initializing. We recommend blocking no longer than 60." }
+      end
+
+      ok = ready.wait(wait_for_sec)
+      if !ok
+        @config.logger.error { "[LDClient] Timeout encountered waiting for LaunchDarkly client initialization" }
+      elsif !@data_source.initialized?
+        @config.logger.error { "[LDClient] LaunchDarkly client initialization failed" }
       end
     end
 

data/lib/ldclient-rb/reference.rb

@@ -238,6 +238,16 @@ module LaunchDarkly
       ([error] + components).hash
     end
 
+    #
+    # Convert the Reference to a JSON string.
+    #
+    # @param args [Array]
+    # @return [String]
+    #
+    def to_json(*args)
+      JSON.generate(@raw_path, *args)
+    end
+
     #
     # Performs unescaping of attribute reference path components:
     #

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "8.4.2" # x-release-please-version
+  VERSION = "8.6.0" # x-release-please-version
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 8.4.2
+  version: 8.6.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -376,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby