que 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08d50e63c19dbe61966e4048eb1e30fce181e520b05f20f933220baede9cbc76'
-  data.tar.gz: 72abbb3390310c18897739e35a2fdb5e6a8187a9b5ae27e4ee651ce4b7c8d9bf
+  metadata.gz: 0ab8266596317c607383b8041784ef57580260a1823ff62f7e25da2171eda072
+  data.tar.gz: 7af7354cb7d22d69c97070c7ef4fd075adb23af081ab75f56d587e73a940e208
 SHA512:
-  metadata.gz: aa542178d30c1fc031ae2508ff462d0b1ff23f2e5a4e6f9b3fb1cb08ec3ac3a3cc6c167e532654124b5d72c53a319c0b74c3f3a2eb0b5e66102242b43ad59a50
-  data.tar.gz: d3902890b359a759f9fe3c94f431afb512e312b6dc46d22223d0d3dc7154f21458a8c7592a72850318094af3c4bfe59950dc8f5bde68e314911695e39d19507a
+  metadata.gz: 37cbca060d09e4925d6869bee31365c315e274e7d02f9c6bfe6d866082bda4265c890785e04ed740a1d969e282b44dc38bde0accfe7c033ac170ddb136573c91
+  data.tar.gz: addec5796eedda7f4dd6561445b387f9066cb2096d583d33f562fb7768af15705384677ca7401086a99c012deb432cdbf138c4ca4e81b09bcbf1f010fa1924ce

data/.github/workflows/tests.yml

@@ -7,17 +7,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby_version: ['2.7', '3.0', '3.1']
-        rails_gemfile: ['6.0', '6.1']
+        ruby_version: ['2.7', '3.0', '3.1', '3.2']
+        rails_gemfile: ['6.0', '6.1', '7.0']
         postgres_version: ['14']
         include:
         # Postgres versions
-        - { ruby_version: '3.1', rails_gemfile: '6.1', postgres_version: '9' }
-        - { ruby_version: '3.1', rails_gemfile: '6.1', postgres_version: '10' }
-        - { ruby_version: '3.1', rails_gemfile: '6.1', postgres_version: '11' }
-        - { ruby_version: '3.1', rails_gemfile: '6.1', postgres_version: '12' }
-        - { ruby_version: '3.1', rails_gemfile: '6.1', postgres_version: '13' }
-        - { ruby_version: '3.1', rails_gemfile: '6.1', postgres_version: '14' }
+        - { ruby_version: '3.2', rails_gemfile: '7.0', postgres_version: '9' }
+        - { ruby_version: '3.2', rails_gemfile: '7.0', postgres_version: '10' }
+        - { ruby_version: '3.2', rails_gemfile: '7.0', postgres_version: '11' }
+        - { ruby_version: '3.2', rails_gemfile: '7.0', postgres_version: '12' }
+        - { ruby_version: '3.2', rails_gemfile: '7.0', postgres_version: '13' }
+        - { ruby_version: '3.2', rails_gemfile: '7.0', postgres_version: '14' }
         exclude: []
     name: "Test: Ruby ${{ matrix.ruby_version }}, Rails ${{ matrix.rails_gemfile }}, PostgreSQL ${{ matrix.postgres_version }}"
     services:

data/.ruby-version

@@ -1 +1 @@
-3.1.1
+3.2.2

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 <!-- MarkdownTOC autolink=true -->
 
