Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dtaniwaki/sidekiq-merger
Merge Sidekiq jobs
https://github.com/dtaniwaki/sidekiq-merger
batch bulk-notification rails ruby sidekiq sidekiq-grouping
Last synced: about 2 months ago
JSON representation
Merge Sidekiq jobs
- Host: GitHub
- URL: https://github.com/dtaniwaki/sidekiq-merger
- Owner: dtaniwaki
- License: mit
- Created: 2017-01-30T14:54:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-04T07:57:31.000Z (about 3 years ago)
- Last Synced: 2024-11-09T10:20:28.185Z (about 2 months ago)
- Topics: batch, bulk-notification, rails, ruby, sidekiq, sidekiq-grouping
- Language: Ruby
- Homepage: https://sidekiq-merger.dtaniwaki.com
- Size: 807 KB
- Stars: 51
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sidekiq-merger
[![Gem Version][gem-image]][gem-link]
[![Dependency Status][deps-image]][deps-link]
[![Build Status][build-image]][build-link]
[![Coverage Status][cov-image]][cov-link]
[![Code Climate][gpa-image]][gpa-link]
[![Docker][docker-hub-image]][docker-hub-link]
Merge [sidekiq](http://sidekiq.org/) jobs occurring before the execution times. Inspired by [sidekiq-grouping](https://github.com/gzigzigzeo/sidekiq-grouping).
[Demo](http://sidekiq-merger.dtaniwaki.com/)
## Use Case
### Cancel Task
### Bulk Notification
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sidekiq-merger'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install sidekiq-merger
## Usage
Add merger option into your workers.
```ruby
class SomeWorker
include Sidekiq::Worker
sidekiq_options merger: { key: -> (args) { args[0] } }
def perform(*merged_args)
merged_args.each do |args|
# Do something
end
end
end
```
Then, enqueue jobs by `perform_in` or `perform_at`.
```ruby
SomeWorker.perform_in 100, 4
SomeWorker.perform_in 100, 3
SomeWorker.perform_in 100, 5
# Passed 100 seconds from the first enqueue.
SomeWorker.perform_in 100, 6
SomeWorker.perform_in 100, 1
```
`SomeWorker` will be executed in 100 seconds with args of `[4], [3], [5]`, then with args of `[6], [1]`.
`perform_async` works without merging args.
```ruby
SomeWorker.perform_async 4
SomeWorker.perform_async 3
SomeWorker.perform_async 5
```
In this case, `SomeWorker` will be executed 3 times with args of `[4]`, `[3]` and `[5]`.
### Quick Check
Run docker containers to check the behavior of this gem.
$ docker-compose up
Then, open `http://localhost:3000/`. You can push jobs from the UI and see what happens in the sidekiq console.
## Options
### `key` (optional, default: `nil`)
Defines merge key so different arguments can be merged.
Format: `String` or `Proc`
e.g. `sidekiq_options merger: { key: -> (args) { args[0..1] } }`
### `unique` (optional, default: `false`)
Prevents enqueue of jobs with identical arguments.
Format: `Boolean`
e.g. `true`
### `batch_size` (optional, default: `nil`)
Allow to specify how many jobs max to provide as arguments per aggregation
Format: `Int`
e.g. `50`
## Web UI
Add this line to your `config/routes.rb` to activate web UI:
```ruby
require "sidekiq/merger/web"
```
## Test
$ bundle exec appraisal rspec
The test coverage is available at `./coverage/index.html`.
## Lint
$ bundle exec appraisal rubocop
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new [Pull Request](../../pull/new/master)
## Copyright
Copyright (c) 2017 dtaniwaki. See [LICENSE](LICENSE) for details.
[gem-image]: https://badge.fury.io/rb/sidekiq-merger.svg
[gem-link]: http://badge.fury.io/rb/sidekiq-merger
[build-image]: https://secure.travis-ci.org/dtaniwaki/sidekiq-merger.svg
[build-link]: http://travis-ci.org/dtaniwaki/sidekiq-merger
[deps-image]: https://gemnasium.com/dtaniwaki/sidekiq-merger.svg
[deps-link]: https://gemnasium.com/dtaniwaki/sidekiq-merger
[cov-image]: https://coveralls.io/repos/dtaniwaki/sidekiq-merger/badge.png
[cov-link]: https://coveralls.io/r/dtaniwaki/sidekiq-merger
[gpa-image]: https://codeclimate.com/github/dtaniwaki/sidekiq-merger.svg
[gpa-link]: https://codeclimate.com/github/dtaniwaki/sidekiq-merger
[docker-hub-image]: http://dockeri.co/image/dtaniwaki/sidekiq-merger
[docker-hub-link]: https://hub.docker.com/r/dtaniwaki/sidekiq-merger/