Remove inline user configuration option (#223)

Author: keelerm84

contract-tests/client_entity.rb

@@ -31,7 +31,6 @@ def initialize(log, config)
       opts[:all_attributes_private]  = !!events[:allAttributesPrivate]
       opts[:private_attribute_names] = events[:globalPrivateAttributes]
       opts[:flush_interval] = (events[:flushIntervalMs] / 1_000) unless events[:flushIntervalMs].nil?
-      opts[:inline_users_in_events] = events[:inlineUsers] || false
     else
       opts[:send_events] = false
     end

lib/ldclient-rb/config.rb

@@ -34,7 +34,6 @@ class Config
     # @option opts [Boolean] :send_events (true) See {#send_events}.
     # @option opts [Integer] :user_keys_capacity (1000) See {#user_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 [Object] :data_source See {#data_source}.
     # @option opts [Boolean] :diagnostic_opt_out (false) See {#diagnostic_opt_out?}.
     # @option opts [Float] :diagnostic_recording_interval (900) See {#diagnostic_recording_interval}.
@@ -65,7 +64,6 @@ def initialize(opts = {})
       @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]
       @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 ?
@@ -249,14 +247,6 @@ def offline?
     #
     attr_reader :user_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]
-    #
-    attr_reader :inline_users_in_events
-
     #
     # An object that is responsible for receiving feature flag data from LaunchDarkly. By default,
     # the client uses its standard polling or streaming implementation; this is customizable for

lib/ldclient-rb/events.rb

@@ -311,12 +311,10 @@ def dispatch_event(event, outbox)
         will_add_full_event = true
       end
 
-      # For each user we haven't seen before, we add an index event - unless this is already
-      # an identify event for that user.
-      unless will_add_full_event && @config.inline_users_in_events
-        if !event.context.nil? && !notice_context(event.context) && !event.is_a?(LaunchDarkly::Impl::IdentifyEvent)
-          outbox.add_event(LaunchDarkly::Impl::IndexEvent.new(event.timestamp, event.context))
-        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)
+        outbox.add_event(LaunchDarkly::Impl::IndexEvent.new(event.timestamp, event.context))
       end
 
       outbox.add_event(event) if will_add_full_event
@@ -453,7 +451,6 @@ class EventOutputFormatter
     ANONYMOUS_USER_CONTEXT_KIND = 'anonymousUser'
 
     def initialize(config)
-      @inline_users = config.inline_users_in_events
       @context_filter = LaunchDarkly::Impl::ContextFilter.new(config.all_attributes_private, config.private_attribute_names)
     end
 
@@ -560,18 +557,5 @@ def make_output_events(events, summary)
         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] = @context_filter.filter(user)
-      else
-        key = user[:key]
-        out[:userKey] = key.is_a?(String) ? key : key.to_s
-      end
-    end
   end
 end

lib/ldclient-rb/impl/context.rb

@@ -1,3 +1,5 @@
+require "erb"
+
 module LaunchDarkly
   module Impl
     module Context

lib/ldclient-rb/impl/diagnostic_events.rb

@@ -73,7 +73,6 @@ def self.make_config_data(config)
           diagnosticRecordingIntervalMillis: self.seconds_to_millis(config.diagnostic_recording_interval),
           eventsCapacity: config.capacity,
           eventsFlushIntervalMillis: self.seconds_to_millis(config.flush_interval),
-          inlineUsersInEvents: config.inline_users_in_events,
           pollingIntervalMillis: self.seconds_to_millis(config.poll_interval),
           socketTimeoutMillis: self.seconds_to_millis(config.read_timeout),
           streamingDisabled: !config.stream?,

spec/diagnostic_events_spec.rb

@@ -31,7 +31,6 @@ def expected_default_config
             diagnosticRecordingIntervalMillis: Config.default_diagnostic_recording_interval * 1000,
             eventsCapacity: Config.default_capacity,
             eventsFlushIntervalMillis: Config.default_flush_interval * 1000,
-            inlineUsersInEvents: false,
             pollingIntervalMillis: Config.default_poll_interval * 1000,
             socketTimeoutMillis: Config.default_read_timeout * 1000,
             streamingDisabled: false,
@@ -64,7 +63,6 @@ def expected_default_config
             [ { diagnostic_recording_interval: 9999 }, { diagnosticRecordingIntervalMillis: 9999000 } ],
             [ { capacity: 4000 }, { eventsCapacity: 4000 } ],
             [ { flush_interval: 46 }, { eventsFlushIntervalMillis: 46000 } ],
-            [ { inline_users_in_events: true }, { inlineUsersInEvents: true } ],
             [ { poll_interval: 999 }, { pollingIntervalMillis: 999000 } ],
             [ { read_timeout: 46 }, { socketTimeoutMillis: 46000 } ],
             [ { stream: false }, { streamingDisabled: true } ],

spec/events_spec.rb

@@ -80,27 +80,15 @@ def with_processor_and_sender(config)
   end
 
   it "filters context in feature event" do
-    config = LaunchDarkly::Config.new(default_config_opts.merge(all_attributes_private: true, inline_users_in_events: true))
+    config = LaunchDarkly::Config.new(default_config_opts.merge(all_attributes_private: true))
     with_processor_and_sender(config) 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(feature_event(flag, context, 1, 'value', true)),
-        include(:kind => "summary")
-      )
-    end
-  end
-
-  it "still generates index event if inline_users is true but feature event was not tracked" do
-    config = LaunchDarkly::Config.new(default_config_opts.merge(inline_users_in_events: true))
-    with_processor_and_sender(config) do |ep, sender|
-      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(flag, context, 1, 'value')),
         include(:kind => "summary")
       )
     end
@@ -197,8 +185,8 @@ def with_processor_and_sender(config)
       output = flush_and_get_events(ep, sender)
       expect(output).to contain_exactly(
         eq(index_event(default_config, context)),
-        eq(feature_event(flag1, context, 1, 'value', false, starting_timestamp)),
-        eq(feature_event(flag2, context, 1, 'value', false, starting_timestamp + 1)),
+        eq(feature_event(flag1, context, 1, 'value', starting_timestamp)),
+        eq(feature_event(flag2, context, 1, 'value', starting_timestamp + 1)),
         include(:kind => "summary")
       )
     end
@@ -250,13 +238,14 @@ def with_processor_and_sender(config)
   end
 
   it "filters context in custom event" do
-    config = LaunchDarkly::Config.new(default_config_opts.merge(all_attributes_private: true, inline_users_in_events: true))
+    config = LaunchDarkly::Config.new(default_config_opts.merge(all_attributes_private: true))
     with_processor_and_sender(config) do |ep, sender|
       ep.record_custom_event(context, 'eventkey')
 
       output = flush_and_get_events(ep, sender)
       expect(output).to contain_exactly(
-        eq(custom_event(context, 'eventkey', nil, nil, true))
+        eq(index_event(config, context)),
+        eq(custom_event(context, 'eventkey', nil, nil))
       )
     end
   end
@@ -421,7 +410,7 @@ def identify_event(config, context, timestamp = starting_timestamp)
   # @param timestamp [Integer]
   # @return [Hash]
   #
-  def feature_event(flag, context, variation, value, inline_user = false, timestamp = starting_timestamp)
+  def feature_event(flag, context, variation, value, timestamp = starting_timestamp)
     out = {
       kind: 'feature',
       creationDate: timestamp,
@@ -462,13 +451,12 @@ def debug_event(config, flag, context, variation, value, timestamp = starting_ti
   # @param key [String]
   # @param data [any]
   # @param metric_value [any]
-  # @param timestamp [Integer]
   # @return [Hash]
   #
-  def custom_event(context, key, data, metric_value, inline_user = false, timestamp = starting_timestamp)
+  def custom_event(context, key, data, metric_value)
     out = {
       kind: "custom",
-      creationDate: timestamp,
+      creationDate: starting_timestamp,
       contextKeys: context.keys,
       key: key,
     }