que 1.3.0 → 1.4.1

data/README.md

@@ -23,7 +23,7 @@ Que's secondary goal is performance. The worker process is multithreaded, so tha
 
 Compatibility:
 
-- MRI Ruby 2.2+
+- MRI Ruby 2.2+, < 3 (for Ruby 3, Que 2+ is required)
 - PostgreSQL 9.5+
 - Rails 4.1+ (optional)
 

data/bin/command_line_interface.rb

@@ -138,10 +138,9 @@ module Que
             opts.on(
               '--minimum-buffer-size [SIZE]',
               Integer,
-              "Set minimum number of jobs to be locked and held in this " \
-                "process awaiting a worker (default: 2)",
+              "Unused (deprecated)",
             ) do |s|
-              options[:minimum_buffer_size] = s
+              warn "The --minimum-buffer-size SIZE option has been deprecated and will be removed in v2.0 (it's actually been unused since v1.0.0.beta4)"
             end
 
             opts.on(
@@ -236,7 +235,7 @@ OUTPUT
           <<~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}
+              Buffer size: #{locker.job_buffer.maximum_size}
               Queues:
             #{locker.queues.map { |queue, interval| "    - #{queue} (poll interval: #{interval}s)" }.join("\n")}
             Que waiting for jobs...

data/docs/README.md

