semian 0.11.9 → 0.13.1

data/ext/semian/extconf.rb

@@ -1,33 +1,35 @@
-$LOAD_PATH.unshift File.expand_path("../../../lib", __FILE__)
+# frozen_string_literal: true
 
-require 'semian/platform'
+$LOAD_PATH.unshift(File.expand_path("../../../lib", __FILE__))
+
+require "semian/platform"
 
 unless Semian.sysv_semaphores_supported?
-  File.write "Makefile", <<MAKEFILE
-all:
-clean:
-install:
-MAKEFILE
+  File.write("Makefile", <<~MAKEFILE)
+    all:
+    clean:
+    install:
+  MAKEFILE
   exit
 end
 
-require 'mkmf'
+require "mkmf"
 
-abort 'openssl is missing. please install openssl.' unless find_header('openssl/sha.h')
-abort 'openssl is missing. please install openssl.' unless find_library('crypto', 'SHA1')
+abort "openssl is missing. please install openssl." unless find_header("openssl/sha.h")
+abort "openssl is missing. please install openssl." unless find_library("crypto", "SHA1")
 
-have_header 'sys/ipc.h'
-have_header 'sys/sem.h'
-have_header 'sys/types.h'
+have_header "sys/ipc.h"
+have_header "sys/sem.h"
+have_header "sys/types.h"
 
-have_func 'rb_thread_blocking_region'
-have_func 'rb_thread_call_without_gvl'
+have_func "rb_thread_blocking_region"
+have_func "rb_thread_call_without_gvl"
 
 $CFLAGS = "-D_GNU_SOURCE -Werror -Wall "
-if ENV.key?('DEBUG')
-  $CFLAGS << "-O0 -g -DDEBUG"
+$CFLAGS += if ENV.key?("DEBUG")
+  "-O0 -g -DDEBUG"
 else
-  $CFLAGS << "-O3"
+  "-O3"
 end
 
-create_makefile('semian/semian')
+create_makefile("semian/semian")

data/lib/semian/adapter.rb

@@ -1,9 +1,11 @@
-require 'semian'
+# frozen_string_literal: true
+
+require "semian"
 
 module Semian
   module Adapter
     def semian_identifier
-      raise NotImplementedError.new("Semian adapters must implement a `semian_identifier` method")
+      raise NotImplementedError, "Semian adapters must implement a `semian_identifier` method"
     end
 
     def semian_resource
@@ -31,6 +33,7 @@ module Semian
 
     def acquire_semian_resource(scope:, adapter:, &block)
       return yield if resource_already_acquired?
+
       semian_resource.acquire(scope: scope, adapter: adapter, resource: self) do
         mark_resource_as_acquired(&block)
       end
@@ -48,16 +51,17 @@ module Semian
 
     def semian_options
       return @semian_options if defined? @semian_options
+
       options = raw_semian_options
       @semian_options = options && options.map { |k, v| [k.to_sym, v] }.to_h
     end
 
     def raw_semian_options
-      raise NotImplementedError.new("Semian adapters must implement a `raw_semian_options` method")
+      raise NotImplementedError, "Semian adapters must implement a `raw_semian_options` method"
     end
 
     def resource_exceptions
-      []
+      raise NotImplementedError, "Semian adapters must implement a `resource_exceptions` method"
     end
 
     def resource_already_acquired?

data/lib/semian/circuit_breaker.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Semian
-  class CircuitBreaker #:nodoc:
+  class CircuitBreaker # :nodoc:
     extend Forwardable
 
     def_delegators :@state, :closed?, :open?, :half_open?
@@ -7,7 +9,9 @@ module Semian
     attr_reader :name, :half_open_resource_timeout, :error_timeout, :state, :last_error
 
     def initialize(name, exceptions:, success_threshold:, error_threshold:,
-                         error_timeout:, implementation:, half_open_resource_timeout: nil, error_threshold_timeout: nil)
+      error_timeout:, implementation:, half_open_resource_timeout: nil,
+      error_threshold_timeout: nil)
+
       @name = name.to_sym
       @success_count_threshold = success_threshold
       @error_count_threshold = error_threshold
@@ -25,6 +29,7 @@ module Semian
 
     def acquire(resource = nil, &block)
       return yield if disabled?
+
       transition_to_half_open if transition_to_half_open?
 
       raise OpenCircuitError unless request_allowed?
@@ -63,6 +68,7 @@ module Semian
 
     def mark_success
       return unless half_open?
+
       @successes.increment
       transition_to_close if success_threshold_reached?
     end
@@ -80,8 +86,7 @@ module Semian
     end
 
     def in_use?
-      return false if error_timeout_expired?
-      @errors.size > 0
+      !error_timeout_expired? && !@errors.empty?
     end
 
     private
@@ -117,6 +122,7 @@ module Semian
     def error_timeout_expired?
       last_error_time = @errors.last
       return false unless last_error_time
+
       Time.at(last_error_time) + @error_timeout < Time.now
     end
 
@@ -133,12 +139,12 @@ module Semian
       return if @state.nil? || new_state == @state.value
 
       str = "[#{self.class.name}] State transition from #{@state.value} to #{new_state}."
-      str << " success_count=#{@successes.value} error_count=#{@errors.size}"
-      str << " success_count_threshold=#{@success_count_threshold} error_count_threshold=#{@error_count_threshold}"
-      str << " error_timeout=#{@error_timeout} error_last_at=\"#{@errors.last}\""
-      str << " name=\"#{@name}\""
+      str += " success_count=#{@successes.value} error_count=#{@errors.size}"
+      str += " success_count_threshold=#{@success_count_threshold} error_count_threshold=#{@error_count_threshold}"
+      str += " error_timeout=#{@error_timeout} error_last_at=\"#{@errors.last}\""
+      str += " name=\"#{@name}\""
       if new_state == :open && @last_error
-        str << " last_error_message=#{@last_error.message.inspect}"
+        str += " last_error_message=#{@last_error.message.inspect}"
       end
 
       Semian.logger.info(str)
@@ -149,7 +155,7 @@ module Semian
     end
 
     def disabled?
-      ENV['SEMIAN_CIRCUIT_BREAKER_DISABLED'] || ENV['SEMIAN_DISABLED']
+      ENV["SEMIAN_CIRCUIT_BREAKER_DISABLED"] || ENV["SEMIAN_DISABLED"]
     end
 
     def maybe_with_half_open_resource_timeout(resource, &block)

data/lib/semian/grpc.rb

@@ -1,5 +1,7 @@
-require 'semian/adapter'
-require 'grpc'
+# frozen_string_literal: true
+
+require "semian/adapter"
+require "grpc"
 
 module GRPC
   GRPC::Unavailable.include(::Semian::AdapterError)
@@ -22,7 +24,6 @@ end
 
 module Semian
   module GRPC
-    attr_reader :raw_semian_options
     include Semian::Adapter
 
     ResourceBusyError = ::GRPC::ResourceBusyError
@@ -40,6 +41,7 @@ module Semian
 
       def semian_configuration=(configuration)
         raise Semian::GRPC::SemianConfigurationChangedError unless @semian_configuration.nil?
+
         @semian_configuration = configuration
       end
 
@@ -52,10 +54,10 @@ module Semian
       @raw_semian_options ||= begin
         # If the host is empty, it's possible that the adapter was initialized
         # with the channel. Therefore, we look into the channel to find the host
-        if @host.empty?
-          host = @ch.target
+        host = if @host.empty?
+          @ch.target
         else
-          host = @host
+          @host
         end
         @raw_semian_options = Semian::GRPC.retrieve_semian_configuration(host)
         @raw_semian_options = @raw_semian_options.dup unless @raw_semian_options.nil?
@@ -81,22 +83,42 @@ module Semian
 
     def request_response(*, **)
       return super if disabled?
-      acquire_semian_resource(adapter: :grpc, scope: :request_response) { super }
+
+      acquire_semian_resource_grpc(scope: :request_response) { super }
     end
 
     def client_streamer(*, **)
       return super if disabled?
-      acquire_semian_resource(adapter: :grpc, scope: :client_streamer) { super }
+
+      acquire_semian_resource_grpc(scope: :client_streamer) { super }
     end
 
     def server_streamer(*, **)
       return super if disabled?
-      acquire_semian_resource(adapter: :grpc, scope: :server_streamer) { super }
+
+      acquire_semian_resource_grpc(scope: :server_streamer) { super }
     end
 
     def bidi_streamer(*, **)
       return super if disabled?
-      acquire_semian_resource(adapter: :grpc, scope: :bidi_streamer) { super }
+
+      acquire_semian_resource_grpc(scope: :bidi_streamer) { super }
+    end
+
+    def acquire_semian_resource_grpc(scope:)
+      acquire_semian_resource(adapter: :grpc, scope: scope) do
+        result = yield
+        handle_operation(result, scope) if result.is_a?(::GRPC::ActiveCall::Operation)
+        result
+      end
+    end
+
+    def handle_operation(operation, scope)
+      execute = operation.singleton_method(:execute)
+      operation.instance_variable_set(:@semian, self)
+      operation.define_singleton_method(:execute) do
+        @semian.send(:acquire_semian_resource, **{ adapter: :grpc, scope: scope }) { execute.call }
+      end
     end
   end
 end

data/lib/semian/instrumentable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Semian
   module Instrumentable
     def subscribe(name = rand, &block)

data/lib/semian/lru_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class LRUHash
   # This LRU (Least Recently Used) hash will allow
   # the cleaning of resources as time goes on.
@@ -120,10 +122,10 @@ class LRUHash
 
   def clear_unused_resources
     payload = {
-        size: @table.size,
-        examined: 0,
-        cleared: 0,
-        elapsed: nil,
+      size: @table.size,
+      examined: 0,
+      cleared: 0,
+      elapsed: nil,
     }
     timer_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
@@ -155,20 +157,19 @@ class LRUHash
     end
   end
 
-  EXCEPTION_NEVER = {Exception => :never}.freeze
-  EXCEPTION_IMMEDIATE = {Exception => :immediate}.freeze
+  EXCEPTION_NEVER = { Exception => :never }.freeze
+  EXCEPTION_IMMEDIATE = { Exception => :immediate }.freeze
   private_constant :EXCEPTION_NEVER
   private_constant :EXCEPTION_IMMEDIATE
 
-  def try_synchronize
+  def try_synchronize(&block)
     Thread.handle_interrupt(EXCEPTION_NEVER) do
-      begin
-        return false unless @lock.try_lock
-        Thread.handle_interrupt(EXCEPTION_IMMEDIATE) { yield }
-        true
-      ensure
-        @lock.unlock if @lock.owned?
-      end
+      return false unless @lock.try_lock
+
+      Thread.handle_interrupt(EXCEPTION_IMMEDIATE, &block)
+      true
+    ensure
+      @lock.unlock if @lock.owned?
     end
   end
 end

data/lib/semian/mysql2.rb

@@ -1,5 +1,7 @@
-require 'semian/adapter'
-require 'mysql2'
+# frozen_string_literal: true
+
+require "semian/adapter"
+require "mysql2"
 
 module Mysql2
   Mysql2::Error.include(::Semian::AdapterError)
@@ -32,13 +34,13 @@ module Semian
     CircuitOpenError = ::Mysql2::CircuitOpenError
     PingFailure = Class.new(::Mysql2::Error)
 
-    DEFAULT_HOST = 'localhost'
+    DEFAULT_HOST = "localhost"
     DEFAULT_PORT = 3306
 
     QUERY_WHITELIST = Regexp.union(
-      /\A(?:\/\*.*?\*\/)?\s*ROLLBACK/i,
-      /\A(?:\/\*.*?\*\/)?\s*COMMIT/i,
-      /\A(?:\/\*.*?\*\/)?\s*RELEASE\s+SAVEPOINT/i,
+      %r{\A(?:/\*.*?\*/)?\s*ROLLBACK}i,
+      %r{\A(?:/\*.*?\*/)?\s*COMMIT}i,
+      %r{\A(?:/\*.*?\*/)?\s*RELEASE\s+SAVEPOINT}i,
     )
 
     # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose
@@ -55,7 +57,8 @@ module Semian
 
     def semian_identifier
       @semian_identifier ||= begin
-        unless name = semian_options && semian_options[:name]
+        name = semian_options && semian_options[:name]
+        unless name
           host = query_options[:host] || DEFAULT_HOST
           port = query_options[:port] || DEFAULT_PORT
           name = "#{host}:#{port}"
@@ -68,7 +71,7 @@ module Semian
       result = nil
       acquire_semian_resource(adapter: :mysql, scope: :ping) do
         result = raw_ping
-        raise PingFailure.new(result.to_s) unless result
+        raise PingFailure, result.to_s unless result
       end
       result
     rescue ResourceBusyError, CircuitOpenError, PingFailure
@@ -101,6 +104,11 @@ module Semian
 
     private
 
+    EXCEPTIONS = [].freeze
+    def resource_exceptions
+      EXCEPTIONS
+    end
+
     def query_whitelisted?(sql, *)
       QUERY_WHITELIST =~ sql
     rescue ArgumentError
@@ -108,6 +116,7 @@ module Semian
       # data that is not recognized as a valid encoding, in which case we just
       # return false.
       return false unless sql.valid_encoding?
+
       raise
     end
 
@@ -127,7 +136,7 @@ module Semian
 
     def raw_semian_options
       return query_options[:semian] if query_options.key?(:semian)
-      return query_options['semian'.freeze] if query_options.key?('semian'.freeze)
+      return query_options["semian"] if query_options.key?("semian")
     end
   end
 end

data/lib/semian/net_http.rb

@@ -1,5 +1,7 @@
-require 'semian/adapter'
-require 'net/http'
+# frozen_string_literal: true
+
+require "semian/adapter"
+require "net/http"
 
 module Net
   ProtocolError.include(::Semian::AdapterError)
@@ -40,10 +42,11 @@ module Semian
       ::Net::ProtocolError,
       ::EOFError,
       ::IOError,
-      ::SystemCallError, # includes ::Errno::EINVAL, ::Errno::ECONNRESET, ::Errno::ECONNREFUSED, ::Errno::ETIMEDOUT, and more
+      ::SystemCallError, # includes ::Errno::EINVAL, ::Errno::ECONNRESET,
+      # ::Errno::ECONNREFUSED, ::Errno::ETIMEDOUT, and more
     ].freeze # Net::HTTP can throw many different errors, this tries to capture most of them
 
-    module ClassMethods 
+    module ClassMethods
       def new(*args, semian: true)
         http = super(*args)
         http.instance_variable_set(:@semian_enabled, semian)
@@ -57,6 +60,7 @@ module Semian
 
       def semian_configuration=(configuration)
         raise Semian::NetHTTP::SemianConfigurationChangedError unless @semian_configuration.nil?
+
         @semian_configuration = configuration
       end
 
@@ -88,11 +92,13 @@ module Semian
 
     def connect
       return super if disabled?
+
       acquire_semian_resource(adapter: :http, scope: :connection) { super }
     end
 
     def transport_request(*)
       return super if disabled?
+
       acquire_semian_resource(adapter: :http, scope: :query) do
         handle_error_responses(super)
       end

data/lib/semian/platform.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Semian
   extend self
 
@@ -11,6 +13,6 @@ module Semian
   end
 
   def disabled?
-    ENV['SEMIAN_SEMAPHORES_DISABLED'] || ENV['SEMIAN_DISABLED']
+    ENV["SEMIAN_SEMAPHORES_DISABLED"] || ENV["SEMIAN_DISABLED"]
   end
 end

data/lib/semian/protected_resource.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Semian
   class ProtectedResource
     extend Forwardable
 
     def_delegators :@bulkhead, :destroy, :count, :semid, :tickets, :registered_workers
     def_delegators :@circuit_breaker, :reset, :mark_failed, :mark_success, :request_allowed?,
-                   :open?, :closed?, :half_open?
+      :open?, :closed?, :half_open?
 
     attr_reader :bulkhead, :circuit_breaker, :name
     attr_accessor :updated_at
@@ -17,8 +19,8 @@ module Semian
     end
 
     def destroy
-      @bulkhead.destroy unless @bulkhead.nil?
-      @circuit_breaker.destroy unless @circuit_breaker.nil?
+      @bulkhead&.destroy
+      @circuit_breaker&.destroy
     end
 
     def acquire(timeout: nil, scope: nil, adapter: nil, resource: nil)

data/lib/semian/rails.rb

@@ -1,9 +1,15 @@
-require 'active_record/connection_adapters/abstract_adapter'
+# frozen_string_literal: true
 
-class ActiveRecord::ConnectionAdapters::AbstractAdapter
-  def semian_resource
-    # support for https://github.com/rails/rails/commit/d86fd6415c0dfce6fadb77e74696cf728e5eb76b
-    connection = instance_variable_defined?(:@raw_connection) ? @raw_connection : @connection
-    connection.semian_resource
+require "active_record/connection_adapters/abstract_adapter"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractAdapter
+      def semian_resource
+        # support for https://github.com/rails/rails/commit/d86fd6415c0dfce6fadb77e74696cf728e5eb76b
+        connection = instance_variable_defined?(:@raw_connection) ? @raw_connection : @connection
+        connection.semian_resource
+      end
+    end
   end
 end

data/lib/semian/redis.rb

@@ -1,5 +1,7 @@
-require 'semian/adapter'
-require 'redis'
+# frozen_string_literal: true
+
+require "semian/adapter"
+require "redis"
 
 class Redis
   Redis::BaseConnectionError.include(::Semian::AdapterError)
@@ -17,7 +19,7 @@ class Redis
   end
 
   class ConnectionError < Redis::BaseConnectionError
-    # A Connection Reset is a fast failure and we don't want to track these errors in 
+    # A Connection Reset is a fast failure and we don't want to track these errors in
     # semian
     def marks_semian_circuits?
       message != "Connection lost (ECONNRESET)"
@@ -90,12 +92,11 @@ module Semian
 
     def connect
       acquire_semian_resource(adapter: :redis, scope: :connection) do
-        begin
-          raw_connect
-        rescue SocketError, RuntimeError => e
-          raise ResolveError.new(semian_identifier) if dns_resolve_failure?(e.cause || e)
-          raise
-        end
+        raw_connect
+      rescue SocketError, RuntimeError => e
+        raise ResolveError, semian_identifier if dns_resolve_failure?(e.cause || e)
+
+        raise
       end
     end
 
@@ -107,7 +108,7 @@ module Semian
 
       begin
         connection.timeout = temp_timeout if connected?
-        options[:timeout] = Float(temp_timeout),
+        options[:timeout] = Float(temp_timeout)
         options[:connect_timeout] = Float(temp_timeout)
         options[:read_timeout] = Float(temp_timeout)
         options[:write_timeout] = Float(temp_timeout)
@@ -133,17 +134,18 @@ module Semian
 
     def raw_semian_options
       return options[:semian] if options.key?(:semian)
-      return options['semian'.freeze] if options.key?('semian'.freeze)
+      return options["semian"] if options.key?("semian")
     end
 
     def raise_if_out_of_memory(reply)
       return unless reply.is_a?(::Redis::CommandError)
-      return unless reply.message =~ /OOM command not allowed when used memory > 'maxmemory'\.\s*\z/
-      raise ::Redis::OutOfMemoryError.new(reply.message)
+      return unless reply.message =~ /OOM command not allowed when used memory > 'maxmemory'/
+
+      raise ::Redis::OutOfMemoryError, reply.message
     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)
+      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
     end
   end
 end

data/lib/semian/redis_client.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "semian/adapter"
+require "redis-client"
+
+class RedisClient
+  ConnectionError.include(::Semian::AdapterError)
+
+  class SemianError < ConnectionError
+    def initialize(semian_identifier, *args)
+      super(*args)
+      @semian_identifier = semian_identifier
+    end
+  end
+
+  ResourceBusyError = Class.new(SemianError)
+  CircuitOpenError = Class.new(SemianError)
+
+  module SemianConfig
+    attr_reader :raw_semian_options
+
+    def initialize(semian: nil, **kwargs)
+      super(**kwargs)
+
+      @raw_semian_options = semian
+    end
+
+    def semian_identifier
+      @semian_identifier ||= begin
+        name = (semian_options && semian_options[:name]) || "#{host}:#{port}/#{db}"
+        :"redis_#{name}"
+      end
+    end
+
+    define_method(:semian_options, Semian::Adapter.instance_method(:semian_options))
+  end
+
+  Config.include(SemianConfig)
+  SentinelConfig.include(SemianConfig)
+end
+
+module Semian
+  module RedisClientCommon
+    def with_resource_timeout(temp_timeout)
+      connect_timeout = self.connect_timeout
+      read_timeout = self.read_timeout
+      write_timeout = self.write_timeout
+
+      begin
+        self.timeout = temp_timeout
+        yield
+      ensure
+        self.connect_timeout = connect_timeout
+        self.read_timeout = read_timeout
+        self.write_timeout = write_timeout
+      end
+    end
+
+    def semian_identifier
+      config.semian_identifier
+    end
+
+    private
+
+    def semian_options
+      config.semian_options
+    end
+
+    def raw_semian_options
+      config.raw_semian_options
+    end
+  end
+
+  module RedisClient
+    EXCEPTIONS = [::RedisClient::ConnectionError]
+
+    include Semian::Adapter
+    include RedisClientCommon
+
+    private
+
+    def resource_exceptions
+      EXCEPTIONS
+    end
+
+    def ensure_connected(retryable: true)
+      if block_given?
+        super do |connection|
+          acquire_semian_resource(adapter: :redis_client, scope: :query) do
+            yield connection
+          end
+        end
+      else
+        super
+      end
+    end
+
+    def connect
+      acquire_semian_resource(adapter: :redis_client, scope: :connection) do
+        super
+      end
+    end
+  end
+
+  module RedisClientPool
+    include RedisClientCommon
+    define_method(:semian_resource, Semian::Adapter.instance_method(:semian_resource))
+    define_method(:clear_semian_resource, Semian::Adapter.instance_method(:clear_semian_resource))
+  end
+end
+
+RedisClient.prepend(Semian::RedisClient)
+RedisClient::Pooled.prepend(Semian::RedisClient)