sidekiq-fairplay 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8da6198834317f72485926227a1a0798f26fa2cb89506248b8430f36445c3d8e
-  data.tar.gz: 1b09fd7ff17a68822a77d2944a22f9913a3048660e591aebb0fcdcf71ef69b8f
+  metadata.gz: 90c65bc475c5878775b1e24fee917f48c7f24021c43846d1d7d4d4659b9cbcca
+  data.tar.gz: 883a02caa000007968db911404f77798cc3f2252360550c8a00146b8ef7e794c
 SHA512:
-  metadata.gz: 74bfa63effdd8815a733acb146f7acd5bfa6203eef103c22ba79f1b170fc3de9085b52cd6086b37d86d32d7da2110af2896e8ce562f191648c47c6e924b33292
-  data.tar.gz: f06564822787aa2e4c01072a450f12dc7ba78539457bef069ed6c38708d8989bf03b1881b4bd9a26e3e0ae2ffa3002bf455bcc959b403424cafc019728be98fb
+  metadata.gz: 15705758d8ce779bb448d285a26ac8f79d97c074dd80758ad02eafd90fc2300296c6bfa3f2be28bc4f06fac96bb46f5601ab1f57b7e5684642070c7e7ae90088
+  data.tar.gz: 0ab155ded33d5eeafeb3c5719d88aca244af590f5596cd4e6326a2552f455ac96fffe4d33878a4d5ed90c6aaef45325d3d3654b58c4879f203219a06474f6a07

data/lib/sidekiq/fairplay/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Fairplay
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-fairplay
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Baygeldin
@@ -179,32 +179,18 @@ dependencies:
         version: '7.0'
 email:
 - a.baygeldin@gmail.com
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".standard.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- gemfiles/sidekiq_7.gemfile
-- gemfiles/sidekiq_8.gemfile
 - lib/sidekiq/fairplay.rb
 - lib/sidekiq/fairplay/config.rb
 - lib/sidekiq/fairplay/middleware.rb
 - lib/sidekiq/fairplay/planner.rb
 - lib/sidekiq/fairplay/redis.rb
 - lib/sidekiq/fairplay/version.rb
-- sidekiq-fairplay.gemspec
-- spec/sidekiq/fairplay_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/baygeldin/sidekiq-fairplay
 licenses:
 - MIT

data/.github/workflows/ci.yml

@@ -1,76 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ main, master ]
-  pull_request:
-    branches: [ main, master ]
-
-jobs:
-  test:
-    name: Test (Ruby ${{ matrix.ruby }}, Sidekiq ${{ matrix.sidekiq }})
-    runs-on: ubuntu-latest
-    timeout-minutes: 15
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['3.4']
-        sidekiq: ['7', '8']
-
-    services:
-      redis:
-        image: redis:7-alpine
-        ports:
-          - 6379:6379
-        options: >-
-          --health-cmd "redis-cli ping || exit 1"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Select Gemfile for Sidekiq ${{ matrix.sidekiq }}
-        run: |
-          export BUNDLE_GEMFILE="gemfiles/sidekiq_${{ matrix.sidekiq }}.gemfile"
-          echo "BUNDLE_GEMFILE=$BUNDLE_GEMFILE" >> $GITHUB_ENV
-
-      - name: Bundle install
-        run: bundle install --jobs 4 --retry 3
-
-      - name: Run specs
-        env:
-          REDIS_URL: redis://localhost:6379/1
-        run: |
-          bundle exec rspec --format progress
-
-      - uses: qltysh/qlty-action/coverage@v2
-        if: matrix.sidekiq == '8' && matrix.ruby == '3.4'
-        with:
-          token: ${{secrets.QLTY_COVERAGE_TOKEN}}
-          files: coverage/.resultset.json
-
-  lint:
-    name: Lint (standardrb)
-    runs-on: ubuntu-latest
-    continue-on-error: true
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.4'
-          bundler-cache: true
-
-      - name: Run StandardRB
-        run: bundle exec standardrb

data/.gitignore

@@ -1,37 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-spec/examples.txt
-.byebug_history
-
-## Documentation cache and generated files
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# System files
-.DS_Store
-
-# Editors
-.vscode
-.ruby-lsp
-
-# Unnecessary for Ruby gems
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-.tool-versions

data/.standard.yml

@@ -1,9 +0,0 @@
-plugins:
-  - standard-performance
-  - standard-rspec
-
-ignore:
-  - 'spec/**/*_spec.rb':
-    - RSpec/MultipleMemoizedHelpers
-    - RSpec/MultipleExpectations
-    - RSpec/ExampleLength

data/Gemfile

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

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "standard/rake"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: %i[spec standard]

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "sidekiq/fairplay"
-
-require "pry"
-Pry.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/gemfiles/sidekiq_7.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem "sidekiq", "~> 7.0"

data/gemfiles/sidekiq_8.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem "sidekiq", "~> 8.0"

data/sidekiq-fairplay.gemspec

@@ -1,37 +0,0 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "sidekiq/fairplay/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "sidekiq-fairplay"
-  spec.version = Sidekiq::Fairplay::VERSION
-  spec.authors = ["Alexander Baygeldin"]
-  spec.email = ["a.baygeldin@gmail.com"]
-  spec.summary = <<~SUMMARY
-    Make Sidekiq play fair — dynamic job prioritization for multi-tenant apps.
-  SUMMARY
-  spec.homepage = "http://github.com/baygeldin/sidekiq-fairplay"
-  spec.license = "MIT"
-
-  spec.files = `git ls-files -z`.split("\x0")
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 3.4.0"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry", "~> 0.15"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-sidekiq", "~> 5.0"
-  spec.add_development_dependency "standard", "~> 1.0"
-  spec.add_development_dependency "standard-performance", "~> 1.0"
-  spec.add_development_dependency "standard-rspec", "~> 0.3"
-  spec.add_development_dependency "simplecov", "~> 0.22"
-  spec.add_development_dependency "timecop", "~> 0.9"
-
-  spec.add_dependency "activesupport", "~> 7.0"
-  spec.add_runtime_dependency "sidekiq", "~> 7.0"
-
-  spec.metadata["rubygems_mfa_required"] = "true"
-end

data/spec/sidekiq/fairplay_spec.rb

@@ -1,301 +0,0 @@
-require "spec_helper"
-
-class RegularJob
-  include Sidekiq::Job
-
-  def perform(foo)
-  end
-end
-
-class FairplayJob
-  include Sidekiq::Job
-  include Sidekiq::Fairplay::Job
-
-  def perform(tenant_key, foo)
-  end
-end
-
-RSpec.describe Sidekiq::Fairplay do
-  before do
-    FairplayJob.sidekiq_fairplay_options \
-      enqueue_interval:,
-      enqueue_jobs:,
-      planner_queue:,
-      planner_lock_ttl:,
-      latency_threshold:,
-      tenant_key:,
-      tenant_weights:
-  end
-
-  let(:enqueue_interval) { 1 }
-  let(:enqueue_jobs) { 10 }
-  let(:planner_queue) { "default" }
-  let(:planner_lock_ttl) { 60 }
-  let(:latency_threshold) { 60 }
-  let(:tenant_key) { ->(tenant_key, *_args) { tenant_key } }
-  let(:tenant_weights) { ->(tenant_keys) { tenant_keys.to_h { |tid| [tid, 1] } } }
-
-  describe "fairness (probabilistic)" do
-    # Seed Ruby's PRNG for deterministic results
-    around do |example|
-      prev = srand(1234)
-      example.run
-    ensure
-      srand(prev)
-    end
-
-    let(:enqueue_jobs) { 1000 }
-    let(:tenant_weights) do
-      ->(tenant_ids) do
-        mapping = {"t1" => 1, "t2" => 3, "t3" => 6}
-        tenant_ids.to_h { |tid| [tid, mapping.fetch(tid, 1)] }
-      end
-    end
-
-    it "enqueues approximately proportional to weights" do
-      enqueue_jobs.times do |i|
-        FairplayJob.perform_async("t1", "a#{i}")
-        FairplayJob.perform_async("t2", "b#{i}")
-        FairplayJob.perform_async("t3", "c#{i}")
-      end
-
-      Sidekiq::Fairplay::Planner.new.perform("FairplayJob")
-
-      expect(FairplayJob).to have_enqueued_sidekiq_job.exactly(enqueue_jobs)
-
-      jobs_per_tenant = FairplayJob.jobs.each_with_object(Hash.new(0)) do |job, memo|
-        memo[job["args"].first] += 1
-      end
-
-      expected_jobs_per_tenant = {"t1" => 100, "t2" => 300, "t3" => 600}
-      tolerance = 0.25 # 25% tolerance to avoid flakiness across Ruby versions
-
-      expected_jobs_per_tenant.each do |tid, exp|
-        low = (exp * (1 - tolerance)).floor
-        high = (exp * (1 + tolerance)).ceil
-
-        expect(jobs_per_tenant[tid]).to be_between(low, high).inclusive
-      end
-    end
-  end
-
-  describe "basic functionality" do
-    it "intercepts fairplay jobs and enqueues them later" do
-      FairplayJob.perform_async("t1", "a")
-      FairplayJob.perform_async("t2", "b")
-      FairplayJob.perform_async("t3", "c")
-
-      expect(FairplayJob).not_to have_enqueued_sidekiq_job
-      expect(Sidekiq::Fairplay::Planner)
-        .to have_enqueued_sidekiq_job("FairplayJob")
-        .exactly(1)
-        .immediately
-
-      Sidekiq::Fairplay::Planner.perform_one
-
-      expect(FairplayJob).to have_enqueued_sidekiq_job.exactly(3)
-      expect(FairplayJob).to have_enqueued_sidekiq_job("t1", "a")
-      expect(FairplayJob).to have_enqueued_sidekiq_job("t2", "b")
-      expect(FairplayJob).to have_enqueued_sidekiq_job("t3", "c")
-    end
-
-    context "with custom planner queue" do
-      let(:planner_queue) { "whatever" }
-
-      it "enqueues the planner job on the configured queue" do
-        FairplayJob.perform_async("t1", "a")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(Sidekiq::Fairplay::Planner)
-          .to have_enqueued_sidekiq_job("FairplayJob")
-          .on(planner_queue)
-          .in(enqueue_interval.to_i)
-
-        expect(FairplayJob)
-          .to have_enqueued_sidekiq_job("t1", "a")
-          .on("default") # default queue for FairplayJob
-      end
-    end
-
-    context "when latency threshold exceeded" do
-      let(:queue) { instance_double(Sidekiq::Queue) }
-
-      before do
-        allow(Sidekiq::Queue).to receive(:new).and_return(queue)
-        allow(queue).to receive(:latency).and_return(latency_threshold.to_i + 1)
-      end
-
-      it "reschedules the planner without enqueuing jobs" do
-        FairplayJob.perform_async("t1", "a")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(FairplayJob).not_to have_enqueued_sidekiq_job
-        expect(Sidekiq::Fairplay::Planner)
-          .to have_enqueued_sidekiq_job("FairplayJob")
-          .in(enqueue_interval.to_i)
-      end
-    end
-
-    context "with custom weights" do
-      let(:tenant_weights) do
-        ->(tenant_ids) do
-          tenant_ids.to_h do |tid|
-            [tid, (tid == "t1") ? 1 : 0]
-          end
-        end
-      end
-
-      it "uses weights to prefer specific tenant" do
-        FairplayJob.perform_async("t1", "a")
-        FairplayJob.perform_async("t2", "b")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(FairplayJob).to have_enqueued_sidekiq_job.exactly(1)
-        expect(FairplayJob).to have_enqueued_sidekiq_job("t1", "a")
-        expect(FairplayJob).not_to have_enqueued_sidekiq_job("t2", "b")
-      end
-    end
-
-    context "when too many jobs in the queue" do
-      let(:enqueue_jobs) { 1 }
-
-      it "respects the enqueue_jobs limit" do
-        FairplayJob.perform_async("t1", "a")
-        FairplayJob.perform_async("t1", "b")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(FairplayJob).to have_enqueued_sidekiq_job.exactly(1)
-        expect(FairplayJob)
-          .to have_enqueued_sidekiq_job("t1", "a")
-          .or have_enqueued_sidekiq_job("t1", "b")
-      end
-    end
-  end
-
-  describe "edge cases" do
-    it "ignores unknown job class" do
-      Sidekiq::Fairplay::Planner.new.perform("UnknownJob")
-
-      expect(Sidekiq::Fairplay::Planner).not_to have_enqueued_sidekiq_job
-      expect(FairplayJob).not_to have_enqueued_sidekiq_job
-    end
-
-    it "has no effect on regular jobs" do
-      RegularJob.perform_async("foo")
-
-      expect(RegularJob).to have_enqueued_sidekiq_job("foo")
-      expect(Sidekiq::Fairplay::Planner).not_to have_enqueued_sidekiq_job
-    end
-
-    it "has no effect on scheduled jobs" do
-      FairplayJob.perform_in(5, "t1", "a")
-
-      expect(FairplayJob).to have_enqueued_sidekiq_job("t1", "a").in(5)
-      expect(Sidekiq::Fairplay::Planner).not_to have_enqueued_sidekiq_job
-    end
-
-    context "with zero weights for all tenants" do
-      let(:tenant_weights) do
-        ->(tenant_ids) { tenant_ids.to_h { |tid| [tid, 0] } }
-      end
-
-      it "enqueues no jobs" do
-        FairplayJob.perform_async("t1", "a")
-        FairplayJob.perform_async("t2", "b")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(FairplayJob).not_to have_enqueued_sidekiq_job
-      end
-    end
-  end
-
-  describe "errors" do
-    let(:tenant_key) { ->(_tid, *_args) {} }
-
-    it "raises when tenant key resolves to nil" do
-      tenant_key
-
-      expect { FairplayJob.perform_async("t1", "a") }
-        .to raise_error(ArgumentError, /tenant key cannot be nil/)
-    end
-  end
-
-  describe "implementation details" do
-    it "reschedules planning for the next interval" do
-      FairplayJob.perform_async("t1", "a")
-
-      Sidekiq::Fairplay::Planner.perform_one
-
-      expect(Sidekiq::Fairplay::Planner)
-        .to have_enqueued_sidekiq_job("FairplayJob")
-        .in(enqueue_interval.to_i)
-    end
-
-    context "when planner_lock_ttl is being held" do
-      let(:planner_lock_ttl) { 42 }
-
-      before do
-        redis = Sidekiq::Fairplay::Redis.new
-        redis.try_acquire_planner_lock(FairplayJob, "some_jid")
-      end
-
-      it "blocks planning until the TTL expires" do
-        FairplayJob.perform_async("t1", "a")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(FairplayJob).not_to have_enqueued_sidekiq_job
-        expect(Sidekiq::Fairplay::Planner)
-          .to have_enqueued_sidekiq_job("FairplayJob")
-          .in(enqueue_interval.to_i)
-      end
-    end
-
-    context "when tenant_key and tenant_weights refer to class methods" do
-      before do
-        class << FairplayJob
-          def static_tenant_key(tid, *_args) = tid
-          def static_tenant_weights(tids) = tids.to_h { |tid| [tid, 1] }
-        end
-      end
-
-      let(:tenant_key) { ->(tid, *args) { static_tenant_key(tid, *args) } }
-      let(:tenant_weights) { ->(tids) { static_tenant_weights(tids) } }
-
-      it "works as expected" do
-        FairplayJob.perform_async("t1", "a")
-        FairplayJob.perform_async("t2", "b")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(FairplayJob).to have_enqueued_sidekiq_job.exactly(2)
-        expect(FairplayJob).to have_enqueued_sidekiq_job("t1", "a")
-        expect(FairplayJob).to have_enqueued_sidekiq_job("t2", "b")
-      end
-    end
-
-    context "when using ActiveSupport::Duration" do
-      let(:enqueue_interval) { 1.minute }
-      let(:latency_threshold) { 1.hour }
-      let(:planner_lock_ttl) { 10.seconds }
-
-      it "handles durations correctly" do
-        FairplayJob.perform_async("t1", "a")
-
-        Sidekiq::Fairplay::Planner.perform_one
-
-        expect(Sidekiq::Fairplay::Planner)
-          .to have_enqueued_sidekiq_job("FairplayJob")
-          .in(enqueue_interval.to_i)
-
-        expect(FairplayJob).to have_enqueued_sidekiq_job.exactly(1)
-        expect(FairplayJob).to have_enqueued_sidekiq_job("t1", "a")
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,63 +0,0 @@
-$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
-
-require "rubygems"
-require "bundler/setup"
-require "timecop"
-require "simplecov"
-
-require "sidekiq"
-require "rspec-sidekiq"
-require "sidekiq/fairplay"
-require "pry"
-
-SimpleCov.start do
-  add_filter "spec"
-end
-
-Sidekiq::Fairplay.logger = nil
-
-Sidekiq.configure_client do |config|
-  config.redis = {db: 1}
-  config.logger = nil
-
-  config.client_middleware do |chain|
-    chain.add Sidekiq::Fairplay::Middleware
-  end
-end
-
-Sidekiq.configure_server do |config|
-  config.redis = {db: 1}
-  config.logger = nil
-
-  config.client_middleware do |chain|
-    chain.add Sidekiq::Fairplay::Middleware
-  end
-end
-
-RSpec::Sidekiq.configure do |config|
-  config.clear_all_enqueued_jobs = true
-  config.warn_when_jobs_not_processed_by_sidekiq = false
-end
-
-RSpec.configure do |config|
-  config.order = :random
-  config.run_all_when_everything_filtered = true
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  config.before do
-    Sidekiq.redis do |conn|
-      keys = conn.call("KEYS", "fairplay*")
-      keys.each { |key| conn.call("DEL", key) }
-    end
-  end
-
-  config.before do
-    Timecop.freeze
-  end
-
-  config.after do
-    Timecop.return
-  end
-end
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")