que-locks 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 809491912a7146d6ac1d4df762d88efb1e4bc9a1ae037769b937275fea35b502
-  data.tar.gz: b562eb878454d0a03939cbbcd3b81371478c7f36aea12c428a568da6ea23dc19
+  metadata.gz: 9d0ffcedfe00f4e3e4e6b609c345bfb8f5af2f13c31c7f21394e1e43c71458c1
+  data.tar.gz: 80c89326dfbab470400c543be8760e4966103d1d781602db4135e903f1a38234
 SHA512:
-  metadata.gz: 12a5d34c46c3eadd293885796eedc264b77c751cc5f31ec063e75a6a878f5ec7bec42c1716e51798db3006fa6be44419129e9421da1d012cd8aa1432e668fbb7
-  data.tar.gz: 63185315f4926d0d2226c0231e207c9c4417c443f56deac59dd771711a64c142cb1906cce1a8b898b8bc31902279d8f5cc34d4d213b592f5993f1ebc46d44ba7
+  metadata.gz: 4eedc15d8acf9d9a37cb0ccda407b26c2d7505f259ccabac9d469c9862070a90bd592dd2f6b9dca16fa51bc967077ce12319cf82924a713d2c700d253c8ddf5a
+  data.tar.gz: c4f436197a6546866b8b3d25441f5a548d007c1ae64c7adb218c9b95ea5792be4c68b88f4692cc862c4b32a2e8f56e30d26a4b87d23415b84c4e1755ac297367

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 group :development do
   gem "activerecord"
   gem "activejob"
+  gem "railties"
   gem "pg"
   gem "database_cleaner"
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    que-locks (0.3.0)
+    que-locks (0.4.0)
       neatjson (~> 0.9)
       que (~> 1.0)
       xxhash (~> 0.4)
@@ -9,42 +9,81 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (6.1.6.1)
-      activesupport (= 6.1.6.1)
+    actionpack (6.1.4.7)
+      actionview (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.4.7)
+      activesupport (= 6.1.4.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.7)
+      activesupport (= 6.1.4.7)
       globalid (>= 0.3.6)
-    activemodel (6.1.6.1)
-      activesupport (= 6.1.6.1)
-    activerecord (6.1.6.1)
-      activemodel (= 6.1.6.1)
-      activesupport (= 6.1.6.1)
-    activesupport (6.1.6.1)
+    activemodel (6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activerecord (6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activesupport (6.1.4.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
+    builder (3.2.4)
     byebug (11.1.3)
     concurrent-ruby (1.1.10)
+    crass (1.0.6)
     database_cleaner (2.0.1)
       database_cleaner-active_record (~> 2.0.0)
     database_cleaner-active_record (2.0.1)
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
+    erubi (1.10.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
     minitest (5.16.2)
     mocha (1.14.0)
     neatjson (0.9)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
     pg (1.4.2)
     que (1.4.1)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.1.1)
     rake (10.5.0)
     regexp_parser (2.5.0)
@@ -66,6 +105,7 @@ GEM
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     rufo (0.13.0)
+    thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
@@ -85,6 +125,7 @@ DEPENDENCIES
   mocha
   pg
   que-locks!
+  railties
   rake (~> 10.0)
   rubocop
   rubocop-performance

data/lib/que/locks/active_job_extensions.rb

@@ -0,0 +1,29 @@
+module Que::Locks
+  module ActiveJobExtensions
+    class ExclusiveJobWrapper < ::ActiveJob::QueueAdapters::QueAdapter::JobWrapper
+      # Opt into the locking functionality provided by que-locks
+      self.exclusive_execution_lock = true
+    end
+
+    def enqueue(job)
+      return super unless job.class.exclusive_execution_lock
+      do_enqueue job
+    end
+
+    def enqueue_at(job, timestamp)
+      return super unless job.class.exclusive_execution_lock
+      do_enqueue job, run_at: Time.at(timestamp)
+    end
+
+    def do_enqueue(job, **job_options)
+      job_options[:priority] = job.priority if job.respond_to? :priority
+      job_options[:queue] = job.queue_name if job.respond_to? :queue_name
+
+      que_job = ExclusiveJobWrapper.enqueue job.serialize, job_options: job_options
+      if que_job && job.respond_to?(:provider_job_id=)
+        job.provider_job_id = que_job.attrs["job_id"]
+      end
+      que_job
+    end
+  end
+end

data/lib/que/locks/execution_lock.rb

@@ -2,10 +2,14 @@ require "xxhash"
 
 module Que
   SQL[:args_already_enqueued] = %{
-    SELECT COUNT(*) FROM public.que_jobs WHERE job_class = $1 AND args = $2 AND finished_at IS NULL AND expired_at IS NULL;
+    SELECT COUNT(*) FROM public.que_jobs WHERE job_class = $1 AND args = $2 AND finished_at IS NULL AND expired_at IS NULL LIMIT 1;
   }
 
-  SQL[:try_aquire_execution_lock] = %{
+  SQL[:active_job_args_already_enqueued] = %{
+    SELECT COUNT(*) FROM public.que_jobs WHERE job_class = $1 AND args->0 @> $2 AND finished_at IS NULL AND expired_at IS NULL LIMIT 1;
+  }
+
+  SQL[:try_acquire_execution_lock] = %{
     SELECT pg_try_advisory_lock(42, $1) AS locked
   }
 
@@ -16,19 +20,25 @@ module Que
   module Locks::ExecutionLock
     class << self
       def already_enqueued_job_wanting_lock?(klass, args)
+        query = :args_already_enqueued
+        if active_job_class?(klass)
+          args = active_jobless_args(args)
+          query = :active_job_args_already_enqueued
+        end
+
         args_string = Que.serialize_json(args)
-        values = Que.execute(:args_already_enqueued, [klass.name, args_string]).first
+        values = Que.execute(query, [klass.name, args_string]).first
         values[:count] != 0
       end
 
-      def can_aquire?(klass, args)
-        can_aquire_key?(lock_key(klass, args))
+      def can_acquire?(klass, args)
+        can_acquire_key?(lock_key(klass, args))
       end
 
-      def can_aquire_key?(key)
+      def can_acquire_key?(key)
         result = false
         begin
-          result = aquire!(key)
+          result = acquire!(key)
         ensure
           if result
             release!(key)
@@ -38,17 +48,43 @@ module Que
       end
 
       def lock_key(klass, args)
+        if active_job_class?(klass)
+          args = active_jobless_args(args)
+        end
         XXhash.xxh32(klass.name + ":" + Que.serialize_json(args), 42) / 2
       end
 
-      def aquire!(key)
-        result = Que.execute(:try_aquire_execution_lock, [key]).first
+      def acquire!(key)
+        result = Que.execute(:try_acquire_execution_lock, [key]).first
         result[:locked]
       end
 
       def release!(key)
         Que.execute(:release_execution_lock, [key])
       end
+
+      private
+
+      def active_job_class?(klass)
+        if Object.const_defined?("ActiveJob::QueueAdapters::QueAdapter::JobWrapper")
+          return klass.ancestors.include? ::ActiveJob::QueueAdapters::QueAdapter::JobWrapper
+        end
+        false
+      end
+
+      def active_jobless_args(args)
+        # ActiveJob handles its own arguments, and thus comes in as one argument:
+        # a single serialized hash representing the job. We want to use this hash
+        # to check and see if we already have an equivalent job queued up, but that
+        # requires us to toss out irrelevant ActiveJob-specific parameters that will
+        # throw our check off. There are enough of these
+        # (see ActiveJob::Core#serialize) that it's easier to maintain a whitelist;
+        # toss everything else.
+        hash = args.first
+        okay_keys = ["job_class", "arguments"]
+        # Careful, this is a shallow copy, don't actually modify that hash
+        hash.reject { |key| !okay_keys.include?(key) }
+      end
     end
   end
 end

data/lib/que/locks/job_extensions.rb

@@ -6,7 +6,7 @@ module Que::Locks
       args << kwargs if kwargs.any?
       return true unless self.exclusive_execution_lock
       return false if Que::Locks::ExecutionLock.already_enqueued_job_wanting_lock?(self, args)
-      return Que::Locks::ExecutionLock.can_aquire?(self, args)
+      return Que::Locks::ExecutionLock.can_acquire?(self, args)
     end
 
     def enqueue(*args, queue: nil, priority: nil, run_at: nil, job_class: nil, tags: nil, job_options: {}, **kwargs)
@@ -25,12 +25,16 @@ module Que::Locks
 
         if Que::Locks::ExecutionLock.already_enqueued_job_wanting_lock?(self, args_list)
           Que.log(level: :info, event: :skipped_enqueue_due_to_preemptive_lock_check, args: args_list)
-        else
-          super(*args, **forwardable_kwargs)
+          # This technically breaks API compatibility with que, which always
+          # returns a job. It could be argued that we should return the
+          # already-enqueued job, but then we'd lose the ability to signal to
+          # the caller that a job wasn't actually enqueued. Let's see how
+          # far we can get with this.
+          return
         end
-      else
-        super(*args, **forwardable_kwargs)
       end
+
+      super(*args, **forwardable_kwargs)
     end
   end
 end

data/lib/que/locks/lock_middleware.rb

@@ -3,7 +3,7 @@ module Que::Locks
     if job.class.exclusive_execution_lock
       args = job.que_attrs[:args]
       lock_key = ExecutionLock.lock_key(job.class, args)
-      if ExecutionLock.aquire!(lock_key)
+      if ExecutionLock.acquire!(lock_key)
         begin
           block.call
         ensure

data/lib/que/locks/railtie.rb

@@ -0,0 +1,13 @@
+module Que::Locks
+  class Railtie < Rails::Railtie
+    initializer "que-locks.patch_active_job" do
+      ActiveSupport.on_load(:active_job) do
+        class_attribute :exclusive_execution_lock
+
+        require_relative "active_job_extensions"
+        ActiveJob::QueueAdapters::QueAdapter.prepend(Que::Locks::ActiveJobExtensions)
+        ActiveJob::QueueAdapters::QueAdapter.singleton_class.prepend(Que::Locks::ActiveJobExtensions) # for rails 4
+      end
+    end
+  end
+end

data/lib/que/locks/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Locks
-    VERSION = "0.3.0".freeze
+    VERSION = "0.4.0".freeze
   end
 end

data/lib/que/locks.rb

@@ -1,8 +1,10 @@
+require "que"
 require "que/locks/version"
 require "que/locks/execution_lock"
 require "que/locks/json_extensions"
 require "que/locks/job_extensions"
 require "que/locks/lock_middleware"
+require "que/locks/railtie" if defined?(Rails::Railtie)
 
 module Que
   module Locks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-locks
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Harry Brundage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,10 +103,12 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/que/locks.rb
+- lib/que/locks/active_job_extensions.rb
 - lib/que/locks/execution_lock.rb
 - lib/que/locks/job_extensions.rb
 - lib/que/locks/json_extensions.rb
 - lib/que/locks/lock_middleware.rb
+- lib/que/locks/railtie.rb
 - lib/que/locks/version.rb
 - que-locks.gemspec
 homepage: https://github.com/superpro-inc/que-locks