Fix infinite recursion when the logger enters a loop

[ArturT]

Story

https://trello.com/c/yROeD8FX

Related

• Infinite recursion when KNAPSACK_PRO_LOG_LEVEL is set to debug #269

Description

Fix infinite recursion when the logger enters a loop. The issue 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).

Changes:

• Log a warning message using warn instead of the Knapsack Pro logger to prevent infinite recursion.

Checklist reminder

• You added the changes to the UNRELEASED section of the CHANGELOG.md, including the needed bump (ie, patch, minor, major)
• You follow the architecture outlined below for RSpec in Queue Mode, which is a work in progress (feel free to propose changes):
  • Pure: lib/knapsack_pro/pure/queue/rspec_pure.rb contains pure functions that are unit tested.
  • Extension: lib/knapsack_pro/extensions/rspec_extension.rb encapsulates calls to RSpec internals and is integration and e2e tested.
  • Runner: lib/knapsack_pro/runners/queue/rspec_runner.rb invokes the pure code and the extension to produce side effects, which are integration and e2e tested.

[ArturT]

Regardless of

Warning[:deprecated] = false

or

Warning[:deprecated] = true

the following warning is printed to stderr:

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}.")

This is fine. We expect it to be printed. After all, it's not a deprecation warning. It's a misconfiguration warning.

If we were to add the :deprecated category to the following message, then the suppression would be respected if Warning[:deprecated] = false:

# see the end of the line
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}.", category: :deprecated)

References:

• https://ruby-doc.org/3.3.6/Warning.html
• Warning[:deprecated] = true by default in RSpec rspec/rspec#37
• https://bugs.ruby-lang.org/issues/17591

[3v0k4]

plea

Please add more information here. The issue is a good starting point.