vwo-fme-ruby-sdk 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba596eb41128d18fecdbac11316dfe345d0fdcd2b8c1a0a612b1145bde5b779
-  data.tar.gz: 0ca14ec46f853f5cd86171ee4a0a7c93fb57f009872f847e2777fc3375e01cd6
+  metadata.gz: 8935c2c79e2fc5cd17d450d4a21fdf48fda27343455ad939bb2a7b66820ae2ec
+  data.tar.gz: 3e0297e44ac33c862aad76b8e04ba7b944acc4c38b476582e931a53c14ffd483
 SHA512:
-  metadata.gz: 398d9be0a02c8b364712eb1b1ef38061138ecfcd71a8ec4f8ec5a6ad5d7ef1b0a6ee678f8ed1cb057bc6db337baf885cd3852c0ad935d480d5cd705ab7e2768c
-  data.tar.gz: ae7f284247ccc40c0c881dcd7ab23665989b71f3252931e755417a428cc606cf5e7af091cac9a28f20d274c5a782afab095633635ced57a23879b965579d56a6
+  metadata.gz: d05fef9ef3277e071c8cbf3f7582dc7845e1e99c63247b6db440975c46bbb685f8b5723bc67850fd2666bfd1d69e7fe17fafbdf1f711aa562bff013d7c65f48d
+  data.tar.gz: e39b7eaf87dc0bb3540519649a96b85e4178775948d88f7a60aedf6e430aa977c7ff1f27b5f53860f86e37233544da21975a66e767683be3566fec3ec2f261ed

data/lib/resources/error_messages.json

