process_executer 3.1.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6cedd27c98fa7e8e5d7ac1d134a514cdad1bac02fec17e88045729c644d978d
-  data.tar.gz: 3c61d911e0134dd3d083be1773d44910b0218c268733e7bd10b547b83b67dfe4
+  metadata.gz: 0a9debe1b364e7755e593434f5b018b6ef39d64f509132b2f803ebe1be1bfe36
+  data.tar.gz: 780091f37f642962c1bbaf885cd22559defe52d568294884df23aac0eb575318
 SHA512:
-  metadata.gz: 1963744fe4e899bc099f1641587e3e9d722bcf8f4ee1c88795918eadddc9b4f55324d59779f2be0804bf08a2c47267b0d28d6e625fba2588c1dedd075049f484
-  data.tar.gz: 004562c12d9ba5ff76a6a9a0b028c0817631eb3fddbca2dac329a1d594ca843ba08e44b6b33cbaea7292b073d2bdd861bb47b738f7d4eaba506ead916606b5d4
+  metadata.gz: fc21311fca209fc28ce413c7562a8d80a3268c90bf34941525422db8cdd0656549c5e8ca285c4cfee4711f0d9ad8babe4de55676d4ed0fbf77f2001b4ebd17fe
+  data.tar.gz: 689feaf01cc890fcb978c78e24c16ad912e4e64cfa3494ecd6d825ceaf86662d46e8239528e4f985ed9a5365cc32498c7d618d1203aebf1da0a34bfedf868228

data/CHANGELOG.md

@@ -5,6 +5,29 @@ 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.1 (2025-04-08)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v3.2.0..v3.2.1)
+
+Changes since v3.2.0:
+
+* d1e19a5 test: assert that MonitoredPipe has no open instances after each test
+* aa71f8e test: ensure MonitoredPipe cleans up open instances in specs
+* 987b0c9 fix: ensure that all pipes are closed even when there is an IOError
+* 65e8db0 fix: ensure that MonitoredPipe cleans up after itself even when there is IOError
+* ed2454e chore: integrate track_open_instances gem to report on leaked MonitoredPipe instances
+* f25c87d chore: release v3.2.0
+
+## 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

@@ -2,6 +2,7 @@
 
 require 'stringio'
 require 'io/wait'
+require 'track_open_instances'
 
 module ProcessExecuter
   # Write data sent through a pipe to a destination
@@ -41,6 +42,8 @@ module ProcessExecuter
   # @api public
   #
   class MonitoredPipe
+    include TrackOpenInstances
+
     # Create a new monitored pipe
     #
     # Creates a IO.pipe and starts a monitoring thread to read data written to the pipe.
@@ -58,14 +61,14 @@ 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
+
+      self.class.add_open_instance(self)
     end
 
     # Set the state to `:closing` and wait for the state to be set to `:closed`
@@ -84,12 +87,16 @@ module ProcessExecuter
     # @return [void]
     #
     def close
-      return unless state == :open
-
-      @state = :closing
-      sleep 0.001 until state == :closed
+      mutex.synchronize do
+        if state == :open
+          @state = :closing
+          condition_variable.wait(mutex) while @state != :closed
+        end
+      end
 
+      thread.join
       destination.close
+      self.class.remove_open_instance(self)
     end
 
     # Return the write end of the pipe so that data can be written to it
@@ -152,9 +159,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 +264,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 +296,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 +317,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 +356,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

@@ -52,7 +52,8 @@ module ProcessExecuter
       opened_pipes = wrap_stdout_stderr(options)
       ProcessExecuter.spawn_and_wait_with_options(command, options)
     ensure
-      opened_pipes.each { |key, value| close_pipe(command, key, value) }
+      opened_pipes.each_value(&:close)
+      opened_pipes.each { |option_key, pipe| raise_pipe_error(command, option_key, pipe) }
     end
 
     # Wrap the stdout and stderr redirection options with a MonitoredPipe
@@ -81,16 +82,6 @@ module ProcessExecuter
         ProcessExecuter::Destinations.compatible_with_monitored_pipe?(value)
     end
 
-    # Close the pipe and raise an error if the pipe raised an exception
-    # @return [void]
-    # @raise [ProcessExecuter::ProcessIOError] If an exception was raised while
-    #   collecting subprocess output
-    # @api private
-    def close_pipe(command, option_key, pipe)
-      pipe.close
-      raise_pipe_error(command, option_key, pipe) if pipe.exception
-    end
-
     # Process the result of the command and return a ProcessExecuter::Result
     #
     # Log the command and result, and raise an error if the command failed.
@@ -144,6 +135,8 @@ module ProcessExecuter
     # @api private
     #
     def raise_pipe_error(command, option_key, pipe)
+      return unless pipe.exception
+
       error = ProcessExecuter::ProcessIOError.new("Pipe Exception for #{command}: #{option_key.inspect}")
       raise(error, cause: pipe.exception)
     end

data/lib/process_executer/version.rb

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

data/process_executer.gemspec

@@ -37,6 +37,8 @@ Gem::Specification.new do |spec|
     'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
   ]
 
+  spec.add_dependency 'track_open_instances', '~> 0.1'
+
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
   spec.add_development_dependency 'create_github_release', '~> 2.1'
   spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - James Couball
 bindir: exe
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: track_open_instances
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -250,8 +264,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.1
+  changelog_uri: https://rubydoc.info/gems/process_executer/3.2.1/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: