sequel-activerecord_connection 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 929f5047395464d1d3616aeab41742b6766ae14b96ca1f5b7ac47bb1991f3391
-  data.tar.gz: c931c23d71b73ce2bb35118e1d02ecc2df529f2c297b995c9c5ee46c5b0bfe85
+  metadata.gz: 4bb2b81760b45990a9bea2801f8a243cfc180853ad450d652cf888cd45844033
+  data.tar.gz: 73ae4c6341a3c694423b4e20da86f01cce3324d37a9a29143eb2f2e420d45288
 SHA512:
-  metadata.gz: 062f919b4268a57e392bad5dd7d4a988adc90a8df2d4076f5abfa9afe7c125534f9e7ad1ca16733d0539e622f2b988f95d4653d6b076cd356809d95daf1c24d2
-  data.tar.gz: 1f1efabd6b3ae74c6d35b3d0a23ad87a9d1c939e209afc2f24267840c6c72b2ff60fb1ca86010335b65a251c3c57fa81b300aa4cf38b9ad49df53b00f931d89f
+  metadata.gz: 4e27142472fabc36703d3cca6828e005858d60088a88bbb8f78c58dba5f6e9a2b2ae349ff6d39451558d7dd3e4e32e92d49818af88af9bb6bc18a522c283bc38
+  data.tar.gz: 6dff47d6fe0adf995dc3738e932bda92b15279b56bdf22750e6c42058031ca2b2f152e26cd80b2a09e3be460a1be8695a3645df8a2bcd4a87430ebfc3243fa98

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## 1.2.2 (2021-01-11)
+
+* Ensure Active Record queries inside a Sequel transaction are typemapped correctly in postgres adapter (@janko)
+
+* Fix executing Active Record queries inside a Sequel transaction not working in mysql2 adapter (@janko)
+
+## 1.2.1 (2021-01-10)
+
+* Fix original mysql2 query options not being restored after nested `DB#synchronize` calls, e.g. when using Sequel transactions (@janko)
+
+## 1.2.0 (2020-11-15)
+
+* Attempt support for [activerecord-sqlserver-adapter](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter) (@janko)
+
+* Attempt support for [oracle-enhanced](https://github.com/rsim/oracle-enhanced) Active Record adapter (@janko)
+
+## 1.1.0 (2020-11-08)
+
+* Drop support for Ruby 2.2 (@janko)
+
+* Support transaction/savepoint hooks even when Active Record holds the transaction/savepoint (@janko)
+
+* Don't test the connection on `Sequel.connect` by default (@janko)
+
+## 1.0.1 (2020-10-28)
+
+* Use Active Record connection lock in `Database#synchronize` (@janko)
+
 ## 1.0.0 (2020-10-25)
 
 * Clear AR statement cache on `ActiveRecord::PreparedStatementCacheExpired` when Sequel holds the transaction (@janko)

data/README.md

@@ -1,25 +1,25 @@
-# Sequel::ActiveRecordConnection
+# sequel-activerecord_connection
 
 This is an extension for [Sequel] that allows it to reuse an existing
-ActiveRecord connection for database interaction. It works on ActiveRecord 4.2
-or higher, and supports the built-in `postgresql`, `mysql2` and `sqlite3`
-adapters, as well as JDBC adapter for JRuby.
+ActiveRecord connection for database interaction.
 
 This can be useful if you're using a library that uses Sequel for database
-interaction (e.g. [Rodauth]), but you want to avoid creating a separate
-database connection. Or if you're transitioning from ActiveRecord to Sequel,
-and want the database connection to be shared.
+interaction (e.g. [Rodauth] or [rom-sql]), but you want to avoid creating a
+separate database connection. Or if you're transitioning from ActiveRecord to
+Sequel, and want the database connection to be shared.
 
-Note that this is a best-effort implementation, so some discrepancies are still
-possible. That being said, this implementation passes Rodauth's test suite
-(for all adapters), which has some fairly advanced Sequel usage.
+It works on ActiveRecord 4.2+ and fully supports PostgresSQL, MySQL and SQLite
+adapters, both the native ones and JDBC (JRuby). There is attempted suppport
+for [Oracle enhanced] and [SQL Server] Active Record adapters (`oracle` and
+`tinytds` in Sequel). Other adapters might work too, but their integration
+hasn't been tested.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem "sequel-activerecord_connection", "~> 0.3"
+```rb
+gem "sequel-activerecord_connection", "~> 1.0"
 ```
 
 And then execute:
@@ -111,31 +111,71 @@ DB.transaction(isolation: :serializable) do
 end
 ```
 
-One caveat to keep in mind is that using Sequel's transaction/savepoint hooks
-currently don't work if ActiveRecord holds the corresponding
-transaction/savepoint. This is because it's difficult to be notified when
-ActiveRecord commits or rolls back the transaction/savepoint.
+When registering transaction hooks, they will be registered on Sequel
+transactions when possible, in which case they will behave as described in the
+[Sequel docs][sequel transaction hooks].
 
 ```rb
+# Sequel: An after_commit transaction hook will always get executed if the outer
+# transaction commits, even if it's added inside a savepoint that's rolled back.
 DB.transaction do
-  DB.after_commit { ... } # will get executed
+  ActiveRecord::Base.transaction(requires_new: true) do
+    DB.after_commit { puts "after commit" }
+    raise ActiveRecord::Rollback
+  end
 end
-
-DB.transaction do
-  DB.transaction(savepoint: true) do
-    DB.after_commit(savepoint: true) { ... } # will get executed
+#>> BEGIN
+#>> SAVEPOINT active_record_1
+#>> ROLLBACK TO SAVEPOINT active_record_1
+#>> COMMIT
+#>> after commit
+
+# Sequel: An after_commit savepoint hook will get executed only after the outer
+# transaction commits, given that all enclosing savepoints have been released.
+DB.transaction(auto_savepoint: true) do
+  DB.transaction do
+    DB.after_commit(savepoint: true) { puts "after commit" }
+    raise Sequel::Rollback
   end
 end
+#>> BEGIN
+#>> SAVEPOINT active_record_1
+#>> RELEASE SAVEPOINT active_record_1
+#>> COMMIT
+#>> after commit
+```
 
+In case of (a) adding a transaction hook while Active Record holds the
+transaction, or (b) adding a savepoint hook when Active Record holds any
+enclosing savepoint, Active Record transaction callbacks will be used instead
+of Sequel hooks, which have slightly different behaviour in some circumstances.
+
+```rb
+# ActiveRecord: An after_commit transaction callback is not executed if any
+# if the enclosing savepoints have been rolled back
 ActiveRecord::Base.transaction do
-  DB.after_commit { ... } # not allowed (will raise Sequel::ActiveRecordConnection::Error)
+  DB.transaction(savepoint: true) do
+    DB.after_commit { puts "after commit" }
+    raise Sequel::Rollback
+  end
 end
-
-DB.transaction do
-  ActiveRecord::Base.transaction(requires_new: true) do
-    DB.after_commit(savepoint: true) { ... } # not allowed (will raise Sequel::ActiveRecordConnection::Error)
+#>> BEGIN
+#>> SAVEPOINT active_record_1
+#>> ROLLBACK TO SAVEPOINT active_record_1
+#>> COMMIT
+
+# ActiveRecord: An after_commit transaction callback can be executed already
+# after a savepoint is released, if the enclosing transaction is not joinable.
+ActiveRecord::Base.transaction(joinable: false) do
+  DB.transaction do
+    DB.after_commit { puts "after commit" }
   end
 end
+#>> BEGIN
+#>> SAVEPOINT active_record_1
+#>> RELEASE SAVEPOINT active_record_1
+#>> after commit
+#>> COMMIT
 ```
 
 ### Model
@@ -185,3 +225,7 @@ Everyone interacting in this project's codebases, issue trackers, chat rooms and
 
 [Sequel]: https://github.com/jeremyevans/sequel
 [Rodauth]: https://github.com/jeremyevans/rodauth
+[rom-sql]: https://github.com/rom-rb/rom-sql
+[sequel transaction hooks]: http://sequel.jeremyevans.net/rdoc/files/doc/transactions_rdoc.html#label-Transaction+Hooks
+[Oracle enhanced]: https://github.com/rsim/oracle-enhanced
+[SQL Server]: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter

data/lib/sequel/extensions/activerecord_connection.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "after_commit_everywhere"
+
 module Sequel
   module ActiveRecordConnection
     Error = Class.new(Sequel::Error)
@@ -11,8 +13,11 @@ module Sequel
       serializable: :serializable,
     }
 
+    ACTIVERECORD_CALLBACKS = Object.new.extend(AfterCommitEverywhere)
+
     def self.extended(db)
       db.activerecord_model = ActiveRecord::Base
+      db.opts[:test] = false unless db.opts.key?(:test)
 
       begin
         require "sequel/extensions/activerecord_connection/#{db.adapter_scheme}"
@@ -31,7 +36,9 @@ module Sequel
 
     # Avoid calling Sequel's connection pool, instead use Active Record's.
     def synchronize(*)
-      yield activerecord_connection.raw_connection
+      activerecord_lock do
+        yield activerecord_connection.raw_connection
+      end
     end
 
     # Log executed queries into Active Record logger as well.
@@ -95,20 +102,41 @@ module Sequel
       activerecord_connection.rollback_transaction
     end
 
+    # When Active Record holds the transaction, we cannot use Sequel hooks,
+    # because Sequel doesn't have knowledge of when the transaction is
+    # committed. So in this case we register an Active Record hook using the
+    # after_commit_everywhere gem.
     def add_transaction_hook(conn, type, block)
       if _trans(conn)[:activerecord]
-        fail Error, "cannot add transaction hook when ActiveRecord holds the outer transaction"
+        ACTIVERECORD_CALLBACKS.public_send(type, &block)
+      else
+        super
       end
-
-      super
     end
 
+    # When Active Record holds the savepoint, we cannot use Sequel hooks,
+    # because Sequel doesn't have knowledge of when the savepoint is
+    # released. So in this case we register an Active Record hook using the
+    # after_commit_everywhere gem.
     def add_savepoint_hook(conn, type, block)
       if _trans(conn)[:savepoints].last[:activerecord]
-        fail Error, "cannot add savepoint hook when ActiveRecord holds the current savepoint"
+        ACTIVERECORD_CALLBACKS.public_send(type, &block)
+      else
+        super
       end
+    end
 
-      super
+    # Active Record doesn't guarantee that a single connection can only be used
+    # by one thread at a time, so we need to use locking, which is what Active
+    # Record does internally as well.
+    def activerecord_lock
+      return yield if ActiveRecord.version < Gem::Version.new("5.1.0")
+
+      activerecord_connection.lock.synchronize do
+        ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+          yield
+        end
+      end
     end
 
     def activerecord_connection
@@ -124,25 +152,6 @@ module Sequel
         &block
       )
     end
-
-    module Utils
-      def self.set_value(object, name, new_value)
-        original_value = object.send(name)
-        object.send(:"#{name}=", new_value)
-        yield
-      ensure
-        object.send(:"#{name}=", original_value)
-      end
-
-      def self.add_prepared_statements_cache(conn)
-        return if conn.respond_to?(:prepared_statements)
-
-        class << conn
-          attr_accessor :prepared_statements
-        end
-        conn.prepared_statements = {}
-      end
-    end
   end
 
   Database.register_extension(:activerecord_connection, ActiveRecordConnection)

data/lib/sequel/extensions/activerecord_connection/jdbc.rb

@@ -9,7 +9,11 @@ module Sequel
 
       def synchronize(*)
         super do |conn|
-          yield conn.connection
+          if database_type == :oracle
+            yield conn.raw_connection
+          else
+            yield conn.connection
+          end
         end
       end
     end

data/lib/sequel/extensions/activerecord_connection/mysql2.rb

@@ -1,19 +1,30 @@
+require_relative "utils"
+
 module Sequel
   module ActiveRecordConnection
     module Mysql2
       def synchronize(*)
         super do |conn|
           # required for prepared statements
-          conn.instance_variable_set(:@sequel_default_query_options, conn.query_options.dup)
           Utils.add_prepared_statements_cache(conn)
 
-          conn.query_options.merge!(as: :hash, symbolize_keys: true, cache_rows: false)
+          yield conn
+        end
+      end
+
+      private
+
+      def _execute(conn, sql, opts)
+        if conn.instance_variable_defined?(:@sequel_default_query_options)
+          return super
+        end
 
-          begin
-            yield conn
-          ensure
-            conn.query_options.replace(conn.instance_variable_get(:@sequel_default_query_options))
-          end
+        conn.instance_variable_set(:@sequel_default_query_options, conn.query_options.dup)
+        conn.query_options.merge!(as: :hash, symbolize_keys: true, cache_rows: false)
+        begin
+          super
+        ensure
+          conn.query_options.replace(conn.remove_instance_variable(:@sequel_default_query_options))
         end
       end
     end

data/lib/sequel/extensions/activerecord_connection/oracle.rb

@@ -0,0 +1,16 @@
+require_relative "utils"
+
+module Sequel
+  module ActiveRecordConnection
+    module Oracle
+      def synchronize(*)
+        super do |conn|
+          # required for prepared statements
+          Utils.add_prepared_statements_cache(conn.raw_oci_connection)
+
+          yield conn.raw_oci_connection
+        end
+      end
+    end
+  end
+end

data/lib/sequel/extensions/activerecord_connection/postgres.rb

@@ -1,3 +1,5 @@
+require_relative "utils"
+
 module Sequel
   module ActiveRecordConnection
     module Postgres
@@ -8,9 +10,7 @@ module Sequel
 
           Utils.add_prepared_statements_cache(conn)
 
-          Utils.set_value(conn, :type_map_for_results, PG::TypeMapAllStrings.new) do
-            yield conn
-          end
+          yield conn
         end
       end
 
@@ -30,20 +30,12 @@ module Sequel
       module ConnectionMethods
         # The underlying exception classes to reraise as disconnect errors
         # instead of regular database errors.
-        DISCONNECT_ERROR_CLASSES = [IOError, Errno::EPIPE, Errno::ECONNRESET, ::PG::ConnectionBad].freeze
+        DISCONNECT_ERROR_CLASSES = Sequel::Postgres::Adapter::DISCONNECT_ERROR_CLASSES
 
         # Since exception class based disconnect checking may not work,
         # also trying parsing the exception message to look for disconnect
         # errors.
-        DISCONNECT_ERROR_REGEX = /\A#{Regexp.union([
-          "ERROR:  cached plan must not change result type",
-          "could not receive data from server",
-          "no connection to the server",
-          "connection not open",
-          "connection is closed",
-          "terminating connection due to administrator command",
-          "PQconsumeInput() "
-         ])}/
+        DISCONNECT_ERROR_REGEX = Sequel::Postgres::Adapter::DISCONNECT_ERROR_RE
 
         def async_exec_params(sql, args)
           defined?(super) ? super : async_exec(sql, args)
@@ -90,7 +82,9 @@ module Sequel
         # Return the PG::Result containing the query results.
         def execute_query(sql, args)
           @db.log_connection_yield(sql, self, args) do
-            args ? async_exec_params(sql, args) : async_exec(sql)
+            Utils.set_value(self, :type_map_for_results, PG::TypeMapAllStrings.new) do
+              args ? async_exec_params(sql, args) : async_exec(sql)
+            end
           end
         end
       end

data/lib/sequel/extensions/activerecord_connection/sqlite.rb

@@ -1,3 +1,5 @@
+require_relative "utils"
+
 module Sequel
   module ActiveRecordConnection
     module Sqlite
@@ -13,8 +15,16 @@ module Sequel
 
           Utils.add_prepared_statements_cache(conn)
 
+          yield conn
+        end
+      end
+
+      private
+
+      def _execute(type, sql, opts, &block)
+        synchronize(opts[:server]) do |conn|
           Utils.set_value(conn, :results_as_hash, nil) do
-            yield conn
+            super
           end
         end
       end

data/lib/sequel/extensions/activerecord_connection/tinytds.rb

@@ -0,0 +1,19 @@
+require_relative "utils"
+
+module Sequel
+  module ActiveRecordConnection
+    module Tinytds
+      def synchronize(*)
+        super do |conn|
+          conn.query_options.merge!(cache_rows: false)
+
+          begin
+            yield conn
+          ensure
+            conn.query_options.merge!(cache_rows: true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequel/extensions/activerecord_connection/utils.rb

@@ -0,0 +1,22 @@
+module Sequel
+  module ActiveRecordConnection
+    module Utils
+      def self.set_value(object, name, new_value)
+        original_value = object.send(name)
+        object.send(:"#{name}=", new_value)
+        yield
+      ensure
+        object.send(:"#{name}=", original_value)
+      end
+
+      def self.add_prepared_statements_cache(conn)
+        return if conn.respond_to?(:prepared_statements)
+
+        class << conn
+          attr_accessor :prepared_statements
+        end
+        conn.prepared_statements = {}
+      end
+    end
+  end
+end

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "1.0.0"
+  spec.version       = "1.2.2"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 
@@ -9,11 +9,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/janko/sequel-activerecord_connection"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.2.0")
+  spec.required_ruby_version = ">= 2.3"
 
   spec.add_dependency "sequel", "~> 5.16"
   spec.add_dependency "activerecord", ">= 4.2", "< 7"
+  spec.add_dependency "after_commit_everywhere", "~> 0.1.5"
 
+  spec.add_development_dependency "sequel", "~> 5.38"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "warning" if RUBY_VERSION >= "2.4"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -44,6 +44,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: after_commit_everywhere
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.38'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -85,8 +113,11 @@ files:
 - lib/sequel/extensions/activerecord_connection.rb
 - lib/sequel/extensions/activerecord_connection/jdbc.rb
 - lib/sequel/extensions/activerecord_connection/mysql2.rb
+- lib/sequel/extensions/activerecord_connection/oracle.rb
 - lib/sequel/extensions/activerecord_connection/postgres.rb
 - lib/sequel/extensions/activerecord_connection/sqlite.rb
+- lib/sequel/extensions/activerecord_connection/tinytds.rb
+- lib/sequel/extensions/activerecord_connection/utils.rb
 - sequel-activerecord_connection.gemspec
 homepage: https://github.com/janko/sequel-activerecord_connection
 licenses:
@@ -100,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="