semian 0.13.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 540294c5a9ecdfdcbafcdc1485afd1314a94fd869501bc6795ee327606d3e799
-  data.tar.gz: 5855959232d25ea3c2da1f7ca7096c18afb15161ac8116e8f1ece9792fd456e4
+  metadata.gz: 9610bcda3bdfb95c885c6c31c4a2450a4c31824f877ad38e7ca3c34c4fd57d6c
+  data.tar.gz: d748c2da29ba2ca844bc74354591196a6645a915d725fea07ab743d0b6343bf2
 SHA512:
-  metadata.gz: c7549cd0c6dc515733612fcd7b200c23467104c5616ff9501b65a554712e0449d07d8d2d479b45962cffb87c8e6cd2fc82d695a1d9f399a5724b3b4c241c59a8
-  data.tar.gz: cf31ff975016b22e101db10813d73ab8288584657c9f7319ef222790dcd052d3ab45caedcca2639140d2199be87d1f790f0c82edf918d388c669f9be68b467f2
+  metadata.gz: bf3e8a28916019f60f64ce668cd919e4b59e3ebcb50e397266363b7f43d093cbefd06bb41b9816351b9435484b5948eaf5c45e5408d677d76c0ac879ae98b21e
+  data.tar.gz: b387b82d92712aba64d47e0a8ac33abc9789dba435e88e0020de6eae46881938fcdba5f16da39cbc3930e8a8e9b4bdacf3688388c9d328be25845915b341a5ce

data/README.md

@@ -531,7 +531,7 @@ provides an easy way to get the semaphore key:
 
 ```
 irb> require 'semian'
-irb> puts Semian::Resource.new(:your_resource_name, tickets:1).key # do this from a dev machine
+irb> puts Semian::Resource.new(:your_resource_name, tickets: 42).key # do this from a dev machine
 "0x48af51ea"
 ```
 
@@ -553,8 +553,8 @@ otime = Thu Mar 30 15:06:16 2017
 ctime = Mon Mar 13 20:25:36 2017
 semnum     value      ncount     zcount     pid
 0          1          0          0          48
-1          25         0          0          48
-2          25         0          0          27
+1          42         0          0          48
+2          42         0          0          27
 3          31         0          0          48
 ```
 

data/lib/semian/mysql2.rb

@@ -43,16 +43,18 @@ module Semian
       %r{\A(?:/\*.*?\*/)?\s*RELEASE\s+SAVEPOINT}i,
     )
 
-    # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose
-    def self.included(base)
-      base.send(:alias_method, :raw_query, :query)
-      base.send(:remove_method, :query)
+    class << self
+      # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose
+      def included(base)
+        base.send(:alias_method, :raw_query, :query)
+        base.send(:remove_method, :query)
 
-      base.send(:alias_method, :raw_connect, :connect)
-      base.send(:remove_method, :connect)
+        base.send(:alias_method, :raw_connect, :connect)
+        base.send(:remove_method, :connect)
 
-      base.send(:alias_method, :raw_ping, :ping)
-      base.send(:remove_method, :ping)
+        base.send(:alias_method, :raw_ping, :ping)
+        base.send(:remove_method, :ping)
+      end
     end
 
     def semian_identifier
@@ -68,6 +70,8 @@ module Semian
     end
 
     def ping
+      return false if closed?
+
       result = nil
       acquire_semian_resource(adapter: :mysql, scope: :ping) do
         result = raw_ping

data/lib/semian/rails.rb

@@ -4,6 +4,23 @@ require "active_record/connection_adapters/abstract_adapter"
 
 module Semian
   module Rails
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Translate ConnectionNotEstablished errors to their original
+      # cause if applicable. When we have a CircuitOpenErorr we don't
+      # want the Active Record error, but rather the original cause.
+      def new_client(config)
+        super
+      rescue ActiveRecord::ConnectionNotEstablished => e
+        if e.cause.is_a?(Mysql2::CircuitOpenError)
+          raise e.cause
+        else
+          raise
+        end
+      end
+    end
+
     def semian_resource
       @semian_resource ||= client_connection.semian_resource
     end

data/lib/semian/redis/v5.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "semian/redis_client"
+
+class Redis
+  BaseConnectionError.include(::Semian::AdapterError)
+  OutOfMemoryError.include(::Semian::AdapterError)
+
+  class SemianError < BaseConnectionError
+    def initialize(semian_identifier, *args)
+      super(*args)
+      @semian_identifier = semian_identifier
+    end
+  end
+
+  ResourceBusyError = Class.new(SemianError)
+  CircuitOpenError = Class.new(SemianError)
+
+  Client::ERROR_MAPPING.merge!(
+    RedisClient::CircuitOpenError => Redis::CircuitOpenError,
+    RedisClient::ResourceBusyError => Redis::ResourceBusyError,
+  )
+end
+
+module Semian
+  module RedisV5
+    def semian_resource
+      _client.semian_resource
+    end
+
+    def semian_identifier
+      _client.semian_identifier
+    end
+  end
+
+  module RedisV5Client
+    private
+
+    def translate_error!(error)
+      redis_error = translate_error_class(error.class)
+      if redis_error < ::Semian::AdapterError
+        redis_error = redis_error.new(error.message)
+        redis_error.semian_identifier = semian_identifier
+      end
+      raise redis_error, error.message, error.backtrace
+    end
+  end
+end
+
+::Redis.prepend(Semian::RedisV5)
+::Redis::Client.prepend(Semian::RedisV5Client)

data/lib/semian/redis.rb

@@ -3,6 +3,12 @@
 require "semian/adapter"
 require "redis"
 
+if Redis::VERSION >= "5"
+  gem "redis", ">= 5.0.3"
+  require "semian/redis/v5"
+  return
+end
+
 class Redis
   Redis::BaseConnectionError.include(::Semian::AdapterError)
   ::Errno::EINVAL.include(::Semian::AdapterError)
@@ -58,20 +64,22 @@ class Redis
 end
 
 module Semian
-  module Redis
+  module RedisV4
     include Semian::Adapter
 
     ResourceBusyError = ::Redis::ResourceBusyError
     CircuitOpenError = ::Redis::CircuitOpenError
     ResolveError = ::Redis::ResolveError
 
-    # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose
-    def self.included(base)
-      base.send(:alias_method, :raw_io, :io)
-      base.send(:remove_method, :io)
+    class << self
+      # The naked methods are exposed as `raw_query` and `raw_connect` for instrumentation purpose
+      def included(base)
+        base.send(:alias_method, :raw_io, :io)
+        base.send(:remove_method, :io)
 
-      base.send(:alias_method, :raw_connect, :connect)
-      base.send(:remove_method, :connect)
+        base.send(:alias_method, :raw_connect, :connect)
+        base.send(:remove_method, :connect)
+      end
     end
 
     def semian_identifier
@@ -150,4 +158,4 @@ module Semian
   end
 end
 
-::Redis::Client.include(Semian::Redis)
+::Redis::Client.include(Semian::RedisV4)

data/lib/semian/redis_client.rb

@@ -5,6 +5,14 @@ require "redis-client"
 
 class RedisClient
   ConnectionError.include(::Semian::AdapterError)
+  ConnectionError.class_eval do
+    # A Connection Reset is a fast failure and we don't want to track these errors in semian
+    def marks_semian_circuits?
+      !message.include?("Connection reset by peer")
+    end
+  end
+
+  OutOfMemoryError.include(::Semian::AdapterError)
 
   class SemianError < ConnectionError
     def initialize(semian_identifier, *args)
@@ -72,7 +80,7 @@ module Semian
   end
 
   module RedisClient
-    EXCEPTIONS = [::RedisClient::ConnectionError]
+    EXCEPTIONS = [::RedisClient::ConnectionError, ::RedisClient::OutOfMemoryError]
 
     include Semian::Adapter
     include RedisClientCommon
@@ -110,4 +118,4 @@ module Semian
 end
 
 RedisClient.prepend(Semian::RedisClient)
-RedisClient::Pooled.prepend(Semian::RedisClient)
+RedisClient::Pooled.prepend(Semian::RedisClientPool)

data/lib/semian/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Scott Francis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A Ruby C extention that is used to control access to shared resources
@@ -21,7 +21,6 @@ extensions:
 - ext/semian/extconf.rb
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.md
 - README.md
 - ext/semian/extconf.rb
@@ -46,6 +45,7 @@ files:
 - lib/semian/protected_resource.rb
 - lib/semian/rails.rb
 - lib/semian/redis.rb
+- lib/semian/redis/v5.rb
 - lib/semian/redis_client.rb
 - lib/semian/resource.rb
 - lib/semian/simple_integer.rb
@@ -60,6 +60,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/Shopify/semian/issues
   changelog_uri: https://github.com/Shopify/semian/blob/master/CHANGELOG.md
+  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: []

data/CHANGELOG.md

@@ -1,243 +0,0 @@
-# Unreleased
-
-# v0.13.2
-
-* Fix: Update AbstractAdapter patch to accomodate recent Rails changes. (#364)
-
-# v0.13.1
-
-* Fix: Raise `Redis::OutOfMemoryError` for messages that match `OOM command not allowed when used memory > 'maxmemory'` rather than checking `start_with?("OOM ")`. (#367)
-
-# v0.13.0
-
-* Refactor: Replace Time.now with CLOCK_MONOTONIC in MockServer (#318)
-* Fix: Circuit not open for GRPC::ActiveCall::Operation failures (#348)
-
-# v0.12.0
-
-* Feature: Add support for the `redis-client` gem (#314)
-
-# v0.11.8
-
-* Feature: Add error_threshold_timeout configuration parameter (#299)
-
-# v0.11.7
-
-* Fix: ECONNRESET won't trigger circuit open for redis (#306)
-
-# v0.11.6
-
-* Fix: pass disable flag by patching new singleton method (#303)
-
-# v0.11.5
-
-* Feature: Add disable flag to http adapter (#301)
-
-# v0.11.4
-
-* Fix: Add `extern` to global variable declarations for gcc 10 (#288)
-
-# v0.11.3
-
-* Feature: Log last error message on circuit breaker state transition (#285)
-* Fix: Update README and docs to resolve common misconception about error_threshold (#283)
-
-# v0.11.2
-
-* Fix: Remove `MySQL client is not connected` error from mysql2 adapter
-
-# v0.11.1
-
-* Feature: Add `Semian.namespace` to globally prefix all the semaphore names. (#280)
-
-# v0.11.0
-
-* Feature: Add `Semian.default_permissions` to globally change the default semaphore permissions. (#279)
-
-# v0.10.6
-
-* Fix: Match whitelisted SQL queries when Marginalia is prepended (#276)
-
-# v0.10.5
-
-* Fix: Compatibility with GC.compact
-
-# v0.10.4
-
-* Fix: Revert the changes in v0.10.3. (#270)
-
-# v0.10.3
-
-* Fix: Positional/Keyword arguments deprecations warning for Ruby 2.7 in the grpc adapter. (#269)
-
-# v0.10.2
-
-* Fix: Positional/Keyword arguments deprecations warning for Ruby 2.7.
-
-# v0.10.1
-
-* Fix: thread safety bug on Ruby 2.7. (#263)
-
-# v0.10.0
-
-* Feature: Support half open resource timeout for redis.
-
-# v0.9.1
-
-* Fix: Compatibility with MRI 2.3
-
-# v0.9.0
-
-* Feature: Add a LRU to garbage collect old resources. (#193)
-
-# v0.8.9
-* Fix: Recursion issue in MySQL2 adapter causing circuits breakers to stay open much longer than they should. (#250)
-* Fix: Better handle DNS resolutions exceptions in Redis adapter. (#230)
-
-# v0.8.8
-* Feature: Introduce the GRPC adapter (#200)
-
-# v0.8.7
-* Fix: Instrument success for `acquire_circuit_breaker` (#209)
-
-# v0.8.6
-* Feature: If an error instance responds to `#marks_semian_circuits?` don't mark the circuit if it returns false (#210)
-
-# v0.8.5
-* Fix: Redis adapter using hiredis is resilient to DNS resolution failures (#205)
-
-# v0.8.4
-* Feature: Introduce `half_open_resource_timeout` which changes the resource timeout when the circuit is in a half-open state for the Net::HTTP adapter. (#198)
-* Feature: Add the cause of the last error when a circuit opens (#197)
-* Fix: Reset successes when transitioning to the half open state (#192)
-
-# v0.8.1
-
-* Fix: Expose `half_open?` when the circuit state has not transitioned but will. This allows consumers further up the stack to know if the circuit
-is half open.
-
-# v0.8.0
-
-* Feature: Introduce `half_open_resource_timeout` which changes the resource timeout when the circuit is in a half-open state (#188)
-
-# v0.7.8
-
-* Feature: More informative error messages when initializing Semian with missing
-  arguments (#182)
-* Fix: Redis adapter is now resilient to DNS resolution failures (#184)
-
-# v0.7.5
-
-* Fix: Repaired compatibility with dependent Redis library
-
-# v0.7.4
-
-* Fix: Protect internal semaphore when adjusting resource count (#164)
-* Feature: Use prepend when monkey-patching Net::HTTP. (#157)
-* Feature: Include time spend waiting for bulkhead in notification (#154)
-
-# v0.7.1
-
-*  Feature: Add the behaviour to enable open circuiting on 5xxs conditionally  (#149)
-*  Refactor: Configurable hosts for Semian's development dependencies (#152)
-
-# v0.7.0
-
-This change introduced a series of changes to support a new "dynamic quota" ticket
-allocation strategy. This code primarily affects bulkheads (protected resources).
-
-Rather than statically setting a ticket count, workers (in their own process) now register
-themselves. By specifying 'quota' instead of 'tickets', the bulkhead threshold will now be
-computed dynamically as a ratio of the number of registered workers, eliminating the need to
-continuously readjust ticket counts, and supporting environments with non-uniform worker
-distribution between machines.
-
-* Feature: Support quota based allocation strategy (#120)
-* Feature: Add ability to manually unregister workers (#130)
-* Feature: Add ability to clear resources from adapters and unregister all resources (#134)
-* Feature: Allow sysV IPC key to be accessed in ruby (#136)
-* Feature: Expose registered worker count to ruby (#137)
-* Refactor: Allow registered worker count to be accessed through bulkhead (#138)
-* Bug fix: Register all workers (#128)
-* Bug fix: Lazy instantiate redis clien on first I/O (#132)
-* Bug fix: New mysql error (#131)
-* Bug fix: Prevent race conditions when unregistering (#141)
-* Refactor/Feature: Break coupling between resource and circuit breaker (#123)
-* Refactor: Use generic max_sem_val (#117)
-* Refactor: Fix header syntax (#118)
-* Refactor: Always acquire semaphore without_gvl (#121)
-* Thread-safety for circuit breakers by default (#150)
-* Fix bug where calling name on a protected resource without a semaphore would fail (#151)
-
-# v0.6.2
-
-*  Refactor: Refactor semian ticket management into its own files (#116)
-*  Refactor: Create sem_meta_lock and sem_meta_unlock (#115)
-*  Refactor: Refactor semaphore operations (#114)
-
-# v0.6.1
-
-* Refactor: Generate a unique semaphore key by including size of semaphore set
-* Refactor: Refactor semian\_resource related C functions
-* Fix: Don't require sudo for travis (#110)
-* Refactor: Refactor semian.c includes and types into header files
-* Fix: Use glob instead of git for gemspec file list
-* Fix: Fix travis CI for ruby 2.3.0 installing rainbows
-* Refactor: Switch to enumerated type for tracking semaphore indices
-* Docs: readme: explain co-operation between cbs and bulkheads
-* Docs: readme: add section about server limits
-
-# v0.6.0
-
-* Feature: Load semian/rails automatically if necessary
-* Feature: Implement AR::AbstractAdapter#semian\_resource
-
-# v0.5.4
-
-* Fix: Also let "Too many connections" be a first class conn error
-
-# v0.5.3
-
-* Fix: mysql: protect pings
-* Fix: mysql: match more lost conn queries
-
-# v0.5.2
-
-* Fix: Make request\_allowed? thread safe
-* Fix: Fix CI connect errors on HTTP requests by using 127.0.0.1 for host
-
-# v0.5.1
-
-* Fix: Assert Resource#initialize\_semaphore contract on Resource init
-* Fix: Lock on older thin version for pre MRI 2.2 compatibility
-
-# v0.5.0
-
-* Fix: Only issue unsupported or disabled semaphores warnings when the first resource is instanciated
-* Refactor: Cleanup requires
-* Maintenance: Use published version of the toxiproxy gem
-* Fix: Fix minitest deprecation warnings
-* Maintenance: Update bundler on travis
-* Maintenance: Update supported MRI versions on travis
-
-# v0.4.3
-
-* Fix: Fix lazy aliasing of Redis#semian\_resource
-* Fix: Workaround rubocop parser limitations
-
-# v0.4.2
-
-* Fix: Fix for TimeoutError is deprecated in Ruby 2.3.0
-* Feature: Include Ruby 2.3 in Travis builds
-
-# v0.4.1
-* Fix: resource: cast float ticket count to fixnum #75
-
-# v0.4.0
-
-* Feature: net/http: add adapter for net/http #58
-* Refactor: circuit_breaker: split circuit breaker into three data structures to allow for
-  alternative implementations in the future #62
-* Fix: mysql: don't prevent rollbacks on transactions #60
-* Fix: core: fix initialization bug when the resource is accessed before the options
-  are set #65