exceptional_synchrony 1.4.0.pre.1 → 1.4.2.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23aa4209588ee0dc66a1c96e25d1a524e1191f7d6f46a0acdfae90c04f19bf93
-  data.tar.gz: 1c40477122edb3b80bdfae312e486ef8a85cf4bac2c9ee78793e6de97bd72b5e
+  metadata.gz: 1034e6dbc52c216a8301e29b81dc902bf9336747570b110565771b98a1b1cd11
+  data.tar.gz: 3260814497d500bcc6fc6f2f9767a00acab6146ae1dea02619c25982ee686b53
 SHA512:
-  metadata.gz: 3fec9e8a041a72ee6c521d1ffb33eeef2a470c3df92b41dacaf7c57d6aa33fe0e3d2ee85392f68261c6ed00e29c0264f809dee303ba896bfc471682f161f2303
-  data.tar.gz: 04d48f19f25bcae51e5b97bf318f78c44151b3d3417dac6b536f25f7b2d778736de0b226aa80c540fbd14801c587c2ffd80e0f4c2890c2ef7003f46fb24f5add
+  metadata.gz: f825b8ca2b963781c1ccc9a0a8cbe9924ce857eae4d4c5bb5aceb496d2bfca5fa1ff74ab6fe4e3db29e785908612dea54e5c0b5a61552bc73941865e8dae1490
+  data.tar.gz: 912987b2df397343435fffbd1414375fd84c821e00629fe2d6a356b3c63d9daaf67dfaf5db91d714e896bc0f848bd61ef1b7b4cdc4efad1763b04c3614c5610f

data/CHANGELOG.md

@@ -6,10 +6,18 @@ Note: This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 
 All notable changes to this project will be documented in this file.
 
-## [1.4.0] - UNRELEASED
+## [1.4.2] - UNRELEASED
+### Fixed
+- Additional symbol reference fixes in FaradayAdapterPatch_v1
+
+## [1.4.1] - 2021-03-09
+### Fixed
+- FaradayAdapterPatch_v1 name typo
+
+## [1.4.0] - 2021-03-08
 ### Added
-- For users of `Faraday` connections, its `default_adapter` is configured to `:em_synchrony` when starting
-  the `EventMachine` reactor so that the reactor does not get blocked when using `Faraday`
+- Added use of Thread local variable to indicate when Eventmachine is running using EM::Synchrony
+- Added faraday gem monkey patch to use the new Thread local variable to choose the adapter to use
 
 ## [1.3.0] - 2021-02-04
 ### Added
@@ -29,6 +37,9 @@ All notable changes to this project will be documented in this file.
 ## [1.1.1] - 2020-05-03
 - Replace hobo_support with invoca_utils
 
+[1.4.2]: https://github.com/Invoca/exceptional_synchrony/compare/v1.4.1...v1.4.2
+[1.4.1]: https://github.com/Invoca/exceptional_synchrony/compare/v1.4.0...v1.4.1
+[1.4.0]: https://github.com/Invoca/exceptional_synchrony/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/Invoca/exceptional_synchrony/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/Invoca/exceptional_synchrony/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/Invoca/exceptional_synchrony/compare/v1.1.0...v1.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exceptional_synchrony (1.4.0.pre.1)
+    exceptional_synchrony (1.4.2.pre.1)
       em-http-request
       em-synchrony
       eventmachine
@@ -11,30 +11,30 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.1.1)
-      actionpack (= 6.1.1)
-      actionview (= 6.1.1)
-      activejob (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionmailer (6.1.3)
+      actionpack (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activesupport (= 6.1.3)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.1)
-      actionview (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.1)
-      activesupport (= 6.1.1)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.1)
-      activesupport (= 6.1.1)
+    activejob (6.1.3)
+      activesupport (= 6.1.3)
       globalid (>= 0.3.6)
-    activesupport (6.1.1)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -64,19 +64,21 @@ GEM
     em-synchrony (1.0.6)
       eventmachine (>= 1.0.0.beta.1)
     erubi (1.10.0)
+    escalate (0.3.0)
     eventmachine (1.2.7)
-    exception_handling (2.8.1)
+    exception_handling (2.9.0)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
       contextual_logger (~> 0.7)
+      escalate (~> 0.2)
       eventmachine (~> 1.0)
       invoca-utils (~> 0.3)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hashdiff (1.0.1)
     http_parser.rb (0.6.0)
-    i18n (1.8.8)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.4.1)
     json (2.5.1)

data/lib/exceptional_synchrony/event_machine_proxy.rb

@@ -3,6 +3,7 @@
 require 'eventmachine'
 require 'em-http'
 require 'em-synchrony/em-http'
+require_relative 'faraday_monkey_patch'
 
 module ExceptionalSynchrony
   # It is important for this exception to be inherited from Exception so that
@@ -62,6 +63,7 @@ module ExceptionalSynchrony
     def stop
       @proxy_class.stop
       @proxy_class.next_tick { } #Fake out EventMachine's epoll mechanism so we don't block until timers fire
+      Thread.current.thread_variable_set(:em_synchrony_reactor_thread, false)
     end
 
     def defers_finished?
@@ -72,11 +74,11 @@ module ExceptionalSynchrony
       @proxy_class.connect(server, port, handler, *args, &block)
     end
 
+    # This method starts the EventMachine reactor.
     # The on_error option has these possible values:
     #   :log   - log any rescued StandardError exceptions and continue
     #   :raise - raise FatalRunError for any rescued StandardError exceptions
     def run(on_error: :log, &block)
-      configure_faraday
       case on_error
       when :log   then run_with_error_logging(&block)
       when :raise then run_with_error_raising(&block)
@@ -134,15 +136,10 @@ module ExceptionalSynchrony
 
     private
 
-    def configure_faraday
-      if defined?(Faraday)
-        Faraday.default_adapter = :em_synchrony
-      end
-    end
-
     def run_with_error_logging(&block)
       ensure_completely_safe("run_with_error_logging") do
         if @proxy_class.respond_to?(:synchrony)
+          Thread.current.thread_variable_set(:em_synchrony_reactor_thread, true)
           @proxy_class.synchrony(&block)
         else
           @proxy_class.run(&block)
@@ -155,6 +152,7 @@ module ExceptionalSynchrony
 
       rescue_exceptions_and_ensure_exit("run_with_error_raising") do
         if @proxy_class.respond_to?(:synchrony)
+          Thread.current.thread_variable_set(:em_synchrony_reactor_thread, true)
           @proxy_class.synchrony(&run_block)
         else
           @proxy_class.run(&run_block)

data/lib/exceptional_synchrony/faraday_monkey_patch.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Monkey patch for the Faraday method that creates the adapter used for a connection.
+# If the thread local variable :em_synchrony_reactor_thread is true, it overrides this method
+# in order to force use of the :em_synchrony adapter rather than the :net_http adapter.
+# This ensures that the Eventmachine reactor does not get blocked by connection i/o.
+begin
+  require 'faraday'
+
+  module ExceptionalSynchrony
+    # Patch built relative to faraday v0.17.3
+    module FaradayAdapterPatch_v0
+      def adapter(key, *args, &block)
+
+        # BEGIN PATCH
+        if key == :net_http && Thread.current.thread_variable_get(:em_synchrony_reactor_thread)
+          key = :em_synchrony
+        end
+        # END PATCH
+
+        use_symbol(Faraday::Adapter, key, *args, &block)
+      end
+    end
+
+    # Patch built relative to faraday v1.3.0 although the ruby2_keywords prefix
+    # was dropped from the adapter method definition to simplify this code
+    module FaradayAdapterPatch_v1
+      def adapter(klass = Faraday::RackBuilder::NO_ARGUMENT, *args, &block)
+        return @adapter if klass == Faraday::RackBuilder::NO_ARGUMENT
+
+        klass = Faraday::Adapter.lookup_middleware(klass) if klass.is_a?(Symbol)
+
+        # BEGIN PATCH
+        if klass == Faraday::Adapter::NetHttp && Thread.current.thread_variable_get(:em_synchrony_reactor_thread)
+          klass = Faraday::Adapter::EMSynchrony
+        end
+        # END PATCH
+
+        @adapter = Faraday::RackBuilder::Handler.new(klass, *args, &block)
+      end
+    end
+  end
+
+  if Faraday::VERSION.start_with?("0")
+    Faraday::RackBuilder.prepend ExceptionalSynchrony::FaradayAdapterPatch_v0
+  else
+    Faraday::RackBuilder.prepend ExceptionalSynchrony::FaradayAdapterPatch_v1
+  end
+
+rescue LoadError
+  # Monkey patch is not needed if faraday is not available
+end

