ff-ruby-server-sdk 1.3.2 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e06f7cec3eb38bff792b8406d0ff11fb487b8662c78ee9bdba3fdad46526e5f
-  data.tar.gz: 7bd8b2c5d1cb6955bdcb9ca6363a6c8afa89cc8b8dbda7769dc0bf60eca62ba0
+  metadata.gz: e2bcc6b6312ee2462bbf6a2a689ddee47c6000bc010db561eb72b5204a7c8d8f
+  data.tar.gz: 7058cd57f6e72cb2c649b51071eaebed405ff3aac691f4aa186a096da70692b9
 SHA512:
-  metadata.gz: 8eb61b5fa760cc59968d2ef51ddfe3263c3b75e9ec254304e9037a656a69318f4a2a7b6538c8ac5583394b5f0701af47c1ea2dbc1c94acb7dc830b4297c1d339
-  data.tar.gz: 55af3f78ef20bc1cc0e667ef70fa60a5a7b41e79578db544038b0afc165470560cfd7566acf61f3902042b56d82f6264ef0d47ac121c149b6b77d31bfcf97b82
+  metadata.gz: 85ff6d9cda7f5579a7eeedce0f7ea293ccf95ff426b413f53aa09c22a0caa4bc1890607c63d67a0b3c58295d537f830a85e81ae45a2a6afafdd4d0521daa60df
+  data.tar.gz: '089aeb5abb536d43e118bade66a80fde7b70e1b74ce1a96fa32d53d7a4a61f08ec7b4c5d35a987e60f11fc4a8791b7233bad01c742bfc4ebc5545a738a13038d'

data/docs/further_reading.md

@@ -24,6 +24,52 @@ client.init(apiKey, ConfigBuilder
 | enableStream    | analytics_enabled(false)                           | Enable streaming mode.                                                                                                                           | true                                 |
 | enableAnalytics | stream_enabled(true)                               | Enable analytics.  Metrics data is posted every 60s                                                                                              | true                                 |
 
+## Client Initialization Options
+The Harness Feature Flags SDK for Ruby provides flexible initialization strategies to accommodate various application requirements. You can choose between an asynchronous (non-blocking) or synchronous (blocking) approach to initialize the SDK.
+
+### Asynchronous (Non-Blocking) Initialization
+The SDK can be initialized asynchronously without blocking the main thread or requiring a callback. In this case, defaults will be served until the SDK completes the initialization process.
+
+```ruby
+client = CfClient.instance
+client.init(api_key, config)
+
+# Will serve default until the SDK completes initialization
+result = client.bool_variation("bool_flag", target, false)
+```
+
+### Synchronous (Blocking) Initialization
+
+In cases where it's critical to ensure the SDK is initialized before evaluating flags, the SDK offers a synchronous initialization method. This approach blocks the current thread until the SDK is fully initialized or the optional specified timeout (in milliseconds) period elapses.
+
+The synchronous method is useful for environments where feature flag decisions are needed before continuing, such as during application startup.
+
+You can use the `wait_for_initialization` method, optionally providing a timeout in milliseconds to prevent waiting indefinitely in case of unrecoverable isues, e.g. incorrect API key used.
+
+**Usage without a timeout**
+
+```ruby
+client = CfClient.instance
+client.init(api_key, config)
+
+client.wait_for_initialization
+
+result = client.bool_variation("bool_flag", target, false)
+```
+
+**Usage with a timeout**
+
+```ruby
+client = CfClient.instance
+client.init(api_key, config)
+
+# Only wait for 30 seconds, after which if the SDK has not initialized the call will
+# unblock and the SDK will then serve defaults
+client.wait_for_initialization(timeout_ms: 30000)
+
+result = client.bool_variation("bool_flag", target, false)
+```
+
 ## Logging Configuration
 You can provide your own logger to the SDK i.e. using the moneta logger we can do this
 

data/lib/ff/ruby/server/sdk/api/auth_service.rb

@@ -89,8 +89,9 @@ class AuthService < Closeable
     # 503 service unavailable
     # 504 gateway timeout
     #  -1 OpenAPI error (timeout etc)
+    # 0 Un-categorised typhoeus error
     case code
-    when 408,425,429,500,502,503,504,-1
+    when 408,425,429,500,502,503,504,-1, 0
       return true
     else
       return false

data/lib/ff/ruby/server/sdk/api/cf_client.rb

@@ -50,11 +50,9 @@ class CfClient < Closeable
     end
   end
 
-  def wait_for_initialization
-
+  def wait_for_initialization(timeout_ms: nil)
     if @client != nil
-
-      @client.wait_for_initialization
+      @client.wait_for_initialization(timeout: timeout_ms)
     end
   end
 

data/lib/ff/ruby/server/sdk/api/inner_client.rb

@@ -231,19 +231,23 @@ class InnerClient < ClientCallback
     @initialized = true
   end
 
-  def wait_for_initialization
-
+  def wait_for_initialization(timeout: nil)
     synchronize do
+      SdkCodes::info_sdk_waiting_to_initialize(@config.logger, timeout)
 
-      @config.logger.debug "Waiting for initialization to finish"
+      start_time = Time.now
 
       until @initialized
+        # Check if a timeout is specified and has been exceeded
+        if timeout && (Time.now - start_time) > (timeout / 1000.0)
+          @config.logger.warn "The SDK has timed out waiting to initialize with supplied timeout #{timeout} ms"
+          handle_initialization_failure
+        end
 
         sleep(1)
       end
 
       if @failure
-
         raise "Initialization failed"
       end
 
@@ -251,8 +255,17 @@ class InnerClient < ClientCallback
     end
   end
 
+
   protected
 
+  def handle_initialization_failure
+    @auth_service.close
+    @poll_processor.stop
+    @update_processor.stop
+    @metrics_processor.stop
+    on_auth_failed
+  end
+
   def setup
 
     @repository = StorageRepository.new(@config.cache, @repository_callback, @config.store, @config.logger)

data/lib/ff/ruby/server/sdk/api/inner_client_flag_evaluate_callback.rb

@@ -23,7 +23,7 @@ class InnerClientFlagEvaluateCallback < FlagEvaluateCallback
 
   def process_evaluation(feature_config, target, variation)
 
-    @logger.debug "Processing evaluation: " + feature_config.feature.to_s + ", " + target.identifier.to_s
+    @logger.debug "Processing evaluation: #{feature_config&.feature || 'nil feature'}, #{target&.identifier || 'nil target'}"
 
     @metrics_processor.register_evaluation(target, feature_config, variation)
   end

data/lib/ff/ruby/server/sdk/api/metrics_event.rb

@@ -2,11 +2,12 @@ class MetricsEvent
 
   attr_accessor :feature_config, :target, :variation
 
-  def initialize(feature_config, target, variation)
+  def initialize(feature_config, target, variation, logger)
 
     @target = target
     @variation = variation
     @feature_config = feature_config
+    @logger = logger
     freeze
   end
 
@@ -15,6 +16,15 @@ class MetricsEvent
   end
 
   def eql?(other)
+    # Guard clause other is the same type.
+    # While it should be, this adds protection for an edge case we are seeing with very large
+    # project sizes. Issue being tracked in FFM-12192, and once resolved, can feasibly remove
+    # these checks in a future release.
+    unless other.is_a?(MetricsEvent)
+      @logger.warn("Warning: Attempted to compare MetricsEvent with #{other.class.name}" )
+      return false
+    end
+
     feature_config.feature == other.feature_config.feature and
       variation.identifier == other.variation.identifier and
       target.identifier == other.target.identifier

data/lib/ff/ruby/server/sdk/api/metrics_processor.rb

@@ -9,6 +9,7 @@ require_relative "../api/metrics_event"
 require_relative "../api/summary_metrics"
 
 class MetricsProcessor < Closeable
+  GLOBAL_TARGET = Target.new(identifier: "__global__cf_target", name: "Global Target").freeze
 
   class FrequencyMap < Concurrent::Map
     def initialize(options = nil, &block)
@@ -29,6 +30,7 @@ class MetricsProcessor < Closeable
       self[key]
     end
 
+    # TODO Will be removed in V2 in favour of simplified clearing. Currently not used outside of tests.
     def drain_to_map
       result = {}
       each_key do |key|
@@ -65,7 +67,6 @@ class MetricsProcessor < Closeable
     @target_attribute = "target"
     @global_target_identifier = "__global__cf_target" # <--- This target identifier is used to aggregate and send data for all
     #                                             targets as a summary
-    @global_target = Target.new("RubySDK1", identifier = @global_target_identifier, name = @global_target_name)
     @ready = false
     @jar_version = Ff::Ruby::Server::Sdk::VERSION
     @server = "server"
@@ -111,12 +112,34 @@ class MetricsProcessor < Closeable
 
   def register_evaluation(target, feature_config, variation)
     register_evaluation_metric(feature_config, variation)
-    register_target_metric(target)
+    if target
+      register_target_metric(target)
+    end
   end
 
   private
 
   def register_evaluation_metric(feature_config, variation)
+    # Guard clause to ensure feature_config, @global_target, and variation are valid.
+    # While they should be, this adds protection for an edge case we are seeing with very large
+    # project sizes.  Issue being tracked in FFM-12192, and once resolved, can feasibly remove
+    # these checks in a future release.
+    if feature_config.nil? || !feature_config.respond_to?(:feature) || feature_config.feature.nil?
+      @config.logger.warn("Skipping invalid MetricsEvent: feature_config is missing or incomplete. feature_config=#{feature_config.inspect}")
+      return
+    end
+
+    if GLOBAL_TARGET.nil? || !GLOBAL_TARGET.respond_to?(:identifier) || GLOBAL_TARGET.identifier.nil?
+      @config.logger.warn("Skipping invalid MetricsEvent: global_target is missing or incomplete. global_target=#{GLOBAL_TARGET.inspect}")
+      return
+    end
+
+    if variation.nil? || !variation.respond_to?(:identifier) || variation.identifier.nil?
+      @config.logger.warn("Skipping iInvalid MetricsEvent: variation is missing or incomplete. variation=#{variation.inspect}")
+      return
+    end
+
+
     if @evaluation_metrics.size > @max_buffer_size
       unless @evaluation_warning_issued.true?
         SdkCodes.warn_metrics_evaluations_max_size_exceeded(@config.logger)
@@ -125,7 +148,7 @@ class MetricsProcessor < Closeable
       return
     end
 
-    event = MetricsEvent.new(feature_config, @global_target, variation)
+    event = MetricsEvent.new(feature_config, GLOBAL_TARGET, variation, @config.logger)
     @evaluation_metrics.increment event
   end
 
@@ -158,8 +181,14 @@ class MetricsProcessor < Closeable
   end
 
   def send_data_and_reset_cache(evaluation_metrics_map, target_metrics_map)
-    evaluation_metrics_map_clone = evaluation_metrics_map.drain_to_map
+    # Clone and clear evaluation metrics map
+    evaluation_metrics_map_clone = Concurrent::Map.new
 
+    evaluation_metrics_map.each_pair do |key, value|
+      evaluation_metrics_map_clone[key] = value
+    end
+
+    evaluation_metrics_map.clear
     target_metrics_map_clone = Concurrent::Map.new
 
     target_metrics_map.each_pair do |key, value|
@@ -188,6 +217,24 @@ class MetricsProcessor < Closeable
 
     total_count = 0
     evaluation_metrics_map.each do |key, value|
+      # While Components should not be missing, this adds protection for an edge case we are seeing with very large
+      # project sizes.  Issue being tracked in FFM-12192, and once resolved, can feasibly remove
+      # these checks in a future release.
+      # Initialize an array to collect missing components
+      missing_components = []
+
+      # Check each required component and add to missing_components if absent
+      missing_components << 'feature_config' unless key.respond_to?(:feature_config) && key.feature_config
+      missing_components << 'variation' unless key.respond_to?(:variation) && key.variation
+      missing_components << 'target' unless key.respond_to?(:target) && key.target
+      missing_components << 'count' if value.nil?
+
+      # If any components are missing, log a detailed warning and skip processing
+      unless missing_components.empty?
+        @config.logger.warn "Skipping invalid metrics event: missing #{missing_components.join(', ')} in key: #{key.inspect}, full details: #{key.inspect}"
+        next
+      end
+
       total_count += value
       metrics_data = OpenapiClient::MetricsData.new({ :attributes => [] })
       metrics_data.timestamp = (Time.now.to_f * 1000).to_i

data/lib/ff/ruby/server/sdk/common/sdk_codes.rb

@@ -14,6 +14,17 @@ class SdkCodes
     logger.info SdkCodes.sdk_err_msg(1000)
   end
 
+  def self.info_sdk_waiting_to_initialize(logger, timeout)
+    if timeout
+      message = "with timeout: #{timeout} ms"
+    else
+
+      message = "with no timeout"
+
+    end
+    logger.info SdkCodes.sdk_err_msg(1003, message)
+  end
+
   def self.info_sdk_auth_ok(logger)
     logger.info SdkCodes.sdk_err_msg(2000)
   end
@@ -76,6 +87,7 @@ class SdkCodes
       1000 => "The SDK has successfully initialized",
       1001 => "The SDK has failed to initialize due to the following authentication error:",
       1002 => "The SDK has failed to initialize due to a missing or empty API key",
+      1003 => "The SDK is waiting for initialzation to complete",
       # SDK_AUTH_2xxx
       2000 => "Authenticated ok",
       2001 => "Authentication failed with a non-recoverable error - defaults will be served",

data/lib/ff/ruby/server/sdk/connector/harness_connector.rb

@@ -46,6 +46,11 @@ class HarnessConnector < Connector
         # determine if a timeout has occurred. This is fixed in 6.3.0 but requires Ruby version to be increased to 2.7
         # https://github.com/OpenAPITools/openapi-generator/releases/tag/v6.3.0
         @config.logger.warn "OpenapiClient::ApiError [\n\n#{e}\n]"
+
+        if e.code
+          return e.code
+        end
+
         return -1
       end
 

data/lib/ff/ruby/server/sdk/version.rb

@@ -5,7 +5,7 @@ module Ff
     module Server
       module Sdk
 
-        VERSION = "1.3.2"
+        VERSION = "1.4.1"
       end
     end
   end

data/scripts/sdk_specs.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 export ff_ruby_sdk="ff-ruby-server-sdk"
-export ff_ruby_sdk_version="1.3.2"
+export ff_ruby_sdk_version="1.4.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.1
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -305,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Harness is a feature management platform that helps teams to build better