optimizely-sdk 3.3.1 → 3.3.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0eefcbf5e58e06f6e28c1437d3ed456810a4240f
-  data.tar.gz: c50c1633875300966b654e1fc0b2d246a386a089
+SHA256:
+  metadata.gz: 4b941180fbc22ae8f59eff475967cb6f130c4845e2a47324c3e18252b4a35685
+  data.tar.gz: 560e8ce82a288fb98c6d088264b0df6ff1cd4b0d3aba162d72ab1541a9fe76ee
 SHA512:
-  metadata.gz: 43c28f74959363c09232e85422cf7995a22163f4a8166300a87379bc05f29e49cae4d0af3cf8f3203b74bd02674d74b34be950b2cc307de0be3accf41371ae29
-  data.tar.gz: 2d73a7d2a6909f5a1a90287faa5af11579de08a072d5522feb6a7aec54bc3af758a752c6a217642518d4e6bd7eed035b46e186eae8e8bcc9d42e0c98a5d7bc31
+  metadata.gz: 66dbbf2dcbfe72ba85201b552f5d8a1e10c33eb109c18e51a56e46582754fcc21ad86d7d0ce487e032e872e135c2671269451c788447c527d8a2b8498fd1421e
+  data.tar.gz: 3ca3f728b5c3c20355e192f26a50913194cebf4fe3a446cddd94a72daecc9c0f50d74af7c36863cfcde5dd02e93baea2d14fb0137a6b0e5e3481d135ff323ae0

data/lib/optimizely.rb

@@ -70,7 +70,7 @@ module Optimizely
     )
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
-      @event_dispatcher = event_dispatcher || EventDispatcher.new
+      @event_dispatcher = event_dispatcher || EventDispatcher.new(logger: @logger, error_handler: @error_handler)
       @user_profile_service = user_profile_service
 
       begin
@@ -701,7 +701,7 @@ module Optimizely
 
       return if Helpers::Validator.event_dispatcher_valid?(@event_dispatcher)
 
-      @event_dispatcher = EventDispatcher.new
+      @event_dispatcher = EventDispatcher.new(logger: @logger, error_handler: @error_handler)
       raise InvalidInputError, 'event_dispatcher'
     end
 

data/lib/optimizely/config_manager/async_scheduler.rb

@@ -75,10 +75,10 @@ module Optimizely
       loop do
         begin
           callback.call
-        rescue
+        rescue StandardError => e
           @logger.log(
             Logger::ERROR,
-            'Something went wrong when running passed function.'
+            "Something went wrong when executing passed callback. #{e.message}"
           )
           stop!
         end

data/lib/optimizely/config_manager/http_project_config_manager.rb

@@ -70,14 +70,16 @@ module Optimizely
       @blocking_timeout = nil
       blocking_timeout(blocking_timeout)
       @last_modified = nil
-      @async_scheduler = AsyncScheduler.new(method(:fetch_datafile_config), @polling_interval, auto_update, @logger)
-      @async_scheduler.start! if start_by_default == true
-      @stopped = false
       @skip_json_validation = skip_json_validation
       @notification_center = notification_center.is_a?(Optimizely::NotificationCenter) ? notification_center : NotificationCenter.new(@logger, @error_handler)
       @config = datafile.nil? ? nil : DatafileProjectConfig.create(datafile, @logger, @error_handler, @skip_json_validation)
       @mutex = Mutex.new
       @resource = ConditionVariable.new
+      @async_scheduler = AsyncScheduler.new(method(:fetch_datafile_config), @polling_interval, auto_update, @logger)
+      # Start async scheduler in the end to avoid race condition where scheduler executes
+      # callback which makes use of variables not yet initialized by the main thread.
+      @async_scheduler.start! if start_by_default == true
+      @stopped = false
     end
 
     def ready?

data/lib/optimizely/event/batch_event_processor.rb

@@ -20,7 +20,7 @@ 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 a EventQueue.
+    # 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.
@@ -30,13 +30,15 @@ module Optimizely
     DEFAULT_BATCH_SIZE = 10
     DEFAULT_BATCH_INTERVAL = 30_000 # interval in milliseconds
     DEFAULT_QUEUE_CAPACITY = 1000
+    DEFAULT_TIMEOUT_INTERVAL = 5 # interval in seconds
+    MAX_NIL_COUNT = 3
 
     FLUSH_SIGNAL = 'FLUSH_SIGNAL'
     SHUTDOWN_SIGNAL = 'SHUTDOWN_SIGNAL'
 
     def initialize(
       event_queue: SizedQueue.new(DEFAULT_QUEUE_CAPACITY),
-      event_dispatcher: Optimizely::EventDispatcher.new,
+      event_dispatcher: nil,
       batch_size: DEFAULT_BATCH_SIZE,
       flush_interval: DEFAULT_BATCH_INTERVAL,
       logger: NoOpLogger.new,
@@ -44,7 +46,7 @@ module Optimizely
     )
       @event_queue = event_queue
       @logger = logger
-      @event_dispatcher = event_dispatcher
+      @event_dispatcher = event_dispatcher || EventDispatcher.new(logger: @logger)
       @batch_size = if (batch_size.is_a? Integer) && positive_number?(batch_size)
                       batch_size
                     else
@@ -58,8 +60,6 @@ module Optimizely
                           DEFAULT_BATCH_INTERVAL
                         end
       @notification_center = notification_center
-      @mutex = Mutex.new
-      @received = ConditionVariable.new
       @current_batch = []
       @started = false
       start!
@@ -71,15 +71,13 @@ module Optimizely
         return
       end
       @flushing_interval_deadline = Helpers::DateTimeUtils.create_timestamp + @flush_interval
+      @logger.log(Logger::INFO, 'Starting scheduler.')
       @thread = Thread.new { run }
       @started = true
     end
 
     def flush
-      @mutex.synchronize do
-        @event_queue << FLUSH_SIGNAL
-        @received.signal
-      end
+      @event_queue << FLUSH_SIGNAL
     end
 
     def process(user_event)
@@ -90,56 +88,54 @@ module Optimizely
         return
       end
 
-      @mutex.synchronize do
-        begin
-          @event_queue << user_event
-          @received.signal
-        rescue Exception
-          @logger.log(Logger::WARN, 'Payload not accepted by the queue.')
-          return
-        end
+      begin
+        @event_queue.push(user_event, true)
+      rescue Exception
+        @logger.log(Logger::WARN, 'Payload not accepted by the queue.')
+        return
       end
     end
 
     def stop!
       return unless @started
 
-      @mutex.synchronize do
-        @event_queue << SHUTDOWN_SIGNAL
-        @received.signal
-      end
-
+      @logger.log(Logger::INFO, 'Stopping scheduler.')
+      @event_queue << SHUTDOWN_SIGNAL
+      @thread.join(DEFAULT_TIMEOUT_INTERVAL)
       @started = false
-      @logger.log(Logger::WARN, 'Stopping scheduler.')
-      @thread.exit
     end
 
     private
 
     def run
+      # if we receive a number of item nils that reach MAX_NIL_COUNT,
+      # then we hang on the pop via setting use_pop to false
+      @nil_count = 0
+      # hang on pop if true
+      @use_pop = false
       loop do
-        if Helpers::DateTimeUtils.create_timestamp > @flushing_interval_deadline
-          @logger.log(
-            Logger::DEBUG,
-            'Deadline exceeded flushing current batch.'
-          )
+        if Helpers::DateTimeUtils.create_timestamp >= @flushing_interval_deadline
+          @logger.log(Logger::DEBUG, 'Deadline exceeded flushing current batch.')
           flush_queue!
+          @flushing_interval_deadline = Helpers::DateTimeUtils.create_timestamp + @flush_interval
+          @use_pop = true if @nil_count > MAX_NIL_COUNT
         end
 
-        item = nil
-
-        @mutex.synchronize do
-          @received.wait(@mutex, 0.05)
-          item = @event_queue.pop if @event_queue.length.positive?
-        end
+        item = @event_queue.pop if @event_queue.length.positive? || @use_pop
 
         if item.nil?
-          sleep(0.05)
+          # when nil count is greater than MAX_NIL_COUNT, we hang on the pop until there is an item available.
+          # this avoids to much spinning of the loop.
+          @nil_count += 1
           next
         end
 
+        # reset nil_count and use_pop if we have received an item.
+        @nil_count = 0
+        @use_pop = false
+
         if item == SHUTDOWN_SIGNAL
-          @logger.log(Logger::INFO, 'Received shutdown signal.')
+          @logger.log(Logger::DEBUG, 'Received shutdown signal.')
           break
         end
 
@@ -152,7 +148,7 @@ module Optimizely
         add_to_batch(item) if item.is_a? Optimizely::UserEvent
       end
     rescue SignalException
-      @logger.log(Logger::INFO, 'Interrupted while processing buffer.')
+      @logger.log(Logger::ERROR, 'Interrupted while processing buffer.')
     rescue Exception => e
       @logger.log(Logger::ERROR, "Uncaught exception processing buffer. #{e.message}")
     ensure
@@ -168,6 +164,11 @@ module Optimizely
 
       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],
@@ -192,7 +193,7 @@ module Optimizely
       @current_batch << user_event
       return unless @current_batch.length >= @batch_size
 
-      @logger.log(Logger::DEBUG, 'Flushing on max batch size!')
+      @logger.log(Logger::DEBUG, 'Flushing on max batch size.')
       flush_queue!
     end
 

data/lib/optimizely/event_dispatcher.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -15,6 +15,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 #
+require_relative 'exceptions'
+
 require 'httparty'
 
 module Optimizely
@@ -28,26 +30,48 @@ module Optimizely
     # @api constants
     REQUEST_TIMEOUT = 10
 
+    def initialize(logger: nil, error_handler: nil)
+      @logger = logger || NoOpLogger.new
+      @error_handler = error_handler || NoOpErrorHandler.new
+    end
+
     # Dispatch the event being represented by the Event object.
     #
     # @param event - Event object
     def dispatch_event(event)
       if event.http_verb == :get
-        begin
-          HTTParty.get(event.url, headers: event.headers, query: event.params, timeout: REQUEST_TIMEOUT)
-        rescue Timeout::Error => e
-          return e
-        end
+        response = HTTParty.get(event.url, headers: event.headers, query: event.params, timeout: REQUEST_TIMEOUT)
+
       elsif event.http_verb == :post
-        begin
-          HTTParty.post(event.url,
-                        body: event.params.to_json,
-                        headers: event.headers,
-                        timeout: REQUEST_TIMEOUT)
-        rescue Timeout::Error => e
-          return e
-        end
+        response = HTTParty.post(event.url,
+                                 body: event.params.to_json,
+                                 headers: event.headers,
+                                 timeout: REQUEST_TIMEOUT)
       end
+
+      error_msg = "Event failed to dispatch with response code: #{response.code}"
+
+      case response.code
+      when 400...500
+        @logger.log(Logger::ERROR, error_msg)
+        @error_handler.handle_error(HTTPCallError.new("HTTP Client Error: #{response.code}"))
+
+      when 500...600
+        @logger.log(Logger::ERROR, error_msg)
+        @error_handler.handle_error(HTTPCallError.new("HTTP Server Error: #{response.code}"))
+      else
+        @logger.log(Logger::DEBUG, 'event successfully sent with response code ' + response.code.to_s)
+      end
+    rescue Timeout::Error => e
+      @logger.log(Logger::ERROR, "Request Timed out. Error: #{e}")
+      @error_handler.handle_error(e)
+
+      # Returning Timeout error to retain existing behavior.
+      e
+    rescue StandardError => e
+      @logger.log(Logger::ERROR, "Event failed to dispatch. Error: #{e}")
+      @error_handler.handle_error(e)
+      nil
     end
   end
 end

data/lib/optimizely/exceptions.rb

@@ -18,6 +18,13 @@
 module Optimizely
   class Error < StandardError; end
 
+  class HTTPCallError < Error
+    # Raised when a 4xx or 5xx response code is recieved.
+    def initialize(msg = 'HTTP call resulted in a response with an error code.')
+      super
+    end
+  end
+
   class InvalidAudienceError < Error
     # Raised when an invalid audience is provided
 

data/lib/optimizely/notification_center.rb

@@ -39,20 +39,28 @@ module Optimizely
 
     # Adds notification callback to the notification center
     #
-    # @param notification_type -  One of the constants in NOTIFICATION_TYPES
-    # @param notification_callback -  Function to call when the event is sent
+    # @param notification_type - One of the constants in NOTIFICATION_TYPES
+    # @param notification_callback [lambda, Method, Callable] (default: block) - Called when the event is sent
+    # @yield Block to be used as callback if callback omitted.
     #
     # @return [notification ID] Used to remove the notification
 
-    def add_notification_listener(notification_type, notification_callback)
+    def add_notification_listener(notification_type, notification_callback = nil, &block)
       return nil unless notification_type_valid?(notification_type)
 
+      if notification_callback && block_given?
+        @logger.log Logger::ERROR, 'Callback and block are mutually exclusive.'
+        return nil
+      end
+
+      notification_callback ||= block
+
       unless notification_callback
         @logger.log Logger::ERROR, 'Callback can not be empty.'
         return nil
       end
 
-      unless notification_callback.is_a? Method
+      unless notification_callback.respond_to? :call
         @logger.log Logger::ERROR, 'Invalid notification callback given.'
         return nil
       end
@@ -70,7 +78,7 @@ module Optimizely
     #
     # @param notification_id
     #
-    # @return [Boolean] The function returns true if found and removed, false otherwise
+    # @return [Boolean] true if found and removed, false otherwise
 
     def remove_notification_listener(notification_id)
       unless notification_id

data/lib/optimizely/version.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '3.3.1'
+  VERSION = '3.3.2.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2.rc1
 platform: ruby
 authors:
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -202,12 +202,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Optimizely's testing framework