vwo-sdk 1.30.0 → 1.37.1

data/lib/vwo/services/event_dispatcher.rb

@@ -12,10 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../utils/request'
 require_relative '../utils/utility'
+require_relative '../utils/log_message'
 require_relative '../constants'
 
 class VWO
@@ -33,7 +33,7 @@ class VWO
       #                     to our server should be made or not.
       #
       def initialize(is_development_mode = false)
-        @logger = VWO::Logger.get_instance
+        @logger = VWO::Utils::Logger
         @is_development_mode = is_development_mode
       end
 
@@ -43,7 +43,7 @@ class VWO
       #                                       the request to be dispatched to the VWO server
       # @return[Boolean]
       #
-      def dispatch(impression)
+      def dispatch(impression, main_keys, end_point)
         return true if @is_development_mode
 
         modified_event = impression.reject do |key, _value|
@@ -52,18 +52,38 @@ class VWO
 
         resp = VWO::Utils::Request.get(impression['url'], modified_event)
         if resp.code == '200'
+          @logger.log(
+            LogLevelEnum::INFO,
+            'IMPRESSION_SUCCESS',
+            {
+              '{file}' => FILE,
+              '{endPoint}' => end_point,
+              '{accountId}' => impression['account_id'] || impression[:account_id],
+              '{mainKeys}' => JSON.generate(main_keys)
+            }
+          )
           true
         else
           @logger.log(
             LogLevelEnum::ERROR,
-            format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: impression['url'])
+            'IMPRESSION_FAILED',
+            {
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
+              '{err}' => resp.message,
+              '{endPoint}' => impression['url']
+            }
           )
           false
         end
-      rescue StandardError
+      rescue StandardError => e
         @logger.log(
           LogLevelEnum::ERROR,
-          format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: impression['url'])
+          'IMPRESSION_FAILED',
+          {
+            '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
+            '{err}' => e.message,
+            '{endPoint}' => impression['url']
+          }
         )
         false
       end
@@ -76,26 +96,36 @@ class VWO
         if resp.code == '200'
           @logger.log(
             LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS_FOR_EVENT_ARCH, 
-              file: FileNameEnum::EventDispatcher, 
-              event: 'visitor property:' + JSON.generate(post_data[:d][:visitor][:props]), 
-              url: url,
-              a: params[:a]
-            )
+            'IMPRESSION_SUCCESS_FOR_EVENT_ARCH',
+            {
+              '{file}' => FileNameEnum::BATCH_EVENTS_DISPATCHER,
+              '{event}' => "visitor property:#{JSON.generate(post_data[:d][:visitor][:props])}",
+              '{endPoint}' => url,
+              '{accountId}' => params[:a]
+            }
           )
           true
         else
           @logger.log(
             LogLevelEnum::ERROR,
-            format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: url)
+            'IMPRESSION_FAILED',
+            {
+              '{file}' => FileNameEnum::EVENT_DISPATCHER,
+              '{err}' => resp.message,
+              '{endPoint}' => url
+            }
           )
           false
         end
-      rescue StandardError
+      rescue StandardError => e
         @logger.log(
           LogLevelEnum::ERROR,
-          format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: url)
+          'IMPRESSION_FAILED',
+          {
+            '{file}' => FileNameEnum::EVENT_DISPATCHER,
+            '{err}' => e.message,
+            '{endPoint}' => url
+          }
         )
         false
       end

data/lib/vwo/services/hooks_manager.rb

@@ -15,22 +15,18 @@
 class VWO
   module Services
     class HooksManager
-     # Hooks Manager is responsible for triggering callbacks useful to the end-user based on certain lifecycle events.
-     # Possible use with integrations when the user intends to send an event when a visitor is part of the experiment.
+      # Hooks Manager is responsible for triggering callbacks useful to the end-user based on certain lifecycle events.
+      # Possible use with integrations when the user intends to send an event when a visitor is part of the experiment.
       def initialize(config)
         @logger = VWO::Logger.get_instance
-        if config.key?(:integrations) && config[:integrations].key?(:callback) && config[:integrations][:callback].is_a?(Method)
-          @callback = config[:integrations][:callback]
-        end
+        @callback = config[:integrations][:callback] if config.key?(:integrations) && config[:integrations].key?(:callback) && config[:integrations][:callback].is_a?(Method)
       end
 
-     # Executes the callback
-     # @param[Hash] properties Properties from the callback
-     def execute(properties)
-       if @callback
-         @callback.call(properties)
-       end
-     end
+      # Executes the callback
+      # @param[Hash] properties Properties from the callback
+      def execute(properties)
+        @callback&.call(properties)
+      end
     end
   end
 end

data/lib/vwo/services/segment_evaluator.rb

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../logger'
 require_relative '../enums'
 require_relative './operand_evaluator'
 require_relative '../utils/function'
 require_relative '../utils/segment'
 require_relative '../utils/validations'
+require_relative '../utils/log_message'
 
 class VWO
   module Services
@@ -29,7 +29,7 @@ class VWO
 
       # Initializes this class with VWOLogger and OperandEvaluator
       def initialize
-        @logger = VWO::Logger.get_instance
+        @logger = VWO::Utils::Logger
         @operand_evaluator = OperandEvaluator.new
       end
 
@@ -43,15 +43,16 @@ class VWO
       #
       def evaluate_util(dsl, custom_variables)
         operator, sub_dsl = get_key_value(dsl)
-        if operator == OperatorTypes::NOT
+        case operator
+        when OperatorTypes::NOT
           !evaluate_util(sub_dsl, custom_variables)
-        elsif operator == OperatorTypes::AND
+        when OperatorTypes::AND
           sub_dsl.all? { |y| evaluate_util(y, custom_variables) }
-        elsif operator == OperatorTypes::OR
+        when OperatorTypes::OR
           sub_dsl.any? { |y| evaluate_util(y, custom_variables) }
-        elsif operator == OperandTypes::CUSTOM_VARIABLE
+        when OperandTypes::CUSTOM_VARIABLE
           @operand_evaluator.evaluate_custom_variable?(sub_dsl, custom_variables)
-        elsif operator == OperandTypes::USER
+        when OperandTypes::USER
           @operand_evaluator.evaluate_user?(sub_dsl, custom_variables)
         end
       end
@@ -73,14 +74,15 @@ class VWO
       rescue StandardError => e
         @logger.log(
           LogLevelEnum::ERROR,
-          format(
-            LogMessageEnum::ErrorMessages::SEGMENTATION_ERROR,
-            file: FileNameEnum::SegmentEvaluator,
-            user_id: user_id,
-            campaign_key: campaign_key,
-            custom_variables: custom_variables,
-            error_message: e
-          ),
+          'SEGMENTATION_ERROR',
+          {
+            '{file}' => FileNameEnum::SEGMENT_EVALUATOR,
+            '{userId}' => user_id,
+            '{campaignKey}' => campaign_key,
+            '{variation}' => '',
+            '{customVariables}' => custom_variables,
+            '{err}' => e.message
+          },
           disable_logs
         )
         false

data/lib/vwo/services/settings_file_manager.rb

@@ -47,11 +47,11 @@ class VWO
           return '{}'
         end
 
-        if is_via_webhook
-          path = ::VWO::CONSTANTS::ENDPOINTS::WEBHOOK_SETTINGS_URL
-        else
-          path = ::VWO::CONSTANTS::ENDPOINTS::SETTINGS_URL
-        end
+        path = if is_via_webhook
+                 ::VWO::CONSTANTS::ENDPOINTS::WEBHOOK_SETTINGS_URL
+               else
+                 ::VWO::CONSTANTS::ENDPOINTS::SETTINGS_URL
+               end
         vwo_server_url = "#{PROTOCOL}://#{HOSTNAME}#{path}"
 
         settings_file_response = ::VWO::Utils::Request.get(vwo_server_url, params)

data/lib/vwo/services/settings_file_processor.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../utils/campaign'
+require_relative '../utils/log_message'
 
 class VWO
   module Services
@@ -30,7 +30,6 @@ class VWO
 
       def initialize(settings_file)
         @settings_file = JSON.parse(settings_file)
-        @logger = VWO::Logger.get_instance
       end
 
       # Processes the settings_file, assigns variation allocation range
@@ -38,9 +37,13 @@ class VWO
         (@settings_file['campaigns'] || []).each do |campaign|
           set_variation_allocation(campaign)
         end
-        @logger.log(
+        Utils::Logger.log(
           LogLevelEnum::DEBUG,
-          format(LogMessageEnum::DebugMessages::SETTINGS_FILE_PROCESSED, file: FileNameEnum::SettingsFileProcessor)
+          'SETTINGS_FILE_PROCESSED',
+          {
+            '{file}' => FileNameEnum::SETTINGS_FILE_PROCESSOR,
+            '{accountId}' => @settings_file['accountId']
+          }
         )
       end
 

data/lib/vwo/services/usage_stats.rb

@@ -16,13 +16,14 @@ class VWO
   module Services
     class UsageStats
       attr_reader :usage_stats
+
       # Initialize the UsageStats
       def initialize(stats, is_development_mode = false)
         @usage_stats = {}
-        unless is_development_mode
-          @usage_stats = stats
-          @usage_stats[:_l] = 1 if @usage_stats.length > 0
-        end
+        return if is_development_mode
+
+        @usage_stats = stats
+        @usage_stats[:_l] = 1 if @usage_stats.length > 0
       end
     end
   end

data/lib/vwo/utils/campaign.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
+require_relative './log_message'
 
 # Utility module for processing VWO campaigns
 class VWO
@@ -41,18 +41,17 @@ class VWO
             variation['start_variation_allocation'] = -1
             variation['end_variation_allocation'] = -1
           end
-
-          VWO::Logger.get_instance.log(
-            LogLevelEnum::INFO,
-            format(
-              LogMessageEnum::InfoMessages::VARIATION_RANGE_ALLOCATION,
-              file: FileNameEnum::CampaignUtil,
-              campaign_key: campaign['key'],
-              variation_name: variation['name'],
-              variation_weight: variation['weight'],
-              start: variation['start_variation_allocation'],
-              end: variation['end_variation_allocation']
-            )
+          Logger.log(
+            LogLevelEnum::DEBUG,
+            'VARIATION_RANGE_ALLOCATION',
+            {
+              '{file}' => FileNameEnum::CAMPAIGN_UTIL,
+              '{campaignKey}' => campaign['key'],
+              '{variationName}' => variation['name'],
+              '{variationWeight}' => variation['weight'],
+              '{start}' => variation['start_variation_allocation'],
+              '{end}' => variation['end_variation_allocation']
+            }
           )
         end
       end
@@ -178,21 +177,19 @@ class VWO
           campaigns = get_campaigns_from_campaign_keys(campaign_key, settings_file, goal_identifier, goal_type_to_track)
         elsif campaign_key.is_a?(String)
           campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
-          if campaign
-            campaigns = [campaign]
-          end
+          campaigns = [campaign] if campaign
         end
-        if campaigns.length() == 0
-          VWO::Logger.get_instance.log(
+        if campaigns.length == 0
+          Utils::Logger.log(
             LogLevelEnum::ERROR,
-            format(
-              LogMessageEnum::ErrorMessages::NO_CAMPAIGN_FOUND,
-              file: FileNameEnum::CampaignUtil,
-              goal_identifier: goal_identifier
-            )
+            'CAMPAIGN_NOT_FOUND_FOR_GOAL',
+            {
+              '{file}' => FileNameEnum::CAMPAIGN_UTIL,
+              '{goalIdentifier}' => goal_identifier
+            }
           )
         end
-        return campaigns
+        campaigns
       end
 
       # fetch all running campaigns (having goal identifier goal_type_to_track and goal type CUSTOM|REVENUE|ALL) from settings
@@ -205,38 +202,31 @@ class VWO
         campaigns = []
         if settings_file
           settings_file['campaigns'].each do |campaign|
-            if campaign.key?(:status) && campaign[:status] != 'RUNNING'
-              next
-            end
+            next if campaign.key?(:status) && campaign[:status] != 'RUNNING'
+
             goal = get_campaign_goal(campaign, goal_identifier)
-            if validate_goal(goal, goal_type_to_track)
-              campaigns.push(campaign)
-            end
+            campaigns.push(campaign) if validate_goal(goal, goal_type_to_track)
           end
         end
         campaigns
       end
 
       def validate_goal(goal, goal_type_to_track)
-        result = goal && (
+        goal && (
           goal_type_to_track == 'ALL' ||
             (
-              GOAL_TYPES.has_value?(goal['type']) &&
+              GOAL_TYPES.value?(goal['type']) &&
                 (GOAL_TYPES.key? goal_type_to_track) &&
                 goal['type'] == GOAL_TYPES[goal_type_to_track]
             )
         )
-        return result
       end
 
       def get_campaigns_from_campaign_keys(campaign_keys, settings_file, goal_identifier, goal_type_to_track = 'ALL')
         campaigns = []
         campaign_keys.each do |campaign_key|
-
           campaign = get_campaign_for_campaign_key_and_goal(campaign_key, settings_file, goal_identifier, goal_type_to_track)
-          if campaign
-            campaigns.push(campaign)
-          end
+          campaigns.push(campaign) if campaign
         end
         campaigns
       end
@@ -245,9 +235,7 @@ class VWO
         campaign = get_running_campaign(campaign_key, settings_file)
         if campaign
           goal = get_campaign_goal(campaign, goal_identifier)
-          if validate_goal(goal, goal_type_to_track)
-            return campaign
-          end
+          return campaign if validate_goal(goal, goal_type_to_track)
         end
         nil
       end
@@ -255,18 +243,18 @@ class VWO
       def get_running_campaign(campaign_key, settings_file)
         campaign = get_campaign(settings_file, campaign_key)
         if campaign.nil? || (campaign['status'] != 'RUNNING')
-          @logger.log(
-            LogLevelEnum::ERROR,
-            format(
-              LogMessageEnum::ErrorMessages::CAMPAIGN_NOT_RUNNING,
-              file: FILE,
-              campaign_key: campaign_key,
-              api_name: ApiMethods::TRACK
-            )
+          Utils::Logger.log(
+            LogLevelEnum::WARNING,
+            'CAMPAIGN_NOT_RUNNING',
+            {
+              '{file}' => FILE,
+              '{campaignKey}' => campaign_key,
+              '{api}' => ApiMethods::TRACK
+            }
           )
           nil
         end
-        return campaign
+        campaign
       end
 
       # Checks whether a campaign is part of a group.
@@ -274,10 +262,9 @@ class VWO
       #  @param[Hash]       :settings_file          Settings file for the project
       #  @param[Integer]     :campaign_id            Id of campaign which is to be checked
       #  @return[Boolean]
-      def is_part_of_group(settings_file, campaign_id)
-        if settings_file["campaignGroups"] && (settings_file["campaignGroups"].has_key?(campaign_id.to_s))
-          return true
-        end
+      def part_of_group?(settings_file, campaign_id)
+        return true if settings_file['campaignGroups']&.key?(campaign_id.to_s)
+
         false
       end
 
@@ -289,24 +276,34 @@ class VWO
       def get_group_campaigns(settings_file, group_id)
         group_campaign_ids = []
         group_campaigns = []
-        groups = settings_file["groups"]
+        groups = settings_file['groups']
 
-        if groups && groups.has_key?(group_id.to_s)
-          group_campaign_ids = groups[group_id.to_s]["campaigns"]
-        end
+        group_campaign_ids = groups[group_id.to_s]['campaigns'] if groups&.key?(group_id.to_s)
 
-        if group_campaign_ids
-          group_campaign_ids.each do |campaign_id|
-            settings_file["campaigns"].each do |campaign|
-              if campaign["id"] == campaign_id && campaign["status"] == STATUS_RUNNING
-                group_campaigns.push(campaign)
-              end
-            end
+        group_campaign_ids&.each do |campaign_id|
+          settings_file['campaigns'].each do |campaign|
+            group_campaigns.push(campaign) if campaign['id'] == campaign_id && campaign['status'] == STATUS_RUNNING
           end
         end
         group_campaigns
       end
 
+      def campaign_goal_already_tracked?(user_id, campaign, identifiers, goal_identifier)
+        if identifiers.include? goal_identifier
+          @logger.log(
+            LogLevelEnum::INFO,
+            'CAMPAIGN_GOAL_ALREADY_TRACKED',
+            {
+              '{file}' => FILE,
+              '{userId}' => user_id,
+              '{campaignKey}' => campaign['key'],
+              '{goalIdentifier}' => goal_identifier
+            }
+          )
+          return true
+        end
+        false
+      end
     end
   end
 end

data/lib/vwo/utils/custom_dimensions.rb

@@ -13,11 +13,11 @@
 # limitations under the License.
 
 require 'json'
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
 require_relative './impression'
 require_relative './utility'
+require_relative './log_message'
 
 # Utility module for helper math and random functions
 class VWO
@@ -36,13 +36,13 @@ class VWO
         params = get_common_properties(user_id, settings_file)
         params.merge!('url' => url, 'tags' => JSON.generate(tag), 'env' => sdk_key)
 
-        VWO::Logger.get_instance.log(
+        Logger.log(
           LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::PARAMS_FOR_PUSH_CALL,
-            file: FileNameEnum::CustomDimensionsUtil,
-            properties: remove_sensitive_properties(params)
-          )
+          'IMPRESSION_FOR_PUSH',
+          {
+            '{file}' => FileNameEnum::CUSTOM_DIMENSTIONS_UTIL,
+            '{properties}' => JSON.generate(params)
+          }
         )
         params
       end
@@ -55,17 +55,17 @@ class VWO
         params = {
           'eT' => 3,
           't' => JSON.generate(tag),
-          'u' => generator_for(user_id, account_id),
+          'u' => generator_for(user_id, account_id, true),
           'sId' => get_current_unix_timestamp
         }
 
-        VWO::Logger.get_instance.log(
+        Logger.log(
           LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::PARAMS_FOR_PUSH_CALL,
-            file: FileNameEnum::CustomDimensionsUtil,
-            properties: JSON.generate(params)
-          )
+          'IMPRESSION_FOR_PUSH',
+          {
+            '{file}' => FileNameEnum::CUSTOM_DIMENSTIONS_UTIL,
+            '{properties}' => JSON.generate(params)
+          }
         )
         params
       end

data/lib/vwo/utils/data_location_manager.rb

@@ -12,29 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 require_relative '../constants'
 
 # Utility module for generating uuid
 class VWO
   module Utils
     class DataLocationManager
-
       @@instance = nil
 
       def self.get_instance
-        if @@instance.nil?
-            @@instance = self.new
-        end
+        @@instance = new if @@instance.nil?
         @@instance
       end
 
-
       def get_data_location
         url = VWO::CONSTANTS::ENDPOINTS::BASE_URL
-        if @settings.key?("collectionPrefix")
-            url = url  + '/' + @settings["collectionPrefix"]
-        end
+        url = "#{url}/#{@settings['collectionPrefix']}" if @settings.key?('collectionPrefix')
         url
       end
 

data/lib/vwo/utils/feature.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
+require_relative './log_message'
 
 # Utility module for helper math and random functions
 class VWO
@@ -40,16 +40,13 @@ class VWO
         return !value || value == 0 ? false : true if variable_type == VariableTypes.BOOLEAN
 
         return value if variable_type == VariableTypes::JSON
-      rescue StandardError => _e
-        VWO::Logger.get_instance.log(
+      rescue StandardError => e
+        Logger.log(
           LogLevelEnum::ERROR,
-          format(
-            LogMessageEnum::ErrorMessages::UNABLE_TO_TYPE_CAST,
-            file: FileNameEnum::FeatureUtil,
-            value: value,
-            variable_type: variable_type,
-            of_type: value.class.name
-          )
+          "unable to type cast variable value: #{e.message}",
+          {
+            '{file}' => FILE
+          }
         )
         nil
       end