@@ -1,34 +1,62 @@
 {
-    "API_THROW_ERROR": "API - {apiName} failed to execute. Trace:{err}",
-    "INIT_OPTIONS_ERROR": "[ERROR]: VWO-SDK {date} Options should be of type object",
-    "INIT_OPTIONS_SDK_KEY_ERROR": "[ERROR]: VWO-SDK {date} Please provide the sdkKey in the options and should be a of type string",
-    "INIT_OPTIONS_ACCOUNT_ID_ERROR": "[ERROR]: VWO-SDK {date} Please provide VWO account ID in the options and should be a of type string|number",
+    "EXECUTION_FAILED": "API - {apiName} failed to execute. Error:{err}",
+    "INVALID_OPTIONS": "[ERROR]: VWO-SDK {date} Options should be of type object",
+    "INVALID_SDK_KEY_IN_OPTIONS": "[ERROR]: VWO-SDK {date} Please provide the sdkKey in the options and should be a of type string",
+    "INVALID_ACCOUNT_ID_IN_OPTIONS": "[ERROR]: VWO-SDK {date} Please provide VWO account ID in the options and should be a of type string|number",
+
+    "ERROR_ADDING_CAMPAIGNS_TO_RULES": "Error setting and adding campaigns to rules. Error: {err}",
   
-    "INIT_OPTIONS_INVALID": "Invalid key:{key} passed in options. Should be of type:{correctType} and greater than equal to 1000",
+    "INVALID_POLLING_CONFIGURATION": "Invalid key:{key} passed in options. Should be of type:{correctType} and greater than or equal to 1000",
   
-    "SETTINGS_FETCH_ERROR": "Settings could not be fetched. Error:{err}",
-    "SETTINGS_SCHEMA_INVALID": "Settings are not valid. Failed schema validation",
+    "ERROR_FETCHING_SETTINGS": "Settings could not be fetched. Error:{err}",
+    "INVALID_SETTINGS_SCHEMA": "Settings are not valid for account ID: {accountId} and SDK key: {sdkKey}. Got settings as {settings}",
   
-    "POLLING_FETCH_SETTINGS_FAILED": "Error while fetching VWO settings with polling",
+    "ERROR_UPDATING_SETTINGS": "Error while updating settings. Error: {err}",
+    "UPDATING_CLIENT_INSTANCE_FAILED_WHEN_WEBHOOK_TRIGGERED": "Failed to fetch settings and hence VWO client instance couldn't be updated when API: {apiName} got called having isViaWebhook param as {isViaWebhook}. Error: {err}",
   
-    "API_INVALID_PARAM": "Key:{key} passed to API:{apiName} is not of valid type. Got type:{type}, should be:{correctType}",
-    "API_SETTING_INVALID": "Settings are not valid. Contact VWO Support",
-    "API_CONTEXT_INVALID": "Context should be an object and must contain a mandatory key - id, which is User ID",
+    "INVALID_PARAM": "Key:{key} passed to API:{apiName} is not of valid type. Got type:{type}, should be:{correctType}",
+    "INVALID_CONTEXT": "Context should be an object and must contain a mandatory key - id, which is User ID",
   
     "FEATURE_NOT_FOUND": "Feature not found for the key:{featureKey}",
     "EVENT_NOT_FOUND": "Event:{eventName} not found in any of the features' metrics",
   
-    "STORED_DATA_ERROR": "Error in getting data from storage. Error:{err}",
-    "STORING_DATA_ERROR": "Key:{featureKey} is not valid. Not able to store data into storage",
+    "ERROR_READING_DATA_FROM_STORAGE": "Error while reading data from storage. Error: {err}",
+    "ERROR_STORING_DATA_IN_STORAGE": "Error while storing data in storage. Error: {err}",
   
-    "GATEWAY_URL_ERROR": "Please provide a valid URL for VWO Gateway Service while initializing the SDK",
+    "INVALID_GATEWAY_URL": "Please provide a valid URL for VWO Gateway Service while initializing the SDK",
+    "INVALID_RETRY_CONFIG": "Retry config is invalid. Should be of type:object",
   
-    "NETWORK_CALL_FAILED": "Error occurred while sending {method} request. Error:{err}",
-    "SETTINGS_FETCH_FAILED": "Failed to fetch settings and hence VWO client instance couldn't be updated when API: {apiName} got called having isViaWebhook param as {isViaWebhook}. Error: {err}",
+    "NETWORK_CALL_FAILED": "Error occurred for {method} request. Error:{err}",
     "NETWORK_CALL_RETRY_ATTEMPT": "Request failed for {endPoint}, Error: {err}. Retrying in {delay} seconds, attempt {attempt} of {maxRetries}",
     "NETWORK_CALL_RETRY_FAILED": "Max retries reached. Request failed for {endPoint}, Error: {err}",
+    "ATTEMPTING_RETRY_FOR_FAILED_NETWORK_CALL": "Request failed for {endPoint}, Error: {err}. Retrying in {delay} seconds, attempt {attempt} of {maxRetries}",
+    "NETWORK_CALL_FAILURE_AFTER_MAX_RETRIES": "Network request failed after {attempts} attempts for {extraData}. Error: {err}",
 
-    "CONFIG_PARAMETER_INVALID": "{parameter} paased in {api} API is not correct. It should be of type:{type}}",
     "BATCH_QUEUE_EMPTY": "No batch queue present for account:{accountId} when calling flushEvents API. Check batchEvents config in init API",
-    "INVALID_BATCH_EVENTS_CONFIG": "Invalid batch events config, should be a hash, events_per_request should be a number greater than 0 and request_time_interval should be a number greater than 0"
+    "INVALID_BATCH_EVENTS_CONFIG": "Invalid batch events config, should be a hash, events_per_request should be a number greater than 0 and request_time_interval should be a number greater than 0",
+    "FAILED_TO_INITIALIZE_SERVICE": "Failed to initialize {service}: {err}",
+
+    "ERROR_SETTING_SEGMENTATION_CONTEXT": "Error in setting contextual data for segmentation. Got error: {err}",
+    "ERROR_VALIDATING_SEGMENTATION": "Error in validating segmentation. Got error: {err}",
+    "USER_AGENT_VALIDATION_ERROR": "Failed to validate user agent. Error: {err}",
+    "INVALID_IP_ADDRESS_IN_CONTEXT_FOR_PRE_SEGMENTATION": "ipAddress is required in context to evaluate location pre-segmentation",
+    "INVALID_USER_AGENT_IN_CONTEXT_FOR_PRE_SEGMENTATION": "userAgent is required in context to evaluate user-agent pre-segmentation",
+    "INVALID_ATTRIBUTE_LIST_FORMAT": "Invalid inList operand format",
+    "ERROR_FETCHING_DATA_FROM_GATEWAY": "Error while fetching data from gateway. Error: {err}",
+
+    "ATTRIBUTES_MAP_ERROR": "Attributes map must contain atleast 1 key-value pair",
+    "ATTRIBUTES_MAP_INVALID": "Attributes should be an object containing key-value pairs",
+
+    "VALUES_MISMATCH_BATCHING_NOT_ENABLED": "Values mismatch from the expectation of both parameters. Batching not initialized.",
+    "INVALID_EVENTS_PER_REQUEST_VALUE": "Events_per_request values is invalid (should be greater than 0 and less than 5000). Using default value of events_per_request parameter : 100",
+    "INVALID_REQUEST_TIME_INTERVAL_VALUE": "Request_time_interval values is invalid (should be greater than 0). Using default value of request_time_interval parameter : 600",
+    "BATCHING_NOT_ENABLED": "Batching is not enabled. Pass batchEventData in the SDK configuration while invoking init API.",
+
+    "ERROR_CHECKING_FEATURE_IN_USER_STORAGE": "Error while checking feature in user storage. Got error: {err}",
+
+    "ERROR_FINDING_WINNER_CAMPAIGN": "Error while finding winner campaign inside {method}. Error: {err}",
+
+    "ERROR_EVALUATING_RULE": "Error occurred while evaluating rule. Error: {err}",
+    "BATCH_FLUSH_FAILED": "Failed to send batch events. Re-enqueuing events for retry.",
+    "ERROR_PARSING_GATEWAY_URL": "Error occurred while parsing gateway service URL: {err}"
   }

data/lib/resources/info_messages.json

@@ -29,7 +29,7 @@
     "MEG_CAMPAIGN_ELIGIBLE": "Campaign {campaignKey} is eligible for user ID:{userId}",
     "MEG_WINNER_CAMPAIGN": "MEG: Campaign {campaignKey} is the winner for group {groupId} for user ID:{userId} {algo}",
     "SETTINGS_UPDATED": "Settings fetched and updated successfully on the current VWO client instance when API: {apiName} got called having isViaWebhook param as {isViaWebhook}",
-    "NETWORK_CALL_SUCCESS": "Impression for {event} - {endPoint} was successfully received by VWO having Account ID:{accountId}, User ID:{userId} and UUID: {uuid}",
+    "NETWORK_CALL_SUCCESS": "Impression for {event} - {endPoint} was successfully received by VWO having Account ID:{accountId}, UUID: {uuid}",
 
     "EVENT_BATCH_DEFAULTS": "{parameter} in SDK configuration is missing or invalid (should be greater than {minLimit}). Using default value: {defaultValue}",
     "EVENT_QUEUE": "Event with payload:{event} pushed to the {queueType} queue",
@@ -37,5 +37,6 @@
     "IMPRESSION_BATCH_SUCCESS": "Impression event - {endPoint} was successfully received by VWO having Account ID:{accountId}",
     "IMPRESSION_BATCH_FAILED": "Batch events couldn\"t be received by VWO. Calling Flush Callback with error and data",
     "EVENT_BATCH_MAX_LIMIT": "{parameter} passed in SDK configuration is greater than the maximum limit of {maxLimit}. Setting it to the maximum limit",
-    "GATEWAY_AND_BATCH_EVENTS_CONFIG_MISMATCH": "Batch Events config passed in SDK configuration will not work as the gatewayService is already configured. Please check the documentation for more details"
+    "GATEWAY_AND_BATCH_EVENTS_CONFIG_MISMATCH": "Batch Events config passed in SDK configuration will not work as the gatewayService is already configured. Please check the documentation for more details",
+    "NETWORK_CALL_SUCCESS_WITH_RETRIES": "Network call for {extraData} succeeded after {attempts} retry attempt(s). Previous attempts failed with error: {err}"
   }

