que 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd8e2e7b77de787218a646c550cf38fddd52091c91422fdb5813b12fe1af775c
-  data.tar.gz: e9abc8a607b82db9b0ed925163ed4b21d61f7f2588b1dfd91bf8b558af3fa14c
+  metadata.gz: b6ba77a9666d67547e81022c081b95d0ff1087a25d31e8ae2400213e81e54f2d
+  data.tar.gz: fe9220bf6fe842fd7b0b401ae37440e9a5f7033d9fa59594ceeb1eff802c7ecb
 SHA512:
-  metadata.gz: 55cea89090a9685c5001aba97794e0fa2246362da2b530b02808966e3a4487d07a908ec980d141ad76d59bd04065863fbc097af2ea78acefda110dfdb37cea48
-  data.tar.gz: 114317905799b63fcc9b4c5180a15f24da03e7937790e6b330d0d67c5a0d7df062c470dd2b8a98426f5ced795b5da6d435a647e9504b66ba669fb72953872f66
+  metadata.gz: 96f9ca6172cc8c69055dbd94557cc818aa7bf360437437a3da0ef502ef280b0c9d9b9d4b6f811dcefe06f2f6079902c6b556f8120171ac743f4308bc0063a17f
+  data.tar.gz: '039af963aa1d2106c85144067ee6ec6119f6a7bad22f3301b3c018e46c636e8329c25bd8443460706ef41d9822dcee15e8629ac120cb422ba62a681324f127b8'

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', '7.1']
         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.1', postgres_version: '9' }
+        - { ruby_version: '3.2', rails_gemfile: '7.1', postgres_version: '10' }
+        - { ruby_version: '3.2', rails_gemfile: '7.1', postgres_version: '11' }
+        - { ruby_version: '3.2', rails_gemfile: '7.1', postgres_version: '12' }
+        - { ruby_version: '3.2', rails_gemfile: '7.1', postgres_version: '13' }
+        - { ruby_version: '3.2', rails_gemfile: '7.1', 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.3.0 \(2023-10-10\)](#230-2023-10-16)
+- [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)
@@ -56,6 +58,22 @@
 
 <!-- /MarkdownTOC -->
 
+## 2.3.0 (2023-10-16)
+- **Fixed**:
+    + Don't clear `ActiveRecord` connections when `run_synchronously` is enabled [#393](https://github.com/que-rb/que/pull/393)
+
+- **Changed**
+    + Improve performance of query used by `QueJob#by_job_class` for jobs wrapped by `ActiveJob` [#394](https://github.com/que-rb/que/pull/394)
+
+- **Added**
+    + Allow `que` to be started without listen/notify [#395](https://github.com/que-rb/que/pull/395)
+    + Support Rails 7.1+ [#403](https://github.com/que-rb/que/pull/403)
+
+## 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**:

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,8 @@ 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.
+- [que-prometheus](https://github.com/mnbbrown/que-prometheus) exposes Prometheus API endpoints for job, worker, and queue metrics
 
 If you have a project that uses or relates to Que, feel free to submit a PR adding it to the list!
 

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
 
@@ -106,6 +108,41 @@ module Que
   end
 end
 
+# This is the ActiveJob Que adapter for Rails 7.1+, given ActiveJob::QueueAdapters::QueAdapter has been removed from ActiveJob.
+# For backwards compatibility, the class name of ActiveJob::QueueAdapters::QueAdapter::JobWrapper must remain the same, given this string would be in old job records in the database
+if ActiveJob.gem_version >= Gem::Version.new('7.1')
+  module ActiveJob
+    module QueueAdapters
+      # Work around `autoload QueAdapter` being left over in ActiveJob after the adapter was removed
+      remove_const(:QueAdapter) if const_defined?(:QueAdapter)
+
+      class QueAdapter
+        def enqueue(job)
+          job_options = { priority: job.priority, queue: job.queue_name }
+          que_job = JobWrapper.enqueue job.serialize, **job_options
+          job.provider_job_id = que_job.attrs["job_id"]
+          que_job
+        end
+
+        def enqueue_at(job, timestamp)
+          job_options = { priority: job.priority, queue: job.queue_name, run_at: Time.at(timestamp) }
+          que_job = JobWrapper.enqueue job.serialize, **job_options
+          job.provider_job_id = que_job.attrs["job_id"]
+          que_job
+        end
+
+        private
+
+        class JobWrapper < Que::Job
+          def run(job_data)
+            Base.execute job_data
+          end
+        end
+      end
+    end
+  end
+end
+
 class ActiveJob::QueueAdapters::QueAdapter
   class JobWrapper < Que::Job
     extend Que::ActiveJob::WrapperExtensions::ClassMethods

data/lib/que/active_record/connection.rb

@@ -42,7 +42,7 @@ module Que
             # feature to unknowingly leak connections to other databases. So,
             # take the additional step of telling ActiveRecord to check in all
             # of the current thread's connections after each job is run.
-            ::ActiveRecord::Base.clear_active_connections!
+            ::ActiveRecord::Base.clear_active_connections! unless job.class.resolve_que_setting(:run_synchronously)
           end
         end
       end

data/lib/que/active_record/model.rb

@@ -25,9 +25,10 @@ module Que
       class << self
         def by_job_class(job_class)
           job_class = job_class.name if job_class.is_a?(Class)
+          job_class_doc = "[{\"job_class\": \"#{job_class}\"}]"
           where(
-            "que_jobs.job_class = ? OR (que_jobs.job_class = 'ActiveJob::QueueAdapters::QueAdapter::JobWrapper' AND que_jobs.args->0->>'job_class' = ?)",
-            job_class, job_class,
+            "que_jobs.job_class = ? OR (que_jobs.job_class = 'ActiveJob::QueueAdapters::QueAdapter::JobWrapper' AND que_jobs.args @> ?)",
+            job_class, job_class_doc,
           )
         end
 

data/lib/que/command_line_interface.rb

@@ -50,6 +50,14 @@ module Que
               poll_interval = i
             end
 
+            opts.on(
+              '--listen [LISTEN]',
+              String,
+              "Set to false to disable listen mode (default: true)"
+            ) do |listen|
+              options[:listen] = listen != "false"
+            end
+
             opts.on(
               '-l',
               '--log-level [LEVEL]',

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/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Que
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 
   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.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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