workhorse 2.0.0.rc1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d0f28bfeb67292f3de373115ada4ef7c2cff27b29e847af29326733ba89841
-  data.tar.gz: f69f1d82c2c9c15f47f87d8f8390c31e655596636383b9cadefc8c240d8f43b6
+  metadata.gz: 617b6616890ea3437b817a10d0c1f16438dae9c221a2bc53203793a92417a1ea
+  data.tar.gz: 75e040bf7b18a294f435d263087ece37cf9245d2486709681efbdada1c47a76e
 SHA512:
-  metadata.gz: 00c490f9e4aa2b57066b8b974e38286509cb156cb27f79dc7d7a355c9797338eaa8dcf33a5dc9c07e2f3bbe37878d0be5e82b7f098da9e45194ad0fe5b064d6f
-  data.tar.gz: e0116907c47ae31d9fa5a5626e331a503286667966aa974255e8d9f816c363fe3a9e55406e5f79c9a3da7e82abe4b0648b505de3e279992a58e1864d847edaef
+  metadata.gz: 4f31d1f201019cda0ada3c1b0757c9e447d66f0db8b90e63bb8337d8b7e5414ef5d3ccbdd0ad081cd7a09145e9607c336cf51f9e946b7d606f0dfea08e559f1e
+  data.tar.gz: b306401d8a79d1481c595c924126b3cbe2e537691efefc0a69b7e16cc4eed2585fb36e267ab792d5ebadddede47ce0dd04c47c7be62312f9b968f55d183c2130

data/CHANGELOG.md

@@ -1,65 +1,22 @@
 # Workhorse Changelog
 
-## 2.0.0.rc1 - 2026-09-30
-
-Sitrox reference: #154443.
+## 2.0.1 - 2026-10-28
 
 ### Added
 
