sidekiq-bouncer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35a1cc2b51fcee28682f74c8e7514c38a6b1ad5e625d6345fdc2c09053cdfddb
+  data.tar.gz: d19a115056b72773b66a33a322e23bf6bc47c0471591b4bef2d252326aaf7b72
+SHA512:
+  metadata.gz: ff819fea616eda3621b2d2ab7c17f33c1d988561e1daed035e3406373e277e442b2751e77faa2198641cce1df40d18651077e7e63e2fa6a7b0a4e3866dcda7b8
+  data.tar.gz: 6aac8432d4d07e9bb5c56c8c5ccb9cbdbc1a79354e9f0959b73c5e74014f59626773034f2dc60909e33e1b977a86378bf4d162c57cc448bada78d879be1739be

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+## Version 0.1.1
+
+_2020-06-29_
+
+* Make `redis` configurable instead of hardcoded to `Rails.application.redis`.
+
+## Version 0.1.0
+
+_2020-06-19_
+
+* [4329c3f](https://github.com/apartmentlist/sidekiq-bouncer/commit/4329c3f) - Initial release.

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 jasonzhao6@gmail.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sidekiq-bouncer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-bouncer (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sidekiq-bouncer!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 jasonzhao6
+
+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,96 @@
+# Sidekiq::Bouncer
+
+This gem debounces Sidekiq jobs that have the same worker class and params.
+
+It lets duplicate jobs enqueue. Each time, it refreshes a timestamp in Redis.
+When duplicate jobs run, they are checked against this timestamp in Redis and
+only the last job will execute.
+
+## Alternatives Considered
+
+This is a home grown solution. We looked at the official V6 recommendation and
+top gems from Googling 'sidekiq debounce', but all were too slow or broken.
+
+  1) https://github.com/mperham/sidekiq/wiki/API
+
+     The official recommendation is to find and delete duplicate jobs before
+     enqueuing a new job. V6 introduced `scan` for this purpose, and it is
+     1.5x faster than V5's `select` method, but still too slow at high volume.
+
+  2) https://github.com/hummingbird-me/sidekiq-debounce
+
+     The 1st search result. It is outdated and does not work anymore.
+
+  3) https://github.com/paladinsoftware/sidekiq-debouncer
+
+     The 2nd search result. Still works, but it uses the slow `select` method.
+
+## Performance
+
+For each duplicate job, this approach takes 10ms flat; in comparison, `scan`
+takes 10ms per each thousand job in the scheduled set, which adds up quickly.
+The before (using `scan`) and after (using this gem):
+
+![Screen Shot 2020-06-16 at 5 50 46 PM](https://user-images.githubusercontent.com/680345/85186918-a2ff7580-b250-11ea-8b85-625efb722853.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-bouncer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-bouncer
+
+## Usage
+
+```ruby
+# config/initializers/sidekiq_bouncer.rb
+Sidekiq::Bouncer.configure do |config|
+  config.redis = Rails.application.redis
+end
+
+# app/workers/foo_worker.rb
+class FooWorker
+  include Sidekiq::Worker
+
+  def self.bouncer
+    # The default delay is 60 seconds. You can optionally override it.
+    @bouncer ||= Sidekiq::Bouncer.new(self, optional_delay_override)
+  end
+
+  def perform(param1, param2)
+    return unless self.class.bouncer.let_in?(param1, param2)
+
+    # Do your thing.
+  end
+end
+
+# Call `.bouncer.debounce(...)` in place of `.perform_in/perform_async(...)`.
+FooWorker.bouncer.debounce(param1, param2)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/apartmentlist/sidekiq-bouncer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Sidekiq::Bouncer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/apartmentlist/sidekiq-bouncer/blob/master/CODE_OF_CONDUCT.md).

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/bouncer"
+
+# 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/bouncer.rb

@@ -0,0 +1,57 @@
+require 'sidekiq/bouncer/config'
+require 'sidekiq/bouncer/version'
+
+module Sidekiq
+  class Bouncer
+    BUFFER = 1 # Second.
+    DEFAULT_DELAY = 60 # Seconds.
+
+    class << self
+      def config
+        @config ||= Config.new
+      end
+
+      def configure(&block)
+        yield config
+      end
+    end
+
+    def initialize(klass, delay = DEFAULT_DELAY)
+      @klass = klass
+      @delay = delay
+    end
+
+    def debounce(*params)
+      # Refresh the timestamp in redis with debounce delay added.
+      self.class.config.redis.set(key(params), now + @delay)
+
+      # Schedule the job with not only debounce delay added, but also BUFFER.
+      # BUFFER helps prevent race condition between this line and the one above.
+      @klass.perform_at(now + @delay + BUFFER, *params)
+    end
+
+    def let_in?(*params)
+      # Only the last job should come after the timestamp.
+      timestamp = self.class.config.redis.get(key(params))
+      return false if Time.now.to_i < timestamp.to_i
+
+      # But because of BUFFER, there could be mulitple last jobs enqueued within
+      # the span of BUFFER. The first one will clear the timestamp, and the rest
+      # will skip when they see that the timestamp is gone.
+      return false if timestamp.nil?
+      self.class.config.redis.del(key(params))
+
+      true
+    end
+
+    private
+
+    def key(params)
+      "#{@klass}:#{params.join(',')}"
+    end
+
+    def now
+      Time.now.to_i
+    end
+  end
+end

data/lib/sidekiq/bouncer/config.rb

@@ -0,0 +1,9 @@
+module Sidekiq
+  class Bouncer
+    class Config
+      attr_accessor :redis
+    end
+
+    private_constant :Config
+  end
+end

data/lib/sidekiq/bouncer/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  class Bouncer
+    VERSION = '0.1.1'
+  end
+end

data/sidekiq-bouncer.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/bouncer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-bouncer'
+  spec.version       = Sidekiq::Bouncer::VERSION
+  spec.authors       = ['jasonzhao6']
+  spec.email         = ['jasonzhao6@gmail.com']
+
+  spec.summary       = 'Debounce Sidekiq jobs that have the same worker class and params.'
+  spec.homepage      = 'https://github.com/apartmentlist/sidekiq-bouncer'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/apartmentlist/sidekiq-bouncer/blob/master/CHANGELOG.md'
+
+  # 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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-bouncer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- jasonzhao6
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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:
+- jasonzhao6@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/bouncer.rb
+- lib/sidekiq/bouncer/config.rb
+- lib/sidekiq/bouncer/version.rb
+- sidekiq-bouncer.gemspec
+homepage: https://github.com/apartmentlist/sidekiq-bouncer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/apartmentlist/sidekiq-bouncer
+  source_code_uri: https://github.com/apartmentlist/sidekiq-bouncer
+  changelog_uri: https://github.com/apartmentlist/sidekiq-bouncer/blob/master/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.0.6
+signing_key: 
+specification_version: 4
+summary: Debounce Sidekiq jobs that have the same worker class and params.
+test_files: []