knapsack_pro 8.3.1 → 8.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c6268ccfd0e07224b6fbae963baa01c2f6344b924b7b3b1097a42474c57e3b7
-  data.tar.gz: 909d3632bcede5ecd49e075edc62b4c8a602b31cd1e059c99097a92bd6b21c75
+  metadata.gz: 479679af72441adcef212263c4a92e92760fc3bb82779616c47504d0a137a69c
+  data.tar.gz: 6376bcc3c00f50efa3633a1d015b23bb7a6fd3d8a3188d6912327e5f79c1ae27
 SHA512:
-  metadata.gz: 94cd957dcb04b6157e0aa6902cf6576e67857099b7c4db232742d7a420d08cc588e0dead4bb1d9ec7103024de0b2fe9edbeddacc0575d00533e530cd4c125465
-  data.tar.gz: cf30d4fddcab85d7ce32b589ef624bf08e78eb7d2ad236410c0d162538f3eee457311a7ff9a3ac08fb25440490574d707bf171d252e8dda4b9457138feced4b5
+  metadata.gz: 7dc0407f4c64d578cac17f64f71d93ac123e8ee7a96eeca2637e7e131449c35318bed7b6636d9e722528f36059a4cb5a8748b18e7737aaa8e92ba8212c82f83e
+  data.tar.gz: b3c505870912614006845bbf65b488ca1fe201f0a22e0dc449d5b2f7651603eceea5693fa7db5eff68bc7cd5bc89dde673eb21097a4cb341473b5b06bbcacaf5

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ### 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)`.

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '8.3.1'
+  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_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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 8.3.1
+  version: 8.3.2
 platform: ruby
 authors:
 - ArturT