que-unique 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35fee9d8dc2566367c0f06c98b1722091cf493b396e32207993fec7fdb30e0a0
+  data.tar.gz: 370ac9d00fa7553ff7e5aec3a7654eae9e15653260c45437cea23a021e22eac5
+SHA512:
+  metadata.gz: cb3fdd1122a99c323e48b4cd9e7fe6b0fd1a275df64b1e66f2035674875802d1f1c82d3e34d69b18b6e16b1225427246b475ca8f95273b295568c95f84b59f0f
+  data.tar.gz: bc174ee7bfa80ffc48c21b47de63db05ee2131278a507d0b477bd964511d92fba37769b5daa474557b1bfb52b7bc0b53381996e94dc62db5eeb53644ccf127af

data/lib/que/unique/constants.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Que
+  module Unique
+    THREAD_LOCAL_KEY = :que_unique_thread_local
+    THREAD_LOCAL_DEPTH_KEY = :que_unique_thread_local_depth
+  end
+end

data/lib/que/unique/transaction_class_methods.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "active_record"
+require_relative "constants"
+
+# This block adds the wrapping around all transactions to either start the thread local, or
+# increment it so we know how deep we are in the transaction nesting.
+module Que
+  module Unique
+    module TransactionClassMethods
+      def transaction_with_unique_que(*args, &block)
+        start_que_unique_handled_transaction
+        transaction_without_unique_que(*args, &block)
+      ensure
+        end_que_unique_handled_transaction
+      end
+
+      class << self
+        def extended(base)
+          base.class_eval do
+            class << self
+              alias_method :transaction_without_unique_que, :transaction
+              alias_method :transaction, :transaction_with_unique_que
+            end
+          end
+        end
+      end
+
+      private
+
+      def start_que_unique_handled_transaction
+        # Set the defaults for the thread local, then delegate to the real block.
+        Thread.current[Que::Unique::THREAD_LOCAL_KEY] ||= {}
+        # We keep track of the nested depth, so we know when to clear the array
+        Thread.current[Que::Unique::THREAD_LOCAL_DEPTH_KEY] ||= 0
+        # Now we know we are initialised, increment the transaction counter
+        Thread.current[Que::Unique::THREAD_LOCAL_DEPTH_KEY] += 1
+      end
+
+      def end_que_unique_handled_transaction
+        # Note the depth. When we are back to zero, assume all the Que jobs have been committed,
+        # so reset the hash.
+        Thread.current[Que::Unique::THREAD_LOCAL_DEPTH_KEY] -= 1
+        return unless Thread.current[Que::Unique::THREAD_LOCAL_DEPTH_KEY].zero?
+
+        Thread.current[Que::Unique::THREAD_LOCAL_KEY] = {}
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend Que::Unique::TransactionClassMethods

data/lib/que/unique/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Que
+  module Unique
+    VERSION = "0.1.0"
+  end
+end

data/lib/que/unique.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "que"
+require_relative "unique/version"
+require_relative "unique/constants"
+require_relative "unique/transaction_class_methods"
+
+# This block wraps the enqueue method of Que::Unique jobs.
+# For each json of args, we store in a hash.
+module Que
+  module Unique
+    extend ActiveSupport::Concern
+
+    included do
+      singleton_class.class_eval do
+        def enqueue_before_unique(*args)
+          thread_local_hash = Thread.current[Que::Unique::THREAD_LOCAL_KEY]
+          unless thread_local_hash
+            raise "UniqueQueJob #{self} being scheduled outside a transaction"
+          end
+
+          # Once the args are canonicalised, we convert it to a JSON string to match against.
+          canonicalised_args = args.map { |arg| Que::Unique.canonicalise_que_unique_arg(arg) }
+          args_key = { self => canonicalised_args }.to_json
+          # If this is already known then don't enqueue it again. Otherwise, add it to the last
+          # element of the array.
+          if thread_local_hash.key?(args_key)
+            ::Rails.logger.debug "Que::Unique - #{self} - Already scheduled: #{args_key}"
+          else
+            ::Rails.logger.debug "Que::Unique - #{self} - Enqueuing #{args_key}"
+            thread_local_hash[args_key] = true
+            enqueue_after_unique(*canonicalised_args)
+          end
+        end
+
+        alias_method :enqueue_after_unique, :enqueue
+        alias_method :enqueue, :enqueue_before_unique
+      end
+    end
+
+    class << self
+      def canonicalise_que_unique_arg(value)
+        case value
+        when Class
+          # When we try to enqueue a Class as an arg (very common), to_json chokes.
+          # We must convert it to a string manually.
+          value.to_s
+        when Hash
+          # Hashes are sorted by insertion order by default, so instead, create a new
+          # hash sorted by key/value pairs.
+          value.sort.to_h
+        else
+          value
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: que-unique
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bamboo Engineering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: que
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: que-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dev@bambooloans.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/que/unique.rb
+- lib/que/unique/constants.rb
+- lib/que/unique/transaction_class_methods.rb
+- lib/que/unique/version.rb
+homepage: https://github.com/bambooengineering/que-unique
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bambooengineering/que-unique
+  source_code_uri: https://github.com/bambooengineering/que-unique
+  changelog_uri: https://github.com/bambooengineering/que-unique/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.7
+signing_key: 
+specification_version: 4
+summary: A gem that removes duplicates when multiple copies of a que job are enqueued.
+test_files: []