que 1.3.0 → 2.0.0

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, job_schema_version)
+        (queue, priority, run_at, job_class, args, kwargs, data, job_schema_version)
         VALUES
         (
           coalesce($1, 'default')::text,
@@ -21,6 +21,7 @@ module Que
           $4::text,
           coalesce($5, '[]')::jsonb,
           coalesce($6, '{}')::jsonb,
+          coalesce($7, '{}')::jsonb,
           #{Que.job_schema_version}
         )
         RETURNING *
@@ -56,13 +57,10 @@ module Que
         :priority,
         :run_at
 
-      def enqueue(
-        *args,
-        job_options: {},
-        **arg_opts
-      )
-        arg_opts, job_options = _extract_job_options(arg_opts, job_options.dup)
-        args << arg_opts if arg_opts.any?
+      def enqueue(*args)
+        args, kwargs = Que.split_out_ruby2_keywords(args)
+
+        job_options = kwargs.delete(:job_options) || {}
 
         if job_options[:tags]
           if job_options[:tags].length > MAXIMUM_TAGS_COUNT
@@ -81,6 +79,7 @@ module Que
           priority: job_options[:priority] || resolve_que_setting(:priority),
           run_at:   job_options[:run_at]   || resolve_que_setting(:run_at),
           args:     Que.serialize_json(args),
+          kwargs:   Que.serialize_json(kwargs),
           data:     job_options[:tags] ? Que.serialize_json(tags: job_options[:tags]) : "{}",
           job_class: \
             job_options[:job_class] || name ||
@@ -89,27 +88,31 @@ module Que
 
         if attrs[:run_at].nil? && resolve_que_setting(:run_synchronously)
           attrs[:args] = Que.deserialize_json(attrs[:args])
+          attrs[:kwargs] = Que.deserialize_json(attrs[:kwargs])
           attrs[:data] = Que.deserialize_json(attrs[:data])
           _run_attrs(attrs)
         else
           values =
             Que.execute(
               :insert_job,
-              attrs.values_at(:queue, :priority, :run_at, :job_class, :args, :data),
+              attrs.values_at(:queue, :priority, :run_at, :job_class, :args, :kwargs, :data),
             ).first
-
           new(values)
         end
       end
+      ruby2_keywords(:enqueue) if respond_to?(:ruby2_keywords, true)
 
       def run(*args)
         # Make sure things behave the same as they would have with a round-trip
         # to the DB.
+        args, kwargs = Que.split_out_ruby2_keywords(args)
         args = Que.deserialize_json(Que.serialize_json(args))
+        kwargs = Que.deserialize_json(Que.serialize_json(kwargs))
 
         # Should not fail if there's no DB connection.
-        _run_attrs(args: args)
+        _run_attrs(args: args, kwargs: kwargs)
       end
+      ruby2_keywords(:run) if respond_to?(:ruby2_keywords, true)
 
       def resolve_que_setting(setting, *args)
         value = send(setting) if respond_to?(setting)
@@ -136,27 +139,6 @@ 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/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/job_methods.rb

@@ -39,12 +39,16 @@ module Que
     # Run the job with error handling and cleanup logic. Optionally support
     # overriding the args, because it's necessary when jobs are invoked from
     # ActiveJob.
-    def _run(args: nil, reraise_errors: false)
+    def _run(args: nil, kwargs: nil, reraise_errors: false)
       if args.nil? && que_target
         args = que_target.que_attrs.fetch(:args)
       end
 
-      run(*args)
+      if kwargs.nil? && que_target
+        kwargs = que_target.que_attrs.fetch(:kwargs)
+      end
+
+      run(*args, **kwargs)
       default_resolve_action if que_target && !que_target.que_resolved
     rescue => error
       raise error unless que_target

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/migrations/6/down.sql

@@ -0,0 +1,8 @@
+DROP INDEX que_jobs_kwargs_gin_idx;
+ALTER TABLE que_jobs DROP COLUMN kwargs;
+
+ALTER INDEX que_poll_idx RENAME TO que_poll_idx_with_job_schema_version;
+CREATE INDEX que_poll_idx ON que_jobs (queue, priority, run_at, id) WHERE (finished_at IS NULL AND expired_at IS NULL);
+
+ALTER TABLE que_jobs ALTER COLUMN job_schema_version SET DEFAULT 1;
+ALTER TABLE que_jobs ALTER COLUMN job_schema_version DROP NOT NULL;

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

@@ -0,0 +1,8 @@
+ALTER TABLE que_jobs ADD COLUMN kwargs JSONB NOT NULL DEFAULT '{}';
+CREATE INDEX que_jobs_kwargs_gin_idx ON que_jobs USING gin (kwargs jsonb_path_ops);
+
+DROP INDEX que_poll_idx;
+ALTER INDEX que_poll_idx_with_job_schema_version RENAME TO que_poll_idx;
+
+ALTER TABLE que_jobs ALTER COLUMN job_schema_version DROP DEFAULT;
+ALTER TABLE que_jobs ALTER COLUMN job_schema_version SET NOT NULL;

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 = 5
+    CURRENT_VERSION = 6
 
     class << self
       def migrate!(version:)

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/sequel/model.rb

@@ -40,8 +40,11 @@ module Que
           where(QUALIFIED_TABLE[:data].pg_jsonb.contains(JSON.dump(tags: [tag])))
         end
 
-        def by_args(*args)
-          where(QUALIFIED_TABLE[:args].pg_jsonb.contains(JSON.dump(args)))
+        def by_args(*args, **kwargs)
+          where(
+            QUALIFIED_TABLE[:args].pg_jsonb.contains(JSON.dump(args)) &
+            QUALIFIED_TABLE[:kwargs].pg_jsonb.contains(JSON.dump(kwargs))
+          ) 
         end
       end
     end

data/lib/que/utils/ruby2_keywords.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Temporary module allowing ruby2 keyword args to be extracted from an *args splat
+# Allows us to ensure consistent behaviour when running on ruby 2 vs ruby 3
+# We can remove this if/when we drop support for ruby 2
+
+require 'json'
+
+module Que
+  module Utils
+    module Ruby2Keywords
+      def split_out_ruby2_keywords(args)
+        return [args, {}] unless args.last&.is_a?(Hash) && Hash.ruby2_keywords_hash?(args.last)
+
+        [args[0..-2], args.last]
+      end
+    end
+  end
+end

data/lib/que/version.rb

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

data/lib/que/worker.rb

@@ -125,7 +125,7 @@ module Que
           log_message[:event] = :job_worked
         end
 
-        Que.log(log_message)
+        Que.log(**log_message)
       end
 
       instance

data/lib/que.rb

@@ -29,8 +29,11 @@ module Que
   require_relative 'que/utils/logging'
   require_relative 'que/utils/middleware'
   require_relative 'que/utils/queue_management'
+  require_relative 'que/utils/ruby2_keywords'
   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 +44,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
@@ -60,6 +62,7 @@ module Que
     include Utils::Logging
     include Utils::Middleware
     include Utils::QueueManagement
+    include Utils::Ruby2Keywords
     include Utils::Transactions
 
     extend Forwardable

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 = '>= 2.7.0'
+
   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: 2.0.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - Dockerfile
 - LICENSE.txt
@@ -71,6 +72,8 @@ files:
 - lib/que/migrations/4/up.sql
 - lib/que/migrations/5/down.sql
 - lib/que/migrations/5/up.sql
+- lib/que/migrations/6/down.sql
+- lib/que/migrations/6/up.sql
 - lib/que/poller.rb
 - lib/que/rails/railtie.rb
 - lib/que/result_queue.rb
@@ -84,6 +87,7 @@ files:
 - lib/que/utils/logging.rb
 - lib/que/utils/middleware.rb
 - lib/que/utils/queue_management.rb
+- lib/que/utils/ruby2_keywords.rb
 - lib/que/utils/transactions.rb
 - lib/que/version.rb
 - lib/que/worker.rb
@@ -102,14 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A PostgreSQL-based Job Queue