fibered_mysql2 0.1.0.pre.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20d3f46c3c9b81ecdce87f118026e95bfe623322dc69deddd6beec758d550350
-  data.tar.gz: 4193bb8362385556eeb6b966814ec5809d0e1a68c9a09ebd5e235165b298db5c
+  metadata.gz: 48308ffbe571baaa919c2f198d761657f9f77b95a87f67c3ef7493433a3e4a6a
+  data.tar.gz: c5893a679a730bfd7e1a088a06f86b82d65c95da9b9171fcb419f27298ca268c
 SHA512:
-  metadata.gz: 8ff1891831752d602a3a56dec657d7b8b6111d7257e3c890c33acddd95a4b0651a5309d44aae7ac21184b0b614e58f4c70fe40f58f3eb62eaab8fcd66e52e14a
-  data.tar.gz: c3cf276f8e0eaf7a99626c6aa5e0d34993d9763fd382782c7fb73605fa5211a45508324f442e6eb57f7a25896db2e44bf1102e0e99f6a0007b5dd02b6910a23c
+  metadata.gz: af9979eb4a038db1fcbec58dc5a88d617a71271c1588ff0717a4792f5442b3c59d82e9bc8d76b59821179099c87c8387a72bbbcdb096d10991320e7001c4bda8
+  data.tar.gz: 05a912e4b5504aebfb6a0ad5e8a29e72cb8e739066279982ead7aa89ca97b9308f2144ed6142833cba84ad7939c8ee0d364e71065606221ebe52cf4ee35ce0e1

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/Appraisals

@@ -9,5 +9,5 @@ appraise 'rails-5' do
 end
 
 appraise 'rails-6' do
-  gem 'rails', '~> 6.0'
+  gem 'rails', '~> 6.0.0'
 end

data/CHANGELOG.md

@@ -4,11 +4,20 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - Unreleased
+## [0.1.1] - 2021-02-12
+### Fixed
+- Fixed bug with Rails 5+ adapter where connections that have `steal!` called on them were not having their owner updated to the current Fiber, which would then cause an exception when trying to expire the connection (this showed up with the Rails 5 `ConnectionPool::Reaper` that reaps unused connections)
+
+### Changed
+- Updated Rails 6 dependency to 6.0.x for now as 6.1+ requires a newer version of the mysql gem (0.5+) that we do not yet support
+
+
+## [0.1.0] - 2020-10-23
 ### Added
-- An adapter for Rails 4, 5, and 6.
-- Appraisals for Rails 4, 5, and 6.
-- TravisCI unit test pipeline.
-- Coverage reports via Coveralls.
+- Added an adapter for Rails 4, 5, and 6.
+- Added appraisals for Rails 4, 5, and 6.
+- Added TravisCI unit test pipeline.
+- Added coverage reports via Coveralls.
 
-[0.1.0]: https://github.com/Invoca/fibered_mysql2/tree/v0.1.0
+[0.1.1]: https://github.com/Invoca/fibered_mysql2/compare/v0.1.0..v0.1.1
+[0.1.0]: https://github.com/Invoca/fibered_mysql2/tree/v0.1.0

data/Gemfile.lock

@@ -1,63 +1,63 @@
 PATH
   remote: .
   specs:
-    fibered_mysql2 (0.1.0.pre.2)
+    fibered_mysql2 (0.1.1)
       em-synchrony (~> 1.0)
       rails (>= 4.2, < 7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.3)
-      actionpack (= 6.0.3.3)
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      activestorage (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      actionview (= 6.0.3.3)
-      activejob (= 6.0.3.3)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.3)
-      actionview (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      activestorage (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.3)
-      activesupport (= 6.0.3.3)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.3)
-      activesupport (= 6.0.3.3)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activerecord (6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activestorage (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
       marcel (~> 0.3.1)
-    activesupport (6.0.3.3)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -114,29 +114,29 @@ GEM
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.3)
-      actioncable (= 6.0.3.3)
-      actionmailbox (= 6.0.3.3)
-      actionmailer (= 6.0.3.3)
-      actionpack (= 6.0.3.3)
-      actiontext (= 6.0.3.3)
-      actionview (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      activestorage (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.3)
+      railties (= 6.0.3.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)

data/README.md

@@ -29,7 +29,7 @@ Behaves the same as `ActiveRecord::ConnectionAdapters::EMMysql2Adapter` but with
 ```ruby
 connection = FiberedMysql2::FiberedMysql2Adapter.new(client, logger, options, config)
 connection.lease
-connection.expire // Rails 5+ only
+connection.expire # Rails 5+ only
 ```
 
 ## Development

data/fibered_mysql2.gemspec

@@ -7,16 +7,18 @@ require "fibered_mysql2/version"
 Gem::Specification.new do |spec|
   spec.name          = "fibered_mysql2"
   spec.version       = FiberedMysql2::VERSION
-  spec.authors       = ["Octothorp"]
-  spec.email         = ["octothorp@invoca.com"]
+  spec.authors       = ["Invoca Development"]
+  spec.email         = ["development@invoca.com"]
 
   spec.summary       = "An adapter for fibered mysql2"
   spec.homepage      = "https://github.com/Invoca/fibered_mysql2"
 
   # 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.
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "homepage_uri"      => spec.homepage
+  }
 
   # 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.

data/gemfiles/rails_6.gemfile

@@ -10,6 +10,6 @@ gem "pry", "~> 0.13"
 gem "pry-byebug", "~> 3.9"
 gem "rake", "~> 10.0"
 gem "rspec", "~> 3.0"
-gem "rails", "~> 6.0"
+gem "rails", "~> 6.0.0"
 
 gemspec path: "../"

data/lib/{fibered_mysql2 → active_record/connection_adapters}/fibered_mysql2_adapter.rb

@@ -49,6 +49,18 @@ module FiberedMysql2
         raise ::ActiveRecord::ActiveRecordError, "Cannot expire connection, it is not currently leased."
       end
     end
+
+    def steal!
+      if in_use?
+        if @owner != Fiber.current
+          pool.send :remove_connection_from_thread_cache, self, @owner
+
+          @owner = Fiber.current
+        end
+      else
+        raise ::ActiveRecord::ActiveRecordError, "Cannot steal connection, it is not currently leased."
+      end
+    end
   end
 
   class FiberedMysql2Adapter < ::ActiveRecord::ConnectionAdapters::EMMysql2Adapter

data/lib/fibered_mysql2.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-require "fibered_mysql2/version"
+require 'fibered_mysql2/version'
+require_relative '../lib/active_record/connection_adapters/fibered_mysql2_adapter'
+require 'fibered_mysql2/fibered_database_connection_pool'
+require 'fibered_mysql2/fibered_mutex_with_waiter_priority'
+require 'fibered_mysql2/fibered_mysql2_connection_factory'
 
 module FiberedMysql2
   class Error < StandardError; end

data/lib/fibered_mysql2/fibered_database_connection_pool.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+# This class behaves the same as ActiveRecord's ConnectionPool, but synchronizes with fibers rather than threads.
+
+# Note - trace statements have been commented out.  This is useful trace but we do not want it on by default.
+#        When we have configurable logging we can put this back and have it off by default.
+
+require 'em-synchrony'
+require 'em-synchrony/thread'
+require 'fibered_mysql2/fibered_mutex_with_waiter_priority'
+
+EventMachine::Synchrony::Thread::Mutex.prepend(FiberedMysql2::FiberedMutexWithWaiterPriority)
+
+module FiberedMysql2
+  class FiberedConditionVariable < MonitorMixin::ConditionVariable
+    def initialize(monitor)
+      @monitor = monitor
+      @cond = EM::Synchrony::Thread::ConditionVariable.new
+    end
+  end
+
+  # From Ruby's MonitorMixin, with all occurrences of Thread changed to Fiber
+  module FiberedMonitorMixin
+    def self.extend_object(obj)
+      super
+      obj.__send__(:mon_initialize)
+    end
+
+    #
+    # Attempts to enter exclusive section.  Returns +false+ if lock fails.
+    #
+    def mon_try_enter
+      if @mon_owner != Fiber.current
+        @mon_mutex.try_lock or return false
+        @mon_owner = Fiber.current
+        @mon_count = 0
+      end
+      @mon_count += 1
+      true
+    end
+
+    #
+    # Enters exclusive section.
+    #
+    def mon_enter
+      if @mon_owner != Fiber.current
+        @mon_mutex.lock
+        @mon_owner = Fiber.current
+        @mon_count = 0
+      end
+      @mon_count += 1
+    end
+
+    #
+    # Leaves exclusive section.
+    #
+    def mon_exit
+      mon_check_owner
+      @mon_count -= 1
+      if @mon_count == 0
+        @mon_owner = nil
+        @mon_mutex.unlock
+      end
+    end
+
+    #
+    # Enters exclusive section and executes the block.  Leaves the exclusive
+    # section automatically when the block exits.  See example under
+    # +MonitorMixin+.
+    #
+    def mon_synchronize
+      mon_enter
+      begin
+        yield
+      ensure
+        begin
+          mon_exit
+        rescue => ex
+          ActiveRecord::Base.logger.error("Exception occurred while executing mon_exit: #{ex}")
+        end
+      end
+    end
+    alias synchronize mon_synchronize
+
+    #
+    # Creates a new FiberedConditionVariable associated with the
+    # receiver.
+    #
+    def new_cond
+      FiberedConditionVariable.new(self)
+    end
+
+    private
+
+    # Initializes the FiberedMonitorMixin after being included in a class
+    def mon_initialize
+      @mon_owner = nil
+      @mon_count = 0
+      @mon_mutex = EM::Synchrony::Thread::Mutex.new
+    end
+
+    def mon_check_owner
+      @mon_owner == Fiber.current or raise FiberError, "current fiber not owner"
+    end
+
+    def mon_enter_for_cond(count)
+      @mon_owner = Fiber.current
+      @mon_count = count
+    end
+
+    # returns the old mon_count
+    def mon_exit_for_cond
+      count = @mon_count
+      @mon_owner = nil
+      @mon_count = 0
+      count
+    end
+  end
+
+  module FiberedDatabaseConnectionPool
+    include FiberedMonitorMixin
+
+    module Adapter_4_2
+      def cached_connections
+        @reserved_connections
+      end
+
+      def current_connection_id
+        ActiveRecord::Base.connection_id ||= Fiber.current.object_id
+      end
+
+      def checkout
+        begin
+          reap_connections
+        rescue => ex
+          ActiveRecord::Base.logger.error("Exception occurred while executing reap_connections: #{ex}")
+        end
+        super
+      end
+    end
+
+    module Adapter_5_2
+      def cached_connections
+        @thread_cached_conns
+      end
+
+      def current_connection_id
+        connection_cache_key(current_thread)
+      end
+
+      def checkout(checkout_timeout = @checkout_timeout)
+        begin
+          reap_connections
+        rescue => ex
+          ActiveRecord::Base.logger.error("Exception occurred while executing reap_connections: #{ex}")
+        end
+        super
+      end
+
+      def release_connection(owner_thread = Fiber.current)
+        if (conn = @thread_cached_conns.delete(connection_cache_key(owner_thread)))
+          checkin(conn)
+        end
+      end
+    end
+
+    case Rails::VERSION::MAJOR
+    when 4
+      include Adapter_4_2
+    when 5, 6
+      include Adapter_5_2
+    end
+
+    def initialize(connection_spec, *args, **keyword_args)
+      connection_spec.config[:reaping_frequency] and raise "reaping_frequency is not supported (the ActiveRecord Reaper is thread-based)"
+
+      super(connection_spec, *args, **keyword_args)
+
+      @reaper = nil # no need to keep a reference to this since it does nothing in this sub-class
+
+      # note that @reserved_connections is a ThreadSafe::Cache which is overkill in a fibered world, but harmless
+    end
+
+    def connection
+      # this is correctly done double-checked locking
+      # (ThreadSafe::Cache's lookups have volatile semantics)
+      if (result = cached_connections[current_connection_id])
+        result
+      else
+        synchronize do
+          if (result = cached_connections[current_connection_id])
+            result
+          else
+            cached_connections[current_connection_id] = checkout
+          end
+        end
+      end
+    end
+
+    def reap_connections
+      cached_connections.values.each do |connection|
+        unless connection.owner.alive?
+          checkin(connection)
+        end
+      end
+    end
+
+    private
+
+    #--
+    # This hook-in method allows for easier monkey-patching fixes needed by
+    # JRuby users that use Fibers.
+    def connection_cache_key(fiber)
+      fiber
+    end
+
+    def current_thread
+      Fiber.current
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::ConnectionPool.prepend(FiberedMysql2::FiberedDatabaseConnectionPool)

data/lib/fibered_mysql2/fibered_mutex_with_waiter_priority.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FiberedMysql2
+  module FiberedMutexWithWaiterPriority
+    # Note: @waiters is a bit confusing because the first waiter is actually the current fiber that has it locked;
+    # the _rest_ of @waiters are the actual waiters
+    def sleep(timeout = nil)
+      unlock
+      beg = Time.now
+      current = Fiber.current
+      @slept[current] = true
+      if timeout
+        timer = EM.add_timer(timeout) do
+          _wakeup(current)
+        end
+        Fiber.yield
+        EM.cancel_timer(timer) # if we resumed not via timer
+      else
+        Fiber.yield
+      end
+      @slept.delete(current)
+      yield if block_given?
+
+      # Invoca patch: inline lock that puts us at the front of the mutex @waiters queue instead of the back
+      # ==========================
+      @waiters.unshift(current)
+      Fiber.yield if @waiters.size > 1
+      # ==========================
+
+      Time.now - beg
+    end
+  end
+end

data/lib/fibered_mysql2/fibered_mysql2_connection_factory.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../active_record/connection_adapters/fibered_mysql2_adapter'
+
+module EM::Synchrony
+  module ActiveRecord
+    _ = Adapter_4_2
+    module Adapter_4_2
+      def configure_connection
+        super                   # undo EM::Synchrony's override here
+      end
+
+      def transaction(*args)
+        super                   # and here
+      end
+
+      _ = TransactionManager
+      class TransactionManager < _
+        if Rails::VERSION::MAJOR > 5
+          # Overriding the em-synchrony override to bring it up to rails 6 requirements.
+          # Changes from the original Rails 6 source are:
+          #   1. the usage of _current_stack created by em-synchrony instead of the Rails provided @stack instance variable
+          #   2. the usage of Fiber.current.object_id as a part of the savepoint transaction name
+          #
+          # Original EM Synchrony Source:
+          # https://github.com/igrigorik/em-synchrony/blob/master/lib/em-synchrony/activerecord_4_2.rb#L35-L44
+          #
+          # Original Rails Source:
+          # https://github.com/rails/rails/blob/6-0-stable/activerecord/lib/active_record/connection_adapters/abstract/transaction.rb#L205-L224
+          def begin_transaction(options = {})
+            @connection.lock.synchronize do
+              run_commit_callbacks = !current_transaction.joinable?
+              transaction =
+                  if _current_stack.empty?
+                    ::ActiveRecord::ConnectionAdapters::RealTransaction.new(@connection, options, run_commit_callbacks: run_commit_callbacks)
+                  else
+                    ::ActiveRecord::ConnectionAdapters::SavepointTransaction.new(@connection, "active_record_#{Fiber.current.object_id}_#{open_transactions}", _current_stack.last, options,
+                                                                                 run_commit_callbacks: run_commit_callbacks)
+                  end
+
+              if @connection.supports_lazy_transactions? && lazy_transactions_enabled? && options[:_lazy] != false
+                @has_unmaterialized_transactions = true
+              else
+                transaction.materialize!
+              end
+              _current_stack.push(transaction)
+              transaction
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module FiberedMysql2
+  module FiberedMysql2ConnectionFactory
+    def fibered_mysql2_connection(raw_config)
+      config = raw_config.symbolize_keys
+
+      config[:username] = 'root' if config[:username].nil?
+      config[:flags]    = Mysql2::Client::FOUND_ROWS if Mysql2::Client.const_defined?(:FOUND_ROWS)
+
+      client =
+          begin
+            Mysql2::EM::Client.new(config)
+          rescue Mysql2::Error => error
+            if error.message.include?("Unknown database")
+              raise ActiveRecord::NoDatabaseError.new(error.message, error)
+            else
+              raise
+            end
+          end
+
+      options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
+      FiberedMysql2Adapter.new(client, logger, options, config)
+    end
+  end
+end
+
+ActiveRecord::Base.class.prepend(FiberedMysql2::FiberedMysql2ConnectionFactory)

data/lib/fibered_mysql2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FiberedMysql2
-  VERSION = "0.1.0.pre.2"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fibered_mysql2
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.2
+  version: 0.1.1
 platform: ruby
 authors:
-- Octothorp
+- Invoca Development
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-synchrony
@@ -46,7 +46,7 @@ dependencies:
         version: '7'
 description:
 email:
-- octothorp@invoca.com
+- development@invoca.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -66,8 +66,11 @@ files:
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_5.gemfile
 - gemfiles/rails_6.gemfile
+- lib/active_record/connection_adapters/fibered_mysql2_adapter.rb
 - lib/fibered_mysql2.rb
-- lib/fibered_mysql2/fibered_mysql2_adapter.rb
+- lib/fibered_mysql2/fibered_database_connection_pool.rb
+- lib/fibered_mysql2/fibered_mutex_with_waiter_priority.rb
+- lib/fibered_mysql2/fibered_mysql2_connection_factory.rb
 - lib/fibered_mysql2/version.rb
 homepage: https://github.com/Invoca/fibered_mysql2
 licenses: []
@@ -85,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.1
 signing_key: