knapsack_pro 7.6.2 → 7.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd5c8d52aa9de26d125b40b1c3b60ee7536a75e9351b524ad9d99386fd6bfc8
-  data.tar.gz: 491d49252b139b817939ef4555a36fba6ca6ca74cc70e9a325124e0a900bb5ab
+  metadata.gz: 305d35a49e09ed66729fda89d59557df29b05f260ad7495cf7c37f5e886f55f8
+  data.tar.gz: 07efa1a33e29ea7d0ea8b83e7134558dda4e94e14c3753d386cb5d46ad8e1dee
 SHA512:
-  metadata.gz: f1b030ead892b4251f9e191049425675105940777e5061a81e23b90ce8481e3a0564832068202d56d912afe62e5e92482a771f06e7c3faeaf331dc5d772a583c
-  data.tar.gz: 82f5ba33b17213da4b7a7b8e2647042559b52ac12c0aae7255f838ed4e6ed70d0fab80d7009434855e58c1c63d3c11fb9cfe69f85fab5968fa37edc3005d1250
+  metadata.gz: 0b3af0a93381d94a03afa13a3bddb9de2c2b91958ffb8b0d83707c168300a51bf863d6907ce3b5f2cbe22fc87954fe01f4b61557b9cafddceabd35ba541a2344
+  data.tar.gz: f195aebb076beac551dbd4923fdb516d08d2d2f15d6b663499be5ed432dc502048a93bafdd48ff46f1632ac1d9adf5de2e4c261a9c4d80a9eab31e2ddb62a5e6

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ### UNRELEASED
 
+### 7.8.0
+
+* Add a link to help you read the backtrace.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/267
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.7.0...v7.8.0
+
+### 7.7.0
+
+* Log threads when the OS signal is received to simplify debugging, especially when a CI node hangs.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/266
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.6.2...v7.7.0
+
 ### 7.6.2
 
 * Fix an error for the `KnapsackPro::Formatters::TimeTracker` formatter in RSpec when using Knapsack Pro Regular Mode and the `.rspec` file is not present.

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

@@ -59,9 +59,38 @@ module KnapsackPro
             Signal.trap(signal) {
               puts "#{signal} signal has been received. Terminating Knapsack Pro..."
               @@terminate_process = true
+              log_threads
             }
           end
         end
+
+        def log_threads
+          threads = Thread.list
+
+          puts
+          puts '=' * 80
+          puts "Start logging #{threads.count} detected threads."
+          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'
+
+          threads.each do |thread|
+            puts
+            if thread == Thread.main
+              puts "Main thread backtrace:"
+            else
+              puts "Non-main thread inspect: #{thread.inspect}"
+              puts "Non-main thread backtrace:"
+            end
+            puts thread.backtrace.join("\n")
+            puts
+          end
+
+          puts
+          puts 'End logging threads.'
+          puts '=' * 80
+
+          $stdout.flush
+        end
       end
     end
   end

data/lib/knapsack_pro/version.rb

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

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

@@ -1318,6 +1318,12 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
         describe 'A_describe' do
           it 'A1 test example' do
             expect(1).to eq 1
+
+            Thread.new do
+              sleep 10
+            end
+
+            sleep 1 # wait for the above async thread to start
           end
         end
       SPEC
@@ -1406,6 +1412,14 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
         OUTPUT
       )
 
+
+      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('Main thread backtrace:')
+      expect(actual.stdout).to include("spec_integration/b_spec.rb:7:in `kill'")
+      expect(actual.stdout).to include('Non-main thread backtrace:')
+      expect(actual.stdout).to include("spec_integration/a_spec.rb:6:in `sleep'")
+
+
       expect(actual.exit_code).to eq 1
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.6.2
+  version: 7.8.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -415,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel