semian 0.22.1 → 0.23.0.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdc3f7ce1f123bfc666e600050ee264cd4398e4e607f4f2dc1b91b008b7d6f3d
-  data.tar.gz: 5f8b87e92a43267aa10158cd27a7e3e931bb4a51a6ef301d8a9af9d0ddcbabd5
+  metadata.gz: 141d6f1891d8a67b232ac835b120c03178439b3d39c9fe3695ac40176f4538d2
+  data.tar.gz: ff73c4b952045eeffa6a78e20c55e9c657a5c38c44a72707a9d20eee0645c8ba
 SHA512:
-  metadata.gz: b2bc7b89dde896156164abbac527ccdc242d635ccfa78190afc48a30f07b8b2fb89c5660fffe6ea35d1accfe132fa23c50550f633777d6879d8d077f2554e985
-  data.tar.gz: 7c2fdf0a5c4db2c3d7b141279cb330c6cc612c55932fa54e628d9da919a2de8174c115eec67886fe40ce3cf6aac8feedca5870a0c767a84459e42d99b64fe8b7
+  metadata.gz: ed1af89aa82e0491264b9367f2dd9fb9bf661b08b454878e7b21cb86724dec98bfed01a53a766a159e0b0f349cb7fcc45a2af6f25720a90a3aae10d2ad3eefaa
+  data.tar.gz: 5097dcc59c75ae818cbcfdf2c99739e1534ca2239de84eeabaafab94d18e0a57a520f5e1266a584d9de679cb3de6ee8b3205f5bb19b9137f9afa6ac257141fa3

data/README.md

@@ -534,7 +534,7 @@ It is possible to disable Circuit Breaker with environment variable
 `SEMIAN_CIRCUIT_BREAKER_DISABLED=1`.
 
 For more information about configuring these parameters, please read
-[this post](https://engineering.shopify.com/blogs/engineering/circuit-breaker-misconfigured).
+[this post](https://shopify.engineering/circuit-breaker-misconfigured).
 
 ### Bulkheading
 
@@ -576,6 +576,33 @@ We call this limitation primitive "tickets". In this case, the resource access
 is limited to 5 tickets (see Configuration). The timeout value specifies the
 maximum amount of time to block if no ticket is available.
 
+```mermaid
+
+graph TD;
+    Start[Start]
+    CheckConnection{Request Connection to Resource}
+    AllocateTicket[Allocate Ticket if Available]
+    BlockTimeout[Block until Timeout or Ticket Available]
+    AccessResource[Access Resource]
+    ReleaseTicket[Release Ticket]
+    FailRequest[Fail Request]
+    OpenCircuit[Open Circuit Breaker]
+    
+    Start --> CheckConnection
+    CheckConnection -->|Ticket Available| AllocateTicket
+    AllocateTicket --> AccessResource
+    AccessResource --> ReleaseTicket
+    ReleaseTicket --> CheckConnection
+    
+    CheckConnection -->|No Ticket Available| BlockTimeout
+    BlockTimeout -->|Timeout| FailRequest
+    BlockTimeout -->|Ticket Available| AccessResource
+
+    FailRequest --> OpenCircuit
+    OpenCircuit --> CheckConnection
+
+```
+
 How do we limit the access to a resource for all workers on a server when the
 workers do not directly share memory? This is implemented with [SysV
 semaphores][sysv] to provide server-wide access control.
@@ -924,7 +951,7 @@ $ bundle install
 [nethttp-default-errors]: lib/semian/net_http.rb#L35-L45
 [semian-instrumentable]: lib/semian/instrumentable.rb
 [statsd-instrument]: http://github.com/shopify/statsd-instrument
-[resiliency-blog-post]: https://engineering.shopify.com/blogs/engineering/building-and-testing-resilient-ruby-on-rails-applications
+[resiliency-blog-post]: https://shopify.engineering/building-and-testing-resilient-ruby-on-rails-applications
 [toxiproxy]: https://github.com/Shopify/toxiproxy
 [sysv]: http://man7.org/linux/man-pages/man7/svipc.7.html
 [cbp]: https://en.wikipedia.org/wiki/Circuit_breaker_design_pattern

data/ext/semian/sysv_semaphores.c

@@ -1,12 +1,10 @@
 #include "sysv_semaphores.h"
 #include <time.h>
+#include <stdbool.h>
 
 static key_t
 generate_key(const char *name);
 
-static void *
-acquire_semaphore(void *p);
-
 static int
 wait_for_new_semaphore_set(key_t key, long permissions);
 
@@ -108,6 +106,9 @@ perform_semop(int sem_id, short index, short op, short flags, struct timespec *t
   buf.sem_flg = flags;
 
   int num_retries = 3;
+  if (flags & IPC_NOWAIT) {
+    num_retries = 0;
+  }
 
   do {
     result = semtimedop(sem_id, &buf, 1, ts);
@@ -151,17 +152,9 @@ get_semaphore(int key)
   return semget(key, SI_NUM_SEMAPHORES, 0);
 }
 
-void *
-acquire_semaphore_without_gvl(void *p)
-{
-  WITHOUT_GVL(acquire_semaphore, p, RUBY_UBF_IO, NULL);
-  return NULL;
-}
-
-static void *
-acquire_semaphore(void *p)
+static void
+acquire_semaphore_internal(semian_resource_t *res, short flags)
 {
-  semian_resource_t *res = (semian_resource_t *) p;
   res->error = 0;
   res->wait_time = -1;
 #ifdef DEBUG
@@ -170,7 +163,7 @@ acquire_semaphore(void *p)
 
   struct timespec begin, end;
   int benchmark_result = clock_gettime(CLOCK_MONOTONIC, &begin);
-  if (perform_semop(res->sem_id, SI_SEM_TICKETS, -1, SEM_UNDO, &res->timeout) == -1) {
+  if (perform_semop(res->sem_id, SI_SEM_TICKETS, -1, SEM_UNDO | flags, &res->timeout) == -1) {
     res->error = errno;
   }
   if (benchmark_result == 0) {
@@ -178,6 +171,31 @@ acquire_semaphore(void *p)
       res->wait_time = diff_timespec_ms(&end, &begin);
     }
   }
+}
+
+static void *
+acquire_semaphore(void *p)
+{
+  semian_resource_t *res = (semian_resource_t *) p;
+  acquire_semaphore_internal(res, 0);
+  return NULL;
+}
+
+// Eagerly attempt to acquire the semaphore
+static bool
+try_acquire_semaphore(void *p)
+{
+  semian_resource_t *res = (semian_resource_t *) p;
+  acquire_semaphore_internal(res, IPC_NOWAIT);
+  return !res->error;
+}
+
+void *
+acquire_semaphore_without_gvl(void *p)
+{
+  if (!try_acquire_semaphore(p)) {
+    WITHOUT_GVL(acquire_semaphore, p, RUBY_UBF_IO, NULL);
+  }
   return NULL;
 }
 

data/lib/semian/activerecord_trilogy_adapter.rb

@@ -29,7 +29,7 @@ module Semian
     ResourceBusyError = ::ActiveRecord::ConnectionAdapters::TrilogyAdapter::ResourceBusyError
     CircuitOpenError = ::ActiveRecord::ConnectionAdapters::TrilogyAdapter::CircuitOpenError
 
-    QUERY_ALLOWLIST = %r{\A(?:/\*.*?\*/)?\s*(ROLLBACK|COMMIT|RELEASE\s+SAVEPOINT)}i.freeze
+    QUERY_ALLOWLIST = %r{\A(?:/\*.*?\*/)?\s*(ROLLBACK|COMMIT|RELEASE\s+SAVEPOINT)}i
 
     # The common case here is NOT to have transaction management statements, therefore
     # we are exploiting the fact that Active Record will use COMMIT/ROLLBACK as

data/lib/semian/circuit_breaker.rb

@@ -18,7 +18,6 @@ module Semian
     def initialize(name, exceptions:, success_threshold:, error_threshold:,
       error_timeout:, implementation:, half_open_resource_timeout: nil,
       error_threshold_timeout: nil, error_threshold_timeout_enabled: true)
-
       @name = name.to_sym
       @success_count_threshold = success_threshold
       @error_count_threshold = error_threshold

data/lib/semian/mysql2.rb

@@ -39,7 +39,7 @@ module Semian
     DEFAULT_HOST = "localhost"
     DEFAULT_PORT = 3306
 
-    QUERY_ALLOWLIST = %r{\A(?:/\*.*?\*/)?\s*(ROLLBACK|COMMIT|RELEASE\s+SAVEPOINT)}i.freeze
+    QUERY_ALLOWLIST = %r{\A(?:/\*.*?\*/)?\s*(ROLLBACK|COMMIT|RELEASE\s+SAVEPOINT)}i
 
     class << self
       # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose

data/lib/semian/redis.rb

@@ -163,7 +163,7 @@ module Semian
     end
 
     def dns_resolve_failure?(e)
-      e.to_s.match?(/(can't resolve)|(name or service not known)|(nodename nor servname provided, or not known)|(failure in name resolution)/i) # rubocop:disable Layout/LineLength
+      e.to_s.match?(/(can't resolve)|(name or service not known)|(nodename nor servname provided, or not known)|(failure in name resolution)/i)
     end
   end
 end

data/lib/semian/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Semian
-  VERSION = "0.22.1"
+  VERSION = "0.23.0-rc2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.23.0.pre.rc2
 platform: ruby
 authors:
 - Scott Francis
@@ -9,7 +9,7 @@ authors:
 - Dale Hamel
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A Ruby C extention that is used to control access to shared resources
@@ -70,14 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Bulkheading for Ruby with SysV semaphores
 test_files: []