ff-ruby-server-sdk 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09354edeb352628c1f9744e9c685dc27c2547fc81f3db0e9254dfe8bc9122d58'
-  data.tar.gz: 7f011367b6a2d16162b42f2f02db2730cd04dcff6bf75170d90b2c065e4203a6
+  metadata.gz: ab04a74816651d46324faf27b7aac91d4d6ef5941c01eee61a674fb36cf54bd1
+  data.tar.gz: f52922e05d01426ba12f63e07b5f6e25fbfe477f83c44d13cba72038b35932dc
 SHA512:
-  metadata.gz: 3f3f09d1185dc89443b8b55bf9fe3bdb5ae6105cae81ec861df2affe25b2ade4b7aa7c3620dc1fc41cdde1979b624c8eef3d57e15474ffd8c2934d8dbc03b843
-  data.tar.gz: 02eabc3cce448322b89c5901e183b8d2e9f25d47b605569d26aa07743f669e51d2779efc2c87179e711e37e68f381c6a1458352568e8bff399f19a548fc2b5cd
+  metadata.gz: 2d4038c666ffe22ce8170e17fd8bec516068c0e4fbb5034b706e5efafd3e612d06a4b9cd2b03e63d70bbb9b7b13f8e26360f5f5b26684bcb40904228afa449d7
+  data.tar.gz: 9164338df82c7c97cd2620d302e6d7b8f43299b2a5580988288ddf4ad6bf5b3469519d8ece420333b2c28ea908de27076d5e43905ebe8045b3c722f4909dbc69

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# [1.1.0]
+
+- [FFM-7285] - Remove Metrics queue and implement Map for better memory usage
+- [FFM-7325] - Improve authentication retry logic
+- [FFM-6926] - Add basic Ruby on Rails example
+- [FFM-6965] - Fixes analytics_enabled(false) which didn't fully turn off metrics
+- [FFM-7005] - Add TLS support custom CAs and remove sse-client
+- [FFM-7292] - Add HTTP headers for diagnostics
+
 # [1.0.6]
 
 - [FFM-3715] - Updates open api dependency issue

data/example/getting_started/getting_started.rb

@@ -8,6 +8,7 @@ require "securerandom"
 
 $stdout.sync = true
 logger = Logger.new $stdout
+logger.level = Logger::DEBUG
 
 # API Key
 apiKey = ENV['FF_API_KEY'] || 'changeme'

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

@@ -36,7 +36,7 @@ class AuthService < Closeable
           @logger.warn "Got HTTP code #{http_code} while authenticating on attempt #{attempt}, will retry in #{delay_ms} ms"
           sleep(delay_ms/1000)
           attempt += 1
-          @logger.info "Retrying to authenticate, attempt #{attempt}..."
+          SdkCodes::warn_auth_retying @logger, attempt
         else
           @logger.warn "Auth Service got HTTP code #{http_code} while authenticating, will not attempt to reconnect"
           @callback.on_auth_failed
@@ -67,10 +67,10 @@ class AuthService < Closeable
 
   def stop_async
     if @thread != nil
-      @logger.info "Stopping Auth service, status=#{@thread.status}"
+      @logger.debug "Stopping Auth service, status=#{@thread.status}"
       @thread.exit
       @thread = nil
-      @logger.info "Stopping Auth service done"
+      @logger.debug "Stopping Auth service done"
     end
   end
 

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

@@ -3,6 +3,7 @@ require "murmurhash3"
 
 require_relative "evaluation"
 require_relative "../common/repository"
+require_relative "../common/sdk_codes"
 
 class Evaluator < Evaluation
 
@@ -33,6 +34,7 @@ class Evaluator < Evaluation
       return variation.value == "true"
     end
 
+    SdkCodes::warn_default_variation_served @logger, identifier, target, default_value.to_s
     default_value
   end
 
@@ -45,6 +47,7 @@ class Evaluator < Evaluation
       return variation.value
     end
 
+    SdkCodes::warn_default_variation_served @logger, identifier, target, default_value.to_s
     default_value
   end
 
@@ -57,6 +60,7 @@ class Evaluator < Evaluation
       return variation.value.to_i
     end
 
+    SdkCodes::warn_default_variation_served @logger, identifier, target, default_value.to_s
     default_value
   end
 
@@ -68,6 +72,7 @@ class Evaluator < Evaluation
       return variation.value.to_f
     end
 
+    SdkCodes::warn_default_variation_served @logger, identifier, target, default_value.to_s
     default_value
   end
 
@@ -80,6 +85,7 @@ class Evaluator < Evaluation
       return JSON.parse(variation.value)
     end
 
+    SdkCodes::warn_default_variation_served @logger, identifier, target, default_value.to_s
     default_value
   end
 
@@ -219,13 +225,13 @@ class Evaluator < Evaluation
 
     clauses.each do |clause|
 
-      unless evaluate_clause(clause, target)
+      if evaluate_clause(clause, target)
 
-        return false
+        return true
       end
     end
 
-    true
+    false
   end
 
   def evaluate_clause(clause, target)
@@ -295,7 +301,7 @@ class Evaluator < Evaluation
 
     if operator == "in"
 
-      return object.include?(value)
+      return clause.values.include?(object)
     end
 
     if operator == "segmentMatch"
@@ -460,60 +466,47 @@ class Evaluator < Evaluation
     prerequisites = parent_feature_config.prerequisites
 
     if prerequisites != nil && !prerequisites.empty?
+      @logger.debug "Checking prerequisite #{prerequisites.to_s} of flag #{parent_feature_config.feature}"
 
-      @logger.debug "Checking pre requisites " + prerequisites.to_s + " of parent feature " + parent_feature_config.feature.to_s
-
-      prerequisites.each do |pqs|
-
-        pre_req_feature = pqs.feature
-
-        pre_req_feature_config = @repository.get_flag(pre_req_feature)
-
-        if pre_req_feature_config == nil
-
-          @logger.debug "Could not retrieve the pre requisite details of feature flag: " + pre_req_feature.to_s
+      prerequisites.each do |pre_req|
+        pre_req_flag = @repository.get_flag(pre_req.feature)
 
+        if pre_req_flag == nil
+          @logger.debug "Could not retrieve the pre requisite details of feature flag: #{pre_req.feature}"
           return true
         end
 
-        pre_req_evaluated_variation = evaluate_flag(pre_req_feature_config, target)
-
-        if pre_req_evaluated_variation == nil
-
-          @logger.debug "Could not evaluate the prerequisite details of feature flag: " + pre_req_feature.to_s
+        evaluated_pre_req = evaluate_flag(pre_req_flag, target)
 
+        if evaluated_pre_req == nil
+          @logger.debug "Could not evaluate the prerequisite details of feature flag: #{pre_req.feature}"
           return true
         end
 
-        @logger.debug "Pre requisite flag " + pre_req_feature_config.feature + " has variation " +
-                        pre_req_evaluated_variation.to_s + " for target " + target.to_s
-
-        valid_pre_req_variations = pqs.variations
-
-        @logger.debug "Pre requisite flag " + pre_req_feature_config.to_s + " should have the variations " +
-                        valid_pre_req_variations.to_s
-
         none_match = true
-
-        valid_pre_req_variations.each do |element|
-
-          if element.include?(pre_req_evaluated_variation.identifier)
-
+        pre_req.variations.each do |next_variation|
+          if next_variation.include?(evaluated_pre_req.identifier)
             none_match = false
             break
           end
         end
 
         if none_match
-
+          @logger.debug "Prerequisite flag #{pre_req_flag.feature} has no matching variations for flag #{parent_feature_config.feature}"
           return false
         else
-
-          return check_pre_requisite(pre_req_feature_config, target)
+          unless check_pre_requisite(pre_req_flag, target)
+            @logger.debug "Prerequisite flag #{pre_req_flag.feature} is switched off for flag #{parent_feature_config.feature}"
+            return false
+          end
         end
-      end
+      end # prerequisites.each
+
+      @logger.debug "All prerequisite flags are switched on for flag #{parent_feature_config.feature}"
+      return true
     end
 
+    @logger.debug "No prerequisite flags present for flag #{parent_feature_config.feature}, skipped"
     true
   end
 

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

@@ -12,14 +12,14 @@ require_relative "inner_client_repository_callback"
 require_relative "inner_client_flag_evaluate_callback"
 
 require_relative "../connector/harness_connector"
+require_relative "../common/sdk_codes"
 
 class InnerClient < ClientCallback
 
   def initialize(api_key = nil, config = nil, connector = nil)
 
     if api_key == nil || api_key == ""
-
-      raise "SDK key is not provided"
+      SdkCodes::raise_missing_sdk_key config.logger
     end
 
     if config == nil
@@ -87,7 +87,7 @@ class InnerClient < ClientCallback
 
   def on_auth_success
 
-    @config.logger.info "SDK successfully logged in"
+    SdkCodes::info_sdk_auth_ok @config.logger
 
     if @closing
 
@@ -107,9 +107,8 @@ class InnerClient < ClientCallback
   end
 
   def on_auth_failed
-    @config.logger.warn "Authentication failed with a non-recoverable error - defaults will be served"
+    SdkCodes::warn_auth_failed_srv_defaults @config.logger
     @initialized = true
-
   end
 
   def close
@@ -205,19 +204,19 @@ class InnerClient < ClientCallback
     if processor == @poll_processor
 
       @poller_ready = true
-      @config.logger.info "PollingProcessor ready"
+      @config.logger.debug "PollingProcessor ready"
     end
 
     if processor == @update_processor
 
       @stream_ready = true
-      @config.logger.info "Updater ready"
+      @config.logger.debug "Updater ready"
     end
 
     if processor == @metrics_processor
 
       @metrics_ready = true
-      @config.logger.info "Metrics ready"
+      @config.logger.debug "Metrics ready"
     end
 
     if (@config.stream_enabled && !@stream_ready) ||
@@ -227,21 +226,16 @@ class InnerClient < ClientCallback
       return
     end
 
-    @config.logger.info "All processors now ready"
+    SdkCodes.info_sdk_init_ok @config.logger
 
     @initialized = true
-
-    # TODO: notify - Reactivity support
-    # TODO: notify_consumers - Reactivity support
-
-    @config.logger.info "Initialization is completed"
   end
 
   def wait_for_initialization
 
     synchronize do
 
-      @config.logger.info "Waiting for the initialization to finish"
+      @config.logger.debug "Waiting for initialization to finish"
 
       until @initialized
 
@@ -253,7 +247,7 @@ class InnerClient < ClientCallback
         raise "Initialization failed"
       end
 
-      @config.logger.info "Waiting for the initialization completed"
+      @config.logger.debug "Waiting for initialization has completed"
     end
   end
 
@@ -261,10 +255,6 @@ class InnerClient < ClientCallback
 
   def setup
 
-    @config.logger.info "SDK is not initialized yet! If store is used then values will be loaded from store" +
-           " otherwise default values will be used in meantime. You can use waitForInitialization method for SDK" +
-           " to be ready."
-
     @repository = StorageRepository.new(@config.cache, @repository_callback, @config.store, @config.logger)
 
     @metrics_callback = InnerClientMetricsCallback.new(self, @config.logger)

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

@@ -4,6 +4,7 @@ require "concurrent-ruby"
 require_relative "../dto/target"
 require_relative "../../sdk/version"
 require_relative "../common/closeable"
+require_relative "../common/sdk_codes"
 require_relative "../api/metrics_event"
 require_relative "../api/summary_metrics"
 
@@ -83,18 +84,18 @@ class MetricsProcessor < Closeable
   end
 
   def start
-    @config.logger.info "Starting metrics processor with request interval: " + @config.frequency.to_s
+    @config.logger.debug "Starting metrics processor with request interval: " + @config.frequency.to_s
     start_async
   end
 
   def stop
