fix: Reduce overzealous index event emission

Author: keelerm84

contract-tests/service.rb

@@ -41,6 +41,7 @@
       'context-comparison',
       'polling-gzip',
       'inline-context-all',
+      'reduce-index-events',
       'anonymous-redaction',
       'evaluation-hooks',
       'omit-anonymous-contexts',

lib/ldclient-rb/events.rb

@@ -321,24 +321,23 @@ def dispatch_event(event, outbox)
         will_add_full_event = true
       end
 
-      get_indexable_context(event) do |ctx|
+      suppress_index = (will_add_full_event or !debug_event.nil?)
+      get_indexable_context(event, suppress_index) 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)
+    private def get_indexable_context(event, suppress_index, &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::CustomEvent)
-      return if event.is_a?(LaunchDarkly::Impl::MigrationOpEvent)
+      return if suppress_index
 
       yield context unless block.nil?
     end

spec/events_spec.rb

@@ -79,7 +79,6 @@ module LaunchDarkly
 
           output = flush_and_get_events(ep, sender)
           expect(output).to contain_exactly(
-            eq(index_event(default_config, anon_context)),
             eq(feature_event(default_config, flag, anon_context, 1, 'value')),
             include(:kind => "summary")
           )
@@ -113,7 +112,6 @@ module LaunchDarkly
 
           output = flush_and_get_events(ep, sender)
           expect(output).to contain_exactly(
-            eq(index_event(omit_anonymous_contexts_config, context)),
             eq(feature_event(omit_anonymous_contexts_config, flag, multi, 1, 'value')),
             include(:kind => "summary")
           )
@@ -170,14 +168,13 @@ module LaunchDarkly
       end
     end
 
-    it "queues individual feature event with index event" do
+    it "does not queue index event when tracking event" do
       with_processor_and_sender(default_config, starting_timestamp) do |ep, sender|
         flag = { key: "flagkey", version: 11 }
         ep.record_eval_event(context, 'flagkey', 11, 1, 'value', nil, nil, true)
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(default_config, context)),
           eq(feature_event(default_config, flag, context, 1, 'value')),
           include(:kind => "summary")
         )
@@ -191,7 +188,6 @@ module LaunchDarkly
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(default_config, context)),
           include(:kind => "summary")
         )
       end
@@ -205,7 +201,6 @@ module LaunchDarkly
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(default_config, context)),
           eq(feature_event(default_config, flag, context, 1, 'value'))
         )
       end
@@ -215,12 +210,11 @@ module LaunchDarkly
       config = Config.new(default_config_opts.merge(all_attributes_private: true))
       with_processor_and_sender(config, starting_timestamp) do |ep, sender|
         flag = { key: "flagkey", version: 11 }
-        ep.record_eval_event(context, 'flagkey', 11, 1, 'value', nil, nil, true)
+        ep.record_eval_event(context, 'flagkey', 11, 1, 'value', nil, nil, false)
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
           eq(index_event(config, context)),
-          eq(feature_event(config, flag, context, 1, 'value')),
           include(:kind => "summary")
         )
       end
@@ -234,7 +228,6 @@ module LaunchDarkly
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(config, context)),
           eq(feature_event(config, flag, context, 1, 'value')),
           include(:kind => "summary")
         )
@@ -249,7 +242,6 @@ module LaunchDarkly
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(default_config, context)),
           eq(debug_event(default_config, flag, context, 1, 'value')),
           include(:kind => "summary")
         )
@@ -264,7 +256,6 @@ module LaunchDarkly
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(default_config, context)),
           include(:kind => "summary")
         )
       end
@@ -278,7 +269,6 @@ module LaunchDarkly
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
-          eq(index_event(default_config, context)),
           eq(feature_event(default_config, flag, context, 1, 'value')),
           eq(debug_event(default_config, flag, context, 1, 'value')),
           include(:kind => "summary")
@@ -338,14 +328,12 @@ module LaunchDarkly
         flag1 = { key: "flagkey1", version: 11 }
         flag2 = { key: "flagkey2", version: 22 }
 
-        ep.record_eval_event(context, 'flagkey1', 11, 1, 'value', nil, nil, true)
-        ep.record_eval_event(context, 'flagkey2', 22, 1, 'value', nil, nil, true)
+        ep.record_eval_event(context, 'flagkey1', 11, 1, 'value', nil, nil, false)
+        ep.record_eval_event(context, 'flagkey2', 22, 1, 'value', nil, nil, false)
 
         output = flush_and_get_events(ep, sender)
         expect(output).to contain_exactly(
           eq(index_event(default_config, context)),
-          eq(feature_event(default_config, flag1, context, 1, 'value', starting_timestamp)),
-          eq(feature_event(default_config, flag2, context, 1, 'value', starting_timestamp + 1)),
           include(:kind => "summary")
         )
       end