-* Oracle 12c or later is supported again, and is now covered by CI against
-  `activerecord-oracle_enhanced-adapter` rather than only by hand. The global
-  lock uses `DBMS_LOCK`, and the generated migrations leave out the index
-  prefix lengths Oracle rejects while naming every index within the 30
-  characters it allows before 12.2. See
-  [Database support](README.md#database-support).
+* `Workhorse::Performer#db_job`: inside a job, `Workhorse.performer.db_job`
+  returns the job's own `Workhorse::DbJob`. This lets a job link something to
+  its record that outlives the job, for example a progress display that has to
+  end when the worker cleans up after a killed worker.
 
-  2.0.0.rc0 dropped Oracle; anyone who took that release up and needs it can
-  move straight to this one. Grant the schema execute permission on
-  `DBMS_LOCK`, as described under Database support.
-
-### Fixed
-
-* On Oracle, jobs are picked up in priority order. 1.x limited the rows it
-  selected by filtering on `ROWNUM`, which Oracle numbers before sorting, so
-  both the job taken from each queue and the jobs a poll picked up were an
-  arbitrary subset regardless of `priority`. Limiting now uses
-  `FETCH FIRST … ROWS ONLY`, which applies after the sort and is why 12c is
-  now the minimum.
-
-* A poll that finds the global lock taken now waits for it with a polling
-  interval below half a second. The lock timeout follows the interval, and
-  MySQL and Oracle take it as whole seconds, so they rounded it down to not
-  waiting at all - only MariaDB honours a fraction. Each such poll gave up
-  at once and counted towards `Workhorse.max_global_lock_fails`, so several
-  workers contending for the lock could trigger its alarm about a crashed
-  worker. The timeout is now rounded up to whole seconds.
-
-* A soft restart (`USR1`) no longer wedges a worker whose `tmp/pids` does not
-  exist yet, as on a fresh checkout or deployment. The worker touched its
-  shutdown file there after it had stopped accepting jobs, so failing on it
-  left a worker that took no jobs and never exited. The directory is now
-  created when missing, and a shutdown file that still cannot be written no
-  longer holds up the shutdown. The heartbeat and the memory-limit shutdown,
-  which write to the same directory, create it as well.
-
-* `Workhorse.clean_stuck_jobs` works on Oracle. It is built on splitting
-  `locked_by` into host, PID and random component, which was written with
-  MySQL's `substring_index` and so raised on Oracle for as long as the option
-  has existed — visible only to an installation that turned it on, as it is
-  off by default.
-
-## 2.0.0.rc0 - 2026-09-29
+## 2.0.0 - 2026-10-14
 
 Sitrox reference: #154443.
 
 ### Breaking changes
 
-* **Support for Oracle is dropped.** Workhorse supports MySQL and MariaDB
-  only. The Oracle branches of the global lock, the row limiting and the
-  generated migrations are gone, along with
-  `Workhorse::Poller::ORACLE_LOCK_MODE` and `ORACLE_LOCK_HANDLE`. It was never
-  covered by CI, so it only ever had manual verification. An Oracle
-  installation has no upgrade path and should stay on 1.x. See
+* Oracle 12c is the minimum, as job selection now limits its rows with
+  `FETCH FIRST … ROWS ONLY` (see the priority fix below). See
   [Database support](README.md#database-support).
 
 * A forked daemon worker no longer runs the `at_exit` handlers registered by
@@ -108,7 +65,9 @@ Sitrox reference: #154443.
 * The composite indexes `[state, perform_at]`, `[state, priority, created_at]`
   and `[state, expires_at]` in the generated `jobs` migration, replacing the
   single-column index on `state`. `rails generate workhorse:install` now emits
-  two migrations rather than one.
+  two migrations rather than one. On Oracle, the generated migrations leave
+  out the index prefix lengths Oracle rejects and name every index within the
+  30 characters it allows before 12.2.
 
 * `fugit` as a runtime dependency, for parsing cron expressions.
 
@@ -127,8 +86,40 @@ Sitrox reference: #154443.
 
 * `Workhorse::DbJob#reset!` accepts `expired` as the terminal state it is.
 
+* Oracle is covered by CI against `activerecord-oracle_enhanced-adapter`
+  rather than only by hand.
+
 ### Fixed
 
+* On Oracle, jobs are picked up in priority order. 1.x limited the rows it
+  selected by filtering on `ROWNUM`, which Oracle numbers before sorting, so
+  both the job taken from each queue and the jobs a poll picked up were an
+  arbitrary subset regardless of `priority`. Limiting now uses
+  `FETCH FIRST … ROWS ONLY`, which applies after the sort and is why 12c is
+  now the minimum.
+
+* A poll that finds the global lock taken now waits for it with a polling
+  interval below half a second. The lock timeout follows the interval, and
+  MySQL and Oracle take it as whole seconds, so they rounded it down to not
+  waiting at all - only MariaDB honours a fraction. Each such poll gave up
+  at once and counted towards `Workhorse.max_global_lock_fails`, so several
+  workers contending for the lock could trigger its alarm about a crashed
+  worker. The timeout is now rounded up to whole seconds.
+
+* A soft restart (`USR1`) no longer wedges a worker whose `tmp/pids` does not
+  exist yet, as on a fresh checkout or deployment. The worker touched its
+  shutdown file there after it had stopped accepting jobs, so failing on it
+  left a worker that took no jobs and never exited. The directory is now
+  created when missing, and a shutdown file that still cannot be written no
+  longer holds up the shutdown. The heartbeat and the memory-limit shutdown,
+  which write to the same directory, create it as well.
+
+* `Workhorse.clean_stuck_jobs` works on Oracle. It is built on splitting
+  `locked_by` into host, PID and random component, which was written with
+  MySQL's `substring_index` and so raised on Oracle for as long as the option
+  has existed — visible only to an installation that turned it on, as it is
+  off by default.
+
 * A deadlock between shutting a worker down and the poller posting a job.
   `Worker#shutdown` held the worker's mutex while waiting for the poller
   thread, which could be waiting for that same mutex in `Worker#perform`. The

data/VERSION

@@ -1 +1 @@
-2.0.0.rc1
+2.0.1

data/lib/workhorse/performer.rb

@@ -10,6 +10,13 @@ module Workhorse
     # @return [Workhorse::Worker] The worker that owns this performer
     attr_reader :worker
 
+    # The job this performer performs. Inside a job, {Workhorse.performer}
+    # gives a job its own database record, e.g. to link something to it that
+    # outlives the job.
+    #
+    # @return [Workhorse::DbJob]
+    attr_reader :db_job
+
     # Creates a new performer for a specific job.
     #
     # @param db_job_id [Integer] The ID of the {Workhorse::DbJob} to perform

data/test/workhorse/performer_test.rb

@@ -30,6 +30,21 @@ class Workhorse::PerformerTest < WorkhorseTest
     work_until(pool_size: 5, polling_interval: 0.2) { assert_equal 'failed', Workhorse::DbJob.first.state }
   end
 
+  class OwnDbJobJob
+    class_attribute :db_job_id
+
+    def perform
+      self.class.db_job_id = Workhorse.performer.db_job.id
+    end
+  end
+
+  def test_a_job_finds_its_own_db_job
+    db_job = Workhorse.enqueue OwnDbJobJob.new
+    work_until(pool_size: 1, polling_interval: 0.2) { assert_equal 'succeeded', db_job.reload.state }
+
+    assert_equal db_job.id, OwnDbJobJob.db_job_id
+  end
+
   def test_on_exception
     old_callback = Workhorse.on_exception
     exception = nil

data/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 2.0.0.rc1 ruby lib
+# stub: workhorse 2.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "2.0.0.rc1".freeze
+  s.version = "2.0.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2026-09-30"
+  s.date = "2026-10-28"
   s.files = [".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/generators/workhorse/templates/create_table_workhorse_schedules.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/active_job_extension.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/detect_late_schedules_job.rb".freeze, "lib/workhorse/jobs/detect_stale_jobs_job.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/notifiers/base.rb".freeze, "lib/workhorse/notifiers/file_system.rb".freeze, "lib/workhorse/notifiers/none.rb".freeze, "lib/workhorse/notifiers/redis.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/schedule.rb".freeze, "lib/workhorse/schedules.rb".freeze, "lib/workhorse/scoped_env.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/daemon_test.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/notifier_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/schedule_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "test/workhorse/yjit_test.rb".freeze, "workhorse.gemspec".freeze]
   s.homepage = "https://github.com/sitrox/workhorse".freeze
   s.licenses = ["MIT".freeze]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.1
 platform: ruby
 authors:
 - Sitrox
 bindir: bin
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.15
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files: