activerecord-trilogy-adapter 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6012f06cd5bd29a7bd180354fd0e65c3fd11784a6a7483fac9599d87baa1b68
-  data.tar.gz: bde2129ca1f647d6b7308c131d00ae012d614ad4aba36450f16fd3551bc303ce
+  metadata.gz: 778687330e4ff0e83f8cf02ea27808b9e7197c625312611c0dd004d17627a29e
+  data.tar.gz: f3ddf11ab50accd31b5bd3a4b41899a781f4ac04555739d1e65eff3e884b8b38
 SHA512:
-  metadata.gz: 0ae12198df3991bccc1a17a983050457b2483d33f40078d5bd4c99a2d475d5fbdb84a2510c0beb0db65c9ebb4e431e12115ab2830c0cd5901a75cea3dfd7f75a
-  data.tar.gz: 0aed27beca07c98b513a092345b125129999f5ec0180ee9df0c78b39348c73be71ef0ad78448a644733f8966636f8059ec43aa248b247e66fa7cfda2cb3bdae8
+  metadata.gz: 7b2e8b370f301aeda40bef4e1a66c16dc0351b245a5c967341a22e1ab05830e4e11d5cd1de2de2e38a246cbd5fb492e27d8e906770d4484707512a34e9d8430c
+  data.tar.gz: 3471e795e4942858134083a06f632da5afebb69c60a87001631486c79ecb81dc3f90e5c5cbdf5eb408c48ca125f47055ca8c08c0af945324e1043aa7996b104e

data/README.md

@@ -1,12 +1,16 @@
 # Trilogy Adapter
 
-Active Record database adapter for [Trilogy](https://github.com/github/trilogy)
+Active Record database adapter for [Trilogy](https://github.com/trilogy-libraries/trilogy)
+
+This gem offers Trilogy support for versions of ActiveRecord prior to 7.1. Currently supports:
+
+- Rails v7.0.x
 
 ## Requirements
 
 - [Ruby](https://www.ruby-lang.org) 2.7 or higher
-- [Active Record](https://github.com/rails/rails) 7.1 or higher
-- [Trilogy](https://github.com/github/trilogy) 2.1.1 or higher
+- [Active Record](https://github.com/rails/rails) 7.0.x
+- [Trilogy](https://github.com/trilogy-libraries/trilogy) 2.4.0 or higher
 
 ## Setup
 

data/lib/active_record/connection_adapters/trilogy_adapter.rb

@@ -15,6 +15,9 @@ module ActiveRecord
         ) # :nodoc:
         private_constant :READ_QUERY
 
+        HIGH_PRECISION_CURRENT_TIMESTAMP = Arel.sql("CURRENT_TIMESTAMP(6)").freeze # :nodoc:
+        private_constant :HIGH_PRECISION_CURRENT_TIMESTAMP
+
         def write_query?(sql) # :nodoc:
           !READ_QUERY.match?(sql)
         rescue ArgumentError # Invalid encoding
@@ -30,13 +33,6 @@ module ActiveRecord
           MySQL::ExplainPrettyPrinter.new.pp(result, elapsed)
         end
 
-        def execute(sql, name = nil, async: false)
-          sql = transform_query(sql)
-          check_if_write_query(sql)
-
-          raw_execute(sql, name, async: async)
-        end
-
         def exec_query(sql, name = "SQL", binds = [], prepare: false, async: false)
           result = execute(sql, name, async: async)
           ActiveRecord::Result.new(result.fields, result.to_a)
@@ -55,6 +51,10 @@ module ActiveRecord
 
         alias :exec_update :exec_delete
 
+        def high_precision_current_timestamp
+          HIGH_PRECISION_CURRENT_TIMESTAMP
+        end
+
         private
           def last_inserted_id(result)
             result.last_insert_id
@@ -63,8 +63,6 @@ module ActiveRecord
 
       ER_BAD_DB_ERROR = 1049
       ER_ACCESS_DENIED_ERROR = 1045
-      ER_CONN_HOST_ERROR = 2003
-      ER_UNKNOWN_HOST_ERROR = 2005
 
       ADAPTER_NAME = "Trilogy"
 
@@ -82,7 +80,7 @@ module ActiveRecord
         def new_client(config)
           config[:ssl_mode] = parse_ssl_mode(config[:ssl_mode]) if config[:ssl_mode]
           ::Trilogy.new(config)
-        rescue Trilogy::DatabaseError => error
+        rescue Trilogy::ConnectionError, Trilogy::ProtocolError => error
           raise translate_connect_error(config, error)
         end
 
@@ -102,14 +100,24 @@ module ActiveRecord
             ActiveRecord::NoDatabaseError.db_error(config[:database])
           when ER_ACCESS_DENIED_ERROR
             ActiveRecord::DatabaseConnectionError.username_error(config[:username])
-          when ER_CONN_HOST_ERROR, ER_UNKNOWN_HOST_ERROR
-            ActiveRecord::DatabaseConnectionError.hostname_error(config[:host])
           else
-            ActiveRecord::ConnectionNotEstablished.new(error.message)
+            if error.message.match?(/TRILOGY_DNS_ERROR/)
+              ActiveRecord::DatabaseConnectionError.hostname_error(config[:host])
+            else
+              ActiveRecord::ConnectionNotEstablished.new(error.message)
+            end
           end
         end
       end
 
+      def initialize(connection, logger, connection_options, config)
+        super
+        # Ensure that we're treating prepared_statements in the same way that Rails 7.1 does
+        @prepared_statements = self.class.type_cast_config_to_boolean(
+          @config.fetch(:prepared_statements) { default_prepared_statements }
+        )
+      end
+
       def supports_json?
         !mariadb? && database_version >= "5.7.8"
       end
@@ -135,12 +143,53 @@ module ActiveRecord
       end
 
       def quote_string(string)
-        with_raw_connection(allow_retry: true, uses_transaction: false) do |conn|
+        with_trilogy_connection(allow_retry: true, uses_transaction: false) do |conn|
           conn.escape(string)
         end
       end
 
+      def connect!
+        verify!
+        self
+      end
+
+      def reconnect!
+        @lock.synchronize do
+          disconnect!
+          connect
+        rescue StandardError => original_exception
+          raise translate_exception_class(original_exception, nil, nil)
+        end
+      end
+
+      def with_trilogy_connection(uses_transaction: true, **_kwargs)
+        @lock.synchronize do
+          verify!
+          materialize_transactions if uses_transaction
+          yield connection
+        end
+      end
+
+      def raw_execute(sql, name, async: false, allow_retry: false, uses_transaction: true)
+        mark_transaction_written_if_write(sql)
+
+        log(sql, name, async: async) do
+          with_trilogy_connection(allow_retry: allow_retry, uses_transaction: uses_transaction) do |conn|
+            sync_timezone_changes(conn)
+            conn.query(sql)
+          end
+        end
+      end
+
+      def execute(sql, name = nil, **kwargs)
+        sql = transform_query(sql)
+        check_if_write_query(sql)
+        super
+      end
+
       def active?
+        return false if connection&.closed?
+
         connection&.ping || false
       rescue ::Trilogy::Error
         false
@@ -149,6 +198,7 @@ module ActiveRecord
       alias reset! reconnect!
 
       def disconnect!
+        super
         unless connection.nil?
           connection.close
           self.connection = nil
@@ -159,23 +209,6 @@ module ActiveRecord
         self.connection = nil
       end
 
-      def raw_execute(sql, name, async: false, allow_retry: false, uses_transaction: true)
-        mark_transaction_written_if_write(sql)
-
-        log(sql, name, async: async) do
-          with_raw_connection(allow_retry: allow_retry, uses_transaction: uses_transaction) do |conn|
-            # Sync any changes since connection last established.
-            if default_timezone == :local
-              conn.query_flags |= ::Trilogy::QUERY_FLAGS_LOCAL_TIMEZONE
-            else
-              conn.query_flags &= ~::Trilogy::QUERY_FLAGS_LOCAL_TIMEZONE
-            end
-
-            conn.query(sql)
-          end
-        end
-      end
-
       def each_hash(result)
         return to_enum(:each_hash, result) unless block_given?
 
@@ -198,13 +231,7 @@ module ActiveRecord
       end
 
       private
-        def connection
-          @raw_connection
-        end
-
-        def connection=(conn)
-          @raw_connection = conn
-        end
+        attr_accessor :connection
 
         def connect
           self.connection = self.class.new_client(@config)
@@ -212,15 +239,80 @@ module ActiveRecord
 
         def reconnect
           connection&.close
+          self.connection = nil
           connect
         end
 
+        def sync_timezone_changes(conn)
+          # Sync any changes since connection last established.
+          if ActiveRecord.default_timezone == :local
+            conn.query_flags |= ::Trilogy::QUERY_FLAGS_LOCAL_TIMEZONE
+          else
+            conn.query_flags &= ~::Trilogy::QUERY_FLAGS_LOCAL_TIMEZONE
+          end
+        end
+
+        def execute_batch(statements, name = nil)
+          statements = statements.map { |sql| transform_query(sql) }
+          combine_multi_statements(statements).each do |statement|
+            with_trilogy_connection do |conn|
+              raw_execute(statement, name)
+              conn.next_result while conn.more_results_exist?
+            end
+          end
+        end
+
+        def multi_statements_enabled?
+          !!@config[:multi_statement]
+        end
+
+        def with_multi_statements
+          if multi_statements_enabled?
+            return yield
+          end
+
+          with_trilogy_connection do |conn|
+            conn.set_server_option(Trilogy::SET_SERVER_MULTI_STATEMENTS_ON)
+
+            yield
+          ensure
+            conn.set_server_option(Trilogy::SET_SERVER_MULTI_STATEMENTS_OFF)
+          end
+        end
+
+        def combine_multi_statements(total_sql)
+          total_sql.each_with_object([]) do |sql, total_sql_chunks|
+            previous_packet = total_sql_chunks.last
+            if max_allowed_packet_reached?(sql, previous_packet)
+              total_sql_chunks << +sql
+            else
+              previous_packet << ";\n"
+              previous_packet << sql
+            end
+          end
+        end
+
+        def max_allowed_packet_reached?(current_packet, previous_packet)
+          if current_packet.bytesize > max_allowed_packet
+            raise ActiveRecordError,
+              "Fixtures set is too large #{current_packet.bytesize}. Consider increasing the max_allowed_packet variable."
+          elsif previous_packet.nil?
+            true
+          else
+            (current_packet.bytesize + previous_packet.bytesize + 2) > max_allowed_packet
+          end
+        end
+
+        def max_allowed_packet
+          @max_allowed_packet ||= show_variable("max_allowed_packet")
+        end
+
         def full_version
           schema_cache.database_version.full_version_string
         end
 
         def get_full_version
-          with_raw_connection(allow_retry: true, uses_transaction: false) do |conn|
+          with_trilogy_connection(allow_retry: true, uses_transaction: false) do |conn|
             conn.server_info[:version]
           end
         end

data/lib/trilogy_adapter/connection.rb

@@ -14,6 +14,10 @@ module TrilogyAdapter
   #                                           host: "localhost",
   #                                           database: "demo_development"
   module Connection
+    def trilogy_adapter_class
+      ActiveRecord::ConnectionAdapters::TrilogyAdapter
+    end
+
     def trilogy_connection(config)
       configuration = config.dup
 
@@ -31,7 +35,7 @@ module TrilogyAdapter
         0
       ]
 
-      ActiveRecord::ConnectionAdapters::TrilogyAdapter.new nil, logger, options, configuration
+      trilogy_adapter_class.new nil, logger, options, configuration
     end
   end
 end

data/lib/trilogy_adapter/errors.rb

@@ -3,43 +3,43 @@
 module TrilogyAdapter
   module Errors
     # ServerShutdown will be raised when the database server was shutdown.
-    class ServerShutdown < ActiveRecord::ConnectionFailed
+    class ServerShutdown < ::ActiveRecord::QueryAborted
     end
 
     # ServerLost will be raised when the database connection was lost.
-    class ServerLost < ActiveRecord::ConnectionFailed
+    class ServerLost < ::ActiveRecord::QueryAborted
     end
 
     # ServerGone will be raised when the database connection is gone.
-    class ServerGone < ActiveRecord::ConnectionFailed
+    class ServerGone < ::ActiveRecord::QueryAborted
     end
 
     # BrokenPipe will be raised when a system process connection fails.
-    class BrokenPipe < ActiveRecord::ConnectionFailed
+    class BrokenPipe < ::ActiveRecord::QueryAborted
     end
 
     # SocketError will be raised when Ruby encounters a network error.
-    class SocketError < ActiveRecord::ConnectionFailed
+    class SocketError < ::ActiveRecord::QueryAborted
     end
 
     # ConnectionResetByPeer will be raised when a network connection is closed
     # outside the sytstem process.
-    class ConnectionResetByPeer < ActiveRecord::ConnectionFailed
+    class ConnectionResetByPeer < ::ActiveRecord::QueryAborted
     end
 
     # ClosedConnection will be raised when the Trilogy encounters a closed
     # connection.
-    class ClosedConnection < ActiveRecord::ConnectionFailed
+    class ClosedConnection < ::ActiveRecord::QueryAborted
     end
 
     # InvalidSequenceId will be raised when Trilogy ecounters an invalid sequence
     # id.
-    class InvalidSequenceId < ActiveRecord::ConnectionFailed
+    class InvalidSequenceId < ::ActiveRecord::QueryAborted
     end
 
     # UnexpectedPacket will be raised when Trilogy ecounters an unexpected
     # response packet.
-    class UnexpectedPacket < ActiveRecord::ConnectionFailed
+    class UnexpectedPacket < ::ActiveRecord::QueryAborted
     end
   end
 end

data/lib/trilogy_adapter/lost_connection_exception_translator.rb

@@ -37,8 +37,10 @@ module TrilogyAdapter
           Errors::BrokenPipe.new(message)
         when SocketError, IOError
           Errors::SocketError.new(message)
-        when Errno::ECONNRESET
-          Errors::ConnectionResetByPeer.new(message)
+        when Trilogy::ConnectionError
+          if message.match?(/Connection reset by peer/)
+            Errors::ConnectionResetByPeer.new(message)
+          end
         end
       end
 

data/lib/trilogy_adapter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TrilogyAdapter
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-trilogy-adapter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - GitHub Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trilogy
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.1.a
+        version: 7.1a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.1.a
+        version: 7.1a
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -111,16 +117,15 @@ files:
 - lib/trilogy_adapter/connection.rb
 - lib/trilogy_adapter/errors.rb
 - lib/trilogy_adapter/lost_connection_exception_translator.rb
-- lib/trilogy_adapter/rails/dbconsole.rb
 - lib/trilogy_adapter/railtie.rb
 - lib/trilogy_adapter/version.rb
-homepage: https://github.com/github/activerecord-trilogy-adapter
+homepage: https://github.com/trilogy-libraries/activerecord-trilogy-adapter
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/github/activerecord-trilogy-adapter
-  changelog_uri: https://github.com/github/activerecord-trilogy-adapter/blob/master/CHANGELOG.md
-  bug_tracker_uri: https://github.com/github/activerecord-trilogy-adapter/issues
+  source_code_uri: https://github.com/trilogy-libraries/activerecord-trilogy-adapter
+  changelog_uri: https://github.com/trilogy-libraries/activerecord-trilogy-adapter/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/trilogy-libraries/activerecord-trilogy-adapter/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -139,5 +144,5 @@ requirements: []
 rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
-summary: Active Record adapter for https://github.com/github/trilogy.
+summary: Active Record adapter for https://github.com/trilogy-libraries/trilogy.
 test_files: []

data/lib/trilogy_adapter/rails/dbconsole.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module TrilogyAdapter
-  module Rails
-    module DBConsole
-      class AdapterAdapter < SimpleDelegator
-        def adapter
-          "mysql"
-        end
-      end
-
-      def db_config
-        if super.adapter == "trilogy"
-          AdapterAdapter.new(super)
-        else
-          super
-        end
-      end
-    end
-  end
-end