feat(datafile management): Add Polling Manager and Config Update (#179)

Author: rashidsp

.rubocop_todo.yml

@@ -20,6 +20,15 @@ Lint/LiteralAsCondition:
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 6
+  Exclude:
+    - 'lib/optimizely/config_manager/http_project_config_manager.rb'
+    - 'lib/optimizely.rb'
+    - 'lib/optimizely/optimizely_factory.rb'
+
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/optimizely/config_manager/http_project_config_manager.rb'
+    - 'spec/optimizely_factory_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.

lib/optimizely.rb

@@ -17,6 +17,7 @@
 #
 require_relative 'optimizely/audience'
 require_relative 'optimizely/config/datafile_project_config'
+require_relative 'optimizely/config_manager/http_project_config_manager'
 require_relative 'optimizely/config_manager/static_project_config_manager'
 require_relative 'optimizely/decision_service'
 require_relative 'optimizely/error_handler'
@@ -46,8 +47,22 @@ class Project
     #                 By default all exceptions will be suppressed.
     # @param user_profile_service - Optional component which provides methods to store and retreive user profiles.
     # @param skip_json_validation - Optional boolean param to skip JSON schema validation of the provided datafile.
-
-    def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil, skip_json_validation = false, user_profile_service = nil)
+    # @params sdk_key - Optional string uniquely identifying the datafile corresponding to project and environment combination.
+    #                   Must provide at least one of datafile or sdk_key.
+    # @param config_manager - Optional Responds to get_config.
+    # @param notification_center - Optional Instance of NotificationCenter.
+
+    def initialize(
+      datafile = nil,
+      event_dispatcher = nil,
+      logger = nil,
+      error_handler = nil,
+      skip_json_validation = false,
+      user_profile_service = nil,
+      sdk_key = nil,
+      config_manager = nil,
+      notification_center = nil
+    )
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
       @event_dispatcher = event_dispatcher || EventDispatcher.new
@@ -60,10 +75,24 @@ def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = n
         @logger.log(Logger::ERROR, e.message)
       end
 
-      @config_manager = StaticProjectConfigManager.new(datafile, @logger, @error_handler, skip_json_validation)
+      @notification_center = notification_center.is_a?(Optimizely::NotificationCenter) ? notification_center : NotificationCenter.new(@logger, @error_handler)
+
+      @config_manager = if config_manager.respond_to?(:get_config)
+                          config_manager
+                        elsif sdk_key
+                          HTTPProjectConfigManager.new(
+                            sdk_key: sdk_key,
+                            datafile: datafile,
+                            logger: @logger,
+                            error_handler: @error_handler,
+                            skip_json_validation: skip_json_validation,
+                            notification_center: @notification_center
+                          )
+                        else
+                          StaticProjectConfigManager.new(datafile, @logger, @error_handler, skip_json_validation)
+                        end
       @decision_service = DecisionService.new(@logger, @user_profile_service)
       @event_builder = EventBuilder.new(@logger)
-      @notification_center = NotificationCenter.new(@logger, @error_handler)
     end
 
     # Buckets visitor and sends impression event to Optimizely.

lib/optimizely/config/datafile_project_config.rb

@@ -140,7 +140,7 @@ def initialize(datafile, logger, error_handler)
       end
     end
 
-    def self.create_project_config_from_datafile(datafile, logger, error_handler, skip_json_validation)
+    def self.create(datafile, logger, error_handler, skip_json_validation)
       # Looks up and sets datafile and config based on response body.
       #
       # datafile - JSON string representing the Optimizely project.

lib/optimizely/config_manager/async_scheduler.rb

@@ -0,0 +1,91 @@
+# 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.
+#
+module Optimizely
+  class AsyncScheduler
+    attr_reader :running
+
+    def initialize(callback, interval, auto_update, logger = nil)
+      # Sets up AsyncScheduler to execute a callback periodically.
+      #
+      # callback - Main function to be executed periodically.
+      # interval - How many seconds to wait between executions.
+      # auto_update - boolean indicates to run infinitely or only once.
+      # logger - Optional Provides a logger instance.
+
+      @callback = callback
+      @interval = interval
+      @auto_update = auto_update
+      @running = false
+      @thread = nil
+      @logger = logger || NoOpLogger.new
+    end
+
+    def start!
+      # Starts the async scheduler.
+
+      if @running
+        @logger.log(
+          Logger::WARN,
+          'Scheduler is already running. Ignoring .start() call.'
+        )
+        return
+      end
+
+      begin
+        @running = true
+        @thread = Thread.new { execution_wrapper(@callback) }
+      rescue StandardError => e
+        @logger.log(
+          Logger::ERROR,
+          "Couldn't create a new thread for async scheduler. #{e.message}"
+        )
+      end
+    end
+
+    def stop!
+      # Stops the async scheduler.
+
+      # If the scheduler is not running do nothing.
+      return unless @running
+
+      @running = false
+      @thread.exit
+    end
+
+    private
+
+    def execution_wrapper(callback)
+      # Executes the given callback periodically
+
+      loop do
+        begin
+          callback.call
+        rescue
+          @logger.log(
+            Logger::ERROR,
+            'Something went wrong when running passed function.'
+          )
+          stop!
+        end
+        break unless @auto_update
+
+        sleep @interval
+      end
+    end
+  end
+end