unique_job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af33cb02d39f50c4d16316374ee2079b863505321370817e1df1a293d5b6674f
+  data.tar.gz: '02906948d9857c66215b6984ff2966e766bde452eb375f08c71f01739b3dbf25'
+SHA512:
+  metadata.gz: 6e53fde574f9343471ccdbbf72a9a3562e4a8c95950968ea55f1cbb5f774989b8ab5f781dd129f299817d4e45dbfaa9fe4ae42b3aa9b5b86dd4475c4d6d6ab50
+  data.tar.gz: cd1f0aff1da071006a5c9c003882650bfb2d534b0c1bc455469fddfdc3de60b889e404ddb072426f155ea944315bcd88c9e0ecb24009b0e011fdd4c878b30347

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ts_3156@yahoo.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in unique_job.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    unique_job (0.1.0)
+      redis
+      sidekiq (> 6.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.3)
+    minitest (5.11.3)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rake (12.3.2)
+    redis (4.2.1)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  unique_job!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ts-3156
+
+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,44 @@
+# UniqueJob
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/unique_job`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unique_job'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install unique_job
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/unique_job. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/unique_job/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the UniqueJob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/unique_job/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unique_job"
+
+# 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/unique_job.rb

@@ -0,0 +1,4 @@
+require "unique_job/client_middleware"
+require "unique_job/job_history"
+require "unique_job/server_middleware"
+require "unique_job/version"

data/lib/unique_job/client_middleware.rb

@@ -0,0 +1,21 @@
+require 'unique_job/util'
+
+module UniqueJob
+  class ClientMiddleware
+    include Util
+
+    def call(worker_str, job, queue, redis_pool, &block)
+      if job.has_key?('at')
+        # perform_in or perform_at
+        yield
+      else
+        if worker_str.class == String
+          worker = worker_str.constantize.new # Sidekiq < 6
+        else
+          worker = worker_str.new
+        end
+        perform_if_unique(worker, job['args'], &block)
+      end
+    end
+  end
+end

data/lib/unique_job/job_history.rb

@@ -0,0 +1,65 @@
+module UniqueJob
+  class JobHistory
+    def initialize(worker_class, queueing_class, ttl)
+      @key = "#{self.class}:#{queueing_class}:#{worker_class}"
+      @ttl = ttl
+    end
+
+    def ttl(val = nil)
+      if val
+        redis.ttl(key(val))
+      else
+        @ttl
+      end
+    end
+
+    def delete_all
+      redis.keys("#{@key}:*").each do |key|
+        redis.del(key)
+      end
+    end
+
+    def exists?(val)
+      redis.exists(key(val))
+    end
+
+    def add(val)
+      redis.setex(key(val), @ttl, true)
+    end
+
+    private
+
+    def key(val)
+      "#{@key}:#{val}"
+    end
+
+    def redis
+      self.class.redis
+    end
+
+    class << self
+      def redis
+        @redis ||= Redis.client(ENV['REDIS_HOST'])
+      end
+    end
+
+    module RescueAllRedisErrors
+      %i(
+        ttl
+        exists?
+        add
+      ).each do |method_name|
+        define_method(method_name) do |*args, &blk|
+          start = Time.zone.now
+          super(*args, &blk)
+        rescue => e
+          elapsed = Time.zone.now - start
+          Rails.logger.warn "Rescue all errors in #{self.class}##{method_name} #{e.inspect} elapsed=#{sprintf("%.3f sec", elapsed)}"
+          Rails.logger.debug { e.backtrace.join("\n") }
+          nil
+        end
+      end
+    end
+    prepend RescueAllRedisErrors
+  end
+end

data/lib/unique_job/server_middleware.rb

@@ -0,0 +1,11 @@
+require 'unique_job/util'
+
+module UniqueJob
+  class ServerMiddleware
+    include Util
+
+    def call(worker, msg, queue, &block)
+      perform_if_unique(worker, msg['args'], &block)
+    end
+  end
+end

data/lib/unique_job/util.rb

@@ -0,0 +1,79 @@
+module UniqueJob
+  module Util
+    def perform_if_unique(worker, args, &block)
+      if worker.respond_to?(:unique_key)
+        unique_key = worker.unique_key(*args)
+
+        if unique_key.nil? || unique_key.to_s.empty?
+          logger.warn { "#{class_name}##{__method__} Key is blank worker=#{worker.class} args=#{truncate(args.inspect)}" }
+          yield
+        elsif perform_unique_check(worker, args, unique_key.to_s)
+          yield
+        end
+      else
+        yield
+      end
+    end
+
+    def perform_unique_check(worker, args, unique_key)
+      history = job_history(worker)
+
+      if history.exists?(unique_key)
+        logger.info { "#{class_name}##{__method__} Skip duplicate job for #{history.ttl} seconds, remaining #{history.ttl(unique_key)} seconds worker=#{worker.class} args=#{truncate(args.inspect)}" }
+
+        perform_callback(worker, :after_skip, args)
+
+        false
+      else
+        history.add(unique_key)
+        true
+      end
+    end
+
+    def job_history(worker)
+      ttl = worker.respond_to?(:unique_in) ? worker.unique_in : 3600
+      JobHistory.new(worker.class, class_name, ttl)
+    end
+
+    def truncate(text, length: 100)
+      if text.length > length
+        text.slice(0, length)
+      else
+        text
+      end
+    end
+
+    def perform_callback(worker, callback_name, args)
+      if worker.respond_to?(callback_name)
+        parameters = worker.method(callback_name).parameters
+
+        begin
+          if parameters.empty?
+            worker.send(callback_name)
+          else
+            worker.send(callback_name, *args)
+          end
+        rescue ArgumentError => e
+          message = "The number of parameters of the callback method (#{parameters.size}) is not the same as the number of arguments (#{args.size})"
+          raise ArgumentError.new("#{self.class}:#{worker.class} #{message} callback_name=#{callback_name} args=#{args.inspect} parameters=#{parameters.inspect}")
+        end
+      end
+    end
+
+    def class_name
+      self.class.name.demodulize
+    end
+
+    def logger
+      if File.basename($0) == 'rake'
+        Logger.new(STDOUT, level: Logger::WARN)
+      elsif defined?(Sidekiq)
+        Sidekiq.logger
+      elsif defined?(Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT, level: Logger::WARN)
+      end
+    end
+  end
+end

data/lib/unique_job/version.rb

@@ -0,0 +1,3 @@
+module UniqueJob
+  VERSION = "0.1.0"
+end

data/unique_job.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/unique_job/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unique_job"
+  spec.version       = UniqueJob::VERSION
+  spec.authors       = ["ts-3156"]
+  spec.email         = ["ts_3156@yahoo.co.jp"]
+
+  spec.summary       = "Set a uniqueness to Sidekiq jobs"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/egotter/unique_job"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/egotter/unique_job"
+  spec.metadata["changelog_uri"] = "https://github.com/egotter/unique_job"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", ["> 6.0", "< 7.0"]
+  spec.add_dependency "redis"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: unique_job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ts-3156
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: Set a uniqueness to Sidekiq jobs
+email:
+- ts_3156@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/unique_job.rb
+- lib/unique_job/client_middleware.rb
+- lib/unique_job/job_history.rb
+- lib/unique_job/server_middleware.rb
+- lib/unique_job/util.rb
+- lib/unique_job/version.rb
+- unique_job.gemspec
+homepage: https://github.com/egotter/unique_job
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/egotter/unique_job
+  source_code_uri: https://github.com/egotter/unique_job
+  changelog_uri: https://github.com/egotter/unique_job
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Set a uniqueness to Sidekiq jobs
+test_files: []