configcat 6.1.0 → 8.0.0

data/lib/configcat/configentry.rb

@@ -2,37 +2,51 @@ require 'configcat/utils'
 
 module ConfigCat
   class ConfigEntry
-    CONFIG = 'config'
-    ETAG = 'etag'
-    FETCH_TIME = 'fetch_time'
+    attr_accessor :config, :etag, :config_json_string, :fetch_time
 
-    attr_accessor :config, :etag, :fetch_time
-
-    def initialize(config = {}, etag = '', fetch_time = Utils::DISTANT_PAST)
+    def initialize(config = {}, etag = '', config_json_string = '{}', fetch_time = Utils::DISTANT_PAST)
       @config = config
       @etag = etag
+      @config_json_string = config_json_string
       @fetch_time = fetch_time
     end
 
-    def self.create_from_json(json)
-      return ConfigEntry::EMPTY if json.nil?
-      return ConfigEntry.new(
-        config = json.fetch(CONFIG, {}),
-        etag = json.fetch(ETAG, ''),
-        fetch_time = json.fetch(FETCH_TIME, Utils::DISTANT_PAST)
-      )
-    end
-
     def empty?
       self == ConfigEntry::EMPTY
     end
 
-    def to_json
-      {
-        CONFIG => config,
-        ETAG => etag,
-        FETCH_TIME => fetch_time
-      }
+    def serialize
+      "#{(fetch_time * 1000).floor}\n#{etag}\n#{config_json_string}"
+    end
+
+    def self.create_from_string(string)
+      return ConfigEntry.empty if string.nil? || string.empty?
+
+      fetch_time_index = string.index("\n")
+      etag_index = string.index("\n", fetch_time_index + 1)
+      if fetch_time_index.nil? || etag_index.nil?
+        raise 'Number of values is fewer than expected.'
+      end
+
+      begin
+        fetch_time = Float(string[0...fetch_time_index])
+      rescue ArgumentError
+        raise "Invalid fetch time: #{string[0...fetch_time_index]}"
+      end
+
+      etag = string[fetch_time_index + 1...etag_index]
+      if etag.nil? || etag.empty?
+        raise 'Empty eTag value'
+      end
+      begin
+        config_json = string[etag_index + 1..-1]
+        config = JSON.parse(config_json)
+        Config.fixup_config_salt_and_segments(config)
+      rescue => e
+        raise "Invalid config JSON: #{config_json}. #{e.message}"
+      end
+
+      ConfigEntry.new(config, etag, config_json, fetch_time / 1000.0)
     end
 
     EMPTY = ConfigEntry.new(etag: 'empty')

data/lib/configcat/configfetcher.rb

@@ -1,7 +1,7 @@
 require 'configcat/interfaces'
 require 'configcat/version'
 require 'configcat/datagovernance'
-require 'configcat/constants'
+require 'configcat/config'
 require 'configcat/configentry'
 require 'net/http'
 require 'uri'
@@ -20,8 +20,8 @@ module ConfigCat
   end
 
   class Status
-    FETCHED = 0,
-    NOT_MODIFIED = 1,
+    FETCHED = 0
+    NOT_MODIFIED = 1
     FAILURE = 2
   end
 
@@ -179,7 +179,8 @@ module ConfigCat
             response_etag = ""
           end
           config = JSON.parse(response.body)
-          return FetchResponse.success(ConfigEntry.new(config, response_etag, Utils.get_utc_now_seconds_since_epoch))
+          Config.fixup_config_salt_and_segments(config)
+          return FetchResponse.success(ConfigEntry.new(config, response_etag, response.body, Utils.get_utc_now_seconds_since_epoch))
         when Net::HTTPNotModified
           return FetchResponse.not_modified
         when Net::HTTPNotFound, Net::HTTPForbidden
@@ -198,7 +199,9 @@ module ConfigCat
         @log.error(1102, error)
         return FetchResponse.failure(error, true)
       rescue Exception => e
-        error = "Unexpected error occurred while trying to fetch config JSON: #{e}"
+        error = "Unexpected error occurred while trying to fetch config JSON. It is most likely due to a local network " \
+                "issue. Please make sure your application can reach the ConfigCat CDN servers (or your proxy server) " \
+                "over HTTP. #{e}"
         @log.error(1103, error)
         return FetchResponse.failure(error, true)
       end

data/lib/configcat/configservice.rb

@@ -7,14 +7,13 @@ require 'configcat/refreshresult'
 module ConfigCat
   class ConfigService
     def initialize(sdk_key, polling_mode, hooks, config_fetcher, log, config_cache, is_offline)
-      @sdk_key = sdk_key
       @cached_entry = ConfigEntry::EMPTY
       @cached_entry_string = ''
       @polling_mode = polling_mode
       @log = log
       @config_cache = config_cache
       @hooks = hooks
-      @cache_key = Digest::SHA1.hexdigest("ruby_#{CONFIG_FILE_NAME}_#{@sdk_key}")
+      @cache_key = ConfigService.get_cache_key(sdk_key)
       @config_fetcher = config_fetcher
       @is_offline = is_offline
       @response_future = nil
@@ -31,13 +30,12 @@ module ConfigCat
       end
     end
 
-    def get_settings
+    def get_config
       if @polling_mode.is_a?(LazyLoadingMode)
         entry, _ = fetch_if_older(Utils.get_utc_now_seconds_since_epoch - @polling_mode.cache_refresh_interval_seconds)
         return !entry.empty? ?
-          [entry.config.fetch(FEATURE_FLAGS, {}), entry.fetch_time] :
+          [entry.config, entry.fetch_time] :
           [nil, Utils::DISTANT_PAST]
-          
       elsif @polling_mode.is_a?(AutoPollingMode) && !@initialized.set?
         elapsed_time = Utils.get_utc_now_seconds_since_epoch - @start_time # Elapsed time in seconds
         if elapsed_time < @polling_mode.max_init_wait_time_seconds
@@ -47,20 +45,27 @@ module ConfigCat
           if !@initialized.set?
             set_initialized
             return !@cached_entry.empty? ?
-              [@cached_entry.config.fetch(FEATURE_FLAGS, {}), @cached_entry.fetch_time] :
+              [@cached_entry.config, @cached_entry.fetch_time] :
               [nil, Utils::DISTANT_PAST]
           end
         end
       end
 
-      entry, _ = fetch_if_older(Utils::DISTANT_PAST, prefer_cache: true)
+      # If we are initialized, we prefer the cached results
+      entry, _ = fetch_if_older(Utils::DISTANT_PAST, prefer_cache: @initialized.set?)
       return !entry.empty? ?
-        [entry.config.fetch(FEATURE_FLAGS, {}), entry.fetch_time] :
+        [entry.config, entry.fetch_time] :
         [nil, Utils::DISTANT_PAST]
     end
 
     # :return [RefreshResult]
     def refresh
+      if offline?
+        offline_warning = "Client is in offline mode, it cannot initiate HTTP calls."
+        @log.warn(3200, offline_warning)
+        return RefreshResult.new(success = false, error = offline_warning)
+      end
+
       _, error = fetch_if_older(Utils::DISTANT_FUTURE)
       return RefreshResult.new(success = error.nil?, error = error)
     end
@@ -75,7 +80,7 @@ module ConfigCat
         if @polling_mode.is_a?(AutoPollingMode)
           start_poll
         end
-        @log.info(5200, 'Switched to ONLINE mode.')
+        @log.info(5200, "Switched to ONLINE mode.")
       end
     end
 
@@ -91,7 +96,7 @@ module ConfigCat
           @thread.join
         end
 
-        @log.info(5200, 'Switched to OFFLINE mode.')
+        @log.info(5200, "Switched to OFFLINE mode.")
       end
     end
 
@@ -107,36 +112,30 @@ module ConfigCat
 
     private
 
+    def self.get_cache_key(sdk_key)
+      Digest::SHA1.hexdigest("#{sdk_key}_#{CONFIG_FILE_NAME}.json_#{SERIALIZATION_FORMAT_VERSION}")
+    end
+
     # :return [ConfigEntry, String] Returns the ConfigEntry object and error message in case of any error.
-    def fetch_if_older(time, prefer_cache: false)
+    def fetch_if_older(threshold, prefer_cache: false)
       # Sync up with the cache and use it when it's not expired.
       @lock.synchronize do
-        if @cached_entry.empty? || @cached_entry.fetch_time > time
-          entry = read_cache
-          if !entry.empty? && entry.etag != @cached_entry.etag
-            @cached_entry = entry
-            @hooks.invoke_on_config_changed(entry.config[FEATURE_FLAGS])
-          end
-
-          # Cache isn't expired
-          if @cached_entry.fetch_time > time
-            set_initialized
-            return @cached_entry, nil
-          end
+        # Sync up with the cache and use it when it's not expired.
+        from_cache = read_cache
+        if !from_cache.empty? && from_cache.etag != @cached_entry.etag
+          @cached_entry = from_cache
+          @hooks.invoke_on_config_changed(from_cache.config[FEATURE_FLAGS])
         end
 
-        # Use cache anyway (get calls on auto & manual poll must not initiate fetch).
-        # The initialized check ensures that we subscribe for the ongoing fetch during the
-        # max init wait time window in case of auto poll.
-        if prefer_cache && @initialized.set?
+        # Cache isn't expired
+        if @cached_entry.fetch_time > threshold
+          set_initialized
           return @cached_entry, nil
         end
 
-        # If we are in offline mode we are not allowed to initiate fetch.
-        if @is_offline
-          offline_warning = "Client is in offline mode, it cannot initiate HTTP calls."
-          @log.warn(3200, offline_warning)
-          return @cached_entry, offline_warning
+        # If we are in offline mode or the caller prefers cached values, do not initiate fetch.
+        if @is_offline || prefer_cache
+          return @cached_entry, nil
         end
       end
 
@@ -201,7 +200,7 @@ module ConfigCat
         end
 
         @cached_entry_string = json_string
-        return ConfigEntry.create_from_json(JSON.parse(json_string))
+        return ConfigEntry.create_from_string(json_string)
       rescue Exception => e
         @log.error(2200, "Error occurred while reading the cache. #{e}")
         return ConfigEntry::EMPTY
@@ -210,7 +209,7 @@ module ConfigCat
 
     def write_cache(config_entry)
       begin
-        @config_cache.set(@cache_key, config_entry.to_json.to_json)
+        @config_cache.set(@cache_key, config_entry.serialize)
       rescue Exception => e
         @log.error(2201, "Error occurred while writing the cache. #{e}")
       end

data/lib/configcat/evaluationcontext.rb

@@ -0,0 +1,14 @@
+module ConfigCat
+  class EvaluationContext
+    attr_accessor :key, :setting_type, :user, :visited_keys, :is_missing_user_object_logged, :is_missing_user_object_attribute_logged
+
+    def initialize(key, setting_type, user, visited_keys = nil, is_missing_user_object_logged = false, is_missing_user_object_attribute_logged = false)
+      @key = key
+      @setting_type = setting_type
+      @user = user
+      @visited_keys = visited_keys || []
+      @is_missing_user_object_logged = is_missing_user_object_logged
+      @is_missing_user_object_attribute_logged = is_missing_user_object_attribute_logged
+    end
+  end
+end

data/lib/configcat/evaluationdetails.rb

@@ -1,19 +1,37 @@
 module ConfigCat
   class EvaluationDetails
     attr_reader :key, :value, :variation_id, :fetch_time, :user, :is_default_value, :error,
-                :matched_evaluation_rule, :matched_evaluation_percentage_rule
+                :matched_targeting_rule, :matched_percentage_option
 
     def initialize(key:, value:, variation_id: nil, fetch_time: nil, user: nil, is_default_value: false, error: nil,
-                   matched_evaluation_rule: nil, matched_evaluation_percentage_rule: nil)
+                   matched_targeting_rule: nil, matched_percentage_option: nil)
+      # Key of the feature flag or setting.
       @key = key
+
+      # Evaluated value of the feature flag or setting.
       @value = value
+
+      # Variation ID of the feature flag or setting (if available).
       @variation_id = variation_id
+
+      # Time of last successful config download.
       @fetch_time = fetch_time
+
+      # The User Object used for the evaluation (if available).
       @user = user
+
+      # Indicates whether the default value passed to the setting evaluation methods like ConfigCatClient.get_value,
+      # ConfigCatClient.get_value_details, etc. is used as the result of the evaluation.
       @is_default_value = is_default_value
+
+      # Error message in case evaluation failed.
       @error = error
-      @matched_evaluation_rule = matched_evaluation_rule
-      @matched_evaluation_percentage_rule = matched_evaluation_percentage_rule
+
+      # The targeting rule (if any) that matched during the evaluation and was used to return the evaluated value.
+      @matched_targeting_rule = matched_targeting_rule
+
+      # The percentage option (if any) that was used to select the evaluated value.
+      @matched_percentage_option = matched_percentage_option
     end
 
     def self.from_error(key, value, error:, variation_id: nil)

data/lib/configcat/evaluationlogbuilder.rb

@@ -0,0 +1,81 @@
+module ConfigCat
+  class EvaluationLogBuilder
+    def initialize
+      @indent_level = 0
+      @text = ''
+    end
+
+    def self.trunc_comparison_value_if_needed(comparator, comparison_value)
+      if [
+        Comparator::IS_ONE_OF_HASHED,
+        Comparator::IS_NOT_ONE_OF_HASHED,
+        Comparator::EQUALS_HASHED,
+        Comparator::NOT_EQUALS_HASHED,
+        Comparator::STARTS_WITH_ANY_OF_HASHED,
+        Comparator::NOT_STARTS_WITH_ANY_OF_HASHED,
+        Comparator::ENDS_WITH_ANY_OF_HASHED,
+        Comparator::NOT_ENDS_WITH_ANY_OF_HASHED,
+        Comparator::ARRAY_CONTAINS_ANY_OF_HASHED,
+        Comparator::ARRAY_NOT_CONTAINS_ANY_OF_HASHED
+      ].include?(comparator)
+        if comparison_value.is_a?(Array)
+          length = comparison_value.length
+          if length > 1
+            return "[<#{length} hashed values>]"
+          end
+          return "[<#{length} hashed value>]"
+        end
+
+        return "'<hashed value>'"
+      end
+
+      if comparison_value.is_a?(Array)
+        length_limit = 10
+        length = comparison_value.length
+        if length > length_limit
+          remaining = length - length_limit
+          more_text = remaining == 1 ? "<1 more value>" : "<#{remaining} more values>"
+
+          formatted_strings = comparison_value.first(length_limit).map { |str| "'#{str}'" }.join(", ")
+          return "[#{formatted_strings}, ... #{more_text}]"
+        end
+
+        # replace '"' with "'" in the string representation of the array
+        formatted_strings = comparison_value.map { |str| "'#{str}'" }.join(", ")
+        return "[#{formatted_strings}]"
+      end
+
+      if [Comparator::BEFORE_DATETIME, Comparator::AFTER_DATETIME].include?(comparator)
+        time = Utils.get_date_time(comparison_value)
+        return "'#{comparison_value}' (#{time.strftime('%Y-%m-%dT%H:%M:%S.%L')}Z UTC)"
+      end
+
+      "'#{comparison_value.to_s}'"
+    end
+
+    def increase_indent
+      @indent_level += 1
+      self
+    end
+
+    def decrease_indent
+      @indent_level = [@indent_level - 1, 0].max
+      self
+    end
+
+    def append(text)
+      @text += text
+      self
+    end
+
+    def new_line(text = nil)
+      @text += "\n" + '  ' * @indent_level
+      @text += text if text
+      self
+    end
+
+    def to_s
+      @text
+    end
+  end
+end

data/lib/configcat/localdictionarydatasource.rb

@@ -1,5 +1,5 @@
 require 'configcat/overridedatasource'
-require 'configcat/constants'
+require 'configcat/config'
 
 
 module ConfigCat
@@ -17,14 +17,30 @@ module ConfigCat
   class LocalDictionaryDataSource < OverrideDataSource
     def initialize(source, override_behaviour)
       super(override_behaviour)
-      @_settings = {}
+      @_config = {}
       source.each do |key, value|
-        @_settings[key] = { VALUE => value }
+        value_type = case value
+                     when TrueClass, FalseClass
+                       BOOL_VALUE
+                     when String
+                       STRING_VALUE
+                     when Integer
+                       INT_VALUE
+                     when Float
+                       DOUBLE_VALUE
+                     else
+                       UNSUPPORTED_VALUE
+        end
+
+        @_config[FEATURE_FLAGS] ||= {}
+        @_config[FEATURE_FLAGS][key] = { VALUE => { value_type => value } }
+        setting_type = SettingType.from_type(value.class)
+        @_config[FEATURE_FLAGS][key][SETTING_TYPE] = setting_type.to_i unless setting_type.nil?
       end
     end
 
     def get_overrides
-      return @_settings
+      return @_config
     end
   end
 end

data/lib/configcat/localfiledatasource.rb

@@ -1,5 +1,5 @@
 require 'configcat/overridedatasource'
-require 'configcat/constants'
+require 'configcat/config'
 
 
 module ConfigCat
@@ -18,17 +18,17 @@ module ConfigCat
     def initialize(file_path, override_behaviour, log)
       super(override_behaviour)
       @log = log
-      if !File.exists?(file_path)
+      if !File.exist?(file_path)
         @log.error(1300, "Cannot find the local config file '#{file_path}'. This is a path that your application provided to the ConfigCat SDK by passing it to the `LocalFileFlagOverrides.new()` method. Read more: https://configcat.com/docs/sdk-reference/ruby/#json-file")
       end
       @_file_path = file_path
-      @_settings = nil
+      @_config = nil
       @_cached_file_stamp = 0
     end
 
     def get_overrides
       reload_file_content()
-      return @_settings
+      return @_config
     end
 
     private
@@ -41,13 +41,29 @@ module ConfigCat
           file = File.read(@_file_path)
           data = JSON.parse(file)
           if data.key?("flags")
-            @_settings = {}
+            @_config = { FEATURE_FLAGS => {} }
             source = data["flags"]
             source.each do |key, value|
-              @_settings[key] = { VALUE => value }
+              value_type = case value
+                           when true, false
+                             BOOL_VALUE
+                           when String
+                             STRING_VALUE
+                           when Integer
+                             INT_VALUE
+                           when Float
+                             DOUBLE_VALUE
+                           else
+                             UNSUPPORTED_VALUE
+              end
+
+              @_config[FEATURE_FLAGS][key] = { VALUE => { value_type => value } }
+              setting_type = SettingType.from_type(value.class)
+              @_config[FEATURE_FLAGS][key][SETTING_TYPE] = setting_type.to_i unless setting_type.nil?
             end
           else
-            @_settings = data[FEATURE_FLAGS]
+            Config.fixup_config_salt_and_segments(data)
+            @_config = data
           end
         end
       rescue JSON::ParserError => e