semian 0.22.0.RC.1 → 0.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd87705b68966cef884eeeb1d5df4d052eeb86f2ff7d43c9499435795341461
-  data.tar.gz: 911a0772662b81e21dcb475c9b981ceb0fbaeadf26edbbca70ab8adbf5be4068
+  metadata.gz: cdc3f7ce1f123bfc666e600050ee264cd4398e4e607f4f2dc1b91b008b7d6f3d
+  data.tar.gz: 5f8b87e92a43267aa10158cd27a7e3e931bb4a51a6ef301d8a9af9d0ddcbabd5
 SHA512:
-  metadata.gz: 8edb70d967cb15e12b919b3a7e6585f98848e2d569683d590d2d37e32eb57b65cd9f425931a3bf1575d91fc6c50e9d43901340cb33a34a671a585956b947514f
-  data.tar.gz: b880f4f52891cbc4fd3d97221053bddc741aa72a98b986826b8ca08454c73ccbe714cff311966387f40b83e2f48a6d2db4ddf23407ff275e55bfb8c1730b5673
+  metadata.gz: b2bc7b89dde896156164abbac527ccdc242d635ccfa78190afc48a30f07b8b2fb89c5660fffe6ea35d1accfe132fa23c50550f633777d6879d8d077f2554e985
+  data.tar.gz: 7c2fdf0a5c4db2c3d7b141279cb330c6cc612c55932fa54e628d9da919a2de8174c115eec67886fe40ce3cf6aac8feedca5870a0c767a84459e42d99b64fe8b7

data/README.md

@@ -270,23 +270,23 @@ SEMIAN_PARAMETERS = {
   dynamic: true,
 }
 
-class CurrentSemianSubResource < ActiveSupport::Attributes
- attribute :name
+class CurrentSemianSubResource < ActiveSupport::CurrentAttributes
+ attribute :sub_name
 end
 
 Semian::NetHTTP.semian_configuration = proc do |host, port|
   name = "#{host}_#{port}"
-  if (sub_resource_name = CurrentSemianSubResource.name)
-    name << "_#{name}"
+  if (sub_resource_name = CurrentSemianSubResource.sub_name)
+    name << "_#{sub_resource_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")) }
+# as long as `CurrentSemianSubResource.sub_name` is set accordingly:
+# CurrentSemianSubResource.set(sub_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")) }
+# CurrentSemianSubResource.set(sub_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

data/ext/semian/resource.c

@@ -5,9 +5,6 @@ ID id_wait_time;
 ID id_timeout;
 int system_max_semaphore_count;
 
-static VALUE
-cleanup_semian_resource_acquire(VALUE self);
-
 static void
 check_tickets_xor_quota_arg(VALUE tickets, VALUE quota);
 
@@ -33,15 +30,11 @@ static const rb_data_type_t
 semian_resource_type;
 
 VALUE
-semian_resource_acquire(int argc, VALUE *argv, VALUE self)
+semian_resource_acquire_semaphore(int argc, VALUE *argv, VALUE self)
 {
   semian_resource_t *self_res = NULL;
   semian_resource_t res = { 0 };
 
-  if (!rb_block_given_p()) {
-    rb_raise(rb_eArgError, "acquire requires a block");
-  }
-
   TypedData_Get_Struct(self, semian_resource_t, &semian_resource_type, self_res);
   res = *self_res;
 
@@ -75,7 +68,19 @@ semian_resource_acquire(int argc, VALUE *argv, VALUE self)
     wait_time = LONG2NUM(res.wait_time);
   }
 
-  return rb_ensure(rb_yield, wait_time, cleanup_semian_resource_acquire, self);
+  return wait_time;
+}
+
+VALUE
+semian_resource_acquire(int argc, VALUE *argv, VALUE self)
+{
+  if (!rb_block_given_p()) {
+    rb_raise(rb_eArgError, "acquire requires a block");
+  }
+
+  VALUE wait_time = semian_resource_acquire_semaphore(argc, argv, self);
+
+  return rb_ensure(rb_yield, wait_time, semian_resource_release_semaphore, self);
 }
 
 VALUE
@@ -253,8 +258,8 @@ semian_resource_in_use(VALUE self)
   return Qtrue;
 }
 
-static VALUE
-cleanup_semian_resource_acquire(VALUE self)
+VALUE
+semian_resource_release_semaphore(VALUE self)
 {
   semian_resource_t *res = NULL;
   TypedData_Get_Struct(self, semian_resource_t, &semian_resource_type, res);

data/ext/semian/resource.h

@@ -33,10 +33,39 @@ semian_resource_initialize(VALUE self, VALUE id, VALUE tickets, VALUE quota, VAL
  *
  * If no timeout argument is provided, the default timeout passed to Semian.register will be used.
  *
+ * The given block is executed with the semaphore held and, when the block
+ * exits, the semaphore is automatically released.
  */
 VALUE
 semian_resource_acquire(int argc, VALUE *argv, VALUE self);
 
+/*
+ * call-seq:
+ *    resource.acquire_semaphore(timeout: default_timeout) -> wait_time
+ *
+ * Acquires a resource. The call will block for <code>timeout</code> seconds if a ticket
+ * is not available. If no ticket is available within the timeout period, Semian::TimeoutError
+ * will be raised.
+ *
+ * If no timeout argument is provided, the default timeout passed to Semian.register will be used.
+ *
+ * Note: The caller is responsible for releasing the semaphore when done by calling release_semaphore.
+ */
+VALUE
+semian_resource_acquire_semaphore(int argc, VALUE *argv, VALUE self);
+
+/*
+ * call-seq:
+ *    resource.release_semaphore() -> nil
+ *
+ * Releases a resource previously acquired with acquire_semaphore.
+ *
+ * Note: The method is NOT idempotent. The caller must ensure that the method is called exactly
+ * as many times as acquire_semaphore.
+ */
+VALUE
+semian_resource_release_semaphore(VALUE self);
+
 /*
  * call-seq:
  *   resource.destroy() -> true

data/ext/semian/semian.c

@@ -60,6 +60,8 @@ void Init_semian()
   rb_define_alloc_func(cResource, semian_resource_alloc);
   rb_define_method(cResource, "initialize_semaphore", semian_resource_initialize, 5);
   rb_define_method(cResource, "acquire", semian_resource_acquire, -1);
+  rb_define_method(cResource, "acquire_semaphore", semian_resource_acquire_semaphore, -1);
+  rb_define_method(cResource, "release_semaphore", semian_resource_release_semaphore, 0);
   rb_define_method(cResource, "count", semian_resource_count, 0);
   rb_define_method(cResource, "semid", semian_resource_id, 0);
   rb_define_method(cResource, "key", semian_resource_key, 0);

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
+    QUERY_ALLOWLIST = %r{\A(?:/\*.*?\*/)?\s*(ROLLBACK|COMMIT|RELEASE\s+SAVEPOINT)}i.freeze
 
     # 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/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/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
+    QUERY_ALLOWLIST = %r{\A(?:/\*.*?\*/)?\s*(ROLLBACK|COMMIT|RELEASE\s+SAVEPOINT)}i.freeze
 
     class << self
       # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose

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

@@ -4,7 +4,7 @@ module Semian
   class ProtectedResource
     extend Forwardable
 
-    def_delegators :@bulkhead, :destroy, :count, :semid, :tickets, :registered_workers
+    def_delegators :@bulkhead, :count, :semid, :tickets, :registered_workers
     def_delegators :@circuit_breaker,
       :reset,
       :mark_failed,

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

@@ -9,6 +9,12 @@ module Semian
       def instance(name, **kwargs)
         Semian.resources[name] ||= ProtectedResource.new(name, new(name, **kwargs), nil)
       end
+
+      private
+
+      def redefinable(method_name)
+        alias_method(method_name, method_name) # Silence method redefinition warnings
+      end
     end
 
     def initialize(name, tickets: nil, quota: nil, permissions: Semian.default_permissions, timeout: 0)
@@ -26,41 +32,48 @@ module Semian
       @name = name
     end
 
-    def reset_registered_workers!
+    redefinable def reset_registered_workers!
     end
 
-    def destroy
+    redefinable def destroy
     end
 
-    def unregister_worker
+    redefinable def unregister_worker
     end
 
-    def acquire(*)
+    redefinable def acquire(*)
       wait_time = 0
       yield wait_time
     end
 
-    def count
+    redefinable def acquire_semaphore
+      0
+    end
+
+    redefinable def release_semaphore
+    end
+
+    redefinable def count
       0
     end
 
-    def tickets
+    redefinable def tickets
       0
     end
 
-    def registered_workers
+    redefinable def registered_workers
       0
     end
 
-    def semid
+    redefinable def semid
       0
     end
 
-    def key
+    redefinable def key
       "0x00000000"
     end
 
-    def in_use?
+    redefinable def in_use?
       false
     end
   end

data/lib/semian/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Semian
-  VERSION = "0.22.0.RC.1"
+  VERSION = "0.22.1"
 end

data/lib/semian.rb

@@ -275,6 +275,21 @@ module Semian
     @thread_safe = thread_safe
   end
 
+  THREAD_BULKHEAD_DISABLED_VAR = :semian_bulkheads_disabled
+  private_constant(:THREAD_BULKHEAD_DISABLED_VAR)
+
+  def bulkheads_disabled_in_thread?(thread)
+    thread.thread_variable_get(THREAD_BULKHEAD_DISABLED_VAR)
+  end
+
+  def disable_bulkheads_for_thread(thread)
+    old_value = thread.thread_variable_get(THREAD_BULKHEAD_DISABLED_VAR)
+    thread.thread_variable_set(THREAD_BULKHEAD_DISABLED_VAR, true)
+    yield
+  ensure
+    thread.thread_variable_set(THREAD_BULKHEAD_DISABLED_VAR, old_value)
+  end
+
   private
 
   def create_circuit_breaker(name, **options)
@@ -318,7 +333,7 @@ module Semian
   end
 
   def create_bulkhead(name, **options)
-    return if ENV.key?("SEMIAN_BULKHEAD_DISABLED")
+    return if ENV.key?("SEMIAN_BULKHEAD_DISABLED") || bulkheads_disabled_in_thread?(Thread.current)
     return unless options.fetch(:bulkhead, true)
 
     permissions = options[:permissions] || default_permissions

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.22.0.RC.1
+  version: 0.22.1
 platform: ruby
 authors:
 - Scott Francis
 - Simon Eskildsen
 - Dale Hamel
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2025-02-10 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
@@ -79,8 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Bulkheading for Ruby with SysV semaphores
 test_files: []