flatware 2.2.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 278612d774eb619a0548544e33650c8f73b4fa1b88de900027aba730a46c51bd
-  data.tar.gz: a1ac3e33ff822f2cac88fe24914d1034bffd40872ca0e10791e8019a60f64d68
+  metadata.gz: e4e66ab27a1e76fc9ca919c9b9de35006f88317cb6b5bf6f1b136b1b7eabc368
+  data.tar.gz: d16310a202a40d0e1a4147d31e1c97c8cc590f5d1b009b2576cefb9e79e47735
 SHA512:
-  metadata.gz: 48e11bc65e1e0423567b21175a313766aeb1949aa3f7f168e005c3657f9a189da5003aea4c8f50230969875dc6363fe5e8eacebb0c594d4fdea28c3775082791
-  data.tar.gz: 1f6abcc7d6b8d1e29e8c588e27dd077b8af754fb7c3b057f648d595974591c5069f147fe6b3f43768655add6553a090b240312180773f58db5d0b23f74e76cdc
+  metadata.gz: 3e1b6e794216a3724966e1465990d89a6d8d33f2ef2d58248b7ccb35e16451ad3f675c9b4f630135b9d4fbc61a75e4be32b844ee8758f1e9975dc80ffd13b32a
+  data.tar.gz: 341abe2ae2e05e2105f3de801fb8e8bd044028bc75a21529d4f5b2d1aab20b943d0b4d860cfff432e1f234d91dbd662db23c664543e3dd2ad2b8b2b95d315738

data/README.md

@@ -40,13 +40,13 @@ $ flatware rspec
 
 The rspec runner can balance worker loads, making your suite even faster.
 
-It forms balaced groups of spec files according to their last run times, if you've set `example_status_persistence_file_path` [in your RSpec config](https://relishapp.com/rspec/rspec-core/v/3-8/docs/command-line/only-failures).
+It forms balanced groups of spec files according to their last run times, if you've set `example_status_persistence_file_path` [in your RSpec config](https://relishapp.com/rspec/rspec-core/v/3-8/docs/command-line/only-failures).
 
-For this to work the configuration option must be loaded before any specs are run. The `.rspec` file is one way to achive this:
+For this to work the configuration option must be loaded before any specs are run. The `.rspec` file is one way to achieve this:
 
     --require spec_helper
 
-But beware, if you're using ActiveRecord in your suite you'll need to avoid doing things that cause it to establish a database connection in `spec_helper.rb`. If ActiveRecord connects before flatware forks off workers, each will die messily. All of this will just work if you're following [the recomended pattern of splitting your helpers into `spec_helper` and `rails_helper`](https://github.com/rspec/rspec-rails/blob/v3.8.2/lib/generators/rspec/install/templates/spec/rails_helper.rb). Another option is to use [the configurable hooks](
+But beware, if you're using ActiveRecord in your suite you'll need to avoid doing things that cause it to establish a database connection in `spec_helper.rb`. If ActiveRecord connects before flatware forks off workers, each will die messily. All of this will just work if you're following [the recommended pattern of splitting your helpers into `spec_helper` and `rails_helper`](https://github.com/rspec/rspec-rails/blob/v3.8.2/lib/generators/rspec/install/templates/spec/rails_helper.rb). Another option is to use [the configurable hooks](
 #faster-startup-with-activerecord
 ).
 

data/lib/flatware/cli.rb

@@ -17,7 +17,7 @@ module Flatware
         aliases: '-w',
         type: :numeric,
         default: processors,
-        desc: 'Number of concurent processes to run'
+        desc: 'Number of concurrent processes to run'
       )
     end
 
@@ -90,6 +90,6 @@ if loaded_flatware_gem_count.zero?
   warn(
     format(<<~MESSAGE, gem_list: flatware_gems.join(' or ')))
       The flatware gem is a dependency of flatware runners for rspec and cucumber.
-      Install %<gem_list>s for more usefull commands.
+      Install %<gem_list>s for more useful commands.
     MESSAGE
 end

data/lib/flatware/sink/signal.rb

@@ -0,0 +1,82 @@
+module Flatware
+  module Sink
+    class Signal
+      Message = Struct.new(:message)
+
+      attr_reader :formatter
+
+      def initialize(formatter, &on_interrupt)
+        @formatter = formatter
+        Thread.main[:signals] = Queue.new
+
+        @on_interrupt = on_interrupt
+      end
+
+      def listen
+        Thread.new(&method(:handle_signals))
+
+        ::Signal.trap('INT') { signals << :int }
+        ::Signal.trap('CLD') do
+          signals << :cld if child_failed?
+        end
+
+        self
+      end
+
+      def self.listen(formatter, &block)
+        new(formatter, &block).listen
+      end
+
+      private
+
+      def child_status
+        _worker_pid, status = begin
+          Process.wait2(-1, Process::WNOHANG)
+        rescue Errno::ECHILD
+          []
+        end
+        status
+      end
+
+      def child_statuses
+        statuses = []
+        loop do
+          status = child_status
+          return statuses unless status
+
+          statuses << status
+        end
+      end
+
+      def child_failed?
+        child_statuses.any? { |status| !status.success? }
+      end
+
+      def handle_signals
+        signal_message(signals.pop) do
+          Process.waitall
+          @on_interrupt.call
+        end
+
+        abort
+      end
+
+      def signal_message(signal)
+        formatter.message(Message.new(format(<<~MESSAGE, { cld: 'A worker died', int: 'Interrupted' }.fetch(signal))))
+
+          %s!
+
+          Waiting for workers to finish their current jobs...
+        MESSAGE
+
+        yield
+
+        formatter.message(Message.new('done.'))
+      end
+
+      def signals
+        Thread.main[:signals]
+      end
+    end
+  end
+end

data/lib/flatware/sink.rb

@@ -1,5 +1,6 @@
 require 'drb/drb'
 require 'set'
+require 'flatware/sink/signal'
 
 module Flatware
   module Sink
@@ -24,6 +25,7 @@ module Flatware
         @checkpoints = []
         @completed_jobs = []
         @formatter = formatter
+        @interrupted = false
         @jobs = group_jobs(jobs, worker_count).freeze
         @queue = @jobs.dup
         @sink = sink
@@ -31,16 +33,16 @@ module Flatware
       end
 
       def start
-        trap_interrupt
+        Signal.listen(formatter, &method(:on_interrupt))
         formatter.jobs jobs
         DRb.start_service(sink, self, verbose: Flatware.verbose?)
         DRb.thread.join
-        !failures?
+        !(failures? || interrupted?)
       end
 
       def ready(worker)
         job = queue.shift
-        if job && !(remaining_work.empty? || interruped?)
+        if job && !(remaining_work.empty? || interrupted?)
           workers << worker
           job
         else
@@ -72,29 +74,13 @@ module Flatware
 
       private
 
-      def trap_interrupt
-        Thread.main[:signals] = Queue.new
-
-        Thread.new(&method(:handle_interrupt))
-
-        trap 'INT' do
-          Thread.main[:signals] << :int
-        end
-      end
-
-      def handle_interrupt
-        Thread.main[:signals].pop
-        puts 'Interrupted!'
+      def on_interrupt
+        @interrupted = true
         summarize_remaining
-        puts "\n\nCleaning up. Please wait...\n"
-        Process.waitall
-        puts 'done.'
-        abort
       end
 
-      def interruped?
-        signals = Thread.main[:signals]
-        signals && !signals.empty?
+      def interrupted?
+        @interrupted
       end
 
       def check_finished!

data/lib/flatware/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flatware
-  VERSION = '2.2.1'
+  VERSION = '2.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flatware
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Brian Dunn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -45,6 +45,7 @@ files:
 - lib/flatware/serialized_exception.rb
 - lib/flatware/sink.rb
 - lib/flatware/sink/client.rb
+- lib/flatware/sink/signal.rb
 - lib/flatware/version.rb
 - lib/flatware/worker.rb
 homepage: http://github.com/briandunn/flatware