vwo-fme-ruby-sdk 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13710bca2e74d196e8f16dae0d76687b063f0b9ffab675bb425e63cd381b863
-  data.tar.gz: 237b9215295d8562dc340eabf4a0670c04615410606f4e950b6b6ded3eb9afdd
+  metadata.gz: 46ef28eb680c91f4a2009e0fdff9053a4c2f82cfacbe2b09c5a3359b469a104a
+  data.tar.gz: a5aeb2e3856e53a62f8c52ff1da83c7396260f50087441f2537b94319459013f
 SHA512:
-  metadata.gz: d04499359ef1b97ae2d7aac4df5fb0a1084eb7274596877cc84ea64dc11ab08975514b94412f48871d6682cc2bbbe8a277543a744baaf6a854e5a07da128fd03
-  data.tar.gz: 27cd8399d7d7768ff7ac7928df99c09e6d8eba26b2367e9301acb7a0586c709b612d15f7f988589a025c214e2525e59815ca041608acc0c7b232e9f60b1095b5
+  metadata.gz: 216b54b6567c982b2c6392c1bb52a940cb0eb083604f7bcc8040e1017acf06a8da1438a665706b9e0f618e57ccbc7146f8a59cda2bce8eba6c8fb7fbcb05af96
+  data.tar.gz: 5ed4c55969fe455f57b946b67314382a2f50534fdc4e62948a54b88ed0a81bb9c94b5c0abe01b24c255bb2f15c449893545865a3a4ad8e8b7467ffd5d43e24bc

data/lib/vwo/api/set_attribute.rb

@@ -15,28 +15,24 @@
 require_relative '../models/user/context_model'
 require_relative '../enums/event_enum'
 require_relative '../utils/network_util'
-require_relative '../models/settings/settings_model'
 require_relative '../services/batch_event_queue'
 
 class SetAttributeApi
   # Sets multiple attributes for a user in a single network call.
-  # @param settings [SettingsModel] Configuration settings.
   # @param attributes [Hash] Key-value map of attributes.
   # @param context [ContextModel] Context containing user information.
-  def set_attribute(settings, attributes, context)
-    create_impression_for_attributes(settings, attributes, context)
+  def set_attribute(attributes, context)
+    create_impression_for_attributes(attributes, context)
   end
 
   private
 
   # Creates an impression for multiple user attributes and sends it to the server.
-  # @param settings [SettingsModel] Configuration settings.
   # @param attributes [Hash] Key-value map of attributes.
   # @param context [ContextModel] Context containing user information.
-  def create_impression_for_attributes(settings, attributes, context)
+  def create_impression_for_attributes(attributes, context)
     # Retrieve base properties for the event
     properties = NetworkUtil.get_events_base_properties(
-      settings,
       EventEnum::VWO_SYNC_VISITOR_PROP,
       URI.encode_www_form_component(context.user_agent),
       context.ip_address
@@ -44,7 +40,6 @@ class SetAttributeApi
 
     # Construct payload data for multiple attributes
     payload = NetworkUtil.get_attribute_payload_data(
-      settings,
       context.id,
       EventEnum::VWO_SYNC_VISITOR_PROP,
       attributes,

data/lib/vwo/api/track_event.rb

@@ -32,7 +32,7 @@ class TrackApi
   def track(settings, event_name, context, event_properties, hooks_service)
     if does_event_belong_to_any_feature(event_name, settings)
       # Create an impression for the track event
-      create_impression_for_track(settings, event_name, context, event_properties)
+      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 })
@@ -50,14 +50,12 @@ class TrackApi
   private
 
   # Creates an impression for a track event and sends it via a POST API request.
-  # @param settings [SettingsModel] Configuration settings.
   # @param event_name [String] Name of the event to track.
   # @param context [ContextModel] User details.
   # @param event_properties [Hash] Properties associated with the event.
-  def create_impression_for_track(settings, event_name, context, event_properties)
+  def create_impression_for_track(event_name, context, event_properties)
     # Get base properties for the event
     properties = NetworkUtil.get_events_base_properties(
-      settings,
       event_name,
       URI.encode_www_form_component(context.user_agent),
       context.ip_address
@@ -65,7 +63,6 @@ class TrackApi
 
     # Prepare the payload for the track goal
     payload = NetworkUtil.get_track_goal_payload_data(
-      settings,
       context.id,
       event_name,
       event_properties,

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.3.2'.freeze
+  SDK_VERSION = '1.4.0'.freeze
 
   MAX_TRAFFIC_PERCENT = 100
   MAX_TRAFFIC_VALUE = 10_000
@@ -55,4 +55,6 @@ module Constants
   SHOULD_USE_THREADING = true
   MAX_POOL_SIZE = 5
   MAX_QUEUE_SIZE = 10000
+
+  PRODUCT_NAME = 'fme'.freeze
 end

data/lib/vwo/enums/event_enum.rb

@@ -15,5 +15,6 @@
 # Event types
 module EventEnum
     VWO_VARIATION_SHOWN = 'vwo_variationShown'
-    VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp'
+    VWO_SYNC_VISITOR_PROP = 'vwo_syncVisitorProp',
+    VWO_INIT_CALLED = 'vwo_fmeSdkInit'
   end

data/lib/vwo/models/schemas/settings_schema_validation.rb

@@ -89,6 +89,7 @@ class SettingsSchema
       optional(:groups).maybe(:hash)
       optional(:campaignGroups).maybe(:hash)
       optional(:collectionPrefix).maybe(:string)
+      optional(:sdkMetaInfo).maybe(:hash)
     end
   end
 

data/lib/vwo/packages/logger/core/log_manager.rb

@@ -17,6 +17,7 @@ require 'securerandom'
 require_relative '../logger'
 require_relative 'transport_manager'
 require_relative '../transports/console_transport'
+require_relative '../../../enums/log_level_enum'
 
 class LogManager < VWOLogger
     @instance = nil
@@ -62,8 +63,9 @@ class LogManager < VWOLogger
       @transport_manager.log('WARN', message)
     end
   
-    def error(message)
+    def error(message, extraData = {})
       @transport_manager.log('ERROR', message)
+      # sendLogToVWO(message, LogLevelEnum::ERROR, extraData)
     end
   
     private

data/lib/vwo/services/settings_service.rb

@@ -23,7 +23,7 @@ require_relative '../enums/log_level_enum'
 require_relative '../models/schemas/settings_schema_validation'
 
 class SettingsService
-  attr_accessor :sdk_key, :account_id, :expiry, :network_timeout, :hostname, :port, :protocol, :is_gateway_service_provided, :is_settings_valid
+  attr_accessor :sdk_key, :account_id, :expiry, :network_timeout, :hostname, :port, :protocol, :is_gateway_service_provided, :is_settings_valid, :settings_fetch_time
 
   class << self
     attr_accessor :instance
@@ -93,8 +93,15 @@ class SettingsService
     request = RequestModel.new(@hostname, "GET", path, options, nil, nil, @protocol, @port)
     request.set_timeout(@network_timeout)
 
+    # store the current time in milliseconds
+    settings_fetch_start_time = (Time.now.to_f * 1000).to_i
+
     begin
       response = network_instance.get(request)
+      # calculate the time taken to fetch the settings
+      settings_fetch_end_time = (Time.now.to_f * 1000).to_i
+      time_taken = settings_fetch_end_time - settings_fetch_start_time
+      @settings_fetch_time = time_taken.to_s 
       response.get_data
     rescue => e
       LoggerService.log(LogLevelEnum::ERROR, "Error fetching settings: #{e.message}", nil)

data/lib/vwo/utils/event_util.rb

@@ -0,0 +1,36 @@
+# 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.
+
+require_relative './network_util'
+require_relative '../enums/event_enum'
+require_relative '../services/batch_event_queue'
+
+# Sends an init called event to VWO.
+# This event is triggered when the init function is called.
+# @param settings_fetch_time [Number] Time taken to fetch settings in milliseconds.
+# @param sdk_init_time [Number] Time taken to initialize the SDK in milliseconds.
+def send_sdk_init_event(settings_fetch_time, sdk_init_time)
+  # Get base properties for the event
+  properties = NetworkUtil.get_events_base_properties(EventEnum::VWO_INIT_CALLED)
+  payload = NetworkUtil.get_sdk_init_event_payload(EventEnum::VWO_INIT_CALLED, settings_fetch_time, sdk_init_time)
+
+  # 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_event(properties, payload)
+  end
+end

data/lib/vwo/utils/impression_util.rb

@@ -28,7 +28,6 @@ require_relative '../services/batch_event_queue'
 def create_and_send_impression_for_variation_shown(settings, campaign_id, variation_id, context)
   # Get base properties for the event
   properties = NetworkUtil.get_events_base_properties(
-    settings,
     EventEnum::VWO_VARIATION_SHOWN,
     URI.encode_www_form_component(context.get_user_agent), # Encode user agent for URL safety
     context.get_ip_address
@@ -36,7 +35,6 @@ def create_and_send_impression_for_variation_shown(settings, campaign_id, variat
 
   # Construct payload data for tracking the user
   payload = NetworkUtil.get_track_user_payload_data(
-    settings,
     context.get_id,
     EventEnum::VWO_VARIATION_SHOWN,
     campaign_id,

data/lib/vwo/utils/network_util.rb

@@ -80,11 +80,11 @@ class NetworkUtil
     end
 
     # Builds generic properties for different tracking calls
-    def get_events_base_properties(setting, event_name, visitor_user_agent = '', ip_address = '')
-        sdk_key = setting.sdk_key || ''
+    def get_events_base_properties(event_name, visitor_user_agent = '', ip_address = '')
+        sdk_key = SettingsService.instance.sdk_key || ''
         {
         en: event_name,
-        a: setting.account_id,
+        a: SettingsService.instance.account_id,
         env: sdk_key,
         eTime: get_current_unix_timestamp_in_millis,
         random: get_random_number,
@@ -96,9 +96,9 @@ class NetworkUtil
     end
 
     # Builds base payload for tracking events
-    def _get_event_base_payload(settings, user_id, event_name, visitor_user_agent = '', ip_address = '')
-        uuid = UUIDUtil.get_uuid(user_id.to_s, settings.account_id)
-        sdk_key = settings.sdk_key
+    def _get_event_base_payload(user_id, event_name, visitor_user_agent = '', ip_address = '')
+        uuid = UUIDUtil.get_uuid(user_id.to_s, SettingsService.instance.account_id)
+        sdk_key = SettingsService.instance.sdk_key
 
         {
         d: {
@@ -124,8 +124,8 @@ class NetworkUtil
     end
 
     # Builds track-user payload data
-    def get_track_user_payload_data(settings, user_id, event_name, campaign_id, variation_id, visitor_user_agent = '', ip_address = '')
-        properties = _get_event_base_payload(settings, user_id, event_name, visitor_user_agent, ip_address)
+    def get_track_user_payload_data(user_id, event_name, campaign_id, variation_id, visitor_user_agent = '', ip_address = '')
+        properties = _get_event_base_payload(user_id, event_name, visitor_user_agent, ip_address)
         properties[:d][:event][:props][:id] = campaign_id
         properties[:d][:event][:props][:variation] = variation_id
         properties[:d][:event][:props][:isFirst] = 1
@@ -141,7 +141,7 @@ class NetworkUtil
         end
         
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_TRACK_USER", {
-            accountId: settings.account_id,
+            accountId: SettingsService.instance.account_id,
             userId: user_id,
             campaignId: campaign_id
         })
@@ -150,8 +150,8 @@ class NetworkUtil
     end
 
     # Constructs payload for tracking goals with custom event properties
-    def get_track_goal_payload_data(settings, user_id, event_name, event_properties, visitor_user_agent = '', ip_address = '')
-        properties = _get_event_base_payload(settings, user_id, event_name, visitor_user_agent, ip_address)
+    def get_track_goal_payload_data(user_id, event_name, event_properties, visitor_user_agent = '', ip_address = '')
+        properties = _get_event_base_payload(user_id, event_name, visitor_user_agent, ip_address)
         properties[:d][:event][:props][:isCustomEvent] = true
 
         if SettingsService.instance.is_gateway_service_provided
@@ -165,15 +165,15 @@ class NetworkUtil
         
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_TRACK_GOAL", {
             eventName: event_name,
-            accountId: settings.account_id,
+            accountId: SettingsService.instance.account_id,
             userId: user_id
         })
         
         properties
     end
 
-    def get_attribute_payload_data(settings, user_id, event_name, event_properties, visitor_user_agent = '', ip_address = '')
-        properties = _get_event_base_payload(settings, user_id, event_name, visitor_user_agent, ip_address)
+    def get_attribute_payload_data(user_id, event_name, event_properties, visitor_user_agent = '', ip_address = '')
+        properties = _get_event_base_payload(user_id, event_name, visitor_user_agent, ip_address)
         properties[:d][:event][:props][:isCustomEvent] = true
 
         if event_properties.is_a?(Hash) && !event_properties.empty?
@@ -182,12 +182,31 @@ class NetworkUtil
 
         LoggerService.log(LogLevelEnum::DEBUG, "IMPRESSION_FOR_SYNC_VISITOR_PROP", {
             eventName: event_name,
-            accountId: settings.account_id,
+            accountId: SettingsService.instance.account_id,
             userId: user_id
         })
         properties
     end
 
+    # Constructs the payload for init called event.
+    # @param event_name - The name of the event.
+    # @param settings_fetch_time - Time taken to fetch settings in milliseconds.
+    # @param sdk_init_time - Time taken to initialize the SDK in milliseconds.
+    # @returns The constructed payload with required fields.
+    def get_sdk_init_event_payload(event_name, settings_fetch_time, sdk_init_time)
+        user_id = SettingsService.instance.account_id + "_" + SettingsService.instance.sdk_key
+        properties = _get_event_base_payload(user_id, event_name, nil, nil)
+        properties[:d][:event][:props][:vwo_fs_environment] = SettingsService.instance.sdk_key
+        properties[:d][:event][:props][:product] = Constants::PRODUCT_NAME
+        data = {
+            "isSDKInitialized": true,
+            "settingsFetchTime": settings_fetch_time,
+            "sdkInitTime": sdk_init_time
+        }
+        properties[:d][:event][:props][:data] = data
+        properties
+    end
+
     # Sends a POST API request with given properties and payload
     def send_post_api_request(properties, payload)
         network_instance = NetworkManager.instance
@@ -230,6 +249,41 @@ class NetworkUtil
         end
     end
 
+    # Sends an event to VWO (generic event sender).
+    # @param properties - Query parameters for the request.
+    # @param payload - The payload for the request.
+    # @param event_name - The name of the event to send.
+    def send_event(properties, payload)
+        network_instance = NetworkManager.instance
+        headers = {}
+        headers[HeadersEnum::USER_AGENT] = payload[:d][:visitor_ua] if payload[:d][:visitor_ua]
+        headers[HeadersEnum::IP] = payload[:d][:visitor_ip] if payload[:d][:visitor_ip]
+
+        request = RequestModel.new(
+            UrlUtil.get_base_url,
+            HttpMethodEnum::POST,
+            UrlEnum::EVENTS,
+            properties,
+            payload,
+            headers,
+            SettingsService.instance.protocol,
+            SettingsService.instance.port
+        )
+
+        begin 
+            if network_instance.get_client.get_should_use_threading
+                network_instance.get_client.get_thread_pool.post {
+                    response = network_instance.post(request)
+                    response
+                }
+            else
+                response = network_instance.post(request)
+                response
+            end
+        rescue ResponseModel => err
+        end
+    end
+
     # Sends a GET API request to the specified endpoint with given properties
     def send_get_api_request(properties, endpoint)
         network_instance = NetworkManager.instance

data/lib/vwo/vwo_client.rb

@@ -146,7 +146,7 @@ class VWOClient
       end
       
       context_model = ContextModel.new.model_from_dictionary(context)
-      SetAttributeApi.new.set_attribute(@settings, attributes, context_model)
+      SetAttributeApi.new.set_attribute(attributes, context_model)
     rescue StandardError => e
       LoggerService.log(LogLevelEnum::ERROR, "API_THROW_ERROR", {apiName: api_name, err: e.message})
     end

data/lib/vwo.rb

@@ -16,6 +16,8 @@ require 'json'
 require 'uri'
 require_relative 'vwo/vwo_builder'
 require_relative 'vwo/vwo_client'
+require_relative 'vwo/utils/event_util'
+require_relative 'vwo/services/settings_service'
 
 class VWO
   @@vwo_builder = nil
@@ -67,7 +69,30 @@ class VWO
         puts "[ERROR]: VWO-SDK: Please provide VWO account ID in the options and should be a of type string|number"
       end
 
+      # store the current time in milliseconds
+      sdk_init_start_time = (Time.now.to_f * 1000).to_i
+      # initialize the vwo instance
       new(options)
+      # store the time after initializing the vwo instance in milliseconds
+      sdk_init_end_time = (Time.now.to_f * 1000).to_i
+      # calculate the time taken for initializing the vwo instance
+      time_taken_for_init = sdk_init_end_time - sdk_init_start_time
+      # get sdkMetaInfo from settings file to check if the sdk was initialized earlier
+      sdk_meta_info = nil
+      was_initialized_earlier = false
+      
+      begin
+        if @@instance && @@instance.original_settings && @@instance.original_settings.is_a?(Hash)
+          sdk_meta_info = @@instance.original_settings["sdkMetaInfo"]
+          was_initialized_earlier = sdk_meta_info && sdk_meta_info.is_a?(Hash) ? sdk_meta_info["wasInitializedEarlier"] : false
+        end
+      rescue StandardError => e
+        was_initialized_earlier = false
+      end
+      if !was_initialized_earlier && SettingsService.instance.is_settings_valid
+        # send the sdk init info to vwo server
+        send_sdk_init_event(SettingsService.instance.settings_fetch_time, time_taken_for_init.to_s)
+      end
       @@instance
     rescue StandardError => e
       puts "[ERROR]: VWO-SDK: Got error while initializing VWO: #{e.message}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-24 00:00:00.000000000 Z
+date: 2025-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -211,6 +211,7 @@ files:
 - lib/vwo/utils/campaign_util.rb
 - lib/vwo/utils/data_type_util.rb
 - lib/vwo/utils/decision_util.rb
+- lib/vwo/utils/event_util.rb
 - lib/vwo/utils/function_util.rb
 - lib/vwo/utils/gateway_service_util.rb
 - lib/vwo/utils/impression_util.rb