exceptional_synchrony 1.4.0.pre.2 → 1.4.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7337c98f6e124b7e27327707ad7996bea893fe5c005ae57627e855ec35c77ff4
-  data.tar.gz: 2603dc05990ab4c3f257409382f8fc6453f8e22446a82a1ad9841564b509994e
+  metadata.gz: f2d07494229878e6b59b249b36914d1a6487393ebd636ac239c0f865abbd1bf1
+  data.tar.gz: af0fba3287a3c9dad53c46cb3f6290c2ba478cd9ef41a1811f8ac4d008837564
 SHA512:
-  metadata.gz: bd0b2894a70161f7162c465aacf315cada6748267d88590bb943d3c68ad382f0ed1b910224738f54b1a1ada219f894b9fd64bcb2f06c7f3b95f0c9b3efb1d218
-  data.tar.gz: b9b7c5fde46b71d32651108b855f4396517e32a73915b1e3bc09e258a5bcee678d3946ca3fc6c768eef1deebc0edaa66e4e41898b3a08a6d95e993c0bc12339e
+  metadata.gz: ccbed6964c6408c17d178d48641c0f96941ee997f55b5656d59c1d3f0a31c97a2c5de2fd2f752297ee99cbd1d0e35e86746adf2cf44a0d29b8cb9df120f53dc4
+  data.tar.gz: b04f34c08e1a9da226a9bf679985017cd6e86b18f173152169e7be9cf7e143c46fbe85cee265ce6112e4fc03a369abb39cbf14cf9070684375a31c4f4c941c3d

data/CHANGELOG.md

@@ -8,8 +8,7 @@ All notable changes to this project will be documented in this file.
 
 ## [1.4.0] - UNRELEASED
 ### Added
-- Added `:faraday_adapter` option to `EventMachineProxy#run` with a default of `:em_synchrony`
-  so that the reactor does not get blocked when using `Faraday` connections
+- Added use of Thread local variable to indicate when Eventmachine is running using EM::Synchrony
 
 ## [1.3.0] - 2021-02-04
 ### Added
@@ -29,6 +28,7 @@ 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.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.2)
+    exceptional_synchrony (1.4.0.pre.3)
       em-http-request
       em-synchrony
       eventmachine
@@ -87,15 +87,13 @@ GEM
       mini_mime (>= 0.1.1)
     method_source (1.0.0)
     mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
     minitest (5.14.0)
     minitest-reporters (1.4.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.11.1-x86_64-darwin)
       racc (~> 1.4)
     pry (0.13.1)
       coderay (~> 1.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?
@@ -76,12 +78,7 @@ module ExceptionalSynchrony
     # The on_error option has these possible values:
     #   :log   - log any rescued StandardError exceptions and continue
     #   :raise - raise FatalRunError for any rescued StandardError exceptions
-    # The faraday_adapter option has these possible values that only apply if Faraday connections are in use:
-    #   :em_synchrony - for use when EM::Synchrony is being used in all threads of the given process
-    #   :net_http     - for use when EM::Synchrony is being used in only some threads of the given process;
-    #                   in this case requests made over the Faraday connection will block the reactor
-    def run(on_error: :log, faraday_adapter: :em_synchrony, &block)
-      configure_faraday(faraday_adapter)
+    def run(on_error: :log, &block)
       case on_error
       when :log   then run_with_error_logging(&block)
       when :raise then run_with_error_raising(&block)
@@ -139,16 +136,10 @@ module ExceptionalSynchrony
 
     private
 
-    def configure_faraday(adapter)
-      if defined?(Faraday)
-        adapter.in?([:em_synchrony, :net_http]) or raise ArgumentError, "Invalid faraday_adapter: #{adapter.inspect}"
-        Faraday.default_adapter = adapter
-      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)
@@ -161,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 FaradayPatch_v1
+      def adapter(klass = NO_ARGUMENT, *args, &block)
+        return @adapter if klass == 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 = self.class::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.2'
+  VERSION = '1.4.0.pre.3'
 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,42 +166,6 @@ describe ExceptionalSynchrony::EventMachineProxy do
     end
   end
 
-  describe "run with faraday" do
-    before do
-      class Faraday
-        class << self
-          attr_reader :default_adapter
-
-          def default_adapter=(adapter)
-            @default_adapter = adapter
-          end
-        end
-
-        self.default_adapter = :net_http
-      end
-
-      assert_equal :net_http, Faraday.default_adapter
-    end
-
-    it "sets Faraday default_adapter to :em_synchrony by default if Faraday is defined" do
-      mock(@em).run_with_error_logging
-      @em.run
-      assert_equal :em_synchrony, Faraday.default_adapter
-    end
-
-    it "sets Faraday default_adapter to :net_http if Faraday is defined" do
-      mock(@em).run_with_error_logging
-      @em.run(faraday_adapter: :net_http)
-      assert_equal :net_http, Faraday.default_adapter
-    end
-
-    it "raise ArgumentError if the specified faraday_adapter is invalid" do
-      assert_raises(ArgumentError, "Invalid faraday_adapter: :bogus") do
-        @em.run(faraday_adapter: :bogus)
-      end
-    end
-  end
-
   { synchrony: SynchronyProxyMock, run: RunProxyMock }.each do |method, proxy_mock|
     describe "run" do
       before do
@@ -207,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
@@ -214,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.2
+  version: 1.4.0.pre.3
 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