ff-ruby-server-sdk 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e06f7cec3eb38bff792b8406d0ff11fb487b8662c78ee9bdba3fdad46526e5f
-  data.tar.gz: 7bd8b2c5d1cb6955bdcb9ca6363a6c8afa89cc8b8dbda7769dc0bf60eca62ba0
+  metadata.gz: 6411beee7ad512c4e70efc7d9fbd45c71835b18eff4bf41b8e056333074dc083
+  data.tar.gz: 1f13b504ffda1c95f4956813ec8dc887935340a26dcba09689864250dbf4589b
 SHA512:
-  metadata.gz: 8eb61b5fa760cc59968d2ef51ddfe3263c3b75e9ec254304e9037a656a69318f4a2a7b6538c8ac5583394b5f0701af47c1ea2dbc1c94acb7dc830b4297c1d339
-  data.tar.gz: 55af3f78ef20bc1cc0e667ef70fa60a5a7b41e79578db544038b0afc165470560cfd7566acf61f3902042b56d82f6264ef0d47ac121c149b6b77d31bfcf97b82
+  metadata.gz: f3cc5c07fe09718e260ca6ab19bb720d0db276a60f6ff9b9229a4374bdfeebce0b519e6edbbf82d202183382f55c447d3ed2293b614035ab4f8e2ff7880b4d56
+  data.tar.gz: 7771ae2a6823afffa73dbda7e49beceab7ad973e8ef4cb8dfdd1781ca0de7ee3a10822d19c58a749a90ffe492c72e5dbcaf0b8a05a04159c510e38d675ff25c9

data/docs/further_reading.md

@@ -24,6 +24,50 @@ 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 with a timeout**
+
+```ruby
+client = CfClient.instance
+client.init(api_key, config)
+
+client.wait_for_initialization
+
+result = client.bool_variation("bool_flag", target, false)
+```
+
+**Usage without a timeout**
+
+```ruby
+client = CfClient.instance
+client.init(api_key, config)
+
+client.wait_for_initialization(timeout_ms: 3000)
+
+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/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.0"
       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.0"

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.0
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2024-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake