activerecord-aws_data_service_mysql-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea845acf007f68d7ab23d36b4c8047929b4a1595f40fc4987475cf7abe8eff52
+  data.tar.gz: 8d2c21499204eee1d1df81b629580d3cd72b6572e4440e920cd28ebc651c4739
+SHA512:
+  metadata.gz: acbf481ab559e9dd3f796e34fe91f654279ab906d06d1b124289fb5e3fe12b6f58315ef14448da896c6f3971f6f81b97fbb87f5c3ef00bc6c57f1ac2aec619f6
+  data.tar.gz: 9e09360e0d50c1edd8b0257ca56d4fc7bb2d91793a5a715874053eb83d2bc8b22ebe73f126e2f3e87c521b0b977a475bd3c61ecbfb11a220ba4bad8bd024cf56

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+*.env

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activerecord-aws_data_service_mysql-adapter.gemspec
+gemspec
+
+gem 'pry-byebug'
+
+# To find the original behavior
+gem 'mysql2'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    activerecord-aws_data_service_mysql-adapter (0.1.0)
+      activerecord (>= 6.0.0.rc2)
+      aws-sdk-rdsdataservice (>= 1.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0.rc2)
+      activesupport (= 6.0.0.rc2)
+    activerecord (6.0.0.rc2)
+      activemodel (= 6.0.0.rc2)
+      activesupport (= 6.0.0.rc2)
+    activesupport (6.0.0.rc2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.192.0)
+    aws-sdk-core (3.61.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-rdsdataservice (1.10.0)
+      aws-sdk-core (~> 3, >= 3.58.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    mysql2 (0.5.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-aws_data_service_mysql-adapter!
+  bundler (~> 1.17)
+  mysql2
+  pry-byebug
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Fumiaki MATSUSHIMA
+
+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,48 @@
+# Activerecord::AwsDataServiceMysql::Adapter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-aws_data_service_mysql-adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-aws_data_service_mysql-adapter
+
+## Usage
+
+```
+AWS_ACCESS_KEY_ID=xxxxx
+AWS_SECRET_ACCESS_KEY=xxxxx
+AWS_REGION=xxxxx
+DATABASE_URL=aws-data-service-mysql:///?secret_arn=arn:aws:secretsmanager:xxxxx:xxxxx:secret:xxxxx&resource_arn=arn:aws:rds:xxxxx:xxxxx:cluster:xxxxx
+```
+
+```ruby
+ActiveRecord::Base.connection.execute('SELECT 1')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activerecord::AwsDataServiceMysql::Adapter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/activerecord-aws_data_service_mysql-adapter.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-aws_data_service_mysql-adapter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Fumiaki MATSUSHIMA"]
+  spec.email         = ["mtsmfm@gmail.com"]
+
+  spec.summary       = %q{An Aurora Serverless ActiveRecord adapter}
+  spec.description   = %q{An Aurora Serverless ActiveRecord adapter}
+  spec.homepage      = "https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter"
+    spec.metadata["changelog_uri"] = "https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.devcontainer)/}) }
+  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.0.rc2"]
+  spec.add_runtime_dependency "aws-sdk-rdsdataservice", [">= 1.10.0"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/aws_data_service_mysql/adapter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/connection_adapters/aws_data_service_mysql/connection.rb

@@ -0,0 +1,120 @@
+require 'aws-sdk-rdsdataservice'
+
+module ActiveRecord
+  module ConnectionAdapters
+    module AwsDataServiceMysql
+      class Result
+        include Enumerable
+
+        def initialize(result, as:, symbolize_keys:, database_timezone:)
+          @result = result
+          @as = as
+          @symbolize_keys = symbolize_keys
+          @database_timezone = database_timezone
+        end
+
+        def each(as: @as, symbolize_keys: @symbolize_keys)
+          return unless @result.records || @result.generated_fields
+          raise if @result.records && @result.generated_fields
+
+          @result.lazy.flat_map {|page|
+            (page.records || [page.generated_fields]).map {|row|
+              row.map {|c| c.is_null ? nil : c.values.compact.first }
+            }
+          }.each do |row|
+            if as == :array
+              yield row
+            else
+              if symbolize_keys
+                yield fields.map(&:to_sym).zip(row).to_h
+              else
+                yield fields.zip(row).to_h
+              end
+            end
+          end
+        end
+
+        def fields
+          @fields ||= @result.column_metadata ? @result.column_metadata.map(&:label) : []
+        end
+      end
+
+      class Connection
+        attr_reader :query_options
+
+        def initialize(secret_arn:, resource_arn:, database:, **config)
+          @client = ::Aws::RDSDataService::Client.new
+          @secret_arn = secret_arn
+          @resource_arn = resource_arn
+          @database = database
+          @query_options = {
+            database_timezone: :local,
+            as: :array, # Mysql2 default is hash
+            symbolize_keys: false
+          }
+        end
+
+        def query(sql, **query_options)
+          _query(sql, **@query_options.merge(query_options))
+        end
+
+        def ping
+          query('SELECT 1')
+        end
+
+        def close
+          # nop
+        end
+
+        def abandon_results!
+          # nop
+        end
+
+        def affected_rows
+          @last_result.number_of_records_updated
+        end
+
+        def last_id
+          @last_result.generated_fields.first.values.compact.first
+        end
+
+        def server_info
+          {
+            version: query('SHOW VARIABLES LIKE "version";', as: :array).first.last
+          }
+        end
+
+        def begin_db_transaction
+          @current_transaction = client.begin_transaction(secret_arn: secret_arn, resource_arn: resource_arn, database: database)
+        end
+
+        def commit_db_transaction
+          client.commit_transaction(secret_arn: secret_arn, resource_arn: resource_arn, transaction_id: @current_transaction.transaction_id)
+          @current_transaction = nil
+        end
+
+        def exec_rollback_db_transaction
+          client.rollback_transaction(secret_arn: secret_arn, resource_arn: resource_arn, transaction_id: @current_transaction.transaction_id)
+          @current_transaction = nil
+        end
+
+        private
+
+        attr_reader :client, :secret_arn, :resource_arn, :database
+
+        def _query(sql, **options)
+          @last_result = client.execute_statement(
+            secret_arn: secret_arn, resource_arn: resource_arn, sql: sql, database: database, include_result_metadata: true, transaction_id: @current_transaction&.transaction_id
+          )
+          Result.new(@last_result, **options)
+        rescue Aws::RDSDataService::Errors::BadRequestException => error
+          if error.message.include?("No database selected")
+            raise ActiveRecord::NoDatabaseError
+          else
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/aws_data_service_mysql_adapter.rb

@@ -0,0 +1,73 @@
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+require 'active_record/connection_adapters/mysql/database_statements'
+
+require 'active_record/connection_adapters/aws_data_service_mysql/connection.rb'
+
+module ActiveRecord
+  module ConnectionHandling
+    def aws_data_service_mysql_connection(config)
+      ConnectionAdapters::AwsDataServiceMysqlAdapter.new(ConnectionAdapters::AwsDataServiceMysql::Connection.new(config), logger, nil, config)
+    end
+  end
+
+  module ConnectionAdapters
+    class AwsDataServiceMysqlAdapter < AbstractMysqlAdapter
+      ADAPTER_NAME = 'AwsDataServiceMysql'.freeze
+
+      include MySQL::DatabaseStatements
+
+      def initialize(*)
+        super
+        @prepared_statements = false
+      end
+
+      def each_hash(result)
+        if block_given?
+          result.each(as: :hash, symbolize_keys: true) do |row|
+            yield row
+          end
+        else
+          to_enum(:each_hash, result)
+        end
+      end
+
+      def begin_db_transaction
+        log('BEGIN') do
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            @connection.begin_db_transaction
+          end
+        end
+      end
+
+      def commit_db_transaction
+        log('COMMIT') do
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            @connection.commit_db_transaction
+          end
+        end
+      end
+
+      def exec_rollback_db_transaction
+        log('ROLLBACK') do
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            @connection.exec_rollback_db_transaction
+          end
+        end
+      end
+
+      private
+
+      def error_number(exception)
+        exception.error_number if exception.respond_to?(:error_number)
+      end
+
+      def full_version
+        schema_cache.database_version.full_version_string
+      end
+
+      def get_full_version
+        @connection.server_info[:version]
+      end
+    end
+  end
+end

data/test.rb

@@ -0,0 +1,68 @@
+require 'bundler'
+Bundler.require
+
+require 'active_record'
+require 'minitest/autorun'
+require 'logger'
+
+$LOAD_PATH << File.join(__dir__, 'lib')
+
+ActiveRecord::Base.establish_connection
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# DATABASE_URL=mysql2://mysql/database?pool=1 ruby test.rb
+
+begin
+  ActiveRecord::Tasks::DatabaseTasks.create_current('default_env')
+rescue
+end
+
+ActiveRecord::Base.establish_connection
+
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+  end
+
+  create_table :comments, force: true do |t|
+    t.integer :post_id
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class BugTest < Minitest::Test
+  def setup
+    Post.destroy_all
+    Comment.destroy_all
+  end
+
+  def test_association_stuff
+    post = Post.create!
+    post.comments << Comment.create!
+
+    assert_equal 1, post.comments.count
+    assert_equal 1, Comment.count
+    assert_equal post.id, Comment.first.post.id
+  end
+
+  def test_transaction
+    assert_equal 0, Post.count
+
+    Post.transaction do
+      Post.create!
+      Post.transaction(requires_new: true) do
+        Post.create!
+
+        raise ActiveRecord::Rollback
+      end
+    end
+
+    assert_equal 1, Post.count
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-aws_data_service_mysql-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fumiaki MATSUSHIMA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-rdsdataservice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An Aurora Serverless ActiveRecord adapter
+email:
+- mtsmfm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-aws_data_service_mysql-adapter.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/connection_adapters/aws_data_service_mysql/connection.rb
+- lib/active_record/connection_adapters/aws_data_service_mysql_adapter.rb
+- test.rb
+homepage: https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter
+  source_code_uri: https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter
+  changelog_uri: https://github.com/mtsmfm/activerecord-aws_data_service_mysql-adapter
+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.0.3
+signing_key: 
+specification_version: 4
+summary: An Aurora Serverless ActiveRecord adapter
+test_files: []