activerecord-pg-extensions 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b240f7e9306ba57d7f52add8cef37ebe735e2f3d900d328d7cfb2e22fe1fcc6
-  data.tar.gz: 04b62ecf9b4c250e2f664f1a0be0c71baac1b6f5d117dc8d45f08bb7b7100459
+  metadata.gz: 3494201ce01b5c6d5104ae9ddb7f993310223ecc94bd902b2484ce6b6a4e525b
+  data.tar.gz: acd5b4c842cbfc275b2a86f009c048e7916709803f3d72c9ed40f42095c47a7d
 SHA512:
-  metadata.gz: c5a1ae9925eb093ea81424574d409186c85ef2474b1cc2a38f388757ff4e94a8b3893ca7e582e5010e8dbe8915a2e499d1600103c12936169d0447703b5c8d68
-  data.tar.gz: 256b8740a417e1bcc84a7edd23663da83543aa412a7221ae2a818721dd04a16b7ccf3f06915cb625d50f95ecb55ccd0719e1d8204441294dd9860ba25cb54b6a
+  metadata.gz: 91625c727722fb91aa1860960a3f9c5ba7ba4dcab0a0cf459e6b8301a7fa734ff91882f5ae31ac4cb492218eaf17205ed97e54236cf8760d55b6c33b4cd3f7dc
+  data.tar.gz: fbe3e4a073f7f646438b07f1226e5c654a744c3efb421ea38b9c7b7adc5cf9e173fbab479780f765cc41f3c9144294d1ac16fe7f140e68bcdf44128a0bcafd68

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.0] - 2021-09-29
+
+- Deprecate with_statement_timeout
+- Add statement_timeout, lock_timeout, and idle_in_transaction_session_timeout
 ## [0.2.3] - 2021-06-23
 
 - Fix extension_available?

data/lib/active_record/pg_extensions/errors.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  class QueryTimeout < ActiveRecord::StatementInvalid; end
+  # @deprecated just use QueryCanceled
+  QueryTimeout = QueryCanceled
 end

data/lib/active_record/pg_extensions/postgresql_adapter.rb

@@ -236,15 +236,41 @@ module ActiveRecord
         select_value("SELECT pg_is_in_recovery()")
       end
 
-      def with_statement_timeout(timeout = nil)
+      def set(configuration_parameter, value, local: false)
+        value = value.nil? ? "DEFAULT" : quote(value)
+        execute("SET#{' LOCAL' if local} #{configuration_parameter} TO #{value}")
+      end
+
+      def reset(configuration_parameter)
+        execute("RESET #{configuration_parameter}")
+      end
+
+      TIMEOUTS = %i[lock_timeout statement_timeout idle_in_transaction_session_timeout].freeze
+
+      TIMEOUTS.each do |kind|
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{kind}
+            current_transaction.#{kind}
+          end
+
+          def #{kind}=(timeout)
+            raise ArgumentError, "Timeouts can only be set inside of a transaction" unless current_transaction.open?
+
+            current_transaction.send(:#{kind}=, timeout)
+          end
+        RUBY
+      end
+
+      # @deprecated: manage the transaction yourself and set statement_timeout directly
+      #
+      # otherwise, if you're already in a transaction, or you nest with_statement_timeout,
+      # the value will unexpectedly "stick" even after the block returns
+      def with_statement_timeout(timeout)
         timeout = 30 if timeout.nil? || timeout == true
+
         transaction do
-          execute("SET LOCAL statement_timeout=#{(timeout * 1000).to_i}")
+          self.statement_timeout = timeout
           yield
-        rescue ActiveRecord::StatementInvalid => e
-          raise ActiveRecord::QueryTimeout.new(sql: e.sql, binds: e.binds) if e.cause.is_a?(PG::QueryCanceled)
-
-          raise
         end
       end
 

data/lib/active_record/pg_extensions/railtie.rb

@@ -10,8 +10,11 @@ module ActiveRecord
         ActiveSupport.on_load(:active_record) do
           require "active_record/pg_extensions/errors"
           require "active_record/pg_extensions/postgresql_adapter"
+          require "active_record/pg_extensions/transaction"
 
-          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(PostgreSQLAdapter)
+          ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(PostgreSQLAdapter)
+          ::ActiveRecord::ConnectionAdapters::NullTransaction.prepend(NullTransaction)
+          ::ActiveRecord::ConnectionAdapters::Transaction.prepend(Transaction)
           # if they've already require 'all', then inject now
           defined?(All) && All.inject
         end

data/lib/active_record/pg_extensions/transaction.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PGExtensions
+    # Contains general additions to Transaction
+    module Transaction
+      PostgreSQLAdapter::TIMEOUTS.each do |kind|
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{kind}(local: false)
+            return @#{kind} if local
+            @#{kind} || parent_transaction.#{kind}
+          end
+
+          private def #{kind}=(timeout)
+            return if @#{kind} == timeout
+
+            @#{kind} = timeout
+            return unless materialized?
+            connection.set(#{kind.inspect}, "\#{timeout}s", local: true)
+          end
+        RUBY
+      end
+
+      def materialize!
+        PostgreSQLAdapter::TIMEOUTS.each do |kind|
+          next if (timeout = send(kind, local: true)).nil?
+
+          connection.set(kind, "#{timeout}s", local: true)
+        end
+        super
+      end
+    end
+
+    # Contains general additions to NullTransaction
+    module NullTransaction
+      PostgreSQLAdapter::TIMEOUTS.each do |kind|
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{kind}
+            nil
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/active_record/pg_extensions/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module PGExtensions
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/postgresql_adapter_spec.rb

@@ -270,12 +270,20 @@ describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
   end
 
   describe "#with_statement_timeout" do
+    around do |example|
+      # these specs were written before we supported deferring setting timeouts
+      # until the transaction materializes
+      connection.disable_lazy_transactions!
+      example.call
+      connection.enable_lazy_transactions!
+    end
+
     it "stops long-running queries" do
       expect do
         connection.with_statement_timeout(0.01) do
           connection.execute("SELECT pg_sleep(3)")
         end
-      end.to raise_error(ActiveRecord::QueryTimeout)
+      end.to raise_error(ActiveRecord::QueryCanceled)
     end
 
     it "re-raises other errors" do
@@ -283,16 +291,20 @@ describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
         connection.with_statement_timeout(1) do
           connection.execute("bad sql")
         end
-      end.to raise_error(ActiveRecord::StatementInvalid)
+      end.to(raise_error { |e| expect(e.cause).to be_a(PG::SyntaxError) })
     end
 
     context "without executing" do
+      around do |example|
+        connection.dont_execute(&example)
+      end
+
       it "converts integer to ms" do
         connection.with_statement_timeout(30) { nil }
         expect(connection.executed_statements).to eq(
           [
             "BEGIN",
-            "SET LOCAL statement_timeout=30000",
+            "SET LOCAL statement_timeout TO '30s'",
             "COMMIT"
           ]
         )
@@ -303,7 +315,7 @@ describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
         expect(connection.executed_statements).to eq(
           [
             "BEGIN",
-            "SET LOCAL statement_timeout=5500",
+            "SET LOCAL statement_timeout TO '5.5s'",
             "COMMIT"
           ]
         )
@@ -314,7 +326,7 @@ describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
         expect(connection.executed_statements).to eq(
           [
             "BEGIN",
-            "SET LOCAL statement_timeout=5000",
+            "SET LOCAL statement_timeout TO '5s'",
             "COMMIT"
           ]
         )
@@ -325,7 +337,7 @@ describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
         expect(connection.executed_statements).to eq(
           [
             "BEGIN",
-            "SET LOCAL statement_timeout=30000",
+            "SET LOCAL statement_timeout TO '30s'",
             "COMMIT"
           ]
         )
@@ -333,6 +345,81 @@ describe ActiveRecord::ConnectionAdapters::PostgreSQLAdapter do
     end
   end
 
+  describe "#statement_timeout=" do
+    around do |example|
+      connection.dont_execute(&example)
+    end
+
+    it "raises if a transaction isn't active" do
+      expect { connection.statement_timeout = 30 }.to raise_error(ArgumentError)
+    end
+
+    it "does nothing if the transaction never materializes" do
+      connection.transaction do
+        connection.statement_timeout = 30
+        expect(connection.statement_timeout).to eq 30
+      end
+      expect(connection.statement_timeout).to be_nil
+
+      expect(connection.executed_statements).to be_empty
+    end
+
+    it "sets the timeout if the transaction is materialized" do
+      connection.transaction do
+        connection.select_value("SELECT 1")
+        connection.statement_timeout = 30
+        expect(connection.statement_timeout).to eq 30
+      end
+      expect(connection.statement_timeout).to be_nil
+
+      expect(connection.executed_statements).to eq(
+        ["BEGIN",
+         "SELECT 1",
+         "SET LOCAL statement_timeout TO '30s'",
+         "COMMIT"]
+      )
+    end
+
+    it "sets the timeout if the transaction materializes" do
+      connection.transaction do
+        connection.statement_timeout = 30
+        connection.select_value("SELECT 1")
+        expect(connection.statement_timeout).to eq 30
+      end
+      expect(connection.statement_timeout).to be_nil
+
+      expect(connection.executed_statements).to eq(
+        ["BEGIN",
+         "SET LOCAL statement_timeout TO '30s'",
+         "SELECT 1",
+         "COMMIT"]
+      )
+    end
+
+    it "works with nested transactions" do
+      connection.transaction do
+        connection.statement_timeout = 30
+        connection.transaction(requires_new: true) do
+          connection.statement_timeout = 15
+          connection.select_value("SELECT 1")
+          expect(connection.statement_timeout).to eq 15
+        end
+        expect(connection.statement_timeout).to eq 30
+      end
+      expect(connection.statement_timeout).to be_nil
+
+      expect(connection.executed_statements).to eq(
+        ["BEGIN",
+         "SET LOCAL statement_timeout TO '30s'",
+         "SAVEPOINT active_record_1",
+         "SET LOCAL statement_timeout TO '15s'",
+         "SELECT 1",
+         "RELEASE SAVEPOINT active_record_1",
+         "COMMIT"]
+      )
+    end
+  end
+
   unless Rails.version >= "6.1"
     describe "#add_check_constraint" do
       around do |example|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg-extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -180,6 +180,7 @@ files:
 - lib/active_record/pg_extensions/pessimistic_migrations.rb
 - lib/active_record/pg_extensions/postgresql_adapter.rb
 - lib/active_record/pg_extensions/railtie.rb
+- lib/active_record/pg_extensions/transaction.rb
 - lib/active_record/pg_extensions/version.rb
 - lib/activerecord-pg-extensions.rb
 - spec/pessimistic_migrations_spec.rb