configcat 9.0.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aad1052b20cd0204dc7b7b6a0ca9cb556e5fc43f7a5598c06441ac27e12fae0
-  data.tar.gz: 6efb60cc11630106701b68dd0d9fd14c1f1e38bb10746f4d5a031a0170052713
+  metadata.gz: 4d2b7f4e5d47d25f547528e0168dd531f50c84e44a9a1e9f6634c5f68db29dd0
+  data.tar.gz: e92023320e954118f80842efd483efd9cdb6865d4ac33f8d5c02230b0b11a981
 SHA512:
-  metadata.gz: 906f61166e8ecbf15ed35ba50cf0f5cfa0132a822ea2023e0639e45d8ea44f76965b8c5c67e7d64464a45afc7fa4d7da500a89f5a132ce807bf7bd734940b0af
-  data.tar.gz: 6211e2b597e3f25b09a7424906fab85a3a3edf89ab927d8c7302c35ae6703c6d1c43fd7d321bf051348a5201118c4bb90eff784327857311a1dc2e16e1336acb
+  metadata.gz: e72cf2f0a18bb717468a45727f924af34fbdf2dd188e2605243250112494eca928903f984248bc3edf15cf9ea32bb2975bfbec055f5c40fb78675ecf70f71237
+  data.tar.gz: 8172327e157b399f1ad53b1583a474af2c03ad012796523c68522568872801c63949027b89ec823a6b9459811e3181e1760bb4484a0c07cbc5bbc2b5691bf0a5

data/lib/configcat/configcatclient.rb

@@ -28,9 +28,10 @@ module ConfigCat
         client = @@instances[sdk_key]
         if client
           if options
+            masked_sdk_key = ConfigCatLogger.mask_sdk_key(sdk_key)
             client.log.warn(3000, "There is an existing client instance for the specified SDK Key. " \
                                   "No new client instance will be created and the specified options are ignored. " \
-                                  "Returning the existing client instance. SDK Key: '#{sdk_key}'.")
+                                  "Returning the existing client instance. SDK Key: '#{masked_sdk_key}'.")
           end
           return client
         end
@@ -98,7 +99,7 @@ module ConfigCat
                                             read_timeout: options.read_timeout_seconds,
                                             data_governance: options.data_governance)
 
-        @_config_service = ConfigService.new(@sdk_key,
+        @_config_service = ConfigService.new(@_sdk_key,
                                              options.polling_mode,
                                              @hooks,
                                              @_config_fetcher,

data/lib/configcat/configcatlogger.rb

@@ -1,5 +1,12 @@
 module ConfigCat
   class ConfigCatLogger
+    def self.mask_sdk_key(sdk_key)
+      num_chars_to_keep = 6
+      return sdk_key if sdk_key.length <= num_chars_to_keep
+
+      sdk_key[0, sdk_key.length - num_chars_to_keep].gsub(%r{[^/]}, '*') + sdk_key[-num_chars_to_keep, num_chars_to_keep]
+    end
+
     def initialize(hooks)
       @hooks = hooks
     end

data/lib/configcat/configentry.rb

@@ -1,4 +1,5 @@
 require 'configcat/utils'
+require 'json'
 
 module ConfigCat
   class ConfigEntry

data/lib/configcat/configfetcher.rb

@@ -26,13 +26,14 @@ module ConfigCat
   end
 
   class FetchResponse
-    attr_reader :entry, :error, :is_transient_error
+    attr_reader :entry, :error, :is_transient_error, :cf_ray_id
 
-    def initialize(status, entry, error = nil, is_transient_error = false)
+    def initialize(status, entry, error = nil, is_transient_error = false, cf_ray_id = nil)
       @status = status
       @entry = entry
       @error = error
       @is_transient_error = is_transient_error
+      @cf_ray_id = cf_ray_id
     end
 
     # Gets whether a new configuration value was fetched or not.
@@ -53,19 +54,22 @@ module ConfigCat
       @status == Status::FAILURE
     end
 
-    def self.success(entry)
-      FetchResponse.new(Status::FETCHED, entry)
+    def self.success(entry, cf_ray_id = nil)
+      FetchResponse.new(Status::FETCHED, entry, nil, false, cf_ray_id)
     end
 
-    def self.not_modified
-      FetchResponse.new(Status::NOT_MODIFIED, ConfigEntry::EMPTY)
+    def self.not_modified(cf_ray_id = nil)
+      FetchResponse.new(Status::NOT_MODIFIED, ConfigEntry::EMPTY, nil, false, cf_ray_id)
     end
 
-    def self.failure(error, is_transient_error)
-      FetchResponse.new(Status::FAILURE, ConfigEntry::EMPTY, error, is_transient_error)
+    def self.failure(error, is_transient_error, cf_ray_id = nil)
+      FetchResponse.new(Status::FAILURE, ConfigEntry::EMPTY, error, is_transient_error, cf_ray_id)
     end
   end
 
+  RETRY_DELAY_SECONDS = 0.05
+  CONNECTION_RESET_THRESHOLD_SECONDS = 30
+
   class ConfigFetcher
     def initialize(sdk_key, log, mode, base_url: nil, proxy_address: nil, proxy_port: nil, proxy_user: nil, proxy_pass: nil,
                    open_timeout: 10, read_timeout: 30,
@@ -79,6 +83,7 @@ module ConfigCat
       @_open_timeout = open_timeout
       @_read_timeout = read_timeout
       @_headers = { "User-Agent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "X-ConfigCat-UserAgent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "Content-Type" => "application/json" }
+      @_last_connection_reset = nil
       if !base_url.equal?(nil)
         @_base_url_overridden = true
         @_base_url = base_url.chomp("/")
@@ -146,7 +151,9 @@ module ConfigCat
 
       # To prevent loops we check if we retried at least 3 times with the new base_url
       if retries >= 2
-        @log.error(1104, "Redirection loop encountered while trying to fetch config JSON. Please contact us at https://configcat.com/support/")
+        error = "Redirection loop encountered while trying to fetch config JSON. Please contact us at https://configcat.com/support/"
+        error = "%s (Ray ID: %s)" % [error, fetch_response.cf_ray_id] if fetch_response.cf_ray_id
+        @log.error(1104, error)
         return fetch_response
       end
 
@@ -163,6 +170,25 @@ module ConfigCat
     private
 
     def _fetch(etag)
+      response = _fetch_http(etag)
+      if response.is_failed && response.is_transient_error
+        _reset_http_if_needed
+        sleep(RETRY_DELAY_SECONDS)
+        response = _fetch_http(etag)
+      end
+      response
+    end
+
+    def _reset_http_if_needed
+      now = Utils.get_utc_now_seconds_since_epoch
+      if @_last_connection_reset.nil? || now - @_last_connection_reset >= CONNECTION_RESET_THRESHOLD_SECONDS
+        close
+        @_last_connection_reset = now
+      end
+    end
+
+    def _fetch_http(etag)
+      response_cf_ray_id = nil
       begin
         @log.debug("Fetching configuration from ConfigCat")
         uri = URI.parse((((@_base_url + ("/")) + BASE_PATH) + @_sdk_key) + BASE_EXTENSION)
@@ -170,40 +196,57 @@ module ConfigCat
         headers["If-None-Match"] = etag.empty? ? nil : etag
         _create_http()
         request = Net::HTTP::Get.new(uri.request_uri, headers)
-        response = @_http.request(request)
+        response = @_http.request(request) do |res|
+          # Capture the response before reading the body, so headers remain accessible even if the body download fails
+          response_cf_ray_id = res["CF-RAY"]
+          res.read_body
+        end
+
         case response
-        when Net::HTTPSuccess
+        when Net::HTTPOK
           @log.debug("ConfigCat configuration json fetch response code:#{response.code} Cached:#{response['ETag']}")
+          content = response.body
+          if content.nil? || content.empty?
+            raise ArgumentError.new("Config JSON content cannot be null or empty.")
+          end
+          config = JSON.parse(content)
+          if config.nil?
+            raise ArgumentError.new("Invalid config JSON content: #{content}")
+          end
+          Config.fixup_config_salt_and_segments(config)
           response_etag = response["ETag"]
           if response_etag.nil?
             response_etag = ""
           end
-          config = JSON.parse(response.body)
-          Config.fixup_config_salt_and_segments(config)
-          return FetchResponse.success(ConfigEntry.new(config, response_etag, response.body, Utils.get_utc_now_seconds_since_epoch))
+          return FetchResponse.success(ConfigEntry.new(config, response_etag, response.body, Utils.get_utc_now_seconds_since_epoch), response_cf_ray_id)
         when Net::HTTPNotModified
-          return FetchResponse.not_modified
+          return FetchResponse.not_modified(response_cf_ray_id)
         when Net::HTTPNotFound, Net::HTTPForbidden
-          error = "Your SDK Key seems to be wrong. You can find the valid SDK Key at https://app.configcat.com/sdkkey. Received unexpected response: #{response}"
+          masked_sdk_key = ConfigCatLogger.mask_sdk_key(@_sdk_key)
+          error = "Your SDK Key seems to be wrong: '#{masked_sdk_key}'. You can find the valid SDK Key at https://app.configcat.com/sdkkey. Received unexpected response: #{response}"
+          error = "%s (Ray ID: %s)" % [error, response_cf_ray_id] if response_cf_ray_id
           @log.error(1100, error)
-          return FetchResponse.failure(error, false)
+          return FetchResponse.failure(error, false, response_cf_ray_id)
         else
           raise Net::HTTPError.new("", response)
         end
       rescue Net::HTTPError => e
         error = "Unexpected HTTP response was received while trying to fetch config JSON: #{e}"
+        error = "%s (Ray ID: %s)" % [error, response_cf_ray_id] if response_cf_ray_id
         @log.error(1101, error)
-        return FetchResponse.failure(error, true)
+        return FetchResponse.failure(error, true, response_cf_ray_id)
       rescue Timeout::Error => e
         error = "Request timed out while trying to fetch config JSON. Timeout values: [connect: #{get_open_timeout()}s, read: #{get_read_timeout()}s]"
+        error = "%s (Ray ID: %s)" % [error, response_cf_ray_id] if response_cf_ray_id
         @log.error(1102, error)
-        return FetchResponse.failure(error, true)
+        return FetchResponse.failure(error, true, response_cf_ray_id)
       rescue Exception => 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}"
+        error = "%s (Ray ID: %s)" % [error, response_cf_ray_id] if response_cf_ray_id
         @log.error(1103, error)
-        return FetchResponse.failure(error, true)
+        return FetchResponse.failure(error, true, response_cf_ray_id)
       end
     end
 

data/lib/configcat/configservice.rb

@@ -2,6 +2,7 @@ require 'concurrent'
 require 'configcat/configentry'
 require 'configcat/pollingmode'
 require 'configcat/refreshresult'
+require 'digest'
 
 
 module ConfigCat

data/lib/configcat/localfiledatasource.rb

@@ -1,5 +1,6 @@
 require 'configcat/overridedatasource'
 require 'configcat/config'
+require 'json'
 
 
 module ConfigCat

data/lib/configcat/rolloutevaluator.rb

@@ -2,7 +2,9 @@ require 'configcat/user'
 require 'configcat/config'
 require 'configcat/evaluationcontext'
 require 'configcat/evaluationlogbuilder'
+require 'date'
 require 'digest'
+require 'json'
 require 'semantic'
 
 

data/lib/configcat/user.rb

@@ -1,3 +1,6 @@
+require 'date'
+require 'json'
+
 module ConfigCat
   # User Object. Contains user attributes which are used for evaluating targeting rules and percentage options.
   class User

data/lib/configcat/version.rb

@@ -1,3 +1,3 @@
 module ConfigCat
-  VERSION = "9.0.0"
+  VERSION = "10.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 10.0.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-10 00:00:00.000000000 Z
+date: 2026-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby