sequel-activerecord_connection 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cbc8358a3097618cd7acc4e8cf46c013ef4d8b6aefde8e05de0277ca585c0b9
-  data.tar.gz: 2ba345ca95455c1acaabf7e2619b81b97b332d1c353bab2de50f700e9ba69148
+  metadata.gz: fba99c145ebf98ed9c3e26fdc96afc3bc5fa7820e01d466ab10320c72765c8ae
+  data.tar.gz: ae36bef3a63280cf54f1a92e814c1bf4928dc8050f572694aac4340389115f9b
 SHA512:
-  metadata.gz: a9d3f729bfa2e5a82e78521856b2928887700a67129e47af6eb40d1bf4508b6deb7202928f7626ea3c4f6a424b23df8410756d2333295c1d56fee79b123dc7dd
-  data.tar.gz: 6184d4e1dd21bc550ac99285fd379215dcd13b4474aeff39928bdc68cc25ac34b235f68bed03260fae3fea34ef203422e2665bb12c822479e6ce4cc8d54d1f59
+  metadata.gz: 073babf3f4e9d60dcb439eb0d9a7b801b9cf23b9be53366382cdd9e18234de66c329d0a975e68fb57d78cbf80f26ddafcd3f1bc90e8282a9a24b90cd1f8c0a43
+  data.tar.gz: 420a6326c6c0e0b85874b52c89e747a59702280e763d9f6a090dd649b17718771cefaa1d9d72d4244a92bcfbee7ff2c186480ad0005d17685abcd0a595ccb97c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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)

data/README.md

@@ -4,9 +4,9 @@ This is an extension for [Sequel] that allows it to reuse an existing
 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.
 
 It works on ActiveRecord 4.2+ and fully supports PostgresSQL, MySQL and SQLite
 adapters, both the native ones and JDBC (JRuby). Other adapters might work too,
@@ -109,31 +109,70 @@ 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 combining Active Record and Sequel transactions, Sequel transaction hook
+functionality will be utilized when possible.
 
 ```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
@@ -183,3 +222,4 @@ 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

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}"
@@ -97,20 +102,28 @@ 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
-
-      super
     end
 
     # Active Record doesn't guarantee that a single connection can only be used

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "1.0.1"
+  spec.version       = "1.1.0"
   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.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-11-08 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
@@ -100,7 +128,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:
   - - ">="