vwo-sdk 1.30.0 → 1.37.1

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
@@ -67,30 +67,28 @@ class VWO
 
         impression = usage_stats.merge(impression)
 
-        logger = VWO::Logger.get_instance
-
         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::IMPRESSION_UTIL,
+              '{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::IMPRESSION_UTIL,
+              '{properties}' => JSON.generate(impression)
+            }
           )
         end
         impression
@@ -110,7 +108,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
@@ -129,6 +127,7 @@ class VWO
       #                                                             Else Properties(dict)
       def create_bulk_event_impression(settings_file, campaign_id, variation_id, user_id, goal_id = nil, revenue = nil)
         return unless valid_number?(campaign_id) && valid_string?(user_id)
+
         is_track_user_api = true
         is_track_user_api = false unless goal_id.nil?
         account_id = settings_file['accountId']
@@ -136,29 +135,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::IMPRESSION_UTIL,
+              '{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::IMPRESSION_UTIL,
+              '{properties}' => JSON.generate(impression)
+            }
           )
         end
         impression
@@ -171,7 +170,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,
@@ -179,12 +178,10 @@ class VWO
           env: settings_file['sdkKey'],
           eTime: get_current_unix_timestamp_in_millis,
           random: get_random_number,
-          p: "FS"
+          p: 'FS'
         }
 
-        if event_name == EventEnum::VWO_VARIATION_SHOWN
-          properties = properties.merge(usage_stats)
-        end
+        properties = properties.merge(usage_stats) if event_name == EventEnum::VWO_VARIATION_SHOWN
         properties
       end
 
@@ -193,11 +190,11 @@ class VWO
       # @param[Hash]                   :settings_file
       # @param[String]                 :user_id
       # @param[String]                 :event_name
-      # @param[Hash]                   :usage_stats
+      # @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']))
+      #
+      def get_event_base_payload(settings_file, user_id, event_name, _usage_stats = {})
+        uuid = generator_for(user_id, (settings_file['accountId']), true)
         sdk_key = settings_file['sdkKey']
 
         props = {
@@ -211,12 +208,12 @@ class VWO
         }
 
         # if usage_stats
-        #   props = props.merge(usage_stats)
+        #   props = props.merge(_usage_stats)
         # end
 
-        properties = {
+        {
           d: {
-            msgId: uuid + '_' + Time.now.to_i.to_s,
+            msgId: "#{uuid} + '_' + #{Time.now.to_i}",
             visId: uuid,
             sessionId: Time.now.to_i,
             event: {
@@ -231,8 +228,6 @@ class VWO
             }
           }
         }
-
-        properties
       end
 
       # Builds payload to track the visitor.
@@ -242,27 +237,26 @@ class VWO
       # @param[String]                 :event_name
       # @param[Integer]                :campaign_id
       # @param[Integer]                :variation_id
-      # @param[Hash]                   :usage_stats
+      # @param[Hash]                   :_usage_stats
       # @return[Hash]                  :properties
       #
-      def get_track_user_payload_data(settings_file, user_id, event_name, campaign_id, variation_id, usage_stats = {})
+      def get_track_user_payload_data(settings_file, user_id, event_name, campaign_id, variation_id, _usage_stats = {})
         properties = get_event_base_payload(settings_file, user_id, event_name)
         properties[:d][:event][:props][:id] = campaign_id
         properties[:d][:event][:props][:variation] = variation_id
 
-        #this is currently required by data-layer team, we can make changes on DACDN and remove it from here
+        # this is currently required by data-layer team, we can make changes on DACDN and remove it from here
         properties[:d][:event][:props][:isFirst] = 1
 
-        logger = VWO::Logger.get_instance
-        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
-          )
+        Logger.log(
+          LogLevelEnum::DEBUG,
+          'IMPRESSION_FOR_EVENT_ARCH_TRACK_USER',
+          {
+            '{file}' => FileNameEnum::IMPRESSION_UTIL,
+            '{accountId}' => settings_file['accountId'],
+            '{userId}' => user_id,
+            '{campaignId}' => campaign_id.to_s
+          }
         )
         properties
       end
@@ -281,20 +275,19 @@ class VWO
       def get_track_goal_payload_data(settings_file, user_id, event_name, revenue_value, metric_map, revenue_props = [])
         properties = get_event_base_payload(settings_file, user_id, event_name)
 
-        logger = VWO::Logger.get_instance
         metric = {}
         metric_map.each do |campaign_id, goal_id|
-          metric[('id_' + campaign_id.to_s).to_sym] = ['g_' + goal_id.to_s]
-          logger.log(
+          metric["id_#{campaign_id}".to_sym] = ["g_#{goal_id}"]
+          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::IMPRESSION_UTIL,
+              '{accountId}' => settings_file['accountId'],
+              '{goalName}' => event_name,
+              '{userId}' => user_id,
+              '{campaignId}' => campaign_id.to_s
+            }
           )
         end
 
