sidekiq-debouncer 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f505c753200cb5a607d4a0f847372a72f5f5571631d6b50e12348e99b407f30
+  data.tar.gz: b72d1d31b9b1b13a7ab8ec88a56a27e2a84e11a8dca721e296ec4a25da361dd7
+SHA512:
+  metadata.gz: 400505251465ceca2630d226a8f1017518a5bb068e755a05428e8f00be81519c2ddcda91be840c24f3eaf382ff7302e1c1941fe790eec95a5cb9f9d9f72dd797
+  data.tar.gz: 6d01faab4b9f4b98512dadb598100674d241ab3fd99a324e1abb89773a9a4c92ba8782fb1564e68a97d4c171646ec9f6472a25cdb507eba218d739f368f1226f

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rspec-local
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+gemfiles/*.gemfile.lock
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.semaphore/semaphore.yml

@@ -0,0 +1,27 @@
+version: v1.0
+name: Sidekiq-debouncer CI pipeline
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+
+blocks:
+  - name: Run specs
+    task:
+      env_vars:
+        - name: RAILS_ENV
+          value: "test"
+
+      jobs:
+        - name: Run RSpec
+          matrix:
+            - env_var: SIDEKIQ_VERSION
+              values: [ "5.0.5", "5.1.3", "5.2.7", "6.0.2" ]
+          commands:
+            - checkout
+            - export RUBY_VERSION=$(cat gemfiles/sidekiq-$SIDEKIQ_VERSION.gemfile | grep "ruby \".*\"" | grep -o "[0-9]\.[0-9]\.[0-9]")
+            - sem-version ruby $RUBY_VERSION
+            - sem-service start redis
+            - gem install bundler -v 1.17.3 -N
+            - bundle install --gemfile gemfiles/sidekiq-$SIDEKIQ_VERSION.gemfile
+            - RAILS_ENV=test bundle exec --gemfile gemfiles/sidekiq-$SIDEKIQ_VERSION.gemfile rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gabriel Evans
+
+MIT License
+
+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,95 @@
+# Sidekiq::Debouncer
+
+Sidekiq extension that adds the ability to debounce job execution.
+
+Worker will postpone its execution after `wait time` have elapsed since the last time it was invoked. Useful for implementing behavior that should only happen after the input has stopped arriving. For example: sending group email to the user after he stopped interacting with the application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-debouncer'
+```
+
+And then execute:
+
+    $ bundle
+
+## Basic usage
+
+In a worker, include `Sidekiq::Debouncer` module, specify debounce wait time (in seconds):
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Debouncer
+
+  sidekiq_options(
+    debounce: {
+      time: 5 * 60
+    }
+  )
+
+  def perform(group)
+    group.each do
+      # do some work with group
+    end
+  end
+end
+```
+
+You can specify your own debounce method. In this case worker will be debounced if first argument matches.
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Debouncer
+
+  sidekiq_options(
+    debounce: {
+      time: 5 * 60,
+      by: -> (job_args) {
+        job_args[0]
+      }
+    }
+  )
+
+  def perform(group)
+    group.each do
+      # do some work with group
+    end
+  end
+end
+```
+
+You can also pass symbol as `debounce_by` matching class method.
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Debouncer
+
+  sidekiq_options(
+    debounce: {
+      time: 5 * 60,
+      by: :debounce_method
+    }
+  )
+  
+  def self.debounce_method(job_args)
+    job_args[0]
+  end
+
+  def perform(group)
+    group.each do
+      # do some work with group
+    end
+  end
+end
+```
+
+
+In the application, call `MyWorker.debounce(...)`. Everytime you call this function, `MyWorker`'s execution will be postponed by 5 minutes. After that time `MyWorker` will receive a method call `perform` with an array of arguments that were provided to the `MyWorker.debounce(...)`.
+
+## License
+
+MIT Licensed. See LICENSE.txt for details.

data/gemfiles/sidekiq-5.0.5.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+ruby "2.3.8"
+
+gem "sidekiq", "= 5.0.5"
+
+gemspec path: '../'

data/gemfiles/sidekiq-5.1.3.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+ruby "2.4.6"
+
+gem "sidekiq", "= 5.1.3"
+
+gemspec path: '../'

data/gemfiles/sidekiq-5.2.7.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+ruby "2.5.5"
+
+gem "sidekiq", "= 5.2.7"
+
+gemspec path: '../'

data/gemfiles/sidekiq-6.0.2.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+ruby "2.6.5"
+
+gem "sidekiq", "= 6.0.2"
+
+gemspec path: '../'

data/lib/sidekiq/debouncer.rb

@@ -0,0 +1,48 @@
+require 'sidekiq'
+require 'sidekiq/api'
+
+require 'sidekiq/debouncer/version'
+
+module Sidekiq
+  module Debouncer
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      DEFAULT_DEBOUNCE_FOR = 5 * 60 # 5.minutes
+      DEFAULT_DEBOUNCE_BY = -> (job_args) { 0 }
+
+      def debounce(*args)
+        sidekiq_options["debounce"] ||= {}
+
+        debounce_for = sidekiq_options["debounce"][:time] || DEFAULT_DEBOUNCE_FOR
+        debounce_by = sidekiq_options["debounce"][:by] || DEFAULT_DEBOUNCE_BY
+        debounce_by_value = debounce_by.is_a?(Symbol) ? send(debounce_by, args) : debounce_by.call(args)
+
+        ss = Sidekiq::ScheduledSet.new
+        jobs = ss.select do |job|
+          next false unless job.klass == self.to_s
+
+          debounce_by_value_job = debounce_by.is_a?(Symbol) ? send(debounce_by, job.args[0][0]) : debounce_by.call(job.args[0][0])
+
+          debounce_by_value_job == debounce_by_value
+        end
+
+        time_from_now = Time.now + debounce_for
+        jobs_to_group = []
+
+        jobs.each do |job|
+          if job.at > Time.now && job.at < time_from_now
+            jobs_to_group += job.args[0]
+            job.delete
+          end
+        end
+
+        jobs_to_group << args
+
+        perform_in(debounce_for, jobs_to_group)
+      end
+    end
+  end
+end

data/lib/sidekiq/debouncer/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Debouncer
+    VERSION = '1.0.1'.freeze
+  end
+end

data/sidekiq-debounce.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/debouncer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'sidekiq-debouncer'
+  gem.version       = Sidekiq::Debouncer::VERSION
+  gem.authors       = ['Sebastian Zuchmański', 'Karol Bąk']
+  gem.email         = ['sebcioz@gmail.com', 'karol.bak@paladinsoftware.com']
+  gem.description   = %q{Sidekiq extension that adds the ability to debounce job execution.}
+  gem.summary       = %q{}
+  gem.homepage      = 'https://github.com/paladinsoftware/sidekiq-debouncer'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w(lib)
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'sidekiq', '>= 5.0'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-sidekiq'
+  gem.add_development_dependency 'timecop'
+  gem.add_development_dependency 'rspec-redis_helper'
+  gem.add_development_dependency 'redis-namespace'
+end

data/spec/sidekiq/debouncer_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+
+class TestWorker
+  include Sidekiq::Worker
+  include Sidekiq::Debouncer
+
+  sidekiq_options(
+    debounce: {
+      time: 5 * 60,
+      by: -> (job_args) {
+        job_args[0]
+      }
+    }
+  )
+
+  # group - array of arguments for single job
+  def perform(group)
+    group.each do
+      # do some work with group
+    end
+  end
+end
+
+class TestWorkerWithMultipleArguments
+  include Sidekiq::Worker
+  include Sidekiq::Debouncer
+
+  sidekiq_options(
+    debounce: {
+      time: 5 * 60,
+      by: -> (job_args) {
+        job_args[0] + job_args[1]
+      }
+    }
+  )
+
+  # group - array of arguments for single job
+  def perform(group)
+    group.each do
+      # do some work with group
+    end
+  end
+end
+
+class TestWorkerWithSymbolAsDebounce
+  include Sidekiq::Worker
+  include Sidekiq::Debouncer
+
+  sidekiq_options(
+    debounce: {
+      time: 5 * 60,
+      by: :debounce_method
+    }
+  )
+
+  def self.debounce_method(args)
+    args[0]
+  end
+
+  # group - array of arguments for single job
+  def perform(group)
+    group.each do
+      # do some work with group
+    end
+  end
+end
+
+describe Sidekiq::Debouncer do
+  let(:time_start) { Time.new(2016, 1, 1, 12, 0, 0) }
+
+  before do
+    Timecop.freeze(time_start)
+    Sidekiq::ScheduledSet.new.clear
+    Sidekiq::Testing.disable!
+  end
+
+  context "1 type of tasks" do
+    context "1 task" do
+      it "executes it after 5 minutes" do
+        TestWorker.debounce("A", "job 1")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(1)
+
+        group = Sidekiq::ScheduledSet.new.first
+        expect(group.args[0]).to eq([["A", "job 1"]])
+        expect(group.at.to_i).to eq((time_start + 5 * 60).to_i)
+      end
+
+      it "executes it after 5 minutes for symbol debounce" do
+        expect(TestWorkerWithSymbolAsDebounce).to receive(:debounce_method).with(["A", "job 1"]).once.and_call_original
+        TestWorkerWithSymbolAsDebounce.debounce("A", "job 1")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(1)
+
+        group = Sidekiq::ScheduledSet.new.first
+        expect(group.args[0]).to eq([["A", "job 1"]])
+        expect(group.at.to_i).to eq((time_start + 5 * 60).to_i)
+      end
+    end
+
+    context "1 task, 3 minutes break, 1 task" do
+      it "executes both tasks after 8 minutes for multiple arguments" do
+        TestWorkerWithMultipleArguments.debounce(1, 5)
+        Timecop.freeze(time_start + 3 * 60)
+        TestWorkerWithMultipleArguments.debounce(3, 3)
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(1)
+        group = Sidekiq::ScheduledSet.new.first
+        expect(group.args[0]).to eq([[1, 5], [3, 3]])
+        expect(group.at.to_i).to be((time_start + 8 * 60).to_i)
+      end
+
+      it "executes both tasks after 8 minutes" do
+        TestWorker.debounce("A", "job 1")
+        Timecop.freeze(time_start + 3 * 60)
+        TestWorker.debounce("A", "job 2")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(1)
+        group = Sidekiq::ScheduledSet.new.first
+        expect(group.args[0]).to eq([["A", "job 1"], ["A", "job 2"]])
+        expect(group.at.to_i).to be((time_start + 8 * 60).to_i)
+      end
+
+      it "executes both tasks after 8 minutes for symbol debounce" do
+        TestWorkerWithSymbolAsDebounce.debounce("A", "job 1")
+        Timecop.freeze(time_start + 3 * 60)
+        TestWorkerWithSymbolAsDebounce.debounce("A", "job 2")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(1)
+        group = Sidekiq::ScheduledSet.new.first
+        expect(group.args[0]).to eq([["A", "job 1"], ["A", "job 2"]])
+        expect(group.at.to_i).to be((time_start + 8 * 60).to_i)
+      end
+    end
+
+    context "1 task, 3 minutes break, 1 task, 6 minutes break, 1 task" do
+      it "executes two tasks after 8 minutes, the last one in 14 minutes" do
+        TestWorker.debounce("A", "job 1")
+        Timecop.freeze(time_start + 3 * 60)
+        TestWorker.debounce("A", "job 2")
+        Timecop.freeze(time_start + 3 * 60 + 6 * 60)
+        TestWorker.debounce("A", "job 3")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(2)
+
+        groups = Sidekiq::ScheduledSet.new.to_a.sort_by { |g| g.at.to_i }
+
+        expect(groups[0].args[0]).to eq([["A", "job 1"], ["A", "job 2"]])
+        expect(groups[0].at.to_i).to be((time_start + 8 * 60).to_i)
+
+        expect(groups[1].args[0]).to eq([["A", "job 3"]])
+        expect(groups[1].at.to_i).to be((time_start + 14 * 60).to_i)
+      end
+    end
+
+    context "1 task, 6 minutes break, 1 task" do
+      it "executes first task, the second one in 11 minutes" do
+        TestWorker.debounce("A", "job 1")
+        Timecop.freeze(time_start + 6 * 60)
+        TestWorker.debounce("A", "job 2")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(2)
+
+        groups = Sidekiq::ScheduledSet.new.to_a.sort_by { |g| g.at.to_i }
+
+        expect(groups[0].args[0]).to eq([["A", "job 1"]])
+        expect(groups[0].at.to_i).to be((time_start + 5 * 60).to_i)
+
+        expect(groups[1].args[0]).to eq([["A", "job 2"]])
+        expect(groups[1].at.to_i).to be((time_start + 11 * 60).to_i)
+      end
+    end
+  end
+
+  context "two types of tasks" do
+    context "A task, 3 minutes break, A and B tasks, 3 minutes break, B task, 6 minutes break, B task" do
+      it "executes two A tasks after 8 minuts, two B tasks after 11 minutes, last B task after 17 minutes" do
+        TestWorker.debounce("A", "job 1")
+        Timecop.freeze(time_start + 3 * 60)
+        TestWorker.debounce("A", "job 2")
+        TestWorker.debounce("B", "job 3")
+        Timecop.freeze(time_start + 3 * 60 + 3 * 60)
+        TestWorker.debounce("B", "job 4")
+        Timecop.freeze(time_start + 3 * 60 + 3 * 60 + 6 * 60)
+        TestWorker.debounce("B", "job 5")
+
+        expect(Sidekiq::ScheduledSet.new.size).to eq(3)
+
+        groups = Sidekiq::ScheduledSet.new.to_a.sort_by { |g| g.at.to_i }
+
+        expect(groups[0].args[0]).to eq([["A", "job 1"], ["A", "job 2"]])
+        expect(groups[0].at.to_i).to be((time_start + 8 * 60).to_i)
+
+        expect(groups[1].args[0]).to eq([["B", "job 3"], ["B", "job 4"]])
+        expect(groups[1].at.to_i).to be((time_start + 11 * 60).to_i)
+
+        expect(groups[2].args[0]).to eq([["B", "job 5"]])
+        expect(groups[2].at.to_i).to be((time_start + 17 * 60).to_i)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'redis/namespace'
+require 'rspec-sidekiq'
+require 'timecop'
+
+require 'sidekiq/debouncer'
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.color = true
+
+  Sidekiq.configure_server do |config|
+    config.redis[:namespace] = { namespace: 'sidekiq-debouncer' }
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-debouncer
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sebastian Zuchmański
+- Karol Bąk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-redis_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sidekiq extension that adds the ability to debounce job execution.
+email:
+- sebcioz@gmail.com
+- karol.bak@paladinsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".semaphore/semaphore.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- gemfiles/sidekiq-5.0.5.gemfile
+- gemfiles/sidekiq-5.1.3.gemfile
+- gemfiles/sidekiq-5.2.7.gemfile
+- gemfiles/sidekiq-6.0.2.gemfile
+- lib/sidekiq/debouncer.rb
+- lib/sidekiq/debouncer/version.rb
+- sidekiq-debounce.gemspec
+- spec/sidekiq/debouncer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paladinsoftware/sidekiq-debouncer
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/sidekiq/debouncer_spec.rb
+- spec/spec_helper.rb