sidekiq-single 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7e304fd7c7c813af1bcfd34ccfc1cf7a669b76c5e66e8ec314af4c91a6bcf1f
+  data.tar.gz: a63dc17028c275e8c8d1b5aa25ed58e17ba57bd29c1b3f53e2577d8ebdf29ed3
+SHA512:
+  metadata.gz: 0e5bbf502ea2d741b63bb92bec6ed47add851fb54ba38897969985e0fa5cbcad04a3149a807103c0edbb010cc57b365910346ebdfc623838ffb93c7dcdf46682
+  data.tar.gz: 1c34e335eb6e95cafc3c55c473a9b7c763e120d15609a147dcd9fc7bc3bb769663d8d2ecc80a39edeb5e21e1b7ecfd2422a501d7c49f0c8c66fa39cf956f4926

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.8
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cocchi.c@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-single.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 ccocchi
+
+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,43 @@
+# Sidekiq::Single
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq/single`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-single'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-single
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, 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/[USERNAME]/sidekiq-single. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Single project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sidekiq-single/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/single"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/single/job.rb

@@ -0,0 +1,25 @@
+module Sidekiq::Single
+  module Job
+    def self.included(job)
+      job.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def single_options(opts)
+        opts = opts.stringify_keys
+        opts["unique_for"] = opts["unique_for"]&.to_i
+
+        raise InvalidConfiguration if opts["unique_for"].nil?
+
+        sidekiq_options(opts)
+      end
+
+      def locked_for?(*args)
+        meth = get_sidekiq_options["unique_args"]
+        item = { "args" => args, "unique_args" => meth }
+
+        Lock.new(item).fastened?
+      end
+    end
+  end
+end

data/lib/sidekiq/single/lock.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Sidekiq::Single
+  class Lock
+    DIGEST_KEY = "digest"
+
+    attr_reader :item
+
+    def initialize(item, pool = nil)
+      @item = item
+      @pool = pool || ::Sidekiq.redis_pool
+    end
+
+    def fastened?
+      args   = item["args"]
+      method = item["unique_args"]
+      args   = Array(method.call(args)) if method
+      digest = digest(args)
+
+      @pool.with { |conn| conn.call("EXISTS", digest) } > 0
+    end
+
+    def acquire_or_discard
+      args    = item.key?("wrapped") ? item.dig("args", 0, "arguments") : item["args"]
+      method  = item.delete("unique_args")
+      ttl     = item["unique_for"]
+      args    = Array(method.call(args)) if method
+      digest  = item[DIGEST_KEY] = digest(args)
+
+      if @pool.with { |conn| conn.call("SET", digest, item["jid"], "NX", "EX", ttl) }
+        yield
+      else
+        handle_conflict
+      end
+    end
+
+    def perform_and_release
+      res = yield
+      release
+      res
+    end
+
+    def release
+      @pool.with { |conn| conn.call("FCALL", "single_release_lock", 1, item["digest"], item["jid"]) }
+    end
+
+    private
+
+    def digest(ary)
+      sha256 = Digest::SHA256.new
+      ary.each { |e| sha256 << e.to_s }
+      sha256.hexdigest
+    end
+
+    def handle_conflict # noop
+    end
+  end
+end

data/lib/sidekiq/single/lua/lock.lua

@@ -0,0 +1,13 @@
+#!lua name=ratelimit
+
+local function single_release_lock(keys, args)
+  local existing = redis.call("GET", keys[1])
+
+  if existing == args[1] then
+    return redis.call("DEL", keys[1])
+  else
+    return 0
+  end
+end
+
+redis.register_function('single_release_lock', single_release_lock)

data/lib/sidekiq/single/middleware/client.rb

@@ -0,0 +1,13 @@
+module Sidekiq::Single
+  class ClientMiddleware
+    include ::Sidekiq::ClientMiddleware
+
+    def call(_, item, _, redis_pool, &)
+      if item.key?("unique_for")
+        Lock.new(item, redis_pool).acquire_or_discard(&)
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/sidekiq/single/middleware/server.rb

@@ -0,0 +1,13 @@
+module Sidekiq::Single
+  class ServerMiddleware
+    include ::Sidekiq::ServerMiddleware
+
+    def call(_, item, _, &)
+      if item.key?(Lock::DIGEST_KEY)
+        Lock.new(item).perform_and_release(&)
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/sidekiq/single/reaper.rb

@@ -0,0 +1,9 @@
+module Sidekiq::Single
+  class Reaper
+    def call(item, *)
+      if item.key?(Lock::DIGEST_KEY)
+        Lock.new(item).release
+      end
+    end
+  end
+end

data/lib/sidekiq/single/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Single
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/single.rb

@@ -0,0 +1,17 @@
+require_relative "single/version"
+require_relative "single/job"
+require_relative "single/lock"
+require_relative "single/middleware/client"
+require_relative "single/middleware/server"
+require_relative "single/reaper"
+
+module Sidekiq
+  module Single
+    class InvalidConfiguration < StandardError; end
+
+    def add_function_to_redis(conn)
+      fn = File.read(File.expand_path("../single/lua/lock.lua", __FILE__))
+      conn.call("FUNCTION LOAD REPLACE", fn)
+    end
+  end
+end

data/sidekiq-single.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq/single/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-single"
+  spec.version       = Sidekiq::Single::VERSION
+  spec.authors       = ["ccocchi"]
+  spec.email         = ["cocchi.c@gmail.com"]
+
+  spec.summary       = "Simple unique jobs for Sidekiq and single Redis instance"
+  spec.homepage      = "https://www.github.com/ccocchi/sidekiq-single"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"]          = spec.homepage
+  spec.metadata["source_code_uri"]       = "#{spec.homepage}/tree/v#{spec.version}"
+  spec.metadata["bug_tracker_uri"]       = "#{spec.homepage}/issues"
+  spec.metadata["changelog_uri"]         = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.start_with?("test/") }
+  end
+
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 3.3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "sidekiq", ">= 7", "< 8"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-single
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ccocchi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+description:
+email:
+- cocchi.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/single.rb
+- lib/sidekiq/single/job.rb
+- lib/sidekiq/single/lock.rb
+- lib/sidekiq/single/lua/lock.lua
+- lib/sidekiq/single/middleware/client.rb
+- lib/sidekiq/single/middleware/server.rb
+- lib/sidekiq/single/reaper.rb
+- lib/sidekiq/single/version.rb
+- sidekiq-single.gemspec
+homepage: https://www.github.com/ccocchi/sidekiq-single
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/ccocchi/sidekiq-single
+  source_code_uri: https://www.github.com/ccocchi/sidekiq-single/tree/v0.1.0
+  bug_tracker_uri: https://www.github.com/ccocchi/sidekiq-single/issues
+  changelog_uri: https://www.github.com/ccocchi/sidekiq-single/blob/v0.1.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Simple unique jobs for Sidekiq and single Redis instance
+test_files: []