knapsack_pro 8.3.0 → 8.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154cc1aaba977644e5f9dd5298e594ba4e6bbc4a67ec1edf1caac2aaf3d21ebb
-  data.tar.gz: 11a7acd42b97cd0e2d0075733e0a34ebcc5677f1cbd2e5342cccb2745405cadd
+  metadata.gz: 479679af72441adcef212263c4a92e92760fc3bb82779616c47504d0a137a69c
+  data.tar.gz: 6376bcc3c00f50efa3633a1d015b23bb7a6fd3d8a3188d6912327e5f79c1ae27
 SHA512:
-  metadata.gz: 733e3fc942afe5ba74bc1b689ac9255bba46e28ddfdd60a826a0946f68a9c208d139786c2ff32319885adbe1c1a0e0696d9f63c5dc1a916b6b5a4072af3e9de8
-  data.tar.gz: 5769bf6874b3b93a1349268688d0304015da91072d9661852b034e937628f1be51d17a4e96a9124713fc6a730f953257989ba4613c6d5246de6ac8ec332c21e7
+  metadata.gz: 7dc0407f4c64d578cac17f64f71d93ac123e8ee7a96eeca2637e7e131449c35318bed7b6636d9e722528f36059a4cb5a8748b18e7737aaa8e92ba8212c82f83e
+  data.tar.gz: b3c505870912614006845bbf65b488ca1fe201f0a22e0dc449d5b2f7651603eceea5693fa7db5eff68bc7cd5bc89dde673eb21097a4cb341473b5b06bbcacaf5

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Changelog
 
-### UNRELEASED
+### UNRELEASED (patch)
+
+### 8.3.2
+
+* Fix infinite recursion when the logger enters a loop. [The issue](https://github.com/KnapsackPro/knapsack_pro-ruby/issues/269) occurs when `KNAPSACK_PRO_LOG_DIR=log` is set and a conflict arises between the values of environment variables from the CI provider and those configured by the user (e.g., `KNAPSACK_PRO_CI_NODE_INDEX`, `KNAPSACK_PRO_CI_NODE_TOTAL`).
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/304
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.3.1...v8.3.2
+
+### 8.3.1
+
+* Fix RSpec TimeTracker to properly track `before(:all)/after(:all)`.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/303
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.3.0...v8.3.1
+
 
 ### 8.3.0
 

data/lib/knapsack_pro/config/env.rb

@@ -13,11 +13,11 @@ module KnapsackPro
 
       class << self
         def ci_node_total
-          (env_for('KNAPSACK_PRO_CI_NODE_TOTAL', :node_total) || 1).to_i
+          @ci_node_total ||= (env_for('KNAPSACK_PRO_CI_NODE_TOTAL', :node_total) || 1).to_i
         end
 
         def ci_node_index
-          (env_for('KNAPSACK_PRO_CI_NODE_INDEX', :node_index) || 0).to_i
+          @ci_node_index ||= (env_for('KNAPSACK_PRO_CI_NODE_INDEX', :node_index) || 0).to_i
         end
 
         def ci_node_build_id
@@ -294,7 +294,7 @@ module KnapsackPro
           ci_env_value = ci_env_for(ci_env_method)
 
           if !knapsack_env_value.nil? && !ci_env_value.nil? && knapsack_env_value != ci_env_value.to_s
-            KnapsackPro.logger.info("You have set the environment variable #{knapsack_env_name} to #{knapsack_env_value} which could be automatically determined from the CI environment as #{ci_env_value}.")
+            warn("You have set the environment variable #{knapsack_env_name} to #{knapsack_env_value} which could be automatically determined from the CI environment as #{ci_env_value}.")
           end
 
           knapsack_env_value != nil ? knapsack_env_value : ci_env_value

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -19,7 +19,7 @@ module KnapsackPro
         @output = StringIO.new
         @time_each = nil
         @time_all = nil
-        @before_all = 0.0
+        @time_all_by_group_id_path = Hash.new(0)
         @group = {}
         @paths = {}
         @suite_started = now
@@ -38,12 +38,12 @@ module KnapsackPro
       end
 
       def example_group_started(notification)
-        return unless top_level_group?(notification.group)
+        record_time_all(notification.group.parent_groups[1], @time_all_by_group_id_path, @time_all)
         @time_all = now
       end
 
-      def example_started(_notification)
-        @before_all = now - @time_all if @before_all == 0.0
+      def example_started(notification)
+        record_time_all(notification.example.example_group, @time_all_by_group_id_path, @time_all)
         @time_each = now
       end
 
@@ -53,11 +53,12 @@ module KnapsackPro
       end
 
       def example_group_finished(notification)
+        record_time_all(notification.group, @time_all_by_group_id_path, @time_all)
+        @time_all = now
         return unless top_level_group?(notification.group)
 
-        after_all = @time_all.nil? ? 0.0 : now - @time_all
-        add_hooks_time(@group, @before_all, after_all)
-        @before_all = 0.0
+        add_hooks_time(@group, @time_all_by_group_id_path)
+        @time_all_by_group_id_path = Hash.new(0)
         @paths = merge(@paths, @group)
         @group = {}
       end
@@ -104,10 +105,17 @@ module KnapsackPro
         group.metadata[:parent_example_group].nil?
       end
 
-      def add_hooks_time(group, before_all, after_all)
+      def add_hooks_time(group, time_all_by_group_id_path)
         group.each do |_, example|
           next if example[:time_execution] == 0.0
-          example[:time_execution] += before_all + after_all
+
+          example[:time_execution] += time_all_by_group_id_path.sum do |group_id_path, time|
+            # :path is a file path (a_spec.rb), sum any before/after(:all) in the file
+            next time if group_id_path.start_with?(example[:path])
+            # :path is an id path (a_spec.rb[1:1]), sum any before/after(:all) above it
+            next time if example[:path].start_with?(group_id_path[0..-2])
+            0
+          end
         end
       end
 
@@ -123,6 +131,13 @@ module KnapsackPro
         end
       end
 
+      def record_time_all(group, time_all_by_group_id_path, time_all)
+        return unless group # above top level group
+
+        group_id_path = KnapsackPro::TestFileCleaner.clean(group.id)
+        time_all_by_group_id_path[group_id_path] += now - time_all
+      end
+
       def path_for(example)
         file_path = file_path_for(example)
         return nil if file_path == ""

data/lib/knapsack_pro/version.rb

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

data/spec/knapsack_pro/config/env_spec.rb

@@ -1,6 +1,11 @@
 describe KnapsackPro::Config::Env do
   before { stub_const("ENV", {}) }
 
+  before(:each) do
+    described_class.remove_instance_variable(:@ci_node_index) if described_class.instance_variable_defined?(:@ci_node_index)
+    described_class.remove_instance_variable(:@ci_node_total) if described_class.instance_variable_defined?(:@ci_node_total)
+  end
+
   describe '.ci_node_total' do
     subject { described_class.ci_node_total }
 
@@ -19,12 +24,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_CI_NODE_TOTAL and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_TOTAL' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:node_total).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -34,7 +36,7 @@ describe KnapsackPro::Config::Env do
           it { should eq 5 }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_CI_NODE_TOTAL to 5 which could be automatically determined from the CI environment as 4.'
             )
             subject
@@ -46,7 +48,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { 5 }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -76,12 +78,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_CI_NODE_INDEX and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_INDEX' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:node_index).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -91,7 +90,7 @@ describe KnapsackPro::Config::Env do
           it { should eq 3 }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_CI_NODE_INDEX to 3 which could be automatically determined from the CI environment as 2.'
             )
             subject
@@ -103,7 +102,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { 3 }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -140,12 +139,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_CI_NODE_BUILD_ID and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_BUILD_ID' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:node_build_id).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -155,7 +151,7 @@ describe KnapsackPro::Config::Env do
           it { should eq '7' }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_CI_NODE_BUILD_ID to 7 which could be automatically determined from the CI environment as 8.'
             )
             subject
@@ -167,7 +163,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { '7' }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -199,12 +195,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_CI_NODE_RETRY_COUNT and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_CI_NODE_RETRY_COUNT' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:node_retry_count).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -214,7 +207,7 @@ describe KnapsackPro::Config::Env do
           it { should eq 1 }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_CI_NODE_RETRY_COUNT to 1 which could be automatically determined from the CI environment as 2.'
             )
             subject
@@ -226,7 +219,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { '7' }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -269,12 +262,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_COMMIT_HASH and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_COMMIT_HASH' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:commit_hash).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -284,7 +274,7 @@ describe KnapsackPro::Config::Env do
           it { should eq '3fa64859337f6e56409d49f865d13fd7' }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_COMMIT_HASH to 3fa64859337f6e56409d49f865d13fd7 which could be automatically determined from the CI environment as fe61a08118d0d52e97c38666eba1eaf3.'
             )
             subject
@@ -296,7 +286,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { '3fa64859337f6e56409d49f865d13fd7' }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -326,12 +316,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_BRANCH and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_BRANCH' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:branch).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -341,7 +328,7 @@ describe KnapsackPro::Config::Env do
           it { should eq 'main' }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_BRANCH to main which could be automatically determined from the CI environment as feature-branch.'
             )
             subject
@@ -353,7 +340,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { 'main' }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -383,12 +370,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_PROJECT_DIR and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_PROJECT_DIR' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:project_dir).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -398,7 +382,7 @@ describe KnapsackPro::Config::Env do
           it { should eq '/home/user/myapp' }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_PROJECT_DIR to /home/user/myapp which could be automatically determined from the CI environment as /home/runner/myapp.'
             )
             subject
@@ -410,7 +394,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { '/home/user/myapp' }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -440,12 +424,9 @@ describe KnapsackPro::Config::Env do
       end
 
       context 'when both KNAPSACK_PRO_USER_SEAT and CI environment have value' do
-        let(:logger) { instance_double(Logger, info: nil) }
-
         before do
           stub_const("ENV", { 'KNAPSACK_PRO_USER_SEAT' => env_value })
           expect(described_class).to receive(:ci_env_for).with(:user_seat).and_return(ci_value)
-          allow(KnapsackPro).to receive(:logger).and_return(logger)
         end
 
         context 'when values are different' do
@@ -455,7 +436,7 @@ describe KnapsackPro::Config::Env do
           it { should eq 'John Doe' }
 
           it 'logs a warning' do
-            expect(logger).to receive(:info).with(
+            expect(described_class).to receive(:warn).with(
               'You have set the environment variable KNAPSACK_PRO_USER_SEAT to John Doe which could be automatically determined from the CI environment as Jane Doe.'
             )
             subject
@@ -467,7 +448,7 @@ describe KnapsackPro::Config::Env do
           let(:ci_value) { 'John Doe' }
 
           it 'does not log a warning' do
-            expect(logger).not_to receive(:info)
+            expect(described_class).not_to receive(:warn)
             subject
           end
         end
@@ -872,13 +853,11 @@ describe KnapsackPro::Config::Env do
           it "on #{ci} it is false" do
             stub_const("ENV", env.merge({ 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'false' }))
 
-            logger = instance_double(Logger)
-            allow(KnapsackPro).to receive(:logger).and_return(logger)
             ci_env = described_class.detected_ci.new.fixed_queue_split
             if ci_env == false
-              expect(logger).not_to receive(:info)
+              expect(described_class).not_to receive(:warn)
             else
-              expect(logger).to receive(:info).with(
+              expect(described_class).to receive(:warn).with(
                 'You have set the environment variable KNAPSACK_PRO_FIXED_QUEUE_SPLIT to false which could be automatically determined from the CI environment as true.'
               )
             end
@@ -907,13 +886,11 @@ describe KnapsackPro::Config::Env do
           it "on #{ci} it is true" do
             stub_const("ENV", env.merge({ 'KNAPSACK_PRO_FIXED_QUEUE_SPLIT' => 'true' }))
 
-            logger = instance_double(Logger)
-            allow(KnapsackPro).to receive(:logger).and_return(logger)
             ci_env = described_class.detected_ci.new.fixed_queue_split
             if ci_env == true
-              expect(logger).not_to receive(:info)
+              expect(described_class).not_to receive(:warn)
             else
-              expect(logger).to receive(:info).with(
+              expect(described_class).to receive(:warn).with(
                 'You have set the environment variable KNAPSACK_PRO_FIXED_QUEUE_SPLIT to true which could be automatically determined from the CI environment as false.'
               )
             end

data/spec/knapsack_pro/formatters/time_tracker_specs.rb

@@ -220,6 +220,63 @@ class TestTimeTracker
     end
   end
 
+  def test_nested_hooks
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      false
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        before(:all) do
+          sleep 0.1
+        end
+
+        after(:all) do
+          sleep 0.1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 1
+      raise unless times[0]["path"] == spec_paths.first
+      raise unless times[0]["time_execution"] > 0.60
+      raise unless times[0]["time_execution"] < 0.65
+    end
+  end
+
   def test_hooks_with_rspec_split_by_test_example
     KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
       true
@@ -263,6 +320,68 @@ class TestTimeTracker
     end
   end
 
+  def test_nested_hooks_with_rspec_split_by_test_example
+    KnapsackPro::Formatters::TimeTracker.define_method(:rspec_split_by_test_example?) do |_file|
+      true
+    end
+
+    spec = <<~SPEC
+      describe "KnapsackPro::Formatters::TimeTracker" do
+        before(:all) do
+          sleep 0.1
+        end
+
+        after(:all) do
+          sleep 0.1
+        end
+
+        it do
+          expect(1).to eq 1
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+
+        describe do
+          before(:all) do
+            sleep 0.1
+          end
+
+          after(:all) do
+            sleep 0.1
+          end
+
+          it do
+            expect(1).to eq 1
+          end
+        end
+      end
+    SPEC
+
+    run_specs(spec) do |spec_paths, times|
+      raise unless times.size == 3
+      spec_path = spec_paths.first
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] > 0.20
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:1]" }["time_execution"] < 0.25
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2:1]" }["time_execution"] > 0.40
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:2:1]" }["time_execution"] < 0.45
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:3:1]" }["time_execution"] > 0.40
+      raise unless times.find { |time| time["path"] == "#{spec_path}[1:3:1]" }["time_execution"] < 0.45
+    end
+  end
+
+
   def test_unknown_path
     KnapsackPro::Formatters::TimeTracker.class_eval do
       alias_method :original_file_path_for, :file_path_for

data/spec/knapsack_pro_spec.rb

@@ -10,7 +10,10 @@ describe KnapsackPro do
 
     subject { described_class.logger }
 
-    before { described_class.reset_logger! }
+    before(:each) do
+      described_class.reset_logger!
+      KnapsackPro::Config::Env.remove_instance_variable(:@ci_node_index) if KnapsackPro::Config::Env.instance_variable_defined?(:@ci_node_index)
+    end
     after { described_class.reset_logger! }
 
     context 'when KNAPSACK_PRO_LOG_DIR is set' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.3.0
+  version: 8.3.2
 platform: ruby
 authors:
 - ArturT
 bindir: bin
 cert_chain: []
-date: 2025-05-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -428,7 +428,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
   job finish work at a similar time.