Upgrading to gems derived from Rails 7 causes Minitest errors

[benjaminoakes]

Background

While upgrading gems derived from Rails to address security vulnerabilities in #54, a series of spec errors prevented a normal bundle update. There was not an obvious fix to make the specs work on Rails 7, so I opted to force Rails 6 to resolve the security alerts. Please see "Technical Details" for more information.

Proposed

Upgrade all Rails-derived gems to version 7.x and fix any errors such that the test suite passes.

Technical Details

Using bundle update brought the Rails-derived gems to version 7.1.1 but this introduced unexpected spec failures, likely due to a dependency issue relating to the assert method. Both failing specs use perform_enqueued_jobs.

Debugging Notes

The following are my debugging notes in the hopes that they're useful to anyone working on this issue.

Details...

When running rake, the following specs failed:

  1) Integration can backfill using an example job
     Failure/Error:
       perform_enqueued_jobs do
         SuperSpreader::SchedulerJob.perform_now
       end

     NameError:
       uninitialized constant ActiveSupport::Testing::Assertions::Minitest
     # ./spec/integration/backfill_spec.rb:50:in `block (3 levels) in <top (required)>'
     # ./spec/support/log_spec_helper.rb:11:in `capture_log'
     # ./spec/integration/backfill_spec.rb:49:in `block (2 levels) in <top (required)>'
     # ./spec/spec_helper.rb:62:in `block (2 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `assert' for #<RSpec::ExampleGroups::Integration "can backfill using an example job" (./spec/integration/backfill_spec.rb:11)>
     #   ./spec/integration/backfill_spec.rb:50:in `block (3 levels) in <top (required)>'

  2) Integration can backfill using a manually-set initial_id
     Failure/Error:
       perform_enqueued_jobs do
         SuperSpreader::SchedulerJob.perform_now
       end

     NameError:
       uninitialized constant ActiveSupport::Testing::Assertions::Minitest
     # ./spec/integration/backfill_spec.rb:101:in `block (2 levels) in <top (required)>'
     # ./spec/spec_helper.rb:62:in `block (2 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `assert' for #<RSpec::ExampleGroups::Integration "can backfill using a manually-set initial_id" (./spec/integration/backfill_spec.rb:64)>
     #   ./spec/integration/backfill_spec.rb:101:in `block (2 levels) in <top (required)>'

It appears that Minitest may have been a "soft" dependency of ActiveJob::TestHelper or ActiveSupport::Testing::Assertions, as assert is referred to but never defined. Manually requiring minitest and adding config.include Minitest::Assertions partially resolves the error, but causes another:

  1) Integration can backfill using an example job
     Failure/Error:
       perform_enqueued_jobs do
         SuperSpreader::SchedulerJob.perform_now
       end

     NameError:
       undefined local variable or method `tagged_logger' for #<RSpec::ExampleGroups::Integration "can backfill using an example job" (./spec/integr
ation/backfill_spec.rb:11)>
     # ./spec/integration/backfill_spec.rb:50:in `block (3 levels) in <top (required)>'
     # ./spec/support/log_spec_helper.rb:11:in `capture_log'
     # ./spec/integration/backfill_spec.rb:49:in `block (2 levels) in <top (required)>'
     # ./spec/spec_helper.rb:63:in `block (2 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `assert' for #<RSpec::ExampleGroups::Integration "can backfill using an example job" (./spec/integration/backfill_spec.rb:11)>
     #   ./spec/integration/backfill_spec.rb:50:in `block (3 levels) in <top (required)>'

  2) Integration can backfill using a manually-set initial_id
     Failure/Error:
       perform_enqueued_jobs do
         SuperSpreader::SchedulerJob.perform_now
       end

     NameError:
       undefined local variable or method `tagged_logger' for #<RSpec::ExampleGroups::Integration "can backfill using a manually-set initial_id" (./
spec/integration/backfill_spec.rb:64)>
     # ./spec/integration/backfill_spec.rb:101:in `block (2 levels) in <top (required)>'
     # ./spec/spec_helper.rb:63:in `block (2 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `assert' for #<RSpec::ExampleGroups::Integration "can backfill using a manually-set initial_id" (./spec/integration/backfill_spec.rb:64)>
     #   ./spec/integration/backfill_spec.rb:101:in `block (2 levels) in <top (required)>'

I manually defined a tagged_logger:

def tagged_logger
  fake_log_device = StringIO.new

  ActiveSupport::TaggedLogging.new(Logger.new(fake_log_device))
end

...but that revealed even more errors:

  1) Integration can backfill using an example job
     Failure/Error:
       perform_enqueued_jobs do
         SuperSpreader::SchedulerJob.perform_now
       end

       `name` is not available from within an example (e.g. an `it` block) or from constructs that run in the scope of an example (e.g. `before`, `l
et`, etc). It is only available on an example group (e.g. a `describe` or `context` block).
     # ./spec/integration/backfill_spec.rb:50:in `block (3 levels) in <top (required)>'
     # ./spec/support/log_spec_helper.rb:11:in `capture_log'
     # ./spec/integration/backfill_spec.rb:49:in `block (2 levels) in <top (required)>'
     # ./spec/spec_helper.rb:63:in `block (2 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `assert' for #<RSpec::ExampleGroups::Integration "can backfill using an example job" (./spec/integration/backfill_spec.rb:11)>
     #   ./spec/integration/backfill_spec.rb:50:in `block (3 levels) in <top (required)>'

  2) Integration can backfill using a manually-set initial_id
     Failure/Error:
       perform_enqueued_jobs do
         SuperSpreader::SchedulerJob.perform_now
       end

       `name` is not available from within an example (e.g. an `it` block) or from constructs that run in the scope of an example (e.g. `before`, `l
et`, etc). It is only available on an example group (e.g. a `describe` or `context` block).
     # ./spec/integration/backfill_spec.rb:101:in `block (2 levels) in <top (required)>'
     # ./spec/spec_helper.rb:63:in `block (2 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `assert' for #<RSpec::ExampleGroups::Integration "can backfill using a manually-set initial_id" (./spec/integration/backfill_spec.rb:64)>
     #   ./spec/integration/backfill_spec.rb:101:in `block (2 levels) in <top (required)>'

I stopped and instead manually defined assert:

  def assert(boolean)
    raise unless boolean
  end

This caused the specs to pass, which resolved my concern about Rails 7.x support. However, it doesn't explain the root cause, so I opted to force Rails 6.x in fe9ffa5.

See also

Related to: #17