vwo-fme-ruby-sdk 1.50.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d76a694880edd0c5a2fa5b892193eef8f601c95d3d0a140c28681450196e2ee
-  data.tar.gz: 95ff81d4b0e38159a57e7d22a603d7f81df3319ad2fb43bb7395691c46b24a79
+  metadata.gz: 15f3001a8b2112b59b1f97dc24f09735e4cb4c28de642f62f18c76a7f7d67d08
+  data.tar.gz: d14170568fbcfcc5677488737641e50f1949240a2788d5345d640516881eef83
 SHA512:
-  metadata.gz: '051825ffb285e02b0db70c7b869dedc2508946e199cec12bcdb402d4ff9f499028df3d8f4da46e24eeb28e45dfc42f2af937130c4118a43b5fd2ccca2abf57f9'
-  data.tar.gz: 42ce7d1946c602b1c73e182677feaee8a78c3a6ccbc9ed5ba5063788e4af45d827cbdba78586a5f37e9f193ce4eb226b0769aa02784ca165b3e684a71e1df5de
+  metadata.gz: 78d65f005620ce3c1b285f356255e992176d546e9b0518a22f37d740760c6abcbe99a0acfc8e5558372a58b50d6e9dfcb996d17795193210d1dea060a161a10c
+  data.tar.gz: bf913d055a768cf1bb36e3608fc8b86f1e22fbd96aa107bff99a327b4c643b38d3d30031587bdc05fd7dfd3ecfd0e803b6594c8f4a7fbc0426d625214b8c2035

data/lib/resources/debug_messages.json

@@ -11,6 +11,7 @@
     "IMPRESSION_FOR_TRACK_USER": "Impression built for vwo_variationShown({brand} standard event for tracking user) event haivng Account ID:{accountId}, User ID:{userId}, and experiment ID:{campaignId}",
     "IMPRESSION_FOR_TRACK_GOAL": "Impression built for event:{eventName} event having Account ID:{accountId}, and user ID:{userId}",
     "IMPRESSION_FOR_SYNC_VISITOR_PROP": "Impression built for {eventName}({brand} internal event) event for Account ID:{accountId}, and user ID:{userId}",
+    "IMPRESSION_FOR_USAGE_TRACKING": "Impression built for vwo_feTrackUsage({brand} standard event for usage tracking call) event having Account ID:{accountId}, and user ID:{userId}",
 
     "CONFIG_BATCH_EVENT_LIMIT_EXCEEDED": "Impression event - {endPoint} failed due to exceeding payload size. Parameter eventsPerRequest in batchEvents config in init API has value:{eventsPerRequest} for account ID:{accountId}. Please read the official documentation for knowing the size limits",
 

data/lib/resources/info_messages.json

@@ -30,6 +30,7 @@
     "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 {brand} client instance when API: {apiName} got called having isViaWebhook param as {isViaWebhook}",
     "NETWORK_CALL_SUCCESS": "Impression for {event} - {endPoint} was successfully received by {brand} having Account ID:{accountId}, UUID: {uuid}",
+    "USAGE_TRACKING_DISPATCHED": "FE track usage call dispatched for Account ID:{accountId}, User ID:{userId}, and feature key:{featureKey}",
 
     "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",

data/lib/wingify/api/get_flag.rb

@@ -40,6 +40,10 @@ class FlagApi
       rollout_variation_to_return = nil
       experiment_variation_to_return = nil
       should_check_for_experiments_rules = false
+      # Flag to check if variation shown event has been fired
+      is_variation_shown_fired = false
+      # Flag to check if tracking usage is enabled
+      is_tracking_usage_enabled = settings.get_is_tracking_usage_enabled
   
       passed_rules_information = {} # for storing integration callback
       evaluated_feature_map = {}
@@ -65,6 +69,8 @@ class FlagApi
     
             if variation
               LoggerService.log(LogLevelEnum::INFO, "STORED_VARIATION_FOUND", {variationKey: variation.get_key, userId: context.get_id, experimentKey: stored_data[:experiment_key], experimentType: "experiment"})
+              # Send usage tracking call when user is served from storage
+              send_tracking_usage(settings, context, is_tracking_usage_enabled, feature_key)
               return GetFlagResponse.new(true, variation.get_variables, context.get_uuid, context.get_session_id)
             end
           end
@@ -91,6 +97,8 @@ class FlagApi
   
       if feature.nil?
         LoggerService.log(LogLevelEnum::ERROR, "FEATURE_NOT_FOUND", {featureKey: feature_key, an: ApiEnum::GET_FLAG, sId: context.get_session_id, uuid: context.get_uuid})
+        # Send usage tracking call when feature is not found
+        send_tracking_usage(settings, context, is_tracking_usage_enabled, feature_key)
         return GetFlagResponse.new(false, [], context.get_uuid, context.get_session_id)
       end
   
@@ -106,6 +114,12 @@ class FlagApi
         rollout_rules.each do |rule|
           result = evaluate_rule(settings, feature, rule, context, evaluated_feature_map, nil, storage_service, decision)
           pre_segmentation_result = result[:pre_segmentation_result]
+          whitelisted_object = result[:whitelisted_object]
+          
+          if whitelisted_object.is_a?(Hash) && !whitelisted_object.empty?
+            is_variation_shown_fired = true
+          end
+
           updated_decision = result[:updated_decision]
           decision.merge!(updated_decision) if updated_decision
   
@@ -131,6 +145,8 @@ class FlagApi
             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, feature_key)
+            # set is_variation_shown_fired to true since we already sent variation shown call for rollout
+            is_variation_shown_fired = true
           end
         end
       elsif rollout_rules.empty?
@@ -147,11 +163,16 @@ class FlagApi
           result = evaluate_rule(settings, feature, rule, context, evaluated_feature_map, meg_group_winner_campaigns, storage_service, decision)
           pre_segmentation_result = result[:pre_segmentation_result]
           whitelisted_object = result[:whitelisted_object]
+          
+          if whitelisted_object.is_a?(Hash) && !whitelisted_object.empty?
+            is_variation_shown_fired = true
+          end
+
           updated_decision = result[:updated_decision]
           decision.merge!(updated_decision) if updated_decision
 
           if pre_segmentation_result
-            if whitelisted_object.nil?
+            if whitelisted_object.nil? || whitelisted_object.empty?
               experiment_rules_to_evaluate << rule
             else
               is_enabled = true
@@ -176,6 +197,8 @@ class FlagApi
             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, feature_key)
+            # set is_variation_shown_fired to true since we already sent variation shown call for experiment
+            is_variation_shown_fired = true
           end
         end
       end
@@ -216,8 +239,15 @@ class FlagApi
           context,
           feature_key
         )
+        # set is_variation_shown_fired to true since we already sent variation shown call for impact analysis
+        is_variation_shown_fired = true
+      end
+
+      # Send usage tracking call when no primary variation_shown event was dispatched.
+      # If a primary variation_shown event was fired, the server already has the usage tracking signal.
+      if !is_variation_shown_fired
+        send_tracking_usage(settings, context, is_tracking_usage_enabled, feature_key)
       end
-  
       # Return final evaluated feature flag
       return GetFlagResponse.new(is_enabled, experiment_variation_to_return&.get_variables || rollout_variation_to_return&.get_variables || [], context.get_uuid, context.get_session_id)
     end

data/lib/wingify/constants/constants.rb

@@ -17,7 +17,7 @@
 # Define the Constants module
 module Constants
   SDK_NAME = 'vwo-fme-ruby-sdk'.freeze
-  SDK_VERSION = '1.50.0'.freeze
+  SDK_VERSION = '1.55.0'.freeze
 
   # --- Brand-specific constants ---
 

data/lib/wingify/enums/event_enum.rb

@@ -19,4 +19,5 @@ module EventEnum
     DEBUGGER_EVENT = 'vwo_sdkDebug'
     INIT_CALLED = 'vwo_fmeSdkInit'
     USAGE_STATS = 'vwo_sdkUsageStats'
+    USER_EVALUATED = 'vwo_feTrackUsage'
 end

data/lib/wingify/models/settings/settings_model.rb

@@ -18,7 +18,7 @@ require_relative '../../constants/constants'
 
 class SettingsModel
   attr_reader :sdk_key, :account_id, :usage_stats_account_id, :version, :collection_prefix,
-              :features, :campaigns, :campaign_groups, :groups, :poll_interval, :is_web_connectivity_enabled
+              :features, :campaigns, :campaign_groups, :groups, :poll_interval, :is_web_connectivity_enabled, :is_tracking_usage_enabled
 
   def initialize(settings)
     @sdk_key = settings["sdkKey"]
@@ -32,6 +32,7 @@ class SettingsModel
     @campaign_groups = settings["campaignGroups"] || {}
     @groups = settings["groups"] || {}
     @is_web_connectivity_enabled = settings.fetch("isWebConnectivityEnabled", true)
+    @is_tracking_usage_enabled = settings.fetch("isMAU", false)
 
     process_features(settings)
     process_campaigns(settings)
@@ -98,4 +99,8 @@ class SettingsModel
   def get_is_web_connectivity_enabled
     @is_web_connectivity_enabled
   end
+
+  def get_is_tracking_usage_enabled
+    @is_tracking_usage_enabled
+  end
 end

data/lib/wingify/utils/impression_util.rb

@@ -64,3 +64,38 @@ def create_and_send_impression_for_variation_shown(settings, campaign_id, variat
     NetworkUtil.send_post_api_request(properties, payload, { campaign_type: campaign_type, feature_key: feature_key, campaign_key: campaign_key, variation_name: variation_name })
   end
 end
+
+# Sends the usage tracking payload to the server.
+# Called whenever a user is evaluated via get_flag() but no variation_shown event is dispatched.
+#
+# @param settings [SettingsModel] The settings model containing configuration.
+# @param context [ContextModel] The user context model.
+# @param is_tracking_usage_enabled [Boolean] Whether usage tracking is active.
+# @param feature_key [String] The key of the evaluated feature.
+def send_tracking_usage(settings, context, is_tracking_usage_enabled, feature_key)
+  return unless is_tracking_usage_enabled
+
+  # Construct payload data for tracking usage
+  payload = NetworkUtil.get_tracking_usage_payload_data(context)
+
+  # Get base properties for the event
+  properties = NetworkUtil.get_events_base_properties(
+    EventEnum::USER_EVALUATED,
+    URI.encode_www_form_component(context.get_user_agent), # Encode user agent for URL safety
+    context.get_ip_address
+  )
+  LoggerService.log(LogLevelEnum::INFO, "USAGE_TRACKING_DISPATCHED", {
+    accountId: settings.account_id,
+    userId: context.get_id,
+    featureKey: feature_key
+  })
+
+  # check if batching is enabled
+  if BatchEventsQueue.instance
+    # add the payload to the batch events queue
+    BatchEventsQueue.instance.enqueue(payload)
+  else
+    # Send the constructed payload via POST request
+    NetworkUtil.send_post_api_request(properties, payload)
+  end
+end

data/lib/wingify/utils/network_util.rb

@@ -293,6 +293,33 @@ class NetworkUtil
         properties
     end
 
+    # Constructs the payload data for usage tracking call.
+    # Sent to server when a user is evaluated via get_flag() but no variation_shown
+    # event is dispatched by the SDK.
+    # @param context [ContextModel] The context model instance.
+    # @returns [Hash] The constructed payload.
+    def get_tracking_usage_payload_data(context)
+        properties = _get_event_base_payload(context.get_id, EventEnum::USER_EVALUATED, context.get_user_agent, context.get_ip_address)
+
+        # use sessionId from context if present
+        if context.get_session_id
+            properties[:d][:sessionId] = context.get_session_id
+        end
+
+        # use uuid from context if present
+        if context.get_uuid && !context.get_uuid.empty?
+            properties[:d][:visId] = context.get_uuid
+            properties[:d][:msgId] = "#{context.get_uuid}-#{get_current_unix_timestamp_in_millis}"
+        end
+
+        LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_USAGE_TRACKING", {
+            accountId: SettingsService.instance.account_id,
+            userId: context.get_id
+        })
+
+        properties
+    end
+
     # Sends a POST API request with given properties and payload
     def send_post_api_request(properties, payload, campaign_info = {})
         network_instance = NetworkManager.instance

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.50.0
+  version: 1.55.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-06-03 00:00:00.000000000 Z
+date: 2026-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools