process_executer 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a13a780c8c9064d19873068266b40be2a2a8ba7fe1d46866d6e8cb15806d5e53
-  data.tar.gz: e727aab59452dac6ef74819bff2462ad0e1eb56c5b0c1ff1f7e018aed5dbdf77
+  metadata.gz: 3af694308b0e9c5119b2ff63d11b6b351a25cc9f7d66ac2dd482c8525736595a
+  data.tar.gz: a669d2c3cceadeb7544be9765793eff22addc8c7bde10e13e4d36de447b26cb5
 SHA512:
-  metadata.gz: 6e349893ee5fbf19410e35e2a3a43907ccb1b1610f266788e0bd01b972ccc0e875fa2df95a9f9b90aefa0d8910f535a9d2ad34432332df07dbd58a33d299169d
-  data.tar.gz: 29d7455610df17c93b8616fcff42fe44077f46de3e855eba573b45071e8bd51322240763529e2c5b578191ff20ada709073bac2989e6bbfcca20e0687fac09f5
+  metadata.gz: 670dcd425f0879def69e0875a90edae0f79280b44d4ea73d117b3875ad3eeb1cd6329f4b2d8a6a8c0d601f7b79eb72989288255d57067714f2e830f4dde3ddb2
+  data.tar.gz: 6a18db9777ecb26ebaa7b30c3fbadb81ae8adba1dcd60c92bf6d30510f30275336ef34c4b1c05c5df6356bcd62cd5b783736adb25462dd55d9d87deec6015945

data/CHANGELOG.md

@@ -5,6 +5,25 @@ 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)
+
+Changes since v3.0.0:
+
+* acb6385 fix: give Windows enough time to release its file lock so tmpdir can be deleted
+* 3fe114a feat: wrap errors raised by `Process.spawn` in a `ProcessExecuter::SpawnError`
+
 ## v3.0.0 (2025-03-18)
 
 [Full Changelog](https://github.com/main-branch/process_executer/compare/v2.0.0..v3.0.0)

data/README.md

@@ -179,6 +179,9 @@ following features:
 * It raises an error if there is any problem with the subprocess. This behavior can
   be turned off with the `raise_errors: false` option.
 
+  ⚠️ `ProcessIOError` and `SpawnError` errors are not suppressed by giving the
+  `raise_errors: false` option.
+
 ```ruby
 result = ProcessExecuter.run('echo "Hello World"', out: StringIO.new)
 result.stdout #=> "Hello World\n"

data/lib/process_executer/errors.rb

@@ -17,7 +17,8 @@ module ProcessExecuter
   #       │   ├─> FailedError
   #       │   └─> SignaledError
   #       │       └─> TimeoutError
-  #       └─> ProcessIOError
+  #       ├─> ProcessIOError
+  #       └─> SpawnError
   # ```
   #
   # | Error Class | Description |
@@ -28,6 +29,7 @@ module ProcessExecuter
   # | `SignaledError` | Raised when the command is terminated as a result of receiving a signal. This could happen if the process is forcibly terminated or if there is a serious system error. |
   # | `TimeoutError` | This is a specific type of `SignaledError` that is raised when the command times out and is killed via the SIGKILL signal. Raised when the operation takes longer than the specified timeout duration (if provided). |
   # | `ProcessIOError` | Raised when an error was encountered reading or writing to the command's subprocess. |
+  # | `SpawnError` | Raised when the process could not execute. Check the  |
   #
   # @example Rescuing any error
   #   begin
@@ -129,6 +131,14 @@ module ProcessExecuter
   # @api public
   #
   class ProcessIOError < ProcessExecuter::Error; end
+
+  # Raised when spawn could not execute the process
+  #
+  # See the `cause` for the exception that Process.spawn raised.
+  #
+  # @api public
+  #
+  class SpawnError < ProcessExecuter::Error; end
 end
 
 # rubocop:enable Layout/LineLength

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/runner.rb

@@ -42,8 +42,7 @@ module ProcessExecuter
     # @param command [Array<String>] The command to execute
     # @param options [ProcessExecuter::Options::RunOptions] Options for running the command
     #
-    # @raise [ProcessExecuter::ProcessIOError] If an exception was raised while collecting subprocess output
-    # @raise [ProcessExecuter::TimeoutError] If the command times out
+    # @raise [ProcessExecuter::Error] if the command could not be executed or failed
     #
     # @return [ProcessExecuter::Result] The result of the completed subprocess
     #
@@ -100,10 +99,7 @@ module ProcessExecuter
     #
     # @return [Void]
     #
-    # @raise [ProcessExecuter::FailedError] If the command failed
-    # @raise [ProcessExecuter::SignaledError] If the command was signaled
-    # @raise [ProcessExecuter::TimeoutError] If the command times out
-    # @raise [ProcessExecuter::ProcessIOError] If an exception was raised while collecting subprocess output
+    # @raise [ProcessExecuter::Error] if the command could not be executed or failed
     #
     # @api private
     #

data/lib/process_executer/version.rb

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

data/lib/process_executer.rb

@@ -87,7 +87,11 @@ module ProcessExecuter
   # @return [ProcessExecuter::Result] The result of the completed subprocess
   # @api private
   def self.spawn_and_wait_with_options(command, options)
-    pid = Process.spawn(*command, **options.spawn_options)
+    begin
+      pid = Process.spawn(*command, **options.spawn_options)
+    rescue StandardError => e
+      raise ProcessExecuter::SpawnError, "Failed to spawn process: #{e.message}"
+    end
     wait_for_process(pid, command, options)
   end
 
@@ -287,10 +291,7 @@ module ProcessExecuter
   # @option options_hash [String] :chdir (nil) The directory to run the command in
   # @option options_hash [Logger] :logger The logger to use
   #
-  # @raise [ProcessExecuter::FailedError] if the command returned a non-zero exit status
-  # @raise [ProcessExecuter::SignaledError] if the command exited because of an unhandled signal
-  # @raise [ProcessExecuter::TimeoutError] if the command timed out
-  # @raise [ProcessExecuter::ProcessIOError] if an exception was raised while collecting subprocess output
+  # @raise [ProcessExecuter::Error] if the command could not be executed or failed
   #
   # @return [ProcessExecuter::Result] The result of the completed subprocess
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - James Couball
 bindir: exe
 cert_chain: []
-date: 2025-03-18 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.0.0
-  changelog_uri: https://rubydoc.info/gems/process_executer/3.0.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: