kameleoon-client-ruby 3.18.0 → 3.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 916619df3b6cdccaf7999889e5f646bcbbfcba29eb6960bbf3374607100c1efe
-  data.tar.gz: d38b503e8cbf9d6df0a0639292b8b5436a59b4544ea53b45ab4d738a5b556dec
+  metadata.gz: c6e939e54b9b0f43a46d27b3ce7d1d442916d036a7db9ca5159645ffc869415b
+  data.tar.gz: 98b6e2c2b04c183ba5052379066e3eff95c9ffdc2b28963a0bd106dcf8adb0db
 SHA512:
-  metadata.gz: 1d154b47a9375184a1e2375cce4654b7615f51f37f656db8124228e0cce3f83414185f0ae53b40d704432c3d2ae1abb05d6700af504ce015b77df22d46caa02e
-  data.tar.gz: 730008de9284005e1401352e48bf2707ae8707456f04e8131cfda0e6b666ba59cf5399f541d01b0b5a5baba83ac7acd78a79e82920a191bc7c49fa6dab5e4dd3
+  metadata.gz: c4eb181ded7a566731df5e6af6bcb271fcf852c27503b5e0c44be51eb93b729decb88c378732f9a9584d5d1ef452e71a5ba651a39d20a06f7e689a3b016bc65a
+  data.tar.gz: 997194371128c0c25cd394ab7ed22e05a0b57684915c96268874ab9e426aa3e0228f396488e77da61c2b122798eeccfee2ad1e8785900ddff24452faac953025

data/lib/kameleoon/configuration/data_file.rb

@@ -13,12 +13,13 @@ module Kameleoon
     class DataFile
       attr_reader :last_modified, :settings, :segments, :audience_tracking_segments, :feature_flags, :me_groups,
                   :has_any_targeted_delivery_rule, :feature_flag_by_id, :rule_info_by_exp_id, :variation_by_id,
-                  :custom_data_info, :experiment_ids_with_js_css_variable, :holdout
+                  :custom_data_info, :experiment_ids_with_js_css_variable, :holdout, :date_modified
 
       def to_s
         'DataFile{' \
           "environment:#{@environment}," \
           "last_modified:#{@last_modified}," \
+          "date_modified:#{@date_modified}," \
           "feature_flags:#{@feature_flags.size}," \
           "settings:#{@settings}" \
           '}'
@@ -46,13 +47,15 @@ module Kameleoon
       def get_feature_flag(feature_key)
         ff = @feature_flags[feature_key]
         raise Exception::FeatureNotFound, feature_key if ff.nil?
+        ff
+      end
 
-        unless ff.environment_enabled
+      def ensure_environment_enabled(feature_flag)
+        unless feature_flag.environment_enabled
           env = @environment.nil? ? 'default' : "'#{@environment}'"
-          msg = "Feature '#{feature_key}' is disabled for #{env} environment'"
+          msg = "Feature '#{feature_flag.feature_key}' is disabled for #{env} environment'"
           raise Exception::FeatureEnvironmentDisabled, msg
         end
-        ff
       end
 
       def experiment_js_css_variable?(experiment_id)
@@ -63,6 +66,7 @@ module Kameleoon
 
       def init_default
         Logging::KameleoonLogger.debug('CALL: DataFile.init_default')
+        @date_modified = 0
         @settings = Settings.new
         @feature_flags = {}
         @me_groups = {}
@@ -73,6 +77,7 @@ module Kameleoon
 
       def init(configuration)
         Logging::KameleoonLogger.debug('CALL: DataFile.init(configuration: %s)', configuration)
+        @date_modified = configuration['dateModified'] || 0
         @settings = Settings.new(configuration['configuration'])
         @segments, @audience_tracking_segments = parse_segments(configuration)
         @custom_data_info = CustomDataInfo.new(configuration['customData'])

data/lib/kameleoon/configuration/variable.rb

@@ -16,6 +16,18 @@ module Kameleoon
         @type = hash['type']
         @value = hash['value']
       end
+
+      def get_value
+        case @type
+        when 'BOOLEAN', 'STRING', 'NUMBER', 'JS', 'CSS'
+          @value
+        when 'JSON'
+          JSON.parse(@value)
+        else
+          Logging::KameleoonLogger.error("Unknown type '#{@type}' for feature variable")
+          @value
+        end
+      end
     end
   end
 end

data/lib/kameleoon/configuration/variation.rb

@@ -19,7 +19,7 @@ module Kameleoon
       end
 
       def initialize(hash)
-        @key = hash['key']
+        @key = hash['key'] || ''
         @variables = Variable.create_from_array(hash['variables'])
         @name = hash['name'] || ''
       end

data/lib/kameleoon/data/browser.rb

@@ -49,7 +49,7 @@ module Kameleoon
       @version = version
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: 'staticData',
         browserIndex: @type,

data/lib/kameleoon/data/conversion.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'set'
 require 'kameleoon/data/custom_data'
 require 'kameleoon/network/uri_helper'
 require 'kameleoon/utils'
@@ -9,11 +10,11 @@ require_relative 'data'
 module Kameleoon
   # Conversion class uses for tracking conversion
   class Conversion < DuplicationSafeData
-    attr_reader :goal_id, :revenue, :negative, :metadata
+    attr_reader :goal_id, :revenue, :negative, :metadata, :assignment_time
 
     def to_s
       "Conversion{goal_id:#{@goal_id},revenue:#{@revenue},negative:#{@negative}," \
-      "metadata:#{Utils::Strval.obj_to_s(@metadata)}}"
+      "metadata:#{Utils::Strval.obj_to_s(@metadata)},assignment_time:#{@assignment_time}}"
     end
 
     # @param [Integer] goal_id Id of the goal associated to the conversion
@@ -26,9 +27,17 @@ module Kameleoon
       @revenue = revenue || 0.0
       @negative = negative || false
       @metadata = metadata
+      @assignment_time = Time.now.to_f
     end
 
-    def obtain_full_post_text_line
+    # @api private
+    def self.build_internal(goal_id, revenue = 0.0, negative = false, metadata: nil, assignment_time: nil)
+      conversion = new(goal_id, revenue, negative, metadata: metadata)
+      conversion.instance_variable_set(:@assignment_time, assignment_time || Time.now.to_f)
+      conversion
+    end
+
+    def query
       params = {
         eventType: 'conversion',
         goalId: @goal_id,

data/lib/kameleoon/data/custom_data.rb

@@ -85,7 +85,7 @@ module Kameleoon
       @index
     end
 
-    def obtain_full_post_text_line
+    def query
       str_values = JSON.generate(Hash[@values.collect { |k| [k, 1] }])
       params = {
         eventType: 'customData',

data/lib/kameleoon/data/data.rb

@@ -38,7 +38,7 @@ module Kameleoon
       @state = DataState::UNSENT
     end
 
-    def obtain_full_post_text_line
+    def query
       raise KameleoonError.new('ToDo: implement this method.'), 'ToDo: implement this method.'
     end
 

data/lib/kameleoon/data/device.rb

@@ -24,7 +24,7 @@ module Kameleoon
       @device_type = device_type
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: 'staticData',
         deviceType: @device_type,

data/lib/kameleoon/data/geolocation.rb

@@ -26,7 +26,7 @@ module Kameleoon
       @longitude = longitude
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: 'geolocation',
         nonce: nonce

data/lib/kameleoon/data/manager/assigned_variation.rb

@@ -25,10 +25,10 @@ module Kameleoon
         @experiment_id = experiment_id
         @variation_id = variation_id
         @rule_type = rule_type
-        @assignment_time = assignment_time || Time.new.to_i
+        @assignment_time = assignment_time || Time.now.to_f
       end
 
-      def obtain_full_post_text_line
+      def query
         params = {
           eventType: EVENT_TYPE,
           id: @experiment_id,

data/lib/kameleoon/data/manager/page_view_visit.rb

@@ -12,7 +12,7 @@ module Kameleoon
       def initialize(page_view, count = 1, timestamp = nil)
         @page_view = page_view
         @count = count
-        @last_timestamp = timestamp.nil? ? Time.new.to_i : timestamp
+        @last_timestamp = timestamp.nil? ? Time.new.to_f : timestamp
       end
 
       # Not thread-save method, should be called in synchronized code
@@ -20,7 +20,7 @@ module Kameleoon
       def overwrite(page_view)
         @page_view = page_view
         @count += 1
-        @last_timestamp = Time.new.to_i
+        @last_timestamp = Time.new.to_f
       end
 
       # Not thread-save method, should be called in synchronized code

data/lib/kameleoon/data/manager/visitor.rb

@@ -55,7 +55,7 @@ module Kameleoon
       end
 
       def update_last_activity_time
-        @data.last_activity_time = Time.new.to_i
+        @data.last_activity_time = Time.new.to_f
       end
 
       def enumerate_sendable_data(&blk)
@@ -322,7 +322,7 @@ module Kameleoon
 
       def initialize
         Logging::KameleoonLogger.debug('CALL: VisitorData.new')
-        @time_started = (Time.now.to_f * 1000).to_i
+        @time_started = Time.now.to_f
         @mutex = Concurrent::ReadWriteLock.new
         @legal_consent = LegalConsent::UNKNOWN
         Logging::KameleoonLogger.debug('RETURN: VisitorData.new')

data/lib/kameleoon/data/manager/visitor_manager.rb

@@ -64,6 +64,16 @@ module Kameleoon
         visitor
       end
 
+      def peek_visitor(visitor_code)
+        Logging::KameleoonLogger.debug("CALL: VisitorManager.peek_visitor(visitor_code: '%s')", visitor_code)
+
+        visitor = @visitors[visitor_code]
+
+        Logging::KameleoonLogger.debug("RETURN: VisitorManager.peek_visitor(visitor_code: '%s') -> (visitor: %s)",
+                              visitor_code, visitor)
+        visitor
+      end
+
       def enumerate(&blk)
         @visitors.each_pair { |vc, v| blk.call(vc, v) }
       end
@@ -144,7 +154,7 @@ module Kameleoon
 
       def purge
         Logging::KameleoonLogger.debug('CALL: VisitorManager.purge')
-        expired_time = Time.new.to_i - @expiration_period
+        expired_time = Time.new.to_f - @expiration_period
         @visitors.each_pair do |vc, v|
           next if v.last_activity_time >= expired_time
 

data/lib/kameleoon/data/mapping_identifier.rb

@@ -28,7 +28,7 @@ module Kameleoon
       false
     end
 
-    def obtain_full_post_text_line
+    def query
       mip = Kameleoon::Network::UriHelper.encode_query({ mappingIdentifier: true })
       "#{super}&#{mip}"
     end

data/lib/kameleoon/data/operating_system.rb

@@ -62,7 +62,7 @@ module Kameleoon
       @os_type = os_type
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: 'staticData',
         os: OperatingSystemType.name_from_type(@os_type),
@@ -73,4 +73,3 @@ module Kameleoon
     end
   end
 end
-

data/lib/kameleoon/data/page_view.rb

@@ -25,7 +25,7 @@ module Kameleoon
       @referrers = referrers.instance_of?(Integer) ? [referrers] : referrers
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: 'page',
         href: @url,

data/lib/kameleoon/data/personalization.rb

@@ -2,15 +2,16 @@
 
 module Kameleoon
   class Personalization
-    attr_reader :id, :variation_id
+    attr_reader :id, :variation_id, :assignment_time
 
-    def initialize(id, variation_id)
+    def initialize(id, variation_id, assignment_time: nil)
       @id = id
       @variation_id = variation_id
+      @assignment_time = assignment_time || Time.now.to_f
     end
 
     def to_s
-      "Personalization{id:#{@id},variation_id:#{@variation_id}}"
+      "Personalization{id:#{@id},variation_id:#{@variation_id},assignment_time:#{@assignment_time}}"
     end
   end
 end

data/lib/kameleoon/data/targeted_segment.rb

@@ -14,7 +14,7 @@ module Kameleoon
       @id = id
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: EVENT_TYPE,
         id: @id,

data/lib/kameleoon/data/visitor_visits.rb

@@ -33,7 +33,7 @@ module Kameleoon
       )
     end
 
-    def obtain_full_post_text_line
+    def query
       params = {
         eventType: 'staticData',
         visitNumber: @visit_number,

data/lib/kameleoon/kameleoon_client.rb

@@ -369,8 +369,6 @@ module Kameleoon
       Utils::VisitorCode.validate(visitor_code)
       variations = {}
       @data_manager.data_file.feature_flags.each_value do |feature_flag|
-        next unless feature_flag.environment_enabled
-
         begin
           variation_key, eval_exp = get_variation_info(visitor_code, feature_flag, track)
         rescue Exception::FeatureEnvironmentDisabled
@@ -468,7 +466,7 @@ module Kameleoon
         raise Exception::FeatureVariableNotFound.new(variable_name),
               "Feature variable #{variable_name} not found"
       end
-      value = _parse_feature_variable(variable)
+      value = variable.get_value
       Logging::KameleoonLogger.info(
         "RETURN: KameleoonClient.get_feature_variable(visitor_code: '%s', feature_key: '%s', variable_name: '%s', " \
           'is_unique_identifier: %s) -> (variable: %s)',
@@ -503,12 +501,13 @@ module Kameleoon
       )
       feature_flag = @data_manager.data_file.get_feature_flag(feature_key)
       variation = feature_flag.get_variation_by_key(variation_key)
+      @data_manager.data_file.ensure_environment_enabled(feature_flag)
       if variation.nil?
         raise Exception::FeatureVariationNotFound.new(variation_key),
               "Variation key #{variation_key} not found"
       end
       variables = {}
-      variation.variables.each { |var| variables[var.key] = _parse_feature_variable(var) }
+      variation.variables.each { |var| variables[var.key] = var.get_value }
       Logging::KameleoonLogger.info(
         "RETURN: KameleoonClient.get_feature_variation_variables(feature_key: '%s', variation_key: '%s') " \
           '-> (variables: %s)', feature_key, variation_key, variables
@@ -607,12 +606,16 @@ module Kameleoon
       )
       warehouse_audience
     end
-
     ##
-    # Returns a list of all feature flag keys
+    # Returns a list of all feature flag keys.
     #
     # @return [Array] array of all feature flag keys
+    #
+    # DEPRECATED. Please use `get_data_file` instead.
     def get_feature_list # rubocop:disable Naming/AccessorMethodName
+      Logging::KameleoonLogger.info(
+        '[DEPRECATION] `get_feature_list` is deprecated. Please use `get_data_file` instead.'
+      )
       Logging::KameleoonLogger.info('CALL: KameleoonClient.get_feature_list')
       features = @data_manager.data_file.feature_flags.keys
       Logging::KameleoonLogger.info('RETURN: KameleoonClient.get_feature_list -> (features: %s)', features)
@@ -638,8 +641,6 @@ module Kameleoon
       visitor = @visitor_manager.get_visitor(visitor_code)
       list_keys = []
       @data_manager.data_file.feature_flags.each do |feature_key, feature_flag|
-        next unless feature_flag.environment_enabled
-
         begin
           eval_exp = evaluate(visitor, visitor_code, feature_flag, false, false)
         rescue Exception::FeatureEnvironmentDisabled
@@ -677,8 +678,6 @@ module Kameleoon
       map_active_features = {}
 
       @data_manager.data_file.feature_flags.each_value do |feature_flag|
-        next unless feature_flag.environment_enabled
-
         begin
           eval_exp = evaluate(visitor, visitor_code, feature_flag, false, false)
         rescue Exception::FeatureEnvironmentDisabled
@@ -803,41 +802,7 @@ module Kameleoon
     # @return [Kameleoon::Types::DataFile] The current DataFile instance.
     def get_data_file
       Logging::KameleoonLogger.info('CALL: KameleoonClient.get_data_file')
-
-      feature_flags_map = @data_manager.data_file.feature_flags.transform_values do |source_feature_flag|
-        # Collect variations
-        variations_map = source_feature_flag.variations.each_with_object({}) do |variation, variations_map|
-          variables_map = variation.variables.each_with_object({}) do |var, variables_map|
-            variables_map[var.key] = Types::Variable.new(var.key, var.type, _parse_feature_variable(var))
-          end
-          variations_map[variation.key] = Types::Variation.new(variation.key, nil, nil, variables_map, variation.name)
-        end
-
-        # Collect rules
-        rules = source_feature_flag.rules.map do |rule|
-          rule_variations = rule.experiment.variations_by_exposition.each_with_object({}) do |var_by_exp, rule_variations|
-            base_variation = variations_map[var_by_exp.variation_key]
-            next unless base_variation
-            rule_variations[base_variation.key] = Types::Variation.new(
-              base_variation.key,
-              var_by_exp.variation_id,
-              rule.experiment.id,
-              base_variation.variables,
-              base_variation.name
-            )
-          end
-          Types::Rule.new(rule_variations)
-        end
-
-        Types::FeatureFlag.new(
-          variations_map,
-          source_feature_flag.environment_enabled,
-          rules,
-          source_feature_flag.default_variation_key
-        )
-      end
-
-      data_file = Types::DataFile.new(feature_flags_map)
+      data_file = @data_manager.external_data_file
       Logging::KameleoonLogger.info('RETURN: KameleoonClient.get_data_file -> (data_file: %s)', data_file)
       data_file
     end
@@ -1015,6 +980,11 @@ module Kameleoon
       )
       eval_exp = nil
       forced_variation = visitor&.get_forced_feature_variation(feature_flag.feature_key)
+
+      unless forced_variation&.simulated
+        @data_manager.data_file.ensure_environment_enabled(feature_flag)
+      end
+
       if forced_variation
         eval_exp = EvaluatedExperiment.from_forced_variation(forced_variation)
       elsif visitor_not_in_holdout?(visitor, visitor_code, track, save, feature_flag.bucketing_custom_data_index) && \
@@ -1276,21 +1246,10 @@ module Kameleoon
       Logging::KameleoonLogger.debug(
         'CALL: KameleoonClient.create_external_variation(variation: %s, eval_exp: %s)', variation, eval_exp
       )
-      ext_variables = {}
-      variation&.variables&.each do |variable|
-        ext_variables[variable.key] = Types::Variable.new(
-          variable.key,
-          variable.type,
-          _parse_feature_variable(variable)
-        )
-      end
-      ext_variables.freeze
-      ext_variation = Types::Variation.new(
-        variation&.key || '',
+      ext_variation = Types::Variation._build_from_internal(
+        variation,
         eval_exp&.var_by_exp&.variation_id,
-        eval_exp&.experiment&.id,
-        ext_variables,
-        variation&.name || ''
+        eval_exp&.experiment&.id
       )
       Logging::KameleoonLogger.debug(
         'RETURN: KameleoonClient.create_external_variation(variation: %s, eval_exp: %s) -> (ext_variation: %s)',
@@ -1301,18 +1260,6 @@ module Kameleoon
 
     ##
     # helper method for fetching values from a Variable
-    def _parse_feature_variable(variable)
-      case variable.type
-      when 'BOOLEAN', 'STRING', 'NUMBER', 'JS', 'CSS'
-        variable.value
-      when 'JSON'
-        JSON.parse(variable.value)
-      else
-        Logging::KameleoonLogger.error("Unknown type '#{variable.type}' for feature variable")
-        variable.value
-      end
-    end
-
     def set_unique_identifier(visitor_code, is_unique_identifier)
       Logging::KameleoonLogger.info(
         "The 'isUniqueIdentifier' parameter is deprecated. Please, add 'UniqueIdentifier' to a visitor instead."

data/lib/kameleoon/managers/data/data_manager.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'kameleoon/types/data_file'
+
 module Kameleoon
   module Managers
     module Data
@@ -13,7 +15,11 @@ module Kameleoon
         end
 
         def data_file=(value)
-          @container = Container.new(value)
+          @container = Container.new(value, create_external_data_file(value))
+        end
+
+        def external_data_file
+          @container.external_data_file
         end
 
         def visitor_code_managed?
@@ -22,14 +28,22 @@ module Kameleoon
 
         class Container
           attr_reader :data_file, :visitor_code_managed
+          attr_reader :external_data_file
 
-          def initialize(data_file)
+          def initialize(data_file, external_data_file)
             @data_file = data_file
+            @external_data_file = external_data_file
             # Regarding GDPR policy we should set visitorCode if legal consent isn't required or we have at
             # least one Targeted Delivery rule in datafile
             @visitor_code_managed = data_file.settings.is_consent_required && !data_file.has_any_targeted_delivery_rule
           end
         end
+
+        private
+
+        def create_external_data_file(source_data_file)
+          Types::DataFile._build_from_internal(source_data_file)
+        end
       end
     end
   end

data/lib/kameleoon/managers/remote_data/remote_visitor_data.rb

@@ -32,7 +32,9 @@ module Kameleoon
             prev_visits = []
             previous_visits.each_index do |i|
               visit = previous_visits[i]
-              prev_visits.push(VisitorVisits::Visit.new(visit['timeStarted'] || 0, visit['timeLastEvent']))
+              prev_visits.push(
+                VisitorVisits::Visit.new(ms_to_s(visit['timeStarted'] || 0), ms_to_s(visit['timeLastEvent']))
+              )
               parse_visit(visit, i + 1)
             end
             @visitor_visits = VisitorVisits.new(prev_visits, @visit_number)
@@ -113,7 +115,7 @@ module Kameleoon
             page_view_visit = @page_view_visits[href]
             if page_view_visit.nil?
               page_view = PageView.new(href, page_event['data']['title'])
-              @page_view_visits[href] = DataManager::PageViewVisit.new(page_view, 1, page_event['time'])
+              @page_view_visits[href] = DataManager::PageViewVisit.new(page_view, 1, ms_to_s(page_event['time']))
             else
               page_view_visit.increase_page_visits
             end
@@ -128,7 +130,7 @@ module Kameleoon
 
             @experiments[id] = DataManager::AssignedVariation.new(
               id, experiment_event['data']['variationId'],
-              Configuration::RuleType::UNKNOWN, assignment_time: experiment_event['time']
+              Configuration::RuleType::UNKNOWN, assignment_time: ms_to_s(experiment_event['time'])
             )
           end
         end
@@ -137,7 +139,10 @@ module Kameleoon
           @conversions = [] if @conversions.nil?
           conversion_events.each do |conversion_event|
             data = conversion_event['data']
-            conversion = Conversion.new(data['goalId'], data['revenue'], data['negative'])
+            conversion = Conversion.send(
+              :build_internal, data['goalId'], data['revenue'], data['negative'],
+              assignment_time: ms_to_s(conversion_event['time'])
+            )
             @conversions.push(conversion)
           end
         end
@@ -173,10 +178,20 @@ module Kameleoon
             id = personalization_event['data']['id']
             next if @personalizations.include?(id)
 
-            @personalizations[id] = Personalization.new(id, personalization_event['data']['variationId'])
+            @personalizations[id] = Personalization.new(
+              id,
+              personalization_event['data']['variationId'],
+              assignment_time: ms_to_s(personalization_event['time'])
+            )
           end
         end
 
+        def ms_to_s(timestamp)
+          return nil if timestamp.nil?
+
+          timestamp / 1000.0
+        end
+
         def conversions_single_objects
           objects = []
           objects += @conversions unless @conversions.nil?

data/lib/kameleoon/managers/tracking/tracking_builder.rb

@@ -32,7 +32,7 @@ module Kameleoon
 
           @visitor_codes.each do |visitor_code|
             if @total_size <= @request_size_limit
-              visitor = @visitor_manager.get_visitor(visitor_code)
+              visitor = @visitor_manager.peek_visitor(visitor_code)
               is_consent_given = consent_given?(visitor)
               data = collect_tracking_data(visitor_code, visitor, is_consent_given)
               if !data.empty?
@@ -127,7 +127,7 @@ module Kameleoon
           )
           user_agent = visitor&.user_agent
           unsent_data.each do |data|
-            line = data.obtain_full_post_text_line
+            line = data.query
             next if line.empty?
 
             line = add_line_params(line, visitor_code_param, user_agent)