knapsack_pro 7.6.1 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11356d7eace33ba43c1dec527436091c103ac8b5d6c9bd2ae28851294854d4df
-  data.tar.gz: 15717cbb12d7d9143be84504464ecd32a25841bb984e70ec88ec6b3c05b0dcbe
+  metadata.gz: 0d9f69e3b0bb57140c1efc90528f7151a7cee10998ec84fe8c87b46767a08aa7
+  data.tar.gz: 5a60c75f51c4909352c022eb74626c831c514ba644f3da5a368a26f2838487bc
 SHA512:
-  metadata.gz: 5a12e300c1a6a7427836b2a62d71b7ccb35174c31d444ac77fdd19847a7b9b85fc805adb9bd966329d0c7e21e58c233230e63e8943b14bad6b9267236c69ee3a
-  data.tar.gz: 3ac187d311a35d343c5c6fd86c667049642638862d5dff4d68ecff91d63191b05a1206881d24efebd3163d92cbd69e08bd8d0a4b129f69bf45b348dde49662be
+  metadata.gz: 93725a31ebe826cfc133f717d02d22d502ab989eaabd7972f0955d32358301685cb3475b18714df69a77be4c04c5fc59dce7fcdc39556b9fd5d070978153a2b4
+  data.tar.gz: 667419cf885ebd7ee1d18420d002d4ad752d973399fb3a980321cbfb0dd41415865445851add3d7641023a05499369dd83c10fadb56171a39c08fa8a991f2b03

data/.circleci/config.yml

@@ -165,6 +165,18 @@ jobs:
             export KNAPSACK_PRO_ENDPOINT=https://api-fake.knapsackpro.com
             export KNAPSACK_PRO_MAX_REQUEST_RETRIES=1
             bundle exec rake knapsack_pro:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # ensures KnapsackPro::Formatters::TimeTracker works when the .rspec file does not exist
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular--no-dot-rspec-file"
+            mv .rspec .rspec.off
+            # load test files that require spec_helper explicitly
+            export KNAPSACK_PRO_TEST_FILE_PATTERN="{spec/time_tracker_spec.rb}"
+            bundle exec rake knapsack_pro:rspec
+            RSPEC_EXIT_CODE=$?
+            mv .rspec.off .rspec
+            exit $RSPEC_EXIT_CODE
       - run:
           working_directory: ~/rails-app-with-knapsack_pro
           command: |

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ### UNRELEASED
 
+### 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.
+
+  https://github.com/KnapsackPro/knapsack_pro-ruby/pull/265
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.6.1...v7.6.2
+
 ### 7.6.1
 
 * Add support for the Timecop 0.9.9 gem version so that we could track proper tests' execution time when `Process.clock_gettime` is mocked.

data/README.md

@@ -78,7 +78,7 @@ Scripted tests can be found in the [Rails App With Knapsack Pro repository](http
 
 2. Update the gem version in `lib/knapsack_pro/version.rb`
 
-3. `git commit -am "chore: prepare release"`
+3. `git commit -am "Bump version x.x.x"`
 
 4. Build, tag, push, release: `bundle exec rake release`
 

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'stringio'
+require_relative '../utils'
 
 module KnapsackPro
   module Formatters

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

@@ -59,9 +59,37 @@ 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.'
+
+          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.1'
+  VERSION = '7.7.0'
 end

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

@@ -1318,6 +1318,10 @@ 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
           end
         end
       SPEC
@@ -1406,6 +1410,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.1
+  version: 7.7.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-08-07 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