data/lib/exceptional_synchrony/version.rb

@@ -1,3 +1,3 @@
 module ExceptionalSynchrony
-  VERSION = '1.4.0.pre.1'
+  VERSION = '1.4.2.pre.1'
 end

data/test/unit/event_machine_proxy_test.rb

@@ -64,6 +64,14 @@ describe ExceptionalSynchrony::EventMachineProxy do
     @em.stop
   end
 
+  it "should set thread variable :em_synchrony_reactor_thread running to false when stop" do
+    @em.run do
+      assert_equal true, Thread.current.thread_variable_get(:em_synchrony_reactor_thread)
+      @em.stop
+      assert_equal false, Thread.current.thread_variable_get(:em_synchrony_reactor_thread)
+    end
+  end
+
   it "should proxy connect" do
     ServerClass = Class.new
     mock(EventMachine).connect(ServerClass, 8080, :handler, :extra_arg).yields(:called)
@@ -158,27 +166,6 @@ describe ExceptionalSynchrony::EventMachineProxy do
     end
   end
 
-  describe "run with faraday" do
-    it "should conigure Faraday default_adapter to :em_synchrony if Faraday is defined" do
-      class Faraday
-        class << self
-          attr_reader :default_adapter
-
-          def default_adapter=(adapter)
-            @default_adapter = adapter
-          end
-        end
-
-        self.default_adapter = :net_http
-      end
-
-      mock(@em).run_with_error_logging
-      assert_equal :net_http, Faraday.default_adapter
-      @em.run
-      assert_equal :em_synchrony, Faraday.default_adapter
-    end
-  end
-
   { synchrony: SynchronyProxyMock, run: RunProxyMock }.each do |method, proxy_mock|
     describe "run" do
       before do
@@ -192,6 +179,10 @@ describe ExceptionalSynchrony::EventMachineProxy do
       end
 
       describe "without error" do
+        before do
+          Thread.current.thread_variable_set(:em_synchrony_reactor_thread, nil)
+        end
+
         [:log, :raise].each do |on_error|
           describe "when using #{method} and on_error = #{on_error}" do
             it "should dispatch to the proxy's synchrony method instead of run iff synchrony" do
@@ -199,6 +190,15 @@ describe ExceptionalSynchrony::EventMachineProxy do
               assert_equal method, (@proxy.run(on_error: on_error) { dispatched = true })
               assert_equal true, dispatched
             end
+
+            if method == :synchrony
+              it "should set thread variable :em_synchrony_reactor_thread running to true" do
+                assert_nil Thread.current.thread_variable_get(:em_synchrony_reactor_thread)
+                @proxy.run(on_error: on_error) do
+                  assert_equal true, Thread.current.thread_variable_get(:em_synchrony_reactor_thread)
+                end
+              end
+            end
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exceptional_synchrony
 version: !ruby/object:Gem::Version
-  version: 1.4.0.pre.1
+  version: 1.4.2.pre.1
 platform: ruby
 authors:
 - Invoca
@@ -101,6 +101,7 @@ files:
 - lib/exceptional_synchrony.rb
 - lib/exceptional_synchrony/callback_exceptions.rb
 - lib/exceptional_synchrony/event_machine_proxy.rb
+- lib/exceptional_synchrony/faraday_monkey_patch.rb
 - lib/exceptional_synchrony/limited_work_queue.rb
 - lib/exceptional_synchrony/parallel_sync.rb
 - lib/exceptional_synchrony/version.rb