undefined local variable or method `tagged_logger' during perform_enqueued_jobs

[jkwuc89]

What Ruby, Rails and RSpec versions are you using?

Ruby version: 3.0.3p157 (2021-11-24 revision 3fb7d2cadc) [x86_64-darwin21]
Rails version: 7.0.0
RSpec 3.10

• rspec-core 3.10.1
• rspec-expectations 3.10.1
• rspec-mocks 3.10.2
• rspec-rails 5.0.2
• rspec-support 3.10.3

Observed behaviour

Inside an rspec support module, my app is calling perform_enqueued_jobs. The spec in question that is using this support module is expecting this call to raise an exception.

When I attempt to run this spec, the following is raised:

got #<NameError: undefined local variable or method `tagged_logger'

When I debug into perform_enqueued_jobs, I am taken into _assert_nothing_raised_or_warn inside activesupport-7.0.0/lib/active_support/testing/assertions.rb, When debugging the block below, it shows e as having the expected exception.

        rescue Minitest::UnexpectedError => e
          if tagged_logger && tagged_logger.warn?
            warning = <<~MSG
              #{self.class} - #{name}: #{e.error.class} raised.
              If you expected this exception, use `assert_raises` as near to the code that raises as possible.
              Other block based assertions (e.g. `#{assertion}`) can be used, as long as `assert_raises` is inside their block.
            MSG
            tagged_logger.warn warning
          end

          raise
        end

Debugging further reveals that the if tagged_logger check above is causing the undefined error.

I reported this on Rails forum here and a member of the core team suggested the following:

"This seems to be a bug in RSpec that doesn’t implement the tagged_logger. Please report the issue in the RSpec issue tracker."

Expected behaviour

The spec should finish and allow to raise_error to check for the expected exception. This spec is working as expected in Rails 6.

[pirj]

Thanks for reporting.
tagger_logger seems to have been introduced in this commit. Wondering if we should work this around by setting it to nil in our adapters code, or this should be fixed in Rails. Wondering where this tagged_logger is defined/initialized in Rails code for testing.
Would you like to dig deeper in this, @jkwuc89 ?

[jkwuc89]

I'll take a deeper dive into this and report what I find.

[JonRowe]

It feels like they are checking for a tagged logger by assuming it exists, they could easily fix this by checking its defined

[jkwuc89]

Inside the Rails PR that added the block I included in the description above, one finds this comment which suggests checking if tagged_logger is defined. 🤔

rails/rails#42459 (comment)

[rafaelfranca]

I think rspec-rails should be responsible for making sure the features of ActiveSupport::TestCase it uses works with RSpec, nor Rails that should check if its own API is existent.

[pirj]

Thanks for the hints @rafaelfranca, @ghiculescu.

@jkwuc89 Does it fix the issue if you add the following to rspec-rails' lib/rspec/rails/example/rails_example_group.rb?

        extend ActiveSupport::Concern
+       include ActiveSupport::Testing::TaggedLogging
        include RSpec::Rails::SetupAndTeardownAdapter

[westonganger]

Here is a quick monkey patch using @pirj suggested solution

# spec/rspec_helper.rb

if Rails::VERSION::MAJOR >= 7
  require 'rspec/rails/version'
  
  if Gem::Version.create(RSpec::Rails::Version::STRING) < Gem::Version.create("5.1.0")
    RSpec::Rails::RailsExampleGroup.module_eval do
      include ActiveSupport::Testing::TaggedLogging
    end
  end
end

[jkwuc89]

Adding the following to spec/rails_helper.rb inside my Rails project allows tagged_logger to get defined which fixes the original undefined error in the description above.

if Rails::VERSION::MAJOR >= 7
  include ActiveSupport::Testing::TaggedLogging
end

Unfortunately, it causes another issue when I run the spec in question. When _assert_nothing_raised_or_warn is called inside activesupport-7.0.0/lib/active_support/testing/assertions.rb as part of handling an exception during perform_enqueued_jobs, it causes the spec to fail with the following because _assert_nothing_raised_or_warn uses name inside its definition.

expected Workflow::SellerAuthorization::MissingSellerAuthorizationError, got #<RSpec::Core::ExampleGroup::WrongScopeError: `name` is not available from within an example (e.g. an...ore`, `let`, etc). It is only available on an example group (e.g. a `describe` or `context` block).> with backtrace:
  # ./spec/support/events/async_event_processor.rb:6:in `publish_event_inline'
  # ./spec/models/workflow/seller_authorization_spec.rb:668:in `block (3 levels) in <top (required)>'
  # ./spec/models/workflow/seller_authorization_spec.rb:699:in `block (6 levels) in <top (required)>'
  # ./spec/models/workflow/seller_authorization_spec.rb:699:in `block (5 levels) in <top (required)>'
  # ./spec/spec_helper.rb:20:in `block (2 levels) in <top (required)>'

[xxx]

I'm using the following crappy patch, as including the module into RSpec::Rails::RailsExampleGroup did not do anything.

Also defined a dummy name method (sigh), to resolve the subsequent issue that @jkwuc89 raises just above (which this also runs into)

if Rails::VERSION::MAJOR >= 7
  require 'rspec/rails/version'

  RSpec::Core::ExampleGroup.module_eval do
    include ActiveSupport::Testing::TaggedLogging

    def name
      'foobar'
    end
  end
end

[JonRowe]

PRs would be accepted to solve this, RailsExampleGroup should conditionally (as in, if on Rails 7) include this module, and ideally we'd want a snippet testing it.

[JonRowe]

This was fixed in 6.0.0 and further improved in 6.0.1