configcat 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6979b91044d036414367912894396e332a9fdd10b4239e72294a74949d8e5c82
-  data.tar.gz: fd58f1ea297a2fce1cf47e4bfe521724677617a32163d7b5bde3f2f80234482e
+  metadata.gz: 4e0dc6578b7a148dda7c630d560098fb295eb139f237362db056b235d0feaa7e
+  data.tar.gz: e9f97b6d5f0af6fa72288bfeac3b13c6354bb1726af129349653b9365a10e665
 SHA512:
-  metadata.gz: ae734ae5e04ae73c6ea7eb62c48a5633a943ac009c2f7b59729028a141932cdfdfceabbdef207d774153f586c0c418df939c0042ea288debe6bfccf877765ff7
-  data.tar.gz: 50b222dd87b113807f72ab24f3e0dfd01bb752639ab394094e40c34461e57ca0637d59038883b78d02dcdcfcd0469bfc21c6b6a5f74ab0b4658c17fcd8d7e8bc
+  metadata.gz: a895b147c9238dbeb7e2f02d5021002032b47e023214842fb4528bdfabdf5c6c729bc746ff630f1f5cfb325442ba70ae71e7e3ee2257b3d81cfc8cf60ad06dee
+  data.tar.gz: 95d70831f41b93bcfa3306e9af41de05eb27ce80df4b734c0f1a6f7f98f83da468ed8abacbd4b252c105cd807bd21859b2cd4f19699b5a426c689bf6b15eedd7

data/lib/configcat/configcatclient.rb

@@ -146,52 +146,6 @@ module ConfigCat
       return settings.keys
     end
 
-    # Gets the Variation ID (analytics) of a feature flag or setting based on it's key.
-    #
-    # :param key [String] the identifier of the feature flag or setting.
-    # :param default_variation_id in case of any failure, this value will be returned.
-    # :param user [User] the user object to identify the caller.
-    # :return the variation ID.
-    def get_variation_id(key, default_variation_id, user = nil)
-      ConfigCat.logger.warn("get_variation_id is deprecated and will be removed in a future major version. " \
-                            "Please use [get_value_details] instead.")
-
-      settings, fetch_time = _get_settings()
-      if settings === nil
-        message = "Config JSON is not present when evaluating setting '#{key}'. Returning the `default_variation_id` parameter that you specified in your application: '#{default_variation_id}'."
-        @log.error(1000, message)
-        @hooks.invoke_on_flag_evaluated(EvaluationDetails.from_error(key, nil, error: message,
-                                                                     variation_id: default_variation_id))
-        return default_variation_id
-      end
-      details = _evaluate(key, user, nil, default_variation_id, settings, fetch_time)
-      return details.variation_id
-    end
-
-    # Gets the Variation IDs (analytics) of all feature flags or settings.
-    #
-    # :param user [User] the user object to identify the caller.
-    # :return list of variation IDs
-    def get_all_variation_ids(user = nil)
-      ConfigCat.logger.warn("get_all_variation_ids is deprecated and will be removed in a future major version. " \
-                            "Please use [get_value_details] instead.")
-
-      settings, _ = _get_settings()
-      if settings === nil
-        @log.error(1000, "Config JSON is not present. Returning empty list.")
-        return []
-      end
-
-      variation_ids = []
-      for key in settings.keys
-        variation_id = get_variation_id(key, nil, user)
-        if !variation_id.equal?(nil)
-          variation_ids.push(variation_id)
-        end
-      end
-      return variation_ids
-    end
-
     # Gets the key of a setting, and it's value identified by the given Variation ID (analytics)
     #
     # :param variation_id [String] variation ID
@@ -350,10 +304,6 @@ module ConfigCat
       return @_config_service.get_settings()
     end
 
-    def _get_cache_key
-      return Digest::SHA1.hexdigest("ruby_" + CONFIG_FILE_NAME + "_" + @_sdk_key)
-    end
-
     def _evaluate(key, user, default_value, default_variation_id, settings, fetch_time)
       user = user || @_default_user
       value, variation_id, rule, percentage_rule, error = @_rollout_evaluator.evaluate(

data/lib/configcat/configentry.rb

@@ -2,37 +2,50 @@ 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)
+      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

@@ -179,7 +179,7 @@ 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))
+          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

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
@@ -107,6 +106,10 @@ 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)
       # Sync up with the cache and use it when it's not expired.
@@ -201,7 +204,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 +213,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/constants.rb

@@ -1,5 +1,6 @@
 module ConfigCat
   CONFIG_FILE_NAME = "config_v5"
+  SERIALIZATION_FORMAT_VERSION = "v2"
 
   PREFERENCES = "p"
   BASE_URL = "u"

data/lib/configcat/version.rb

@@ -1,3 +1,3 @@
 module ConfigCat
-  VERSION = "6.1.0"
+  VERSION = "7.0.0"
 end

data/lib/configcat.rb

@@ -24,164 +24,4 @@ module ConfigCat
   def ConfigCat.close_all
     ConfigCatClient.close_all
   end
-
-  def ConfigCat.create_client(sdk_key, data_governance: DataGovernance::GLOBAL)
-    #
-    #   Create an instance of ConfigCatClient and setup Auto Poll mode with default options
-    #
-    #   :param sdk_key: ConfigCat SDK Key to access your configuration.
-    #   :param data_governance:
-    #   Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
-    #   https://app.configcat.com/organization/data-governance
-    #   (Only Organization Admins have access)
-    #
-    return create_client_with_auto_poll(sdk_key, data_governance: data_governance)
-  end
-
-  # Create an instance of ConfigCatClient and setup Auto Poll mode with custom options
-  #
-  # :param sdk_key: ConfigCat SDK Key to access your configuration.
-  # :param poll_interval_seconds: The client's poll interval in seconds. Default: 60 seconds.
-  # :param on_configuration_changed_callback: You can subscribe to configuration changes with this callback
-  # :param max_init_wait_time_seconds: maximum waiting time for first configuration fetch in polling mode.
-  # :param config_cache: If you want to use custom caching instead of the client's default,
-  # You can provide an implementation of ConfigCache.
-  # :param base_url: You can set a base_url if you want to use a proxy server between your application and ConfigCat
-  # :param proxy_address: Proxy address
-  # :param proxy_port: Proxy port
-  # :param proxy_user: username for proxy authentication
-  # :param proxy_pass: password for proxy authentication
-  # :param open_timeout_seconds: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
-  # :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-  # :param flag_overrides: A FlagOverrides implementation used to override feature flags & settings.
-  # :param data_governance:
-  # Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
-  # https://app.configcat.com/organization/data-governance
-  # (Only Organization Admins have access)
-  def ConfigCat.create_client_with_auto_poll(sdk_key,
-                                             poll_interval_seconds: 60,
-                                             max_init_wait_time_seconds: 5,
-                                             on_configuration_changed_callback: nil,
-                                             config_cache: nil,
-                                             base_url: nil,
-                                             proxy_address: nil,
-                                             proxy_port: nil,
-                                             proxy_user: nil,
-                                             proxy_pass: nil,
-                                             open_timeout_seconds: 10,
-                                             read_timeout_seconds: 30,
-                                             flag_overrides: nil,
-                                             data_governance: DataGovernance::GLOBAL)
-    options = ConfigCatOptions.new(
-      base_url: base_url,
-      polling_mode: PollingMode.auto_poll(poll_interval_seconds: poll_interval_seconds, max_init_wait_time_seconds: max_init_wait_time_seconds),
-      config_cache: config_cache,
-      proxy_address: proxy_address,
-      proxy_port: proxy_port,
-      proxy_user: proxy_user,
-      proxy_pass: proxy_pass,
-      open_timeout_seconds: open_timeout_seconds,
-      read_timeout_seconds: read_timeout_seconds,
-      flag_overrides: flag_overrides,
-      data_governance: data_governance
-    )
-    ConfigCat.logger.warn('create_client_with_auto_poll is deprecated. Create the ConfigCat Client as a Singleton object with `configcatclient.get()` instead')
-    client = ConfigCatClient.get(sdk_key, options)
-    client.hooks.add_on_config_changed(on_configuration_changed_callback) if on_configuration_changed_callback
-    return client
-  end
-
-  # Create an instance of ConfigCatClient and setup Lazy Load mode with custom options
-  #
-  # :param sdk_key: ConfigCat SDK Key to access your configuration.
-  # :param cache_time_to_live_seconds: The cache TTL.
-  # :param config_cache: If you want to use custom caching instead of the client's default,
-  # You can provide an implementation of ConfigCache.
-  # :param base_url: You can set a base_url if you want to use a proxy server between your application and ConfigCat
-  # :param proxy_address: Proxy address
-  # :param proxy_port: Proxy port
-  # :param proxy_user: username for proxy authentication
-  # :param proxy_pass: password for proxy authentication
-  # :param open_timeout_seconds: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
-  # :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-  # :param flag_overrides: A FlagOverrides implementation used to override feature flags & settings.
-  # :param data_governance:
-  # Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
-  # https://app.configcat.com/organization/data-governance
-  # (Only Organization Admins have access)
-  def ConfigCat.create_client_with_lazy_load(sdk_key,
-                                             cache_time_to_live_seconds: 60,
-                                             config_cache: nil,
-                                             base_url: nil,
-                                             proxy_address: nil,
-                                             proxy_port: nil,
-                                             proxy_user: nil,
-                                             proxy_pass: nil,
-                                             open_timeout_seconds: 10,
-                                             read_timeout_seconds: 30,
-                                             flag_overrides: nil,
-                                             data_governance: DataGovernance::GLOBAL)
-    options = ConfigCatOptions.new(
-      base_url: base_url,
-      polling_mode: PollingMode.lazy_load(cache_refresh_interval_seconds: cache_time_to_live_seconds),
-      config_cache: config_cache,
-      proxy_address: proxy_address,
-      proxy_port: proxy_port,
-      proxy_user: proxy_user,
-      proxy_pass: proxy_pass,
-      open_timeout_seconds: open_timeout_seconds,
-      read_timeout_seconds: read_timeout_seconds,
-      flag_overrides: flag_overrides,
-      data_governance: data_governance
-    )
-    ConfigCat.logger.warn('create_client_with_lazy_load is deprecated. Create the ConfigCat Client as a Singleton object with `configcatclient.get()` instead')
-    client = ConfigCatClient.get(sdk_key, options)
-    return client
-  end
-
-  # Create an instance of ConfigCatClient and setup Manual Poll mode with custom options
-  #
-  # :param sdk_key: ConfigCat SDK Key to access your configuration.
-  # :param config_cache: If you want to use custom caching instead of the client's default,
-  # You can provide an implementation of ConfigCache.
-  # :param base_url: You can set a base_url if you want to use a proxy server between your application and ConfigCat
-  # :param proxy_address: Proxy address
-  # :param proxy_port: Proxy port
-  # :param proxy_user: username for proxy authentication
-  # :param proxy_pass: password for proxy authentication
-  # :param open_timeout_seconds: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
-  # :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-  # :param flag_overrides: A FlagOverrides implementation used to override feature flags & settings.
-  # :param data_governance:
-  # Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
-  # https://app.configcat.com/organization/data-governance
-  # (Only Organization Admins have access)
-  def ConfigCat.create_client_with_manual_poll(sdk_key,
-                                               config_cache: nil,
-                                               base_url: nil,
-                                               proxy_address: nil,
-                                               proxy_port: nil,
-                                               proxy_user: nil,
-                                               proxy_pass: nil,
-                                               open_timeout_seconds: 10,
-                                               read_timeout_seconds: 30,
-                                               flag_overrides: nil,
-                                               data_governance: DataGovernance::GLOBAL)
-    options = ConfigCatOptions.new(
-      base_url: base_url,
-      polling_mode: PollingMode.manual_poll(),
-      config_cache: config_cache,
-      proxy_address: proxy_address,
-      proxy_port: proxy_port,
-      proxy_user: proxy_user,
-      proxy_pass: proxy_pass,
-      open_timeout_seconds: open_timeout_seconds,
-      read_timeout_seconds: read_timeout_seconds,
-      flag_overrides: flag_overrides,
-      data_governance: data_governance
-    )
-    ConfigCat.logger.warn('create_client_with_manual_poll is deprecated. Create the ConfigCat Client as a Singleton object with `configcatclient.get()` instead')
-    client = ConfigCatClient.get(sdk_key, options)
-    return client
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby