ff-ruby-server-sdk 1.0.6 → 1.1.1

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

@@ -1,8 +1,8 @@
 require "json"
-require "sse-client"
+require 'restclient'
 
 require_relative './service'
-
+require_relative "../common/sdk_codes"
 class Events < Service
 
   def initialize(
@@ -10,109 +10,105 @@ class Events < Service
     url,
     headers,
     updater,
-    logger = nil
+    config
   )
 
-    if @updater != nil
+    @url = url
+    @headers = headers
+    @headers['params'] = {}
+    @updater = updater
+    @config = config
 
+    if @updater != nil
       unless @updater.kind_of?(Updater)
-
         raise "The 'callback' parameter must be of '" + Updater.to_s + "' data type"
       end
     end
 
-    @updater = updater
-
-    if logger != nil
-
-      @logger = logger
+    if @config.logger != nil
+      @logger = @config.logger
     else
-
       @logger = Logger.new(STDOUT)
     end
 
-    @sse = SSE::EventSource.new(
-
-      url = url,
-      query = {},
-      headers = headers
-    )
-
-    @sse.open do
-
-      on_open
-    end
-
-    @sse.error do |error|
-
-      if error != nil
-
-        @logger.error "SSE ERROR: " + error.body
-      end
-
-      on_error
-    end
-
-    @sse.message do |message|
-
-      on_message(message)
-    end
-
-    @sse.on("*") do |message|
-
-      on_message(message)
-    end
-
     @updater.on_ready
   end
 
   def start
-
-    @logger.info "Starting EventSource service"
-
-    @sse.start
+    @logger.debug "Starting EventSource service"
+    begin
+      conn = RestClient::Request.execute(method: :get,
+                                         url: @url,
+                                         headers: @headers,
+                                         block_response: proc { |response| response_handler response },
+                                         before_execution_proc: nil,
+                                         log: false,
+                                         read_timeout: 60,
+                                         ssl_ca_file: @config.ssl_ca_cert)
+
+    rescue => e
+      on_error e.message
+    end
   end
 
   def stop
-
-    @logger.info "Stopping EventSource service"
-
+    @logger.debug "Stopping EventSource service"
     on_closed
   end
 
   def close
-
     stop
   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
+
+  private
+
+  def emit_line(line)
+    if line.start_with?("data:")
+      @logger.debug "SSE emit line: " + line
+      on_message line[line.index("{")..-1]
+    end
+  end
+
+  def response_handler(response)
+    on_open
+    case response.code
+    when "200"
+      line = ""
+      response.read_body do |chunk|
+        line << chunk
+        while line.sub!(/^(.*)\n/,"")
+            emit_line $1
+        end
+      end
+      close
+    else
+      msg = "SSE ERROR: http_code=%d body=%d" % [response.code, response.body]
+      @logger.warn msg
+      on_error msg
+    end
+  end
+
 end

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

@@ -13,6 +13,7 @@ class HarnessConnector < Connector
     @config = config
     @on_unauthorized = on_unauthorized
     @user_agent = "RubySDK " + Ff::Ruby::Server::Sdk::VERSION
+    @sdk_info = "Ruby #{Ff::Ruby::Server::Sdk::VERSION} Server"
 
     @api = OpenapiClient::ClientApi.new(make_api_client)
     @metrics_api = OpenapiClient::MetricsApi.new(make_metrics_api_client)
@@ -34,16 +35,23 @@ 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 true
+      return 200
 
     rescue OpenapiClient::ApiError => e
 
-      log_error(e)
-    end
+      if e.message.include? "the server returns an error"
+        # NOTE openapi-generator 5.2.1 has a bug where exceptions don't contain any useful information and we can't
+        # 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]"
+        return -1
+      end
 
-    false
+      log_error("auth", e)
+      return e.code
+    end
   end
 
   def get_flags
@@ -58,7 +66,8 @@ class HarnessConnector < Connector
 
     rescue OpenapiClient::ApiError => e
 
-      log_error(e)
+      log_error("get_feature_config", e)
+      return nil
     end
   end
 
@@ -74,7 +83,8 @@ class HarnessConnector < Connector
 
     rescue OpenapiClient::ApiError => e
 
-      log_error(e)
+      log_error("get_all_segments", e)
+      return nil
     end
   end
 
@@ -117,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
 
@@ -139,15 +148,19 @@ class HarnessConnector < Connector
     headers = {
 
       "Authorization" => "Bearer " + @token,
-      "API-Key" => @api_key
-    }
+      "API-Key" => @api_key,
+      "User-Agent" => @user_agent,
+      "Harness-SDK-Info" =>  @sdk_info,
+      "Harness-AccountID" => @account_id,
+      "Harness-EnvironmentID" => @environment_id
+    }.compact
 
     @event_source = Events.new(
 
       url,
       headers,
       updater,
-      @config.logger
+      @config
     )
 
     @event_source
@@ -169,7 +182,10 @@ class HarnessConnector < Connector
     api_client = OpenapiClient::ApiClient.new
 
     api_client.config = @config
+    api_client.config.connection_timeout = @config.read_timeout / 1000
+    api_client.config.read_timeout = @config.read_timeout / 1000
     api_client.user_agent = @user_agent
+    api_client.default_headers['Harness-SDK-Info'] = @sdk_info
 
     api_client
   end
@@ -189,30 +205,32 @@ class HarnessConnector < Connector
 
     api_client.config = config
     api_client.user_agent = @user_agent
+    api_client.default_headers['Harness-SDK-Info'] = @sdk_info
 
     api_client
   end
 
   def process_token
-
-    headers = {
-
-      "Authorization" => "Bearer " + @token
-    }
-
-    @api.api_client.default_headers = @api.api_client.default_headers.merge(headers)
-    @metrics_api.api_client.default_headers = @metrics_api.api_client.default_headers.merge(headers)
-
     decoded_token = JWT.decode @token, nil, false
 
     if decoded_token != nil && !decoded_token.empty?
 
       @environment = decoded_token[0]["environment"]
       @cluster = decoded_token[0]["clusterIdentifier"]
+      @environment_id = decoded_token[0]["environmentIdentifier"]
+      @account_id = decoded_token[0]["accountID"]
+
+      headers = {
+        "Authorization" => "Bearer " + @token,
+        "Harness-AccountID" => @account_id,
+        "Harness-EnvironmentID" => @environment_id
+      }.compact
+
+      @api.api_client.default_headers = @api.api_client.default_headers.merge(headers)
+      @metrics_api.api_client.default_headers = @metrics_api.api_client.default_headers.merge(headers)
 
       @config.logger.debug "Token has been processed: environment='" + @environment.to_s + "', cluster='" + @cluster.to_s + "'"
     else
-
       @config.logger.error "ERROR: Could not obtain the environment and cluster data from the token"
     end
   end
@@ -229,8 +247,14 @@ class HarnessConnector < Connector
     }
   end
 
-  def log_error(e)
+  def log_error(prefix, e)
+
+    if e.code == 0
+      type = "typhoeus/libcurl"
+    else
+      type = "HTTP code #{e.code}"
+    end
 
-    @config.logger.error "ERROR - Start\n\n" + e.to_s + "\nERROR - End"
+    @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.0.6"
+        VERSION = "1.1.1"
       end
     end
   end

data/scripts/openapi.sh

@@ -57,12 +57,9 @@ if which openapi-generator-cli; then
       gem install concurrent-ruby -v 1.1.10 && \
       gem install murmurhash3 -v 0.1.6 && \
       cd "$dir_path/.." && \
-      openapi-generator-cli generate -i api.yaml -g ruby -o "$generated_path" && \
-      cd "$generated_path" && gem build openapi_client.gemspec && \
-      test -e "openapi_client-1.0.0.gem" && \
-      gem install --dev "openapi_client-1.0.0.gem"; then
+      openapi-generator-cli generate -i api.yaml -g ruby -o "$generated_path"; then
 
-      echo "Generated API has been installed with success: $generated_path"
+      echo "API has been generated with success: $generated_path"
   else
 
       echo "ERROR: 'openapi-generator-cli' is not installed [1] 😬"

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.0.6"
+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.0.6
+  version: 1.1.1
 platform: ruby
 authors:
 - 'Miloš Vasić, cyr.: Милош Васић'
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,20 +122,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: sse-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -165,19 +151,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.6
 - !ruby/object:Gem::Dependency
-  name: openapi_client
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: Harness is a feature management platform that helps teams to build better
   software and to test features quicker.
 email:
@@ -198,6 +190,7 @@ files:
 - api.yaml
 - bin/console
 - bin/setup
+- buildInContainer.sh
 - docs/build.md
 - docs/further_reading.md
 - docs/images/ff-gui.png
@@ -207,6 +200,7 @@ files:
 - example/number_variation_example/number_variation_example.rb
 - example/simple_example/example.rb
 - example/string_variation_example/string_variation_example.rb
+- example/tls_example/tls_example.rb
 - example/url_change_example/url_change_example.rb
 - lib/ff/ruby/server/generated/lib/openapi_client.rb
 - lib/ff/ruby/server/generated/lib/openapi_client/api/client_api.rb
@@ -268,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
@@ -291,7 +286,7 @@ metadata:
   homepage_uri: https://www.harness.io/
   source_code_uri: https://github.com/harness/ff-ruby-server-sdk
   changelog_uri: https://github.com/harness/ff-ruby-server-sdk/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -307,8 +302,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Harness is a feature management platform that helps teams to build better
   software and to test features quicker.