good_job 1.13.2 → 1.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef04aa133c3e3f39b4e5967f61441617808d51a8d13b79e9f4e61a89c3da0c63
-  data.tar.gz: a5abe5ff64d1c7abb197b78f0aa7812834b9034fb0340dbb8abb6d2a42912af9
+  metadata.gz: fe59c2b49eaef9a76ecbf1af80c6ea765fb89a5d61f01b0436595e15e377019e
+  data.tar.gz: 15c0ee082903f8316de7656e855489492a00e90b3e75e55475f59824b49c0542
 SHA512:
-  metadata.gz: 6effeb75fd0d5a0541f4be984e6a0931fba2d6849b1d5061941276b5ee977b3620ce13b2328b64fdd27b1d66ab1753087aed612d7c301b7a100fc709a3740697
-  data.tar.gz: 4694a54a3f1dffd84e4875fc7169e49f6edff3baa92fc458720939738b3db6b6f907883601c480fd4aa1d64549b7a1a0352b3c2481df1ae67057685efa9414a6
+  metadata.gz: 22c7de0952050994cb220cda916ce85187775d2b79692b8ee094a0e6e76f84945ad528327fc3e83e50263e46272094949d2d6270a0332c19e8f79fb0841e0d80
+  data.tar.gz: '0229a23385ed171a50a39d54ab5295a5147110d203e84518643caa49c2dab16eee16263b54c86245a376e946402e9d39d52f05c3cde6ba2906f8f32fd77046e0'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [v1.99.0](https://github.com/bensheldon/good_job/tree/v1.99.0) (2021-08-24)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v1.13.2...v1.99.0)
+
+**Closed issues:**
+
+- Set Advisory Lock on ActiveJob job uuid instead of GoodJob's job uuid [\#272](https://github.com/bensheldon/good_job/issues/272)
+
+**Merged pull requests:**
+
+- Add upgrade instructions for v1 to v2 [\#345](https://github.com/bensheldon/good_job/pull/345) ([bensheldon](https://github.com/bensheldon))
+- Add transitional/temporary additional lock on good\_jobs-\[active\_job\_id\] [\#336](https://github.com/bensheldon/good_job/pull/336) ([bensheldon](https://github.com/bensheldon))
+
 ## [v1.13.2](https://github.com/bensheldon/good_job/tree/v1.13.2) (2021-08-18)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.13.1...v1.13.2)

data/README.md

@@ -41,6 +41,8 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [ActiveJob concurrency](#activejob-concurrency)
     - [Cron-style repeating/recurring jobs](#cron-style-repeatingrecurring-jobs)
     - [Updating](#updating)
+        - [Upgrading minor versions](#upgrading-minor-versions)
+        - [Upgrading v1 to v2](#upgrading-v1-to-v2)
 - [Go deeper](#go-deeper)
     - [Exceptions, retries, and reliability](#exceptions-retries-and-reliability)
         - [Exceptions](#exceptions)
@@ -405,17 +407,45 @@ config.good_job.cron = {
 
 GoodJob follows semantic versioning, though updates may be encouraged through deprecation warnings in minor versions.
 
-To apply updates:
+#### Upgrading minor versions
 
-```bash
-bin/rails g good_job:update
-```
+Upgrading between minor versions (e.g. v1.4 to v1.5) should not introduce breaking changes, but can introduce new deprecation warnings and database migration notices.
 
-...and run the resulting migration:
+To perform upgrades to the GoodJob database tables:
 
-```bash
-bin/rails db:migrate
-```
+1. Generate new database migration files:
+
+    ```bash
+    bin/rails g good_job:update
+    ```
+
+1. Run the database migration locally
+
+    ```bash
+    bin/rails db:migrate
+    ```
+
+1. Commit the migration files and resulting `db/schema.rb` changes.
+1. Deploy the code, run the migrations against the production database, and restart server/worker processes.
+
+#### 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 likely44
+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.
+1. Address any deprecation warnings generated by `v1.99`.
+1. Upgrade your production environment to `v1.99.x` to `v2.0.x` again following the _minor_ upgrade process.
+
+Notable 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.
+- 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`.
 
 ## Go deeper
 

data/lib/good_job/job.rb

@@ -189,7 +189,13 @@ module GoodJob
         break if good_job.blank?
         break :unlocked unless good_job&.executable?
 
-        good_job.perform
+        begin
+          good_job.with_advisory_lock(key: "good_jobs-#{good_job.active_job_id}") do
+            good_job.perform
+          end
+        rescue RecordAlreadyAdvisoryLockedError => e
+          ExecutionResult.new(value: nil, handled_error: e)
+        end
       end
     end
 

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '1.13.2'
+  VERSION = '1.99.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 1.13.2
+  version: 1.99.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob