statement_timeout 1.0.0.pre.rc.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42943a4a7aaa58ea1d0111e663391f30e8781dee8d220ad8db2ad011b1efda3
-  data.tar.gz: c585bf0781f46e562b3947c0813c478ba6d14e038d9c0f876ba27dd0ee0fe4be
+  metadata.gz: e0a38e0ec0dab300f6ddfbc11f8af5f7ef60d5af3083435e1c8cfa869b779197
+  data.tar.gz: 28fc70d816752e5399cc69574c11b6d73200e85fe6c6700ed7d6caa5a75af84f
 SHA512:
-  metadata.gz: 66a2345bbb4088bdebd6fe59327c5550b4d114e6edac342d4778641a081184cd5a7e5d0bfec6db4d5e07be71acf9f9abbd727a0b665725b916f41f6798742641
-  data.tar.gz: 566f9e844756d16d3d85da9a31a35a5c52b52969cf8acf95879dbf04c915e1eb974b7bc1c5d8c4e3fa0902be25885cf24ce67375ac10bb3dd0b373674d45606c
+  metadata.gz: b7dee7d2c5dc5ff99d0f8d12616b834cc7ac05e472b3ed1dcddb8854003fd33b2256d439b8fbc9c6a74d4e6fedbfacb892b51987bfc66fe0179f500b951e65de
+  data.tar.gz: 46dd7481f5a302ec553a0e01b2f018dedb577d607f312aff48e9c52357986f94bef84edd92ab3ec88f8fca4d1925f4cdeb902195bb214835859eb3d0a2016c3a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
 # Changelog
 
-## [Unreleased]
+## v1.1.0
+
+- Add support for transaction `:mode`, useful in cases where a PgBouncer is in
+  sitting front of Postgres and in transaction mode. In this case, the default
+  session-based `SET statement_timeout = ...` will not work consistently.
+
+## v1.0.0
+
+Initial release.

data/README.md

@@ -38,6 +38,17 @@ Or install it yourself as:
 $ gem install statement_timeout
 ```
 
+## Configuration
+
+```ruby
+StatementTimeout.configure do |config|
+  # When using a connection pooler like PgBouncer while in transaction mode, it
+  # is required that you change the default mode from :session to :transaction
+  # otherwise the statement timeouts may be SET on the right connection.
+  config.default_mode = :transaction
+end
+```
+
 ## Usage
 
 ```ruby
@@ -49,16 +60,15 @@ User.posts.statement_timeout 10.seconds do
   some_cheap_operation
 end
 
+Post.statement_timeout 10.minutes do |conn|
+  conn.transaction { archive_old_posts }
+end
+
 Tag.statement_timeout 6.hours do |conn|
   conn.execute 'VACUUM ANALYZE tags'
 end
 ```
 
-## Future
-
-Right now, the gem only supports RSpec, but we're open to pull requests that
-extend the functionality to other testing frameworks.
-
 ## Supported databases
 
 We currently support PostgreSQL. We'd love contributions that add MySQL,

data/lib/statement_timeout/configuration.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module StatementTimeout
+  class Configuration
+    class_attribute :default_mode
+    self.default_mode = :session
+  end
+end

data/lib/statement_timeout/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StatementTimeout
-  VERSION = '1.0.0-rc.1'
+  VERSION = '1.1.0'
 end

data/lib/statement_timeout.rb

@@ -3,6 +3,7 @@
 require 'active_support'
 require 'active_record'
 
+require_relative 'statement_timeout/configuration'
 require_relative 'statement_timeout/version'
 require_relative 'statement_timeout/railtie'
 
@@ -10,23 +11,35 @@ module StatementTimeout
   module AbstractAdapterExtension
     def supports_statement_timeout? = false
     def statement_timeout           = raise NotImplementedError
+
     def statement_timeout=(timeout)
       raise NotImplementedError
     end
+
+    def local_statement_timeout=(timeout)
+      raise NotImplementedError
+    end
   end
 
   module PostgreSQLAdapterExtension
     def supports_statement_timeout? = true
     def statement_timeout           = @statement_timeout ||= query_value("SHOW statement_timeout")
+
     def statement_timeout=(timeout)
       @statement_timeout = nil
 
       internal_exec_query("SET statement_timeout = #{quote(timeout)}")
     end
+
+    def local_statement_timeout=(timeout)
+      @statement_timeout = nil
+
+      internal_exec_query("SET LOCAL statement_timeout = #{quote(timeout)}")
+    end
   end
 
   module QueryMethodsExtension
-    def statement_timeout(timeout)
+    def statement_timeout(timeout, mode: StatementTimeout.config.default_mode)
       timeout = if timeout in ActiveSupport::Duration
                   timeout.in_milliseconds
                 else
@@ -37,11 +50,26 @@ module StatementTimeout
         raise ActiveRecord::AdapterError, "statement_timeout is not supported for the #{connection.class.inspect} adapter" unless
           connection.supports_statement_timeout?
 
-        statement_timeout_was, connection.statement_timeout = connection.statement_timeout, timeout
+        case mode
+        when :transaction
+          connection.transaction do
+            statement_timeout_was, connection.local_statement_timeout = connection.statement_timeout, timeout
 
-        yield connection
-      ensure
-        connection.statement_timeout = statement_timeout_was
+            yield connection
+          ensure
+            connection.local_statement_timeout = statement_timeout_was
+          end
+        when :session
+          begin
+            statement_timeout_was, connection.statement_timeout = connection.statement_timeout, timeout
+
+            yield connection
+          ensure
+            connection.statement_timeout = statement_timeout_was
+          end
+        else
+          raise ArgumentError, "mode is not supported: #{mode.inspect}"
+        end
       end
     end
   end
@@ -49,5 +77,10 @@ module StatementTimeout
   module QueryingExtension
     delegate :statement_timeout, to: :all
   end
+
+  def self.config = @config ||= Configuration.new
+  def self.configure
+    yield config
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statement_timeout
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2025-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -121,6 +121,7 @@ files:
 - README.md
 - SECURITY.md
 - lib/statement_timeout.rb
+- lib/statement_timeout/configuration.rb
 - lib/statement_timeout/railtie.rb
 - lib/statement_timeout/version.rb
 homepage: https://github.com/keygen-sh/statement_timeout
@@ -138,11 +139,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Wrap an Active Record transaction or query in a local statement timeout.