sequel-activerecord_connection 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af03da0244bb9eedd77b19377ee8ced698c347c1e91af8457956589a3960bc08
-  data.tar.gz: ddb5b1d45042644b0caed6f0fce07aaec872cfb4e7ed6456ea4e536a4af6833f
+  metadata.gz: f8e137f0937e4f17511d40529df10648276b7dae834cef50f4bc6615206c486b
+  data.tar.gz: e25287b365a78b34c55afb084b0ebad4a24c8c00944323c1a2b455505fd4a251
 SHA512:
-  metadata.gz: a08b930bdbd1262d4f4299e21ff5d92812ad2ef8c30de9b36963c22ae8a39666d308b9fe1a8fbf1749e412687c4f149e38b5b0dac12b74923036c4c674a5db53
-  data.tar.gz: e5541c627333193ef80b5f74c2f2714137b15f8deff876e25503c89ddf4650f4db7ee12b9d30b8927fa3d03418934111277720541d43d3359458776f437957ff
+  metadata.gz: '033781eeae71623aa992f2a882c04a1fd718109435b3aa428b0710df4322f1f267664abb4670a9909e3aefa570029a37c8a6a6947d54d2b38e119b80c938245b'
+  data.tar.gz: c013ca47766a5cfae058353094df8a88e74a992de924f7b2107c6e50a5f76af72c74fab0f957032666f7b3442b80af886ca56f5bd3635d67c141fa67ff7be5d8

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+## 0.4.0 (2020-09-28)
+
+* Return correct result of `Database#in_transaction?` after ActiveRecord transaction exited (@janko)
+
+* Make ActiveRecord create a savepoint inside a Sequel transaction with `auto_savepoint: true` (@janko)
+
+* Make Sequel create a savepoint inside ActiveRecord transaction with `joinable: false` (@janko)
+
+* Improve reliability of nested transactions when combining Sequel and ActiveRecord (@janko)
+
+* Raise error when attempting to add an `after_commit`/`after_rollback` hook on ActiveRecord transaction (@janko)
+
+* Fix infinite loop that could happen with transactional Rails tests (@janko)
+
+## 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)
+
+* Fix `Sequel::Model#save_changes` or `#save` with additional options not executing (@zabolotnov87, @janko)
+
+## 0.2.5 (2020-06-04)
+
+* Use `#current_timestamp_utc` for the JDBC SQLite adapter as well (@HoneyryderChuck)
+
+## 0.2.4 (2020-06-03)
+
+* Add JRuby support for ActiveRecord 6.0 and 5.2 (@HoneyryderChuck)
+
+* Use `#current_timestamp_utc` setting for SQLite adapter on Sequel >= 5.33 (@HoneyryderChuck)
+
+## 0.2.3 (2020-05-25)
+
+* Fix Ruby 2.7 kwargs warnings in `#transaction` (@HoneyryderChuck)
+
+## 0.2.2 (2020-05-02)
+
+* Add support for ActiveRecord 4.2 (@janko)
+
+## 0.2.1 (2020-05-02)
+
+* Add support for Active Record 5.0, 5.1 and 5.2 (@janko)
+
+* Allow Sequel 4.x (@janko)
+
+## 0.2.0 (2020-04-29)
+
+* Rename to `sequel-activerecord_connection` and make it a Sequel extension (@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:
@@ -42,8 +42,7 @@ appropriate Sequel adapter and load the `activerecord_connection` extension:
 ```rb
 require "sequel"
 
-DB = Sequel.postgres(test: false) # avoid creating a connection
-DB.extension :activerecord_connection
+DB = Sequel.postgres(extensions: :activerecord_connection)
 ```
 
 Now any Sequel operations that you make will internaly be done using the
@@ -75,70 +74,64 @@ ActiveRecord adapters, just make sure to initialize the corresponding Sequel
 adapter before loading the extension.
 
 ```rb
-DB = Sequel.postgres(test: false) # for "postgresql" adapter
+DB = Sequel.postgres(extensions: :activerecord_connection) # for "postgresql" adapter
 # or
-DB = Sequel.mysql2(test: false) # for "mysql2" adapter
+DB = Sequel.mysql2(extensions: :activerecord_connection) # for "mysql2" adapter
 # or
-DB = Sequel.sqlite(test: false) # for "sqlite3" adapter
+DB = Sequel.sqlite(extensions: :activerecord_connection) # for "sqlite3" adapter
+# or
+DB = Sequel.jdbc(extensions: :activerecord_connection) # 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 { ... } # executed after transaction commits
+  DB.transaction(savepoint: true) do # creates a savepoint
+    DB.after_commit(savepoint: true) { ... } # executed if all enclosing savepoints have been released
   end
 end
 ```
 
-The `#in_transaction?` method is supported as well:
+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.
 
 ```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).
 
-### Exceptions
-
-To ensure Sequel compatibility, any `ActiveRecord::StatementInvalid` exceptions
-will be translated into Sequel exceptions:
-
-```rb
-DB[:posts].multi_insert [{ id: 1 }, { id: 1 }]
-#~> Sequel::UniqueConstraintViolation
+DB.transaction do
+  DB.transaction(savepoint: true) do
+    DB.after_commit(savepoint: true) { ... } # will get executed
+  end
+end
 
-DB[:posts].insert(title: nil)
-#~> Sequel::NotNullConstraintViolation
+ActiveRecord::Base.transaction do
+  DB.after_commit { ... } # not allowed (will raise Sequel::ActiveRecordConnection::Error)
+end
 
-DB[:posts].insert(author_id: 123)
-#~> Sequel::ForeignKeyConstraintViolation
+DB.transaction do
+  ActiveRecord::Base.transaction(requires_new: true) do
+    DB.after_commit(savepoint: true) { ... } # not allowed (will raise Sequel::ActiveRecordConnection::Error)
+  end
+end
 ```
 
 ### Model

data/lib/sequel/extensions/activerecord_connection.rb

@@ -1,7 +1,16 @@
+# frozen_string_literal: true
+
 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,57 +30,82 @@ module Sequel
       raise Error, "creating a Sequel connection is not allowed"
     end
 
-    def transaction(options = {})
-      savepoint      = options.delete(:savepoint)
-      rollback       = options.delete(:rollback)
-      auto_savepoint = options.delete(:auto_savepoint)
-      server         = options.delete(:server)
+    # Avoid calling Sequel's connection pool, instead use ActiveRecord.
+    def synchronize(*)
+      if ActiveRecord.version >= Gem::Version.new("5.1.0")
+        activerecord_connection.lock.synchronize do
+          yield activerecord_raw_connection
+        end
+      else
+        yield activerecord_raw_connection
+      end
+    end
 
-      fail Error, "#{options} transaction options are currently not supported" unless options.empty?
+    private
 
-      if in_transaction?
-        requires_new = savepoint || Thread.current[:sequel_activerecord_auto_savepoint]
-      else
-        requires_new = true
+    # Synchronizes transaction state with ActiveRecord. 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)
+      hash = super || { savepoints: [], activerecord: true }
+
+      # add any ActiveRecord transactions/savepoints that have been opened
+      # directly via ActiveRecord::Base.transaction
+      while hash[:savepoints].length < activerecord_connection.open_transactions
+        hash[:savepoints] << { activerecord: true }
       end
 
-      activerecord_model.transaction(requires_new: requires_new) do
-        begin
-          Thread.current[:sequel_activerecord_auto_savepoint] = true if auto_savepoint
-          yield
-        rescue Sequel::Rollback => exception
-          raise if rollback == :reraise
-          raise ActiveRecord::Rollback, exception.message, exception.backtrace
-        ensure
-          Thread.current[:sequel_activerecord_auto_savepoint] = nil if auto_savepoint
-        end
+      # remove any ActiveRecord transactions/savepoints that have been closed
+      # directly via ActiveRecord::Base.transaction
+      while hash[:savepoints].length > activerecord_connection.open_transactions && hash[:savepoints].last[:activerecord]
+        hash[:savepoints].pop
+      end
+
+      # sync knowledge about joinability of current ActiveRecord transaction/savepoint
+      if activerecord_connection.transaction_open? && !activerecord_connection.current_transaction.joinable?
+        hash[:savepoints].last[:auto_savepoint] = true
+      end
 
-        raise ActiveRecord::Rollback if rollback == :always
+      if hash[:savepoints].empty? && hash[:activerecord]
+        Sequel.synchronize { @transactions.delete(conn) }
+      else
+        Sequel.synchronize { @transactions[conn] = hash }
       end
+
+      super
     end
 
-    def in_transaction?(*)
-      activerecord_connection.transaction_open?
+    def begin_transaction(conn, opts = {})
+      isolation = TRANSACTION_ISOLATION_MAP.fetch(opts[:isolation]) if opts[:isolation]
+      joinable  = !opts[:auto_savepoint]
+
+      activerecord_connection.begin_transaction(isolation: isolation, joinable: joinable)
     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
+    def commit_transaction(conn, opts = {})
+      activerecord_connection.commit_transaction
     end
 
-    # Avoid calling Sequel's connection pool, instead use ActiveRecord.
-    def synchronize(*)
-      if ActiveRecord.version >= Gem::Version.new("5.1.0")
-        activerecord_connection.lock.synchronize do
-          yield activerecord_raw_connection
-        end
-      else
-        yield activerecord_raw_connection
+    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 add_transaction_hook(conn, type, block)
+      if _trans(conn)[:activerecord]
+        fail Error, "cannot add transaction hook when ActiveRecord holds the outer transaction"
       end
+
+      super
     end
 
-    private
+    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"
+      end
+
+      super
+    end
 
     def activerecord_raw_connection
       activerecord_connection.raw_connection

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

@@ -0,0 +1,38 @@
+module Sequel
+  module ActiveRecordConnection
+    module Jdbc
+      def self.extended(db)
+        if db.timezone == :utc && db.respond_to?(:current_timestamp_utc)
+          db.current_timestamp_utc = true
+        end
+      end
+
+      def statement(conn)
+        stmt = activerecord_raw_connection.connection.createStatement
+        yield stmt
+      rescue ActiveRecord::StatementInvalid => exception
+        raise_error(exception.cause, classes: database_error_classes)
+      rescue *database_error_classes => e
+        raise_error(e, classes: database_error_classes)
+      ensure
+        stmt.close if stmt
+      end
+
+      def execute(sql, opts=OPTS)
+        activerecord_connection.send(:log, sql) do
+          super
+        end
+      rescue ActiveRecord::StatementInvalid => exception
+        raise_error(exception.cause, classes: database_error_classes)
+      end
+
+      def execute_dui(sql, opts=OPTS)
+        activerecord_connection.send(:log, sql) do
+          super
+        end
+      rescue ActiveRecord::StatementInvalid => exception
+        raise_error(exception.cause, classes: database_error_classes)
+      end
+    end
+  end
+end

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

@@ -9,11 +9,21 @@ 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
         result.clear if result
       end
+
+      def transaction(options = {})
+        %i[deferrable read_only synchronous].each do |key|
+          fail Error, "#{key.inspect} transaction option is currently not supported" if options.key?(key)
+        end
+
+        super
+      end
     end
   end
 end

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

@@ -1,6 +1,12 @@
 module Sequel
   module ActiveRecordConnection
     module Sqlite
+      def self.extended(db)
+        if db.timezone == :utc && db.respond_to?(:current_timestamp_utc)
+          db.current_timestamp_utc = true
+        end
+      end
+
       def execute_ddl(sql, opts=OPTS)
         execute(sql, opts)
       end

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "0.2.3"
+  spec.version       = "0.4.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 
@@ -14,9 +14,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sequel", ">= 4.0", "< 6"
   spec.add_dependency "activerecord", ">= 4.2", "< 7"
 
-  spec.add_development_dependency "pg",      "~> 1.0"
-  spec.add_development_dependency "mysql2",  "~> 0.5"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
   spec.add_development_dependency "minitest"
 
   spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "*.gemspec"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -50,48 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -113,9 +71,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - 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/postgres.rb
 - lib/sequel/extensions/activerecord_connection/sqlite.rb