sidekiq_unique_retries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6577679bf6a5b58b52e3e632538c8facc8508423
+  data.tar.gz: b0a56f52bca88b9dd8970284575dbb803521a9ed
+SHA512:
+  metadata.gz: e0886eb08c1f1de23a4afaff414ef409e688305e264ad78a62855476ce0f36e996b6ed064ecdeae4f969818f2aba4f4ee65da5280d1cd0458946f2c93b595af5
+  data.tar.gz: c47f7c0a862c39a336480c1bf86626eeef319749f009a6bed789174f4a5bd0b1adb9fe9303f7c311c84d29064cd9af331f65a9e11efe9c2646dda12c04556fbe

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 2.4.1
+cache: bundler
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'redis-namespace'

data/README.md

@@ -0,0 +1,31 @@
+# Unique Retries for Sidekiq [![Build Status](https://travis-ci.org/railsware/sidekiq_unique_retries.svg?branch=master)](https://travis-ci.org/railsware/sidekiq_unique_retries)
+
+This is extension for sidekiq that allows to have unique retries for your unique jobs.
+It should work for any sidekiq unique job extension if it guarantees that only one unique job can be performing at the same time.
+Currently this gem supports SidekiqUniqueJobs extension but you may wrote own adapter.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq_unique_retries'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_unique_retries
+
+## Authors
+
+* [Andriy Yanko](http://ayanko.github.io)
+
+## References
+
+* https://github.com/mperham/sidekiq
+* https://github.com/mhenrixon/sidekiq-unique-jobs

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq_unique_retries"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq_unique_retries.rb

@@ -0,0 +1,51 @@
+require 'sidekiq_unique_retries/lock'
+require 'sidekiq_unique_retries/extensions/api'
+require 'sidekiq_unique_retries/extensions/job_retry'
+
+module SidekiqUniqueRetries
+
+  class << self
+    attr_reader :adapter
+
+    def adapter=(name)
+      @adapter = adapter_for(name)
+    end
+
+    def lockable?(item)
+      adapter.lockable?(item)
+    end
+
+    def lock(item)
+      Lock.new(item, adapter).acquire
+    end
+
+    def unlock(item)
+      Lock.new(item, adapter).release
+    end
+
+    private
+
+    def adapter_for(object)
+      case object
+      when Symbol
+        load_adapter(object)
+        build_adapter(object)
+      else
+        object
+      end
+    end
+
+    def load_adapter(name)
+      require "sidekiq_unique_retries/adapters/#{name}"
+    end
+
+    def build_adapter(name)
+      class_name = name.to_s.split('_').map(&:capitalize).join
+      klass = self::Adapters.const_get(class_name, false)
+      klass.new
+    end
+  end
+
+  self.adapter = :sidekiq_unique_jobs
+
+end

data/lib/sidekiq_unique_retries/adapters/sidekiq_unique_jobs.rb

@@ -0,0 +1,22 @@
+module SidekiqUniqueRetries
+  module Adapters
+    class SidekiqUniqueJobs
+
+      JOB_ID_KEY = 'jid'.freeze
+      UNIQUE_DIGEST_KEY = 'unique_digest'.freeze
+
+      def lockable?(item)
+        item.key?(UNIQUE_DIGEST_KEY)
+      end
+
+      def job_id(item)
+        item.fetch(JOB_ID_KEY)
+      end
+
+      def unique_digest(item)
+        item.fetch(UNIQUE_DIGEST_KEY)
+      end
+
+    end
+  end
+end

data/lib/sidekiq_unique_retries/extensions/api.rb

@@ -0,0 +1,35 @@
+require 'sidekiq/api'
+
+module SidekiqUniqueRetries
+  module Extensions
+    module SortedEntry
+
+      def delete
+        if SidekiqUniqueRetries.lockable?(item)
+          SidekiqUniqueRetries.unlock(item)
+        end
+
+        super
+      end
+
+      def retry
+        if SidekiqUniqueRetries.lockable?(item)
+          SidekiqUniqueRetries.unlock(item)
+        end
+
+        super
+      end
+
+      def kill
+        if SidekiqUniqueRetries.lockable?(item)
+          SidekiqUniqueRetries.unlock(item)
+        end
+
+        super
+      end
+
+    end
+  end
+end
+
+Sidekiq::SortedEntry.prepend SidekiqUniqueRetries::Extensions::SortedEntry

data/lib/sidekiq_unique_retries/extensions/job_retry.rb

@@ -0,0 +1,27 @@
+require 'sidekiq/job_retry'
+
+module SidekiqUniqueRetries
+  module Extensions
+    module JobRetry
+
+      def attempt_retry(worker, msg, queue, exception)
+        if SidekiqUniqueRetries.lockable?(msg)
+          raise exception unless SidekiqUniqueRetries.lock(msg)
+        end
+
+        super(worker, msg, queue, exception)
+      end
+
+      def retries_exhausted(worker, msg, exception)
+        if SidekiqUniqueRetries.lockable?(msg)
+          SidekiqUniqueRetries.unlock(msg)
+        end
+
+        super(worker, msg, exception)
+      end
+
+    end
+  end
+end
+
+Sidekiq::JobRetry.prepend SidekiqUniqueRetries::Extensions::JobRetry

data/lib/sidekiq_unique_retries/lock.rb

@@ -0,0 +1,52 @@
+module SidekiqUniqueRetries
+  class Lock
+
+    HASH_KEY = 'uniqueretries'.freeze
+
+    attr_reader \
+      :job_id,
+      :unique_digest
+
+    def initialize(item, adapter)
+      @job_id = adapter.job_id(item)
+      @unique_digest = adapter.unique_digest(item)
+    end
+
+    def acquire
+      lock_id = get_lock
+
+      if lock_id
+        job_id == lock_id
+      else
+        set_lock(job_id)
+        true
+      end
+    end
+
+    def release
+      remove_lock
+      true
+    end
+
+    private
+
+    def get_lock
+      Sidekiq.redis do |conn|
+        conn.hget HASH_KEY, unique_digest
+      end
+    end
+
+    def set_lock(value)
+      Sidekiq.redis do |conn|
+        conn.hset HASH_KEY, unique_digest, value
+      end
+    end
+
+    def remove_lock
+      Sidekiq.redis do |conn|
+        conn.hdel HASH_KEY, unique_digest
+      end
+    end
+  end
+
+end

data/sidekiq_unique_retries.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_unique_retries"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Andriy Yanko"]
+  spec.email         = ["andriy.yanko@railsware.com"]
+
+  spec.summary       = %q{Uniqueness for Sidekiq Retries}
+  spec.homepage      = "https://github.com/railsware/sidekiq_unique_retries"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", ">= 5.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_unique_retries
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andriy Yanko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- andriy.yanko@railsware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq_unique_retries.rb
+- lib/sidekiq_unique_retries/adapters/sidekiq_unique_jobs.rb
+- lib/sidekiq_unique_retries/extensions/api.rb
+- lib/sidekiq_unique_retries/extensions/job_retry.rb
+- lib/sidekiq_unique_retries/lock.rb
+- sidekiq_unique_retries.gemspec
+homepage: https://github.com/railsware/sidekiq_unique_retries
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Uniqueness for Sidekiq Retries
+test_files: []
+has_rdoc: