Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fatkodima/sidekiq-expiring-jobs
Expiring jobs support for Sidekiq
https://github.com/fatkodima/sidekiq-expiring-jobs
gem ruby sidekiq
Last synced: 5 days ago
JSON representation
Expiring jobs support for Sidekiq
- Host: GitHub
- URL: https://github.com/fatkodima/sidekiq-expiring-jobs
- Owner: fatkodima
- License: mit
- Created: 2023-04-12T12:53:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-14T13:48:16.000Z (10 months ago)
- Last Synced: 2024-11-02T02:02:17.249Z (9 days ago)
- Topics: gem, ruby, sidekiq
- Language: Ruby
- Homepage:
- Size: 18.6 KB
- Stars: 31
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SidekiqExpiringJobs
[](https://github.com/fatkodima/sidekiq-expiring-jobs/actions/workflows/ci.yml)
Support for Sidekiq jobs which expire after a certain length of time.
Jobs that are set to expire can run as long as they want, but an expiring job must start executing before the expiration time.
Note: Sidekiq Pro has this feature, so please consider upgrading if you can.
## Use Cases
1. Perhaps you want to expire a cache which has a TTL of 30 minutes with a Sidekiq job. If the job doesn't process successfully within 30 minutes, there's no point in executing the job.
2. You use a Sidekiq job to send a daily digest email. If the job doesn't execute within 24 hours, perhaps you want to skip that day as the user might only care about the latest digest.
3. You enqueue periodically a Sidekiq job to do some task. If the job doesn't execute before the next period begins, you may skip that job as the newly enqueued job will do the task.
## Requirements
- Ruby 2.7+
- Sidekiq 6.0+
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sidekiq-expiring-jobs'
```
And then execute:
```sh
$ bundle
```
Or install it yourself as:
```sh
$ gem install sidekiq-expiring-jobs
```
## Defining Expiration
Statically:
```ruby
class SomeJob
include Sidekiq::Job
sidekiq_options expires_in: 1.hour
...
end
```
Dynamically, per job:
```ruby
SomeJob.set(expires_in: 1.day).perform_async(...)
```
`expires_in` must be a relative time, not an absolute timestamp.
Expiration knows about scheduled jobs: schedule a job to run two hours from now with a one hour expiration and it will expire **three** hours from now.
## Configuration
You can override the following default options:
```ruby
# A callback that is called when the job is expired.
# Accepts a job hash as an argument.
SidekiqExpiringJobs.expiration_callback = ->(job) {}
```
## Development
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 the created tag, 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/fatkodima/sidekiq-expiring-jobs.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).