featurehub-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4621f1ab8e515ab8eec3b701bf3928d1eabfafbe21a955175729dfeb39ed31b
-  data.tar.gz: 3e57a7dc1e0e525e6da0dca8848d42fd09eea437a378162160b5e529422fa12c
+  metadata.gz: 033fbbd756fd2a748d584634724881aae1a2d49feec0a2f7cec4aa7245dc8440
+  data.tar.gz: 042ff7ee449a8b80a5f120d203c791e7e42c896dce377a5c7af4367c94048829
 SHA512:
-  metadata.gz: 95899cd71c1c70756cddc97821c30173ef5381c0ba384d58e9be0b6c57664b59be85e4f748d55723677b84dfdda276df48526a8bb603165da911af1fc0344305
-  data.tar.gz: 8840b4aa7359fa5bbbc3247bac92df4fc96915c788737d08e3d4a0ccd92542536e05b527411875f17b4a5b94b7614f033303eaba93d349a88be200e010f8ccef
+  metadata.gz: 0fe881017cbb21138eed0663f0df11d18df61e63be666c5e2e26b68ca478792e8bb51f123ea415d86c8ce6ede3e087b2c7e8b35991c90d6939bac7672f0f7de4
+  data.tar.gz: 944146e27443caad934f35b1efb30179ec3c1a8b8c78d2def46e68250b338b156184e79b861be2ae3b929cf4b38a7514978a1757bd7e24a65ede50930010c9a7

data/.rubocop.yml

@@ -12,6 +12,9 @@ Style/StringLiteralsInInterpolation:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 # affects similarity to other SDKs + pointless
 Metrics/MethodLength:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+## [1.2.0] - 2022-10-14
+
+- Fixing polling client for server eval
+- Added in tests for polling client
+- Added in server eval for streaming client
+- Added expired environment support for polling and streaming
+- Added cache busting for server eval polling client
+- 
+
 ## [1.1.0] - 2022-10-12
 
 - Adds support for array values in flag evaluation contexts via [this PR](https://github.com/featurehub-io/featurehub-ruby-sdk/pull/12)
+
 ## [1.0.0] - 2022-06-06
 
 - Initial release, feature complete

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    featurehub-sdk (1.1.0)
+    featurehub-sdk (1.2.0)
       concurrent-ruby (~> 1.1.10)
       faraday (~> 2.3)
       ld-eventsource (~> 2.2.0)

data/lib/feature_hub/sdk/feature_hub_config.rb

@@ -74,7 +74,10 @@ module FeatureHub
         edge_provider
       end
 
-      def use_polling_edge_service(interval = ENV.fetch("FEATUREHUB_POLL_INTERVAL", "30").to_i); end
+      def use_polling_edge_service(interval = ENV.fetch("FEATUREHUB_POLL_INTERVAL", "30").to_i)
+        @interval = interval
+        @edge_service_provider = method(:create_polling_edge_provider)
+      end
 
       def new_context
         get_or_create_edge_service
@@ -99,8 +102,11 @@ module FeatureHub
         @edge_service_provider.call(@repository, @api_keys, @edge_url, @logger)
       end
 
+      def create_polling_edge_provider(repo, api_keys, edge_url, logger)
+        FeatureHub::Sdk::PollingEdgeService.new(repo, api_keys, edge_url, @interval, logger)
+      end
+
       def create_default_provider(repo, api_keys, edge_url, logger)
-        # FeatureHub::Sdk::PollingEdgeService.new(repo, api_keys, edge_url, 10, logger)
         FeatureHub::Sdk::StreamingEdgeService.new(repo, api_keys, edge_url, logger)
       end
 

data/lib/feature_hub/sdk/poll_edge_service.rb

@@ -4,12 +4,13 @@ require "faraday"
 require "faraday/net_http"
 require "json"
 require "concurrent-ruby"
+require "digest/sha2"
 
 module FeatureHub
   module Sdk
     # uses a periodic polling mechanism to get updates
     class PollingEdgeService < EdgeService
-      attr_reader :repository, :api_keys, :edge_url, :interval
+      attr_reader :repository, :api_keys, :edge_url, :interval, :stopped, :etag, :cancel, :sha_context
 
       def initialize(repository, api_keys, edge_url, interval, logger = nil)
         super(repository, api_keys, edge_url)
@@ -25,6 +26,8 @@ module FeatureHub
         @cancel = false
         @context = nil
         @etag = nil
+        @stopped = false
+        @sha_context = nil
 
         generate_url
       end
@@ -48,34 +51,53 @@ module FeatureHub
         return if new_header == @context
 
         @context = new_header
+        @sha_context = Digest::SHA256.hexdigest(@context)
 
-        get_updates
+        if active
+          get_updates
+        else
+          poll
+        end
       end
 
       def close
         cancel_task
       end
 
+      def active
+        !@task.nil?
+      end
+
       private
 
       def poll_with_interval
-        return if @cancel || !@task.nil?
-
-        get_updates
+        return if @cancel || !@task.nil? || @stopped
 
         @logger.info("starting polling for #{determine_request_url}")
-        @task = Concurrent::TimerTask.new(execution_interval: @interval) do
+        @task = Concurrent::TimerTask.new(execution_interval: @interval, run_now: false) do
           get_updates
         end
-        @task.execute
+
+        get_updates
+
+        @task&.execute # could have been shutdown
       end
 
       def cancel_task
+        @cancel = true
+        shutdown_task
+      end
+
+      def stopped_task
+        @stopped = true
+        shutdown_task
+      end
+
+      def shutdown_task
         return if @task.nil?
 
         @task.shutdown
         @task = nil
-        @cancel = true
       end
 
       # rubocop:disable Naming/AccessorMethodName
@@ -86,36 +108,63 @@ module FeatureHub
           "X-SDK": "Ruby",
           "X-SDK-Version": FeatureHub::Sdk::VERSION
         }
+
+        headers["x-featurehub"] = @context unless @context.nil?
         headers["if-none-match"] = @etag unless @etag.nil?
+
         @logger.debug("polling for #{url}")
-        resp = @conn.get(url, request: { timeout: @timeout }, headers: headers)
+        resp = @conn.get url, {}, headers
         case resp.status
         when 200
-          @etag = resp.headers["etag"]
-          process_results(JSON.parse(resp.body))
+          success(resp)
+        when 236
+          stopped_task
+          success(resp)
         when 404 # no such key
           @repository.notify("failed", nil)
-          @cancel = true
+          cancel_task
           @logger.error("featurehub: key does not exist, stopping polling")
         when 503 # dacha busy
-          @logger.debug("featurehub: dacha is busy, trying tgaina")
+          @logger.debug("featurehub: dacha is busy, trying again")
         else
           @logger.debug("featurehub: unknown error #{resp.status}")
         end
       end
+
       # rubocop:enable Naming/AccessorMethodName
 
+      def success(resp)
+        @etag = resp.headers["etag"]
+
+        check_interval_change(resp.headers["cache-control"]) if resp.headers["cache-control"]
+
+        process_results(JSON.parse(resp.body))
+      end
+
       def process_results(data)
         data.each do |environment|
           @repository.notify("features", environment["features"]) if environment
         end
       end
 
+      def check_interval_change(cache_control_header)
+        found = cache_control_header.scan(/max-age=(\d+)/)
+
+        return if @task.nil? || found.empty? || found[0].empty?
+
+        new_interval = found[0][0].to_i
+
+        return unless new_interval.positive? && new_interval != @interval
+
+        @interval = new_interval
+        @task.execution_interval = @interval
+      end
+
       def determine_request_url
         if @context.nil?
-          @url
+          "#{@url}&contextSha=0"
         else
-          "#{@url}&#{@context}"
+          "#{@url}&contextSha=#{@sha_context}"
         end
       end
 
@@ -125,6 +174,7 @@ module FeatureHub
         @timeout = ENV.fetch("FEATUREHUB_POLL_HTTP_TIMEOUT", "12").to_i
         @conn = Faraday.new(url: @edge_url) do |f|
           f.adapter :net_http
+          f.options.timeout = @timeout
         end
       end
     end

data/lib/feature_hub/sdk/streaming_edge_service.rb

@@ -7,7 +7,7 @@ module FeatureHub
   module Sdk
     # provides a streaming service
     class StreamingEdgeService < FeatureHub::Sdk::EdgeService
-      attr_reader :repository, :sse_client, :url, :closed
+      attr_reader :repository, :sse_client, :url, :stopped
 
       def initialize(repository, api_keys, edge_url, logger = nil)
         super(repository, api_keys, edge_url)
@@ -15,42 +15,78 @@ module FeatureHub
         @url = "#{edge_url}features/#{api_keys[0]}"
         @repository = repository
         @sse_client = nil
-        @closed = true
+        @context = nil
         @logger = logger || FeatureHub::Sdk.default_logger
       end
 
+      def closed
+        @sse_client.nil?
+      end
+
       def poll
-        start_streaming unless @sse_client
+        start_streaming unless @sse_client || @stopped
       end
 
       def active
-        !@closed && !@sse_client.nil?
+        !@sse_client.nil?
       end
 
       def close
-        @closed = true
+        close_connection
+      end
+
+      private
+
+      def close_connection
         return if @sse_client.nil?
 
         @sse_client.close
         @sse_client = nil
       end
 
-      private
+      def stop
+        @stopped = true
+        close_connection
+      end
+
+      def context_change(new_header)
+        return if new_header == @context
+
+        @context = new_header
+        close
+        poll
+      end
 
       def start_streaming
-        @closed = false
         @logger.info("streaming from #{@url}")
+        # we can get an error before returning the new() function and get a race condition on the close
+        must_close = false
         @sse_client = SSE::Client.new(@url) do |client|
           client.on_event do |event|
-            @repository.notify(event.type, JSON.parse(event.data))
+            json_data = JSON.parse(event.data)
+
+            if event.type == "config"
+              process_config(json_data)
+            else
+              @repository.notify(event.type, json_data)
+            end
           end
           client.on_error do |error|
             if error.is_a?(SSE::Errors::HTTPStatusError) && (error.status == 404)
               @repository.notify("failure", nil)
               close
+              must_close = true
             end
           end
         end
+
+        return unless must_close
+
+        close  # try again
+      end
+
+      def process_config(json_data)
+        stop if json_data["edge.stale"]
       end
     end
   end

data/lib/feature_hub/sdk/version.rb

@@ -3,7 +3,7 @@
 module FeatureHub
   # already documented elsewhere
   module Sdk
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
 
     def default_logger
       log = ::Logger.new($stdout)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: featurehub-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Richard Vowles
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -97,7 +97,6 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - Rakefile
-- featurehub-sdk.gemspec
 - featurehub-sdk.iml
 - lib/feature_hub/sdk/context.rb
 - lib/feature_hub/sdk/feature_hub_config.rb

data/featurehub-sdk.gemspec

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "feature_hub/sdk/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "featurehub-sdk"
-  spec.version = FeatureHub::Sdk::VERSION
-  spec.authors = ["Richard Vowles", "Irina Southwell"]
-  spec.email = ["richard@bluetrainsoftware.com"]
-
-  spec.summary = "FeatureHub Ruby SDK"
-  spec.description = "FeatureHub Ruby SDK"
-  spec.homepage = "https://www.featurehub.io"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/featurehub-io/featurehub-ruby-sdk"
-  spec.metadata["changelog_uri"] = "https://github.com/featurehub-io/featurehub-ruby-sdk/featurehub-sdk/CHANGELOG.md"
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "concurrent-ruby", "~> 1.1.10"
-  spec.add_dependency "faraday", "~> 2.3"
-  spec.add_dependency "ld-eventsource", "~> 2.2.0"
-  spec.add_dependency "murmurhash3", "~> 0.1.6"
-  spec.add_dependency "sem_version", "~> 2.0.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end