@@ -4,7 +4,7 @@ Docs Index
 - [Command Line Interface](#command-line-interface)
   * [worker-priorities and worker-count](#worker-priorities-and-worker-count)
   * [poll-interval](#poll-interval)
-  * [minimum-buffer-size and maximum-buffer-size](#minimum-buffer-size-and-maximum-buffer-size)
+  * [maximum-buffer-size](#maximum-buffer-size)
   * [connection-url](#connection-url)
   * [wait-period](#wait-period)
   * [log-internals](#log-internals)
@@ -62,7 +62,6 @@ usage: que [options] [file/to/require] ...
         --connection-url [URL]       Set a custom database url to connect to for locking purposes.
         --log-internals              Log verbosely about Que's internal state. Only recommended for debugging issues
         --maximum-buffer-size [SIZE] Set maximum number of jobs to be locked and held in this process awaiting a worker (default: 8)
-        --minimum-buffer-size [SIZE] Set minimum number of jobs to be locked and held in this process awaiting a worker (default: 2)
         --wait-period [PERIOD]       Set maximum interval between checks of the in-memory job queue, in milliseconds (default: 50)
 ```
 
@@ -82,9 +81,9 @@ If you pass both worker-count and worker-priorities, the count will trim or pad
 
 This option sets the number of seconds the process will wait between polls of the job queue. Jobs that are ready to be worked immediately will be broadcast via the LISTEN/NOTIFY system, so polling is unnecessary for them - polling is only necessary for jobs that are scheduled in the future or which are being delayed due to errors. The default is 5 seconds.
 
-### minimum-buffer-size and maximum-buffer-size
+### maximum-buffer-size
 
-These options set the size of the internal buffer that Que uses to hold jobs until they're ready for workers. The default minimum is 2 and the maximum is 8, meaning that the process won't buffer more than 8 jobs that aren't yet ready to be worked, and will only resort to polling if the buffer dips below 2. If you don't want jobs to be buffered at all, you can set both of these values to zero.
+This option sets the size of the internal buffer that Que uses to hold jobs until they're ready for workers. The default maximum is 8, meaning that the process won't buffer more than 8 jobs that aren't yet ready to be worked. If you don't want jobs to be buffered at all, you can set this value to zero.
 
 ### connection-url
 

data/lib/que/job_buffer.rb

@@ -6,7 +6,7 @@
 
 module Que
   class JobBuffer
-    attr_reader :maximum_size, :minimum_size, :priority_queues
+    attr_reader :maximum_size, :priority_queues
 
     # Since we use a mutex, which is not reentrant, we have to be a little
     # careful to not call a method that locks the mutex when we've already
@@ -17,20 +17,11 @@ module Que
 
     def initialize(
       maximum_size:,
-      minimum_size:,
       priorities:
     )
       @maximum_size = Que.assert(Integer, maximum_size)
       Que.assert(maximum_size >= 0) { "maximum_size for a JobBuffer must be at least zero!" }
 
-      @minimum_size = Que.assert(Integer, minimum_size)
-      Que.assert(minimum_size >= 0) { "minimum_size for a JobBuffer must be at least zero!" }
-
-      Que.assert(minimum_size <= maximum_size) do
-        "minimum buffer size (#{minimum_size}) is " \
-          "greater than the maximum buffer size (#{maximum_size})!"
-      end
-
       @stop  = false
       @array = []
       @mutex = Mutex.new

data/lib/que/locker.rb

@@ -45,7 +45,6 @@ module Que
 
     DEFAULT_POLL_INTERVAL       = 5.0
     DEFAULT_WAIT_PERIOD         = 50
-    DEFAULT_MINIMUM_BUFFER_SIZE = 2
     DEFAULT_MAXIMUM_BUFFER_SIZE = 8
     DEFAULT_WORKER_PRIORITIES   = [10, 30, 50, nil, nil, nil].freeze
 
@@ -57,7 +56,6 @@ module Que
       poll_interval:       DEFAULT_POLL_INTERVAL,
       wait_period:         DEFAULT_WAIT_PERIOD,
       maximum_buffer_size: DEFAULT_MAXIMUM_BUFFER_SIZE,
-      minimum_buffer_size: DEFAULT_MINIMUM_BUFFER_SIZE,
       worker_priorities:   DEFAULT_WORKER_PRIORITIES,
       on_worker_start:     nil
     )
@@ -77,7 +75,6 @@ module Que
       # ResultQueue to receive messages from workers.
       @job_buffer = JobBuffer.new(
         maximum_size: maximum_buffer_size,
-        minimum_size: minimum_buffer_size,
         priorities:   worker_priorities.uniq,
       )
 
@@ -93,7 +90,6 @@ module Que
           poll_interval:       poll_interval,
           wait_period:         wait_period,
           maximum_buffer_size: maximum_buffer_size,
-          minimum_buffer_size: minimum_buffer_size,
           worker_priorities:   worker_priorities,
         }
       end

data/lib/que/poller.rb

@@ -146,8 +146,6 @@ module Que
 
       return unless should_poll?
 
-      expected_count = priorities.inject(0){|s,(_,c)| s + c}
-
       jobs =
         connection.execute_prepared(
           :poll_jobs,
@@ -159,7 +157,7 @@ module Que
         )
 
       @last_polled_at      = Time.now
-      @last_poll_satisfied = expected_count == jobs.count
+      @last_poll_satisfied = poll_satisfied?(priorities, jobs)
 
       Que.internal_log :poller_polled, self do
         {
@@ -265,5 +263,12 @@ module Que
         SQL
       end
     end
+
+    private
+
+    def poll_satisfied?(priorities, jobs)
+      lowest_priority = priorities.keys.max
+      jobs.count >= priorities[lowest_priority]
+    end
   end
 end

data/lib/que/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Que
-  VERSION = '1.3.0'
+  VERSION = '1.4.1'
 
   def self.job_schema_version
     1

data/lib/que.rb

@@ -31,6 +31,8 @@ module Que
   require_relative 'que/utils/queue_management'
   require_relative 'que/utils/transactions'
 
+  require_relative 'que/version'
+
   require_relative 'que/connection'
   require_relative 'que/connection_pool'
   require_relative 'que/job_methods'
@@ -41,7 +43,6 @@ module Que
   require_relative 'que/migrations'
   require_relative 'que/poller'
   require_relative 'que/result_queue'
-  require_relative 'que/version'
   require_relative 'que/worker'
 
   class << self

data/que.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/que-rb/que'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '< 3'
+
   files_to_exclude = [
     /\A\.circleci/,
     /\AGemfile/,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,16 +100,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A PostgreSQL-based Job Queue