data/lib/vwo/api/get_flag.rb

@@ -90,7 +90,7 @@ class FlagApi
       end
   
       if feature.nil?
-        LoggerService.log(LogLevelEnum::ERROR, "FEATURE_NOT_FOUND", {featureKey: feature_key})
+        LoggerService.log(LogLevelEnum::ERROR, "FEATURE_NOT_FOUND", {featureKey: feature_key, an: ApiEnum::GET_FLAG, sId: context.get_session_id, uuid: context.get_uuid})
         return GetFlagResponse.new(false, [])
       end
   
@@ -130,7 +130,7 @@ class FlagApi
             rollout_variation_to_return = variation
             update_integrations_decision_object(passed_rollout_campaign, variation, passed_rules_information, decision)
   
-            create_and_send_impression_for_variation_shown(settings, passed_rollout_campaign.get_id, variation.get_id, context)
+            create_and_send_impression_for_variation_shown(settings, passed_rollout_campaign.get_id, variation.get_id, context, feature_key)
           end
         end
       elsif rollout_rules.empty?
@@ -175,17 +175,21 @@ class FlagApi
             experiment_variation_to_return = variation
             update_integrations_decision_object(campaign, variation, passed_rules_information, decision)
   
-            create_and_send_impression_for_variation_shown(settings, campaign.get_id, variation.get_id, context)
+            create_and_send_impression_for_variation_shown(settings, campaign.get_id, variation.get_id, context, feature_key)
           end
         end
       end
   
       # Store evaluated feature in storage
       if is_enabled
-        StorageDecorator.new.set_data_in_storage(
-          { feature_key: feature_key, context: context }.merge(passed_rules_information),
-          storage_service
-        )
+        begin
+          StorageDecorator.new.set_data_in_storage(
+            { feature_key: feature_key, context: context }.merge(passed_rules_information),
+            storage_service
+          )
+        rescue StandardError => e
+          LoggerService.log(LogLevelEnum::ERROR, "ERROR_STORING_DATA_IN_STORAGE", { err: e.message, an: ApiEnum::GET_FLAG, sId: context.get_session_id, uuid: context.get_uuid})
+        end
       end
   
       # Execute hooks
@@ -209,7 +213,8 @@ class FlagApi
           settings,
           feature&.get_impact_campaign&.get_campaign_id,
           variation_id,
-          context
+          context,
+          feature_key
         )
       end
   

data/lib/vwo/api/track_event.rb

@@ -35,14 +35,14 @@ class TrackApi
       create_impression_for_track(event_name, context, event_properties)
 
       # Set and execute integration callback for the track event
-      hooks_service.set({ event_name: event_name, api: ApiEnum::TRACK })
+      hooks_service.set({ event_name: event_name, api: ApiEnum::TRACK_EVENT })
       hooks_service.execute(hooks_service.get)
 
       return { event_name: true }
     end
 
     # Log an error if the event does not exist
-    LoggerService.log(LogLevelEnum::ERROR, "EVENT_NOT_FOUND", { eventName: event_name })
+    LoggerService.log(LogLevelEnum::ERROR, "EVENT_NOT_FOUND", { eventName: event_name, an: ApiEnum::TRACK_EVENT, sId: context.get_session_id, uuid: context.get_uuid})
 
     { event_name: false }
   end

data/lib/vwo/constants/constants.rb

@@ -17,7 +17,7 @@
 # Define the Constants module
 module Constants
   SDK_NAME = 'vwo-fme-ruby-sdk'.freeze
-  SDK_VERSION = '1.6.0'.freeze
+  SDK_VERSION = '1.7.0'.freeze
 
   MAX_TRAFFIC_PERCENT = 100
   MAX_TRAFFIC_VALUE = 10_000
@@ -57,4 +57,27 @@ module Constants
   MAX_QUEUE_SIZE = 10000
 
   PRODUCT_NAME = 'fme'.freeze
+
+  REQUEST_TIMEOUT = 10 # 10 seconds
+
+  # Retry mechanism constants
+  MAX_RETRIES = 3
+  INITIAL_RETRY_DELAY = 2 # seconds
+  RETRY_BACKOFF_FACTOR = 2
+
+  # Default retry configuration
+  DEFAULT_RETRY_CONFIG = {
+    should_retry: true,
+    initial_delay: 2,
+    max_retries: 3,
+    backoff_multiplier: 2
+  }.freeze
+
+  # debugger event constants
+  V2_SETTINGS = 'v2-settings'.freeze
+  POLLING = 'polling'.freeze
+  BATCH_EVENTS = 'batch-events'.freeze
+  NETWORK_CALL_FAILURE_AFTER_MAX_RETRIES = 'NETWORK_CALL_FAILURE_AFTER_MAX_RETRIES'.freeze
+  NETWORK_CALL_SUCCESS_WITH_RETRIES = 'NETWORK_CALL_SUCCESS_WITH_RETRIES'.freeze
+  IMPACT_ANALYSIS = 'IMPACT_ANALYSIS'.freeze
 end

data/lib/vwo/decorators/storage_decorator.rb

@@ -53,22 +53,18 @@ class StorageDecorator
     experiment_variation_id = data[:experiment_variation_id]
 
     if feature_key.nil?
-      LoggerService.log(LogLevelEnum::ERROR, "STORING_DATA_ERROR", { key: 'featureKey' })
       raise 'Feature key is missing'
     end
 
     if context.nil? || context.id.nil?
-      LoggerService.log(LogLevelEnum::ERROR, "STORING_DATA_ERROR", { key: 'Context or Context.id' })
       raise 'Context ID is missing'
     end
 
     if rollout_key && !experiment_key && !rollout_variation_id
-      LoggerService.log(LogLevelEnum::ERROR, "STORING_DATA_ERROR", { key: 'Variation:(rolloutKey, experimentKey or rolloutVariationId)' })
       raise 'Invalid rollout variation'
     end
 
     if experiment_key && !experiment_variation_id
-      LoggerService.log(LogLevelEnum::ERROR, "STORING_DATA_ERROR", { key: 'Variation:(experimentKey or rolloutVariationId)' })
       raise 'Invalid experiment variation'
     end
 
@@ -81,6 +77,6 @@ class StorageDecorator
       experiment_id: experiment_id,
       experiment_key: experiment_key,
       experiment_variation_id: experiment_variation_id
-    })
+    }, context)
   end
 end

data/lib/vwo/enums/api_enum.rb

@@ -13,7 +13,11 @@
 # limitations under the License.
 
 module ApiEnum
-    GET_FLAG = 'getFlag'
-    TRACK = 'track'
-  end
+  INIT = 'init'
+  GET_FLAG = 'getFlag'
+  TRACK_EVENT = 'trackEvent'
+  SET_ATTRIBUTE = 'setAttribute'
+  UPDATE_SETTINGS = 'updateSettings'
+  FLUSH_EVENTS = 'flushEvents'
+end
   

data/lib/vwo/enums/debug_category_enum.rb

@@ -0,0 +1,20 @@
+# Copyright 2024-2025 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.
+
+module DebugCategoryEnum
+    DECISION = 'decision'
+    NETWORK = 'network'
+    RETRY = 'retry'
+    ERROR = 'error'
+end

data/lib/vwo/enums/event_enum.rb

@@ -16,6 +16,7 @@
 module EventEnum
     VWO_VARIATION_SHOWN = 'vwo_variationShown'
     VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp'
+    VWO_DEBUGGER_EVENT = 'vwo_sdkDebug'
     VWO_INIT_CALLED = 'vwo_fmeSdkInit'
     VWO_USAGE_STATS = 'vwo_sdkUsageStats'
 end

data/lib/vwo/models/user/context_model.rb

@@ -13,11 +13,13 @@
 # limitations under the License.
 
 require_relative './context_vwo_model'
+require_relative '../../utils/uuid_util'
+require_relative '../../services/settings_service'
 
 class ContextModel
-  attr_accessor :id, :user_agent, :ip_address, :custom_variables, :variation_targeting_variables, :post_segmentation_variables, :vwo
+  attr_accessor :id, :user_agent, :ip_address, :custom_variables, :variation_targeting_variables, :post_segmentation_variables, :vwo, :session_id, :uuid
 
-  def initialize(id = nil, user_agent = nil, ip_address = nil, custom_variables = {}, variation_targeting_variables = {}, post_segmentation_variables = {}, vwo = nil)
+  def initialize(id = nil, user_agent = nil, ip_address = nil, custom_variables = {}, variation_targeting_variables = {}, post_segmentation_variables = {}, vwo = nil, session_id = nil, uuid = nil)
     @id = id
     @user_agent = user_agent
     @ip_address = ip_address
@@ -25,6 +27,8 @@ class ContextModel
     @variation_targeting_variables = variation_targeting_variables || {}
     @post_segmentation_variables = post_segmentation_variables || {}
     @vwo = vwo
+    @session_id = session_id
+    @uuid = uuid
   end
 
   # Creates a model instance from a hash (dictionary)
@@ -48,6 +52,20 @@ class ContextModel
     @variation_targeting_variables = context[:variationTargetingVariables] if context.key?(:variationTargetingVariables)
     @post_segmentation_variables = context[:postSegmentationVariables] if context.key?(:postSegmentationVariables)
     @vwo = ContextVWOModel.new.model_from_dictionary(context[:_vwo]) if context.key?(:_vwo)
+  
+    # check if sessionId is present in context and should be non null and non empty string
+    if context.key?(:sessionId) && context[:sessionId].is_a?(String) && !context[:sessionId].empty?
+      @session_id = context[:sessionId]
+    else
+      @session_id = Time.now.to_i
+    end
+
+    # check if uuid is present in context and should be non null and non empty string
+    if context.key?(:uuid) && context[:uuid].is_a?(String) && !context[:uuid].empty?
+      @uuid = context[:uuid]
+    else
+      @uuid = UUIDUtil.get_uuid(id.to_s, SettingsService.instance.account_id.to_s)
+    end
 
     self
   end
@@ -107,4 +125,20 @@ class ContextModel
   def set_vwo(vwo)
     @vwo = vwo
   end
+
+  def get_session_id
+    @session_id
+  end
+
+  def set_session_id(session_id)
+    @session_id = session_id
+  end
+
+  def get_uuid
+    @uuid
+  end
+
+  def set_uuid(uuid)
+    @uuid = uuid
+  end
 end

data/lib/vwo/models/vwo_options_model.rb

@@ -15,7 +15,8 @@
 class VWOOptionsModel
   attr_accessor :account_id, :sdk_key, :is_development_mode, :storage, :gateway_service,
                 :poll_interval, :logger, :segmentation, :integrations, :network,
-                :should_wait_for_tracking_calls, :settings, :vwo_builder, :is_usage_stats_disabled, :_vwo_meta
+                :should_wait_for_tracking_calls, :settings, :vwo_builder, :is_usage_stats_disabled, :_vwo_meta,
+                :retry_config
 
   def initialize(options = {})
     @account_id = options[:account_id]
@@ -33,6 +34,7 @@ class VWOOptionsModel
     @vwo_builder = options[:vwo_builder]
     @is_usage_stats_disabled = options[:is_usage_stats_disabled]
     @_vwo_meta = options[:_vwo_meta]
+    @retry_config = options[:retry_config]
   end
 
   # Creates a model instance from a hash (dictionary)
@@ -51,6 +53,7 @@ class VWOOptionsModel
     @integrations = options[:integrations] if options.key?(:integrations)
     @network = options[:network] if options.key?(:network)
     @settings = options[:settings] if options.key?(:settings)
+    @retry_config = options[:retry_config] if options.key?(:retry_config)
 
     self
   end
@@ -114,5 +117,9 @@ class VWOOptionsModel
   def get_vwo_meta
     @_vwo_meta
   end
+
+  def get_retry_config
+    @retry_config
+  end
   
 end