Auto-detect SolidQueue

[karlentwistle]

Issue

#237

Description of changes

Adds SolidQueue as an auto-detected framework.

Reading through the Solid Queue docs it says:

Solid Queue's supervisor will fork a separate process for each supervised worker/dispatcher/scheduler.

~ https://github.com/rails/solid_queue?tab=readme-ov-file#workers-dispatchers-and-scheduler

It also offers four hooks

SolidQueue.on_start
SolidQueue.on_stop

SolidQueue.on_worker_start
SolidQueue.on_worker_stop

~ https://github.com/rails/solid_queue?tab=readme-ov-file#lifecycle-hooks

So I found that by adding

# config/initializers/solid_queue.rb

SolidQueue.on_worker_start do
  # Re-open appenders after forking the process
  SemanticLogger.reopen
end

The logs started to appear in STDOUT.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[MiroslavCsonka]

Thanks for opening this! It solved our week-long issue on Heroku. I can stop spamming their support. I hope it will get merged soon for others to save a bunch of time.

[hms]

@karlentwistle @MiroslavCsonka

The latest releases of SolidQueue have an #on_start for the dispatcher and scheduler. This PR needs to add a SemanticLogger.reopen for the 2 new on_start blocks.

Also, if interesting, I'm doing this in my #on_start blocks:
Rails.logger.name = "#{Rails.application.name}::Supervisor"
Rails.logger.name = "#{Rails.application.name}::Worker"
...
...

[karlentwistle]

@hms Thanks, and sorry for the delay! I've updated the PR based on your comment.

I didn’t include the following lines:

Rails.logger.name = "#{Rails.application.name}::Supervisor"
Rails.logger.name = "#{Rails.application.name}::Worker"

Since I didn’t see any existing precedent for this in lib/rails_semantic_logger/engine.rb. That said, it’s useful to know about, and I’ll add it to my own app via an initializer.

If a maintainer could let me know if you'd like me to include it in this PR, I can add it. It seems like a sensible default to me.

[hms]

@karlentwistle

Since your PR and my comment, solid_queue now has on_start blocks for the supervisor and scheduler. I believe you need to update the PR to add a reopen there too.

hms

[karlentwistle]

@hms I saw you got rails/solid_queue#486 merged - nice! Do you mean something beyond

# Re-open appenders after SolidQueue worker/dispatcher/scheduler has finished booting
SolidQueue.on_worker_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_worker_start)
SolidQueue.on_dispatcher_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_dispatcher_start)
SolidQueue.on_scheduler_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_scheduler_start)

It seems like the supervisor would be

SolidQueue.on_start { ::SemanticLogger.reopen } if defined?(SolidQueue.on_start)

[chadxz]

Hi all! Would love to see this land. Is there anything remaining that is blocking it? I can help if needed.

[karlentwistle]

@chadxz, as far as I am aware, this is ready to go. Awaiting a maintainer to hopefully merge it.

[chadxz]

Hi @reidmorrison, thank you for merging! Is there anything blocking the release of a new version we might be able to help with?

[reidmorrison]

Was waiting for one more PR, that is merged now. V4.18.0 is now published.