"uninitialized constant GoodJob::Execution" in development env

[doits]

Trying to enqueue Rails' job in development mode:

TestJob.perform_later

... gives:

Failed enqueuing TestJob to GoodJob(default): NameError (uninitialized constant GoodJob::Execution

      execution = GoodJob::Execution.enqueue(
                         ^^^^^^^^^^^
Did you mean?  Exception)
/.../.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/good_job-2.17.0/lib/good_job/adapter.rb:72:in `enqueue_at': uninitialized constant GoodJob::Execution (NameError)

      execution = GoodJob::Execution.enqueue(
                         ^^^^^^^^^^^
Did you mean?  Exception

To fix it I can do a require 'good_job/execution'. Looks like autoloader does not catch it?

• Happens on GoodJob 2.17.
• 2.16.1 works fine.
• Production and Test env are not affected, seems like only development
• Rails 7.0.3
• Ruby 3.1.2

Can you reproduce it? I'll provide more details if you need them.

[bensheldon]

@doits thanks for being quick to upgrade to the new version, and flagging this. Let me try to reproduce on a new project and I'll get this fixed.

I'm going to assume that you haven't mounted the Dashboard? (that shouldn't be required, but I'm still learning about how Engines and autoloading work apparently)

[doits]

Thanks for you quick help! If you cannot reproduce it, please ping me, so I can try my best to do so on a minimal app.

I'm going to assume that you haven't mounted the Dashboard?

That is correct.

[bensheldon]

I'm not able to (easily) reproduce it.

rails new repro_app \
  -d postgresql \
  --no-assets \
  --skip-action-text \
  --skip-action-mailer \
  --skip-action-mailbox \
  --skip-action-cable \
  --skip-sprockets \
  --skip-listen \
  --skip-javascript \
  --skip-turbolinks \
  --skip-system-test \
  --skip-test-unit \
  --skip-bootsnap \
  --skip-spring \
  --skip-active-storage

bundle add good_job

bin/rails db:create

bin/rails g good_job:install

bin/rails db:migrate

and then edit config/application.rb to add config.active_job.queue_adapter = :good_job.

I'm successfully able to run bin/rails s and see GoodJob make successful database queries with GoodJob::Execution.

😬

[bensheldon]

If I try running bin/rails runner 'pp ActiveSupport::Dependencies.autoload_paths' (via https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoloading-and-engines) , I see the engine/models directory (where GoodJob::Execution is defined as of GoodJob v2.17) is under autoload paths:

❯ bin/rails runner 'pp ActiveSupport::Dependencies.autoload_paths'
["/Users/bensheldon/Repositories/tmp/demo_engine/app/controllers",
 "/Users/bensheldon/Repositories/tmp/demo_engine/app/controllers/concerns",
 "/Users/bensheldon/Repositories/tmp/demo_engine/app/helpers",
 "/Users/bensheldon/Repositories/tmp/demo_engine/app/jobs",
 "/Users/bensheldon/Repositories/tmp/demo_engine/app/models",
 "/Users/bensheldon/Repositories/tmp/demo_engine/app/models/concerns",
 "/Users/bensheldon/.rbenv/versions/2.7.5/lib/ruby/gems/2.7.0/gems/good_job-2.17.0/app/charts",
 "/Users/bensheldon/.rbenv/versions/2.7.5/lib/ruby/gems/2.7.0/gems/good_job-2.17.0/app/controllers",
 "/Users/bensheldon/.rbenv/versions/2.7.5/lib/ruby/gems/2.7.0/gems/good_job-2.17.0/app/filters",
 "/Users/bensheldon/.rbenv/versions/2.7.5/lib/ruby/gems/2.7.0/gems/good_job-2.17.0/app/helpers",
 "/Users/bensheldon/.rbenv/versions/2.7.5/lib/ruby/gems/2.7.0/gems/good_job-2.17.0/app/models"]

[dillonhafer]

This happened to me when I removed the engine require, I restored the require to get my rspec suite working again on 2.17

EDIT: To clarify, removing the require engine statement broke my test environment

[doits]

For me it seems to be the gem stringex.

@bensheldon can you reproduce it in your test app after bundle add stringex?

[bensheldon]

@doits oh yep, adding stringex gem does it ❓❗

Thank you for tracking that down! Now just to figure out why and patch the problem asap.

[doits]

Glad you could reproduce it!

Not sure who is to blame though, maybe stringex messes up the autoloader (at least it monkey patches String, so who knows ...)

[bensheldon]

@dillonhafer nuts! Sorry about the trouble. Hmmm, I'll have to do some research into why you'd need to add that require into your test suite. GoodJob does an explicit require of good_job/engine itself:

good_job/lib/good_job.rb

Line 15 in ae3a93f

require "good_job/engine"

[redareda9]

Same problem here.
And it's random.
The first execution of the JOB works perfectly. Then, a few executions later, it suddenly stops working and gives me the Uninitialized constant, which is really weird/unpredictable and hard to reproduce.

[bensheldon]

I think I have a fix in #635:

My hypothesis is that when the model files are in gem app they are managed by Rails's autoloader, which is lazy-loaded, but the model files are sometimes referenced from gem lib which is eager-loaded, and that inconsistency causes pain.

Once tests pass on that PR, I'll merge and release.

[bensheldon]

I've released https://github.com/bensheldon/good_job/releases/tag/v2.17.1 which I hope fixes this. Please confirm 🙏🏻

[doits]

Fixed it for me 👍