semian 0.22.0 → 0.23.0.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27fa3d35b047fbe54483763821e246e2ce6f1403d8b3354d5759c4bdf1b43b2b
-  data.tar.gz: '06303901cc95e293dee76cd712283a4a7db1536771133e83563c969a6f3598e5'
+  metadata.gz: 141d6f1891d8a67b232ac835b120c03178439b3d39c9fe3695ac40176f4538d2
+  data.tar.gz: ff73c4b952045eeffa6a78e20c55e9c657a5c38c44a72707a9d20eee0645c8ba
 SHA512:
-  metadata.gz: 31e47dcea63ba9fc861272d9b8c2d591eb5f2d0783b1d8cde667812ba1cc4307ea52b533f8dc3542d011fb98c770ed011ff3a84c3e1ee7239635b01c0717b1ad
-  data.tar.gz: e32d7f17f6d73c95418fe6b80f1dce3423271423d61c8acd1fda356dab02aac41c24637d9a0939d39e5ade7cb015a2e47182361ea5c9187b1b39d93d59058510
+  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/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/grpc.rb

@@ -36,10 +36,11 @@ module Semian
     end
 
     class << self
-      attr_accessor :exceptions
       attr_reader :semian_configuration
 
+      # rubocop:disable ThreadSafety/ClassInstanceVariable
       def semian_configuration=(configuration)
+        # Only allow setting the configuration once in boot time
         raise Semian::GRPC::SemianConfigurationChangedError unless @semian_configuration.nil?
 
         @semian_configuration = configuration
@@ -48,6 +49,7 @@ module Semian
       def retrieve_semian_configuration(host)
         @semian_configuration.call(host) if @semian_configuration.respond_to?(:call)
       end
+      # rubocop:enable ThreadSafety/ClassInstanceVariable
     end
 
     def raw_semian_options

data/lib/semian/net_http.rb

@@ -55,10 +55,12 @@ module Semian
     end
 
     class << self
-      attr_accessor :exceptions
+      attr_accessor :exceptions # rubocop:disable ThreadSafety/ClassAndModuleAttributes
       attr_reader :semian_configuration
 
+      # rubocop:disable ThreadSafety/ClassInstanceVariable
       def semian_configuration=(configuration)
+        # Only allow setting the configuration once in boot time
         raise Semian::NetHTTP::SemianConfigurationChangedError unless @semian_configuration.nil?
 
         @semian_configuration = configuration
@@ -67,6 +69,7 @@ module Semian
       def retrieve_semian_configuration(host, port)
         @semian_configuration.call(host, port) if @semian_configuration.respond_to?(:call)
       end
+      # rubocop:enable ThreadSafety/ClassInstanceVariable
 
       def reset_exceptions
         self.exceptions = Semian::NetHTTP::DEFAULT_ERRORS.dup

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/redis_client.rb

@@ -94,7 +94,7 @@ module Semian
   end
 
   module RedisClient
-    EXCEPTIONS = [::RedisClient::ConnectionError, ::RedisClient::OutOfMemoryError]
+    EXCEPTIONS = [::RedisClient::ConnectionError, ::RedisClient::OutOfMemoryError].freeze
 
     include Semian::Adapter
     include RedisClientCommon

data/lib/semian/version.rb

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

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0.pre.rc2
 platform: ruby
 authors:
 - Scott Francis
 - Simon Eskildsen
 - Dale Hamel
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-05 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
@@ -64,7 +63,6 @@ metadata:
   documentation_uri: https://github.com/Shopify/semian
   homepage_uri: https://github.com/Shopify/semian
   source_code_uri: https://github.com/Shopify/semian
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,15 +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.5.22
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Bulkheading for Ruby with SysV semaphores
 test_files: []