sequel-activerecord_connection 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95766ef8e2bf54388e4a139f430c42176760f2b77e0322902445414ffe3d7ddb
-  data.tar.gz: 35a9fe4b35ff4037299799be9d902e93a29f9d81333ddf084374a4525761a2b1
+  metadata.gz: d4078a41f54331cbb97fc266abdbe24cf8c297be14bb7f92b3bf605bf9b549bd
+  data.tar.gz: af466cd9b062279a7781106136a05151f02339830469136cdf9b58d629397b98
 SHA512:
-  metadata.gz: 93a612e4cfc3454783ba936a19518459fee958e53f8193e9f0561d65961008892a7b8c24a3189e5b2cc8620803e0da1375cd36f5c319af4adf7461656e2e462e
-  data.tar.gz: 526c8b8ce56b481f5fa98ff1dbd242fc9104665dab6166bd4797514ae187bfe0e9460881dc9f6783e1216323a9a0d701949de2d1972865d464a9a13c51dd4c41
+  metadata.gz: e28881de46188d6dc143952a473e00254b0742c497e7888e8d334ff33b627d3d90d9174675809cc3248b15cfcc800908bc83dda5a8da3fee93c4048c44282424
+  data.tar.gz: 7c0a46d18a45e76ca4a7af11d467b957035dd4b62adbdcaf64d8e9cafe1bfb406fa40c3d4feadff10c823d2535cab978111203ade32ea519f991e828ed1df033

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0 (2020-07-24)
+
+* Fully support Sequel transaction API (all transaction options, transaction/savepoint hooks etc.) (@janko)
+
 ## 0.2.6 (2020-07-19)
 
 * Return block result in `Sequel::Database#transaction` (@zabolotnov87, @janko)

data/README.md

@@ -3,7 +3,7 @@
 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.
+adapters, as well as JDBC adapter for JRuby.
 
 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
@@ -11,15 +11,15 @@ 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 fairly advanced Sequel usage.
+possible. That being said, this implementation passes Rodauth's test suite
+(for all adapters), which has some fairly advanced Sequel usage.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "sequel-activerecord_connection"
+gem "sequel-activerecord_connection", "~> 0.3"
 ```
 
 And then execute:
@@ -80,65 +80,62 @@ DB = Sequel.postgres(test: false) # for "postgresql" adapter
 DB = Sequel.mysql2(test: false) # for "mysql2" adapter
 # or
 DB = Sequel.sqlite(test: false) # for "sqlite3" adapter
+# or
+DB = Sequel.jdbc(test: false) # for JDBC adapter
 ```
 
 ### Transactions
 
-The database extension overrides Sequel transactions to use ActiveRecord
-transcations, which allows using ActiveRecord inside Sequel transactions (and
-vice-versa), and have things like ActiveRecord's transactional callbacks still
-work correctly.
+This database extension keeps the transaction state of Sequel and ActiveRecord
+in sync, allowing you to use Sequel and ActiveRecord transactions
+interchangeably (including nesting them), and have things like ActiveRecord's
+and Sequel's transactional callbacks still work correctly.
 
 ```rb
-DB.transaction do
-  ActiveRecord::Base.transaction do
-    # this all works
-  end
+ActiveRecord::Base.transaction do
+  DB.in_transaction? #=> true
 end
 ```
 
-The following Sequel transaction options are currently supported:
-
-* `:savepoint`
-* `:auto_savepoint`
-* `:rollback`
+Sequel's transaction API is fully supported:
 
 ```rb
-ActiveRecord::Base.transaction do
-  DB.transaction(savepoint: true) do # will create a savepoint
-    DB.transaction do # will not create a savepoint
-      # ...
-    end
+DB.transaction(isolation: :serializable) do
+  DB.after_commit { ... } # call block after transaction commits
+  DB.transaction(savepoint: true) do # creates a savepoint
+    # ...
   end
 end
 ```
 
-The `#in_transaction?` method is supported as well:
+One caveat to keep in mind is that Sequel's transaction hooks
+(`after_commit`, `after_rollback`) will *not* run if ActiveRecord holds the
+outer transaction:
 
 ```rb
-ActiveRecord::Base.transaction do
-  DB.in_transaction? #=> true
+DB.transaction do
+  DB.after_commit { ... } # will get executed
 end
-```
 
-Other transaction-related Sequel methods (`#after_commit`, `#after_rollback`
-etc) are not supported, because ActiveRecord currently doesn't provide
-transactional callbacks on the connection level (only on the model level).
+ActiveRecord::Base.transaction do
+  DB.after_commit { ... } # won't get executed
+end
 
-### Exceptions
+ActiveRecord::Base.transaction do
+  DB.transaction do
+    DB.after_commit { ... } # won't get executed
+  end
+end
+```
 
-To ensure Sequel compatibility, any `ActiveRecord::StatementInvalid` exceptions
-will be translated into Sequel exceptions:
+Savepoint hooks should still work, though:
 
 ```rb
-DB[:posts].multi_insert [{ id: 1 }, { id: 1 }]
-#~> Sequel::UniqueConstraintViolation
-
-DB[:posts].insert(title: nil)
-#~> Sequel::NotNullConstraintViolation
-
-DB[:posts].insert(author_id: 123)
-#~> Sequel::ForeignKeyConstraintViolation
+ActiveRecord::Base.transaction do
+  DB.transaction(savepoint: true) do
+    DB.after_commit { ... } # will get executed after savepoint is released
+  end
+end
 ```
 
 ### Model

data/lib/sequel/extensions/activerecord_connection.rb

@@ -2,6 +2,13 @@ module Sequel
   module ActiveRecordConnection
     Error = Class.new(Sequel::Error)
 
+    TRANSACTION_ISOLATION_MAP = {
+      uncommitted:  :read_uncommitted,
+      committed:    :read_committed,
+      repeatable:   :repeatable_read,
+      serializable: :serializable,
+    }
+
     def self.extended(db)
       db.activerecord_model = ActiveRecord::Base
       db.timezone = ActiveRecord::Base.default_timezone
@@ -21,36 +28,6 @@ module Sequel
       raise Error, "creating a Sequel connection is not allowed"
     end
 
-    def transaction(options = {})
-      %i[isolation num_retries before_retry prepare retry_on].each do |key|
-        fail Error, "#{key.inspect} transaction option is currently not supported" if options.key?(key)
-      end
-
-      activerecord_model.transaction(requires_new: !in_transaction? || options[:savepoint] || Thread.current[:sequel_activerecord_auto_savepoint]) do
-        begin
-          Thread.current[:sequel_activerecord_auto_savepoint] = true if options[:auto_savepoint]
-          result = yield
-          raise ActiveRecord::Rollback if options[:rollback] == :always
-          result
-        rescue Sequel::Rollback => exception
-          raise if options[:rollback] == :reraise
-          raise ActiveRecord::Rollback, exception.message, exception.backtrace
-        ensure
-          Thread.current[:sequel_activerecord_auto_savepoint] = nil if options[:auto_savepoint]
-        end
-      end
-    end
-
-    def in_transaction?(*)
-      activerecord_connection.transaction_open?
-    end
-
-    %i[after_commit after_rollback rollback_on_exit rollback_checker].each do |meth|
-      define_method(meth) do |*|
-        fail Error, "Database##{meth} is currently not supported"
-      end
-    end
-
     # Avoid calling Sequel's connection pool, instead use ActiveRecord.
     def synchronize(*)
       if ActiveRecord.version >= Gem::Version.new("5.1.0")
@@ -64,6 +41,53 @@ module Sequel
 
     private
 
+    # Backfills any ActiveRecord transactions/savepoints that have been opened
+    # directly via ActiveRecord::Base.transaction. Sequel uses this information
+    # to know whether we're in a transaction, whether to create a savepoint,
+    # when to run transaction/savepoint hooks etc.
+    def _trans(conn)
+      Sequel.synchronize do
+        result = @transactions[conn]
+
+        if activerecord_connection.transaction_open?
+          result ||= { savepoints: [] }
+          while result[:savepoints].length < activerecord_connection.open_transactions
+            result[:savepoints].unshift({ activerecord: true })
+          end
+        end
+
+        @transactions[conn] = result if result
+        result
+      end
+    end
+
+    # First delete any transactions/savepoints opened directly via
+    # ActiveRecord::Base.transaction, so that Sequel can detect when the last
+    # Sequel transaction has been closed and clear transaction information.
+    def transaction_finished?(conn)
+      _trans(conn)[:savepoints].shift while _trans(conn)[:savepoints].first[:activerecord]
+      super
+    end
+
+    def begin_transaction(conn, opts = {})
+      isolation = TRANSACTION_ISOLATION_MAP.fetch(opts[:isolation]) if opts[:isolation]
+
+      activerecord_connection.begin_transaction(isolation: isolation)
+    end
+
+    def commit_transaction(conn, opts = {})
+      activerecord_connection.commit_transaction
+    end
+
+    def rollback_transaction(conn, opts = {})
+      activerecord_connection.rollback_transaction
+      activerecord_connection.transaction_manager.send(:after_failure_actions, activerecord_connection.current_transaction, $!) if activerecord_connection.transaction_manager.respond_to?(:after_failure_actions)
+    end
+
+    def savepoint_level(conn)
+      activerecord_connection.open_transactions
+    end
+
     def activerecord_raw_connection
       activerecord_connection.raw_connection
     end

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

@@ -9,6 +9,8 @@ module Sequel
         else
           result.cmd_tuples
         end
+      rescue ActiveRecord::PreparedStatementCacheExpired
+        raise # ActiveRecord's transaction manager needs to handle this exception
       rescue ActiveRecord::StatementInvalid => exception
         raise_error(exception.cause, classes: database_error_classes)
       ensure

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "0.2.6"
+  spec.version       = "0.3.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel