semian 0.17.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0461852ea5a5ffbacaf9a20062213609066e3ef8ade9a93a980d2af73a0feb39'
-  data.tar.gz: 8e21023912cd7c71cc74c0eb6a384771018f5fa3f53c212a62c23446801573e2
+  metadata.gz: 8c0cecc8c8e42f223f2cde75e3818ad4bc33897107b6a99186beb48c413c6d30
+  data.tar.gz: 9202b9e1cf15ff54d68f8d3fe11800ace1624828d1aa840840b88180f65e5355
 SHA512:
-  metadata.gz: 0bd910ad2f7891d4dc2660135adea394db252afa7f53f8c707a55fa569cbf481514af485fe9056d5959e98faffd8bd20990ac9f7b6abe0b0f453ca29d3ad3e9f
-  data.tar.gz: a4149e3b4021fe47be636e28bbd5ece3eb4246d65bbc95b07cc50e1b45a328980e47c32d15e81a52e2516fe01b2622fedf31d5aac8bcedbee7e3bdb73a1a0c8c
+  metadata.gz: 1bd71610d96984ada73fe625966f66ecc13cc921ac659a78c9010eec952f61e1ea56aa4c9f3e6de0572a2b2059e0cd919e1063907c4d39c9d630dd536bf4a89e
+  data.tar.gz: 20513585134a89dc3a33bcc2895728a64fa5e35e978dbcf83ac44fccc00ae9428e0f8bd8988fe3941e4236d4d18daed380014843b0ad071f945164e68eda68af

data/README.md

@@ -1,5 +1,4 @@
-## Semian ![Build Status](https://github.com/Shopify/semian/actions/workflows/main.yml/badge.svg)
-
+## Semian ![Build Status](https://github.com/Shopify/semian/actions/workflows/test.yml/badge.svg)
 
 ![](http://i.imgur.com/7Vn2ibF.png)
 
@@ -73,6 +72,7 @@ version is the version of the public gem with the same name:
 * [`semian/mysql2`][mysql-semian-adapter] (~> 0.3.16)
 * [`semian/redis`][redis-semian-adapter] (~> 3.2.1)
 * [`semian/net_http`][nethttp-semian-adapter]
+* [`semian/activerecord_trilogy_adapter`][activerecord-trilogy-semian-adapter]
 * [`semian-postgres`][postgres-semian-adapter]
 
 ### Creating Adapters
@@ -299,6 +299,35 @@ SEMIAN_PARAMETERS = { tickets: 1,
                       open_circuit_server_errors: true }
 ```
 
+#### Active Record
+
+Semian supports Active Record adapter `trilogy`.
+It can be configured in the `database.yml`:
+
+```yml
+semian: &semian
+  success_threshold: 2
+  error_threshold: 3
+  error_timeout: 4
+  half_open_resource_timeout: 1
+  bulkhead: false # Disable bulkhead for Puma: https://github.com/shopify/semian#thread-safety
+  name: semian_identifier_name
+
+default: &default
+  adapter: trilogy
+  username: root
+  password:
+  host: localhost
+  read_timeout: 2
+  write_timeout: 1
+  connect_timeout: 1
+  semian:
+    <<: *semian
+```
+
+Example cases for `activerecord-trilogy-adapter` can be run using
+`BUNDLE_GEMFILE=gemfiles/activerecord_trilogy_adapter.gemfile bundle exec rake examples:activerecord_trilogy_adapter`
+
 # Understanding Semian
 
 Semian is a library with heuristics for failing fast. This section will explain
@@ -859,6 +888,7 @@ $ bundle install
 [mysql-semian-adapter]: lib/semian/mysql2.rb
 [postgres-semian-adapter]: https://github.com/mschoenlaub/semian-postgres
 [redis-semian-adapter]: lib/semian/redis.rb
+[activerecord-trilogy-semian-adapter]: lib/semian/activerecord_trilogy_adapter.rb
 [semian-adapter]: lib/semian/adapter.rb
 [nethttp-semian-adapter]: lib/semian/net_http.rb
 [nethttp-default-errors]: lib/semian/net_http.rb#L35-L45

data/lib/semian/activerecord_trilogy_adapter.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "semian/adapter"
+require "active_record"
+require "active_record/connection_adapters/trilogy_adapter"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class TrilogyAdapter
+      ActiveRecord::ActiveRecordError.include(::Semian::AdapterError)
+
+      class SemianError < StatementInvalid
+        def initialize(semian_identifier, *args)
+          super(*args)
+          @semian_identifier = semian_identifier
+        end
+      end
+
+      ResourceBusyError = Class.new(SemianError)
+      CircuitOpenError = Class.new(SemianError)
+    end
+  end
+end
+
+module Semian
+  module ActiveRecordTrilogyAdapter
+    include Semian::Adapter
+
+    ResourceBusyError = ::ActiveRecord::ConnectionAdapters::TrilogyAdapter::ResourceBusyError
+    CircuitOpenError = ::ActiveRecord::ConnectionAdapters::TrilogyAdapter::CircuitOpenError
+
+    attr_reader :raw_semian_options, :semian_identifier
+
+    def initialize(*options)
+      *, config = options
+      config = config.dup
+      @raw_semian_options = config.delete(:semian)
+      @semian_identifier = begin
+        name = semian_options && semian_options[:name]
+        unless name
+          host = config[:host] || "localhost"
+          port = config[:port] || 3306
+          name = "#{host}:#{port}"
+        end
+        :"mysql_#{name}"
+      end
+      super
+    end
+
+    def execute(sql, *)
+      if query_allowlisted?(sql)
+        super
+      else
+        acquire_semian_resource(adapter: :trilogy_adapter, scope: :execute) do
+          super
+        end
+      end
+    end
+    ruby2_keywords :execute
+
+    def active?
+      acquire_semian_resource(adapter: :trilogy_adapter, scope: :ping) do
+        super
+      end
+    rescue ResourceBusyError, CircuitOpenError
+      false
+    end
+
+    def with_resource_timeout(temp_timeout)
+      if connection.nil?
+        prev_read_timeout = @config[:read_timeout] || 0
+        @config.merge!(read_timeout: temp_timeout) # Create new client with temp_timeout for read timeout
+      else
+        prev_read_timeout = connection.read_timeout
+        connection.read_timeout = temp_timeout
+      end
+      yield
+    ensure
+      @config.merge!(read_timeout: prev_read_timeout)
+      connection&.read_timeout = prev_read_timeout
+    end
+
+    private
+
+    def acquire_semian_resource(**)
+      super
+    rescue ActiveRecord::StatementInvalid => error
+      if error.cause.is_a?(Trilogy::TimeoutError)
+        semian_resource.mark_failed(error)
+        error.semian_identifier = semian_identifier
+      end
+      raise
+    end
+
+    def resource_exceptions
+      [ActiveRecord::ConnectionNotEstablished]
+    end
+
+    # TODO: share this with Mysql2
+    QUERY_ALLOWLIST = Regexp.union(
+      %r{\A(?:/\*.*?\*/)?\s*ROLLBACK}i,
+      %r{\A(?:/\*.*?\*/)?\s*COMMIT}i,
+      %r{\A(?:/\*.*?\*/)?\s*RELEASE\s+SAVEPOINT}i,
+    )
+
+    def query_allowlisted?(sql, *)
+      QUERY_ALLOWLIST.match?(sql)
+    rescue ArgumentError
+      return false unless sql.valid_encoding?
+
+      raise
+    end
+
+    def connect(*args)
+      acquire_semian_resource(adapter: :trilogy_adapter, scope: :connection) do
+        super
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TrilogyAdapter.prepend(Semian::ActiveRecordTrilogyAdapter)

data/lib/semian/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Scott Francis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies: []
 description: |2
       A Ruby C extention that is used to control access to shared resources
@@ -34,6 +34,7 @@ files:
 - ext/semian/tickets.h
 - ext/semian/types.h
 - lib/semian.rb
+- lib/semian/activerecord_trilogy_adapter.rb
 - lib/semian/adapter.rb
 - lib/semian/circuit_breaker.rb
 - lib/semian/grpc.rb
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.12
 signing_key: 
 specification_version: 4
 summary: Bulkheading for Ruby with SysV semaphores