sidekiq-dup-guard 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc503b1844bd20c32c69b767aaa974b6afd66d730e118736c1b0f0d95148f730
+  data.tar.gz: 1dd020d8cd934a58d39284af4e410e6fed5a2f37cad1344c5b8fc84394d4474f
+SHA512:
+  metadata.gz: eee95aac75f2f4b96de311f13d2ea20ff84aecca3a39fa31d9e7d579c907debe58f732df0ff0b488036599a0f6a479beb3a76a5235481fa63032882502196869
+  data.tar.gz: bafc054d73461aa5fa63f8b3298297584dea5383f88c1662a7bc6eddcef5de6464a8a4e0697b4c49fb2f4308c74e6a569d7cafa7ef7aa2c3e4c5b09e72ee3848

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.1
+
+* Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Amagi Media Private Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# sidekiq-dup-guard
+
+This gem provides a Sidekiq middleware to prevent duplicate jobs from getting enqueued.
+Uniqueness can be configured at worker level or at function level.
+
+## Installation
+
+Include the gem in your Application Gemfile:
+
+```ruby
+gem 'sidekiq-dup-guard'
+```
+and then execute
+
+```bash
+$ bundle install
+```
+
+## Configuring at Function level
+
+At a time there can be only one job in queue with same arguments for the method's configured in `dup_guard_methods`.
+
+### Worker Example
+
+```ruby
+class FooWorker
+  include Sidekiq::Workers
+
+  # Only method1 and method3 should have unique jobs
+  sidekiq_options :queue => :foo, :dup_guard_methods => ['method1', 'method3']
+
+  def perform(args)
+    # Do work
+  end
+
+  def method1(args)
+    # Do work
+  end
+
+  def method2(args)
+    # Do work
+  end
+
+  def method3(args)
+    # Do work
+  end
+end
+```
+
+This will ensure duplicate job's are not enqueued to queue from `FooWorker.perform_async` until `FooWorker.new.perform` is called for `method1` and `method3`. If a job is already present for `method1` and `method3` with same arguments then Sidekiq job will not be enqueued.
+
+## Configuring at Worker Level
+
+At a time there can be only one job in queue with same arguments for all the method's of a Worker.
+
+### Worker Example
+
+```ruby
+class FooWorker
+  include Sidekiq::Workers
+
+  # All the methods of FooWorker should have unique jobs
+  sidekiq_options :queue => :foo, :dup_guard_methods => 'all'
+
+  def perform(args)
+    # Do work
+  end
+end
+```
+
+This will ensure duplicate job are not enqueued to queue from `FooWorker.perform_async` until `FooWorker.new.perform` is called for all functions of `FooWorker`. If a job is already present for a method with same arguments then Sidekiq job will not be enqueued.

data/lib/sidekiq-dup-guard/middleware.rb

@@ -0,0 +1,17 @@
+# Configure Sidekiq Middleware
+
+# Sidekiq Wiki for more info: https://github.com/mperham/sidekiq/wiki/Middleware
+
+# :nocov:
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add SidekiqDupGuard::SidekiqUniqueJobFilter
+  end
+end
+# :nocov:
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add SidekiqDupGuard::SidekiqUniqueJobFilter
+  end
+end

data/lib/sidekiq-dup-guard/sidekiq_unique_job_filter.rb

@@ -0,0 +1,59 @@
+
+# Before job is enqueued this middleware will be called.
+module SidekiqDupGuard
+  class SidekiqUniqueJobFilter
+
+    # get Sidekiq logger
+    def logger
+      Sidekiq.logger
+    end
+
+    ##
+    # checks if Sidekiq Job is already present in queue
+    #
+    #   - If job is already present in queue with same arguments then Sidekiq job will be ignored
+    #   - If job is not present with similar arguments then Sidekiq job will be queued
+    #
+    # @param worker [String]: Worker class name
+    # @param item [Hash]: Args passed to create a SidekiqJob
+    #   - item["dup_guard_methods"]: *all* --: All jobs enqueued to all the function of a worker should be unique
+    #   - item["dup_guard_methods"]: [array of method names] --: All jobs enqueued to a method should be unique
+    # @param queue [String]:  queue name
+    # @param redis_pool [ConnectionPool]: Redis connection pool
+    #
+    # @return nil
+    #
+
+    def call(worker, item, queue, redis_pool)
+      if (item["dup_guard_methods"] != nil) and !item["dup_guard_methods"].empty? and (item["dup_guard_methods"] == "all" or item["dup_guard_methods"].include?(item["args"][0]))
+        jid = get_sidekiq_job(queue, item["args"][0], item["args"][1])
+        unless (jid == nil)
+          logger.info("SidekiqDupGuard: #{item["class"]}##{item["args"][0]} '#{item["args"][1]}' job already exists in queue with JID #{jid}, skipping enqueue.")
+          return
+        end
+      end
+
+      yield
+    end
+
+    ##
+    # checks if Sidekiq job is present
+    #
+    # @param [String] queue
+    # @param [String] method
+    # @param [Hash] args
+    #
+    # @return [String] sidekiq job ID
+    #
+    def get_sidekiq_job(queue, method, args)
+      q = Sidekiq::Queue.new(queue)
+      args.transform_keys!(&:to_s)
+      q.each do |j|
+        if (j.args[0] == method.to_s) and (j.args[1] == args)
+          return j.jid
+        end
+      end
+      return nil
+    end
+  end
+end

data/lib/sidekiq-dup-guard/version.rb

@@ -0,0 +1,5 @@
+# Gem Version
+
+module SidekiqDupGuard
+  VERSION = "1.0.1"
+end

data/lib/sidekiq-dup-guard.rb

@@ -0,0 +1,4 @@
+require 'sidekiq'
+
+require 'sidekiq-dup-guard/sidekiq_unique_job_filter'
+require 'sidekiq-dup-guard/middleware'

data/sidekiq-dup-guard.gemspec

@@ -0,0 +1,17 @@
+require_relative "lib/sidekiq-dup-guard/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = 'sidekiq-dup-guard'
+  spec.version     = SidekiqDupGuard::VERSION
+  spec.summary     = "Sidekiq middleware to prevent enqueue of duplicate jobs"
+  spec.description = <<-EOS
+    This gem provides a Sidekiq middleware to prevent duplicate jobs from getting enqueued to the queue.
+  EOS
+  spec.authors     = ["Sowmya S K"]
+  spec.email       = ['cloudport.team@amagi.com']
+  spec.homepage    = "https://github.com/amagimedia/sidekiq-dup-guard"
+  spec.license     = "MIT"
+  spec.files       = ["sidekiq-dup-guard.gemspec", "README.md", "CHANGELOG.md", "LICENSE"] + `git ls-files | grep -E '^(lib)'`.split("\n")
+
+  spec.add_dependency 'sidekiq'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-dup-guard
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sowmya S K
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    This gem provides a Sidekiq middleware to prevent duplicate jobs
+  from getting enqueued to the queue.\n"
+email:
+- cloudport.team@amagi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sidekiq-dup-guard.rb
+- lib/sidekiq-dup-guard/middleware.rb
+- lib/sidekiq-dup-guard/sidekiq_unique_job_filter.rb
+- lib/sidekiq-dup-guard/version.rb
+- sidekiq-dup-guard.gemspec
+homepage: https://github.com/amagimedia/sidekiq-dup-guard
+licenses:
+- MIT
+metadata: {}
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Sidekiq middleware to prevent enqueue of duplicate jobs
+test_files: []