exceptional_synchrony 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d067a2b3a9635740dbee2374a06e772c29ca9a8fe57a61108c94118ac15480bb
-  data.tar.gz: 665f4bf8ccc1ea699c0d56a4f7d38647c2e3e64e814b736562bf83b69ccd0d25
+  metadata.gz: 5c1805d12af62c0dac803b64eadb0e7b21efa614f5c10600d75280649a7d2a0e
+  data.tar.gz: 89f0a7ededf02acc4f84df65df03880af40edc4e41d0f930244262067ab10961
 SHA512:
-  metadata.gz: 9961b1ef53acfb4c94651611871b120279dab3b3564e1841b199a7b2fa1f7a3728bca945517f50964704b0491f9a086192cb857a3205c6008758ecb51a4fb9c5
-  data.tar.gz: 0a4d64204faf45276aaca59757ad43bb850c75ea668671e92eae251721a19c6b2ce0ecae5b3bb38c8a64179ba41d0b0864bf1a6640de4e234c4c772434bcfca0
+  metadata.gz: cab5a438cdef3a5e1682912e500b79eff2d11992e351070064b167df9125d305429a26f153dc2aa33923695970584b06da731b7220c50b230e3e4a202a49ce99
+  data.tar.gz: 18fca7c2d477146a3886b66abb32a2c43d5125f220c45f8d71c47f4ed4d2d28f8fbf98257cb396033a8223e9e26ea8d35ae110e2d7e88ffe0a17d148a9a594bc

data/CHANGELOG.md

@@ -6,6 +6,15 @@ 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.1] - 2021-03-09
+### Fixed
+- FaradayAdapterPatch_v1 name typo
+
+## [1.4.0] - 2021-03-08
+### Added
+- 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
 - Extend `EMP.defer` to have a new keyword argument, `wait_for_result` for the callers to control whether they should should block until the background thread returns. To preserve existing behavior, this option defaults to `true`, so `EMP.defer` will block in order to return the value (or raise an exception) from the deferred block. Callers can pass `wait_for_result: false` if they do not want to block.
@@ -24,6 +33,8 @@ 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.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.3.0)
+    exceptional_synchrony (1.4.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.7)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.4.1)
     json (2.5.1)
@@ -87,15 +89,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?
@@ -72,6 +74,7 @@ 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
@@ -136,6 +139,7 @@ module ExceptionalSynchrony
     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)
@@ -148,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 = 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.3.0'
+  VERSION = '1.4.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)
@@ -171,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
@@ -178,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.3.0
+  version: 1.4.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