sidekiq-unique-jobs 4.0.18 → 7.1.28

data/lib/sidekiq_unique_jobs/scripts.rb

@@ -1,49 +0,0 @@
-require 'pathname'
-require 'digest/sha1'
-
-module SidekiqUniqueJobs
-  ScriptError = Class.new(StandardError)
-
-  module Scripts
-    LUA_PATHNAME ||= Pathname.new(__FILE__).dirname.join('../../redis').freeze
-    SOURCE_FILES ||= Dir[LUA_PATHNAME.join('**/*.lua')].compact.freeze
-    DEFINED_METHODS ||= [].freeze
-
-    module_function
-
-    extend SingleForwardable
-    def_delegator :SidekiqUniqueJobs, :connection
-
-    def script_shas
-      @script_shas ||= {}
-    end
-
-    def logger
-      Sidekiq.logger
-    end
-
-    def call(file_name, redis_pool, options = {})
-      connection(redis_pool) do |redis|
-        script_shas[file_name] ||= redis.script(:load, script_source(file_name))
-        redis.evalsha(script_shas[file_name], options)
-      end
-    rescue Redis::CommandError => ex
-      if ex.message == 'NOSCRIPT No matching script. Please use EVAL.'
-        script_shas[file_name] = nil
-        call(file_name, redis_pool, options)
-      else
-        raise ScriptError,
-              "#{file_name}.lua\n\n#{ex.message}\n\n#{script_source(file_name)}" \
-              "#{ex.backtrace.join("\n")}"
-      end
-    end
-
-    def script_source(file_name)
-      script_path(file_name).read
-    end
-
-    def script_path(file_name)
-      LUA_PATHNAME.join("#{file_name}.lua")
-    end
-  end
-end

data/lib/sidekiq_unique_jobs/server/middleware.rb

@@ -1,34 +0,0 @@
-module SidekiqUniqueJobs
-  module Server
-    class Middleware
-      extend Forwardable
-      def_delegators :Sidekiq, :logger
-      def_instance_delegator :@worker, :class, :worker_class
-
-      include OptionsWithFallback
-
-      def call(worker, item, queue, redis_pool = nil, &blk)
-        @worker = worker
-        @redis_pool = redis_pool
-        @queue = queue
-        @item = item
-        return yield unless unique_enabled?
-        lock.send(:execute, after_unlock_hook, &blk)
-      end
-
-      private
-
-      attr_reader :redis_pool, :worker, :item
-
-      protected
-
-      def after_unlock_hook
-        -> { worker.after_unlock if worker.respond_to?(:after_unlock) }
-      end
-
-      def reschedule
-        Sidekiq::Client.new(redis_pool).raw_push([item])
-      end
-    end
-  end
-end

data/lib/sidekiq_unique_jobs/testing/sidekiq_overrides.rb

@@ -1,70 +0,0 @@
-require 'sidekiq/testing'
-
-module Sidekiq
-  module Worker
-    module ClassMethods
-      # Drain and run all jobs for this worker
-      def drain
-        while (job = jobs.shift)
-          worker = new
-          worker.jid = job['jid']
-          worker.bid = job['bid'] if worker.respond_to?(:bid=)
-          execute_job(worker, job['args'])
-          unlock(job) if Sidekiq::Testing.fake?
-        end
-      end unless Sidekiq::Testing.respond_to?(:server_middleware)
-
-      # Pop out a single job and perform it
-      def perform_one
-        raise(EmptyQueueError, 'perform_one called with empty job queue') if jobs.empty?
-        job = jobs.shift
-        worker = new
-        worker.jid = job['jid']
-        worker.bid = job['bid'] if worker.respond_to?(:bid=)
-        execute_job(worker, job['args'])
-        unlock(job) if Sidekiq::Testing.fake?
-      end unless Sidekiq::Testing.respond_to?(:server_middleware)
-
-      # Clear all jobs for this worker
-      def clear
-        jobs.each do |job|
-          unlock(job) if Sidekiq::Testing.fake?
-        end
-        # if Sidekiq::VERSION >= '4'
-        #   Queues.jobs[queue].clear
-        # else
-        jobs.clear
-        # end
-      end
-
-      def execute_job(worker, args)
-        worker.perform(*args)
-      end unless respond_to?(:execute_job)
-
-      def unlock(job)
-        SidekiqUniqueJobs::Unlockable.unlock(job)
-      end
-    end
-
-    module Overrides
-      def self.included(base)
-        base.extend Testing
-        base.class_eval do
-          class << self
-            alias_method :clear_all_orig, :clear_all
-            alias_method :clear_all, :clear_all_ext
-          end
-        end
-      end
-
-      module Testing
-        def clear_all_ext
-          SidekiqUniqueJobs::Util.del('*', 1000, false) unless SidekiqUniqueJobs.mocked?
-          clear_all_orig
-        end
-      end
-    end
-
-    include Overrides
-  end
-end

data/lib/sidekiq_unique_jobs/timeout_calculator.rb

@@ -1,65 +0,0 @@
-module SidekiqUniqueJobs
-  class TimeoutCalculator
-    def self.for_item(item)
-      new(item)
-    end
-
-    def initialize(item)
-      @item = item
-    end
-
-    def time_until_scheduled
-      scheduled = item[AT_KEY]
-      return 0 unless scheduled
-      (Time.at(scheduled) - Time.now.utc).to_i
-    end
-
-    def seconds
-      raise NotImplementedError
-    end
-
-    def worker_class_queue_lock_expiration
-      worker_class_expiration_for QUEUE_LOCK_TIMEOUT_KEY
-    end
-
-    def worker_class_run_lock_expiration
-      worker_class_expiration_for RUN_LOCK_TIMEOUT_KEY
-    end
-
-    def worker_class
-      @worker_class ||= SidekiqUniqueJobs.worker_class_constantize(item[CLASS_KEY])
-    end
-
-    private
-
-    def worker_class_expiration_for(key)
-      return unless worker_class.respond_to?(:get_sidekiq_options)
-      worker_class.get_sidekiq_options[key]
-    end
-
-    attr_reader :item
-  end
-
-  class RunLockTimeoutCalculator < TimeoutCalculator
-    def seconds
-      @seconds ||= (
-        worker_class_run_lock_expiration ||
-        SidekiqUniqueJobs.config.default_run_lock_expiration
-      ).to_i
-    end
-  end
-
-  class QueueLockTimeoutCalculator < TimeoutCalculator
-    def seconds
-      queue_lock_expiration + time_until_scheduled
-    end
-
-    def queue_lock_expiration
-      @queue_lock_expiration ||=
-        (
-          worker_class_queue_lock_expiration ||
-          SidekiqUniqueJobs.config.default_queue_lock_expiration
-        ).to_i
-    end
-  end
-end

data/lib/sidekiq_unique_jobs/unique_args.rb

@@ -1,134 +0,0 @@
-require 'digest'
-require 'sidekiq_unique_jobs/normalizer'
-
-module SidekiqUniqueJobs
-  # This class exists to be testable and the entire api should be considered private
-  # rubocop:disable ClassLength
-  class UniqueArgs
-    CLASS_NAME = 'SidekiqUniqueJobs::UniqueArgs'.freeze
-    extend Forwardable
-    include Normalizer
-
-    def_delegators :SidekiqUniqueJobs, :config, :worker_class_constantize
-    def_delegators :Sidekiq, :logger
-
-    def self.digest(item)
-      new(item).unique_digest
-    end
-
-    def initialize(job)
-      Sidekiq::Logging.with_context(CLASS_NAME) do
-        @item = job
-        @worker_class ||= worker_class_constantize(@item[CLASS_KEY])
-        @item[UNIQUE_PREFIX_KEY] ||= unique_prefix
-        @item[UNIQUE_ARGS_KEY] = unique_args(@item[ARGS_KEY]) # SIC! Calculate unique_args unconditionally
-        @item[UNIQUE_DIGEST_KEY] ||= unique_digest
-      end
-    end
-
-    def unique_digest
-      @unique_digest ||= begin
-        digest = Digest::MD5.hexdigest(Sidekiq.dump_json(digestable_hash))
-        digest = "#{unique_prefix}:#{digest}"
-        logger.debug { "#{__method__} : #{digestable_hash} into #{digest}" }
-        digest
-      end
-    end
-
-    def unique_prefix
-      return config.unique_prefix unless sidekiq_worker_class?
-      @worker_class.get_sidekiq_options[UNIQUE_PREFIX_KEY] || config.unique_prefix
-    end
-
-    def digestable_hash
-      hash = @item.slice(CLASS_KEY, QUEUE_KEY, UNIQUE_ARGS_KEY)
-
-      if unique_on_all_queues?
-        logger.debug do
-          "uniqueness specified across all queues (deleting queue: #{@item[QUEUE_KEY]} from hash)"
-        end
-        hash.delete(QUEUE_KEY)
-      end
-      hash
-    end
-
-    def unique_args(args)
-      if unique_args_enabled?
-        filtered_args(args)
-      else
-        logger.debug { "#{__method__} : unique arguments disabled" }
-        args
-      end
-    rescue NameError
-      # fallback to not filtering args when class can't be instantiated
-      return args
-    end
-
-    def unique_on_all_queues?
-      return unless sidekiq_worker_class?
-      @item[UNIQUE_ON_ALL_QUEUES_KEY] || @worker_class.get_sidekiq_options[UNIQUE_ON_ALL_QUEUES_KEY]
-    end
-
-    def unique_args_enabled?
-      return unless sidekiq_worker_class?
-      unique_args_method # && !unique_args_method.is_a?(Boolean)
-    end
-
-    def sidekiq_worker_class?
-      if @worker_class.respond_to?(:get_sidekiq_options)
-        true
-      else
-        logger.debug { "#{@worker_class} does not respond to :get_sidekiq_options" }
-        nil
-      end
-    end
-
-    # Filters unique arguments by proc or symbol
-    # returns provided arguments for other configurations
-    def filtered_args(args)
-      return args if args.empty?
-      json_args = Normalizer.jsonify(args)
-      logger.debug { "#filtered_args #{args} => #{json_args}" }
-
-      case unique_args_method
-      when Proc
-        filter_by_proc(json_args)
-      when Symbol
-        filter_by_symbol(json_args)
-      else
-        logger.debug { 'arguments not filtered (the combined arguments count towards uniqueness)' }
-        json_args
-      end
-    end
-
-    def filter_by_proc(args)
-      if unique_args_method.nil?
-        warn { "#{__method__} : Proc was nil, returning args as is #{args} -> #{filter_args}" }
-        return args
-      end
-      filter_args = unique_args_method.call(args)
-      logger.debug { "#{__method__} : #{args} -> #{filter_args}" }
-      filter_args
-    end
-
-    def filter_by_symbol(args)
-      unless @worker_class.respond_to?(unique_args_method)
-        logger.warn do
-          "#{__method__} : #{unique_args_method}) not defined in #{@worker_class} " \
-               "returning #{args} unchanged"
-        end
-        return args
-      end
-
-      filter_args = @worker_class.send(unique_args_method, args)
-      logger.debug { "#{__method__} : #{unique_args_method}(#{args}) => #{filter_args}" }
-      filter_args
-    end
-
-    def unique_args_method
-      @unique_args_method ||= @worker_class.get_sidekiq_options[UNIQUE_ARGS_KEY] if sidekiq_worker_class?
-      @unique_args_method ||= :unique_args if @worker_class.respond_to?(:unique_args)
-      @unique_args_method ||= Sidekiq.default_worker_options.stringify_keys[UNIQUE_ARGS_KEY]
-    end
-  end
-end

data/lib/sidekiq_unique_jobs/util.rb

@@ -1,91 +0,0 @@
-module SidekiqUniqueJobs
-  module Util
-    SCAN_PATTERN ||= '*'.freeze
-    DEFAULT_COUNT ||= 1_000
-    KEYS_METHOD ||= 'keys'.freeze
-    SCAN_METHOD ||= 'scan'.freeze
-
-    module_function
-
-    def keys(pattern = SCAN_PATTERN, count = DEFAULT_COUNT)
-      send("keys_by_#{redis_keys_method}", pattern, count)
-    end
-
-    def del(pattern = SCAN_PATTERN, count = 0, dry_run = true)
-      logger.debug { "Deleting keys by: #{pattern}" }
-      keys, time = timed { keys(pattern, count) }
-      logger.debug { "#{keys.size} matching keys found in #{time} sec." }
-      keys = dry_run(keys)
-      logger.debug { "#{keys.size} matching keys after postprocessing" }
-      unless dry_run
-        logger.debug { "deleting #{keys}..." }
-        _, time = timed { batch_delete(keys) }
-        logger.debug { "Deleted in #{time} sec." }
-      end
-      keys.size
-    end
-
-    def keys_by_scan(pattern, count)
-      connection { |conn| conn.scan_each(match: prefix(pattern), count: count).to_a }
-    end
-
-    def keys_by_keys(pattern, _count)
-      connection { |conn| conn.keys(prefix(pattern)).to_a }
-    end
-
-    def batch_delete(keys)
-      connection do |conn|
-        keys.each_slice(500) do |chunk|
-          conn.pipelined do
-            chunk.each do |key|
-              conn.del key
-            end
-          end
-        end
-      end
-    end
-
-    def dry_run(keys, pattern = nil)
-      return keys if pattern.nil?
-      regex = Regexp.new(pattern)
-      keys.select { |k| regex.match k }
-    end
-
-    def timed(&_block)
-      start = Time.now
-      result = yield
-      elapsed = (Time.now - start).round(2)
-      [result, elapsed]
-    end
-
-    def prefix_keys(keys)
-      keys = Array(keys).flatten.compact
-      keys.map { |key| prefix(key) }
-    end
-
-    def prefix(key)
-      return key if unique_prefix.nil?
-      "#{unique_prefix}:#{key}"
-    end
-
-    def unique_prefix
-      SidekiqUniqueJobs.config.unique_prefix
-    end
-
-    def connection(&block)
-      SidekiqUniqueJobs.connection(&block)
-    end
-
-    def redis_version
-      SidekiqUniqueJobs.redis_version
-    end
-
-    def redis_keys_method
-      redis_version >= '2.8' ? SCAN_METHOD : KEYS_METHOD
-    end
-
-    def logger
-      Sidekiq.logger
-    end
-  end
-end

data/rails_example/.env

@@ -1,12 +0,0 @@
-SECRET_KEY_BASE=10167c7f7654ed02b3557b05b88ece1866a9748a2e8e064016f76cb74ddae38264f7403ba65f301d63c21d770e0ee2ac6906f245e904b3b140d12297f67e0db1
-APP_DOMAIN=localhost
-APP_WEB_URL=http://localhost:3000
-APP_CABLE_URL=ws://localhost:28080
-WEB_CONSOLE_WHITELISTED_IPS=127.0.0.1 ::1 127.0.0.0/8 ::1
-DB_HOST=postgres
-DB_PORT=5432
-DB_USERNAME=mhenrixon
-DB_PASSWORD=
-DB_POOL=25
-DB_TIMEOUT=5000
-DB_REAPING_FREQUENCY=10

data/rails_example/.gitignore

@@ -1,13 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore all logfiles and tempfiles.
-/log/*
-!/log/.keep
-/tmp

data/rails_example/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/rails_example/Gemfile

@@ -1,34 +0,0 @@
-source 'https://rubygems.org'
-
-ruby '2.3.1'
-
-gem 'rails', '~> 5.0'
-gem 'puma'
-gem 'json'
-gem 'bigdecimal'
-
-platforms :ruby do
-  gem 'pg'
-  gem 'pry-byebug'
-  gem 'ruby-prof'
-end
-
-platforms :jruby do
-  gem 'jruby-openssl'
-  gem 'jdbc-pg'
-  gem 'activerecord-jdbc-adapter'
-end
-
-gem 'sidekiq-unique-jobs', path: '../'
-gem 'sinatra', github: 'sinatra/sinatra'
-
-group :development do
-  gem 'web-console'
-end
-
-group :development, :test do
-  gem 'rspec-rails'
-  gem 'factory_girl_rails'
-  gem 'mock_redis'
-end
-

data/rails_example/Procfile

@@ -1,2 +0,0 @@
-web:    bundle exec rails server -p $PORT
-worker: bundle exec sidekiq

data/rails_example/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/rails_example/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/rails_example/app/assets/javascripts/application.js

@@ -1,16 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require jquery
-//= require jquery_ujs
-//= require turbolinks
-//= require_tree .

data/rails_example/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/rails_example/app/channels/appearance_channel.rb

@@ -1,17 +0,0 @@
-class AppearanceChannel < ApplicationCable::Channel
-  def subscribed
-    current_user.appear
-  end
-
-  def unsubscribed
-    current_user.disappear
-  end
-
-  def appear(data)
-    current_user.appear on: data['appearing_on']
-  end
-
-  def away
-    current_user.away
-  end
-end

data/rails_example/app/channels/application_cable/channel.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Channel < ActionCable::Channel::Base
-  end
-end

data/rails_example/app/channels/application_cable/connection.rb

@@ -1,9 +0,0 @@
-module ApplicationCable
-  class Connection < ActionCable::Connection::Base
-    identified_by :current_user
-
-    def connect
-      self.current_user = Guest.new
-    end
-  end
-end

data/rails_example/app/channels/post_channel.rb

@@ -1,5 +0,0 @@
-class PostChannel < ApplicationCable::Channel
-  def subscribed
-    stream_from "post_#{params[:post_id]}"
-  end
-end

data/rails_example/app/controllers/application_controller.rb

@@ -1,5 +0,0 @@
-class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
-end

data/rails_example/app/controllers/work_controller.rb

@@ -1,13 +0,0 @@
-class WorkController < ApplicationController
-  def duplicate_simple
-    4.times { SimpleWorker.perform_async(1) }
-
-    redirect_to '/sidekiq'
-  end
-
-  def duplicate_nested
-    4.times { SpawnSimpleWorker.perform_async(1) }
-
-    redirect_to '/sidekiq'
-  end
-end

data/rails_example/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/rails_example/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end