semian 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c0cecc8c8e42f223f2cde75e3818ad4bc33897107b6a99186beb48c413c6d30
-  data.tar.gz: 9202b9e1cf15ff54d68f8d3fe11800ace1624828d1aa840840b88180f65e5355
+  metadata.gz: 47d9f8254a2231b2ca3210ff09331ace5bd23f86bfe0f178a95e64187d3f1203
+  data.tar.gz: 644bcb5a30040499af851b17a9cb46c7a2a4fe0a3896cfd7052bc39e115fb4bc
 SHA512:
-  metadata.gz: 1bd71610d96984ada73fe625966f66ecc13cc921ac659a78c9010eec952f61e1ea56aa4c9f3e6de0572a2b2059e0cd919e1063907c4d39c9d630dd536bf4a89e
-  data.tar.gz: 20513585134a89dc3a33bcc2895728a64fa5e35e978dbcf83ac44fccc00ae9428e0f8bd8988fe3941e4236d4d18daed380014843b0ad071f945164e68eda68af
+  metadata.gz: b3d5769728bd70009178ad78d1b397b5a067e2482578e0916ae76963870cc9808499a49cd5a22f6a3ffa254cbb203f5dec37584352815cb9ba32a8a281432468
+  data.tar.gz: 7ea88141334bed5ecf490f25bd3b8d98759de50f38824af6f0af70619f0688eeacea05c80181a079fb3563d887fc1d1dbc6840893eb4a8c78e729a1c4b498b94

data/README.md

@@ -254,10 +254,40 @@ The `semian_options` passed apply to that resource. Semian creates the `semian_i
 from the `name` to look up and store changes in the circuit breaker and bulkhead states
 and associate successes, failures, errors with the protected resource.
 
-We only require that:
-* the `semian_configuration` be **set only once** over the lifetime of the library
-* the output of the `proc` be the same over time, that is, the configuration produced by
-  each pair of `host`, `port` is **the same each time** the callback is invoked.
+We only require that the `semian_configuration` be **set only once** over the lifetime of
+the library.
+
+If you need to return different values for the same pair of `host`/`port` value, you **must**
+include the `dynamic: true` option. Returning different values for the same `host`/`port` values
+without setting the `dynamic` option can lead to undesirable behavior.
+
+A common example for dynamic options is the use of a thread local variable, such as
+`ActiveSupport::CurrentAttributes`, for requests to a service acting as a proxy.
+
+```ruby
+SEMIAN_PARAMETERS = {
+  # ...
+  dynamic: true,
+}
+
+class CurrentSemianSubResource < ActiveSupport::Attributes
+ attribute :name
+end
+
+Semian::NetHTTP.semian_configuration = proc do |host, port|
+  name = "#{host}_#{port}"
+  if (sub_resource_name = CurrentSemianSubResource.name)
+    name << "_#{name}"
+  end
+  SEMIAN_PARAMETERS.merge(name: name)
+end
+
+# Two requests to example.com can use two different semian resources,
+# as long as `CurrentSemianSubResource.name` is set accordingly:
+# CurrentSemianSubResource.set(name: "sub_resource_1") { Net::HTTP.get_response(URI("http://example.com")) }
+# and:
+# CurrentSemianSubResource.set(name: "sub_resource_2") { Net::HTTP.get_response(URI("http://example.com")) }
+```
 
 For most purposes, `"#{host}_#{port}"` is a good default `name`. Custom `name` formats
 can be useful to grouping related subdomains as one resource, so that they all

data/lib/semian/adapter.rb

@@ -9,19 +9,25 @@ module Semian
     end
 
     def semian_resource
-      @semian_resource ||= case semian_options
+      return @semian_resource if @semian_resource
+
+      case semian_options
       when false
-        UnprotectedResource.new(semian_identifier)
+        @semian_resource = UnprotectedResource.new(semian_identifier)
       when nil
         Semian.logger.info("Semian is not configured for #{self.class.name}: #{semian_identifier}")
-        UnprotectedResource.new(semian_identifier)
+        @semian_resource = UnprotectedResource.new(semian_identifier)
       else
         options = semian_options.dup
         options.delete(:name)
         options[:consumer] = self
         options[:exceptions] ||= []
         options[:exceptions] += resource_exceptions
-        ::Semian.retrieve_or_register(semian_identifier, **options)
+        resource = ::Semian.retrieve_or_register(semian_identifier, **options)
+
+        @semian_resource = resource unless options.fetch(:dynamic, false)
+
+        resource
       end
     end
 
@@ -53,7 +59,11 @@ module Semian
       return @semian_options if defined? @semian_options
 
       options = raw_semian_options
-      @semian_options = options && options.map { |k, v| [k.to_sym, v] }.to_h
+
+      symbolized_options = options && options.transform_keys(&:to_sym) # rubocop:disable Style/SafeNavigation
+      symbolized_options.tap do
+        @semian_options = symbolized_options if !symbolized_options || !symbolized_options.fetch(:dynamic, false)
+      end
     end
 
     def raw_semian_options

data/lib/semian/net_http.rb

@@ -91,16 +91,20 @@ module Semian
     end
 
     def connect
-      return super if disabled?
+      with_cleared_dynamic_options do
+        return super if disabled?
 
-      acquire_semian_resource(adapter: :http, scope: :connection) { super }
+        acquire_semian_resource(adapter: :http, scope: :connection) { super }
+      end
     end
 
     def transport_request(*)
-      return super if disabled?
+      with_cleared_dynamic_options do
+        return super if disabled?
 
-      acquire_semian_resource(adapter: :http, scope: :query) do
-        handle_error_responses(super)
+        acquire_semian_resource(adapter: :http, scope: :query) do
+          handle_error_responses(super)
+        end
       end
     end
 
@@ -125,6 +129,24 @@ module Semian
       end
       result
     end
+
+    def with_cleared_dynamic_options
+      unless @resource_acquisition_in_progress
+        @resource_acquisition_in_progress = true
+        resource_acquisition_started = true
+      end
+
+      yield
+    ensure
+      if resource_acquisition_started
+        if @raw_semian_options&.fetch(:dynamic, false)
+          # Clear @raw_semian_options if the resource was flagged as dynamic.
+          @raw_semian_options = nil
+        end
+
+        @resource_acquisition_in_progress = false
+      end
+    end
   end
 end
 

data/lib/semian/redis/v5.rb

@@ -6,6 +6,14 @@ class Redis
   BaseConnectionError.include(::Semian::AdapterError)
   OutOfMemoryError.include(::Semian::AdapterError)
 
+  class ReadOnlyError < Redis::BaseConnectionError
+    # A ReadOnlyError is a fast failure and we don't want to track these errors so that we can reconnect
+    # to the new primary ASAP
+    def marks_semian_circuits?
+      false
+    end
+  end
+
   class SemianError < BaseConnectionError
     def initialize(semian_identifier, *args)
       super(*args)

data/lib/semian/redis.rb

@@ -32,6 +32,14 @@ class Redis
     end
   end
 
+  class ReadOnlyError < Redis::CommandError
+    # A ReadOnlyError is a fast failure and we don't want to track these errors so that we can reconnect
+    # to the new primary ASAP
+    def marks_semian_circuits?
+      false
+    end
+  end
+
   ResourceBusyError = Class.new(SemianError)
   CircuitOpenError = Class.new(SemianError)
   ResolveError = Class.new(SemianError)

data/lib/semian/redis_client.rb

@@ -14,6 +14,14 @@ class RedisClient
 
   OutOfMemoryError.include(::Semian::AdapterError)
 
+  class ReadOnlyError < RedisClient::ConnectionError
+    # A ReadOnlyError is a fast failure and we don't want to track these errors so that we can reconnect
+    # to the new primary ASAP
+    def marks_semian_circuits?
+      false
+    end
+  end
+
   class SemianError < ConnectionError
     def initialize(semian_identifier, *args)
       super(*args)

data/lib/semian/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Semian
-  VERSION = "0.18.1"
+  VERSION = "0.19.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Scott Francis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A Ruby C extention that is used to control access to shared resources