sidekiq-expiring-jobs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb92ddcc1f401edb1b9f9462e599c9800ec8ea9550bc7568f16aab9bbf88ae88
+  data.tar.gz: 9f2e2483ec683668a512f7580d93de0dac245ee7a1179c81b36e1da21d711532
+SHA512:
+  metadata.gz: a01c577b380b0f4a4d5cb02660bcca4d82cb33995c7f6042b99c9a28a9aa5185e15f2d6a5408e837843b37c0df9fd304efa52c870e2aa793811ff53597af6367
+  data.tar.gz: c30d348d3d9bba82c26bf482e58572e05f06fb6a578a1a902d3b31d21ecbf82e383255f510718c6f6331b46c49abf727e2f511660e09124f1d3340f28f745b9c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master (unreleased)
+
+## 0.1.0 (2023-04-12)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 fatkodima
+
+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,85 @@
+# SidekiqExpiringJobs
+
+[![Build Status](https://github.com/fatkodima/sidekiq-expiring-jobs/actions/workflows/ci.yml/badge.svg?branch=master)](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
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 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).

data/lib/sidekiq-expiring-jobs.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "sidekiq_expiring_jobs"

data/lib/sidekiq_expiring_jobs/middleware.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SidekiqExpiringJobs
+  module Middleware
+    class Client
+      def call(_worker_class, job, _queue, _redis_pool)
+        if (expires_in = job.delete("expires_in"))
+          at = job["at"] || job["created_at"]
+          job["expires_at"] = at + expires_in.to_f
+        end
+        yield
+      end
+    end
+
+    class Server
+      def call(_worker, job, _queue)
+        if (expires_at = job["expires_at"])
+          if expires_at >= Time.now.to_f
+            yield
+          else
+            Sidekiq.logger.info("[SidekiqExpiringJobs] Expired #{job['class']} job (jid=#{job['jid']}) is skipped")
+            SidekiqExpiringJobs.expiration_callback&.call(job)
+          end
+        else
+          yield
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add(SidekiqExpiringJobs::Middleware::Client)
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add(SidekiqExpiringJobs::Middleware::Client)
+  end
+
+  config.server_middleware do |chain|
+    chain.add(SidekiqExpiringJobs::Middleware::Server)
+  end
+end

data/lib/sidekiq_expiring_jobs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SidekiqExpiringJobs
+  VERSION = "0.1.0"
+end

data/lib/sidekiq_expiring_jobs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+require_relative "sidekiq_expiring_jobs/version"
+
+module SidekiqExpiringJobs
+  class << self
+    attr_accessor :expiration_callback
+  end
+
+  self.expiration_callback = ->(job) {}
+end
+
+require_relative "sidekiq_expiring_jobs/middleware"

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-expiring-jobs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fatkodima
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: |
+  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.
+email:
+- fatkodima123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/sidekiq-expiring-jobs.rb
+- lib/sidekiq_expiring_jobs.rb
+- lib/sidekiq_expiring_jobs/middleware.rb
+- lib/sidekiq_expiring_jobs/version.rb
+homepage: https://github.com/fatkodima/sidekiq-expiring-jobs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fatkodima/sidekiq-expiring-jobs
+  source_code_uri: https://github.com/fatkodima/sidekiq-expiring-jobs
+  changelog_uri: https://github.com/fatkodima/sidekiq-expiring-jobs/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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: Expiring jobs support for Sidekiq.
+test_files: []