flatware 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf9e819cd4142e9648a8dbe098afc8077e5a6dc64e58dc1fe1a025efc081a105
-  data.tar.gz: 947a36ace6700bb8280af4626d80199b186120e6a835802e064d13cfbe16fba0
+  metadata.gz: f3dfa03a78403cf9d0b10b97ac354baba9353a6847bcbbc9b150b7deaa8a4f68
+  data.tar.gz: e2181f1f91b2b313ab42d39c93ce209efc432b29192737f7b9d5e06d13f637ce
 SHA512:
-  metadata.gz: abfe9079d1576452f489eb16300934838d7efef290523af3369918f1e99efc30608f8faa93f20f096710551d03fb892647ee2891e0767a300086345abf3e022b
-  data.tar.gz: 55f1933b44ebc6783598acb067ca7c33a42a2d7bbbf49310aa46dadefcfdf9e215b66aa08e2948792660aacb84c0a0fd9c3a509c2d84e0627522cff8d334977f
+  metadata.gz: 63b9c6f997e89382276b56797cf0e0b53155c30e11a5e22157c03a93da7cd616bffde249283a6ed7a29affc1b9da5baa211c2963e98402998068c7a9f856ed33
+  data.tar.gz: dba4525f41243955e2f0f3db5a8685031a38eb66192de319c110eae41450fcd55ad995d56c3025e01cb8ad61a50dce04dec4dcc1e45ed54f36dfe011554f5339

data/README.md

@@ -106,6 +106,11 @@ Flatware has a couple lifecycle callbacks that you can use to avoid booting your
 over again on every core. One way to take advantage of this via a `spec/flatware_helper.rb` file like so:
 
 ```ruby
+##
+# uncomment if you get a segmentation fault from the "pg" gem
+# @see https://github.com/ged/ruby-pg/issues/311#issuecomment-1609970533
+# ENV["PGGSSENCMODE"] = "disable"
+
 Flatware.configure do |conf|
   conf.before_fork do
     require 'rails_helper'
@@ -114,6 +119,11 @@ Flatware.configure do |conf|
   end
 
   conf.after_fork do |test_env_number|
+    ##
+    # uncomment if you're using SimpleCov and have started it in `rails_helper` as suggested here:
+    # @see https://github.com/simplecov-ruby/simplecov/tree/main?tab=readme-ov-file#use-it-with-any-framework
+    # SimpleCov.at_fork.call(test_env_number)
+
     config = ActiveRecord::Base.connection_db_config.configuration_hash
 
     ActiveRecord::Base.establish_connection(
@@ -126,6 +136,15 @@ end
 ```
 Now when I run `bundle exec flatware rspec -r ./spec/flatware_helper` My app only boots once, rather than once per core.
 
+## SimpleCov
+
+If you're using SimpleCov, follow [their directions](https://github.com/simplecov-ruby/simplecov/tree/main?tab=readme-ov-file#use-it-with-any-framework) to install. When you have it working as desired for serial runs, add
+`SimpleCov.at_fork.call(test_env_number)` to flatware's `after_fork` hook. You should now get the same coverage stats from parallel and serial runs.
+
+## Segmentation faults in the PG gem
+
+If you get a segmentation fault on start you may need to add `ENV["PGGSSENCMODE"] = "disable"` to the top of your flatware helper.
+
 ## Design Goals
 
 ### Maintainable
@@ -170,3 +189,10 @@ Do whatever you want. I'd love to help make sure Flatware meets your needs.
 [![Hashrocket logo](https://hashrocket.com/hashrocket_logo.svg)](https://hashrocket.com)
 
 Flatware is supported by the team at [Hashrocket](https://hashrocket.com), a multidisciplinary design & development consultancy. If you'd like to [work with us](https://hashrocket.com/contact-us/hire-us) or [join our team](https://hashrocket.com/contact-us/jobs), don't hesitate to get in touch.
+
+
+# TODO:
+
+possible simplecov fixes
+
+1. seems like we won't get the same results as serial rspec runs unless we start simplecov after fork. And if we do that, I think a process needs to claim to be the last one for simplecov to run the merge.

data/lib/flatware/cli.rb

@@ -55,7 +55,8 @@ module Flatware
 
     def start_sink(jobs:, workers:, formatter:)
       $0 = 'flatware sink'
-      Process.setpgrp
+      try_setpgrp
+
       passed = Sink.start_server(
         jobs: jobs,
         formatter: Flatware::Broadcaster.new([formatter]),
@@ -65,6 +66,12 @@ module Flatware
       exit passed ? 0 : 1
     end
 
+    def try_setpgrp
+      Process.setpgrp
+    rescue Errno::EPERM => e
+      Flatware.log 'continuing after: Process.setpgrp:', e.message
+    end
+
     def workers
       options[:workers]
     end

data/lib/flatware/serialized_exception.rb

@@ -3,11 +3,11 @@ module Flatware
     attr_reader :class, :message, :cause
     attr_accessor :backtrace
 
-    def initialize(klass, message, backtrace, cause = '')
+    def initialize(klass, message, backtrace, cause = nil)
       @class = serialized(klass)
       @message = message
       @backtrace = backtrace
-      @cause = cause
+      @cause = cause && SerializedException.from(cause)
     end
 
     def self.from(exception)

data/lib/flatware/sink/signal.rb

@@ -0,0 +1,51 @@
+module Flatware
+  module Sink
+    class Signal
+      def initialize(&on_interrupt)
+        Thread.main[:signals] = Queue.new
+
+        @on_interrupt = on_interrupt
+      end
+
+      def interruped?
+        !signals.empty?
+      end
+
+      def listen
+        Thread.new(&method(:handle_signals))
+
+        ::Signal.trap('INT') { signals << :int }
+        ::Signal.trap('CLD') { signals << :cld }
+
+        self
+      end
+
+      def self.listen(&block)
+        new(&block).listen
+      end
+
+      private
+
+      def handle_signals
+        puts signal_message(signals.pop)
+        Process.waitall
+        @on_interrupt.call
+        puts 'done.'
+        abort
+      end
+
+      def signal_message(signal)
+        format(<<~MESSAGE, { cld: 'A worker died', int: 'Interrupted' }.fetch(signal))
+
+          %s!
+
+          Cleaning up. Please wait...
+        MESSAGE
+      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
@@ -31,7 +32,7 @@ module Flatware
       end
 
       def start
-        trap_interrupt
+        @signal = Signal.listen(&method(:summarize_remaining))
         formatter.jobs jobs
         DRb.start_service(sink, self, verbose: Flatware.verbose?)
         DRb.thread.join
@@ -72,29 +73,8 @@ 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!'
-        summarize_remaining
-        puts "\n\nCleaning up. Please wait...\n"
-        Process.waitall
-        puts 'done.'
-        abort
-      end
-
       def interruped?
-        signals = Thread.main[:signals]
-        signals && !signals.empty?
+        @signal&.interruped?
       end
 
       def check_finished!

data/lib/flatware/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flatware
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Brian Dunn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-03-20 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