+- [2.2.1 \(2023-04-28\)](#221-2023-04-28)
+- [2.2.0 \(2022-08-29\)](#220-2022-08-29)
 - [2.1.0 \(2022-08-25\)](#210-2022-08-25)
 - [2.0.0 \(2022-08-25\)](#200-2022-08-25)
 - [1.4.1 \(2022-07-24\)](#141-2022-07-24)
@@ -55,6 +57,25 @@
 
 <!-- /MarkdownTOC -->
 
+## 2.2.1 (2023-04-28)
+
+- **Fixed**:
+    + Fixed support for ActiveJob in Ruby 3.2. [#390](https://github.com/que-rb/que/pull/390)
+
+## 2.2.0 (2022-08-29)
+
+- **Changed**:
+    + When migrating, now raises an exception when the Que DB schema version is missing from the database. The migrations system records this version in a comment on the `que_jobs` table. [#379](https://github.com/que-rb/que/pull/379)
+        *   > Que::Error: Cannot determine Que DB schema version.
+            >
+            > The que_jobs table is missing its comment recording the Que DB schema version. This is likely due to a bug in Rails schema dump in Rails 7 versions prior to 7.0.3, omitting comments - see https://github.com/que-rb/que/issues/363. Please determine the appropriate schema version from your migrations and record it manually by running the following SQL (replacing version as appropriate):
+            >
+            > COMMENT ON TABLE que_jobs IS 'version';
+- **Removed**:
+    + Removed support for upgrading directly from a version of Que prior to v0.5.0 (released on 2014-01-14), which introduced the migrations system. It's too difficult to handle the different DB schemas from prior to this.
+- **Internal**:
+    + Moved `command_line_interface.rb` from `bin/` to `lib/`. [#378](https://github.com/que-rb/que/pull/378)
+
 ## 2.1.0 (2022-08-25)
 
 - **Added**:
@@ -65,7 +86,7 @@
 This release contains a database migration. You will need to migrate Que to the latest database schema version (7). For example, on ActiveRecord and Rails 6:
 
 ```ruby
-class UpdateQueTablesToVersion6 < ActiveRecord::Migration[6.0]
+class UpdateQueTablesToVersion7 < ActiveRecord::Migration[6.0]
   def up
     Que.migrate!(version: 7)
   end

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.1.1-slim-buster@sha256:2ada3e4fe7b1703c9333ad4eb9fc12c1d4d60bce0f981281b2151057e928d9ad AS base
+FROM ruby:3.2.2-slim-buster@sha256:005f0892d160a4f80f8f89116ec15fddc81f296cd4083db9d59accaed125e270 AS base
 
 # Install libpq-dev in our base layer, as it's needed in all environments
 RUN apt-get update \

data/README.md

@@ -59,7 +59,7 @@ class CreateQueSchema < ActiveRecord::Migration[6.0]
     # 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: 6)
+    Que.migrate!(version: 7)
   end
 
   def down
@@ -191,6 +191,7 @@ These projects are tested to be compatible with Que 1.x:
 - [que-web](https://github.com/statianzo/que-web) is a Sinatra-based UI for inspecting your job queue.
 - [que-scheduler](https://github.com/hlascelles/que-scheduler) lets you schedule tasks using a cron style config file.
 - [que-locks](https://github.com/airhorns/que-locks) lets you lock around job execution for so only one job runs at once for a set of arguments.
+- [que-unique](https://github.com/bambooengineering/que-unique) provides fast in-memory `enqueue` deduping.
 
 If you have a project that uses or relates to Que, feel free to submit a PR adding it to the list!
 

data/bin/que

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative 'command_line_interface'
+require 'que/command_line_interface'
 
 $stdout.sync = true
 

data/docker-compose.yml

@@ -10,7 +10,7 @@ services:
       - db
     volumes:
       - .:/work
-      - ruby-3.1.1-gem-cache:/usr/local/bundle
+      - ruby-3.2.2-gem-cache:/usr/local/bundle
       - ~/.docker-rc.d/:/.docker-rc.d/:ro
     working_dir: /work
     entrypoint: /work/scripts/docker-entrypoint
@@ -44,4 +44,4 @@ services:
 
 volumes:
   db-data: ~
-  ruby-3.1.1-gem-cache: ~
+  ruby-3.2.2-gem-cache: ~

data/docs/README.md

@@ -139,8 +139,8 @@ 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 #6.
-Que.migrate!(version: 6)
+# Update the schema to version #7.
+Que.migrate!(version: 7)
 
 # Remove Que's jobs table entirely.
 Que.migrate!(version: 0)
@@ -553,7 +553,7 @@ require 'que'
 Sequel.migration do
   up do
     Que.connection = self
-    Que.migrate!(version: 6)
+    Que.migrate!(version: 7)
   end
   down do
     Que.connection = self

data/lib/que/active_job/extensions.rb

@@ -10,6 +10,7 @@ module Que
       def run(*args)
         raise Error, "Job class #{self.class} didn't define a run() method!"
       end
+      ruby2_keywords(:run) if respond_to?(:ruby2_keywords, true)
 
       def perform(*args)
         args, kwargs = Que.split_out_ruby2_keywords(args)
@@ -31,6 +32,7 @@ module Que
           ),
         )
       end
+      ruby2_keywords(:perform) if respond_to?(:ruby2_keywords, true)
 
       private
 

data/lib/que/locker.rb

@@ -7,6 +7,10 @@
 require 'set'
 
 module Que
+  class << self
+    attr_accessor :locker
+  end
+
   Listener::MESSAGE_FORMATS[:job_available] =
     {
       queue:    String,
@@ -71,6 +75,11 @@ module Que
       Que.assert Array, worker_priorities
       worker_priorities.each { |p| Que.assert([Integer, NilClass], p) }
 
+      # We assign this globally because we only ever expect one locker to be
+      # created per worker process. This can be used by middleware or external
+      # code to access the locker during runtime.
+      Que.locker = self
+
       # We use a JobBuffer to track jobs and pass them to workers, and a
       # ResultQueue to receive messages from workers.
       @job_buffer = JobBuffer.new(

data/lib/que/migrations.rb

@@ -48,14 +48,27 @@ module Que
           # No table in the database at all.
           0
         elsif (d = result.first[:description]).nil?
-          # There's a table, it was just created before the migration system
-          # existed.
-          1
+          # The table exists but the version comment is missing
+          _raise_db_version_comment_missing_error
         else
           d.to_i
         end
       end
 
+      # The que_jobs table could be missing the schema version comment either due to:
+      # - Being created before the migration system existed; or
+      # - A bug in Rails schema dump in some versions of Rails
+      # The former is the case on Que versions prior to v0.5.0 (2014-01-14). Upgrading directly from there is unsupported, so we just raise in all cases of the comment being missing
+      def _raise_db_version_comment_missing_error
+        raise Error, <<~ERROR
+          Cannot determine Que DB schema version.
+
+          The que_jobs table is missing its comment recording the Que DB schema version. This is likely due to a bug in Rails schema dump in Rails 7 versions prior to 7.0.3, omitting comments - see https://github.com/que-rb/que/issues/363. Please determine the appropriate schema version from your migrations and record it manually by running the following SQL (replacing version as appropriate):
+
+          COMMENT ON TABLE que_jobs IS 'version';
+        ERROR
+      end
+
       def set_db_version(version)
         i = version.to_i
         Que.execute "COMMENT ON TABLE que_jobs IS '#{i}'" unless i.zero?

data/lib/que/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Que
-  VERSION = '2.1.0'
+  VERSION = '2.2.1'
 
   def self.job_schema_version
     2

data/lib/que.rb

@@ -79,6 +79,10 @@ module Que
       @default_queue || DEFAULT_QUEUE
     end
 
+    def server?
+      defined?(Que::CommandLineInterface).nil?
+    end
+
     # Support simple integration with many common connection pools.
     def connection=(conn)
       self.connection_proc =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,6 @@ files:
 - auto/psql
 - auto/test
 - auto/test-postgres-14
-- bin/command_line_interface.rb
 - bin/que
 - docker-compose.yml
 - docs/README.md
@@ -53,6 +52,7 @@ files:
 - lib/que/active_job/extensions.rb
 - lib/que/active_record/connection.rb
 - lib/que/active_record/model.rb
+- lib/que/command_line_interface.rb
 - lib/que/connection.rb
 - lib/que/connection_pool.rb
 - lib/que/job.rb
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A PostgreSQL-based Job Queue