├── .github └── CODEOWNERS ├── .gitignore ├── .rspec ├── .travis.yml ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── Gemfile ├── Gemfile.lock ├── LICENSE.txt ├── README.md ├── Rakefile ├── bin ├── console └── setup ├── lib └── sidekiq │ ├── bouncer.rb │ └── bouncer │ ├── config.rb │ └── version.rb ├── sidekiq-bouncer.gemspec └── spec ├── sidekiq └── bouncer_spec.rb └── spec_helper.rb /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @apartmentlist/internal-tooling 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.bundle/ 2 | /.yardoc 3 | /_yardoc/ 4 | /coverage/ 5 | /doc/ 6 | /pkg/ 7 | /spec/reports/ 8 | /tmp/ 9 | 10 | # rspec failure tracking 11 | .rspec_status 12 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --format documentation 2 | --color 3 | --require spec_helper 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | sudo: false 3 | language: ruby 4 | cache: bundler 5 | rvm: 6 | - 2.4.5 7 | before_install: gem install bundler -v 2.0.2 8 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | ## Version 0.1.1 4 | 5 | _2020-06-29_ 6 | 7 | * [18a8aa9](https://github.com/apartmentlist/sidekiq-bouncer/commit/18a8aa9) - Make `redis` configurable instead of hardcoded to `Rails.application.redis`. 8 | 9 | ## Version 0.1.0 10 | 11 | _2020-06-19_ 12 | 13 | * [4329c3f](https://github.com/apartmentlist/sidekiq-bouncer/commit/4329c3f) - Initial release. 14 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at jasonzhao6@gmail.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Specify your gem's dependencies in sidekiq-bouncer.gemspec 4 | gemspec 5 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | sidekiq-bouncer (0.1.1) 5 | 6 | GEM 7 | remote: https://rubygems.org/ 8 | specs: 9 | diff-lcs (1.3) 10 | rake (13.0.1) 11 | rspec (3.9.0) 12 | rspec-core (~> 3.9.0) 13 | rspec-expectations (~> 3.9.0) 14 | rspec-mocks (~> 3.9.0) 15 | rspec-core (3.9.0) 16 | rspec-support (~> 3.9.0) 17 | rspec-expectations (3.9.0) 18 | diff-lcs (>= 1.2.0, < 2.0) 19 | rspec-support (~> 3.9.0) 20 | rspec-mocks (3.9.0) 21 | diff-lcs (>= 1.2.0, < 2.0) 22 | rspec-support (~> 3.9.0) 23 | rspec-support (3.9.0) 24 | 25 | PLATFORMS 26 | ruby 27 | 28 | DEPENDENCIES 29 | bundler (~> 2.0) 30 | rake (~> 13.0) 31 | rspec (~> 3.0) 32 | sidekiq-bouncer! 33 | 34 | BUNDLED WITH 35 | 2.0.2 36 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2020 jasonzhao6 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sidekiq::Bouncer 2 | 3 | This Ruby gem debounces Sidekiq jobs that have the same worker class and params. 4 | 5 | It lets duplicate jobs enqueue. Each time, it refreshes a timestamp in Redis. 6 | When duplicate jobs run, they are checked against this timestamp in Redis and 7 | only the last job will execute. 8 | 9 | ## Alternatives Considered 10 | 11 | This is a home grown solution. We looked at the official V6 recommendation and 12 | top gems from Googling 'sidekiq debounce', but all were too slow or broken. 13 | 14 | 1) https://github.com/mperham/sidekiq/wiki/API 15 | 16 | The official recommendation is to find and delete duplicate jobs before 17 | enqueuing a new job. V6 introduced `scan` for this purpose, and it is 18 | 1.5x faster than V5's `select` method, but still too slow at high volume. 19 | 20 | 2) https://github.com/hummingbird-me/sidekiq-debounce 21 | 22 | The 1st search result. It is outdated and does not work anymore. 23 | 24 | 3) https://github.com/paladinsoftware/sidekiq-debouncer 25 | 26 | The 2nd search result. Still works, but it uses the slow `select` method. 27 | 28 | ## Performance 29 | 30 | For each duplicate job, this approach takes 10ms flat; in comparison, `scan` 31 | takes 10ms per each thousand job in the scheduled set, which adds up quickly. 32 | The before (using `scan`) and after (using this gem): 33 | 34 | ![Screen Shot 2020-06-16 at 5 50 46 PM](https://user-images.githubusercontent.com/680345/85186918-a2ff7580-b250-11ea-8b85-625efb722853.png) 35 | 36 | ## Installation 37 | 38 | Add this line to your application's Gemfile: 39 | 40 | ```ruby 41 | gem 'sidekiq-bouncer' 42 | ``` 43 | 44 | And then execute: 45 | 46 | $ bundle 47 | 48 | Or install it yourself as: 49 | 50 | $ gem install sidekiq-bouncer 51 | 52 | ## Usage 53 | 54 | ```ruby 55 | # config/initializers/sidekiq_bouncer.rb 56 | Sidekiq::Bouncer.configure do |config| 57 | config.redis = Rails.application.redis 58 | end 59 | 60 | # app/workers/foo_worker.rb 61 | class FooWorker 62 | include Sidekiq::Worker 63 | 64 | def self.bouncer 65 | # The default delay is 60 seconds. You can optionally override it. 66 | @bouncer ||= Sidekiq::Bouncer.new(self, optional_delay_override) 67 | end 68 | 69 | def perform(param1, param2) 70 | return unless self.class.bouncer.let_in?(param1, param2) 71 | 72 | # Do your thing. 73 | end 74 | end 75 | 76 | # Call `.bouncer.debounce(...)` in place of `.perform_in/perform_async(...)`. 77 | FooWorker.bouncer.debounce(param1, param2) 78 | ``` 79 | 80 | # About Apartment List 81 | 82 | The majority of Americans spend two thirds of their time at home, yet they find searching for their home to be a huge hassle. Our engineering team is dedicated to solving this problem for millions of renters by disrupting the rental process. Each team is impactful and high-leverage, making the entire engineering organization more productive. Our backend is powered by Ruby, PostgreSQL, Elasticsearch, Kinesis, Go and AMQP, and we are excited to hire the best and brightest engineering talent to join us with new ideas, innovative approaches, and fresh perspectives. Check out our career page for open roles - https://www.apartmentlist.com/about/careers 83 | 84 | ## Development 85 | 86 | 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. 87 | 88 | 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). 89 | 90 | ## Contributing 91 | 92 | 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. 93 | 94 | ## License 95 | 96 | The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 97 | 98 | ## Code of Conduct 99 | 100 | 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). 101 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rspec/core/rake_task" 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | 6 | task :default => :spec 7 | -------------------------------------------------------------------------------- /bin/console: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require "bundler/setup" 4 | require "sidekiq/bouncer" 5 | 6 | # You can add fixtures and/or initialization code here to make experimenting 7 | # with your gem easier. You can also use a different console, if you like. 8 | 9 | # (If you use this, don't forget to add pry to your Gemfile!) 10 | # require "pry" 11 | # Pry.start 12 | 13 | require "irb" 14 | IRB.start(__FILE__) 15 | -------------------------------------------------------------------------------- /bin/setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | set -vx 5 | 6 | bundle install 7 | 8 | # Do any other automated setup that you need to do here 9 | -------------------------------------------------------------------------------- /lib/sidekiq/bouncer.rb: -------------------------------------------------------------------------------- 1 | require 'sidekiq/bouncer/config' 2 | require 'sidekiq/bouncer/version' 3 | 4 | module Sidekiq 5 | class Bouncer 6 | BUFFER = 1 # Second. 7 | DEFAULT_DELAY = 60 # Seconds. 8 | 9 | class << self 10 | def config 11 | @config ||= Config.new 12 | end 13 | 14 | def configure(&block) 15 | yield config 16 | end 17 | end 18 | 19 | def initialize(klass, delay = DEFAULT_DELAY) 20 | @klass = klass 21 | @delay = delay 22 | end 23 | 24 | def debounce(*params) 25 | # Refresh the timestamp in redis with debounce delay added. 26 | self.class.config.redis.set(key(params), now + @delay) 27 | 28 | # Schedule the job with not only debounce delay added, but also BUFFER. 29 | # BUFFER helps prevent race condition between this line and the one above. 30 | @klass.perform_at(now + @delay + BUFFER, *params) 31 | end 32 | 33 | def let_in?(*params) 34 | # Only the last job should come after the timestamp. 35 | timestamp = self.class.config.redis.get(key(params)) 36 | return false if Time.now.to_i < timestamp.to_i 37 | 38 | # But because of BUFFER, there could be mulitple last jobs enqueued within 39 | # the span of BUFFER. The first one will clear the timestamp, and the rest 40 | # will skip when they see that the timestamp is gone. 41 | return false if timestamp.nil? 42 | self.class.config.redis.del(key(params)) 43 | 44 | true 45 | end 46 | 47 | private 48 | 49 | def key(params) 50 | "#{@klass}:#{params.join(',')}" 51 | end 52 | 53 | def now 54 | Time.now.to_i 55 | end 56 | end 57 | end 58 | -------------------------------------------------------------------------------- /lib/sidekiq/bouncer/config.rb: -------------------------------------------------------------------------------- 1 | module Sidekiq 2 | class Bouncer 3 | class Config 4 | attr_accessor :redis 5 | end 6 | 7 | private_constant :Config 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /lib/sidekiq/bouncer/version.rb: -------------------------------------------------------------------------------- 1 | module Sidekiq 2 | class Bouncer 3 | VERSION = '0.1.1' 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /sidekiq-bouncer.gemspec: -------------------------------------------------------------------------------- 1 | lib = File.expand_path('lib', __dir__) 2 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 3 | require 'sidekiq/bouncer/version' 4 | 5 | Gem::Specification.new do |spec| 6 | spec.name = 'sidekiq-bouncer' 7 | spec.version = Sidekiq::Bouncer::VERSION 8 | spec.authors = ['jasonzhao6'] 9 | spec.email = ['jasonzhao6@gmail.com'] 10 | 11 | spec.summary = 'Debounce Sidekiq jobs that have the same worker class and params.' 12 | spec.homepage = 'https://github.com/apartmentlist/sidekiq-bouncer' 13 | spec.license = 'MIT' 14 | 15 | spec.metadata['homepage_uri'] = spec.homepage 16 | spec.metadata['source_code_uri'] = spec.homepage 17 | spec.metadata['changelog_uri'] = 'https://github.com/apartmentlist/sidekiq-bouncer/blob/master/CHANGELOG.md' 18 | 19 | # Specify which files should be added to the gem when it is released. 20 | # The `git ls-files -z` loads the files in the RubyGem that have been added into git. 21 | spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do 22 | `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 23 | end 24 | spec.bindir = 'exe' 25 | spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } 26 | spec.require_paths = ['lib'] 27 | 28 | spec.add_development_dependency 'bundler', '~> 2.0' 29 | spec.add_development_dependency 'rake', '~> 13.0' 30 | spec.add_development_dependency 'rspec', '~> 3.0' 31 | end 32 | -------------------------------------------------------------------------------- /spec/sidekiq/bouncer_spec.rb: -------------------------------------------------------------------------------- 1 | module RedisMock 2 | end 3 | 4 | class WorkerMock 5 | def self.bouncer 6 | @bouncer ||= Sidekiq::Bouncer.new(self) 7 | end 8 | end 9 | 10 | RSpec.describe Sidekiq::Bouncer do 11 | let(:redis) { RedisMock } 12 | let(:klass) { WorkerMock } 13 | let(:param1) { 1 } 14 | let(:param2) { 2 } 15 | let(:key) { "#{klass}:#{param1},#{param2}" } 16 | let(:now) { 100 } 17 | 18 | subject { WorkerMock.bouncer } 19 | 20 | before do 21 | described_class.configure do |config| 22 | config.redis = RedisMock 23 | end 24 | end 25 | 26 | describe '#debounce' do 27 | before do 28 | allow(subject).to receive(:now).and_return(now) 29 | allow(redis).to receive(:set) 30 | allow(klass).to receive(:perform_at) 31 | end 32 | 33 | it 'sets Redis with delayed timestamp' do 34 | subject.debounce(param1, param2) 35 | 36 | expect(subject.class.config.redis) 37 | .to have_received(:set) 38 | .with(key, now + described_class::DEFAULT_DELAY) 39 | end 40 | 41 | it 'queues Sidekiq with delayed and buffered timestamp' do 42 | subject.debounce(param1, param2) 43 | 44 | expect(klass) 45 | .to have_received(:perform_at) 46 | .with( 47 | now + described_class::DEFAULT_DELAY + described_class::BUFFER, 48 | param1, 49 | param2 50 | ) 51 | end 52 | end 53 | 54 | describe '#let_in?' do 55 | context 'when debounce timestamp is in the past' do 56 | before do 57 | allow(redis).to receive(:get).and_return(Time.now - 10) 58 | allow(redis).to receive(:del) 59 | end 60 | 61 | it 'returns true' do 62 | expect(subject.let_in?(param1, param2)).to eq(true) 63 | end 64 | 65 | it 'deletes debounce timestamp from redis' do 66 | subject.let_in?(param1, param2) 67 | expect(subject.class.config.redis).to have_received(:del).with(key) 68 | end 69 | end 70 | 71 | context 'when debounce timestamp is in the future' do 72 | before do 73 | allow(redis).to receive(:get).and_return(Time.now + 10) 74 | end 75 | 76 | it 'returns false' do 77 | expect(subject.let_in?(param1, param2)).to eq(false) 78 | end 79 | end 80 | 81 | context 'when debounce timestamp is not there' do 82 | before do 83 | allow(redis).to receive(:get).and_return(nil) 84 | end 85 | 86 | it 'returns false' do 87 | expect(subject.let_in?(param1, param2)).to eq(false) 88 | end 89 | end 90 | end 91 | end 92 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | require "bundler/setup" 2 | require "sidekiq/bouncer" 3 | 4 | RSpec.configure do |config| 5 | # Enable flags like --only-failures and --next-failure 6 | config.example_status_persistence_file_path = ".rspec_status" 7 | 8 | # Disable RSpec exposing methods globally on `Module` and `main` 9 | config.disable_monkey_patching! 10 | 11 | config.expect_with :rspec do |c| 12 | c.syntax = :expect 13 | end 14 | end 15 | --------------------------------------------------------------------------------