fix: Reduce overzealous index event emission

Author: keelerm84

contract-tests/service.py

@@ -74,6 +74,7 @@ def status():
             'event-sampling',
             'polling-gzip',
             'inline-context-all',
+            'reduce-index-events',
             'anonymous-redaction',
             'evaluation-hooks',
             'omit-anonymous-contexts',

ldclient/impl/events/event_processor.py

@@ -358,15 +358,16 @@ def _process_event(self, event: EventInput):
         elif isinstance(event, MigrationOpEvent):
             full_event = event
 
-        self._get_indexable_context(event, lambda c: self._outbox.add_event(IndexEvent(event.timestamp, c)))
+        suppress_index = full_event is not None or debug_event is not None
+        self._get_indexable_context(event, suppress_index, lambda c: self._outbox.add_event(IndexEvent(event.timestamp, c)))
 
         if full_event and self._sampler.sample(sampling_ratio):
             self._outbox.add_event(full_event)
 
         if debug_event and self._sampler.sample(sampling_ratio):
             self._outbox.add_event(debug_event)
 
-    def _get_indexable_context(self, event: EventInput, block: Callable[[Context], None]):
+    def _get_indexable_context(self, event: EventInput, suppress_index: bool, block: Callable[[Context], None]):
         if event.context is None:
             return
 
@@ -381,7 +382,7 @@ def _get_indexable_context(self, event: EventInput, block: Callable[[Context], N
         if already_seen:
             self._deduplicated_contexts += 1
             return
-        elif isinstance(event, EventInputIdentify) or isinstance(event, MigrationOpEvent) or isinstance(event, EventInputCustom):
+        elif suppress_index:
             return
 
         block(context)

ldclient/testing/impl/events/test_event_processor.py

@@ -282,16 +282,15 @@ def test_omit_anonymous_contexts_strips_anonymous_contexts_correctly():
         check_identify_event(output[0], e, formatter.format_context(c))
 
 
-def test_individual_feature_event_is_queued_with_index_event():
+def test_no_index_emitted_for_tracked_evaluation():
     with DefaultTestProcessor() as ep:
         e = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value', None, 'default', None, True)
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 3
-        check_index_event(output[0], e)
-        check_feature_event(output[1], e)
-        check_summary_event(output[2])
+        assert len(output) == 2
+        check_feature_event(output[0], e)
+        check_summary_event(output[1])
 
 
 def test_omit_anonymous_context_emits_feature_event_without_index():
@@ -312,14 +311,13 @@ def test_omit_anonymous_context_strips_anonymous_from_index_event():
         b = Context.builder('b').kind('b').anonymous(True).build()
         c = Context.builder('c').kind('c').anonymous(False).build()
         mc = Context.multi_builder().add(a).add(b).add(c).build()
-        e = EventInputEvaluation(timestamp, mc, flag.key, flag, 1, 'value', None, 'default', None, True)
+        e = EventInputEvaluation(timestamp, mc, flag.key, flag, 1, 'value', None, 'default', None, False)
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 3
+        assert len(output) == 2
         check_index_event(output[0], e, c.to_dict())  # Should only contain non-anon context
-        check_feature_event(output[1], e)
-        check_summary_event(output[2])
+        check_summary_event(output[1])
 
 
 def test_individual_feature_event_is_ignored_for_0_sampling_ratio():
@@ -328,9 +326,8 @@ def test_individual_feature_event_is_ignored_for_0_sampling_ratio():
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 2
-        check_index_event(output[0], e)
-        check_summary_event(output[1])
+        assert len(output) == 1
+        check_summary_event(output[0])
 
 
 def test_exclude_can_keep_feature_event_from_summary():
@@ -339,54 +336,48 @@ def test_exclude_can_keep_feature_event_from_summary():
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 2
-        check_index_event(output[0], e)
-        check_feature_event(output[1], e)
+        assert len(output) == 1
+        check_feature_event(output[0], e)
 
 
 def test_context_is_filtered_in_index_event():
     with DefaultTestProcessor(all_attributes_private=True) as ep:
         formatter = EventContextFormatter(True, [])
-        e = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value', None, 'default', None, True)
+        e = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value', None, 'default', None, False)
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 3
+        assert len(output) == 2
         check_index_event(output[0], e, formatter.format_context(context))
-        check_feature_event(output[1], e, formatter.format_context(context))
-        check_summary_event(output[2])
+        check_summary_event(output[1])
 
 
 def test_two_events_for_same_context_only_produce_one_index_event():
     with DefaultTestProcessor(context_keys_flush_interval=300) as ep:
-        e0 = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value1', None, 'default', None, True)
-        e1 = EventInputEvaluation(timestamp, context, flag.key, flag, 2, 'value2', None, 'default', None, True)
+        e0 = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value1', None, 'default', None, False)
+        e1 = EventInputEvaluation(timestamp, context, flag.key, flag, 2, 'value2', None, 'default', None, False)
         ep.send_event(e0)
         ep.send_event(e1)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 4
+        assert len(output) == 2
         check_index_event(output[0], e0)
-        check_feature_event(output[1], e0)
-        check_feature_event(output[2], e1)
-        check_summary_event(output[3])
+        check_summary_event(output[1])
 
 
 def test_new_index_event_is_added_if_context_cache_has_been_cleared():
     with DefaultTestProcessor(context_keys_flush_interval=0.1) as ep:
-        e0 = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value1', None, 'default', None, True)
-        e1 = EventInputEvaluation(timestamp, context, flag.key, flag, 2, 'value2', None, 'default', None, True)
+        e0 = EventInputEvaluation(timestamp, context, flag.key, flag, 1, 'value1', None, 'default', None, False)
+        e1 = EventInputEvaluation(timestamp, context, flag.key, flag, 2, 'value2', None, 'default', None, False)
         ep.send_event(e0)
         time.sleep(0.2)
         ep.send_event(e1)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 5
+        assert len(output) == 3
         check_index_event(output[0], e0)
-        check_feature_event(output[1], e0)
-        check_index_event(output[2], e1)
-        check_feature_event(output[3], e1)
-        check_summary_event(output[4])
+        check_index_event(output[1], e1)
+        check_summary_event(output[2])
 
 
 def test_event_kind_is_debug_if_flag_is_temporarily_in_debug_mode():
@@ -397,10 +388,9 @@ def test_event_kind_is_debug_if_flag_is_temporarily_in_debug_mode():
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 3
-        check_index_event(output[0], e)
-        check_debug_event(output[1], e)
-        check_summary_event(output[2])
+        assert len(output) == 2
+        check_debug_event(output[0], e)
+        check_summary_event(output[1])
 
 
 def test_event_can_be_both_tracked_and_debugged():
@@ -411,11 +401,10 @@ def test_event_can_be_both_tracked_and_debugged():
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 4
-        check_index_event(output[0], e)
-        check_feature_event(output[1], e)
-        check_debug_event(output[2], e)
-        check_summary_event(output[3])
+        assert len(output) == 3
+        check_feature_event(output[0], e)
+        check_debug_event(output[1], e)
+        check_summary_event(output[2])
 
 
 def test_debug_event_can_be_disabled_with_sampling_ratio():
@@ -426,9 +415,8 @@ def test_debug_event_can_be_disabled_with_sampling_ratio():
         ep.send_event(e)
 
         output = flush_and_get_events(ep)
-        assert len(output) == 2
-        check_index_event(output[0], e)
-        check_summary_event(output[1])
+        assert len(output) == 1
+        check_summary_event(output[0])
 
 
 def test_debug_mode_does_not_expire_if_both_client_time_and_server_time_are_before_expiration_time():
@@ -450,10 +438,9 @@ def test_debug_mode_does_not_expire_if_both_client_time_and_server_time_are_befo
 
         # Should get a summary event only, not a full feature event
         output = flush_and_get_events(ep)
-        assert len(output) == 3
-        check_index_event(output[0], e)
-        check_debug_event(output[1], e)
-        check_summary_event(output[2])
+        assert len(output) == 2
+        check_debug_event(output[0], e)
+        check_summary_event(output[1])
 
 
 def test_debug_mode_expires_based_on_client_time_if_client_time_is_later_than_server_time():