knapsack_pro 7.13.0 → 7.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddf5678a555f4e33ac61a02ba0f05b916a5e65dd8dca2b5a06e7d2bea74da028
-  data.tar.gz: aaa74b69c3753b8f70aa8deff5528413db49c53b731ce65db571d5d768c0d4f0
+  metadata.gz: 113e9ca31d058ab9623d6a0bb278768ad0a864db8bb8776440d00ceb2a648b37
+  data.tar.gz: '084be6d88bf072c8ece112b3de2a6707b240816e993f039701cd68e7920f7988'
 SHA512:
-  metadata.gz: dbc287b2088b1fb96a76e9ca59d3e37c40e426644b21c0b85fd373737847b0966f56b70309b5ba2afa32c26279807ea858d99e09ab9e9feb38ed0f1819320dcd
-  data.tar.gz: fc31eb5aa8f02cb4a77221d04d5260e607a8af70e3174b89c0d578c67f2616c4bee76a098d7f405942a0bcf678399b9d270b42e50d1e89902233f1e7203ea8f1
+  metadata.gz: 97015f7b3db931f3a9f68e7ef59aecb99f0befa5202b148d5aa56736d256048c842c00babc265c47c583534f2a0dafc488c49b748b4b3084f93a2d42f6013d84
+  data.tar.gz: 62fd8be74b14f402840ea4b9b6866a9ac008daa09d279e2cee21bd3f513d8f746f635c770c83e65db36139aa6e9ebb362301794e6aad70a9d59796dd86167d90

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+### 7.14.0
+
+* Improve debugging for hanging CI nodes: show hanging spec files in the RSpec output and a command to reproduce the current batch of tests.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/287
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.13.1...v7.14.0
+
+### 7.13.1
+
+* Fix handling signals for non-RSpec test runners
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/286
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.13.0...v7.13.1
+
 ### 7.13.0
 
 * Add `KNAPSACK_PRO_FALLBACK_MODE_ERROR_EXIT_CODE` to specify a custom exit code whenever Knapsack Pro fails because Fallback Mode cannot be used

data/lib/knapsack_pro/runners/queue/base_runner.rb

@@ -59,12 +59,15 @@ module KnapsackPro
             Signal.trap(signal) {
               puts "#{signal} signal has been received. Terminating Knapsack Pro..."
               @@terminate_process = true
-              RSpec.world.wants_to_quit = true
+              post_trap_signals
               log_threads
             }
           end
         end
 
+        def post_trap_signals
+        end
+
         def log_threads
           threads = Thread.list
 
@@ -74,6 +77,8 @@ module KnapsackPro
           puts 'Use the following backtrace(s) to find the line of code that got stuck if the CI node hung and terminated your tests.'
           puts 'How to read the backtrace: https://knapsackpro.com/perma/ruby/backtrace-debugging'
 
+          log_current_tests(threads)
+
           threads.each do |thread|
             puts
             if thread == Thread.main
@@ -92,6 +97,10 @@ module KnapsackPro
 
           $stdout.flush
         end
+
+        def log_current_tests(threads)
+          # implement in a child class if you need to log more info
+        end
       end
     end
   end

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -117,6 +117,31 @@ module KnapsackPro
 
         private
 
+        def post_trap_signals
+          RSpec.world.wants_to_quit = true
+
+          log_current_batch_rspec_command
+        end
+
+        def log_current_tests(threads)
+          threads.each do |thread|
+            next unless thread.backtrace
+
+            spec_file_lines = thread.backtrace.select { |line| line.include?('_spec.rb') }
+            next if spec_file_lines.empty?
+
+            puts
+            if thread == Thread.main
+              puts "Running specs in the main thread:"
+            else
+              puts "Non-main thread inspect: #{thread.inspect}"
+              puts "Running specs in non-main thread:"
+            end
+            puts spec_file_lines.join("\n")
+            puts
+          end
+        end
+
         def pre_run_setup
           ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
           ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
@@ -161,6 +186,21 @@ module KnapsackPro
           test_file_paths
         end
 
+        def log_current_batch_rspec_command
+          test_file_paths = @queue.current_batch&.test_file_paths
+          return unless test_file_paths
+
+          puts
+          puts '=' * 80
+
+          order_option = @adapter_class.order_option(@cli_args)
+          printable_args = @rspec_pure.args_with_seed_option_added_when_viable(order_option, @rspec_runner.knapsack__seed, @cli_args)
+          messages = @rspec_pure.rspec_command(printable_args, test_file_paths, :batch_finished)
+          messages.each do |message|
+            puts message
+          end
+        end
+
         def log_rspec_batch_command(test_file_paths)
           order_option = @adapter_class.order_option(@cli_args)
           printable_args = @rspec_pure.args_with_seed_option_added_when_viable(order_option, @rspec_runner.knapsack__seed, @cli_args)

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '7.13.0'
+  VERSION = '7.14.0'
 end

data/spec/integration/runners/queue/rspec_runner_spec.rb

@@ -1403,12 +1403,16 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
         OUTPUT
       )
 
+      expect(actual.stdout).to include('To retry the last batch of tests fetched from the Queue API, please run the following command on your machine:')
+      expect(actual.stdout).to include('bundle exec rspec --format documentation --default-path spec_integration "spec_integration/b_spec.rb" "spec_integration/c_spec.rb"')
 
       expect(actual.stdout).to include('Use the following backtrace(s) to find the line of code that got stuck if the CI node hung and terminated your tests.')
+      expect(actual.stdout).to include('Running specs in the main thread:')
+      expect(actual.stdout).to include('Running specs in non-main thread:')
       expect(actual.stdout).to include('Main thread backtrace:')
-      expect(actual.stdout).to match(/spec_integration\/b_spec\.rb:7:in .*kill/)
+      expect(actual.stdout.scan(/spec_integration\/b_spec\.rb:7:in .*kill/).size).to eq 2
       expect(actual.stdout).to include('Non-main thread backtrace:')
-      expect(actual.stdout).to match(/spec_integration\/a_spec\.rb:6:in .*sleep/)
+      expect(actual.stdout.scan(/spec_integration\/a_spec\.rb:6:in .*sleep/).size).to eq 2
 
 
       expect(actual.exit_code).to eq 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.13.0
+  version: 7.14.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -433,7 +433,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel