semian 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7b62deafc4e8de524ae8aec32a17e3a1065d70206a5ead2ef6298da3b1c38ed
-  data.tar.gz: 3f6b18aa473410c0ad8d476931417fa69595328fd748a2edb75a333709b901cd
+  metadata.gz: 03aa7b6a715e0990279468f71a5bacbd03b94f983c16083570a09dc46c69d325
+  data.tar.gz: 1b53f85622bfa3868585ea8836df867a37da5b4142b769ad8b968d9865c001c2
 SHA512:
-  metadata.gz: c064829103c0c4f8915f6c072d43872b9a6dc011987e6a81f5efa8931052cc84b758df9bc4dd74f4f90c0501accbaa3e09ca3212af6a8a3e7056ce1f28a28e22
-  data.tar.gz: 124128fc2a5791317ea5a04b32c84e9b3cd394e843a74599c5ecf044cc6c89eec656384675b88e9fd73e95038dfb1e8a35b8e613034114e264b59e754a8eec0c
+  metadata.gz: f7f481a7a77c6d91574500e2a636eb6bd9721e61be5c8740265f58ac90895525ed9b34750b7dbb23d97360a3449a7a990994d870c8a9730e8d06350afda7c7de
+  data.tar.gz: 216189dea6814080db529843164dd02235541127ce9058ff803cc3843842220e87340b45a73109a2004d6205194b166b0cbcbf55e46601a5bf5f00c75cb5678c

data/README.md

@@ -211,7 +211,7 @@ calculate and adjust ticket counts.
 
 **Note**:
 
-- You must pass **exactly** one of ticket or quota.
+- You must pass **exactly** one of options: `tickets` or `quota`.
 - Tickets available will be the ceiling of the quota ratio to the number of workers
  - So, with one worker, there will always be a minimum of 1 ticket
 - Workers in different processes will automatically unregister when the process exits.
@@ -236,7 +236,7 @@ SEMIAN_PARAMETERS = { tickets: 1,
                       error_timeout: 10 }
 Semian::NetHTTP.semian_configuration = proc do |host, port|
   # Let's make it only active for github.com
-  if host == "github.com" && port == "80"
+  if host == "github.com" && port.to_i == 80
     SEMIAN_PARAMETERS.merge(name: "github.com_80")
   else
     nil
@@ -282,19 +282,22 @@ Semian::NetHTTP.exceptions += [::OpenSSL::SSL::SSLError]
 Semian::NetHTTP.reset_exceptions
 # assert_equal(Semian::NetHTTP.exceptions, Semian::NetHTTP::DEFAULT_ERRORS)
 ```
+
 ##### Mark Unsuccessful Responses as Failures
-Unsuccessful responses (e.g. 5xx responses) do not raise exceptions, and as such are not marked as failures by default. The `open_circuit_server_errors` Semian configuration parameter may be set to enable this behaviour, to mark unsuccessful responses as failures as seen below:
+
+Unsuccessful responses (e.g. 5xx responses) do not raise exceptions,
+and as such are not marked as failures by default.
+The `open_circuit_server_errors` Semian configuration parameter may be set to enable this behaviour,
+to mark unsuccessful responses as failures as seen below:
 
 ```ruby
 SEMIAN_PARAMETERS = { tickets: 1,
                       success_threshold: 1,
                       error_threshold: 3,
                       error_timeout: 10,
-                      open_circuit_server_errors: true}
+                      open_circuit_server_errors: true }
 ```
 
-
-
 # Understanding Semian
 
 Semian is a library with heuristics for failing fast. This section will explain
@@ -415,7 +418,7 @@ response time. This is the problem Semian solves by failing fast.
 
 ## How does Semian work?
 
-Semian consists of two parts: circuit breaker and bulkheading. To understand
+Semian consists of two parts: **Circuit breaker** and **Bulkheading**. To understand
 Semian, and especially how to configure it, we must understand these patterns
 and their implementation.
 
@@ -453,6 +456,8 @@ There are four configuration parameters for circuit breakers in Semian:
 * **error_threshold_timeout**. The amount of time in seconds that error_threshold errors must occur to open the circuit. Defaults to error_timeout seconds if not set.
 * **error_timeout**. The amount of time in seconds until trying to query the resource
   again.
+* **error_threshold_timeout_enabled**. If set to false it will disable the time window for evicting old exceptions. `error_timeout` is still used and will reset
+  the circuit. Defaults to `true` if not set.
 * **success_threshold**. The amount of successes on the circuit until closing it
   again, that is to start accepting all requests to the circuit.
 * **half_open_resource_timeout**. Timeout for the resource in seconds when the circuit is half-open (supported for MySQL, Net::HTTP and Redis).
@@ -531,7 +536,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 +558,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
 ```
 
@@ -754,11 +759,13 @@ non-IO.
 
 # Developing Semian
 
-Semian requires a Linux environment.  We provide a [docker-compose](https://docs.docker.com/compose/) file
-that runs MySQL, Redis, Toxiproxy and Ruby in containers.  Use
-the steps below to work on Semian from a Mac OS environment.
+Semian requires a Linux environment for **Bulkheading**.
+We provide a [docker-compose](https://docs.docker.com/compose/) file
+that runs MySQL, Redis, Toxiproxy and Ruby in containers.
+Use the steps below to work on Semian from a Mac OS environment.
 
 ## Prerequisites :
+
 ```bash
 # install docker-for-desktop
 $ brew cask install docker
@@ -819,6 +826,17 @@ $ cd semian
 $ bundle exec rake test:parallel TEST_WORKERS=5 TEST_WORKER_NUM=1
 ```
 
+### Debug
+
+Build a semian native extension with debug information.
+
+```shell
+$ bundle exec rake clean --trace
+$ export DEBUG=1
+$ bundle exec rake build
+$ bundle install
+```
+
 [hystrix]: https://github.com/Netflix/Hystrix
 [release-it]: https://pragprog.com/titles/mnee2/release-it-second-edition/
 [shopify]: http://www.shopify.com/

data/ext/semian/resource.c

@@ -273,10 +273,10 @@ static void
 check_tickets_xor_quota_arg(VALUE tickets, VALUE quota)
 {
   if (tickets == Qnil && quota == Qnil) {
-    rb_raise(rb_eArgError, "Semian configuration require either the :ticket or :quota parameter, you provided neither");
+    rb_raise(rb_eArgError, "Semian configuration require either the :tickets or :quota parameter, you provided neither");
   }
   if (tickets != Qnil && quota != Qnil) {
-    rb_raise(rb_eArgError, "Semian configuration require either the :ticket or :quota parameter, you provided both");
+    rb_raise(rb_eArgError, "Semian configuration require either the :tickets or :quota parameter, you provided both");
   }
 }
 

data/ext/semian/sysv_semaphores.h

@@ -10,6 +10,9 @@ and functions associated directly weth semops.
 #include <errno.h>
 #include <stdio.h>
 #include <string.h>
+#ifdef DEBUG
+#include <unistd.h>
+#endif
 
 #include <openssl/sha.h>
 #include <ruby.h>
@@ -110,7 +113,8 @@ acquire_semaphore_without_gvl(void *p);
 static inline void
 print_sem_vals(int sem_id)
 {
-  printf("lock %d, tickets: %d configured: %d, registered workers %d\n",
+  printf("[pid=%d][semian] semaphore values lock: %d, tickets: %d configured: %d, registered workers: %d\n",
+   getpid(),
    get_sem_val(sem_id, SI_SEM_LOCK),
    get_sem_val(sem_id, SI_SEM_TICKETS),
    get_sem_val(sem_id, SI_SEM_CONFIGURED_TICKETS),

data/lib/semian/circuit_breaker.rb

@@ -6,16 +6,24 @@ module Semian
 
     def_delegators :@state, :closed?, :open?, :half_open?
 
-    attr_reader :name, :half_open_resource_timeout, :error_timeout, :state, :last_error
+    attr_reader(
+      :name,
+      :half_open_resource_timeout,
+      :error_timeout,
+      :state,
+      :last_error,
+      :error_threshold_timeout_enabled,
+    )
 
     def initialize(name, exceptions:, success_threshold:, error_threshold:,
       error_timeout:, implementation:, half_open_resource_timeout: nil,
-      error_threshold_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
       @error_threshold_timeout = error_threshold_timeout || error_timeout
+      @error_threshold_timeout_enabled = error_threshold_timeout_enabled.nil? ? true : error_threshold_timeout_enabled
       @error_timeout = error_timeout
       @exceptions = exceptions
       @half_open_resource_timeout = half_open_resource_timeout
@@ -131,7 +139,10 @@ module Semian
     end
 
     def push_time(window, time: Time.now)
-      window.reject! { |err_time| err_time + @error_threshold_timeout < time.to_i }
+      if error_threshold_timeout_enabled
+        window.reject! { |err_time| err_time + @error_threshold_timeout < time.to_i }
+      end
+
       window << time.to_i
     end
 

data/lib/semian/mysql2.rb

@@ -70,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/version.rb

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

data/lib/semian.rb

@@ -276,6 +276,11 @@ module Semian
       error_threshold: options[:error_threshold],
       error_threshold_timeout: options[:error_threshold_timeout],
       error_timeout: options[:error_timeout],
+      error_threshold_timeout_enabled: if options[:error_threshold_timeout_enabled].nil?
+                                         true
+                                       else
+                                         options[:error_threshold_timeout_enabled]
+                                       end,
       exceptions: Array(exceptions) + [::Semian::BaseError],
       half_open_resource_timeout: options[:half_open_resource_timeout],
       implementation: implementation(**options),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Scott Francis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A Ruby C extention that is used to control access to shared resources