launchdarkly-server-sdk 6.3.3 → 6.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e87643dab1105f65581f685f5fcbd51031d989fd8f2d782c9ba3cd8db81935c
-  data.tar.gz: a4f896ba4a813edb23d265448ee809f6081b32c64c8487d3501137d0cde527c8
+  metadata.gz: 50934709e1ee8c075c56c149f75753f87498eb9e1f06e39597d2cd4514ea7196
+  data.tar.gz: e7f153366b7b50c3951f844bf9ce1a0b81093fc733818dbb02e8f0a888d9ac26
 SHA512:
-  metadata.gz: 0b8b1d10daeb8a22fcaafc398a19c484776a4809d7ed8412880539c7176d3bd36c1137eb59180741ed948b94f58fac9fbafdd03ccaa1b3fe1d4725d48f581b0e
-  data.tar.gz: a4caf7a74fd68f40f6f3ad05ba1999b2062eb2d11d7c077ef4cff78434cc23319493686e27f4cb987ab2fa5013dc69e6e71c55cacc419c13dbd7fcd304df51cb
+  metadata.gz: 2469e536ca482489eb46f3ff650aeb573eb691ab6c6c2b8ed669b7f8ba799bf65d68d40f6cabc51ec4b051dd56e309430f94e5dc4fbbd70193efa5156d1d1082
+  data.tar.gz: 454219746c7b296fd8c92ee5e266f96765f72527706b7d6f7360445eb1d245e2acb37e4cb722ed48bf73dce8e307d2121771270ea9bedb71e91d67f9a79b8ea0

data/lib/ldclient-rb/events.rb

@@ -1,5 +1,7 @@
 require "ldclient-rb/impl/diagnostic_events"
 require "ldclient-rb/impl/event_sender"
+require "ldclient-rb/impl/event_summarizer"
+require "ldclient-rb/impl/event_types"
 require "ldclient-rb/impl/util"
 
 require "concurrent"
@@ -26,16 +28,33 @@ require "time"
 #
 
 module LaunchDarkly
-  MAX_FLUSH_WORKERS = 5
-  USER_ATTRS_TO_STRINGIFY_FOR_EVENTS = [ :key, :secondary, :ip, :country, :email, :firstName, :lastName,
-    :avatar, :name ]
+  module EventProcessorMethods
+    def record_eval_event(
+      user,
+      key,
+      version = nil,
+      variation = nil,
+      value = nil,
+      reason = nil,
+      default = nil,
+      track_events = false,
+      debug_until = nil,
+      prereq_of = nil
+    )
+    end
 
-  private_constant :MAX_FLUSH_WORKERS
-  private_constant :USER_ATTRS_TO_STRINGIFY_FOR_EVENTS
+    def record_identify_event(user)
+    end
 
-  # @private
-  class NullEventProcessor
-    def add_event(event)
+    def record_custom_event(
+      user,
+      key,
+      data = nil,
+      metric_value = nil
+    )
+    end
+
+    def record_alias_event(user, previous_user)
     end
 
     def flush
@@ -45,12 +64,16 @@ module LaunchDarkly
     end
   end
 
+  MAX_FLUSH_WORKERS = 5
+  USER_ATTRS_TO_STRINGIFY_FOR_EVENTS = [ :key, :secondary, :ip, :country, :email, :firstName, :lastName,
+    :avatar, :name ]
+
+  private_constant :MAX_FLUSH_WORKERS
+  private_constant :USER_ATTRS_TO_STRINGIFY_FOR_EVENTS
+
   # @private
-  class EventMessage
-    def initialize(event)
-      @event = event
-    end
-    attr_reader :event
+  class NullEventProcessor
+    include EventProcessorMethods
   end
 
   # @private
@@ -90,6 +113,8 @@ module LaunchDarkly
 
   # @private
   class EventProcessor
+    include EventProcessorMethods
+
     def initialize(sdk_key, config, client = nil, diagnostic_accumulator = nil, test_properties = nil)
       raise ArgumentError, "sdk_key must not be nil" if sdk_key.nil?  # see LDClient constructor comment on sdk_key
       @logger = config.logger
@@ -116,16 +141,46 @@ module LaunchDarkly
       @stopped = Concurrent::AtomicBoolean.new(false)
       @inbox_full = Concurrent::AtomicBoolean.new(false)
 
-      event_sender = test_properties && test_properties.has_key?(:event_sender) ?
-        test_properties[:event_sender] :
+      event_sender = (test_properties || {})[:event_sender] ||
         Impl::EventSender.new(sdk_key, config, client ? client : Util.new_http_client(config.events_uri, config))
 
+      @timestamp_fn = (test_properties || {})[:timestamp_fn] || proc { Impl::Util.current_time_millis }
+
       EventDispatcher.new(@inbox, sdk_key, config, diagnostic_accumulator, event_sender)
     end
 
