activerecord-dynamic_timeout 0.0.1.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f13bd79fe5a35f5979b91ec7f702ad0fe0d95ff743a2a91dc3a81a9c8e78fa7
+  data.tar.gz: d1c6f748961cb9c812215f2ee710fc88f99d7230a67986710152ecda8bb8f811
+SHA512:
+  metadata.gz: 57286088e5d8fdb64d24e24e949dce507ff8afb10d295182c42926df5eef6fa2c4d1abc5e3a55812596b32d56969f8b9ad2b0eadbd6c7fc1443b973a6109c32b
+  data.tar.gz: 24e3f13a1c85ab0efd0d68222fe9b8e2fd4e1a84816c01fe28b00736e386c33a6d70ed94ae6261ecb57400a644d24a2e9415c89c55e4d851945ccfe94c417e6b

data/Appraisals

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "appraisal/matrix"
+
+appraisal_matrix(activerecord: "6.1") do |activerecord:|
+  if activerecord < "7.2"
+    gem "sqlite3", "~> 1.4"
+  end
+end
+# appraisal_matrix(activerecord: "6.1", mysql2: { versions: ["~> 0.5"], step: :major })
+# appraisal_matrix(activerecord: "6.1", pg: { versions: ["~> 1.5"], step: :major })
+#
+# appraisal_matrix(activerecord: [">= 6.1", "< 7.2"], sqlite3: { versions: ["~> 1.4"], step: :major })
+# appraisal_matrix(activerecord: "7.2", sqlite3: { versions: [">= 1.4"], step: :major })
+# appraisal_matrix(activerecord: "7.1", trilogy: { versions: [">= 2.8"], step: :major })

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "appraisal"
+gem "appraisal-matrix"
+gem "debug"
+gem "mysql2"
+gem "pg"
+gem "rspec"
+gem "sqlite3"
+gem "trilogy"

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    activerecord-dynamic_timeout (0.0.1.rc1)
+      activerecord (>= 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.2.1)
+      activesupport (= 7.2.1)
+    activerecord (7.2.1)
+      activemodel (= 7.2.1)
+      activesupport (= 7.2.1)
+      timeout (>= 0.4.0)
+    activesupport (7.2.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    appraisal-matrix (0.3.0)
+      appraisal (~> 2.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    logger (1.6.1)
+    minitest (5.25.1)
+    mysql2 (0.5.6)
+    pg (1.5.8)
+    psych (5.1.2)
+      stringio
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.10)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    securerandom (0.3.1)
+    sqlite3 (2.0.4-arm64-darwin)
+    stringio (3.1.1)
+    thor (1.3.2)
+    timeout (0.4.1)
+    trilogy (2.8.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin
+
+DEPENDENCIES
+  activerecord-dynamic_timeout!
+  appraisal
+  appraisal-matrix
+  debug
+  mysql2
+  pg
+  rspec
+  sqlite3
+  trilogy
+
+BUNDLED WITH
+   2.5.5

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2024 Tristan Starck <tstarck@invoca.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# activerecord-dynamic_timeout
+Dynamic Timeouts within ActiveRecord

data/Rakefile

@@ -0,0 +1,7 @@
+Bundler::GemHelper.install_tasks
+
+task default: :rspec
+
+desc "run rspec unit tests"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:rspec)

data/activerecord-dynamic_timeout.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path("../lib", __FILE__)
+require "active_record/dynamic_timeout/version"
+
+Gem::Specification.new do |s|
+  s.name          = "activerecord-dynamic_timeout"
+  s.version       = ActiveRecord::DynamicTimeout::VERSION
+  s.authors       = ["Tristan Starck"]
+  s.email         = ["tstarck@invoca.com", "Invoca Development"]
+  s.homepage      = "https://github.com/Invoca/activerecord-dynamic_timeout"
+  s.licenses      = ["MIT"]
+  s.summary       = "ActiveRecord extension for dynamically setting connection timeouts"
+  s.description   = s.summary
+  s.metadata      = {
+    "allowed_push_host" => "https://rubygems.org",
+    "source_code_uri"   => s.homepage,
+  }
+
+  s.files         = Dir.glob("{bin/*,lib/**/*,[A-Z]*}")
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ">= 6.1"
+end

data/lib/active_record/dynamic_timeout/extensions/abstract_adapter_extension.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+require_relative "../../dynamic_timeout"
+
+module ActiveRecord::DynamicTimeout
+  module AbstractAdapterExtension
+    extend ActiveSupport::Concern
+
+    attr_accessor :active_record_dynamic_timeout
+
+    included do
+      set_callback :checkin, :before, :reset_dynamic_timeout_for_checkin, prepend: true
+    end
+
+    def supports_dynamic_timeouts?
+      false
+    end
+
+    def set_dynamic_timeout(raw_connection, timeout)
+      return unless supports_dynamic_timeouts?
+      return if active_record_dynamic_timeout == timeout
+      if timeout.nil?
+        reset_dynamic_timeout(raw_connection)
+      else
+        set_connection_timeout(raw_connection, timeout)
+        self.active_record_dynamic_timeout = timeout
+      end
+    end
+
+    def reset_dynamic_timeout(raw_connection)
+      return unless supports_dynamic_timeouts?
+      return if active_record_dynamic_timeout.nil?
+      reset_connection_timeout(raw_connection)
+      self.active_record_dynamic_timeout = nil
+    end
+  end
+
+  module TimeoutAdapterExtension
+    def with_raw_connection(*args, **kwargs, &block)
+      super do |raw_connection|
+        set_dynamic_timeout(raw_connection, ActiveRecord::Base.current_timeout)
+        yield raw_connection
+      ensure
+        if timeout_set_client_side?
+          reset_dynamic_timeout(raw_connection)
+        end
+      end
+    end
+
+    # This ensures new connections from reconnects have the correct timeout.
+    def configure_connection
+      super
+      if active_record_dynamic_timeout && !timeout_set_client_side?
+        set_connection_timeout(@raw_connection, active_record_dynamic_timeout)
+      end
+    end
+
+    def reset_dynamic_timeout_for_checkin
+      if active_record_dynamic_timeout
+        with_raw_connection do |conn|
+          reset_dynamic_timeout(conn)
+        end
+      end
+    end
+  end
+
+  module TimeoutAdapterExtension_Rails_7_0
+    def log(*args, **kwargs, &block)
+      super do
+        set_dynamic_timeout(@connection, ActiveRecord::Base.current_timeout)
+        yield
+      ensure
+        if timeout_set_client_side?
+          reset_dynamic_timeout(@connection)
+        end
+      end
+    end
+
+    # This ensures new connections from reconnects have the correct timeout.
+    def configure_connection
+      super
+      if active_record_dynamic_timeout && !timeout_set_client_side?
+        set_connection_timeout(@connection, active_record_dynamic_timeout)
+      end
+    end
+
+    def reset_dynamic_timeout_for_checkin
+      if @connection
+        reset_dynamic_timeout(@connection)
+      end
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/extensions/base_extension.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+
+module ActiveRecord::DynamicTimeout
+  module BaseExtension
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def with_timeout(timeout)
+        (timeout.is_a?(Integer) || timeout.nil?) or raise ArgumentError, "timeout must be an Integer or NilClass, got: `#{timeout.inspect}`"
+        timeout_stack << timeout
+        yield
+      ensure
+        timeout_stack.pop
+      end
+
+      def current_timeout
+        timeout_stack.last
+      end
+
+      # @param [Class] scope_class
+      def timeout_isolation_scope=(scope_class)
+        (scope_class == Thread || scope_class == Fiber) or raise ArgumentError, "scope must be `Thread` or `Fiber`, got: `#{scope_class.inspect}`"
+        raise ArgumentError, "timeout_isolation_scope can only be set once" if @timeout_isolation_scope
+        @timeout_isolation_scope = scope_class
+      end
+
+      private
+
+      def timeout_stack
+        if (stack = timeout_isolation_state[:active_record_dynamic_timeout_stack])
+          stack
+        else
+          stack = []
+          timeout_isolation_state[:active_record_dynamic_timeout_stack] = stack
+          stack
+        end
+      end
+
+      def timeout_isolation_state
+        if timeout_isolation_scope == Thread
+          Thread.current.thread_variable_get(:ar_dynamic_timeout_execution_state) ||
+            Thread.current.thread_variable_set(:ar_dynamic_timeout_execution_state, {})
+        else
+          # Thread.current[] is Fiber local
+          Thread.current[:ar_dynamic_timeout_execution_state] ||= {}
+        end
+      end
+
+      def timeout_isolation_scope
+        @timeout_isolation_scope
+      end
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/extensions/mysql2_adapter_extension.rb

@@ -0,0 +1,28 @@
+module ActiveRecord::DynamicTimeout
+  module Mysql2AdapterExtension
+    def set_connection_timeout(raw_connection, timeout)
+      set_timeouts_on_connection(raw_connection, read_timeout: timeout, write_timeout: timeout)
+    end
+
+    def reset_connection_timeout(raw_connection)
+      read_timeout = Integer(@config[:read_timeout]) unless @config[:read_timeout].nil?
+      write_timeout = Integer(@config[:write_timeout]) unless @config[:write_timeout].nil?
+      set_timeouts_on_connection(raw_connection, read_timeout:, write_timeout:)
+    end
+
+    def timeout_set_client_side?
+      true
+    end
+
+    def supports_dynamic_timeouts?
+      true
+    end
+
+    private
+
+    def set_timeouts_on_connection(raw_connection, read_timeout:, write_timeout:)
+      raw_connection.instance_variable_set(:@read_timeout, read_timeout)
+      raw_connection.instance_variable_set(:@write_timeout, write_timeout)
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/extensions/postgres_adapter_extension.rb

@@ -0,0 +1,32 @@
+module ActiveRecord::DynamicTimeout
+  module PostgresAdapterExtension
+    def set_connection_timeout(raw_connection, timeout)
+      if timeout.nil? || timeout == ":default" || timeout == :default
+        raw_connection.query("SET SESSION statement_timeout TO DEFAULT")
+      else
+        raw_connection.query("SET SESSION statement_timeout TO #{quote(timeout)}")
+      end
+    end
+
+    def reset_connection_timeout(raw_connection)
+      set_connection_timeout(raw_connection, default_statement_timeout)
+    end
+
+    def timeout_set_client_side?
+      false
+    end
+
+    def supports_dynamic_timeouts?
+      true
+    end
+
+    private
+
+    def default_statement_timeout
+      unless defined?(@default_statement_timeout)
+        @default_statement_timeout = @config.fetch(:variables, {}).stringify_keys["statement_timeout"]
+      end
+      @default_statement_timeout
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/extensions/sqlite_adapter_extension.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActiveRecord::DynamicTimeout
+  module SqliteAdapterExtension
+    def set_connection_timeout(raw_connection, timeout)
+      if timeout
+        raw_connection.busy_timeout(timeout)
+      else
+        raw_connection.busy_timeout(0)
+      end
+    end
+
+    def reset_connection_timeout(raw_connection)
+      timeout = @config[:timeout]
+      set_connection_timeout(raw_connection, self.class.type_cast_config_to_integer(timeout))
+    end
+
+    def timeout_set_client_side?
+      false
+    end
+
+    def supports_dynamic_timeouts?
+      true
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/extensions/trilogy_adapter_extension.rb

@@ -0,0 +1,28 @@
+module ActiveRecord::DynamicTimeout
+  module TrilogyAdapterExtension
+    def set_connection_timeout(raw_connection, timeout)
+      set_timeouts_on_connection(raw_connection, read_timeout: timeout, write_timeout: timeout)
+    end
+
+    def reset_connection_timeout(raw_connection)
+      read_timeout = @config[:read_timeout]
+      write_timeout = @config[:write_timeout]
+      set_timeouts_on_connection(raw_connection, read_timeout:, write_timeout:)
+    end
+
+    def timeout_set_client_side?
+      true
+    end
+
+    def supports_dynamic_timeouts?
+      true
+    end
+
+    private
+
+    def set_timeouts_on_connection(raw_connection, read_timeout:, write_timeout:)
+      raw_connection.read_timeout = read_timeout
+      raw_connection.write_timeout = write_timeout
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/initializer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support"
+require_relative "../dynamic_timeout"
+require_relative "extensions/base_extension"
+require_relative "extensions/abstract_adapter_extension"
+require_relative "extensions/mysql2_adapter_extension"
+require_relative "extensions/trilogy_adapter_extension"
+require_relative "extensions/sqlite_adapter_extension"
+require_relative "extensions/postgres_adapter_extension"
+
+module ActiveRecord::DynamicTimeout
+  module Initializer
+    class << self
+      def initialize!
+        ActiveRecord::Base.include(ActiveRecord::DynamicTimeout::BaseExtension)
+        ActiveRecord::Base.connection.class.include(ActiveRecord::DynamicTimeout::AbstractAdapterExtension)
+
+        if ActiveRecord.gem_version < "7.1"
+          ActiveRecord::Base.connection.class.prepend(ActiveRecord::DynamicTimeout::TimeoutAdapterExtension_Rails_7_0)
+        else
+          ActiveRecord::Base.connection.class.prepend(ActiveRecord::DynamicTimeout::TimeoutAdapterExtension)
+        end
+        register_adapter_extension(ActiveRecord::Base.connection.class)
+      end
+
+      def register_adapter_extension(adapter_class)
+        extension = case adapter_class.name
+                    when "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
+                      ActiveRecord::DynamicTimeout::Mysql2AdapterExtension
+                    when "ActiveRecord::ConnectionAdapters::TrilogyAdapter"
+                      ActiveRecord::DynamicTimeout::TrilogyAdapterExtension
+                    when "ActiveRecord::ConnectionAdapters::SQLite3Adapter"
+                      ActiveRecord::DynamicTimeout::SqliteAdapterExtension
+                    when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
+                      ActiveRecord::DynamicTimeout::PostgresAdapterExtension
+                    end
+        adapter_class.prepend(extension) if extension
+      end
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "initializer"
+
+module ActiveRecord::DynamicTimeout
+  class Railtie < Rails::Railtie
+    initializer "active_record-dynamic_timeout.initialize", after: "active_record.initialize_database" do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::DynamicTimeout::Initializer.initialize!
+      end
+    end
+  end
+end

data/lib/active_record/dynamic_timeout/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module DynamicTimeout
+    VERSION = '0.0.1.rc1'
+  end
+end

data/lib/active_record/dynamic_timeout.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support"
+
+module ActiveRecord
+  module DynamicTimeout
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-dynamic_timeout
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc1
+platform: ruby
+authors:
+- Tristan Starck
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: ActiveRecord extension for dynamically setting connection timeouts
+email:
+- tstarck@invoca.com
+- Invoca Development
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- activerecord-dynamic_timeout.gemspec
+- lib/active_record/dynamic_timeout.rb
+- lib/active_record/dynamic_timeout/extensions/abstract_adapter_extension.rb
+- lib/active_record/dynamic_timeout/extensions/base_extension.rb
+- lib/active_record/dynamic_timeout/extensions/mysql2_adapter_extension.rb
+- lib/active_record/dynamic_timeout/extensions/postgres_adapter_extension.rb
+- lib/active_record/dynamic_timeout/extensions/sqlite_adapter_extension.rb
+- lib/active_record/dynamic_timeout/extensions/trilogy_adapter_extension.rb
+- lib/active_record/dynamic_timeout/initializer.rb
+- lib/active_record/dynamic_timeout/railtie.rb
+- lib/active_record/dynamic_timeout/version.rb
+homepage: https://github.com/Invoca/activerecord-dynamic_timeout
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/Invoca/activerecord-dynamic_timeout
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: ActiveRecord extension for dynamically setting connection timeouts
+test_files: []