@@ -302,7 +295,7 @@ class VWO
           metric: metric
         }
 
-        if revenue_props.length() != 0 && revenue_value
+        if revenue_props.length != 0 && revenue_value
           revenue_props.each do |revenue_prop|
             properties[:d][:event][:props][:vwoMeta][revenue_prop.to_sym] = revenue_value
           end
@@ -330,19 +323,27 @@ class VWO
           properties[:d][:visitor][:props][tag_key] = tag_value
         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::IMPRESSION_UTIL,
+            '{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 = {})
+        {
+          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,69 @@
+# 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(logs_type, message_type)
+        @@logs = VwoLogMessages.getMessage if @@logs.nil?
+
+        return message_type unless @@logs[logs_type].key?(message_type)
+
+        @@logs[logs_type][message_type]
+      end
+
+      def self.log(level, message_type, params, disable_logs = false)
+        return if disable_logs
+
+        message = case level
+                  when DEBUG
+                    get_log_message('debug_logs', message_type)
+                  when INFO
+                    get_log_message('info_logs', message_type)
+                  when ERROR
+                    get_log_message('error_logs', message_type)
+                  when WARN
+                    get_log_message('warning_logs', message_type)
+                  else
+                    ''
+                  end
+        message = message.dup
+
+        if message && !message.empty?
+          params.each do |key, value|
+            message[key.to_s] = value.to_s if message.include? key
+          end
+        end
+        message = "[#{@@api_name}] #{message}"
+        VWO::Logger.get_instance.log(level, message)
+      end
+    end
+  end
+end

data/lib/vwo/utils/request.rb

@@ -31,12 +31,11 @@ class VWO
         http.use_ssl = true
         uri.query = URI.encode_www_form(params)
         headers = {
-          'Authorization'=>params[:env],
-          'Content-Type' =>'application/json',
-          'Accept'=>'application/json'
+          'Authorization' => params[:env],
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
         }
-        response = http.post(uri, post_data.to_json, headers)
-        response
+        http.post(uri, post_data.to_json, headers)
       end
 
       def self.event_post(url, params, post_data, user_agent_value)
@@ -46,11 +45,10 @@ class VWO
         uri.query = URI.encode_www_form(params)
         headers = {
           'User-Agent' => user_agent_value,
-          'Content-Type' =>'application/json',
-          'Accept'=>'application/json'
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
         }
-        response = http.post(uri, post_data.to_json, headers)
-        response
+        http.post(uri, post_data.to_json, headers)
       end
     end
   end

data/lib/vwo/utils/utility.rb

@@ -19,37 +19,54 @@ require_relative '../constants'
 
 # Generic utility module
 class VWO
-    module Utils
-        module Utility
-            include Validations
-            include VWO::Utils
-            include VWO::CONSTANTS
+  module Utils
+    module Utility
+      include Validations
+      include VWO::Utils
+      include VWO::CONSTANTS
 
-            # converting hash with keys as strings into hash with keys as strings
-            # @param[Hash]
-            # @return[Hash]
-            def convert_to_symbol_hash(hashObject)
-                hashObject ||= {}
-                convertedHash = {}
-                hashObject.each do |key, value|
-                    if valid_hash?(value)
-                        convertedHash[key.to_sym] = convert_to_symbol_hash(value)
-                    else
-                        convertedHash[key.to_sym] = value
-                    end
-                end
-                convertedHash
-            end
+      # converting hash with keys as strings into hash with keys as strings
+      # @param[Hash]
+      # @return[Hash]
+      def convert_to_symbol_hash(hash_object)
+        hash_object ||= {}
+        converted_hash = {}
+        hash_object.each do |key, value|
+          converted_hash[key.to_sym] = if valid_hash?(value)
+                                         convert_to_symbol_hash(value)
+                                       else
+                                         value
+                                       end
+        end
+        converted_hash
+      end
+
+      def remove_sensitive_properties(properties)
+        properties.delete('env')
+        properties.delete('env'.to_sym)
+        JSON.generate(properties)
+      end
 
-            def remove_sensitive_properties(properties)
-                properties.delete("env")
-                properties.delete("env".to_sym)
-                JSON.generate(properties)
-            end
+      def get_url(endpoint)
+        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
 
-            def get_url(endpoint)
-                return DataLocationManager.get_instance().get_data_location + endpoint
-            end
+      def get_variation_identifiers(variation)
+        if variation['goal_identifier']
+          identifiers = variation['goal_identifier'].split(VWO_DELIMITER)
+        else
+          variation['goal_identifier'] = ''
+          identifiers = []
         end
+        identifiers
+      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