optimizely-sdk 3.9.0 → 4.0.0

data/lib/optimizely/error_handler.rb

@@ -1,39 +1,39 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-2017, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-module Optimizely
-  class BaseErrorHandler
-    # Class encapsulating exception handling functionality.
-    # Override with your own exception handler providing a handle_error method.
-
-    def handle_error(_error); end
-  end
-
-  class NoOpErrorHandler < BaseErrorHandler
-    # Class providing handle_error method that suppresses errors.
-
-    def handle_error(_error); end
-  end
-
-  class RaiseErrorHandler < BaseErrorHandler
-    # Class providing a handle_error method that raises exceptions.
-
-    def handle_error(error)
-      raise error
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2017, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+module Optimizely
+  class BaseErrorHandler
+    # Class encapsulating exception handling functionality.
+    # Override with your own exception handler providing a handle_error method.
+
+    def handle_error(_error); end
+  end
+
+  class NoOpErrorHandler < BaseErrorHandler
+    # Class providing handle_error method that suppresses errors.
+
+    def handle_error(_error); end
+  end
+
+  class RaiseErrorHandler < BaseErrorHandler
+    # Class providing a handle_error method that raises exceptions.
+
+    def handle_error(error)
+      raise error
+    end
+  end
+end

data/lib/optimizely/event/batch_event_processor.rb

@@ -1,234 +1,235 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2019, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-require_relative 'event_processor'
-require_relative '../helpers/validator'
-module Optimizely
-  class BatchEventProcessor < EventProcessor
-    # BatchEventProcessor is a batched implementation of the Interface EventProcessor.
-    # Events passed to the BatchEventProcessor are immediately added to an EventQueue.
-    # The BatchEventProcessor maintains a single consumer thread that pulls events off of
-    # the BlockingQueue and buffers them for either a configured batch size or for a
-    # maximum duration before the resulting LogEvent is sent to the NotificationCenter.
-
-    attr_reader :event_queue, :event_dispatcher, :current_batch, :started, :batch_size, :flush_interval
-
-    DEFAULT_BATCH_SIZE = 10
-    DEFAULT_BATCH_INTERVAL = 30_000 # interval in milliseconds
-    DEFAULT_QUEUE_CAPACITY = 1000
-    DEFAULT_TIMEOUT_INTERVAL = 5 # interval in seconds
-
-    FLUSH_SIGNAL = 'FLUSH_SIGNAL'
-    SHUTDOWN_SIGNAL = 'SHUTDOWN_SIGNAL'
-
-    def initialize(
-      event_queue: SizedQueue.new(DEFAULT_QUEUE_CAPACITY),
-      event_dispatcher: nil,
-      batch_size: DEFAULT_BATCH_SIZE,
-      flush_interval: DEFAULT_BATCH_INTERVAL,
-      logger: NoOpLogger.new,
-      notification_center: nil
-    )
-      @event_queue = event_queue
-      @logger = logger
-      @event_dispatcher = event_dispatcher || EventDispatcher.new(logger: @logger)
-      @batch_size = if (batch_size.is_a? Integer) && positive_number?(batch_size)
-                      batch_size
-                    else
-                      @logger.log(Logger::DEBUG, "Setting to default batch_size: #{DEFAULT_BATCH_SIZE}.")
-                      DEFAULT_BATCH_SIZE
-                    end
-      @flush_interval = if positive_number?(flush_interval)
-                          flush_interval
-                        else
-                          @logger.log(Logger::DEBUG, "Setting to default flush_interval: #{DEFAULT_BATCH_INTERVAL} ms.")
-                          DEFAULT_BATCH_INTERVAL
-                        end
-      @notification_center = notification_center
-      @current_batch = []
-      @started = false
-      @stopped = false
-    end
-
-    def start!
-      if @started == true
-        @logger.log(Logger::WARN, 'Service already started.')
-        return
-      end
-      @flushing_interval_deadline = Helpers::DateTimeUtils.create_timestamp + @flush_interval
-      @logger.log(Logger::INFO, 'Starting scheduler.')
-      if @wait_mutex.nil?
-        @wait_mutex = Mutex.new
-        @resource = ConditionVariable.new
-      end
-      @thread = Thread.new { run_queue }
-      @started = true
-      @stopped = false
-    end
-
-    def flush
-      @event_queue << FLUSH_SIGNAL
-      @wait_mutex.synchronize { @resource.signal }
-    end
-
-    def process(user_event)
-      @logger.log(Logger::DEBUG, "Received userEvent: #{user_event}")
-
-      # if the processor has been explicitly stopped. Don't accept tasks
-      if @stopped
-        @logger.log(Logger::WARN, 'Executor shutdown, not accepting tasks.')
-        return
-      end
-
-      # start if the processor hasn't been started
-      start! unless @started
-
-      begin
-        @event_queue.push(user_event, true)
-        @wait_mutex.synchronize { @resource.signal }
-      rescue => e
-        @logger.log(Logger::WARN, 'Payload not accepted by the queue: ' + e.message)
-        return
-      end
-    end
-
-    def stop!
-      return unless @started
-
-      @logger.log(Logger::INFO, 'Stopping scheduler.')
-      @event_queue << SHUTDOWN_SIGNAL
-      @wait_mutex.synchronize { @resource.signal }
-      @thread.join(DEFAULT_TIMEOUT_INTERVAL)
-      @started = false
-      @stopped = true
-    end
-
-    private
-
-    def process_queue
-      while @event_queue.length.positive?
-        item = @event_queue.pop
-        if item == SHUTDOWN_SIGNAL
-          @logger.log(Logger::DEBUG, 'Received shutdown signal.')
-          return false
-        end
-
-        if item == FLUSH_SIGNAL
-          @logger.log(Logger::DEBUG, 'Received flush signal.')
-          flush_queue!
-          next
-        end
-
-        add_to_batch(item) if item.is_a? Optimizely::UserEvent
-      end
-      true
-    end
-
-    def run_queue
-      loop do
-        if Helpers::DateTimeUtils.create_timestamp >= @flushing_interval_deadline
-          @logger.log(Logger::DEBUG, 'Deadline exceeded flushing current batch.')
-
-          break unless process_queue
-
-          flush_queue!
-          @flushing_interval_deadline = Helpers::DateTimeUtils.create_timestamp + @flush_interval
-        end
-
-        break unless process_queue
-
-        # what is the current interval to flush in seconds
-        interval = (@flushing_interval_deadline - Helpers::DateTimeUtils.create_timestamp) * 0.001
-
-        next unless interval.positive?
-
-        @wait_mutex.synchronize { @resource.wait(@wait_mutex, interval) }
-      end
-    rescue SignalException
-      @logger.log(Logger::ERROR, 'Interrupted while processing buffer.')
-    rescue => e
-      @logger.log(Logger::ERROR, "Uncaught exception processing buffer. #{e.message}")
-    ensure
-      @logger.log(Logger::INFO, 'Exiting processing loop. Attempting to flush pending events.')
-      flush_queue!
-    end
-
-    def flush_queue!
-      return if @current_batch.empty?
-
-      log_event = Optimizely::EventFactory.create_log_event(@current_batch, @logger)
-      begin
-        @logger.log(
-          Logger::INFO,
-          'Flushing Queue.'
-        )
-
-        @event_dispatcher.dispatch_event(log_event)
-        @notification_center&.send_notifications(
-          NotificationCenter::NOTIFICATION_TYPES[:LOG_EVENT],
-          log_event
-        )
-      rescue StandardError => e
-        @logger.log(Logger::ERROR, "Error dispatching event: #{log_event} #{e.message}.")
-      end
-      @current_batch = []
-    end
-
-    def add_to_batch(user_event)
-      if should_split?(user_event)
-        flush_queue!
-        @current_batch = []
-      end
-
-      # Reset the deadline if starting a new batch.
-      @flushing_interval_deadline = (Helpers::DateTimeUtils.create_timestamp + @flush_interval) if @current_batch.empty?
-
-      @logger.log(Logger::DEBUG, "Adding user event: #{user_event} to batch.")
-      @current_batch << user_event
-      return unless @current_batch.length >= @batch_size
-
-      @logger.log(Logger::DEBUG, 'Flushing on max batch size.')
-      flush_queue!
-    end
-
-    def should_split?(user_event)
-      return false if @current_batch.empty?
-
-      current_context = @current_batch.last.event_context
-      new_context = user_event.event_context
-
-      # Revisions should match
-      unless current_context[:revision] == new_context[:revision]
-        @logger.log(Logger::DEBUG, 'Revisions mismatched: Flushing current batch.')
-        return true
-      end
-
-      # Projects should match
-      unless current_context[:project_id] == new_context[:project_id]
-        @logger.log(Logger::DEBUG, 'Project Ids mismatched: Flushing current batch.')
-        return true
-      end
-      false
-    end
-
-    def positive_number?(value)
-      # Returns true if the given value is positive finite number.
-      #   false otherwise.
-      Helpers::Validator.finite_number?(value) && value.positive?
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, 2022, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require_relative 'event_processor'
+require_relative '../helpers/validator'
+module Optimizely
+  class BatchEventProcessor < EventProcessor
+    # BatchEventProcessor is a batched implementation of the Interface EventProcessor.
+    # Events passed to the BatchEventProcessor are immediately added to an EventQueue.
+    # The BatchEventProcessor maintains a single consumer thread that pulls events off of
+    # the BlockingQueue and buffers them for either a configured batch size or for a
+    # maximum duration before the resulting LogEvent is sent to the NotificationCenter.
+
+    attr_reader :event_queue, :event_dispatcher, :current_batch, :started, :batch_size, :flush_interval
+
+    DEFAULT_BATCH_SIZE = 10
+    DEFAULT_BATCH_INTERVAL = 30_000 # interval in milliseconds
+    DEFAULT_QUEUE_CAPACITY = 1000
+    DEFAULT_TIMEOUT_INTERVAL = 5 # interval in seconds
+
+    FLUSH_SIGNAL = 'FLUSH_SIGNAL'
+    SHUTDOWN_SIGNAL = 'SHUTDOWN_SIGNAL'
+
+    def initialize(
+      event_queue: SizedQueue.new(DEFAULT_QUEUE_CAPACITY),
+      event_dispatcher: nil,
+      batch_size: DEFAULT_BATCH_SIZE,
+      flush_interval: DEFAULT_BATCH_INTERVAL,
+      logger: NoOpLogger.new,
+      notification_center: nil
+    )
+      super()
+      @event_queue = event_queue
+      @logger = logger
+      @event_dispatcher = event_dispatcher || EventDispatcher.new(logger: @logger)
+      @batch_size = if (batch_size.is_a? Integer) && positive_number?(batch_size)
+                      batch_size
+                    else
+                      @logger.log(Logger::DEBUG, "Setting to default batch_size: #{DEFAULT_BATCH_SIZE}.")
+                      DEFAULT_BATCH_SIZE
+                    end
+      @flush_interval = if positive_number?(flush_interval)
+                          flush_interval
+                        else
+                          @logger.log(Logger::DEBUG, "Setting to default flush_interval: #{DEFAULT_BATCH_INTERVAL} ms.")
+                          DEFAULT_BATCH_INTERVAL
+                        end
+      @notification_center = notification_center
+      @current_batch = []
+      @started = false
+      @stopped = false
+    end
+
+    def start!
+      if @started == true
+        @logger.log(Logger::WARN, 'Service already started.')
+        return
+      end
+      @flushing_interval_deadline = Helpers::DateTimeUtils.create_timestamp + @flush_interval
+      @logger.log(Logger::INFO, 'Starting scheduler.')
+      if @wait_mutex.nil?
+        @wait_mutex = Mutex.new
+        @resource = ConditionVariable.new
+      end
+      @thread = Thread.new { run_queue }
+      @started = true
+      @stopped = false
+    end
+
+    def flush
+      @event_queue << FLUSH_SIGNAL
+      @wait_mutex.synchronize { @resource.signal }
+    end
+
+    def process(user_event)
+      @logger.log(Logger::DEBUG, "Received userEvent: #{user_event}")
+
+      # if the processor has been explicitly stopped. Don't accept tasks
+      if @stopped
+        @logger.log(Logger::WARN, 'Executor shutdown, not accepting tasks.')
+        return
+      end
+
+      # start if the processor hasn't been started
+      start! unless @started
+
+      begin
+        @event_queue.push(user_event, true)
+        @wait_mutex.synchronize { @resource.signal }
+      rescue => e
+        @logger.log(Logger::WARN, "Payload not accepted by the queue: #{e.message}")
+        nil
+      end
+    end
+
+    def stop!
+      return unless @started
+
+      @logger.log(Logger::INFO, 'Stopping scheduler.')
+      @event_queue << SHUTDOWN_SIGNAL
+      @wait_mutex.synchronize { @resource.signal }
+      @thread.join(DEFAULT_TIMEOUT_INTERVAL)
+      @started = false
+      @stopped = true
+    end
+
+    private
+
+    def process_queue
+      while @event_queue.length.positive?
+        item = @event_queue.pop
+        if item == SHUTDOWN_SIGNAL
+          @logger.log(Logger::DEBUG, 'Received shutdown signal.')
+          return false
+        end
+
+        if item == FLUSH_SIGNAL
+          @logger.log(Logger::DEBUG, 'Received flush signal.')
+          flush_queue!
+          next
+        end
+
+        add_to_batch(item) if item.is_a? Optimizely::UserEvent
+      end
+      true
+    end
+
+    def run_queue
+      loop do
+        if Helpers::DateTimeUtils.create_timestamp >= @flushing_interval_deadline
+          @logger.log(Logger::DEBUG, 'Deadline exceeded flushing current batch.')
+
+          break unless process_queue
+
+          flush_queue!
+          @flushing_interval_deadline = Helpers::DateTimeUtils.create_timestamp + @flush_interval
+        end
+
+        break unless process_queue
+
+        # what is the current interval to flush in seconds
+        interval = (@flushing_interval_deadline - Helpers::DateTimeUtils.create_timestamp) * 0.001
+
+        next unless interval.positive?
+
+        @wait_mutex.synchronize { @resource.wait(@wait_mutex, interval) }
+      end
+    rescue SignalException
+      @logger.log(Logger::ERROR, 'Interrupted while processing buffer.')
+    rescue => e
+      @logger.log(Logger::ERROR, "Uncaught exception processing buffer. #{e.message}")
+    ensure
+      @logger.log(Logger::INFO, 'Exiting processing loop. Attempting to flush pending events.')
+      flush_queue!
+    end
+
+    def flush_queue!
+      return if @current_batch.empty?
+
+      log_event = Optimizely::EventFactory.create_log_event(@current_batch, @logger)
+      begin
+        @logger.log(
+          Logger::INFO,
+          'Flushing Queue.'
+        )
+
+        @event_dispatcher.dispatch_event(log_event)
+        @notification_center&.send_notifications(
+          NotificationCenter::NOTIFICATION_TYPES[:LOG_EVENT],
+          log_event
+        )
+      rescue StandardError => e
+        @logger.log(Logger::ERROR, "Error dispatching event: #{log_event} #{e.message}.")
+      end
+      @current_batch = []
+    end
+
+    def add_to_batch(user_event)
+      if should_split?(user_event)
+        flush_queue!
+        @current_batch = []
+      end
+
+      # Reset the deadline if starting a new batch.
+      @flushing_interval_deadline = (Helpers::DateTimeUtils.create_timestamp + @flush_interval) if @current_batch.empty?
+
+      @logger.log(Logger::DEBUG, "Adding user event: #{user_event} to batch.")
+      @current_batch << user_event
+      return unless @current_batch.length >= @batch_size
+
+      @logger.log(Logger::DEBUG, 'Flushing on max batch size.')
+      flush_queue!
+    end
+
+    def should_split?(user_event)
+      return false if @current_batch.empty?
+
+      current_context = @current_batch.last.event_context
+      new_context = user_event.event_context
+
+      # Revisions should match
+      unless current_context[:revision] == new_context[:revision]
+        @logger.log(Logger::DEBUG, 'Revisions mismatched: Flushing current batch.')
+        return true
+      end
+
+      # Projects should match
+      unless current_context[:project_id] == new_context[:project_id]
+        @logger.log(Logger::DEBUG, 'Project Ids mismatched: Flushing current batch.')
+        return true
+      end
+      false
+    end
+
+    def positive_number?(value)
+      # Returns true if the given value is positive finite number.
+      #   false otherwise.
+      Helpers::Validator.finite_number?(value) && value.positive?
+    end
+  end
+end

data/lib/optimizely/event/entity/conversion_event.rb

@@ -1,43 +1,44 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2019, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-require_relative 'user_event'
-require 'optimizely/helpers/date_time_utils'
-module Optimizely
-  class ConversionEvent < UserEvent
-    # Represents conversion event
-    attr_reader :event, :user_id, :visitor_attributes, :tags, :bot_filtering
-
-    def initialize(
-      event_context:,
-      event:,
-      user_id:,
-      visitor_attributes:,
-      tags:,
-      bot_filtering:
-    )
-      @event_context = event_context
-      @uuid = SecureRandom.uuid
-      @timestamp = Helpers::DateTimeUtils.create_timestamp
-      @event = event
-      @user_id = user_id
-      @visitor_attributes = visitor_attributes
-      @tags = tags
-      @bot_filtering = bot_filtering
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, 2022, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require_relative 'user_event'
+require 'optimizely/helpers/date_time_utils'
+module Optimizely
+  class ConversionEvent < UserEvent
+    # Represents conversion event
+    attr_reader :event, :user_id, :visitor_attributes, :tags, :bot_filtering
+
+    def initialize(
+      event_context:,
+      event:,
+      user_id:,
+      visitor_attributes:,
+      tags:,
+      bot_filtering:
+    )
+      super()
+      @event_context = event_context
+      @uuid = SecureRandom.uuid
+      @timestamp = Helpers::DateTimeUtils.create_timestamp
+      @event = event
+      @user_id = user_id
+      @visitor_attributes = visitor_attributes
+      @tags = tags
+      @bot_filtering = bot_filtering
+    end
+  end
+end