-    def add_event(event)
-      event[:creationDate] = Impl::Util.current_time_millis
-      post_to_inbox(EventMessage.new(event))
+    def record_eval_event(
+      user,
+      key,
+      version = nil,
+      variation = nil,
+      value = nil,
+      reason = nil,
+      default = nil,
+      track_events = false,
+      debug_until = nil,
+      prereq_of = nil
+    )
+      post_to_inbox(LaunchDarkly::Impl::EvalEvent.new(timestamp, user, key, version, variation, value, reason,
+        default, track_events, debug_until, prereq_of))
+    end
+
+    def record_identify_event(user)
+      post_to_inbox(LaunchDarkly::Impl::IdentifyEvent.new(timestamp, user))
+    end
+
+    def record_custom_event(user, key, data = nil, metric_value = nil)
+      post_to_inbox(LaunchDarkly::Impl::CustomEvent.new(timestamp, user, key, data, metric_value))
+    end
+
+    def record_alias_event(user, previous_user)
+      post_to_inbox(LaunchDarkly::Impl::AliasEvent.new(
+        timestamp,
+        user.nil? ? nil : user[:key],
+        user_to_context_kind(user),
+        previous_user.nil? ? nil : previous_user[:key],
+        user_to_context_kind(previous_user)
+      ))
     end
 
     def flush
@@ -155,9 +210,11 @@ module LaunchDarkly
       sync_msg.wait_for_completion
     end
 
-    private
+    private def timestamp
+      @timestamp_fn.call()
+    end
 
-    def post_to_inbox(message)
+    private def post_to_inbox(message)
       begin
         @inbox.push(message, non_block=true)
       rescue ThreadError
@@ -170,6 +227,10 @@ module LaunchDarkly
         end
       end
     end
+
+    private def user_to_context_kind(user)
+      (user.nil? || !user[:anonymous]) ? 'user' : 'anonymousUser'
+    end
   end
 
   # @private
@@ -209,8 +270,6 @@ module LaunchDarkly
         begin
           message = inbox.pop
           case message
-          when EventMessage
-            dispatch_event(message.event, outbox)
           when FlushMessage
             trigger_flush(outbox, flush_workers)
           when FlushUsersMessage
@@ -224,6 +283,8 @@ module LaunchDarkly
             do_shutdown(flush_workers, diagnostic_event_workers)
             running = false
             message.completed
+          else
+            dispatch_event(message, outbox)
           end
         rescue => e
           Util.log_exception(@config.logger, "Unexpected error in event processor", e)
@@ -257,11 +318,10 @@ module LaunchDarkly
       # the event (if tracked) and once for debugging.
       will_add_full_event = false
       debug_event = nil
-      if event[:kind] == "feature"
-        will_add_full_event = event[:trackEvents]
+      if event.is_a?(LaunchDarkly::Impl::EvalEvent)
+        will_add_full_event = event.track_events
         if should_debug_event(event)
-          debug_event = event.clone
-          debug_event[:debug] = true
+          debug_event = LaunchDarkly::Impl::DebugEvent.new(event)
         end
       else
         will_add_full_event = true
@@ -270,12 +330,8 @@ module LaunchDarkly
       # For each user we haven't seen before, we add an index event - unless this is already
       # an identify event for that user.
       if !(will_add_full_event && @config.inline_users_in_events)
-        if event.has_key?(:user) && !notice_user(event[:user]) && event[:kind] != "identify"
-          outbox.add_event({
-            kind: "index",
-            creationDate: event[:creationDate],
-            user: event[:user]
-          })
+        if !event.user.nil? && !notice_user(event.user) && !event.is_a?(LaunchDarkly::Impl::IdentifyEvent)
+          outbox.add_event(LaunchDarkly::Impl::IndexEvent.new(event.timestamp, event.user))
         end
       end
 
@@ -295,7 +351,7 @@ module LaunchDarkly
     end
 
     def should_debug_event(event)
-      debug_until = event[:debugEventsUntilDate]
+      debug_until = event.debug_until
       if !debug_until.nil?
         last_past = @last_known_past_time.value
         debug_until > last_past && debug_until > Impl::Util.current_time_millis
@@ -365,12 +421,11 @@ module LaunchDarkly
       @capacity_exceeded = false
       @dropped_events = 0
       @events = []
-      @summarizer = EventSummarizer.new
+      @summarizer = LaunchDarkly::Impl::EventSummarizer.new
     end
 
     def add_event(event)
       if @events.length < @capacity
-        @logger.debug { "[LDClient] Enqueueing event: #{event.to_json}" }
         @events.push(event)
         @capacity_exceeded = false
       else
@@ -404,6 +459,15 @@ module LaunchDarkly
 
   # @private
   class EventOutputFormatter
+    FEATURE_KIND = 'feature'
+    IDENTIFY_KIND = 'identify'
+    CUSTOM_KIND = 'custom'
+    ALIAS_KIND = 'alias'
+    INDEX_KIND = 'index'
+    DEBUG_KIND = 'debug'
+    SUMMARY_KIND = 'summary'
+    ANONYMOUS_USER_CONTEXT_KIND = 'anonymousUser'
+
     def initialize(config)
       @inline_users = config.inline_users_in_events
       @user_filter = UserFilter.new(config)
@@ -418,100 +482,130 @@ module LaunchDarkly
       events_out
     end
 
-    private
-
-    def process_user(event)
-      filtered = @user_filter.transform_user_props(event[:user])
-      Util.stringify_attrs(filtered, USER_ATTRS_TO_STRINGIFY_FOR_EVENTS)
-    end
-
-    def make_output_event(event)
-      case event[:kind]
-      when "feature"
-        is_debug = event[:debug]
+    private def make_output_event(event)
+      case event
+        
+      when LaunchDarkly::Impl::EvalEvent
         out = {
-          kind: is_debug ? "debug" : "feature",
-          creationDate: event[:creationDate],
-          key: event[:key],
-          value: event[:value]
+          kind: FEATURE_KIND,
+          creationDate: event.timestamp,
+          key: event.key,
+          value: event.value
         }
-        out[:default] = event[:default] if event.has_key?(:default)
-        out[:variation] = event[:variation] if event.has_key?(:variation)
-        out[:version] = event[:version] if event.has_key?(:version)
-        out[:prereqOf] = event[:prereqOf] if event.has_key?(:prereqOf)
-        out[:contextKind] = event[:contextKind] if event.has_key?(:contextKind)
-        if @inline_users || is_debug
-          out[:user] = process_user(event)
-        else
-          out[:userKey] = event[:user][:key]
-        end
-        out[:reason] = event[:reason] if !event[:reason].nil?
+        out[:default] = event.default if !event.default.nil?
+        out[:variation] = event.variation if !event.variation.nil?
+        out[:version] = event.version if !event.version.nil?
+        out[:prereqOf] = event.prereq_of if !event.prereq_of.nil?
+        set_opt_context_kind(out, event.user)
+        set_user_or_user_key(out, event.user)
+        out[:reason] = event.reason if !event.reason.nil?
         out
-      when "identify"
+
+      when LaunchDarkly::Impl::IdentifyEvent
         {
-          kind: "identify",
-          creationDate: event[:creationDate],
-          key: event[:user][:key].to_s,
-          user: process_user(event)
+          kind: IDENTIFY_KIND,
+          creationDate: event.timestamp,
+          key: event.user[:key].to_s,
+          user: process_user(event.user)
         }
-      when "custom"
+      
+      when LaunchDarkly::Impl::CustomEvent
         out = {
-          kind: "custom",
-          creationDate: event[:creationDate],
-          key: event[:key]
+          kind: CUSTOM_KIND,
+          creationDate: event.timestamp,
+          key: event.key
         }
-        out[:data] = event[:data] if event.has_key?(:data)
-        if @inline_users
-          out[:user] = process_user(event)
-        else
-          out[:userKey] = event[:user][:key]
-        end
-        out[:metricValue] = event[:metricValue] if event.has_key?(:metricValue)
-        out[:contextKind] = event[:contextKind] if event.has_key?(:contextKind)
+        out[:data] = event.data if !event.data.nil?
+        set_user_or_user_key(out, event.user)
+        out[:metricValue] = event.metric_value if !event.metric_value.nil?
+        set_opt_context_kind(out, event.user)
         out
-      when "index"
+
+      when LaunchDarkly::Impl::AliasEvent
+        {
+          kind: ALIAS_KIND,
+          creationDate: event.timestamp,
+          key: event.key,
+          contextKind: event.context_kind,
+          previousKey: event.previous_key,
+          previousContextKind: event.previous_context_kind
+        }
+      
+      when LaunchDarkly::Impl::IndexEvent
         {
-          kind: "index",
-          creationDate: event[:creationDate],
-          user: process_user(event)
+          kind: INDEX_KIND,
+          creationDate: event.timestamp,
+          user: process_user(event.user)
         }
+      
+      when LaunchDarkly::Impl::DebugEvent
+        original = event.eval_event
+        out = {
+          kind: DEBUG_KIND,
+          creationDate: original.timestamp,
+          key: original.key,
+          user: process_user(original.user),
+          value: original.value
+        }
+        out[:default] = original.default if !original.default.nil?
+        out[:variation] = original.variation if !original.variation.nil?
+        out[:version] = original.version if !original.version.nil?
+        out[:prereqOf] = original.prereq_of if !original.prereq_of.nil?
+        set_opt_context_kind(out, original.user)
+        out[:reason] = original.reason if !original.reason.nil?
+        out
+
       else
-        event
+        nil
       end
     end
 
     # Transforms the summary data into the format used for event sending.
-    def make_summary_event(summary)
+    private def make_summary_event(summary)
       flags = {}
-      summary[:counters].each { |ckey, cval|
-        flag = flags[ckey[:key]]
-        if flag.nil?
-          flag = {
-            default: cval[:default],
-            counters: []
-          }
-          flags[ckey[:key]] = flag
-        end
-        c = {
-          value: cval[:value],
-          count: cval[:count]
-        }
-        if !ckey[:variation].nil?
-          c[:variation] = ckey[:variation]
-        end
-        if ckey[:version].nil?
-          c[:unknown] = true
-        else
-          c[:version] = ckey[:version]
+      summary.counters.each do |flagKey, flagInfo|
+        counters = []
+        flagInfo.versions.each do |version, variations|
+          variations.each do |variation, counter|
+            c = {
+              value: counter.value,
+              count: counter.count
+            }
+            c[:variation] = variation if !variation.nil?
+            if version.nil?
+              c[:unknown] = true
+            else
+              c[:version] = version
+            end
+            counters.push(c)
+          end
         end
-        flag[:counters].push(c)
-      }
+        flags[flagKey] = { default: flagInfo.default, counters: counters }
+      end
       {
-        kind: "summary",
+        kind: SUMMARY_KIND,
         startDate: summary[:start_date],
         endDate: summary[:end_date],
         features: flags
       }
     end
+
+    private def set_opt_context_kind(out, user)
+      out[:contextKind] = ANONYMOUS_USER_CONTEXT_KIND if !user.nil? && user[:anonymous]
+    end
+
+    private def set_user_or_user_key(out, user)
+      if @inline_users
+        out[:user] = process_user(user)
+      else
+        key = user[:key]
+        out[:userKey] = key.is_a?(String) ? key : key.to_s
+      end
+    end
+
+    private def process_user(user)
+      filtered = @user_filter.transform_user_props(user)
+      Util.stringify_attrs(filtered, USER_ATTRS_TO_STRINGIFY_FOR_EVENTS)
+    end
   end
 end

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

@@ -4,6 +4,13 @@ require "ldclient-rb/impl/evaluator_operators"
 
 module LaunchDarkly
   module Impl
+    # Used internally to record that we evaluated a prerequisite flag.
+    PrerequisiteEvalRecord = Struct.new(
+      :prereq_flag,     # the prerequisite flag that we evaluated
+      :prereq_of_flag,  # the flag that it was a prerequisite of
+      :detail           # the EvaluationDetail representing the evaluation result
+    )
+
     # Encapsulates the feature flag evaluation logic. The Evaluator has no knowledge of the rest of the SDK environment;
     # if it needs to retrieve flags or segments that are referenced by a flag, it does so through a simple function that
     # is provided in the constructor. It also produces feature requests as appropriate for any referenced prerequisite
@@ -22,7 +29,7 @@ module LaunchDarkly
         @get_big_segments_membership = get_big_segments_membership
         @logger = logger
       end
-
+  
       # Used internally to hold an evaluation result and additional state that may be accumulated during an
       # evaluation. It's simpler and a bit more efficient to represent these as mutable properties rather than
       # trying to use a pure functional approach, and since we're not exposing this object to any application code
@@ -34,7 +41,7 @@ module LaunchDarkly
       # evaluation.
       EvalResult = Struct.new(
         :detail,  # the EvaluationDetail representing the evaluation result
-        :events,  # an array of evaluation events generated by prerequisites, or nil
+        :prereq_evals,  # an array of PrerequisiteEvalRecord instances, or nil
         :big_segments_status,
         :big_segments_membership
       )
@@ -50,17 +57,15 @@ module LaunchDarkly
       #
       # @param flag [Object] the flag
       # @param user [Object] the user properties
-      # @param event_factory [EventFactory] called to construct a feature request event when a prerequisite flag is
-      #   evaluated; the caller is responsible for constructing the feature event for the top-level evaluation
       # @return [EvalResult] the evaluation result 
-      def evaluate(flag, user, event_factory)
+      def evaluate(flag, user)
         result = EvalResult.new
         if user.nil? || user[:key].nil?
           result.detail = Evaluator.error_result(EvaluationReason::ERROR_USER_NOT_SPECIFIED)
           return result
         end
         
-        detail = eval_internal(flag, user, result, event_factory)
+        detail = eval_internal(flag, user, result)
         if !result.big_segments_status.nil?
           # If big_segments_status is non-nil at the end of the evaluation, it means a query was done at
           # some point and we will want to include the status in the evaluation reason.
@@ -80,12 +85,12 @@ module LaunchDarkly
 
       private
       
-      def eval_internal(flag, user, state, event_factory)
+      def eval_internal(flag, user, state)
         if !flag[:on]
           return get_off_value(flag, EvaluationReason::off)
         end
 
-        prereq_failure_reason = check_prerequisites(flag, user, state, event_factory)
+        prereq_failure_reason = check_prerequisites(flag, user, state)
         if !prereq_failure_reason.nil?
           return get_off_value(flag, prereq_failure_reason)
         end
@@ -118,7 +123,7 @@ module LaunchDarkly
         return EvaluationDetail.new(nil, nil, EvaluationReason::fallthrough)
       end
 
-      def check_prerequisites(flag, user, state, event_factory)
+      def check_prerequisites(flag, user, state)
         (flag[:prerequisites] || []).each do |prerequisite|
           prereq_ok = true
           prereq_key = prerequisite[:key]
@@ -129,15 +134,15 @@ module LaunchDarkly
             prereq_ok = false
           else
             begin
-              prereq_res = eval_internal(prereq_flag, user, state, event_factory)
+              prereq_res = eval_internal(prereq_flag, user, state)
               # Note that if the prerequisite flag is off, we don't consider it a match no matter what its
               # off variation was. But we still need to evaluate it in order to generate an event.
               if !prereq_flag[:on] || prereq_res.variation_index != prerequisite[:variation]
                 prereq_ok = false
               end
-              event = event_factory.new_eval_event(prereq_flag, user, prereq_res, nil, flag)
-              state.events = [] if state.events.nil?
-              state.events.push(event)
+              prereq_eval = PrerequisiteEvalRecord.new(prereq_flag, flag, prereq_res)
+              state.prereq_evals = [] if state.prereq_evals.nil?
+              state.prereq_evals.push(prereq_eval)
             rescue => exn
               Util.log_exception(@logger, "Error evaluating prerequisite flag \"#{prereq_key}\" for flag \"#{flag[:key]}\"", exn)
               prereq_ok = false

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

@@ -0,0 +1,63 @@
+require "ldclient-rb/impl/event_types"
+
+module LaunchDarkly
+  module Impl
+    EventSummary = Struct.new(:start_date, :end_date, :counters)
+
+    EventSummaryFlagInfo = Struct.new(:default, :versions)
+
+    EventSummaryFlagVariationCounter = Struct.new(:value, :count)
+
+    # Manages the state of summarizable information for the EventProcessor, including the
+    # event counters and user deduplication. Note that the methods of this class are
+    # deliberately not thread-safe; the EventProcessor is responsible for enforcing
+    # synchronization across both the summarizer and the event queue.
+    class EventSummarizer
+      class Counter
+      end
+
+      def initialize
+        clear
+      end
+
+      # Adds this event to our counters, if it is a type of event we need to count.
+      def summarize_event(event)
+        return if !event.is_a?(LaunchDarkly::Impl::EvalEvent)
+
+        counters_for_flag = @counters[event.key]
+        if counters_for_flag.nil?
+          counters_for_flag = EventSummaryFlagInfo.new(event.default, Hash.new)
+          @counters[event.key] = counters_for_flag
+        end
+        counters_for_flag_version = counters_for_flag.versions[event.version]
+        if counters_for_flag_version.nil?
+          counters_for_flag_version = Hash.new
+          counters_for_flag.versions[event.version] = counters_for_flag_version
+        end
+        variation_counter = counters_for_flag_version[event.variation]
+        if variation_counter.nil?
+          counters_for_flag_version[event.variation] = EventSummaryFlagVariationCounter.new(event.value, 1)
+        else
+          variation_counter.count = variation_counter.count + 1
+        end
+        time = event.timestamp
+        if !time.nil?
+          @start_date = time if @start_date == 0 || time < @start_date
+          @end_date = time if time > @end_date
+        end
+      end
+
+      # Returns a snapshot of the current summarized event data, and resets this state.
+      def snapshot
+        ret = EventSummary.new(@start_date, @end_date, @counters)
+        ret
+      end
+
+      def clear
+        @start_date = 0
+        @end_date = 0
+        @counters = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+module LaunchDarkly
+  module Impl
+    class Event
+      def initialize(timestamp, user)
+        @timestamp = timestamp
+        @user = user
+      end
+
+      attr_reader :timestamp
+      attr_reader :kind
+      attr_reader :user
+    end
+
+    class EvalEvent < Event
+      def initialize(timestamp, user, key, version = nil, variation = nil, value = nil, reason = nil, default = nil,
+        track_events = false, debug_until = nil, prereq_of = nil)
+        super(timestamp, user)
+        @key = key
+        @version = version
+        @variation = variation
+        @value = value
+        @reason = reason
+        @default = default
+        # avoid setting rarely-used attributes if they have no value - this saves a little space per instance
+        @track_events = track_events if track_events
+        @debug_until = debug_until if debug_until
+        @prereq_of = prereq_of if prereq_of
+      end
+
+      attr_reader :key
+      attr_reader :version
+      attr_reader :variation
+      attr_reader :value
+      attr_reader :reason
+      attr_reader :default
+      attr_reader :track_events
+      attr_reader :debug_until
+      attr_reader :prereq_of
+    end
+
+    class IdentifyEvent < Event
+      def initialize(timestamp, user)
+        super(timestamp, user)
+      end
+    end
+
+    class CustomEvent < Event
+      def initialize(timestamp, user, key, data = nil, metric_value = nil)
+        super(timestamp, user)
+        @key = key
+        @data = data if !data.nil?
+        @metric_value = metric_value if !metric_value.nil?
+      end
+
+      attr_reader :key
+      attr_reader :data
+      attr_reader :metric_value
+    end
+
+    class AliasEvent < Event
+      def initialize(timestamp, key, context_kind, previous_key, previous_context_kind)
+        super(timestamp, nil)
+        @key = key
+        @context_kind = context_kind
+        @previous_key = previous_key
+        @previous_context_kind = previous_context_kind
+      end
+
+      attr_reader :key
+      attr_reader :context_kind
+      attr_reader :previous_key
+      attr_reader :previous_context_kind
+    end
+
+    class IndexEvent < Event
+      def initialize(timestamp, user)
+        super(timestamp, user)
+      end
+    end
+
+    class DebugEvent < Event
+      def initialize(eval_event)
+        super(eval_event.timestamp, eval_event.user)
+        @eval_event = eval_event
+      end
+
+      attr_reader :eval_event
+    end
+  end
+end

data/lib/ldclient-rb/ldclient.rb

@@ -1,7 +1,6 @@
 require "ldclient-rb/impl/big_segments"
 require "ldclient-rb/impl/diagnostic_events"
 require "ldclient-rb/impl/evaluator"
-require "ldclient-rb/impl/event_factory"
 require "ldclient-rb/impl/store_client_wrapper"
 require "concurrent/atomics"
 require "digest/sha1"
@@ -46,9 +45,6 @@ module LaunchDarkly
 
       @sdk_key = sdk_key
 
-      @event_factory_default = EventFactory.new(false)
-      @event_factory_with_reasons = EventFactory.new(true)
-
       # We need to wrap the feature store object with a FeatureStoreClientWrapper in order to add
       # some necessary logic around updates. Unfortunately, we have code elsewhere that accesses
       # the feature store through the Config object, so we need to make a new Config that uses
@@ -202,7 +198,7 @@ module LaunchDarkly
     # @return the variation to show the user, or the default value if there's an an error
     #
     def variation(key, user, default)
-      evaluate_internal(key, user, default, @event_factory_default).value
+      evaluate_internal(key, user, default, false).value
     end
 
     #
@@ -229,7 +225,7 @@ module LaunchDarkly
     # @return [EvaluationDetail] an object describing the result
     #
     def variation_detail(key, user, default)
-      evaluate_internal(key, user, default, @event_factory_with_reasons)
+      evaluate_internal(key, user, default, true)
     end
 
     #
@@ -253,7 +249,7 @@ module LaunchDarkly
         return
       end
       sanitize_user(user)
-      @event_processor.add_event(@event_factory_default.new_identify_event(user))
+      @event_processor.record_identify_event(user)
     end
 
     #
@@ -284,7 +280,7 @@ module LaunchDarkly
         return
       end
       sanitize_user(user)
-      @event_processor.add_event(@event_factory_default.new_custom_event(event_name, user, data, metric_value))
+      @event_processor.record_custom_event(user, event_name, data, metric_value)
     end
 
     #
@@ -301,7 +297,7 @@ module LaunchDarkly
       end
       sanitize_user(current_context)
       sanitize_user(previous_context)
-      @event_processor.add_event(@event_factory_default.new_alias_event(current_context, previous_context))
+      @event_processor.record_alias_event(current_context, previous_context)
     end
 
     #
@@ -368,13 +364,13 @@ module LaunchDarkly
           next
         end
         begin
-          detail = @evaluator.evaluate(f, user, @event_factory_default).detail
+          detail = @evaluator.evaluate(f, user).detail
         rescue => exn
           detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_EXCEPTION))
           Util.log_exception(@config.logger, "Error evaluating flag \"#{k}\" in all_flags_state", exn)
         end
 
-        requires_experiment_data = EventFactory.is_experiment(f, detail.reason)
+        requires_experiment_data = is_experiment(f, detail.reason)
         flag_state = {
           key: f[:key],
           value: detail.value,
@@ -430,7 +426,7 @@ module LaunchDarkly
     end
 
     # @return [EvaluationDetail]
-    def evaluate_internal(key, user, default, event_factory)
+    def evaluate_internal(key, user, default, with_reasons)
       if @config.offline?
         return Evaluator.error_result(EvaluationReason::ERROR_CLIENT_NOT_READY, default)
       end
@@ -453,7 +449,7 @@ module LaunchDarkly
         else
           @config.logger.error { "[LDClient] Client has not finished initializing; feature store unavailable, returning default value" }
           detail = Evaluator.error_result(EvaluationReason::ERROR_CLIENT_NOT_READY, default)
-          @event_processor.add_event(event_factory.new_unknown_flag_event(key, user, default, detail.reason))
+          record_unknown_flag_eval(key, user, default, detail.reason, with_reasons)
           return  detail
         end
       end
@@ -463,32 +459,94 @@ module LaunchDarkly
       if feature.nil?
         @config.logger.info { "[LDClient] Unknown feature flag \"#{key}\". Returning default value" }
         detail = Evaluator.error_result(EvaluationReason::ERROR_FLAG_NOT_FOUND, default)
-        @event_processor.add_event(event_factory.new_unknown_flag_event(key, user, default, detail.reason))
+        record_unknown_flag_eval(key, user, default, detail.reason, with_reasons)
         return detail
       end
 
       begin
-        res = @evaluator.evaluate(feature, user, event_factory)
-        if !res.events.nil?
-          res.events.each do |event|
-            @event_processor.add_event(event)
+        res = @evaluator.evaluate(feature, user)
+        if !res.prereq_evals.nil?
+          res.prereq_evals.each do |prereq_eval|
+            record_prereq_flag_eval(prereq_eval.prereq_flag, prereq_eval.prereq_of_flag, user, prereq_eval.detail, with_reasons)
           end
         end
         detail = res.detail
         if detail.default_value?
           detail = EvaluationDetail.new(default, nil, detail.reason)
         end
-        @event_processor.add_event(event_factory.new_eval_event(feature, user, detail, default))
+        record_flag_eval(feature, user, detail, default, with_reasons)
         return detail
       rescue => exn
         Util.log_exception(@config.logger, "Error evaluating feature flag \"#{key}\"", exn)
         detail = Evaluator.error_result(EvaluationReason::ERROR_EXCEPTION, default)
-        @event_processor.add_event(event_factory.new_default_event(feature, user, default, detail.reason))
+        record_flag_eval_error(feature, user, default, detail.reason, with_reasons)
         return detail
       end
     end
 
-    def sanitize_user(user)
+    private def record_flag_eval(flag, user, detail, default, with_reasons)
+      add_experiment_data = is_experiment(flag, detail.reason)
+      @event_processor.record_eval_event(
+        user,
+        flag[:key],
+        flag[:version],
+        detail.variation_index,
+        detail.value,
+        (add_experiment_data || with_reasons) ? detail.reason : nil,
+        default,
+        add_experiment_data || flag[:trackEvents] || false,
+        flag[:debugEventsUntilDate],
+        nil
+      )
+    end
+    
+    private def record_prereq_flag_eval(prereq_flag, prereq_of_flag, user, detail, with_reasons)
+      add_experiment_data = is_experiment(prereq_flag, detail.reason)
+      @event_processor.record_eval_event(
+        user,
+        prereq_flag[:key],
+        prereq_flag[:version],
+        detail.variation_index,
+        detail.value,
+        (add_experiment_data || with_reasons) ? detail.reason : nil,
+        nil,
+        add_experiment_data || prereq_flag[:trackEvents] || false,
+        prereq_flag[:debugEventsUntilDate],
+        prereq_of_flag[:key]
+      )
+    end
+    
+    private def record_flag_eval_error(flag, user, default, reason, with_reasons)
+      @event_processor.record_eval_event(user, flag[:key], flag[:version], nil, default, with_reasons ? reason : nil, default,
+        flag[:trackEvents], flag[:debugEventsUntilDate], nil)
+    end
+
+    private def record_unknown_flag_eval(flag_key, user, default, reason, with_reasons)
+      @event_processor.record_eval_event(user, flag_key, nil, nil, default, with_reasons ? reason : nil, default,
+        false, nil, nil)
+    end
+
+    private def is_experiment(flag, reason)
+      return false if !reason
+
+      if reason.in_experiment
+        return true
+      end
+
+      case reason[:kind]
+      when 'RULE_MATCH'
+        index = reason[:ruleIndex]
+        if !index.nil?
+          rules = flag[:rules] || []
+          return index >= 0 && index < rules.length && rules[index][:trackEvents]
+        end
+      when 'FALLTHROUGH'
+        return !!flag[:trackEventsFallthrough]
+      end
+      false
+    end
+
+    private def sanitize_user(user)
       if user[:key]
         user[:key] = user[:key].to_s
       end

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "6.3.3"
+  VERSION = "6.3.4"
 end

data/lib/ldclient-rb.rb

@@ -21,7 +21,6 @@ require "ldclient-rb/polling"
 require "ldclient-rb/user_filter"
 require "ldclient-rb/simple_lru_cache"
 require "ldclient-rb/non_blocking_thread_pool"
-require "ldclient-rb/event_summarizer"
 require "ldclient-rb/events"
 require "ldclient-rb/requestor"
 require "ldclient-rb/file_data_source"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly-server-sdk
 version: !ruby/object:Gem::Version
-  version: 6.3.3
+  version: 6.3.4
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -254,7 +254,6 @@ files:
 - lib/ldclient-rb/cache_store.rb
 - lib/ldclient-rb/config.rb
 - lib/ldclient-rb/evaluation_detail.rb
-- lib/ldclient-rb/event_summarizer.rb
 - lib/ldclient-rb/events.rb
 - lib/ldclient-rb/expiring_cache.rb
 - lib/ldclient-rb/file_data_source.rb
@@ -265,8 +264,9 @@ files:
 - lib/ldclient-rb/impl/evaluator.rb
 - lib/ldclient-rb/impl/evaluator_bucketing.rb
 - lib/ldclient-rb/impl/evaluator_operators.rb
-- lib/ldclient-rb/impl/event_factory.rb
 - lib/ldclient-rb/impl/event_sender.rb
+- lib/ldclient-rb/impl/event_summarizer.rb
+- lib/ldclient-rb/impl/event_types.rb
 - lib/ldclient-rb/impl/integrations/consul_impl.rb
 - lib/ldclient-rb/impl/integrations/dynamodb_impl.rb
 - lib/ldclient-rb/impl/integrations/file_data_source.rb
@@ -319,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.3.17
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby

data/lib/ldclient-rb/event_summarizer.rb

@@ -1,55 +0,0 @@
-
-module LaunchDarkly
-  # @private
-  EventSummary = Struct.new(:start_date, :end_date, :counters)
-
-  # Manages the state of summarizable information for the EventProcessor, including the
-  # event counters and user deduplication. Note that the methods of this class are
-  # deliberately not thread-safe; the EventProcessor is responsible for enforcing
-  # synchronization across both the summarizer and the event queue.
-  #
-  # @private
-  class EventSummarizer
-    def initialize
-      clear
-    end
-
-    # Adds this event to our counters, if it is a type of event we need to count.
-    def summarize_event(event)
-      if event[:kind] == "feature"
-        counter_key = {
-          key: event[:key],
-          version: event[:version],
-          variation: event[:variation]
-        }
-        c = @counters[counter_key]
-        if c.nil?
-          @counters[counter_key] = {
-            value: event[:value],
-            default: event[:default],
-            count: 1
-          }
-        else
-          c[:count] = c[:count] + 1
-        end
-        time = event[:creationDate]
-        if !time.nil?
-          @start_date = time if @start_date == 0 || time < @start_date
-          @end_date = time if time > @end_date
-        end
-      end
-    end
-
-    # Returns a snapshot of the current summarized event data, and resets this state.
-    def snapshot
-      ret = EventSummary.new(@start_date, @end_date, @counters)
-      ret
-    end
-
-    def clear
-      @start_date = 0
-      @end_date = 0
-      @counters = {}
-    end
-  end
-end

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

@@ -1,123 +0,0 @@
-
-module LaunchDarkly
-  module Impl
-    # Event constructors are centralized here to avoid mistakes and repetitive logic.
-    # The LDClient owns two instances of EventFactory: one that always embeds evaluation reasons
-    # in the events (for when variation_detail is called) and one that doesn't.
-    #
-    # Note that these methods do not set the "creationDate" property, because in the Ruby client,
-    # that is done by EventProcessor.add_event().
-    class EventFactory
-      def initialize(with_reasons)
-        @with_reasons = with_reasons
-      end
-
-      def new_eval_event(flag, user, detail, default_value, prereq_of_flag = nil)
-        add_experiment_data = self.class.is_experiment(flag, detail.reason)
-        e = {
-          kind: 'feature',
-          key: flag[:key],
-          user: user,
-          variation: detail.variation_index,
-          value: detail.value,
-          default: default_value,
-          version: flag[:version]
-        }
-        # the following properties are handled separately so we don't waste bandwidth on unused keys
-        e[:trackEvents] = true if add_experiment_data || flag[:trackEvents]
-        e[:debugEventsUntilDate] = flag[:debugEventsUntilDate] if flag[:debugEventsUntilDate]
-        e[:prereqOf] = prereq_of_flag[:key] if !prereq_of_flag.nil?
-        e[:reason] = detail.reason if add_experiment_data || @with_reasons
-        e[:contextKind] = context_to_context_kind(user) if !user.nil? && user[:anonymous]
-        e
-      end
-
-      def new_default_event(flag, user, default_value, reason)
-        e = {
-          kind: 'feature',
-          key: flag[:key],
-          user: user,
-          value: default_value,
-          default: default_value,
-          version: flag[:version]
-        }
-        e[:trackEvents] = true if flag[:trackEvents]
-        e[:debugEventsUntilDate] = flag[:debugEventsUntilDate] if flag[:debugEventsUntilDate]
-        e[:reason] = reason if @with_reasons
-        e[:contextKind] = context_to_context_kind(user) if !user.nil? && user[:anonymous]
-        e
-      end
-
-      def new_unknown_flag_event(key, user, default_value, reason)
-        e = {
-          kind: 'feature',
-          key: key,
-          user: user,
-          value: default_value,
-          default: default_value
-        }
-        e[:reason] = reason if @with_reasons
-        e[:contextKind] = context_to_context_kind(user) if !user.nil? && user[:anonymous]
-        e
-      end
-
-      def new_identify_event(user)
-        {
-          kind: 'identify',
-          key: user[:key],
-          user: user
-        }
-      end
-
-      def new_alias_event(current_context, previous_context)
-        {
-          kind: 'alias',
-          key: current_context[:key],
-          contextKind: context_to_context_kind(current_context),
-          previousKey: previous_context[:key],
-          previousContextKind: context_to_context_kind(previous_context)
-        }
-      end
-
-      def new_custom_event(event_name, user, data, metric_value)
-        e = {
-          kind: 'custom',
-          key: event_name,
-          user: user
-        }
-        e[:data] = data if !data.nil?
-        e[:metricValue] = metric_value if !metric_value.nil?
-        e[:contextKind] = context_to_context_kind(user) if !user.nil? && user[:anonymous]
-        e
-      end
-
-      def self.is_experiment(flag, reason)
-        return false if !reason
-
-        if reason.in_experiment
-          return true
-        end
-
-        case reason[:kind]
-        when 'RULE_MATCH'
-          index = reason[:ruleIndex]
-          if !index.nil?
-            rules = flag[:rules] || []
-            return index >= 0 && index < rules.length && rules[index][:trackEvents]
-          end
-        when 'FALLTHROUGH'
-          return !!flag[:trackEventsFallthrough]
-        end
-        false
-      end
-
-      private def context_to_context_kind(user)
-        if !user.nil? && user[:anonymous]
-          return "anonymousUser"
-        else
-          return "user"
-        end
-      end
-    end
-  end
-end