GoodJob v2.0.0

[bensheldon]

Changelog

GoodJob version 2.0 has been released. GoodJob v2.2.0 is backward-incompatible with previous versions of GoodJob, but can be easily upgraded through a transitionary v1.99 release.

Upgrading v1 to v2

GoodJob v2 introduces a new Advisory Lock key format that is different than the v1 advisory lock key format; it's therefore necessary to perform a simple, but staged production upgrade. If you are already using >= v1.12+ no other changes are necessary.

1. Upgrade your production environment to v1.99.x following the minor version upgrade process, including database migrations. v1.99 is a transitional release that is safely compatible with both v1.x and v2.0.0 because it uses both v1- and v2-formatted advisory locks.
2. Address any deprecation warnings generated by v1.99.
3. Upgrade your production environment to v1.99.x to v2.0.x again following the minor upgrade process.

New features

GoodJob 2.0 does not introduce any new features on its own. Since GoodJob v1.0 was released, notable improvements include:

• Web Dashboard: GoodJob includes a Dashboard as a mountable Rails::Engine. Job performance and errors can be inspected and visualized through the dashboard. (v1.5)
• Async execution mode: GoodJob can execute jobs "async" in the same process as the webserver (e.g. bin/rail s). GoodJob's async execution mode offers benefits of economy by not requiring a separate job worker process. (v1.1)
• ActiveJob concurrency controls: GoodJob can extend ActiveJob to provide limits on concurrently running jobs, either at time of enqueue or at perform. Limiting concurrency can help prevent duplicate, double or unnecessary jobs from being enqueued, or race conditions when performing, for example when interacting with 3rd-party APIs. (v1.11)
• Cron-style repeating/recurring jobs: GoodJob can enqueue jobs on a recurring basis that can be used as a replacement for cron. (v1.12)
• JRuby Support: GoodJob is compatible with and tested against both MRI Ruby and JRuby. (v1.4)
• Multi-Database Support: GoodJob can be configured to use multiple databases with ActiveRecord. (v1.9.1)
• Daemon support: GoodJob's CLI can run as a background daemon. (v1.6)

Major (incompatible) changes

• Renames :async_server execution mode to :async; renames prior :async execution mode to :async_all.
• Sets default Development environment's execution mode to :async with disabled polling.
• Excludes performing jobs from enqueue_limit's count in GoodJob::ActiveJobExtensions::Concurrency.
• Triggers GoodJob.on_thread_error for unhandled ActiveJob exceptions.
• Renames GoodJob.reperform_jobs_on_standard_error accessor to GoodJob.retry_on_unhandled_error.
• Renames GoodJob::Adapter.shutdown(wait:) argument to GoodJob::Adapter.shutdown(timeout:).
• Changes Advisory Lock key format from good_jobs[ROW_ID] to good_jobs-[ACTIVE_JOB_ID].
• Expects presence of columns good_jobs.active_job_id, good_jobs.concurrency_key, good_jobs.concurrency_key, and good_jobs.retried_good_job_id.

---

This discussion was created from the release v2.0.0.