que 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd68dcc8f19097468e664cdd7a3777b9d1ce8b431fdb3a42a08ffcb75723f559
-  data.tar.gz: e0191191fe9b64c436173a3f956b4d06b18c131f3de1bbbd71f5966b363db168
+  metadata.gz: 382e70b455239bf58eda4d83e5772400b55055f98857d2b83fdfc7f36f26d856
+  data.tar.gz: dfad699d5bb996c965e3216de224fc9248a3cb2be70cce04f8407ed9b5ee0651
 SHA512:
-  metadata.gz: 37fd03216218cea290a92ecc3961aede25b5e5ed9a11d30dd2fd6ae8bd3b22c6f0a021f947f068836e00c28e1c75d3168330eec2169bf7fa394e3da40dd1a38f
-  data.tar.gz: 16fe7c2452eff1b240854acba12227dc1f061bf9b7ab756656358886327a8ea6a48eea26e2b97c4376acfcdda5dc89ec10fa24341bfc03da49b043e4be07b748
+  metadata.gz: d1c34fc4b2ff8ce02b9b70f8fe9e9d361c8e4e701e36987690464a5f62263905e29453c9dbcb65bce9bda19d511d1430b1e235f1ad8e86cbd1e136e189e71015
+  data.tar.gz: 9cb2182726f813fb53c3cb6f2a41dc4bb482810448673a8f8e704860db119e1ad44a64613f3d688df1085f0686ff51ea74a0d1b46bc7353d79d81945cf3555e8

data/CHANGELOG.md

@@ -1,4 +1,50 @@
+### 1.3.0 (2022-02-25)
+
+**ACTION REQUIRED**
+
+This release will allow you to safely upgrade to Que 2 when it comes out, without first needing to empty your `que_jobs` table.
+
+**You will need to first update to this version, apply the Que schema migration, and deploy, before you can safely begin the process of upgrading to Que 2.**
+
+Que 2 will bring Ruby 3 support, but to do that, the job arguments in the `que_jobs` table will need to be split into two columns - repurposing the existing one for positional arguments only (`args`), and adding a new one for keyword arguments (`kwargs`). This is so that Que running in Ruby 3, when reading job arguments stored in the database, can disambiguate between keyword arguments and a last positional argument hash.
+
+The args split hasn't happened yet, but when it does, we still need to be able to successfully process all the existing queued jobs which have their keyword arguments in the `args` column still. Our solution is for you to have both Que 1 workers and Que 2 workers operating simultaneously during the upgrade, each processing only the jobs enqueued from that version. Once all the Que 1 jobs are processed, the Que 1 workers can be retired.
+
+To allow the different worker versions to tell which jobs belong to which, we've added a new column to the `que_jobs` table in this version, `job_schema_version`. Jobs enqueued with Que 1 will have a `1` here, and jobs from Que 2 will have a `2`. Que schema migration 5 will default the job schema version of all existing jobs to `1`.
+
+You will need to migrate Que to the latest Que schema version (5). For instance, on ActiveRecord and Rails 6:
+
+```ruby
+class UpdateQueTablesToVersion5 < ActiveRecord::Migration[6.0]
+  def up
+    Que.migrate!(version: 5)
+  end
+  def down
+    Que.migrate!(version: 4)
+  end
+end
+```
+
+You must apply the schema migration and deploy to upgrade all workers.
+
+No further action is required from you at this stage. The Que 2 release changelog will provide full upgrade instructions for the process briefly described above of simultaneously running both Que 1 & 2 workers. Note that you won't be required to upgrade from Ruby 2.7 to Ruby 3 at the same time as upgrading to Que 2.
+
+If you use any Que plugins or custom code that interacts with the `que_jobs` table, before you can upgrade to Que 2, you will need to make sure they are updated for compatibility with Que 2: They'll need to make use of the `kwargs` column, and when inserting jobs, put the result of `Que.job_schema_version` into the `job_schema_version` column rather than continue to rely on its default of `1`.
+
+### 1.2.0 (2022-02-23)
+
+- **Deprecated**
+    + Providing job options as top level keyword arguments to Job.enqueue is now deprecated. Support will be dropped in `2.0`. Job options should be nested under the `job_options` keyword arg instead. See [#336](https://github.com/que-rb/que/pull/336)
+
+### 1.1.0 (2022-02-21)
+
+- **Features**:
+    + Add backtrace to errors, by [@trammel](https://github.com/trammel) in [#328](https://github.com/que-rb/que/pull/328)
+- **Internal**:
+    + Add Dockerised development environment, in [#324](https://github.com/que-rb/que/pull/324)
+
 ### 1.0.0 (2022-01-24)
+
 _This release does not add any changes on top of 1.0.0.beta5._
 
 ### 1.0.0.beta5 (2021-12-23)

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.7.5-slim-buster@sha256:4cbbe2fba099026b243200aa8663f56476950cc64ccd91d7aaccddca31e445b5 AS base
+
+# Install libpq-dev in our base layer, as it's needed in all environments
+RUN apt-get update \
+  && apt-get install -y libpq-dev \
+  && rm -rf /var/lib/apt/lists/*
+
+ENV RUBY_BUNDLER_VERSION 2.3.7
+RUN gem install bundler -v $RUBY_BUNDLER_VERSION
+
+ENV BUNDLE_PATH /usr/local/bundle
+
+ENV RUBYOPT=-W:deprecated
+
+FROM base AS dev-environment
+
+# Install build-essential and git, as we'd need them for building gems that have native code components
+RUN apt-get update \
+  && apt-get install -y build-essential git \
+  && rm -rf /var/lib/apt/lists/*

data/README.md

@@ -6,55 +6,60 @@
 
 Que ("keɪ", or "kay") is a queue for Ruby and PostgreSQL that manages jobs using [advisory locks](http://www.postgresql.org/docs/current/static/explicit-locking.html#ADVISORY-LOCKS), which gives it several advantages over other RDBMS-backed queues:
 
-  * **Concurrency** - Workers don't block each other when trying to lock jobs, as often occurs with "SELECT FOR UPDATE"-style locking. This allows for very high throughput with a large number of workers.
-  * **Efficiency** - Locks are held in memory, so locking a job doesn't incur a disk write. These first two points are what limit performance with other queues. Under heavy load, Que's bottleneck is CPU, not I/O.
-  * **Safety** - If a Ruby process dies, the jobs it's working won't be lost, or left in a locked or ambiguous state - they immediately become available for any other worker to pick up.
+- **Concurrency** - Workers don't block each other when trying to lock jobs, as often occurs with "SELECT FOR UPDATE"-style locking. This allows for very high throughput with a large number of workers.
+- **Efficiency** - Locks are held in memory, so locking a job doesn't incur a disk write. These first two points are what limit performance with other queues. Under heavy load, Que's bottleneck is CPU, not I/O.
+- **Safety** - If a Ruby process dies, the jobs it's working won't be lost, or left in a locked or ambiguous state - they immediately become available for any other worker to pick up.
 
 Additionally, there are the general benefits of storing jobs in Postgres, alongside the rest of your data, rather than in Redis or a dedicated queue:
 
-  * **Transactional Control** - Queue a job along with other changes to your database, and it'll commit or rollback with everything else. If you're using ActiveRecord or Sequel, Que can piggyback on their connections, so setup is simple and jobs are protected by the transactions you're already using.
-  * **Atomic Backups** - Your jobs and data can be backed up together and restored as a snapshot. If your jobs relate to your data (and they usually do), there's no risk of jobs falling through the cracks during a recovery.
-  * **Fewer Dependencies** - If you're already using Postgres (and you probably should be), a separate queue is another moving part that can break.
-  * **Security** - Postgres' support for SSL connections keeps your data safe in transport, for added protection when you're running workers on cloud platforms that you can't completely control.
+- **Transactional Control** - Queue a job along with other changes to your database, and it'll commit or rollback with everything else. If you're using ActiveRecord or Sequel, Que can piggyback on their connections, so setup is simple and jobs are protected by the transactions you're already using.
+- **Atomic Backups** - Your jobs and data can be backed up together and restored as a snapshot. If your jobs relate to your data (and they usually do), there's no risk of jobs falling through the cracks during a recovery.
+- **Fewer Dependencies** - If you're already using Postgres (and you probably should be), a separate queue is another moving part that can break.
+- **Security** - Postgres' support for SSL connections keeps your data safe in transport, for added protection when you're running workers on cloud platforms that you can't completely control.
 
 Que's primary goal is reliability. You should be able to leave your application running indefinitely without worrying about jobs being lost due to a lack of transactional support, or left in limbo due to a crashing process. Que does everything it can to ensure that jobs you queue are performed exactly once (though the occasional repetition of a job can be impossible to avoid - see the docs on [how to write a reliable job](/docs/README.md#writing-reliable-jobs)).
 
 Que's secondary goal is performance. The worker process is multithreaded, so that a single process can run many jobs simultaneously.
 
 Compatibility:
+
 - MRI Ruby 2.2+
 - PostgreSQL 9.5+
 - Rails 4.1+ (optional)
 
 **Please note** - Que's job table undergoes a lot of churn when it is under high load, and like any heavily-written table, is susceptible to bloat and slowness if Postgres isn't able to clean it up. The most common cause of this is long-running transactions, so it's recommended to try to keep all transactions against the database housing Que's job table as short as possible. This is good advice to remember for any high-activity database, but bears emphasizing when using tables that undergo a lot of writes.
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'que'
+```ruby
+gem 'que'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install que
-
+```bash
+gem install que
+```
 
 ## Usage
 
 First, create the queue schema in a migration. For example:
 
-``` ruby
+```ruby
 class CreateQueSchema < ActiveRecord::Migration[5.0]
   def up
     # Whenever you use Que in a migration, always specify the version you're
     # migrating to. If you're unsure what the current version is, check the
     # changelog.
-    Que.migrate!(version: 4)
+    Que.migrate!(version: 5)
   end
 
   def down
@@ -66,7 +71,7 @@ end
 
 Create a class for each type of job you want to run:
 
-``` ruby
+```ruby
 # app/jobs/charge_credit_card.rb
 class ChargeCreditCard < Que::Job
   # Default settings for this job. These are optional - without them, jobs
@@ -101,7 +106,7 @@ end
 
 Queue your job. Again, it's best to do this in a transaction with other changes you're making. Also note that any arguments you pass will be serialized to JSON and back again, so stick to simple types (strings, integers, floats, hashes, and arrays).
 
-``` ruby
+```ruby
 CreditCard.transaction do
   # Persist credit card information
   card = CreditCard.create(params[:credit_card])
@@ -111,17 +116,18 @@ end
 
 You can also add options to run the job after a specific time, or with a specific priority:
 
-``` ruby
+```ruby
 ChargeCreditCard.enqueue card.id, user_id: current_user.id, run_at: 1.day.from_now, priority: 5
 ```
 ## Running the Que Worker
 In order to process jobs, you must start a separate worker process outside of your main server. 
 
-```
+```bash
 bundle exec que
 ```
 
 Try running `que -h` to get a list of runtime options:
+
 ```
 $ que -h
 usage: que [options] [file/to/require] ...
@@ -138,21 +144,24 @@ If you're using ActiveRecord to dump your database's schema, please [set your sc
 
 Pre-1.0, the default queue name needed to be configured in order for Que to work out of the box with Rails. In 1.0 the default queue name is now 'default', as Rails expects, but when Rails enqueues some types of jobs it may try to use another queue name that isn't worked by default. You can either:
 
-* [Configure Rails](https://guides.rubyonrails.org/configuring.html) to send all internal job types to the 'default' queue by adding the following to `config/application.rb`:
-```ruby
-config.action_mailer.deliver_later_queue_name = :default
-config.action_mailbox.queues.incineration = :default
-config.action_mailbox.queues.routing = :default
-config.active_storage.queues.analysis = :default
-config.active_storage.queues.purge = :default
-```
+- [Configure Rails](https://guides.rubyonrails.org/configuring.html) to send all internal job types to the 'default' queue by adding the following to `config/application.rb`:
 
-* [Tell que](/docs#multiple-queues) to work all of these queues (less efficient because it requires polling all of them):
-```
-que -q default -q mailers -q action_mailbox_incineration -q action_mailbox_routing -q active_storage_analysis -q active_storage_purge
-```
+    ```ruby
+    config.action_mailer.deliver_later_queue_name = :default
+    config.action_mailbox.queues.incineration = :default
+    config.action_mailbox.queues.routing = :default
+    config.active_storage.queues.analysis = :default
+    config.active_storage.queues.purge = :default
+    ```
+
+- [Tell que](/docs#multiple-queues) to work all of these queues (less efficient because it requires polling all of them):
+
+    ```bash
+    que -q default -q mailers -q action_mailbox_incineration -q action_mailbox_routing -q active_storage_analysis -q active_storage_purge
+    ```
 
 Also, if you would like to integrate Que with Active Job, you can do it by setting the adapter in `config/application.rb` or in a specific environment by setting it in `config/environments/production.rb`, for example:
+
 ```ruby
 config.active_job.queue_adapter = :que
 ```
@@ -183,9 +192,9 @@ If you have a project that uses or relates to Que, feel free to submit a PR addi
 
 ## Community and Contributing
 
-  * For bugs in the library, please feel free to [open an issue](https://github.com/que-rb/que/issues/new).
-  * For general discussion and questions/concerns that don't relate to obvious bugs, join our [Discord Server](https://discord.gg/B3EW32H).
-  * For contributions, pull requests submitted via Github are welcome.
+- For bugs in the library, please feel free to [open an issue](https://github.com/que-rb/que/issues/new).
+- For general discussion and questions/concerns that don't relate to obvious bugs, join our [Discord Server](https://discord.gg/B3EW32H).
+- For contributions, pull requests submitted via Github are welcome.
 
 Regarding contributions, one of the project's priorities is to keep Que as simple, lightweight and dependency-free as possible, and pull requests that change too much or wouldn't be useful to the majority of Que's users have a good chance of being rejected. If you're thinking of submitting a pull request that adds a new feature, consider starting a discussion in [que-talk](https://groups.google.com/forum/#!forum/que-talk) first about what it would do and how it would be implemented. If it's a sufficiently large feature, or if most of Que's users wouldn't find it useful, it may be best implemented as a standalone gem, like some of the related projects above.
 
@@ -193,12 +202,80 @@ Regarding contributions, one of the project's priorities is to keep Que as simpl
 
 A note on running specs - Que's worker system is multithreaded and therefore prone to race conditions. As such, if you've touched that code, a single spec run passing isn't a guarantee that any changes you've made haven't introduced bugs. One thing I like to do before pushing changes is rerun the specs many times and watching for hangs. You can do this from the command line with something like:
 
-    for i in {1..1000}; do SEED=$i bundle exec rake; done
+```bash
+for i in {1..1000}; do SEED=$i bundle exec rake; done
+```
 
 This will iterate the specs one thousand times, each with a different ordering. If the specs hang, note what the seed number was on that iteration. For example, if the previous specs finished with a "Randomized with seed 328", you know that there's a hang with seed 329, and you can narrow it down to a specific spec with:
 
-    for i in {1..1000}; do LOG_SPEC=true SEED=328 bundle exec rake; done
+```bash
+for i in {1..1000}; do LOG_SPEC=true SEED=328 bundle exec rake; done
+```
 
 Note that we iterate because there's no guarantee that the hang would reappear with a single additional run, so we need to rerun the specs until it reappears. The LOG_SPEC parameter will output the name and file location of each spec before it is run, so you can easily tell which spec is hanging, and you can continue narrowing things down from there.
 
 Another helpful technique is to replace an `it` spec declaration with `hit` - this will run that particular spec 100 times during the run.
+
+#### With Docker
+
+We've provided a Dockerised environment to avoid the need to manually: install Ruby, install the gem bundle, set up Postgres, and connect to the database.
+
+To run the specs using this environment, run:
+
+```bash
+./auto/test
+```
+
+To get a shell in the environment, run:
+
+```bash
+./auto/dev
+```
+
+The [Docker Compose config](docker-compose.yml) provides a convenient way to inject your local shell aliases into the Docker container. Simply create a file containing your alias definitions (or which sources them from other files) at `~/.docker-rc.d/.docker-bashrc`, and they will be available inside the container.
+
+#### Without Docker
+
+You'll need to have Postgres running. Assuming you have it running on port 5697, with a `que-test` database, and a username & password of `que`, you can run:
+
+```bash
+DATABASE_URL=postgres://que:que@localhost:5697/que-test bundle exec rake
+```
+
+If you don't already have Postgres, you could use Docker Compose to run just the database:
+
+```bash
+docker compose up -d db
+```
+
+If you want to try a different version of Postgres, e.g. 12:
+
+```bash
+export POSTGRES_VERSION=12
+```
+
+### Git pre-push hook
+
+So we can avoid breaking the build, we've created Git pre-push hooks to verify everything is ok before pushing.
+
+To set up the pre-push hook locally, run:
+
+```bash
+echo -e "#\!/bin/bash\n\$(dirname \$0)/../../auto/pre-push-hook" > .git/hooks/pre-push
+chmod +x .git/hooks/pre-push
+```
+
+### Release process
+
+The process for releasing a new version of the gem is:
+
+- Merge PR(s)
+- Git pull locally
+- Update the version number, bundle install, and commit
+- Update `CHANGELOG.md`, and commit
+- Tag the commit with the version number, prefixed by `v`
+- Git push to master
+- Git push the tag
+- Publish the new version of the gem to RubyGems: `gem build -o que.gem && gem push que.gem`
+- Create a GitHub release - rather than describe anything there, link to the heading for the release in `CHANGELOG.md`
+- Post on the Que Discord in `#announcements`

data/auto/dev

@@ -0,0 +1,21 @@
+#!/bin/bash
+#
+# Operate in development environment
+
+set -Eeuo pipefail
+
+cd "$(dirname "$0")/.."
+
+docker compose build dev
+
+# Delete containers and DB volume afterwards on CI
+if [[ "${CI-}" == "true" ]]; then
+  trap '{
+    echo "Stopping containers..."
+    docker compose down
+    docker volume rm -f que_db-data
+  }' EXIT
+fi
+
+set -x
+docker compose run --rm dev "${@-bash}"

data/auto/pre-push-hook

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+set -Eeuo pipefail
+
+cd "$(dirname "$0")/.."
+
+green='\e[32m'; blue='\e[36m'; red='\e[31m'; bold='\e[1m'; reset='\e[0m'
+coloured-arrow() { printf "$bold$1==> $2$reset\n"; }
+success() { coloured-arrow "$green" "$1"; }
+info() { coloured-arrow "$blue" "$1"; }
+err() { coloured-arrow "$red" "$1"; exit 1; }
+
+info 'Running pre-push hook...'
+
+on-exit() {
+  [[ -n "${succeeded-}" ]] || err 'Pre-push checks failed'
+}
+trap on-exit EXIT
+
+info 'Checking for uncommitted changes...'
+[[ -z $(git status -s) ]] || err 'ERROR: You have uncommited changes'
+
+info 'Checking bundle...'
+bundle check --dry-run || bundle install
+
+info 'Specs...'
+auto/test
+
+succeeded=true
+success 'All pre-push checks passed! =)'

data/auto/psql

@@ -0,0 +1,9 @@
+#!/bin/bash
+#
+# Open a database shell
+
+set -Eeuo pipefail
+
+cd "$(dirname "$0")/.."
+
+docker compose run --rm pg-dev psql "${@-}"

data/auto/test

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -Eeuo pipefail
+
+"$(dirname "$0")"/dev ./scripts/test "$@"

data/auto/test-postgres-14

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -Eeuo pipefail
+
+export POSTGRES_VERSION=14
+
+delete_db() {
+  docker compose down
+  docker volume rm -f que_db-data
+}
+
+trap delete_db EXIT
+
+# pre-test cleanup is necessary as the existing db container will be used if it's running (potentially with the wrong PG version)
+delete_db
+"$(dirname "$0")"/test "$@"
+delete_db

data/bin/command_line_interface.rb

@@ -232,7 +232,16 @@ OUTPUT
         $stop_que_executable = false
         %w[INT TERM].each { |signal| trap(signal) { $stop_que_executable = true } }
 
-        output.puts "Que waiting for jobs..."
+        output.puts(
+          <<~STARTUP
+            Que #{Que::VERSION} started worker process with:
+              Worker threads: #{locker.workers.length} (priorities: #{locker.workers.map { |w| w.priority || 'any' }.join(', ')})
+              Buffer size: #{locker.job_buffer.minimum_size}-#{locker.job_buffer.maximum_size}
+              Queues:
+            #{locker.queues.map { |queue, interval| "    - #{queue} (poll interval: #{interval}s)" }.join("\n")}
+            Que waiting for jobs...
+          STARTUP
+        )
 
         loop do
           sleep 0.01

data/docker-compose.yml

@@ -0,0 +1,46 @@
+version: "3.7"
+
+services:
+
+  dev:
+    build:
+      context: .
+      target: dev-environment
+    depends_on:
+      - db
+    volumes:
+      - .:/work
+      - ruby-2.7.5-gem-cache:/usr/local/bundle
+      - ~/.docker-rc.d/:/.docker-rc.d/:ro
+    working_dir: /work
+    entrypoint: /work/scripts/docker-entrypoint
+    command: bash
+    environment:
+      DATABASE_URL: postgres://que:que@db/que-test
+
+  db:
+    image: "postgres:${POSTGRES_VERSION-13}"
+    volumes:
+      - db-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: que
+      POSTGRES_PASSWORD: que
+      POSTGRES_DB: que-test
+    ports:
+      - 5697:5432
+
+  pg-dev:
+    image: "postgres:${POSTGRES_VERSION-13}"
+    depends_on:
+      - db
+    entrypoint: []
+    command: psql
+    environment:
+      PGHOST: db
+      PGUSER: que
+      PGPASSWORD: que
+      PGDATABASE: que-test
+
+volumes:
+  db-data: ~
+  ruby-2.7.5-gem-cache: ~

data/docs/README.md

@@ -129,11 +129,11 @@ There are other docs to read if you're using [Sequel](#using-sequel) or [plain P
 After you've connected Que to the database, you can manage the jobs table. You'll want to migrate to a specific version in a migration file, to ensure that they work the same way even when you upgrade Que in the future:
 
 ```ruby
-# Update the schema to version #4.
-Que.migrate! version: 4
+# Update the schema to version #5.
+Que.migrate!(version: 5)
 
 # Remove Que's jobs table entirely.
-Que.migrate! version: 0
+Que.migrate!(version: 0)
 ```
 
 There's also a helper method to clear all jobs from the jobs table:
@@ -405,11 +405,11 @@ Some new releases of Que may require updates to the database schema. It's recomm
 ```ruby
 class UpdateQue < ActiveRecord::Migration[5.0]
   def self.up
-    Que.migrate! version: 3
+    Que.migrate!(version: 3)
   end
 
   def self.down
-    Que.migrate! version: 2
+    Que.migrate!(version: 2)
   end
 end
 ```
@@ -418,7 +418,7 @@ This will make sure that your database schema stays consistent with your codebas
 
 ```ruby
 # Change schema to version 3.
-Que.migrate! version: 3
+Que.migrate!(version: 3)
 
 # Check your current schema version.
 Que.db_version #=> 3
@@ -550,11 +550,11 @@ require 'que'
 Sequel.migration do
   up do
     Que.connection = self
-    Que.migrate! :version => 3
+    Que.migrate!(version: 5)
   end
   down do
     Que.connection = self
-    Que.migrate! :version => 0
+    Que.migrate!(version: 0)
   end
 end
 ```

data/lib/que/job.rb

@@ -12,7 +12,7 @@ module Que
     SQL[:insert_job] =
       %{
         INSERT INTO public.que_jobs
-        (queue, priority, run_at, job_class, args, data)
+        (queue, priority, run_at, job_class, args, data, job_schema_version)
         VALUES
         (
           coalesce($1, 'default')::text,
@@ -20,7 +20,8 @@ module Que
           coalesce($3, now())::timestamptz,
           $4::text,
           coalesce($5, '[]')::jsonb,
-          coalesce($6, '{}')::jsonb
+          coalesce($6, '{}')::jsonb,
+          #{Que.job_schema_version}
         )
         RETURNING *
       }
@@ -57,22 +58,18 @@ module Que
 
       def enqueue(
         *args,
-        queue:     nil,
-        priority:  nil,
-        run_at:    nil,
-        job_class: nil,
-        tags:      nil,
+        job_options: {},
         **arg_opts
       )
-
+        arg_opts, job_options = _extract_job_options(arg_opts, job_options.dup)
         args << arg_opts if arg_opts.any?
 
-        if tags
-          if tags.length > MAXIMUM_TAGS_COUNT
-            raise Que::Error, "Can't enqueue a job with more than #{MAXIMUM_TAGS_COUNT} tags! (passed #{tags.length})"
+        if job_options[:tags]
+          if job_options[:tags].length > MAXIMUM_TAGS_COUNT
+            raise Que::Error, "Can't enqueue a job with more than #{MAXIMUM_TAGS_COUNT} tags! (passed #{job_options[:tags].length})"
           end
 
-          tags.each do |tag|
+          job_options[:tags].each do |tag|
             if tag.length > MAXIMUM_TAG_LENGTH
               raise Que::Error, "Can't enqueue a job with a tag longer than 100 characters! (\"#{tag}\")"
             end
@@ -80,13 +77,13 @@ module Que
         end
 
         attrs = {
-          queue:    queue    || resolve_que_setting(:queue) || Que.default_queue,
-          priority: priority || resolve_que_setting(:priority),
-          run_at:   run_at   || resolve_que_setting(:run_at),
+          queue:    job_options[:queue]    || resolve_que_setting(:queue) || Que.default_queue,
+          priority: job_options[:priority] || resolve_que_setting(:priority),
+          run_at:   job_options[:run_at]   || resolve_que_setting(:run_at),
           args:     Que.serialize_json(args),
-          data:     tags ? Que.serialize_json(tags: tags) : "{}",
+          data:     job_options[:tags] ? Que.serialize_json(tags: job_options[:tags]) : "{}",
           job_class: \
-            job_class || name ||
+            job_options[:job_class] || name ||
               raise(Error, "Can't enqueue an anonymous subclass of Que::Job"),
         }
 
@@ -139,6 +136,27 @@ module Que
           end
         end
       end
+
+      def _extract_job_options(arg_opts, job_options)
+        deprecated_job_option_names = []
+
+        %i[queue priority run_at job_class tags].each do |option_name|
+          next unless arg_opts.key?(option_name) && job_options[option_name].nil?
+
+          job_options[option_name] = arg_opts.delete(option_name)
+          deprecated_job_option_names << option_name
+        end
+
+        _log_job_options_deprecation(deprecated_job_option_names)
+
+        [arg_opts, job_options]
+      end
+
+      def _log_job_options_deprecation(deprecated_job_option_names)
+        return unless deprecated_job_option_names.any?
+
+        warn "Passing job options like (#{deprecated_job_option_names.join(', ')}) to `JobClass.enqueue` as top level keyword args has been deprecated and will be removed in version 2.0. Please wrap job options in an explicit `job_options` keyword arg instead."
+      end
     end
 
     # Set up some defaults.

data/lib/que/locker.rb

@@ -24,12 +24,12 @@ module Que
 
   SQL[:register_locker] =
     %{
-      INSERT INTO public.que_lockers (pid, worker_count, worker_priorities, ruby_pid, ruby_hostname, listening, queues)
-      VALUES (pg_backend_pid(), $1::integer, $2::integer[], $3::integer, $4::text, $5::boolean, $6::text[])
+      INSERT INTO public.que_lockers (pid, worker_count, worker_priorities, ruby_pid, ruby_hostname, listening, queues, job_schema_version)
+      VALUES (pg_backend_pid(), $1::integer, $2::integer[], $3::integer, $4::text, $5::boolean, $6::text[], $7::integer)
     }
 
   class Locker
-    attr_reader :thread, :workers, :job_buffer, :locks
+    attr_reader :thread, :workers, :job_buffer, :locks, :queues, :poll_interval
 
     MESSAGE_RESOLVERS = {}
     RESULT_RESOLVERS  = {}
@@ -101,7 +101,20 @@ module Que
       # Local cache of which advisory locks are held by this connection.
       @locks = Set.new
 
-      @queue_names = queues.is_a?(Hash) ? queues.keys : queues
+      @poll_interval = poll_interval
+
+      if queues.is_a?(Hash)
+        @queue_names = queues.keys
+        @queues = queues.transform_values do |interval|
+          interval || poll_interval
+        end
+      else
+        @queue_names = queues
+        @queues = queues.map do |queue_name|
+          [queue_name, poll_interval]
+        end.to_h
+      end
+
       @wait_period = wait_period.to_f / 1000 # Milliseconds to seconds.
 
       @workers =
@@ -183,11 +196,11 @@ module Que
 
             @pollers =
               if poll
-                queues.map do |queue, interval|
+                @queues.map do |queue_name, interval|
                   Poller.new(
                     connection:    @connection,
-                    queue:         queue,
-                    poll_interval: interval || poll_interval,
+                    queue:         queue_name,
+                    poll_interval: interval,
                   )
                 end
               end
@@ -266,6 +279,7 @@ module Que
         CURRENT_HOSTNAME,
         !!@listener,
         "{\"#{@queue_names.join('","')}\"}",
+        Que.job_schema_version,
       ]
     end
 

data/lib/que/migrations/4/up.sql

@@ -146,7 +146,9 @@ CREATE FUNCTION que_job_notify() RETURNS trigger AS $$
         FROM (
           SELECT *
           FROM public.que_lockers ql, generate_series(1, ql.worker_count) AS id
-          WHERE listening AND queues @> ARRAY[NEW.queue]
+          WHERE
+            listening AND
+            queues @> ARRAY[NEW.queue]
           ORDER BY md5(pid::text || id::text)
         ) t1
       ) t2

data/lib/que/migrations/5/down.sql

@@ -0,0 +1,73 @@
+DROP TRIGGER que_job_notify ON que_jobs;
+DROP FUNCTION que_job_notify();
+
+DROP INDEX que_poll_idx_with_job_schema_version;
+
+ALTER TABLE que_jobs
+  DROP COLUMN job_schema_version;
+
+ALTER TABLE que_lockers
+  DROP COLUMN job_schema_version;
+
+CREATE FUNCTION que_job_notify() RETURNS trigger AS $$
+  DECLARE
+    locker_pid integer;
+    sort_key json;
+  BEGIN
+    -- Don't do anything if the job is scheduled for a future time.
+    IF NEW.run_at IS NOT NULL AND NEW.run_at > now() THEN
+      RETURN null;
+    END IF;
+
+    -- Pick a locker to notify of the job's insertion, weighted by their number
+    -- of workers. Should bounce pseudorandomly between lockers on each
+    -- invocation, hence the md5-ordering, but still touch each one equally,
+    -- hence the modulo using the job_id.
+    SELECT pid
+    INTO locker_pid
+    FROM (
+      SELECT *, last_value(row_number) OVER () + 1 AS count
+      FROM (
+        SELECT *, row_number() OVER () - 1 AS row_number
+        FROM (
+          SELECT *
+          FROM public.que_lockers ql, generate_series(1, ql.worker_count) AS id
+          WHERE
+            listening AND
+            queues @> ARRAY[NEW.queue]
+          ORDER BY md5(pid::text || id::text)
+        ) t1
+      ) t2
+    ) t3
+    WHERE NEW.id % count = row_number;
+
+    IF locker_pid IS NOT NULL THEN
+      -- There's a size limit to what can be broadcast via LISTEN/NOTIFY, so
+      -- rather than throw errors when someone enqueues a big job, just
+      -- broadcast the most pertinent information, and let the locker query for
+      -- the record after it's taken the lock. The worker will have to hit the
+      -- DB in order to make sure the job is still visible anyway.
+      SELECT row_to_json(t)
+      INTO sort_key
+      FROM (
+        SELECT
+          'job_available' AS message_type,
+          NEW.queue       AS queue,
+          NEW.priority    AS priority,
+          NEW.id          AS id,
+          -- Make sure we output timestamps as UTC ISO 8601
+          to_char(NEW.run_at AT TIME ZONE 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS.US"Z"') AS run_at
+      ) t;
+
+      PERFORM pg_notify('que_listener_' || locker_pid::text, sort_key::text);
+    END IF;
+
+    RETURN null;
+  END
+$$
+LANGUAGE plpgsql;
+
+CREATE TRIGGER que_job_notify
+  AFTER INSERT ON que_jobs
+  FOR EACH ROW
+  EXECUTE PROCEDURE public.que_job_notify();

data/lib/que/migrations/5/up.sql

@@ -0,0 +1,76 @@
+DROP TRIGGER que_job_notify ON que_jobs;
+DROP FUNCTION que_job_notify();
+
+ALTER TABLE que_jobs
+  ADD COLUMN job_schema_version INTEGER DEFAULT 1;
+
+ALTER TABLE que_lockers
+  ADD COLUMN job_schema_version INTEGER DEFAULT 1;
+
+CREATE INDEX que_poll_idx_with_job_schema_version
+  ON que_jobs (job_schema_version, queue, priority, run_at, id)
+  WHERE (finished_at IS NULL AND expired_at IS NULL);
+
+CREATE FUNCTION que_job_notify() RETURNS trigger AS $$
+  DECLARE
+    locker_pid integer;
+    sort_key json;
+  BEGIN
+    -- Don't do anything if the job is scheduled for a future time.
+    IF NEW.run_at IS NOT NULL AND NEW.run_at > now() THEN
+      RETURN null;
+    END IF;
+
+    -- Pick a locker to notify of the job's insertion, weighted by their number
+    -- of workers. Should bounce pseudorandomly between lockers on each
+    -- invocation, hence the md5-ordering, but still touch each one equally,
+    -- hence the modulo using the job_id.
+    SELECT pid
+    INTO locker_pid
+    FROM (
+      SELECT *, last_value(row_number) OVER () + 1 AS count
+      FROM (
+        SELECT *, row_number() OVER () - 1 AS row_number
+        FROM (
+          SELECT *
+          FROM public.que_lockers ql, generate_series(1, ql.worker_count) AS id
+          WHERE
+            listening AND
+            queues @> ARRAY[NEW.queue] AND
+            ql.job_schema_version = NEW.job_schema_version
+          ORDER BY md5(pid::text || id::text)
+        ) t1
+      ) t2
+    ) t3
+    WHERE NEW.id % count = row_number;
+
+    IF locker_pid IS NOT NULL THEN
+      -- There's a size limit to what can be broadcast via LISTEN/NOTIFY, so
+      -- rather than throw errors when someone enqueues a big job, just
+      -- broadcast the most pertinent information, and let the locker query for
+      -- the record after it's taken the lock. The worker will have to hit the
+      -- DB in order to make sure the job is still visible anyway.
+      SELECT row_to_json(t)
+      INTO sort_key
+      FROM (
+        SELECT
+          'job_available' AS message_type,
+          NEW.queue       AS queue,
+          NEW.priority    AS priority,
+          NEW.id          AS id,
+          -- Make sure we output timestamps as UTC ISO 8601
+          to_char(NEW.run_at AT TIME ZONE 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS.US"Z"') AS run_at
+      ) t;
+
+      PERFORM pg_notify('que_listener_' || locker_pid::text, sort_key::text);
+    END IF;
+
+    RETURN null;
+  END
+$$
+LANGUAGE plpgsql;
+
+CREATE TRIGGER que_job_notify
+  AFTER INSERT ON que_jobs
+  FOR EACH ROW
+  EXECUTE PROCEDURE public.que_job_notify();

data/lib/que/migrations.rb

@@ -4,7 +4,7 @@ module Que
   module Migrations
     # In order to ship a schema change, add the relevant up and down sql files
     # to the migrations directory, and bump the version here.
-    CURRENT_VERSION = 4
+    CURRENT_VERSION = 5
 
     class << self
       def migrate!(version:)
@@ -28,7 +28,6 @@ module Que
               step,
               direction,
             ].join('/') << '.sql'
-
             Que.execute(File.read(filename))
           end
 

data/lib/que/poller.rb

@@ -68,6 +68,7 @@ module Que
             SELECT j
             FROM public.que_jobs AS j
             WHERE queue = $1::text
+              AND job_schema_version = #{Que.job_schema_version}
               AND NOT id = ANY($2::bigint[])
               AND priority <= pg_temp.que_highest_remaining_priority($3::jsonb)
               AND run_at <= now()
@@ -88,6 +89,7 @@ module Que
                   SELECT j
                   FROM public.que_jobs AS j
                   WHERE queue = $1::text
+                    AND job_schema_version = #{Que.job_schema_version}
                     AND NOT id = ANY($2::bigint[])
                     AND priority <= pg_temp.que_highest_remaining_priority(jobs.remaining_priorities)
                     AND run_at <= now()

data/lib/que/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 module Que
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
+
+  def self.job_schema_version
+    1
+  end
 end

data/lib/que/worker.rb

@@ -137,6 +137,7 @@ module Que
         error: {
           class:   error.class.to_s,
           message: error.message,
+          backtrace: (error.backtrace || []).join("\n").slice(0, 10000),
         },
       )
 
@@ -164,7 +165,7 @@ module Que
           Que.execute :set_error, [
             delay,
             "#{error.class}: #{error.message}".slice(0, 500),
-            error.backtrace.join("\n").slice(0, 10000),
+            (error.backtrace || []).join("\n").slice(0, 10000),
             job.fetch(:id),
           ]
         end

data/scripts/docker-entrypoint

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -Eeuo pipefail
+
+# For using your own dotfiles within the Docker container
+if [ -f /.docker-rc.d/.docker-bashrc ]; then
+  echo "source /.docker-rc.d/.docker-bashrc" >> ~/.bashrc
+fi
+
+gem list -i -e bundler -v "$RUBY_BUNDLER_VERSION" >/dev/null || gem install bundler -v "$RUBY_BUNDLER_VERSION"
+
+bundle check --dry-run || bundle install
+
+exec "${@-bash}"

data/scripts/test

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -Eeuo pipefail
+
+bundle exec rake spec "$@"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -35,11 +35,18 @@ files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - CHANGELOG.md
+- Dockerfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- auto/dev
+- auto/pre-push-hook
+- auto/psql
+- auto/test
+- auto/test-postgres-14
 - bin/command_line_interface.rb
 - bin/que
+- docker-compose.yml
 - docs/README.md
 - lib/que.rb
 - lib/que/active_job/extensions.rb
@@ -62,6 +69,8 @@ files:
 - lib/que/migrations/3/up.sql
 - lib/que/migrations/4/down.sql
 - lib/que/migrations/4/up.sql
+- lib/que/migrations/5/down.sql
+- lib/que/migrations/5/up.sql
 - lib/que/poller.rb
 - lib/que/rails/railtie.rb
 - lib/que/result_queue.rb
@@ -79,6 +88,8 @@ files:
 - lib/que/version.rb
 - lib/que/worker.rb
 - que.gemspec
+- scripts/docker-entrypoint
+- scripts/test
 homepage: https://github.com/que-rb/que
 licenses:
 - MIT
@@ -98,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: A PostgreSQL-based Job Queue