activerecord-trilogy-adapter 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c82a7b7939a81514e90b6c5da24ab8e310a34629cce1c33bd300c1ffa1ca3176
+  data.tar.gz: 245b8be7fb7fa5672ce6db5598730120c7b401be3e2ec0b3b74fc3ad25592526
+SHA512:
+  metadata.gz: aa5f9afa69163d02a8d11c75c33c17a0a22a112b7f5ec33671c92b4900b185340665ddc01036a59227ad4e9d8199f86d745ce983dd84c74a54f8e6f3eb6d7538
+  data.tar.gz: 50496283df9b2dd9f7c23b0131951393696512bc2bb904bfd5b708401c7d8c8e875cec5a9ef1a8beae8869d3533c070a24f9b2b577acc8ad7ec04b1b8e9c67e2

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2018-2022 GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Trilogy Adapter
+
+Active Record database adapter for [Trilogy](https://github.com/github/trilogy)
+
+## 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
+
+## Setup
+
+* Add the following to your Gemfile:
+
+  ```rb
+  gem "activerecord-trilogy-adapter"
+  ```
+
+* Update your database configuration (e.g. `config/database.yml`) to use
+  `trilogy` as the adapter.
+
+## Versioning
+
+Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
+
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+## Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
+participating in this project you agree to abide by its terms.
+
+## Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## License
+
+Released under the [MIT License](LICENSE.md).

data/lib/active_record/connection_adapters/trilogy_adapter.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "trilogy"
+require "active_record/connection_adapters/abstract_mysql_adapter"
+
+require "active_record/tasks/trilogy_database_tasks"
+require "trilogy_adapter/lost_connection_exception_translator"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class TrilogyAdapter < ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
+      module DatabaseStatements
+        READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(
+          :desc, :describe, :set, :show, :use
+        ) # :nodoc:
+        private_constant :READ_QUERY
+
+        def write_query?(sql) # :nodoc:
+          !READ_QUERY.match?(sql)
+        rescue ArgumentError # Invalid encoding
+          !READ_QUERY.match?(sql.b)
+        end
+
+        def explain(arel, binds = [])
+          sql     = "EXPLAIN #{to_sql(arel, binds)}"
+          start   = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          result  = exec_query(sql, "EXPLAIN", binds)
+          elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+
+          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)
+        end
+
+        alias exec_without_stmt exec_query
+
+        def exec_insert(sql, name, binds, pk = nil, sequence_name = nil)
+          execute(to_sql(sql, binds), name)
+        end
+
+        def exec_delete(sql, name = nil, binds = [])
+          result = execute(to_sql(sql, binds), name)
+          result.affected_rows
+        end
+
+        alias :exec_update :exec_delete
+
+        private
+          def last_inserted_id(result)
+            result.last_insert_id
+          end
+      end
+
+      ER_BAD_DB_ERROR = 1049
+      ER_ACCESS_DENIED_ERROR = 1045
+      ER_CONN_HOST_ERROR = 2003
+      ER_UNKNOWN_HOST_ERROR = 2005
+
+      ADAPTER_NAME = "Trilogy"
+
+      include DatabaseStatements
+
+      class << self
+        def new_client(config)
+          ::Trilogy.new(config)
+        rescue Trilogy::DatabaseError => error
+          raise translate_connect_error(config, error)
+        end
+
+        def translate_connect_error(config, error)
+          case error.error_code
+          when ER_BAD_DB_ERROR
+            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)
+          end
+        end
+      end
+
+      def supports_json?
+        !mariadb? && database_version >= "5.7.8"
+      end
+
+      def supports_comments?
+        true
+      end
+
+      def supports_comments_in_create?
+        true
+      end
+
+      def supports_savepoints?
+        true
+      end
+
+      def savepoint_errors_invalidate_transactions?
+        true
+      end
+
+      def supports_lazy_transactions?
+        true
+      end
+
+      def quote_string(string)
+        any_raw_connection.escape string
+      end
+
+      def active?
+        connection&.ping || false
+      rescue ::Trilogy::Error
+        false
+      end
+
+      alias reset! reconnect!
+
+      def disconnect!
+        unless connection.nil?
+          connection.close
+          self.connection = nil
+        end
+      end
+
+      def discard!
+        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?
+
+        keys = result.fields.map(&:to_sym)
+        result.rows.each do |row|
+          hash = {}
+          idx = 0
+          row.each do |value|
+            hash[keys[idx]] = value
+            idx += 1
+          end
+          yield hash
+        end
+
+        nil
+      end
+
+      def error_number(exception)
+        exception.error_code if exception.respond_to?(:error_code)
+      end
+
+      private
+        def connection
+          @raw_connection
+        end
+
+        def connection=(conn)
+          @raw_connection = conn
+        end
+
+        def connect
+          self.connection = self.class.new_client(@config)
+        end
+
+        def reconnect
+          connection&.close
+          connect
+        end
+
+        def full_version
+          schema_cache.database_version.full_version_string
+        end
+
+        def get_full_version
+          any_raw_connection.server_info[:version]
+        end
+
+        def translate_exception(exception, message:, sql:, binds:)
+          error_code = exception.error_code if exception.respond_to?(:error_code)
+
+          ::TrilogyAdapter::LostConnectionExceptionTranslator.
+            new(exception, message, error_code).translate || super
+        end
+    end
+  end
+end

data/lib/active_record/tasks/trilogy_database_tasks.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Use MySQLDatabaseTasks for Trilogy
+ActiveRecord::Tasks::DatabaseTasks.register_task(
+  "trilogy",
+  "ActiveRecord::Tasks::MySQLDatabaseTasks"
+)

data/lib/activerecord-trilogy-adapter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "trilogy_adapter/errors"
+require "trilogy_adapter/railtie"

data/lib/trilogy_adapter/connection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "trilogy"
+require "active_record/connection_adapters/trilogy_adapter"
+
+module TrilogyAdapter
+  # Necessary for enhancing ActiveRecord to recognize the Trilogy adapter. Example:
+  #
+  #   ActiveRecord::Base.public_send :extend, TrilogyAdapter::Connection
+  #
+  # This will allow downstream applications to use the Trilogy adapter. Example:
+  #
+  #   ActiveRecord::Base.establish_connection adapter: "trilogy",
+  #                                           host: "localhost",
+  #                                           database: "demo_development"
+  module Connection
+    def trilogy_connection(config)
+      configuration = config.dup
+
+      # Set FOUND_ROWS capability on the connection so UPDATE queries returns number of rows
+      # matched rather than number of rows updated.
+      configuration[:found_rows] = true
+
+      options = [
+        configuration[:host],
+        configuration[:port],
+        configuration[:database],
+        configuration[:username],
+        configuration[:password],
+        configuration[:socket],
+        0
+      ]
+
+      ActiveRecord::ConnectionAdapters::TrilogyAdapter.new nil, logger, options, configuration
+    end
+  end
+end

data/lib/trilogy_adapter/errors.rb

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

data/lib/trilogy_adapter/lost_connection_exception_translator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module TrilogyAdapter
+  class LostConnectionExceptionTranslator
+    attr_reader :exception, :message, :error_number
+
+    def initialize(exception, message, error_number)
+      @exception = exception
+      @message = message
+      @error_number = error_number
+    end
+
+    def translate
+      translate_database_exception || translate_ruby_exception || translate_trilogy_exception
+    end
+
+    private
+      ER_SERVER_SHUTDOWN = 1053
+      CR_SERVER_LOST = 2013
+      CR_SERVER_LOST_EXTENDED = 2055
+      CR_SERVER_GONE_ERROR = 2006
+
+      def translate_database_exception
+        case error_number
+        when ER_SERVER_SHUTDOWN
+          Errors::ServerShutdown.new(message)
+        when CR_SERVER_LOST, CR_SERVER_LOST_EXTENDED
+          Errors::ServerLost.new(message)
+        when CR_SERVER_GONE_ERROR
+          Errors::ServerGone.new(message)
+        end
+      end
+
+      def translate_ruby_exception
+        case exception
+        when Errno::EPIPE
+          Errors::BrokenPipe.new(message)
+        when SocketError
+          Errors::SocketError.new(message)
+        when Errno::ECONNRESET
+          Errors::ConnectionResetByPeer.new(message)
+        end
+      end
+
+      def translate_trilogy_exception
+        return unless exception.is_a?(Trilogy::Error)
+
+        case message
+        when /TRILOGY_CLOSED_CONNECTION/
+          Errors::ClosedConnection.new(message)
+        when /TRILOGY_INVALID_SEQUENCE_ID/
+          Errors::InvalidSequenceId.new(message)
+        when /TRILOGY_UNEXPECTED_PACKET/
+          Errors::UnexpectedPacket.new(message)
+        end
+      end
+  end
+end

data/lib/trilogy_adapter/rails/dbconsole.rb

@@ -0,0 +1,21 @@
+# 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

data/lib/trilogy_adapter/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+if defined?(Rails)
+  require "rails/railtie"
+
+  module TrilogyAdapter
+    class Railtie < ::Rails::Railtie
+      ActiveSupport.on_load(:active_record) do
+        require "trilogy_adapter/connection"
+        ActiveRecord::Base.public_send :extend, TrilogyAdapter::Connection
+      end
+    end
+  end
+end
+
+if defined?(Rails::DBConsole)
+  require "trilogy_adapter/rails/dbconsole"
+  Rails::DBConsole.prepend(TrilogyAdapter::Rails::DBConsole)
+end

data/lib/trilogy_adapter/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-trilogy-adapter
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- GitHub Engineering
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trilogy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0.alpha
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0.alpha
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description:
+email:
+- opensource+trilogy@github.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/active_record/connection_adapters/trilogy_adapter.rb
+- lib/active_record/tasks/trilogy_database_tasks.rb
+- lib/activerecord-trilogy-adapter.rb
+- 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
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Active Record adapter for https://github.com/github/trilogy.
+test_files: []