activerecord-aurora-serverless-adapter 1.0.0

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require_relative 'test/support/aasa_paths'
+require_relative 'test/support/aasa_rake'
+
+namespace :test do
+
+  %w(mysql).each do |mode|
+
+    Rake::TestTask.new(mode) do |t|
+      t.libs = AASA::Paths.test_load_paths
+      t.test_files = AASA::Rake.test_files
+      t.warning = !!ENV['WARNING']
+      t.verbose = false
+    end
+
+  end
+
+  task 'mysql:env' do
+    ENV['ARCONN'] = 'mysql'
+  end
+
+end
+
+task test: ['test:mysql']
+task 'test:mysql' => 'test:mysql:env'
+task default: [:test]

data/activerecord-aurora-serverless-adapter.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/connection_adapters/aurora_serverless/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-aurora-serverless-adapter"
+  spec.version       = ActiveRecord::ConnectionAdapters::AuroraServerless::VERSION
+  spec.authors       = ["Ken Collins"]
+  spec.email         = ["kcollins@customink.com"]
+  spec.summary       = %q{ActiveRecord Adapter for Amazon Aurora Serverless}
+  spec.description   = %q{Amazon Aurora Serverless is an on-demand, auto-scaling configuration for Amazon Aurora (MySQL-compatible and PostgreSQL-compatible editions). Perfect for small Rails on AWS Lambda.}
+  spec.homepage      = 'https://github.com/customink/activerecord-aurora-serverless-adapter'
+  spec.license       = 'MIT'
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency     'activerecord', '>= 6.0'
+  spec.add_runtime_dependency     'aws-sdk-rdsdataservice'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'minitest-retry'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/_setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+bundle config --local path 'vendor/bundle'
+bundle install --jobs 4 --retry 3

data/bin/_test

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -e
+
+export AWS_PROFILE=${AWS_PROFILE:=default}
+export AWS_DEFAULT_REGION=${AWS_DEFAULT_REGION:=us-east-1}
+
+echo "Run our isolated tests..."
+ONLY_AASA=1 bundle exec rake test
+
+echo "Run ActiveRecord tests touching arunit2..."
+ONLY_ACTIVERECORD=1 AASA_ARUNIT2=1 bundle exec rake test
+
+echo "Run isolated AASA_ARHABTM test..."
+ONLY_ACTIVERECORD=1 AASA_ARHABTM=1 bundle exec rake test
+echo "Run isolated AASA_ARCONHANDLER test..."
+ONLY_ACTIVERECORD=1 AASA_ARCONHANDLER=1 bundle exec rake test
+
+echo "Run ActiveRecord test batches 1..."
+ONLY_ACTIVERECORD=1 AASA_BATCH=1 bundle exec rake test
+echo "Run ActiveRecord test batches 2..."
+ONLY_ACTIVERECORD=1 AASA_BATCH=2 bundle exec rake test
+echo "Run ActiveRecord test batches 3..."
+ONLY_ACTIVERECORD=1 AASA_BATCH=3 bundle exec rake test

data/bin/bootstrap

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+touch .env
+
+docker-compose \
+  --project-name aasa \
+  build

data/bin/run

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+
+docker-compose \
+  --project-name aasa \
+  run \
+  ci \
+  $@

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+docker-compose \
+  --project-name aasa \
+  run \
+  ci \
+  ./bin/_setup

data/bin/test

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+docker-compose \
+  --project-name aasa \
+  run \
+  ci \
+  ./bin/_test

data/bin/test-ci-setup

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+mkdir -p ~/.aws
+
+cat >> ~/.aws/credentials << EOL
+[default]
+aws_access_key_id=${AWS_ACCESS_KEY_ID}
+aws_secret_access_key=${AWS_SECRET_ACCESS_KEY}
+EOL
+
+cat >> ~/.aws/config << EOL
+[default]
+region = us-east-1
+output = json
+EOL

data/docker-compose.yml

@@ -0,0 +1,36 @@
+version: "3.7"
+services:
+  ci:
+    build:
+      context: .
+      dockerfile: Dockerfile-ci
+    environment:
+      - AWS_PROFILE=${AWS_PROFILE}
+      - AASA_MASTER_USER=${AASA_MASTER_USER}
+      - AASA_MASTER_PASS=${AASA_MASTER_PASS}
+      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
+      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+      - AASA_SECRET_ARN=${AASA_SECRET_ARN}
+      - AASA_RESOURCE_ARN=${AASA_RESOURCE_ARN}
+      - AASA_SECRET_ARN2=${AASA_SECRET_ARN2}
+      - AASA_RESOURCE_ARN2=${AASA_RESOURCE_ARN2}
+    volumes:
+      - ~/.aws:/root/.aws:delegated
+      - .:/var/task:delegated
+  cdk:
+    build:
+      context: .
+      dockerfile: Dockerfile-cdk
+    environment:
+      - AWS_PROFILE=${AWS_PROFILE}
+      - AASA_MASTER_USER=${AASA_MASTER_USER}
+      - AASA_MASTER_PASS=${AASA_MASTER_PASS}
+      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
+      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+      - AASA_SECRET_ARN=${AASA_SECRET_ARN}
+      - AASA_RESOURCE_ARN=${AASA_RESOURCE_ARN}
+      - AASA_SECRET_ARN2=${AASA_SECRET_ARN2}
+      - AASA_RESOURCE_ARN2=${AASA_RESOURCE_ARN2}
+    volumes:
+      - ~/.aws:/root/.aws:delegated
+      - .:/var/task:delegated

data/lib/active_record/connection_adapters/aurora_serverless/abstract.rb

@@ -0,0 +1,29 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module AuroraServerless
+      module Abstract
+
+        # AbstractAdapter
+
+        def prepared_statements
+          false
+        end
+
+        # Database Statements
+
+        def begin_db_transaction
+          @connection.begin_db_transaction
+        end
+
+        def commit_db_transaction
+          @connection.commit_db_transaction
+        end
+
+        def exec_rollback_db_transaction
+          @connection.exec_rollback_db_transaction
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/aurora_serverless/client.rb

@@ -0,0 +1,152 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module AuroraServerless
+      class Client
+        attr_reader :database,
+                    :resource_arn,
+                    :secret_arn,
+                    :raw_client,
+                    :affected_rows,
+                    :last_id
+
+        def initialize(database, resource_arn, secret_arn, options = {})
+          @database = database
+          @resource_arn = resource_arn
+          @secret_arn = secret_arn
+          @raw_client = Aws::RDSDataService::Client.new(client_options(options))
+          @transactions = []
+          @affected_rows = 0
+          @debug_transactions = false # Development toggle.
+        end
+
+        def inspect
+          "#<#{self.class} database: #{database.inspect}, raw_client: #{raw_client.inspect}>"
+        end
+
+        def execute_statement(sql)
+          id = @transactions.first
+          debug_transactions "EXECUTE: #{sql}", id
+          raw_client.execute_statement({
+            sql: sql,
+            database: database,
+            secret_arn: secret_arn,
+            resource_arn: resource_arn,
+            include_result_metadata: true,
+            transaction_id: id
+          }).tap do |r|
+            @affected_rows = affected_rows_result(r)
+            @last_id = last_id_result(r)
+          end
+        rescue Exception => e
+          if id && e.message == "Transaction #{id} is not found"
+            @transactions.shift
+            retry
+          else
+            raise e
+          end
+        end
+
+        def begin_db_transaction
+          id = raw_client.begin_transaction({
+            database: database,
+            secret_arn: secret_arn,
+            resource_arn: resource_arn
+          }).try(:transaction_id)
+          debug_transactions 'BEGIN', id
+          @transactions.unshift(id) if id
+          true
+        end
+
+        def commit_db_transaction
+          id = @transactions.shift
+          return unless id
+          debug_transactions 'COMMIT', id
+          raw_client.commit_transaction({
+            secret_arn: secret_arn,
+            resource_arn: resource_arn,
+            transaction_id: id
+          })
+          true
+        rescue
+          @transactions.unshift(id) # For imminent rollback.
+        end
+
+        def exec_rollback_db_transaction
+          id = @transactions.shift
+          return unless id
+          debug_transactions 'ROLLBACK', id
+          raw_client.rollback_transaction({
+            secret_arn: secret_arn,
+            resource_arn: resource_arn,
+            transaction_id: id
+          })
+          true
+        end
+
+        private
+
+        def client_options(options)
+          options.slice(*CLIENT_OPTIONS)
+        end
+
+        def affected_rows_result(result)
+          result.number_of_records_updated || 0
+        end
+
+        def last_id_result(result)
+          fields = result.generated_fields || []
+          field = fields.last
+          return unless field
+          field.long_value || field.string_value || field.double_value
+        end
+
+        def debug_transactions(name, id = 'NOID')
+          return unless @debug_transactions
+          ActiveRecord::Base.logger.debug "  \e[36m#{name} #{id} #{object_id}\e[0m"
+        end
+
+        # From AWS docs at https://amzn.to/35V6O8L
+        CLIENT_OPTIONS = %i[
+          credentials
+          region
+          access_key_id
+          active_endpoint_cache
+          client_side_monitoring
+          client_side_monitoring_client_id
+          client_side_monitoring_host
+          client_side_monitoring_port
+          client_side_monitoring_publisher
+          convert_params
+          disable_host_prefix_injection
+          endpoint
+          endpoint_cache_max_entries
+          endpoint_cache_max_threads
+          endpoint_cache_poll_interval
+          endpoint_discovery
+          log_formatter
+          log_level
+          logger
+          profile
+          retry_base_delay
+          retry_jitter
+          retry_limit
+          retry_max_delay
+          secret_access_key
+          session_token
+          stub_responses
+          validate_params
+          http_proxy
+          http_open_timeout
+          http_read_timeout
+          http_idle_timeout
+          http_continue_timeout
+          http_wire_trace
+          ssl_verify_peer
+          ssl_ca_bundle
+          ssl_ca_directory
+        ].freeze
+
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/aurora_serverless/gem_hack.rb

@@ -0,0 +1,15 @@
+# Not perfect. We want to avoid bundling native gems
+# required in each adapter, like mysql2.
+#
+ORIG_GEM_METHOD = method(:gem)
+kernel = (class << ::Kernel; self; end)
+[kernel, ::Kernel].each do |k|
+  k.send :remove_method, :gem
+  k.send :define_method, :gem do |dep, *reqs|
+    # TODO: [PG] Add 'postgresql' here.
+    unless ['mysql2'].include?(dep)
+      ORIG_GEM_METHOD.call(dep, *reqs)
+    end
+  end
+  k.send :public, :gem
+end

data/lib/active_record/connection_adapters/aurora_serverless/mysql2.rb

@@ -0,0 +1,90 @@
+require 'active_record/connection_adapters/aurora_serverless/mysql2/result'
+require 'active_record/connection_adapters/aurora_serverless/mysql2/client'
+require 'active_record/connection_adapters/aurora_serverless/mysql2/connection_handling'
+require 'active_record/connection_adapters/aurora_serverless/gem_hack'
+require 'active_record/connection_adapters/mysql2_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class AuroraServerlessAdapter < Mysql2Adapter
+      include AuroraServerless::Abstract
+
+      def self.name
+        'Mysql2Adapter'
+      end if ENV['AASA_ENV'] == 'test'
+
+      def mysql2_connection(config)
+        aurora_serverless_connection(config)
+      end
+
+      # Abstract Mysql Adapter
+
+      def supports_advisory_locks?
+        false
+      end
+
+
+      private
+
+      def connect
+        @connection = ConnectionHandling.aurora_serverless_connection_from_config(@config)
+        configure_connection
+      end
+
+      # Abstract Mysql Adapter
+
+      def translate_exception(exception, message:, sql:, binds:)
+        msg = exception.message
+        case msg
+        when /Duplicate entry/
+          RecordNotUnique.new(msg, sql: sql, binds: binds)
+        when /foreign key constraint fails/
+          InvalidForeignKey.new(msg, sql: sql, binds: binds)
+        when /Cannot add foreign key constraint/,
+             /referenced column .* in foreign key constraint .* are incompatible/
+          mismatched_foreign_key(msg, sql: sql, binds: binds)
+        when /Data too long for column/
+          ValueTooLong.new(msg, sql: sql, binds: binds)
+        when /Out of range value for column/
+          RangeError.new(msg, sql: sql, binds: binds)
+        when /Column .* cannot be null/,
+             /Field .* doesn't have a default value/
+          NotNullViolation.new(msg, sql: sql, binds: binds)
+        when /Deadlock found when trying to get lock/
+          Deadlocked.new(msg, sql: sql, binds: binds)
+        when /Lock wait timeout exceeded/
+          LockWaitTimeout.new(msg, sql: sql, binds: binds)
+        when /max_statement_time exceeded/, /Sort aborted/
+          StatementTimeout.new(msg, sql: sql, binds: binds)
+        when /Query execution was interrupted/
+          QueryCanceled.new(msg, sql: sql, binds: binds)
+        else
+          ActiveRecord::StatementInvalid.new(msg, sql: sql, binds: binds)
+        end
+      end
+
+      # Database Statements
+
+      def execute_batch(sql, name = nil)
+        execute(sql, name)
+      end
+
+      def multi_statements_enabled?(flags)
+        false
+      end
+
+      def with_multi_statements
+        yield
+      end
+
+      def combine_multi_statements(total_sql)
+        total_sql
+      end
+
+      def max_allowed_packet
+        65536
+      end
+
+    end
+  end
+end