que 2.2.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ab8266596317c607383b8041784ef57580260a1823ff62f7e25da2171eda072
-  data.tar.gz: 7af7354cb7d22d69c97070c7ef4fd075adb23af081ab75f56d587e73a940e208
+  metadata.gz: 37c1d6014ec840c445c2142cdd46646409b21d1513bcd1a6d6cea125afe714fb
+  data.tar.gz: bf5215a463ca64b5acee7a6a080296e9dcb39b9fea8399576ad758e63e424edd
 SHA512:
-  metadata.gz: 37cbca060d09e4925d6869bee31365c315e274e7d02f9c6bfe6d866082bda4265c890785e04ed740a1d969e282b44dc38bde0accfe7c033ac170ddb136573c91
-  data.tar.gz: addec5796eedda7f4dd6561445b387f9066cb2096d583d33f562fb7768af15705384677ca7401086a99c012deb432cdbf138c4ca4e81b09bcbf1f010fa1924ce
+  metadata.gz: 32845cf47073ed8bda56f7bd4594dbd65cceb48324460436437251049fda2548bda517db107034733c5dbbf15edba403111afaf41526ae6a09356aee5b9b93e9
+  data.tar.gz: 791a05612735d7b7480557039001c9d11946b6bffca4f895d44b6a9d58e6c2b78eebb8e20b8440076832e4333e77196f2bb60849fb0f51861ba6572f202d4da7

data/.github/workflows/tests.yml

@@ -8,16 +8,16 @@ jobs:
     strategy:
       matrix:
         ruby_version: ['2.7', '3.0', '3.1', '3.2']
-        rails_gemfile: ['6.0', '6.1', '7.0']
+        rails_gemfile: ['6.0', '6.1', '7.0', '7.1']
         postgres_version: ['14']
         include:
         # Postgres versions
-        - { 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' }
+        - { 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:
@@ -45,7 +45,7 @@ jobs:
       run: |
         sudo apt-get -yqq install libpq-dev postgresql-client
         createdb que-test
-        gem install bundler
+        gem install bundler --version '~> 2.4.22'
         bundle install --jobs 4 --retry 3
         USE_RAILS=true bundle exec rake test
         bundle exec rake test

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 <!-- MarkdownTOC autolink=true -->
 
+- [2.4.0 \(2024-08-21\)](#240-2024-08-21)
+- [2.3.0 \(2023-10-16\)](#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)
@@ -57,6 +59,28 @@
 
 <!-- /MarkdownTOC -->
 
+## 2.4.0 (2024-08-21)
+
+- **Fixed**:
+    + Fixed `Que.server?` method returning the inverse of what was intended. This method can be used to determine whether Que is running as a server process (run from the Que CLI). [#426](https://github.com/que-rb/que/pull/426), context in [#382](https://github.com/que-rb/que/pull/382)
+- **Added**:
+    + Added logging of full job details rather than just `job_id`. Note that the hash `Que.log_formatter` is called with no longer contains `:job_id`; instead it now has a `:job` hash including `:id`. [#428](https://github.com/que-rb/que/pull/428)
+- **Documentation**:
+    + Improved wording of transaction recommendation in the readme for destroying a job. [#417](https://github.com/que-rb/que/pull/417)
+    + Added [que-view](https://github.com/kortirso/que-view) to the list of Que-compatible projects in the readme: "A Rails engine-based UI for inspecting your job queue". [#418](https://github.com/que-rb/que/pull/418)
+
+## 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**:

data/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
   && apt-get install -y libpq-dev \
   && rm -rf /var/lib/apt/lists/*
 
-ENV RUBY_BUNDLER_VERSION 2.3.7
+ENV RUBY_BUNDLER_VERSION 2.4.22
 RUN gem install bundler -v $RUBY_BUNDLER_VERSION
 
 ENV BUNDLE_PATH /usr/local/bundle

data/README.md

@@ -92,7 +92,7 @@ class ChargeCreditCard < Que::Job
 
       # It's best to destroy the job in the same transaction as any other
       # changes you make. Que will mark the job as destroyed for you after the
-      # run method if you don't do it yourself, but if your job writes to the DB
+      # run method if you don't do it yourself; however if your job writes to the DB
       # but doesn't destroy the job in the same transaction, it's possible that
       # the job could be repeated in the event of a crash.
       destroy
@@ -189,9 +189,11 @@ There are a couple ways to do testing. You may want to set `Que::Job.run_synchro
 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-view](https://github.com/kortirso/que-view) is a Rails engine-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/docs/README.md

@@ -349,7 +349,7 @@ que --worker-count 1
 By default, Que logs important information in JSON to either Rails' logger (when running in a Rails web process) or STDOUT (when running via the `que` executable). So, your logs will look something like:
 
 ```
-I, [2017-08-12T05:07:31.094201 #4687]  INFO -- : {"lib":"que","hostname":"lovelace","pid":21626,"thread":21471100,"event":"job_worked","job_id":6157665,"elapsed":0.531411}
+I, [2017-08-12T05:07:31.094201 #4687]  INFO -- : {"lib":"que","hostname":"lovelace","pid":98240,"thread":42660,"event":"job_worked","job":{"priority":1,"run_at":"2024-07-24T11:07:10.056514Z","id":2869885284504751564,"job_class":"WorkerJob","error_count":0,"last_error_message":null,"queue":"default","last_error_backtrace":null,"finished_at":null,"expired_at":null,"args":[1],"data":{},"job_schema_version":2,"kwargs":{}},"elapsed":0.001356}
 ```
 
 Of course you can have it log wherever you like:

data/lib/que/active_job/extensions.rb

@@ -108,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]',
@@ -151,6 +159,14 @@ module Que
             ) do |p|
               options[:wait_period] = p
             end
+
+            opts.on(
+              '--pidfile [PATH]',
+              String,
+              "Write the PID of this process to the specified file.",
+              ) do |p|
+              options[:pidfile] = File.expand_path(p)
+            end
           end
 
         parser.parse!(args)

data/lib/que/locker.rb

@@ -61,7 +61,8 @@ module Que
       wait_period:         DEFAULT_WAIT_PERIOD,
       maximum_buffer_size: DEFAULT_MAXIMUM_BUFFER_SIZE,
       worker_priorities:   DEFAULT_WORKER_PRIORITIES,
-      on_worker_start:     nil
+      on_worker_start:     nil,
+      pidfile:             nil
     )
 
       # Sanity-check all our arguments, since some users may instantiate Locker
@@ -215,10 +216,16 @@ module Que
             @connection.wrapped_connection.close
           end
         end
+
+      @pidfile = pidfile
+      at_exit { delete_pid }
+      write_pid
     end
 
     def stop!
-      stop; wait_for_stop
+      stop
+      wait_for_stop
+      delete_pid
     end
 
     def stop
@@ -512,5 +519,19 @@ module Que
         "Tried to lock a job that was already locked: #{id}"
       end
     end
+
+    def write_pid
+      return unless @pidfile
+
+      File.open(@pidfile, "w+") do |f|
+        f.write(Process.pid.to_s)
+      end
+    end
+
+    def delete_pid
+      return unless @pidfile
+
+      File.delete(@pidfile) if File.exist?(@pidfile)
+    end
   end
 end

data/lib/que/version.rb

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

data/lib/que/worker.rb

@@ -114,7 +114,7 @@ module Que
       if VALID_LOG_LEVELS.include?(log_level)
         log_message = {
           level: log_level,
-          job_id: metajob.id,
+          job: metajob.job,
           elapsed: elapsed,
         }
 
@@ -133,7 +133,7 @@ module Que
       Que.log(
         level: :debug,
         event: :job_errored,
-        job_id: metajob.id,
+        job: metajob.job,
         error: {
           class:   error.class.to_s,
           message: error.message,

data/lib/que.rb

@@ -80,7 +80,7 @@ module Que
     end
 
     def server?
-      defined?(Que::CommandLineInterface).nil?
+      !defined?(Que::CommandLineInterface).nil?
     end
 
     # Support simple integration with many common connection pools.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2024-08-20 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.4.10
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: A PostgreSQL-based Job Queue