sidekiq-status 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73189e5075131660e13e76ce8e8eeedd84953c90998941dd73a16825dc96d951
-  data.tar.gz: 5923bc75138cee22d8b5edcc5fbb9ad42dad4e0d89f29df74df68656a73adadc
+  metadata.gz: 5188215b7cc5735ac70ba8ea4fa9d62df0a2b8d317b901540bf9665bbf5b0e9a
+  data.tar.gz: 4db9d510d4a0908c6a6763f1b89075fa7e031779387c8c05d7940719a3da404f
 SHA512:
-  metadata.gz: '09e500e508e3a0d309e5d817a0fb7e1f58b9013f32284608ae5e2512bd556d07e7846c240789a2df4d5790f0aa183b3623181fd14acb12fd14a863ae354f627e'
-  data.tar.gz: 37b1eb9dec966fc8d8645c0ea4139d9a4cee715aca5c5b988881d63599d77e4d7cc564472a3f72e58923b8fb903ed0254c123821dafa2122c622e0dfc5b1e3ca
+  metadata.gz: de2e9e08e65532dce024e2250e641b6a25833fdf5e977c86860018225c7769538d16076c627eb2f90af1ac4b9b0e035fc347c3651bcae06af43a4e622eef147b
+  data.tar.gz: 3b1508b26d23b45b48692e033d78341dd65ca81f9382bd2498cee07f236b781a176c52dbb079a37409242ffd61632266d00e5c99e60d37eba434e495245117bd

data/.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+name: Ruby CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+        gemfile:
+          - 'gemfiles/sidekiq_6.1.gemfile'
+          - 'gemfiles/sidekiq_6.x.gemfile'
+          - 'gemfiles/sidekiq_7.x.gemfile'
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+          rubygems: latest
+      - name: Run tests
+        run: |
+          bundle exec rake test

data/CHANGELOG.md

@@ -1,26 +1,31 @@
+**Version 3.0.0**
+ - Drops support for Sidekiq 5.x
+ - Adds support for Sidekiq 7.x
+ - Migrates from Travis CI to GitHub Actions
+
 **Version 2.1.3**
-* Fixes redis deprecation warnings (https://github.com/kenaniah/sidekiq-status/issues/11)
+ - Fixes redis deprecation warnings (https://github.com/kenaniah/sidekiq-status/issues/11)
 
 **Version 2.1.2**
- * Casts values to strings when HTML-encoding
+ - Casts values to strings when HTML-encoding
 
 **Version 2.1.1**
- * Ensures parameter outputs are properly HTML-encoded
+ - Ensures parameter outputs are properly HTML-encoded
 
 **Version 2.1.0**
- * Adds support for Sidekiq 6.2.2+ (https://github.com/mperham/sidekiq/issues/4955)
+ - Adds support for Sidekiq 6.2.2+ (https://github.com/mperham/sidekiq/issues/4955)
 
 **Version 2.0.2**
- * Fixes for dark mode theme
+ - Fixes for dark mode theme
 
 **Version 2.0.1**
- * Adds support for dark mode to the job status page
+ - Adds support for dark mode to the job status page
 
 **Version 2.0.0**
- * Adds support for Ruby 2.7, 3.0
- * Adds support for Sidekiq 6.x
- * Removes support for Ruby 2.3, 2.4, 2.5
- * Removes support for Sidekiq 3.x, 4.x
+ - Adds support for Ruby 2.7, 3.0
+ - Adds support for Sidekiq 6.x
+ - Removes support for Ruby 2.3, 2.4, 2.5
+ - Removes support for Sidekiq 3.x, 4.x
 
 **Versions 1.1.4 and prior**
 

data/README.md

@@ -1,11 +1,11 @@
 # Sidekiq::Status
 [![Gem Version](https://badge.fury.io/rb/sidekiq-status.svg)](https://badge.fury.io/rb/sidekiq-status)
-[![Build Status](https://www.travis-ci.com/kenaniah/sidekiq-status.svg?branch=main)](https://www.travis-ci.com/github/kenaniah/sidekiq-status)
+[![Build Status](https://github.com/kenaniah/sidekiq-status/actions/workflows/ci.yaml/badge.svg)](https://github.com/kenaniah/sidekiq-status/actions/)
 [![Inline docs](https://inch-ci.org/github/kenaniah/sidekiq-status.svg?branch=main)](https://inch-ci.org/github/kenaniah/sidekiq-status)
 
 Sidekiq-status is an extension to [Sidekiq](https://github.com/mperham/sidekiq) that tracks information about your Sidekiq and provides a UI to that purpose. It was inspired by [resque-status](https://github.com/quirkey/resque-status).
 
-Requires Ruby 2.6+ and Sidekiq 5.0+ or newer.
+Requires Ruby 2.6+ and Sidekiq 6.0+ or newer.
 
 ## Installation
 

data/gemfiles/{sidekiq_5.x.gemfile → sidekiq_7.x.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "sidekiq", "~> 5"
+gem "sidekiq", "~> 7"
 
 gemspec path: "../"

data/lib/sidekiq-status/client_middleware.rb

@@ -48,7 +48,7 @@ module Sidekiq::Status
 
     def display_args(msg, queue)
       job = JOB_CLASS.new(msg, queue)
-      return job.display_args.to_a.empty? ? nil : job.display_args.to_json
+      return job.display_args.to_a.empty? ? "{}" : job.display_args.to_json
     rescue Exception => e
       # For Sidekiq ~> 2.7
       return msg['args'].to_a.empty? ? nil : msg['args'].to_json

data/lib/sidekiq-status/redis_adapter.rb

@@ -0,0 +1,18 @@
+# adapter for redis-rb client
+class Sidekiq::Status::RedisAdapter
+  def initialize(client)
+    @client = client
+  end
+
+  def scan(**options, &block)
+    @client.scan_each(**options, &block)
+  end
+
+  def schedule_batch(key, options)
+    @client.zrangebyscore key, options[:start], options[:end], limit: [options[:offset], options[:limit]]
+  end
+
+  def method_missing(method, *args)
+    @client.send(method, *args)
+  end
+end

data/lib/sidekiq-status/redis_client_adapter.rb

@@ -0,0 +1,14 @@
+# adapter for redis-client client
+class Sidekiq::Status::RedisClientAdapter
+  def initialize(client)
+    @client = client
+  end
+
+  def schedule_batch(key, options)
+    @client.zrange(key, options[:start], options[:end], :byscore, :limit, options[:offset], options[:limit])
+  end
+
+  def method_missing(method, *args)
+    @client.send(method, *args)
+  end
+end

data/lib/sidekiq-status/storage.rb

@@ -12,6 +12,7 @@ module Sidekiq::Status::Storage
   # @param [ConnectionPool] redis_pool optional redis connection pool
   # @return [String] Redis operation status code
   def store_for_id(id, status_updates, expiration = nil, redis_pool=nil)
+    status_updates.transform_values!(&:to_s)
     redis_connection(redis_pool) do |conn|
       conn.multi do |pipeline|
         pipeline.hmset  key(id), 'update_time', Time.now.to_i, *(status_updates.to_a.flatten(1))
@@ -36,7 +37,7 @@ module Sidekiq::Status::Storage
   # @param [String] id job id
   # @param [Num] job_unix_time, unix timestamp for the scheduled job
   def delete_and_unschedule(job_id, job_unix_time = nil)
-    Sidekiq.redis do |conn|
+    Sidekiq::Status.redis_adapter do |conn|
       scan_options = {offset: 0, conn: conn, start: (job_unix_time || '-inf'), end: (job_unix_time || '+inf')}
 
       while not (jobs = schedule_batch(scan_options)).empty?
@@ -66,7 +67,7 @@ module Sidekiq::Status::Storage
   # @param [String] Symbol field fetched field name
   # @return [String] Redis operation status code
   def read_field_for_id(id, field)
-    Sidekiq.redis do |conn|
+    Sidekiq::Status.redis_adapter do |conn|
       conn.hget(key(id), field)
     end
   end
@@ -75,8 +76,8 @@ module Sidekiq::Status::Storage
   # @param [String] id job id
   # @return [Hash] Hash stored in redis
   def read_hash_for_id(id)
-    Sidekiq.redis do |conn|
-      conn.hgetall key(id)
+    Sidekiq::Status.redis_adapter do |conn|
+      conn.hgetall(key(id))
     end
   end
 
@@ -90,7 +91,7 @@ module Sidekiq::Status::Storage
   #  -  end: end score (i.e. +inf or a unix timestamp)
   #  -  offset: current progress through (all) jobs (e.g.: 100 if you want jobs from 100 to BATCH_LIMIT)
   def schedule_batch(options)
-    options[:conn].zrangebyscore "schedule", options[:start], options[:end], limit: [options[:offset], BATCH_LIMIT]
+    Sidekiq::Status.wrap_redis_connection(options[:conn]).schedule_batch("schedule", options.merge(limit: BATCH_LIMIT))
   end
 
   # Searches the jobs Array for the job_id

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = '2.1.3'
+    VERSION = '3.0.0'
   end
 end

data/lib/sidekiq-status/web.rb

@@ -81,8 +81,8 @@ module Sidekiq::Status
 
       app.get '/statuses' do
 
-        jids = Sidekiq.redis do |conn|
-          conn.scan_each(match: 'sidekiq:status:*', count: 100).map do |key|
+        jids = Sidekiq::Status.redis_adapter do |conn|
+          conn.scan(match: 'sidekiq:status:*', count: 100).map do |key|
             key.split(':').last
           end.uniq
         end

data/lib/sidekiq-status/worker.rb

@@ -11,14 +11,14 @@ module Sidekiq::Status::Worker
   # @param [Hash] status_updates updated values
   # @return [String] Redis operation status code
   def store(hash)
-    store_for_id @provider_job_id || @job_id || @jid, hash, @expiration
+    store_for_id @provider_job_id || @job_id || @jid || "", hash, @expiration
   end
 
   # Read value from job status hash
   # @param String|Symbol hask key
   # @return [String]
   def retrieve(name)
-    read_field_for_id @provider_job_id || @job_id || @jid, name
+    read_field_for_id @provider_job_id || @job_id || @jid || "", name
   end
 
   # Sets current task progress

data/lib/sidekiq-status.rb

@@ -2,6 +2,8 @@ require 'sidekiq-status/version'
 require 'sidekiq-status/sidekiq_extensions'
 require 'sidekiq-status/storage'
 require 'sidekiq-status/worker'
+require 'sidekiq-status/redis_client_adapter'
+require 'sidekiq-status/redis_adapter'
 require 'sidekiq-status/client_middleware'
 require 'sidekiq-status/server_middleware'
 require 'sidekiq-status/web' if defined?(Sidekiq::Web)
@@ -64,5 +66,17 @@ module Sidekiq::Status
     def message(job_id)
       get(job_id, :message)
     end
+
+    def wrap_redis_connection(conn)
+      if Sidekiq.major_version >= 7
+        conn.is_a?(RedisClientAdapter) ? conn : RedisClientAdapter.new(conn)
+      else
+        conn.is_a?(RedisAdapter) ? conn : RedisAdapter.new(conn)
+      end
+    end
+
+    def redis_adapter
+      Sidekiq.redis { |conn| yield wrap_redis_connection(conn) }
+    end
   end
 end

data/sidekiq-status.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Sidekiq::Status::VERSION
 
-  gem.add_dependency                  'sidekiq', '>= 5.0'
+  gem.add_dependency                  'sidekiq', '>= 6.0', '< 8'
   gem.add_dependency                  'chronic_duration'
   gem.add_development_dependency      'appraisal'
   gem.add_development_dependency      'colorize'

data/spec/lib/sidekiq-status/server_middleware_spec.rb

@@ -9,8 +9,9 @@ describe Sidekiq::Status::ServerMiddleware do
     it "sets working/complete status" do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       start_server do
-        thread = redis_thread 4, "status_updates", "job_messages_#{job_id}"
-        expect(ConfirmationJob.perform_async 'arg1' => 'val1').to eq(job_id)
+        thread = branched_redis_thread 4, "status_updates", "job_messages_#{job_id}" do
+          expect(ConfirmationJob.perform_async 'arg1' => 'val1').to eq(job_id)
+        end
         expect(thread.value).to eq([
           job_id,
           job_id,

data/spec/spec_helper.rb

@@ -60,8 +60,47 @@ def redis_thread messages_limit, *channels
 
 end
 
+def redis_client_thread message_limit, *channels
+  thread = Thread.new {
+    messages = []
+    Sidekiq.redis do |conn|
+      puts "Subscribing to #{channels} for #{message_limit.to_s.bold} messages".cyan if ENV['DEBUG']
+      pubsub = conn.pubsub
+      pubsub.call("SUBSCRIBE", *channels)
+
+      timeouts = 0
+      loop do
+        type, ch, msg = pubsub.next_event(2)
+        next if type == "subscribe"
+        if msg
+          puts "Message received: #{ch} -> #{msg}".white if ENV['DEBUG']
+          messages << msg
+          break if messages.length >= message_limit
+        else
+          # no new message was received in the allocated timeout
+          timeouts += 1
+          break if timeouts >= 30
+        end
+      end
+    end
+    puts "Returing from thread".cyan if ENV['DEBUG']
+    messages
+  }
+  sleep 0.1
+  yield if block_given?
+  thread.join
+end
+
+def branched_redis_thread n, *channels, &block
+  if Sidekiq.major_version < 7
+    redis_thread(n, *channels, &block)
+  else
+    redis_client_thread(n, *channels, &block)
+  end
+end
+
 def capture_status_updates n, &block
-  redis_thread(n, "status_updates", &block).value
+  branched_redis_thread(n, "status_updates", &block).value
 end
 
 # Configures server middleware and launches a sidekiq server
@@ -76,20 +115,19 @@ def start_server server_middleware_options = {}
 
     # Load and configure server options
     require 'sidekiq/cli'
-    Sidekiq.options[:queues] << 'default'
-    Sidekiq.options[:require] = File.expand_path 'environment.rb', File.dirname(__FILE__)
-    Sidekiq.options[:timeout] = 1
-    Sidekiq.options[:concurrency] = 5
 
     # Add the server middleware
     Sidekiq.configure_server do |config|
-      config.redis = Sidekiq::RedisConnection.create
+      config.concurrency = 5
+      config.redis = Sidekiq::RedisConnection.create if Sidekiq.major_version < 7
       Sidekiq::Status.configure_server_middleware config, server_middleware_options
     end
 
     # Launch
     puts "Server starting".yellow if ENV['DEBUG']
-    Sidekiq::CLI.instance.run
+    instance = Sidekiq::CLI.instance
+    instance.parse(['-r', File.expand_path('environment.rb', File.dirname(__FILE__))])
+    instance.run
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Evgeniy Tsvigun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -17,14 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: chronic_duration
   requirement: !ruby/object:Gem::Requirement
@@ -131,21 +137,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/sidekiq_5.x.gemfile
 - gemfiles/sidekiq_6.1.gemfile
 - gemfiles/sidekiq_6.x.gemfile
+- gemfiles/sidekiq_7.x.gemfile
 - lib/sidekiq-status.rb
 - lib/sidekiq-status/client_middleware.rb
+- lib/sidekiq-status/redis_adapter.rb
+- lib/sidekiq-status/redis_client_adapter.rb
 - lib/sidekiq-status/server_middleware.rb
 - lib/sidekiq-status/sidekiq_extensions.rb
 - lib/sidekiq-status/storage.rb
@@ -187,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-rvm:
-  - 2.6
-  - 2.7
-  - 3.0
-  - ruby-head
-gemfile:
-  - gemfiles/sidekiq_5.x.gemfile
-  - gemfiles/sidekiq_6.1.gemfile
-  - gemfiles/sidekiq_6.x.gemfile
-before_install:
-  - gem update --system
-  - gem update bundler
-services: redis
-notifications:
-  email: false
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head