sequel-activerecord_connection 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb35cdbc0ade81ae15042834733f9ec4683b6889eab2c35412710d631a02de53
-  data.tar.gz: 75f97d5bee8522c12a7a3c65e05e1511f40ca4eccab8bc4b8cb2e1c3ece1a44a
+  metadata.gz: 929f5047395464d1d3616aeab41742b6766ae14b96ca1f5b7ac47bb1991f3391
+  data.tar.gz: c931c23d71b73ce2bb35118e1d02ecc2df529f2c297b995c9c5ee46c5b0bfe85
 SHA512:
-  metadata.gz: 4fbf8edd6c9a61a8761431d33ba89c63a2aa444417d5ebec7b42ec9d3ef8aa5c509b28d35d708af223289c8e085b62204c3af690dc18c13e0df69f61a837b41d
-  data.tar.gz: 5f4408be86e1d09a856215ca6e1fd4ef594955549e52987107ff33fc8efb24c68f4fdaf03c0132bb22fe4e2023b31d5526dc77f225d476718528d101c2f6bb8c
+  metadata.gz: 062f919b4268a57e392bad5dd7d4a988adc90a8df2d4076f5abfa9afe7c125534f9e7ad1ca16733d0539e622f2b988f95d4653d6b076cd356809d95daf1c24d2
+  data.tar.gz: 1f1efabd6b3ae74c6d35b3d0a23ad87a9d1c939e209afc2f24267840c6c72b2ff60fb1ca86010335b65a251c3c57fa81b300aa4cf38b9ad49df53b00f931d89f

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 1.0.0 (2020-10-25)
+
+* Clear AR statement cache on `ActiveRecord::PreparedStatementCacheExpired` when Sequel holds the transaction (@janko)
+
+* Pick up `ActiveRecord::Base.default_timezone` being changed on runtime (@janko)
+
+* Support prepared statements and bound variables in all adapters (@janko)
+
+* Correctly identify identity columns as primary keys in Postgres adapter (@janko)
+
+* Avoid using deprecated `sqlite3` API in SQLite adapter (@janko)
+
+* Allow using any external Active Record adapters (@janko)
+
+* Avoid potential bugs when converting Active Record exceptions into Sequel exceptions (@janko)
+
+* Don't use Active Record locks when executing queries with Sequel (@janko)
+
+* Support `Database#valid_connection?` in Postgres adapter (@janko)
+
+* Fully utilize Sequel's logic for detecting disconnects in Postgres adapter (@janko)
+
+* Support `Database#{copy_table,copy_into,listen}` in Postgres adapter (@janko)
+
+* Log all queries executed by Sequel (@janko)
+
+* Log executed queries to Sequel logger(s) as well (@janko)
+
+* Specially label queries executed by Sequel in Active Record logs (@janko)
+
 ## 0.4.1 (2020-09-28)
 
 * Require Sequel version 5.16.0 or above (@janko)

data/README.md

@@ -74,13 +74,17 @@ ActiveRecord adapters, just make sure to initialize the corresponding Sequel
 adapter before loading the extension.
 
 ```rb
-DB = Sequel.postgres(extensions: :activerecord_connection) # for "postgresql" adapter
-# or
-DB = Sequel.mysql2(extensions: :activerecord_connection) # for "mysql2" adapter
-# or
-DB = Sequel.sqlite(extensions: :activerecord_connection) # for "sqlite3" adapter
-# or
-DB = Sequel.jdbc(extensions: :activerecord_connection) # for JDBC adapter
+Sequel.postgres(extensions: :activerecord_connection) # for "postgresql" adapter
+Sequel.mysql2(extensions: :activerecord_connection)   # for "mysql2" adapter
+Sequel.sqlite(extensions: :activerecord_connection)   # for "sqlite3" adapter
+```
+
+If you're on JRuby, you should be using the JDBC adapters:
+
+```rb
+Sequel.connect("jdbc:postgresql://", extensions: :activerecord_connection) # for "jdbcpostgresql" adapter
+Sequel.connect("jdbc:mysql://", extensions: :activerecord_connection)      # for "jdbcmysql" adapter
+Sequel.connect("jdbc:sqlite://", extensions: :activerecord_connection)     # for "jdbcsqlite3" adapter
 ```
 
 ### Transactions
@@ -149,19 +153,6 @@ end
 DB.activerecord_model = MyModel
 ```
 
-### Timezone
-
-Sequel's database timezone will be automatically set to ActiveRecord's default
-timezone (`:utc` by default) when the extension is loaded.
-
-If you happen to be changing ActiveRecord's default timezone after you've
-loaded the extension, make sure to reflect that in your Sequel database object,
-for example:
-
-```rb
-DB.timezone = :local
-```
-
 ## Tests
 
 You'll first want to run the rake tasks for setting up databases and users:

data/lib/sequel/extensions/activerecord_connection.rb

@@ -13,13 +13,12 @@ module Sequel
 
     def self.extended(db)
       db.activerecord_model = ActiveRecord::Base
-      db.timezone = ActiveRecord::Base.default_timezone
 
       begin
         require "sequel/extensions/activerecord_connection/#{db.adapter_scheme}"
         db.extend Sequel::ActiveRecordConnection.const_get(db.adapter_scheme.capitalize)
       rescue LoadError
-        fail Error, "unsupported adapter: #{db.adapter_scheme}"
+        # assume the Sequel adapter already works with Active Record
       end
     end
 
@@ -30,15 +29,21 @@ module Sequel
       raise Error, "creating a Sequel connection is not allowed"
     end
 
-    # Avoid calling Sequel's connection pool, instead use ActiveRecord.
+    # Avoid calling Sequel's connection pool, instead use Active Record's.
     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
+      yield activerecord_connection.raw_connection
+    end
+
+    # Log executed queries into Active Record logger as well.
+    def log_connection_yield(sql, conn, args = nil)
+      sql += "; #{args.inspect}" if args
+
+      activerecord_log(sql) { super }
+    end
+
+    # Match database timezone with Active Record.
+    def timezone
+      @timezone || ActiveRecord::Base.default_timezone
     end
 
     private
@@ -75,20 +80,19 @@ module Sequel
       super
     end
 
-    def begin_transaction(conn, opts = {})
+    def begin_transaction(conn, opts = OPTS)
       isolation = TRANSACTION_ISOLATION_MAP.fetch(opts[:isolation]) if opts[:isolation]
       joinable  = !opts[:auto_savepoint]
 
       activerecord_connection.begin_transaction(isolation: isolation, joinable: joinable)
     end
 
-    def commit_transaction(conn, opts = {})
+    def commit_transaction(conn, opts = OPTS)
       activerecord_connection.commit_transaction
     end
 
-    def rollback_transaction(conn, opts = {})
+    def rollback_transaction(conn, opts = 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)
@@ -107,19 +111,36 @@ module Sequel
       super
     end
 
-    def activerecord_raw_connection
-      activerecord_connection.raw_connection
-    end
-
     def activerecord_connection
       activerecord_model.connection
     end
 
-    def activesupport_interlock(&block)
-      if ActiveSupport::Dependencies.respond_to?(:interlock)
-        ActiveSupport::Dependencies.interlock.permit_concurrent_loads(&block)
-      else
+    def activerecord_log(sql, &block)
+      ActiveSupport::Notifications.instrument(
+        "sql.active_record",
+        sql:        sql,
+        name:       "Sequel",
+        connection: activerecord_connection,
+        &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

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

@@ -7,32 +7,11 @@ module Sequel
         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
+      def synchronize(*)
+        super do |conn|
+          yield conn.connection
         end
-      rescue ActiveRecord::StatementInvalid => exception
-        raise_error(exception.cause, classes: database_error_classes)
       end
     end
   end
-end
+end

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

@@ -1,34 +1,20 @@
 module Sequel
   module ActiveRecordConnection
     module Mysql2
-      def execute(sql, opts=OPTS)
-        original_query_options = activerecord_raw_connection.query_options.dup
+      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)
 
-        activerecord_raw_connection.query_options.merge!(
-          as:             :hash,
-          symbolize_keys: true,
-          cache_rows:     false,
-        )
+          conn.query_options.merge!(as: :hash, symbolize_keys: true, cache_rows: false)
 
-        result = activerecord_connection.execute(sql)
-
-        if opts[:type] == :select
-          if block_given?
-            yield result
-          else
-            result
+          begin
+            yield conn
+          ensure
+            conn.query_options.replace(conn.instance_variable_get(:@sequel_default_query_options))
           end
-        elsif block_given?
-          yield activerecord_raw_connection
-        end
-      rescue ActiveRecord::StatementInvalid => exception
-        if exception.cause.is_a?(::Mysql2::Error)
-          raise_error(exception.cause)
-        else
-          raise
         end
-      ensure
-        activerecord_raw_connection.query_options.replace(original_query_options)
       end
     end
   end

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

@@ -1,28 +1,98 @@
 module Sequel
   module ActiveRecordConnection
     module Postgres
-      def execute(sql, opts=OPTS)
-        result = activerecord_connection.execute(sql)
+      def synchronize(*)
+        super do |conn|
+          conn.extend(ConnectionMethods)
+          conn.instance_variable_set(:@db, self)
 
-        if block_given?
-          yield result
-        else
-          result.cmd_tuples
+          Utils.add_prepared_statements_cache(conn)
+
+          Utils.set_value(conn, :type_map_for_results, PG::TypeMapAllStrings.new) do
+            yield conn
+          end
         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 = {})
+      # Reject unsupported Postgres-specific transaction options.
+      def transaction(opts = OPTS)
         %i[deferrable read_only synchronous].each do |key|
-          fail Error, "#{key.inspect} transaction option is currently not supported" if options.key?(key)
+          fail Error, "#{key.inspect} transaction option is currently not supported" if opts.key?(key)
         end
 
         super
+      rescue => e
+        activerecord_connection.clear_cache! if e.class.name == "ActiveRecord::PreparedStatementCacheExpired" && !in_transaction?
+        raise
+      end
+
+      # Copy-pasted from Sequel::Postgres::Adapter.
+      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
+
+        # 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() "
+         ])}/
+
+        def async_exec_params(sql, args)
+          defined?(super) ? super : async_exec(sql, args)
+        end
+
+        # Raise a Sequel::DatabaseDisconnectError if a one of the disconnect
+        # error classes is raised, or a PG::Error is raised and the connection
+        # status cannot be determined or it is not OK.
+        def check_disconnect_errors
+          begin
+            yield
+          rescue *DISCONNECT_ERROR_CLASSES => e
+            disconnect = true
+            raise(Sequel.convert_exception_class(e, Sequel::DatabaseDisconnectError))
+          rescue PG::Error => e
+            disconnect = false
+            begin
+              s = status
+            rescue PG::Error
+              disconnect = true
+            end
+            status_ok = (s == PG::CONNECTION_OK)
+            disconnect ||= !status_ok
+            disconnect ||= e.message =~ DISCONNECT_ERROR_REGEX
+            disconnect ? raise(Sequel.convert_exception_class(e, Sequel::DatabaseDisconnectError)) : raise
+          ensure
+            block if status_ok && !disconnect
+          end
+        end
+
+        # Execute the given SQL with this connection.  If a block is given,
+        # yield the results, otherwise, return the number of changed rows.
+        def execute(sql, args = nil)
+          args   = args.map { |v| @db.bound_variable_arg(v, self) } if args
+          result = check_disconnect_errors { execute_query(sql, args) }
+
+          block_given? ? yield(result) : result.cmd_tuples
+        ensure
+          result.clear if result
+        end
+
+        private
+
+        # 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)
+          end
+        end
       end
     end
   end

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

@@ -7,43 +7,16 @@ module Sequel
         end
       end
 
-      def execute_ddl(sql, opts=OPTS)
-        execute(sql, opts)
-      end
-
-      private
-
-      # ActiveRecord doesn't send SQLite methods Sequel expects, so we need to
-      # try to replicate what ActiveRecord does around connection excecution.
-      def _execute(type, sql, opts, &block)
-        if activerecord_raw_connection.respond_to?(:extended_result_codes=)
-          activerecord_raw_connection.extended_result_codes = true
-        end
+      def synchronize(*)
+        super do |conn|
+          conn.extended_result_codes = true if conn.respond_to?(:extended_result_codes=)
 
-        if ActiveRecord::VERSION::MAJOR >= 6
-          activerecord_connection.materialize_transactions
-        end
+          Utils.add_prepared_statements_cache(conn)
 
-        activerecord_connection.send(:log, sql) do
-          activesupport_interlock do
-            case type
-            when :select
-              activerecord_raw_connection.query(sql, &block)
-            when :insert
-              activerecord_raw_connection.execute(sql)
-              activerecord_raw_connection.last_insert_row_id
-            when :update
-              activerecord_raw_connection.execute_batch(sql)
-              activerecord_raw_connection.changes
-            end
+          Utils.set_value(conn, :results_as_hash, nil) do
+            yield conn
           end
         end
-      rescue ActiveRecord::StatementInvalid => exception
-        if exception.cause.is_a?(SQLite3::Exception)
-          raise_error(exception.cause)
-        else
-          raise exception
-        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       = "0.4.1"
+  spec.version       = "1.0.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 
@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", ">= 4.2", "< 7"
 
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "warning" if RUBY_VERSION >= "2.4"
 
   spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "*.gemspec"]
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allows Sequel to use ActiveRecord connection for database interaction.
 email:
 - janko.marohnic@gmail.com
@@ -93,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Allows Sequel to use ActiveRecord connection for database interaction.