ff-ruby-server-sdk 1.0.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dc03fbc008625a0836f68d7633ed828fca000860ca0ed4bb570acac0e5d0b1c
-  data.tar.gz: 4d7b5998b0fa349c54f08589a094c2d9674989dde242bd0ca173222e92d579c1
+  metadata.gz: ab04a74816651d46324faf27b7aac91d4d6ef5941c01eee61a674fb36cf54bd1
+  data.tar.gz: f52922e05d01426ba12f63e07b5f6e25fbfe477f83c44d13cba72038b35932dc
 SHA512:
-  metadata.gz: 8c0be4cdc264f5efa858b9746824e0304a255f21ff1c8b030e3b9556766f895c7864c26e279bab9370d696e5005934c55a79a11be23d146e8fd477cc82ad2bcf
-  data.tar.gz: a17fdcd1fbcdbc8d4942acf543b06751648a6c986c3abb82e0bb7b239ce0e983349fa6cab0dc9a679df4b4250bce527ab76c93c27560edfa839b328ffb06bd53
+  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/Gemfile

@@ -16,10 +16,16 @@ gem "moneta"
 
 # SSE support:
 gem "rest-client"
-gem "sse-client"
 
 # Concurrency support:
-gem "concurrent-ruby", require: "concurrent"
+gem "concurrent-ruby", "1.1.10", require: "concurrent"
 
 # Evaluator dependencies:
 gem "murmurhash3"
+
+gem "typhoeus"
+
+group :test do
+  gem 'simplecov', '~> 0.21.2'
+end
+

data/README.md

@@ -81,7 +81,7 @@ client.close
 
 ```bash
 # Install the deps
-gem install ff-ruby-server-sdk typhoeus openapi_client
+gem install ff-ruby-server-sdk typhoeus
 
 # Set your API Key
 export FF_API_KEY=<your key here>
@@ -96,7 +96,7 @@ use docker to quickly get started
 
 ```bash
 # Install the package
-docker run -v $(pwd):/app -w /app -e FF_API_KEY=$FF_API_KEY ruby:2.7-buster gem install --install-dir ./gems ff-ruby-server-sdk typhoeus openapi_client
+docker run -v $(pwd):/app -w /app -e FF_API_KEY=$FF_API_KEY ruby:2.7-buster gem install --install-dir ./gems ff-ruby-server-sdk typhoeus
 
 # Run the script
 docker run -v $(pwd):/app -w /app -e FF_API_KEY=$FF_API_KEY -e GEM_HOME=/app/gems ruby:2.7-buster ruby ./example/getting_started/getting_started.rb
@@ -108,6 +108,7 @@ Further examples and config options are in the further reading section:
 
 [Further Reading](docs/further_reading.md)
 
+[Ruby on Rails example](ruby_on_rails_example/README.md)
 
 -------------------------
 [Harness](https://www.harness.io/) is a feature management platform that helps teams to build better software and to

data/buildInContainer.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+ruby -v
+apt-get update
+apt-get install -y npm
+apt-get install -y maven
+apt-get install -y jq
+mvn --version
+npm install @openapitools/openapi-generator-cli -g
+npm install @openapitools/openapi-generator-cli -D
+gem install minitest-junit
+sh scripts/install.sh
+gem env
+gem install ff-ruby-server-sdk typhoeus
+ruby test/ff/ruby/server/sdk/sdk_test.rb --junit

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'
@@ -32,7 +33,7 @@ target = Target.new("RubySDK", identifier="rubysdk", attributes={"location": "em
 # Loop forever reporting the state of the flag
 loop do
   result = client.bool_variation(flagName, target, false)
-  logger.info "Flag variation:  #{result}"
+  logger.info "Flag #{flagName} is set to:  #{result}"
   sleep 10
 end
 

data/example/tls_example/tls_example.rb

@@ -0,0 +1,67 @@
+require 'ff/ruby/server/sdk/api/config'
+require 'ff/ruby/server/sdk/dto/target'
+require 'ff/ruby/server/sdk/api/cf_client'
+require 'ff/ruby/server/sdk/api/config_builder'
+
+require "logger"
+require "securerandom"
+
+$stdout.sync = true
+logger = Logger.new $stdout
+
+# API Key
+apiKey = ENV['FF_API_KEY'] || 'changeme'
+
+# Flag Name
+flagName = ENV['FF_FLAG_NAME'] || 'harnessappdemodarkmode'
+
+logger.info "Harness Ruby SDK TLS example"
+
+=begin
+ For ff servers with a custom or private CAs, you can use 'tls_ca_cert' to pass in the CA bundle in ASCII PEM format.
+ You should also include any intermediate CAs so the full trust chain can be resolved. Typhoeus HTTP client uses libcurl
+ underneath, when developing you should enable debugging(true) to get more detailed error diagnostics logged, which
+ aren't reported through OpenAPI. Common errors include:
+
+ SSL peer certificate or SSH remote key was not OK - you have an invalid or missing CA for the server you're trying
+                                                     to connect to. It can also mean the server hostname and request
+                                                     hostname don't match.
+ SSL: no alternative certificate subject name      - The hostname or IP used in your SDK URLs do not match the SANs
+   matches target host name ‘<host>'                 configured in the cert sent by the web server. You should either
+                                                     fix your URLs or ensure the SANs in the X.509 cert are configured
+                                                     correctly.
+
+The example below assumes you have an ff-server (or proxy) configured with TLS for a server hosted on
+'ffserver:8000' where the web server's cert has a SANs with DNS entry 'ffserver'. CA.crt tells the SDK you trust this
+server.
+
+Typhoeus/libcurl by default has its default CA bundle stored at /etc/ssl/cert.pem. You can append your CA here if
+you choose not to use 'tls_ca_cert'.
+
+=end
+
+
+client = CfClient.instance
+client.init(apiKey, ConfigBuilder.new.logger(logger)
+                                 .event_url("https://ffserver:8001/api/1.0")
+                                 .config_url("https://ffserver:8000/api/1.0")
+                                 .tls_ca_cert("/path/to/CA.crt")
+                                 .debugging(true)
+                                 .build)
+
+client.wait_for_initialization
+
+
+# Create a target (different targets can get different results based on rules.  This include a custom attribute 'location')
+target = Target.new("RubySDK", identifier="rubysdk", attributes={"location": "emea"})
+
+# Loop forever reporting the state of the flag
+loop do
+  result = client.bool_variation(flagName, target, false)
+  logger.info "#{flagName} flag variation:  #{result}"
+  sleep 10
+end
+
+client.close
+
+

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

@@ -2,56 +2,47 @@ require_relative "../common/closeable"
 
 class AuthService < Closeable
 
-  def initialize(connector = nil, poll_interval_in_sec = 60, callback = nil, logger = nil)
+  def initialize(connector, callback, logger, retry_delay_ms = 6000)
 
     unless connector.kind_of?(Connector)
-
       raise "The 'connector' parameter must be of '" + Connector.to_s + "' data type"
     end
 
     unless callback.kind_of?(ClientCallback)
-
       raise "The 'callback' parameter must be of '" + ClientCallback.to_s + "' data type"
     end
 
+    @logger = logger
     @callback = callback
     @connector = connector
-    @poll_interval_in_sec = poll_interval_in_sec
-
-    if logger != nil
-
-      @logger = logger
-    else
-
-      @logger = Logger.new(STDOUT)
-    end
+    @retry_delay_ms = retry_delay_ms
+    @authenticated = false
   end
 
   def start_async
-
     @logger.debug "Async starting: " + self.to_s
 
-    @ready = true
-
-    @thread = Thread.new do
-
-      @logger.debug "Async started: " + self.to_s
-
-      while @ready do
-
-        @logger.debug "Async auth iteration"
-
-        if @connector.authenticate
+    @thread = Thread.new :report_on_exception => true do
+      attempt = 1
+      until @authenticated do
+        http_code = @connector.authenticate
 
+        if http_code == 200
+          @authenticated = true
           @callback.on_auth_success
           stop_async
-          @logger.info "Stopping Auth service"
+        elsif should_retry_http_code http_code
+          delay_ms = @retry_delay_ms * [10, attempt].min
+          @logger.warn "Got HTTP code #{http_code} while authenticating on attempt #{attempt}, will retry in #{delay_ms} ms"
+          sleep(delay_ms/1000)
+          attempt += 1
+          SdkCodes::warn_auth_retying @logger, attempt
         else
-
-          @logger.error "Exception while authenticating, retry in " + @poll_interval_in_sec.to_s + " seconds"
+          @logger.warn "Auth Service got HTTP code #{http_code} while authenticating, will not attempt to reconnect"
+          @callback.on_auth_failed
+          stop_async
+          next
         end
-
-        sleep(@poll_interval_in_sec)
       end
     end
 
@@ -59,33 +50,50 @@ class AuthService < Closeable
   end
 
   def close
-
     stop_async
   end
 
-  def on_auth_success
+  protected
 
-    unless @callback == nil
+  def on_auth_success
 
+    if @callback != nil
       unless @callback.kind_of?(ClientCallback)
-
         raise "Expected '" + ClientCallback.to_s + "' data type for the callback"
       end
-
       @callback.on_auth_success
     end
   end
 
-  protected
-
   def stop_async
-
-    @ready = false
-
     if @thread != nil
-
+      @logger.debug "Stopping Auth service, status=#{@thread.status}"
       @thread.exit
       @thread = nil
+      @logger.debug "Stopping Auth service done"
+    end
+  end
+
+  private
+
+  def is_authenticated
+    @authenticated
+  end
+
+  def should_retry_http_code(code)
+    # 408 request timeout
+    # 425 too early
+    # 429 too many requests
+    # 500 internal server error
+    # 502 bad gateway
+    # 503 service unavailable
+    # 504 gateway timeout
+    #  -1 OpenAPI error (timeout etc)
+    case code
+    when 408,425,429,500,502,503,504,-1
+      return true
+    else
+      return false
     end
   end
 end

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

@@ -1,5 +1,5 @@
-require "openapi_client"
 
+require_relative "../../generated/lib/openapi_client"
 require_relative "../common/closeable"
 require_relative "inner_client"
 

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

@@ -2,44 +2,49 @@ require_relative "../common/closeable"
 
 class ClientCallback < Closeable
 
+  TBI = RuntimeError.new("To be implemented")
+
   def initialize
     super
-
-    @tbi = "To be implemented"
   end
 
   def on_auth_success
 
-    raise @tbi
+    raise TBI
+  end
+
+  def on_auth_failed
+
+    raise TBI
   end
 
   def on_authorized
 
-    raise @tbi
+    raise TBI
   end
 
   def is_closing
 
-    raise @tbi
+    raise TBI
   end
 
   def on_processor_ready(processor)
 
-    raise @tbi
+    raise TBI
   end
 
   def on_update_processor_ready
 
-    raise @tbi
+    raise TBI
   end
 
   def on_metrics_processor_ready
 
-    raise @tbi
+    raise TBI
   end
 
   def update(message, manual)
 
-    raise @tbi
+    raise TBI
   end
 end

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

@@ -7,7 +7,7 @@ class Config
   attr_accessor :config_url, :event_url, :stream_enabled, :poll_interval_in_seconds, :analytics_enabled,
                 :frequency, :buffer_size, :all_attributes_private, :private_attributes, :connection_timeout,
                 :read_timeout, :write_timeout, :debugging, :metrics_service_acceptable_duration, :cache, :store,
-                :logger
+                :logger, :ssl_ca_cert
 
   # Static:
   class << self
@@ -35,7 +35,7 @@ class Config
 
     @frequency = @@min_frequency
 
-    @buffer_size = 1024
+    @buffer_size = 2048
 
     @all_attributes_private = false
 
@@ -82,7 +82,7 @@ class Config
 
   def verify_ssl
 
-    nil
+    true
   end
 
   def cert_file
@@ -97,7 +97,7 @@ class Config
 
   def ssl_ca_cert
 
-    nil
+    @ssl_ca_cert
   end
 
   def client_side_validation

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

@@ -83,6 +83,11 @@ class ConfigBuilder
     self
   end
 
+  def tls_ca_cert(cert_file)
+    @config.ssl_ca_cert = cert_file
+    self
+  end
+
   def logger(logger)
 
     @config.logger = logger

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