process_executer 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6cedd27c98fa7e8e5d7ac1d134a514cdad1bac02fec17e88045729c644d978d
-  data.tar.gz: 3c61d911e0134dd3d083be1773d44910b0218c268733e7bd10b547b83b67dfe4
+  metadata.gz: 3af694308b0e9c5119b2ff63d11b6b351a25cc9f7d66ac2dd482c8525736595a
+  data.tar.gz: a669d2c3cceadeb7544be9765793eff22addc8c7bde10e13e4d36de447b26cb5
 SHA512:
-  metadata.gz: 1963744fe4e899bc099f1641587e3e9d722bcf8f4ee1c88795918eadddc9b4f55324d59779f2be0804bf08a2c47267b0d28d6e625fba2588c1dedd075049f484
-  data.tar.gz: 004562c12d9ba5ff76a6a9a0b028c0817631eb3fddbca2dac329a1d594ca843ba08e44b6b33cbaea7292b073d2bdd861bb47b738f7d4eaba506ead916606b5d4
+  metadata.gz: 670dcd425f0879def69e0875a90edae0f79280b44d4ea73d117b3875ad3eeb1cd6329f4b2d8a6a8c0d601f7b79eb72989288255d57067714f2e830f4dde3ddb2
+  data.tar.gz: 6a18db9777ecb26ebaa7b30c3fbadb81ae8adba1dcd60c92bf6d30510f30275336ef34c4b1c05c5df6356bcd62cd5b783736adb25462dd55d9d87deec6015945

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to the process_executer gem will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v3.2.0 (2025-04-04)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v3.1.0..v3.2.0)
+
+Changes since v3.1.0:
+
+* 272d246 test: fix flaky test that fails on windows
+* 1e121d8 test: add test for raising a SpawnError when Process.spawn raises an error
+* 2a2aaac refactor: improve synchronization of the monitored pipe state
+
 ## v3.1.0 (2025-04-01)
 
 [Full Changelog](https://github.com/main-branch/process_executer/compare/v3.0.0..v3.1.0)

data/lib/process_executer/monitored_pipe.rb

@@ -58,14 +58,12 @@ module ProcessExecuter
 
       assert_destination_is_compatible_with_monitored_pipe
 
+      @mutex = Mutex.new
+      @condition_variable = ConditionVariable.new
       @chunk_size = chunk_size
       @pipe_reader, @pipe_writer = IO.pipe
       @state = :open
-      @thread = Thread.new do
-        Thread.current.report_on_exception = false
-        Thread.current.abort_on_exception = false
-        monitor
-      end
+      @thread = start_monitoring_thread
     end
 
     # Set the state to `:closing` and wait for the state to be set to `:closed`
@@ -84,10 +82,17 @@ module ProcessExecuter
     # @return [void]
     #
     def close
-      return unless state == :open
+      mutex.synchronize do
+        return unless state == :open
 
-      @state = :closing
-      sleep 0.001 until state == :closed
+        @state = :closing
+      end
+
+      mutex.synchronize do
+        condition_variable.wait(mutex) while @state != :closed
+      end
+
+      thread.join
 
       destination.close
     end
@@ -152,9 +157,11 @@ module ProcessExecuter
     # @api private
     #
     def write(data)
-      raise IOError, 'closed stream' unless state == :open
+      mutex.synchronize do
+        raise IOError, 'closed stream' unless state == :open
 
-      pipe_writer.write(data)
+        pipe_writer.write(data)
+      end
     end
 
     # @!attribute [r]
@@ -255,6 +262,28 @@ module ProcessExecuter
 
     private
 
+    # @!attribute [r]
+    #
+    # The mutex used to synchronize access to the state variable
+    #
+    # @return [Mutex]
+    #
+    # @api private
+    #
+    attr_reader :mutex
+
+    # @!attribute [r]
+    #
+    # The condition variable used to synchronize access to the state
+    #
+    # In particular, it is used while waiting for the state to change to :closed
+    #
+    # @return [ConditionVariable]
+    #
+    # @api private
+    #
+    attr_reader :condition_variable
+
     # Raise an error if the destination is not compatible with MonitoredPipe
     # @return [void]
     # @raise [ArgumentError] if the destination is not compatible with MonitoredPipe
@@ -265,6 +294,17 @@ module ProcessExecuter
       raise ArgumentError, "Destination #{destination.destination} is not compatible with MonitoredPipe"
     end
 
+    # Start the thread to monitor the pipe and write data to the destination
+    # @return [void]
+    # @api private
+    def start_monitoring_thread
+      Thread.new do
+        Thread.current.report_on_exception = false
+        Thread.current.abort_on_exception = false
+        monitor
+      end
+    end
+
     # Read data from the pipe until `#state` is changed to `:closing`
     #
     # The state is changed to `:closed` by calling `#close`.
@@ -275,8 +315,12 @@ module ProcessExecuter
     # @api private
     def monitor
       monitor_pipe until state == :closing
+    ensure
       close_pipe
-      @state = :closed
+      mutex.synchronize do
+        @state = :closed
+        condition_variable.signal
+      end
     end
 
     # Read data from the pipe until `#state` is changed to `:closing`
@@ -310,8 +354,10 @@ module ProcessExecuter
     def write_data(data)
       destination.write(data)
     rescue StandardError => e
-      @exception = e
-      @state = :closing
+      mutex.synchronize do
+        @exception = e
+        @state = :closing
+      end
     end
 
     # Read any remaining data from the pipe and close it

data/lib/process_executer/version.rb

@@ -2,5 +2,5 @@
 
 module ProcessExecuter
   # The current Gem version
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - James Couball
 bindir: exe
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -250,8 +250,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/process_executer
   source_code_uri: https://github.com/main-branch/process_executer
-  documentation_uri: https://rubydoc.info/gems/process_executer/3.1.0
-  changelog_uri: https://rubydoc.info/gems/process_executer/3.1.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/process_executer/3.2.0
+  changelog_uri: https://rubydoc.info/gems/process_executer/3.2.0/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: