exceptional_synchrony 1.3.0.pre.lee.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d50d71b944ece103dd43d1efb29002bacec564abcab11ff3bf2b2f3d39cf68f8
-  data.tar.gz: 54222d22252ea445f8ae8eab5cca785cded326979ca9665619c12873bef0819f
+  metadata.gz: 848bad0902a3f12ca5db9a3c357cc2ab3209799d74b347c578c626f23d699466
+  data.tar.gz: 5b0506f45a5dcd80127287d2fdd3cd7255f718b2c52866d0172fdf79fa27bd5c
 SHA512:
-  metadata.gz: ac56deba463c441e282cf315866941bdfe5f399c0605e23778fb155960a7b5f469fdbc9e378fa3a72cb833102f528698148a7fe58d3df30effc46e51648bd3b8
-  data.tar.gz: 4edd6057dcab5bb74334ec97cc95e02f27da421e89e56a8c78383f6103a12fc3a0a85048e06626839ebe97bc8b50c65981542c90518d5937eb6553d9aca24d65
+  metadata.gz: 263e887409ffe6620f687a79e0609cff55c46d989e4066f997846e00f08b582007e35fa12e46d991f2214a770da1312207c5432192ef23cb8f8eaa00916f2e3e
+  data.tar.gz: 5e628327433244d3bad52c4d0db5af754af69a8f941e57458437c891f8ba849a6583868860f95b336b311e49f8d262be349c51c7ef19dcb974d6531284782e3b

data/CHANGELOG.md

@@ -6,15 +6,14 @@ 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.3.0] - UNRELEASED
+## [1.4.0] - 2012-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.1.1] - 2020-05-03
-- Replace hobo_support with invoca_utils
-
-[1.1.1]: https://github.com/Invoca/exceptional_synchrony/compare/v1.1.0...v1.1.1
+## [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.
 
 ## [1.2.0] - 2020-06-02
 ### Changed
@@ -27,4 +26,10 @@ All notable changes to this project will be documented in this file.
   We expect that outer edge handler to log the exception chain (the wrapper plus nested `cause` exception(s))
   and exit the process with a non-0 status code.
 
+## [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.3.0.pre.lee.1)
+    exceptional_synchrony (1.4.0)
       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/Rakefile

@@ -7,6 +7,7 @@ require 'rake/testtask'
 task default: :test
 
 Rake::TestTask.new do |t|
+  t.warning = false
   t.pattern = "test/**/*_test.rb"
 end
 

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,17 +63,22 @@ 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?
+      @proxy_class.defers_finished?
     end
 
     def connect(server, port = nil, handler = nil, *args, &block)
       @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)
@@ -80,16 +86,21 @@ module ExceptionalSynchrony
       end
     end
 
-    def defer(context, &block)
-      deferrable = EventMachine::DefaultDeferrable.new
-
-      callback = -> (result) { deferrable.succeed(result) }
-
-      EventMachine.defer(nil, callback) { CallbackExceptions.return_exception(&block) }
-
-      EventMachine::Synchrony.sync(deferrable)
+    # This method will execute the block on the background thread pool
+    # By default, it will block the caller until the background thread has finished, so that the result can be returned
+    #  :wait_for_result - setting this to false will prevent the caller from being blocked by this deferred work
+    def defer(context, wait_for_result: true, &block)
+      if wait_for_result
+        deferrable = EventMachine::DefaultDeferrable.new
+        callback = -> (result) { deferrable.succeed(result) }
 
-      CallbackExceptions.map_deferred_result(deferrable)
+        EventMachine.defer(nil, callback) { CallbackExceptions.return_exception(&block) }
+        EventMachine::Synchrony.sync(deferrable)
+        CallbackExceptions.map_deferred_result(deferrable)
+      else
+        EventMachine.defer { ExceptionHandling.ensure_completely_safe("defer", &block) }
+        nil
+      end
     end
 
     def reactor_running?
@@ -125,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)
@@ -146,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.3.0.pre.lee.1'
+  VERSION = '1.4.0'
 end

data/test/unit/event_machine_proxy_test.rb

@@ -24,6 +24,14 @@ describe ExceptionalSynchrony::EventMachineProxy do
     end
   end
 
+  def stop_em_after_defers_finish!(em)
+    check_finished_counter = 0
+    em.add_periodic_timer(0.1) do
+      (check_finished_counter += 1) > 20 and raise "defer never finished!"
+      em.defers_finished? and em.stop
+    end
+  end
+
   before do
     @em = ExceptionalSynchrony::EventMachineProxy.new(EventMachine, nil)
     @yielded_value = nil
@@ -56,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)
@@ -78,18 +94,41 @@ describe ExceptionalSynchrony::EventMachineProxy do
   end
 
   describe "#defer" do
-    it "should output its block's output when it doesn't raise an error" do
-      ExceptionHandling.logger = Logger.new(STDERR)
+    before do
+      logger = Logger.new(STDERR)
+      logger.extend ContextualLogger::LoggerMixin
+      ExceptionHandling.logger = logger
+    end
 
+    it "should output its block's output when it doesn't raise an error, by default" do
       @em.run do
         assert_equal 12, @em.defer("#defer success") { 12 }
         @em.stop
       end
     end
 
-    it "should raise an error when its block raises an error" do
-      ExceptionHandling.logger = Logger.new(STDERR)
+    it "should not wait for its block to run if option is passed" do
+      @block_ran = false
+
+      @em.run do
+        assert_nil @em.defer("#defer success", wait_for_result: false) { @block_ran = true; 12 }
+        refute @block_ran
+        stop_em_after_defers_finish!(@em)
+      end
+
+      assert @block_ran
+    end
+
+    it "should handle exceptions when not waiting for its block to run" do
+      mock(ExceptionHandling).log_error(is_a(RuntimeError), "defer", {})
+
+      @em.run do
+        assert_nil @em.defer("#defer success", wait_for_result: false) { raise RuntimeError, "error in defer" }
+        stop_em_after_defers_finish!(@em)
+      end
+    end
 
+    it "should raise an error when its block raises an error" do
       @em.run do
         ex = assert_raises(ArgumentError) do
           @em.defer("#defer raising an error") { raise ArgumentError, "!!!" }
@@ -127,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
@@ -161,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
@@ -168,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.pre.lee.1
+  version: 1.4.0
 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
@@ -126,9 +127,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.3
 signing_key: