featurehub-sdk 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a918d4c2cd828f070ede69b41bccaef489154f189bc93b497256f3589abec7f
-  data.tar.gz: 320522f90925794e6a12df0e3a034ddb46b81a69445d201447bc1bd51743d4e6
+  metadata.gz: 033fbbd756fd2a748d584634724881aae1a2d49feec0a2f7cec4aa7245dc8440
+  data.tar.gz: 042ff7ee449a8b80a5f120d203c791e7e42c896dce377a5c7af4367c94048829
 SHA512:
-  metadata.gz: 5ab24c0101cf91b2a0be85a92e5665d21397a7733be165c2c718208887b1060e29c621e12595ff4b2bbbf4f502fd40a6f1da89b62e147d77f2e9a4c9bd981f15
-  data.tar.gz: 00ee27a652e9c85cabed5e331c18d4bfb68ee32e625e513f330f8534a89cc191c63f1320ce466d80807cf7a0d7518950da78b005e3c759d0e76791a060757607
+  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/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/CHANGELOG.md

@@ -1,3 +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.0.0)
+    featurehub-sdk (1.2.0)
       concurrent-ruby (~> 1.1.10)
       faraday (~> 2.3)
       ld-eventsource (~> 2.2.0)

data/lib/feature_hub/sdk/context.rb

@@ -73,7 +73,7 @@ module FeatureHub
       end
 
       def get_attr(key, default_val = nil)
-        (@attributes[key.to_sym] || [default_val])[0]
+        (@attributes[key.to_sym] || [default_val]).compact
       end
 
       def default_percentage_key

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/impl/apply_features.rb

@@ -67,26 +67,30 @@ module FeatureHub
 
         def match_attribute(context, rs_attr)
           rs_attr.attributes.each do |attr|
-            supplied_value = context.get_attr(attr.field_name)
-            if supplied_value.nil? && attr.field_name.downcase == "now"
+            supplied_values = context.get_attr(attr.field_name)
+            if supplied_values.empty? && attr.field_name.downcase == "now"
               case attr.field_type
               when "DATE"
-                supplied_value = Time.new.utc.iso8601[0..9]
+                supplied_values = [Time.new.utc.iso8601[0..9]]
               when "DATETIME"
-                supplied_value = Time.new.utc.iso8601
+                supplied_values = [Time.new.utc.iso8601]
               end
             end
 
-            if attr.values.nil? && supplied_value.nil?
+            if attr.values.nil? && supplied_values.empty?
               return false unless attr.conditional.equals?
 
               next
             end
 
-            return false if attr.values.nil? || supplied_value.nil?
+            return false if attr.values.nil? || supplied_values.empty?
 
             # this attribute has to match or we failed
-            return false unless @matcher_repository.find_matcher(attr).match(supplied_value, attr)
+            match = supplied_values.any? do |supplied_value|
+              @matcher_repository.find_matcher(attr).match(supplied_value, attr)
+            end
+
+            return false unless match
           end
 
           true

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.0.0"
+    VERSION = "1.2.0"
 
     def default_logger
       log = ::Logger.new($stdout)

data/sig/feature_hub/featurehub.rbs

@@ -1,6 +1,7 @@
 module FeatureHub
   module Sdk
     VERSION: String
+
     # See the writing guide of rbs: https://github.com/ruby/rbs#guides
     #
 
@@ -11,13 +12,17 @@ module FeatureHub
           feature_state: Hash[untyped, untyped]?, parent_state: FeatureState?, ctx: ClientContext?) -> void
 
       def locked?: -> bool
+
       def exists?: (top_feature: FeatureState?) -> bool
+
       def id: -> String?
+
       def feature_type: -> String?
 
       def with_context: (ctx: ClientContext) -> FeatureState
 
       def update_feature_state: (feature_state: Hash[untyped, untyped]) -> void
+
       # this is the feature state of the top level, it always walks up
       def feature_state: () -> Hash[untyped, untyped]
 
@@ -57,19 +62,20 @@ module FeatureHub
       attr_reader matched: bool
       attr_reader value: [bool? | String? | Float?]
 
-      def initialize:(matched: bool, value: [bool? | String? | Float?]) -> void
+      def initialize: (matched: bool, value: [bool? | String? | Float?]) -> void
     end
 
     class InterceptorValue
-      def initialize: (val: [bool? | String? | Float? ]) -> void
-      def cast:(feature_type: String?) -> [bool? | String? | Float? ]
+      def initialize: (val: [bool? | String? | Float?]) -> void
+
+      def cast: (feature_type: String?) -> [bool? | String? | Float?]
     end
 
     class ValueInterceptor
       def intercepted_value: (feature_key: Symbol) -> InterceptorValue?
     end
 
-    class EnvironmentInterceptor <  ValueInterceptor
+    class EnvironmentInterceptor < ValueInterceptor
     end
 
     class PercentageCalculator
@@ -78,17 +84,25 @@ module FeatureHub
 
     class ApplyFeatures
       def initialize: (percent_calculator: PercentageCalculator?, matcher_repository: MatcherRepository?) -> void
+
       def apply: (strategies: Array[RolloutStrategy], key: String, feature_value_id: String, context: ClientContext) -> Applied
+
       def match_attribute: (context: ClientContext, rs: RolloutStrategyAttribute) -> bool
+
       def self.determine_percentage_key: (context: ClientContext, rsi: RolloutStrategy) -> String?
     end
 
     class InternalFeatureRepository
       def feature: (key: String) -> FeatureState?
+
       def find_interceptor: (feature_value: String) -> InterceptorValue?
+
       def ready?: -> bool
+
       def not_ready!: -> void
+
       def apply: (strategies: Array[RolloutStrategy], key: String, feature_id: String, context: ClientContext) -> Applied
+
       def notify: (status: String, data: Hash[untyped, untyped]) -> void
     end
 
@@ -96,15 +110,20 @@ module FeatureHub
       @features: Hash[String, FeatureState]
       @ready: bool
 
-      def initialize: (apply_features: nil | ApplyFeatures ) -> void
-      def apply:(strategies: Array[RolloutStrategy], key: String, feature_id: String, context: ClientContext) -> Applied
+      def initialize: (apply_features: nil | ApplyFeatures) -> void
+
+      def apply: (strategies: Array[RolloutStrategy], key: String, feature_id: String, context: ClientContext) -> Applied
 
       def notify: (status: String, data: Hash[untyped, untyped]) -> void
+
       def feature: (key: String) -> FeatureState
+
       def register_interceptor: (interceptor: ValueInterceptor) -> void
 
       def find_interceptor: (feature_value: String) -> InterceptorValue?
+
       def ready?: -> bool
+
       def not_ready!: -> void
 
       def extract_feature_state: -> Array[Hash[untyped, untyped]]
@@ -114,37 +133,61 @@ module FeatureHub
       attr_reader repo: InternalFeatureRepository
 
       def initialize: (repository: InternalFeatureRepository) -> void
+
       def user_key: (value: String) -> ClientContext
+
       def session_key: (value: String) -> ClientContext
+
       def version: (value: String) -> ClientContext
-      def country: (value: Symbol ) -> ClientContext
-      def platform: (value: Symbol ) -> ClientContext
-      def device: (value: Symbol ) -> ClientContext
-      def attribute_value: (key: String, values: Array[String] ) -> ClientContext
+
+      def country: (value: Symbol) -> ClientContext
+
+      def platform: (value: Symbol) -> ClientContext
+
+      def device: (value: Symbol) -> ClientContext
+
+      def attribute_value: (key: String, values: Array[String]) -> ClientContext
+
       def clear: -> ClientContext
-      def get_attr: (key: String, default_val: String?) -> String?
+
+      def get_attr: (key: String, default_val: String?) -> Array[String]
+
       def default_percentage_key: -> String?
+
       def enabled: (key: String) -> bool?
 
       def feature: (key: String) -> FeatureState
+
       def set?: (key: String) -> bool?
+
       def number: (key: String) -> Float?
+
       def string: (key: String) -> String?
+
       def json: (key: String) -> Hash[untyped, untyped]?
+
       def raw_json: (key: String) -> String?
+
       def flag: (key: String) -> bool?
+
       def boolean: (key: String) -> bool?
+
       def exists?: (key: String) -> bool
 
       def build: -> ClientContext
+
       def build_sync: -> ClientContext
+
       def close: -> ClientContext
     end
 
     class EdgeService
       def initialize: (repository: InternalFeatureRepository, api_keys: Array[String], edge_url: String) -> void
+
       def poll: -> void
+
       def context_change: (new_header: String?) -> void
+
       def close: -> void
     end
 
@@ -189,15 +232,25 @@ module FeatureHub
 
     class RolloutStrategyCondition
       def equals?: -> bool
+
       def ends_with?: -> bool
+
       def starts_with?: -> bool
+
       def greater?: -> bool
+
       def greater_equals?: -> bool
+
       def less?: -> bool
+
       def less_equals?: -> bool
+
       def not_equals?: -> bool
+
       def includes?: -> bool
+
       def excludes?: -> bool
+
       def regex?: -> bool
     end
 
@@ -209,6 +262,7 @@ module FeatureHub
       attr_reader field_type: String
 
       def float_values: -> Array[Float]
+
       def str_values: -> Array[String]
     end
 
@@ -221,15 +275,16 @@ module FeatureHub
       attr_reader value: [bool? | String? | Float?]
 
       def percentage_attributes?: -> bool
+
       def attributes?: -> bool
     end
 
     class StrategyMatcher
-      def match: (supplied_value: String, attr: RolloutStrategyAttribute ) -> bool
+      def match: (supplied_value: String, attr: RolloutStrategyAttribute) -> bool
     end
 
     class BooleanMatcher < StrategyMatcher
-      def match: (supplied_value: String, attr: RolloutStrategyAttribute ) -> bool
+      def match: (supplied_value: String, attr: RolloutStrategyAttribute) -> bool
     end
 
     class StringMatcher < StrategyMatcher
@@ -250,7 +305,6 @@ module FeatureHub
 
     class MatcherRegistry < MatcherRepository
     end
-end
+  end
 
 end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: featurehub-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Richard Vowles
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -90,13 +90,13 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - 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