-    @config.logger.info "Stopping metrics processor"
+    @config.logger.debug "Stopping metrics processor"
     stop_async
   end
 
   def close
     stop
-    @config.logger.info "Closing metrics processor"
+    @config.logger.debug "Closing metrics processor"
   end
 
   def register_evaluation(target, feature_config, variation)
@@ -198,7 +199,7 @@ class MetricsProcessor < Closeable
       while @ready do
         unless @initialized
           @initialized = true
-          @config.logger.info "Metrics processor initialized"
+          SdkCodes::info_metrics_thread_started @config.logger
         end
         sleep(@config.frequency)
         run_one_iteration

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

@@ -29,13 +29,13 @@ class PollingProcessor < Closeable
 
     flags = []
 
-    @logger.info "Fetching flags started"
+    @logger.debug "Fetching flags started"
 
     result = @connector.get_flags
 
     if result != nil
 
-      @logger.info "Flags are fetched"
+      @logger.debug "Flags are fetched"
 
       result.each { |fc|
 
@@ -47,7 +47,7 @@ class PollingProcessor < Closeable
       }
     end
 
-    @logger.info "Fetching flags finished"
+    @logger.debug "Fetching flags finished"
 
     flags
   end
@@ -56,13 +56,13 @@ class PollingProcessor < Closeable
 
     segments = []
 
-    @logger.info "Fetching segments started"
+    @logger.debug "Fetching segments started"
 
     result = @connector.get_segments
 
     if result != nil
 
-      @logger.info "Segments are fetched"
+      @logger.debug "Segments are fetched"
 
       result.each { |s|
 
@@ -74,7 +74,7 @@ class PollingProcessor < Closeable
       }
     end
 
-    @logger.info "Fetching segments finished"
+    @logger.debug "Fetching segments finished"
 
     segments
   end
@@ -106,7 +106,7 @@ class PollingProcessor < Closeable
           unless @initialized
 
             @initialized = true
-            @logger.info "PollingProcessor initialized"
+            SdkCodes::info_poll_started(@logger, @poll_interval_in_sec)
 
             if @callback != nil
 
@@ -137,17 +137,16 @@ class PollingProcessor < Closeable
 
   def start
 
-    @logger.info "Starting PollingProcessor with request interval: " + @poll_interval_in_sec.to_s
+    @logger.debug "Starting PollingProcessor with request interval: " + @poll_interval_in_sec.to_s
     start_async
   end
 
   def stop
 
-    @logger.info "Stopping PollingProcessor"
+    @logger.debug "Stopping PollingProcessor"
     stop_async
     unless @ready
-
-      @logger.info "PollingProcessor stopped"
+      SdkCodes::info_polling_stopped @logger
     end
   end
 

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

@@ -28,7 +28,7 @@ class UpdateProcessor < Closeable
 
   def start
 
-    @logger.info "Starting updater (EventSource)"
+    @logger.debug "Starting updater (EventSource)"
 
     if @updater != nil
 
@@ -105,8 +105,6 @@ class UpdateProcessor < Closeable
 
   def process_flag(message)
 
-    @logger.info "Processing flag message: " + message.to_s
-
     config = @connector.get_flag(message["identifier"])
 
     if config != nil

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

@@ -0,0 +1,102 @@
+
+class SdkCodes
+  def self.raise_missing_sdk_key(logger)
+    msg = SdkCodes.sdk_err_msg(1002)
+    logger.error msg
+    raise msg
+  end
+
+  def self.info_poll_started(logger, durationSec)
+    logger.info SdkCodes.sdk_err_msg(4000, durationSec*1000)
+  end
+
+  def self.info_sdk_init_ok(logger)
+    logger.info SdkCodes.sdk_err_msg(1000)
+  end
+
+  def self.info_sdk_auth_ok(logger)
+    logger.info SdkCodes.sdk_err_msg(2000)
+  end
+
+  def self.info_polling_stopped(logger)
+    logger.info SdkCodes.sdk_err_msg(4001)
+  end
+
+  def self.info_stream_connected(logger)
+    logger.info SdkCodes.sdk_err_msg(5000)
+  end
+
+  def self.info_stream_event_received(logger, event_json)
+    logger.info SdkCodes.sdk_err_msg(5002, event_json)
+  end
+
+  def self.info_metrics_thread_started(logger)
+    logger.info SdkCodes.sdk_err_msg(7000)
+  end
+
+  def self.warn_auth_failed_srv_defaults(logger)
+    logger.warn SdkCodes.sdk_err_msg(2001)
+  end
+
+  def self.warn_auth_retying(logger, attempt)
+    logger.warn SdkCodes.sdk_err_msg(2003, ", attempt #{attempt}")
+  end
+
+  def self.warn_stream_disconnected(logger, reason)
+    logger.warn SdkCodes.sdk_err_msg(5001, reason)
+  end
+
+  def self.warn_post_metrics_failed(logger, reason)
+    logger.warn SdkCodes.sdk_err_msg(7002, reason)
+  end
+
+  def self.warn_default_variation_served(logger, identifier, target, default)
+    logger.warn SdkCodes.sdk_err_msg(6001, "identifier=%s, target=%s, default=%s" % [identifier, target.identifier, default])
+  end
+
+  private
+
+  @map =
+    {
+      # SDK_INIT_1xxx
+      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",
+      # SDK_AUTH_2xxx
+      2000 => "Authenticated ok",
+      2001 => "Authentication failed with a non-recoverable error - defaults will be served",
+      2003 => "Retrying to authenticate",
+      # SDK_POLL_4xxx
+      4000 => "Polling started, intervalMs:",
+      4001 => "Polling stopped",
+      # SDK_STREAM_5xxx
+      5000 => "SSE stream connected ok",
+      5001 => "SSE stream disconnected, reason:",
+      5002 => "SSE event received: ",
+      5003 => "SSE retrying to connect in",
+      # SDK_EVAL_6xxx
+      6000 => "Evaluated variation successfully",
+      6001 => "Default variation was served",
+      # SDK_METRICS_7xxx
+      7000 => "Metrics thread started",
+      7001 => "Metrics thread exited",
+      7002 => "Posting metrics failed, reason:",
+    }
+
+  def self.sdk_err_msg(error_code, append_text = "")
+    "SDKCODE(%s:%s): %s %s" % [(get_err_class error_code), error_code, @map[error_code], append_text]
+  end
+
+  def self.get_err_class(error_code)
+    if error_code >= 1000 and error_code <= 1999
+      return "init"
+    elsif error_code >= 2000 and error_code <= 2999 then return "auth"
+    elsif error_code >= 4000 and error_code <= 4999 then return "poll"
+    elsif error_code >= 5000 and error_code <= 5999 then return "stream"
+    elsif error_code >= 6000 and error_code <= 6999 then return "eval"
+    elsif error_code >= 7000 and error_code <= 7999 then return "metric"
+    end
+    ""
+  end
+
+end

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

@@ -2,7 +2,7 @@ require "json"
 require 'restclient'
 
 require_relative './service'
-
+require_relative "../common/sdk_codes"
 class Events < Service
 
   def initialize(
@@ -35,7 +35,7 @@ class Events < Service
   end
 
   def start
-    @logger.info "Starting EventSource service"
+    @logger.debug "Starting EventSource service"
     begin
       conn = RestClient::Request.execute(method: :get,
                                          url: @url,
@@ -46,15 +46,13 @@ class Events < Service
                                          read_timeout: 60,
                                          ssl_ca_file: @config.ssl_ca_cert)
 
-
     rescue => e
-      @logger.warn "SSE connection failed: " + e.message
-      on_error
+      on_error e.message
     end
   end
 
   def stop
-    @logger.info "Stopping EventSource service"
+    @logger.debug "Stopping EventSource service"
     on_closed
   end
 
@@ -63,23 +61,24 @@ class Events < Service
   end
 
   def on_open
-    @logger.info "EventSource connected"
+    SdkCodes::info_stream_connected @logger
     @updater.on_connected
   end
 
-  def on_error
-    @logger.error "EventSource error"
+  def on_error(reason="")
+    SdkCodes::warn_stream_disconnected @logger, reason
     @updater.on_error
     stop
   end
 
   def on_closed
-    @logger.info "EventSource disconnected"
+    SdkCodes::warn_stream_disconnected @logger, "on_closed called"
     @updater.on_disconnected
   end
 
   def on_message(message)
-    @logger.debug "EventSource message received " + message.to_s
+    SdkCodes::info_stream_event_received @logger, message.to_s
+
     msg = JSON.parse(message)
     @updater.update(msg)
   end
@@ -106,8 +105,9 @@ class Events < Service
       end
       close
     else
-      @logger.error "SSE ERROR: http_code=%d body=%d" % [response.code, response.body]
-      on_error
+      msg = "SSE ERROR: http_code=%d body=%d" % [response.code, response.body]
+      @logger.warn msg
+      on_error msg
     end
   end
 

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

@@ -35,7 +35,7 @@ class HarnessConnector < Connector
       response = @api.authenticate(opts = options)
       @token = response.auth_token
 
-      @config.logger.info "Token has been obtained"
+      @config.logger.debug "Token has been obtained"
       process_token
       return 200
 
@@ -49,7 +49,7 @@ class HarnessConnector < Connector
         return -1
       end
 
-      log_error(e)
+      log_error("auth", e)
       return e.code
     end
   end
@@ -66,7 +66,7 @@ class HarnessConnector < Connector
 
     rescue OpenapiClient::ApiError => e
 
-      log_error(e)
+      log_error("get_feature_config", e)
       return nil
     end
   end
@@ -83,7 +83,7 @@ class HarnessConnector < Connector
 
     rescue OpenapiClient::ApiError => e
 
-      log_error(e)
+      log_error("get_all_segments", e)
       return nil
     end
   end
@@ -127,12 +127,11 @@ class HarnessConnector < Connector
         opts = options
       )
 
-      @config.logger.info "Successfully sent analytics data to the server"
+      @config.logger.debug "Successfully sent analytics data to the server"
 
     rescue OpenapiClient::ApiError => e
-
-      log_error(e)
-      @config.logger.error "Exception while posting metrics to the event server"
+      log_error("post_metrics", e)
+      SdkCodes.warn_post_metrics_failed @config.logger, e.message
     end
   end
 
@@ -248,7 +247,7 @@ class HarnessConnector < Connector
     }
   end
 
-  def log_error(e)
+  def log_error(prefix, e)
 
     if e.code == 0
       type = "typhoeus/libcurl"
@@ -256,6 +255,6 @@ class HarnessConnector < Connector
       type = "HTTP code #{e.code}"
     end
 
-    @config.logger.warn "OpenapiClient::ApiError (#{type}) [\n\n" + e.to_s + "\n]"
+    @config.logger.warn "%s: OpenapiClient::ApiError (%s) [\n\n%s\n]" % [prefix, type, e.to_s]
   end
 end

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

@@ -5,7 +5,7 @@ module Ff
     module Server
       module Sdk
 
-        VERSION = "1.1.0"
+        VERSION = "1.1.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.1.0"
+export ff_ruby_sdk_version="1.1.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -262,6 +262,7 @@ files:
 - lib/ff/ruby/server/sdk/common/closeable.rb
 - lib/ff/ruby/server/sdk/common/destroyable.rb
 - lib/ff/ruby/server/sdk/common/repository.rb
+- lib/ff/ruby/server/sdk/common/sdk_codes.rb
 - lib/ff/ruby/server/sdk/common/storage.rb
 - lib/ff/ruby/server/sdk/connector/connector.rb
 - lib/ff/ruby/server/sdk/connector/events.rb