vwo-sdk 1.29.1 → 1.36.0

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::CampaignUtil,
+              '{campaignKey}' => campaign['key'],
+              '{variationName}' => variation['name'],
+              '{variationWeight}' => variation['weight'],
+              '{start}' => variation['start_variation_allocation'],
+              '{end}' => variation['end_variation_allocation']
+            }
           )
         end
       end
@@ -183,13 +182,13 @@ class VWO
           end
         end
         if campaigns.length() == 0
-          VWO::Logger.get_instance.log(
+          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::CampaignUtil,
+              '{goalIdentifier}' => goal_identifier
+            }
           )
         end
         return campaigns
@@ -255,14 +254,14 @@ 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

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::CustomDimensionsUtil,
+            '{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::CustomDimensionsUtil,
+            '{properties}' => JSON.generate(params)
+          }
         )
         params
       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
@@ -41,15 +41,12 @@ class VWO
 
         return value if variable_type == VariableTypes::JSON
       rescue StandardError => _e
-        VWO::Logger.get_instance.log(
+        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

data/lib/vwo/utils/impression.rb

@@ -14,9 +14,9 @@
 
 require 'json'
 require 'cgi'
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
+require_relative './log_message'
 require_relative 'function'
 require_relative 'uuid'
 require_relative 'utility'
@@ -57,7 +57,7 @@ class VWO
           combination: variation_id,
           random: get_random_number,
           sId: get_current_unix_timestamp,
-          u: generator_for(user_id, account_id),
+          u: generator_for(user_id, account_id, true),
           env: sdk_key
         }
         # Version and SDK constants
@@ -72,25 +72,25 @@ class VWO
         if is_track_user_api
           impression['ed'] = JSON.generate(p: 'server')
           impression['url'] = HTTPS_PROTOCOL + get_url(ENDPOINTS::TRACK_USER)
-          logger.log(
+          Logger.log(
             LogLevelEnum::DEBUG,
-            format(
-              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_USER,
-              file: FileNameEnum::ImpressionUtil,
-              properties: remove_sensitive_properties(impression)
-            )
+            'IMPRESSION_FOR_TRACK_USER',
+            {
+              '{file}' => FileNameEnum::ImpressionUtil,
+              '{properties}' => remove_sensitive_properties(impression)
+            }
           )
         else
           impression['url'] = HTTPS_PROTOCOL + get_url(ENDPOINTS::TRACK_GOAL)
           impression['goal_id'] = goal_id
           impression['r'] = revenue if revenue
-          logger.log(
+          Logger.log(
             LogLevelEnum::DEBUG,
-            format(
-              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_GOAL,
-              file: FileNameEnum::ImpressionUtil,
-              properties: remove_sensitive_properties(impression)
-            )
+            'IMPRESSION_FOR_TRACK_GOAL',
+            {
+              '{file}' => FileNameEnum::ImpressionUtil,
+              '{properties}' => JSON.generate(impression)
+            }
           )
         end
         impression
@@ -110,7 +110,7 @@ class VWO
           'sdk-v' => SDK_VERSION,
           'ap' => PLATFORM,
           'sId' => get_current_unix_timestamp,
-          'u' => generator_for(user_id, account_id),
+          'u' => generator_for(user_id, account_id, true),
           'account_id' => account_id
         }
       end
@@ -136,29 +136,29 @@ class VWO
           eT: is_track_user_api ? 1 : 2,
           e: campaign_id,
           c: variation_id,
-          u: generator_for(user_id, account_id),
+          u: generator_for(user_id, account_id, true),
           sId: get_current_unix_timestamp
         }
         logger = VWO::Logger.get_instance
         if is_track_user_api
-          logger.log(
+          Logger.log(
             LogLevelEnum::DEBUG,
-            format(
-              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_USER,
-              file: FileNameEnum::ImpressionUtil,
-              properties: JSON.generate(impression)
-            )
+            'IMPRESSION_FOR_TRACK_USER',
+            {
+              '{file}' => FileNameEnum::ImpressionUtil,
+              '{properties}' => remove_sensitive_properties(impression)
+            }
           )
         else
           impression['g'] = goal_id
           impression['r'] = revenue if revenue
-          logger.log(
+          Logger.log(
             LogLevelEnum::DEBUG,
-            format(
-              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_GOAL,
-              file: FileNameEnum::ImpressionUtil,
-              properties: JSON.generate(impression)
-            )
+            'IMPRESSION_FOR_TRACK_GOAL',
+            {
+              '{file}' => FileNameEnum::ImpressionUtil,
+              '{properties}' => JSON.generate(impression)
+            }
           )
         end
         impression
@@ -171,7 +171,7 @@ class VWO
       # @param[String]                    :event_name
       # @param[Hash]                      :usage_stats
       # @return[Hash]                     :properties
-      # 
+      #
       def get_events_base_properties(settings_file, event_name, usage_stats = {})
         properties = {
           en: event_name,
@@ -195,9 +195,9 @@ class VWO
       # @param[String]                 :event_name
       # @param[Hash]                   :usage_stats
       # @return[Hash]                  :properties
-      # 
+      #
       def get_event_base_payload(settings_file, user_id, event_name, usage_stats = {})
-        uuid = generator_for(user_id, (settings_file['accountId']))
+        uuid = generator_for(user_id, (settings_file['accountId']), true)
         sdk_key = settings_file['sdkKey']
 
         props = {
@@ -254,15 +254,15 @@ class VWO
         properties[:d][:event][:props][:isFirst] = 1
 
         logger = VWO::Logger.get_instance
-        logger.log(
+        Logger.log(
             LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::IMPRESSION_FOR_EVENT_ARCH_TRACK_USER,
-            file: FileNameEnum::ImpressionUtil,
-            a: settings_file['accountId'],
-            u: user_id,
-            c: campaign_id.to_s
-          )
+            'IMPRESSION_FOR_EVENT_ARCH_TRACK_USER',
+            {
+              '{file}' => FileNameEnum::ImpressionUtil,
+              '{accountId}' => settings_file['accountId'],
+              '{userId}' => user_id,
+              '{campaignId}' => campaign_id.to_s
+            }
         )
         properties
       end
@@ -285,16 +285,16 @@ class VWO
         metric = {}
         metric_map.each do |campaign_id, goal_id|
           metric[('id_' + campaign_id.to_s).to_sym] = ['g_' + goal_id.to_s]
-          logger.log(
+          Logger.log(
             LogLevelEnum::DEBUG,
-            format(
-              LogMessageEnum::DebugMessages::IMPRESSION_FOR_EVENT_ARCH_TRACK_GOAL,
-              file: FileNameEnum::ImpressionUtil,
-              goal_identifier: event_name,
-              a: settings_file['accountId'],
-              u: user_id,
-              c: campaign_id
-            )
+            'IMPRESSION_FOR_EVENT_ARCH_TRACK_GOAL',
+            {
+              '{file}' => FileNameEnum::ImpressionUtil,
+              '{accountId}' => settings_file['accountId'],
+              '{goalName}' => event_name,
+              '{userId}' => user_id,
+              '{campaignId}' => campaign_id.to_s
+            }
           )
         end
 
@@ -331,18 +331,27 @@ class VWO
         end
 
         logger = VWO::Logger.get_instance
-        logger.log(
+        Logger.log(
           LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::IMPRESSION_FOR_EVENT_ARCH_PUSH,
-            file: FileNameEnum::ImpressionUtil,
-            a: settings_file['accountId'],
-            u: user_id,
-            property: JSON.generate(custom_dimension_map)
-          )
+          'IMPRESSION_FOR_EVENT_ARCH_PUSH',
+          {
+            '{file}' => FileNameEnum::ImpressionUtil,
+            '{accountId}' => settings_file['accountId'],
+            '{userId}' => user_id,
+            '{property}' => JSON.generate(custom_dimension_map)
+          }
         )
         properties
       end
+
+      def get_batch_event_query_params(account_id, sdk_key, usage_stats = {})
+        return {
+          a: account_id,
+          sd: SDK_NAME,
+          sv: SDK_VERSION,
+          env: sdk_key
+        }.merge(usage_stats)
+      end
     end
   end
 end

data/lib/vwo/utils/log_message.rb

@@ -0,0 +1,76 @@
+# Copyright 2019-2022 Wingify Software Pvt. Ltd.
+#
+# 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 'vwo_log_messages'
+
+require_relative '../logger'
+
+class VWO
+  module Utils
+    class Logger
+
+      DEBUG = ::Logger::DEBUG
+      INFO = ::Logger::INFO
+      ERROR = ::Logger::ERROR
+      WARN = ::Logger::WARN
+
+      @@logs = nil
+      @@api_name = 'api_name'
+
+      def self.set_api_name(api_name)
+        @@api_name = api_name
+      end
+
+      def self.get_log_message(logsType, message_type)
+        if @@logs.nil?
+          @@logs = VwoLogMessages.getMessage
+        end
+
+        if !@@logs[logsType].key?(message_type)
+          return message_type
+        end
+        return @@logs[logsType][message_type]
+      end
+
+      def self.log(level, message_type, params, disable_logs = false)
+        if disable_logs
+          return
+        end
+        if level == DEBUG
+          message = get_log_message('debug_logs', message_type)
+        elsif level == INFO
+          message = get_log_message('info_logs', message_type)
+        elsif level == ERROR
+          message = get_log_message('error_logs', message_type)
+        elsif level == WARN
+          message = get_log_message('warning_logs', message_type)
+        else
+          message = ""
+        end
+        message = message.dup
+
+        if message && !message.empty?
+          params.each {
+            |key, value|
+            if message.include? key
+              message[key.to_s]= value.to_s
+            end
+          }
+        end
+        message = '[' + @@api_name + '] ' + message
+        VWO::Logger.get_instance.log(level, message)
+      end
+    end
+  end
+end

data/lib/vwo/utils/utility.rb

@@ -50,6 +50,13 @@ class VWO
             def get_url(endpoint)
                 return DataLocationManager.get_instance().get_data_location + endpoint
             end
+
+            def prepare_push_response(custom_dimension_map, resp, result)
+                custom_dimension_map.each do |tag_key, tag_value|
+                    result[tag_key] = resp
+                end
+                result
+            end
         end
     end
 end

data/lib/vwo/utils/uuid.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 require 'digest'
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
+require_relative './log_message'
 
 # Utility module for generating uuid
 class VWO
@@ -53,10 +53,11 @@ class VWO
       #
       # @param[Integer|String]      :user_id        User identifier
       # @param[Integer|String]      :account_id     Account identifier
+      # @param[Boolean]             :disable_logs   if true, do not log log-message
       #
       # @return[Integer]                            Desired UUID
       #
-      def generator_for(user_id, account_id)
+      def generator_for(user_id, account_id, disable_logs = false)
         user_id = user_id.to_s
         account_id = account_id.to_s
         user_id_namespace = generate(VWO_NAMESPACE, account_id)
@@ -64,15 +65,16 @@ class VWO
 
         desired_uuid = uuid_for_account_user_id.delete('-').upcase
 
-        VWO::Logger.get_instance.log(
+        Logger.log(
           LogLevelEnum::DEBUG,
-          format(
-            LogMessageEnum::DebugMessages::UUID_FOR_USER,
-            file: FileNameEnum::UuidUtil,
-            user_id: user_id,
-            account_id: account_id,
-            desired_uuid: desired_uuid
-          )
+          'USER_UUID',
+          {
+            '{file}' => FILE,
+            '{userId}' => user_id,
+            '{accountId}' => account_id,
+            '{uuid}' => desired_uuid
+          },
+          disable_logs
         )
         desired_uuid
       end

data/lib/vwo/utils/validations.rb

@@ -15,13 +15,14 @@
 require 'json'
 require 'json-schema'
 require_relative '../schemas/settings_file'
-require_relative '../logger'
 require_relative '../enums'
 require_relative '../constants'
+require_relative './log_message'
 
 class VWO
   module Utils
     module Validations
+      include Enums
       # Validates the settings_file
       # @param [Hash]:  JSON object received from VWO server
       #                 must be JSON.
@@ -66,83 +67,90 @@ class VWO
       # Validates if the value passed batch_events has correct data type and values or not.
       #
       # Args: batch_events [Hash]: value to be tested
+      #       api_name     [String]: current api name
       #
       # @return: [Boolean]: True if all conditions are passed else False
-      def is_valid_batch_event_settings(batch_events)
-        logger = VWO::Logger.get_instance
+      def is_valid_batch_event_settings(batch_events, api_name)
         events_per_request = batch_events[:events_per_request]
         request_time_interval = batch_events[:request_time_interval]
 
         unless events_per_request || request_time_interval
-          logger.log(
-            VWO::LogLevelEnum::ERROR,
-            format(
-              VWO::LogMessageEnum::ErrorMessages::EVENT_BATCHING_INSUFFICIENT,
-              file: VWO::FileNameEnum::ValidateUtil
-            )
-          )
+          invalid_config_log('batch_events', 'object', api_name)
           return false
         end
 
         if (request_time_interval && !valid_number?(request_time_interval))
-          logger.log(
-            VWO::LogLevelEnum::ERROR,
-            format(
-              VWO::LogMessageEnum::ErrorMessages::REQUEST_TIME_INTERVAL_INVALID,
-              file: VWO::FileNameEnum::ValidateUtil
-            )
-          )
+          invalid_config_log('batch_events', 'object', api_name)
           return false
         end
 
         if (events_per_request && !valid_number?(events_per_request))
-          logger.log(
-            VWO::LogLevelEnum::ERROR,
-            format(
-              VWO::LogMessageEnum::ErrorMessages::EVENTS_PER_REQUEST_INVALID,
-              file: VWO::FileNameEnum::ValidateUtil
-            )
-          )
+          invalid_config_log('batch_events', 'object', api_name)
           return false
         end
 
         if events_per_request && (events_per_request < VWO::MIN_EVENTS_PER_REQUEST || events_per_request > VWO::MAX_EVENTS_PER_REQUEST)
-          logger.log(
-            VWO::LogLevelEnum::ERROR,
-            format(
-              VWO::LogMessageEnum::ErrorMessages::EVENTS_PER_REQUEST_OUT_OF_BOUNDS,
-              file: VWO::FileNameEnum::ValidateUtil,
-              min_value: VWO::MIN_EVENTS_PER_REQUEST,
-              max_value: VWO::MAX_EVENTS_PER_REQUEST
-            )
-          )
+          invalid_config_log('batch_events', 'object', api_name)
           return false
         end
 
         if request_time_interval && request_time_interval < VWO::MIN_REQUEST_TIME_INTERVAL
-          logger.log(
-            VWO::LogLevelEnum::ERROR,
-            format(
-              VWO::LogMessageEnum::ErrorMessages::REQUEST_TIME_INTERVAL_OUT_OF_BOUNDS,
-              file: VWO::FileNameEnum::ValidateUtil,
-              min_value: VWO::MIN_REQUEST_TIME_INTERVAL
-            )
-          )
+          invalid_config_log('batch_events', 'object', api_name)
           return false
         end
 
         if batch_events.key?(:flushCallback) && !batch_events[:flushCallback].is_a?(Method)
-          logger.log(
-            VWO::LogLevelEnum::ERROR,
-            format(
-              VWO::LogMessageEnum::ErrorMessages::FLUSH_CALLBACK_INVALID,
-              file: VWO::FileNameEnum::ValidateUtil
-            )
-          )
+          invalid_config_log('batch_events', 'object', api_name)
           return false
         end
         true
       end
+
+      def validate_sdk_config?(user_storage, is_development_mode, api_name)
+        if is_development_mode
+          if [true, false].include? is_development_mode
+            valid_config_log('isDevelopmentMode', 'boolean')
+          else
+            invalid_config_log('isDevelopmentMode', 'boolean', api_name)
+            return false
+          end
+        end
+
+        if user_storage
+          if user_storage.is_a?(UserStorage)
+            valid_config_log('UserStorageService', 'object')
+          else
+            invalid_config_log('UserStorageService', 'object', api_name)
+            return false
+          end
+        end
+        true
+      end
+
+      def valid_config_log(parameter, type)
+        Logger.log(
+          LogLevelEnum::INFO,
+          'CONFIG_PARAMETER_USED',
+          {
+            '{file}' => VWO::FileNameEnum::ValidateUtil,
+            '{parameter}' => parameter,
+            '{type}' => type
+          }
+        )
+      end
+
+      def invalid_config_log(parameter, type, api_name)
+        Logger.log(
+          LogLevelEnum::ERROR,
+          'CONFIG_PARAMETER_INVALID',
+          {
+            '{file}' => VWO::FileNameEnum::ValidateUtil,
+            '{parameter}' => parameter,
+            '{type}' => type,
+            '{api}' => api_name
+          }
+        )
+      end
     end
   end
 end