exceptional_synchrony 1.3.0.pre.lee.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d50d71b944ece103dd43d1efb29002bacec564abcab11ff3bf2b2f3d39cf68f8
-  data.tar.gz: 54222d22252ea445f8ae8eab5cca785cded326979ca9665619c12873bef0819f
+  metadata.gz: aa270b85777fd65a8aae32439cb7031d28f9204e21fbfc627b7659890f47c966
+  data.tar.gz: fea79c101de02959aefb8596b9635f2ccb24266c6173be354465b764264265ea
 SHA512:
-  metadata.gz: ac56deba463c441e282cf315866941bdfe5f399c0605e23778fb155960a7b5f469fdbc9e378fa3a72cb833102f528698148a7fe58d3df30effc46e51648bd3b8
-  data.tar.gz: 4edd6057dcab5bb74334ec97cc95e02f27da421e89e56a8c78383f6103a12fc3a0a85048e06626839ebe97bc8b50c65981542c90518d5937eb6553d9aca24d65
+  metadata.gz: ed1b737065894c49b88eeaad73f202d8e5b512b117fb36d9ea810f993d201a9999635380f0d2632978b59726c85d0682a589748d82d0fb72b9c5e7e7fd0b52c9
+  data.tar.gz: ba46f65a0f74e86806dc40eda128b4b3172219d4c214d0ab697781334d371b7fda9f4f8e1f378d548fc7a053e01d83ea5ea747ea32266fb58ba0c81df4ada212

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.5

data/CHANGELOG.md

@@ -6,15 +6,13 @@ 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
-### 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`
-
-## [1.1.1] - 2020-05-03
-- Replace hobo_support with invoca_utils
+## [1.3.1] - 2024-03-04
+### Changed
+- Updated `exception_handling` dependency to allow usage of version 3.0
 
-[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 +25,9 @@ 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.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,58 +1,42 @@
 PATH
   remote: .
   specs:
-    exceptional_synchrony (1.3.0.pre.lee.1)
+    exceptional_synchrony (1.3.1)
       em-http-request
       em-synchrony
       eventmachine
-      exception_handling (~> 2.2)
+      exception_handling (>= 2.2)
       invoca-utils (~> 0.3)
 
 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)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.1.1)
-      actionview (= 6.1.1)
-      activesupport (= 6.1.1)
-      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)
-      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)
-      globalid (>= 0.3.6)
-    activesupport (6.1.1)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     builder (3.2.4)
     coderay (1.1.2)
-    concurrent-ruby (1.1.8)
-    contextual_logger (0.11.0)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    contextual_logger (1.2.0)
       activesupport
       json
-    cookiejar (0.3.3)
+    cookiejar (0.3.4)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    crass (1.0.6)
+    drb (2.2.1)
     em-http-request (1.1.7)
       addressable (>= 2.3.4)
       cookiejar (!= 0.3.1)
@@ -63,65 +47,45 @@ GEM
       eventmachine (>= 1.0.0.beta.4)
     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)
-      actionmailer (>= 4.2, < 7.0)
-      actionpack (>= 4.2, < 7.0)
-      activesupport (>= 4.2, < 7.0)
-      contextual_logger (~> 0.7)
-      eventmachine (~> 1.0)
+    exception_handling (3.0.0)
+      activesupport (>= 5.2)
+      contextual_logger (~> 1.0)
+      escalate (~> 0.3)
       invoca-utils (~> 0.3)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+      psych (~> 3.0)
     hashdiff (1.0.1)
-    http_parser.rb (0.6.0)
-    i18n (1.8.8)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    invoca-utils (0.4.1)
-    json (2.5.1)
-    loofah (2.9.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
+    invoca-utils (0.5.1)
+      activesupport (>= 5.0)
+    json (2.7.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)
-      racc (~> 1.4)
+    mutex_m (0.2.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    psych (3.3.4)
     public_suffix (4.0.4)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
     rake (13.0.1)
     rr (1.2.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
     thor (1.0.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     webmock (1.24.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -137,4 +101,4 @@ DEPENDENCIES
   webmock (~> 1.24)
 
 BUNDLED WITH
-   1.17.3
+   2.3.22

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/exceptional_synchrony.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'em-synchrony'
   spec.add_dependency 'em-http-request'
   spec.add_dependency 'eventmachine'
-  spec.add_dependency 'exception_handling', '~> 2.2'
+  spec.add_dependency 'exception_handling', '>= 2.2'
   spec.add_dependency 'invoca-utils', '~> 0.3'
 end

data/lib/exceptional_synchrony/event_machine_proxy.rb

@@ -64,6 +64,10 @@ module ExceptionalSynchrony
       @proxy_class.next_tick { } #Fake out EventMachine's epoll mechanism so we don't block until timers fire
     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
@@ -72,7 +76,6 @@ module ExceptionalSynchrony
     #   :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 +83,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,12 +133,6 @@ 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)

data/lib/exceptional_synchrony/version.rb

@@ -1,3 +1,3 @@
 module ExceptionalSynchrony
-  VERSION = '1.3.0.pre.lee.1'
+  VERSION = '1.3.1'
 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
@@ -78,18 +86,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, "!!!" }
@@ -109,45 +140,24 @@ describe ExceptionalSynchrony::EventMachineProxy do
     end
 
     it "add_timer" do
-      mock(ExceptionHandling).log_error(EXCEPTION, "add_timer", {})
+      mock(ExceptionHandling).log_error(EXCEPTION, "add_timer")
       mock(EventMachine::Synchrony).add_timer(10) { |duration, *args| args.first.call }
       @em.add_timer(10) { raise EXCEPTION }
     end
 
     it "add_periodic_timer" do
-      mock(ExceptionHandling).log_error(EXCEPTION, "add_periodic_timer", {})
+      mock(ExceptionHandling).log_error(EXCEPTION, "add_periodic_timer")
       mock(EventMachine::Synchrony).add_periodic_timer(10) { |duration, *args| args.first.call }
       @em.add_periodic_timer(10) { raise EXCEPTION }
     end
 
     it "next_tick" do
-      mock(ExceptionHandling).log_error(EXCEPTION, "next_tick", {})
+      mock(ExceptionHandling).log_error(EXCEPTION, "next_tick")
       mock(EventMachine::Synchrony).next_tick { |*args| args.first.call }
       @em.next_tick { raise EXCEPTION }
     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
@@ -179,7 +189,7 @@ describe ExceptionalSynchrony::EventMachineProxy do
 
         describe "when using #{method} and on_error = :log" do
           it "should rescue any exceptions and log them" do
-            mock(ExceptionHandling).log_error(EXCEPTION, "run_with_error_logging", {})
+            mock(ExceptionHandling).log_error(EXCEPTION, "run_with_error_logging")
 
             @proxy.run(on_error: :log) { raise EXCEPTION }
           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.3.1
 platform: ruby
 authors:
 - Invoca
@@ -56,14 +56,14 @@ dependencies:
   name: exception_handling
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
@@ -126,11 +126,11 @@ 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
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Extensions to EventMachine/Synchrony to work well with exceptions