semian 0.28.3 → 0.28.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65071f9b9f241c4306a81f24e696220928dd7fd42fe50f9664f51212af37be27
-  data.tar.gz: aea78d645e703f42516e8a507887184a85ef98d547312646f609d6d145c9c2ee
+  metadata.gz: 8fa1376f607286da6a30b6db227b4b27281228308c9c68724b356189cc97d2fb
+  data.tar.gz: 05161e0480da351f89ee3c3fe40cc9d4527a20e64f7830fdf671f92057675bb5
 SHA512:
-  metadata.gz: f628d7359a24fe78fc5ae8885f81e181d1e1a6da1b2956079fdc19e48df63d78f76de29d0cf681ea8c9e6bfc8952b23ab69e86d7313a49628c52ed6b482b49b2
-  data.tar.gz: f166272364381bdc17db8bfc6bf4b62827ae0ac7c99803b1ab6617acc80244d0163dd2a54b7f704501fd4790135fa2f7fbc90b181a8f656d05ecbff83e9bc7c6
+  metadata.gz: 22d2074bf889aae268ea568f4a95f43b8e27f7b02ff24f4bf4afdcddba98bdf01e9090b166bc1b0124667bce39f57f19b5933415a309779e86fe448d5b2f7a36
+  data.tar.gz: 0b7a495a4e7a0bf71fa87b7422c6076c0580b3e368c23d1418d1e8c92745d2ba5acf951a049ade3e2b780a30273ad08fcb30747df2de36d5535e5a002866a952

data/README.md

@@ -83,7 +83,8 @@ To create a Semian adapter you must implement the following methods:
 1. [`include Semian::Adapter`][semian-adapter]. Use the helpers to wrap the
    resource. This takes care of situations such as monitoring, nested resources,
    unsupported platforms, creating the Semian resource if it doesn't already
-   exist and so on.
+   exist and so on. Include it in an object that represents a single resource,
+   typically one connection — see [Thread Safety](#thread-safety).
 2. `#semian_identifier`. This is responsible for returning a symbol that
    represents every unique resource, for example `redis_master` or
    `mysql_shard_1`. This is usually assembled from a `name` attribute on the
@@ -214,6 +215,27 @@ Semian's circuit breaker implementation is thread-safe by default as of
 `v0.7.0`. If you'd like to disable it for performance reasons, pass
 `thread_safety_disabled: true` to the resource options.
 
+An adapter instance represents one resource. Once that resource has been
+acquired, Semian treats further access through the same instance as part of the
+same session: nested or overlapping calls do not re-enter the circuit breaker
+and do not take a second bulkhead ticket, so a circuit that opens elsewhere in
+the process cannot interrupt a session that is already in flight and
+succeeding. Every adapter that ships with Semian has this shape — the mixin is
+included in a connection object, and the session is that connection's unit of
+work.
+
+This is likely to give unexpected results if the adapter instance is shared
+process-wide, such as by a singleton. While any call is in flight, calls made
+through the same instance from other threads are treated as part of that
+session, so they are not fast-failed when the circuit has opened since that
+first acquire, and they cannot contribute failures. Where calls overlap
+continuously, that keeps the circuit closed while the resource is failing.
+Consider introducing a "session" object as the adapterized wrapper around the
+singleton instead, created per unit of work — per request, say. Circuit breaker
+and bulkhead state is keyed by `semian_identifier` and held in a process-wide
+registry, so short-lived adapter instances that share an identifier all share
+one circuit.
+
 Bulkheads should be disabled (pass `bulkhead: false`) in a threaded environment
 (e.g. Puma or Sidekiq), but can safely be enabled in non-threaded environments
 (e.g. Resque and Unicorn). As described in this document, circuit breakers alone

data/lib/semian/adapter.rb

@@ -79,11 +79,10 @@ module Semian
     end
 
     def mark_resource_as_acquired
-      previous = @resource_acquired
       @resource_acquired = true
       yield
     ensure
-      @resource_acquired = previous
+      @resource_acquired = false
     end
   end
 end

data/lib/semian/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.28.3
+  version: 0.28.4
 platform: ruby
 authors:
 - Scott Francis