fibered_mysql2 0.2.0.pre.1 → 1.0.0.colin.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c336888076880a85f5be10b2784991a2a27784e9a3858bf97f79fe782ac6417f
-  data.tar.gz: 59b46276bb6fbc0f6ee2c609195e438cc440dc160b13b26b2d113d034fac004f
+  metadata.gz: 75d1eaf3701caa8823cdfbec61e7d9734d1e5f463e7936010c5636715591c2c9
+  data.tar.gz: 715db9f2e07df69a6cf51a2389404f030cd9c257524544cb77c16f53de36b944
 SHA512:
-  metadata.gz: 4df7a46c2f65f930c08fc5233e73d4fd8b13d4b899feffe04b40d45ea944e4e35c89eae567d77187fdc6fd416a25b6080bb0fd2de7b4a1d8dc10e054c508f692
-  data.tar.gz: 38300d691395f2f0c89cc4304c9e9f44df21f6e7df479ca9369e34829faa6eb3a366a0b0c470e1121a3311e8704f3b536fbcdff22fc7a974ff1ef0944ba00e50
+  metadata.gz: 9a21b639b0b0ab6afcb558978a7e1060510e7fc7ca5e9a833b27d2b8c9eb49d023ac5beb5e0c500c3a3ff711d7f6ee0e49ae61f4e72f941c7a07420f60b9c866
+  data.tar.gz: 99adce5422229bdea37a08ed76a4dad71c6f4108ce3588d42dadc3b6c6fbb2895f65532842739dbe83cd7d6c748ea4b0cf7d57d05ca8fc26cbd0c6e65ab17e41

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @Invoca/octothorpe

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.2.1

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.2.0] - 2023-01-12
+### Added
+- Added support for Rails 6+ by adding knowledge of lazy transactions to the adapter.
+
 ## [0.1.5] - 2022-03-25
 ### Changed
 - Upgraded Bundler to 2.2.29 and Ruby to 2.7.5. Removed support for Rails 4.
@@ -37,6 +41,7 @@ threaded, not fibered.
 - Added TravisCI unit test pipeline.
 - Added coverage reports via Coveralls.
 
+[0.2.0]: https://github.com/Invoca/fibered_mysql2/compare/v0.1.5..v0.2.0
 [0.1.5]: https://github.com/Invoca/fibered_mysql2/compare/v0.1.4..v0.1.5
 [0.1.4]: https://github.com/Invoca/fibered_mysql2/compare/v0.1.3..v0.1.4
 [0.1.3]: https://github.com/Invoca/fibered_mysql2/compare/v0.1.2..v0.1.3

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    fibered_mysql2 (0.2.0.pre.1)
-      em-synchrony (~> 1.0)
+    fibered_mysql2 (1.0.0.colin.1)
+      async
       rails (>= 5.2, < 7)
 
 GEM
@@ -67,10 +67,16 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    async (2.5.1)
+      console (~> 1.10)
+      io-event (~> 1.1)
+      timers (~> 4.1)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
+    console (1.16.2)
+      fiber-local
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -80,14 +86,13 @@ GEM
     crass (1.0.6)
     diff-lcs (1.4.4)
     docile (1.3.2)
-    em-synchrony (1.0.6)
-      eventmachine (>= 1.0.0.beta.1)
     erubi (1.10.0)
-    eventmachine (1.2.7)
+    fiber-local (1.0.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.7)
       concurrent-ruby (~> 1.0)
+    io-event (1.2.2)
     json (2.3.1)
     loofah (2.8.0)
       crass (~> 1.0.2)
@@ -103,7 +108,7 @@ GEM
     mini_mime (1.0.2)
     mini_portile2 (2.6.1)
     minitest (5.14.3)
-    mysql2 (0.5.3)
+    mysql2 (0.5.5)
     nio4r (2.5.4)
     nokogiri (1.12.5)
       mini_portile2 (~> 2.6.1)
@@ -175,6 +180,7 @@ GEM
       tins (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
+    timers (4.3.5)
     tins (1.25.0)
       sync
     tzinfo (1.2.9)

data/fibered_mysql2.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'em-synchrony', '~> 1.0'
+  spec.add_dependency 'async'
   spec.add_dependency 'rails', '>= 5.2', '< 7'
 end

data/lib/active_record/connection_adapters/fibered_mysql2_adapter.rb

@@ -1,88 +1,72 @@
 # frozen_string_literal: true
 
-require 'em-synchrony'
 require 'active_model'
 require 'active_record/errors'
-require 'active_record/connection_adapters/em_mysql2_adapter'
+require 'active_record/connection_adapters/mysql2_adapter'
+require_relative '../../fibered_mysql2/async_task'
 
 module FiberedMysql2
-  module FiberedMysql2Adapter_4_2
+  module FiberedMysql2Adapter_6
     def lease
-      synchronize do
-        unless in_use?
-          @owner = Fiber.current
-        end
-      end
-    end
-  end
-
-  module FiberedMysql2Adapter_5_2
-    def lease
-      if in_use?
-        msg = "Cannot lease connection, ".dup
-        if owner_fiber == Fiber.current
-          msg << "it is already leased by the current fiber."
+      if (ot = owner_task)
+        msg = +"Cannot lease connection; "
+        if ot == (current_task = AsyncTask.current_or_none)
+          msg << "it is already leased by the current Async::Task."
         else
-          msg << "it is already in use by a different fiber: #{owner_fiber}. " \
-                  "Current fiber: #{Fiber.current}."
+          msg << "it is already in use by a different Async::Task: #{ot}. " \
+                  "Current Async::Task: #{current_task}."
         end
         raise ::ActiveRecord::ActiveRecordError, msg
       end
 
-      @owner = Fiber.current
+      @owner = AsyncTask.current_or_none
     end
 
     def expire
-      if in_use?
-        # Because we are actively releasing connections from dead fibers, we only want
-        # to enforce that we're expiring the current fibers connection, iff the owner
+      if (ot = owner_task)
+        # Because we are actively releasing connections from dead tasks, we only want
+        # to enforce that we're expiring the current task's connection, iff the owner
         # of the connection is still alive.
-        if owner_fiber.alive? && owner_fiber != Fiber.current
-          raise ::ActiveRecord::ActiveRecordError, "Cannot expire connection, " \
-            "it is owned by a different fiber: #{owner_fiber}. " \
-            "Current fiber: #{Fiber.current}."
+        if ot.alive? && ot != (current_task = AsyncTask.current_or_none)
+          raise ::ActiveRecord::ActiveRecordError, "Cannot expire connection; " \
+            "it is owned by a different Async::Task: #{ot}. " \
+            "Current Async::Task: #{current_task}."
         end
 
         @idle_since = ::Concurrent.monotonic_time
         @owner = nil
       else
-        raise ::ActiveRecord::ActiveRecordError, "Cannot expire connection, it is not currently leased."
+        raise ::ActiveRecord::ActiveRecordError, "Cannot expire connection; it is not currently leased."
       end
     end
 
     def steal!
-      if in_use?
-        if owner_fiber != Fiber.current
-          pool.send :remove_connection_from_thread_cache, self, owner_fiber
+      if (ot = owner_task)
+        if ot != (current_task = AsyncTask.current_or_none)
+          pool.send :remove_connection_from_thread_cache, self, ot
 
-          @owner = Fiber.current
+          @owner = current_task
         end
       else
-        raise ::ActiveRecord::ActiveRecordError, "Cannot steal connection, it is not currently leased."
+        raise ::ActiveRecord::ActiveRecordError, "Cannot steal connection; it is not currently leased."
       end
     end
 
     private
 
-    def owner_fiber
-      @owner.nil? || @owner.is_a?(Fiber) or
-        raise "@owner must be a Fiber! Found #{@owner.inspect}"
+    def owner_task
+      @owner.nil? || @owner == AsyncTask::NoTaskPlaceholder || @owner.is_a?(Async::Task) or
+        raise "@owner must be an Async::Task or FiberedMysql2::AsyncTask::NoTaskPlaceholder! Found #{@owner.inspect}"
       @owner
     end
   end
 
-  class FiberedMysql2Adapter < ::ActiveRecord::ConnectionAdapters::EMMysql2Adapter
+  class FiberedMysql2Adapter < ::ActiveRecord::ConnectionAdapters::Mysql2Adapter
     case ::Rails::VERSION::MAJOR
-    when 4
-      include FiberedMysql2Adapter_4_2
-    when 5
-      include FiberedMysql2Adapter_5_2
     when 6
-      include FiberedMysql2Adapter_5_2
-
-      def supports_lazy_transactions?
-        false
-      end
+      include FiberedMysql2Adapter_6
+    else
+      raise ArgumentError, "unexpected Rails version #{Rails::VERSION::MAJOR}"
     end
 
     def initialize(*args)

data/lib/fibered_mysql2/async_task.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FiberedMysql2
+  module AsyncTask
+    class NoTaskPlaceholder
+      class << self
+        def alive? = true
+      end
+    end
+
+    class << self
+      # Adapted from https://github.com/socketry/async/blob/main/lib/async/task.rb#L236-L238
+      def current_or_none
+        Thread.current[:async_task] || NoTaskPlaceholder
+      end
+    end
+  end
+end

data/lib/fibered_mysql2/fibered_database_connection_pool.rb

@@ -1,240 +1,39 @@
 # frozen_string_literal: true
 
-# This class behaves the same as ActiveRecord's ConnectionPool, but synchronizes with fibers rather than threads.
+# This class behaves the same as ActiveRecord's ConnectionPool, but synchronizes with Async::Task 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
-    EXCEPTION_NEVER = {Exception => :never}.freeze
-    EXCEPTION_IMMEDIATE = {Exception => :immediate}.freeze
-
-    #
-    # FIXME: This isn't documented in Nutshell.
-    #
-    # Since MonitorMixin.new_cond returns a ConditionVariable, and the example
-    # above calls while_wait and signal, this class should be documented.
-    #
-    class Timeout < Exception; end
-
-    #
-    # Releases the lock held in the associated monitor and waits; reacquires the lock on wakeup.
-    #
-    # If +timeout+ is given, this method returns after +timeout+ seconds passed,
-    # even if no other thread doesn't signal.
-    #
-    def wait(timeout = nil)
-      Thread.handle_interrupt(EXCEPTION_NEVER) do
-        @monitor.__send__(:mon_check_owner)
-        count = @monitor.__send__(:mon_exit_for_cond)
-        begin
-          Thread.handle_interrupt(EXCEPTION_IMMEDIATE) do
-            @cond.wait(@monitor.instance_variable_get(:@mon_mutex), timeout)
-          end
-          return true
-        ensure
-          @monitor.__send__(:mon_enter_for_cond, count)
-        end
-      end
-    end
-
-    #
-    # Calls wait repeatedly while the given block yields a truthy value.
-    #
-    def wait_while
-      while yield
-        wait
-      end
-    end
-
-    #
-    # Calls wait repeatedly until the given block yields a truthy value.
-    #
-    def wait_until
-      until yield
-        wait
-      end
-    end
-
-    #
-    # Wakes up the first thread in line waiting for this lock.
-    #
-    def signal
-      @monitor.__send__(:mon_check_owner)
-      @cond.signal
-    end
-
-    #
-    # Wakes up all threads waiting for this lock.
-    #
-    def broadcast
-      @monitor.__send__(:mon_check_owner)
-      @cond.broadcast
-    end
-
-    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
+  module FiberedDatabaseConnectionPool
+    case ::Rails::VERSION::MAJOR
+    when 6
+    else
+      raise ArgumentError, "unexpected Rails version #{Rails::VERSION::MAJOR}"
     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
+    def cached_connections
+      @thread_cached_conns
     end
 
-    #
-    # Leaves exclusive section.
-    #
-    def mon_exit
-      mon_check_owner
-      @mon_count -= 1
-      if @mon_count == 0
-        @mon_owner = nil
-        @mon_mutex.unlock
-      end
+    def current_connection_id
+      connection_cache_key(current_thread)
     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
+    def checkout(checkout_timeout = @checkout_timeout)
       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
-
-    # 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
-
-    private
-
-    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
+        reap_connections
+      rescue => ex
+        ActiveRecord::Base.logger.error("Exception occurred while executing reap_connections: #{ex.class}: #{ex.message}")
       end
+      super
     end
 
-    module Adapter_5_2
-      def cached_connections
-        @thread_cached_conns
-      end
-
-      def current_connection_id
-        connection_cache_key(current_thread)
+    def release_connection(owner_task = AsyncTask.current_or_none)
+      if (conn = @thread_cached_conns.delete(connection_cache_key(owner_task)))
+        checkin(conn)
       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)
@@ -282,7 +81,7 @@ module FiberedMysql2
     end
 
     def current_thread
-      Fiber.current
+      AsyncTask.current_or_none
     end
   end
 end

data/lib/fibered_mysql2/fibered_mysql2_connection_factory.rb

@@ -2,57 +2,6 @@
 
 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)
@@ -63,10 +12,10 @@ module FiberedMysql2
 
       client =
           begin
-            Mysql2::EM::Client.new(config)
+            Mysql2::Client.new(config)
           rescue Mysql2::Error => error
             if error.message.include?("Unknown database")
-              raise ActiveRecord::NoDatabaseError.new(error.message, error)
+              raise ActiveRecord::NoDatabaseError.new(error.message)
             else
               raise
             end

data/lib/fibered_mysql2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FiberedMysql2
-  VERSION = "0.2.0.pre.1"
+  VERSION = "1.0.0.colin.1"
 end

data/lib/fibered_mysql2.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'async'
 require 'fibered_mysql2/version'
 require_relative '../lib/active_record/connection_adapters/fibered_mysql2_adapter'
 require 'fibered_mysql2/fibered_database_connection_pool'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fibered_mysql2
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.1
+  version: 1.0.0.colin.1
 platform: ruby
 authors:
 - Invoca Development
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: em-synchrony
+  name: async
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/workflows/build.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
@@ -69,6 +70,7 @@ files:
 - gemfiles/rails_6.gemfile
 - lib/active_record/connection_adapters/fibered_mysql2_adapter.rb
 - lib/fibered_mysql2.rb
+- lib/fibered_mysql2/async_task.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
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: An adapter for fibered mysql2