sidekiq-status 2.0.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45893560f4594985006d2842f460861137e46903197e173761ad9bcd96db5b49
-  data.tar.gz: 5de9712752bf085f4792e4e018709e1fc9436a5f246c3c39ad4b0916df3f8df3
+  metadata.gz: 73189e5075131660e13e76ce8e8eeedd84953c90998941dd73a16825dc96d951
+  data.tar.gz: 5923bc75138cee22d8b5edcc5fbb9ad42dad4e0d89f29df74df68656a73adadc
 SHA512:
-  metadata.gz: ee2aa4d21c57403eb01b7fe5a011301dc2a085ffd8aa7498252684f7456d480a82642381c3a9cab970c9fbe9f3275db585de492a0574a474de8604c555f63853
-  data.tar.gz: 0bef9d092bf1c756195fcb46828ca3b85754cb597878d7d52164afb70f492a01416d45672d3de9cad7c7256afb366e1b736f7709ab1ebc5d34d85dc64f5756ff
+  metadata.gz: '09e500e508e3a0d309e5d817a0fb7e1f58b9013f32284608ae5e2512bd556d07e7846c240789a2df4d5790f0aa183b3623181fd14acb12fd14a863ae354f627e'
+  data.tar.gz: 37b1eb9dec966fc8d8645c0ea4139d9a4cee715aca5c5b988881d63599d77e4d7cc564472a3f72e58923b8fb903ed0254c123821dafa2122c622e0dfc5b1e3ca

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - ruby-head
 gemfile:
   - gemfiles/sidekiq_5.x.gemfile
+  - gemfiles/sidekiq_6.1.gemfile
   - gemfiles/sidekiq_6.x.gemfile
 before_install:
   - gem update --system

data/Appraisals

@@ -2,6 +2,10 @@ appraise "sidekiq-5.x" do
   gem "sidekiq", "~> 5"
 end
 
+appraise "sidekiq-6.1" do
+  gem "sidekiq", "~> 6.1"
+end
+
 appraise "sidekiq-6.x" do
   gem "sidekiq", "~> 6"
 end

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+**Version 2.1.3**
+* Fixes redis deprecation warnings (https://github.com/kenaniah/sidekiq-status/issues/11)
+
+**Version 2.1.2**
+ * Casts values to strings when HTML-encoding
+
+**Version 2.1.1**
+ * 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)
+
+**Version 2.0.2**
+ * Fixes for dark mode theme
+
 **Version 2.0.1**
  * Adds support for dark mode to the job status page
 

data/gemfiles/sidekiq_6.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.1"
+
+gemspec path: "../"

data/lib/sidekiq-status/client_middleware.rb

@@ -1,4 +1,6 @@
 require 'sidekiq/api'
+JOB_CLASS = Sidekiq.constants.include?(:JobRecord) ? Sidekiq::JobRecord : Sidekiq::Job
+
 module Sidekiq::Status
 # Should be in the client middleware chain
   class ClientMiddleware
@@ -34,7 +36,7 @@ module Sidekiq::Status
         initial_metadata = {
           jid: msg['jid'],
           status: :queued,
-          worker: Sidekiq::Job.new(msg, queue).display_class,
+          worker: JOB_CLASS.new(msg, queue).display_class,
           args: display_args(msg, queue)
         }
         store_for_id msg['jid'], initial_metadata, job_class.new.expiration || @expiration, redis_pool
@@ -45,7 +47,7 @@ module Sidekiq::Status
     end
 
     def display_args(msg, queue)
-      job = Sidekiq::Job.new(msg, queue)
+      job = JOB_CLASS.new(msg, queue)
       return job.display_args.to_a.empty? ? nil : job.display_args.to_json
     rescue Exception => e
       # For Sidekiq ~> 2.7

data/lib/sidekiq-status/storage.rb

@@ -13,10 +13,10 @@ module Sidekiq::Status::Storage
   # @return [String] Redis operation status code
   def store_for_id(id, status_updates, expiration = nil, redis_pool=nil)
     redis_connection(redis_pool) do |conn|
-      conn.multi do
-        conn.hmset  key(id), 'update_time', Time.now.to_i, *(status_updates.to_a.flatten(1))
-        conn.expire key(id), (expiration || Sidekiq::Status::DEFAULT_EXPIRY)
-        conn.publish "status_updates", id
+      conn.multi do |pipeline|
+        pipeline.hmset  key(id), 'update_time', Time.now.to_i, *(status_updates.to_a.flatten(1))
+        pipeline.expire key(id), (expiration || Sidekiq::Status::DEFAULT_EXPIRY)
+        pipeline.publish "status_updates", id
       end[0]
     end
   end

data/lib/sidekiq-status/version.rb

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

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

@@ -12,13 +12,13 @@ describe Sidekiq::Status::ClientMiddleware do
   describe "without :expiration parameter" do
 
     it "sets queued status" do
-      expect(StubJob.perform_async arg1: 'val1').to eq(job_id)
+      expect(StubJob.perform_async 'arg1' => 'val1').to eq(job_id)
       expect(redis.hget("sidekiq:status:#{job_id}", :status)).to eq('queued')
       expect(Sidekiq::Status::queued?(job_id)).to be_truthy
     end
 
     it "sets status hash ttl" do
-      expect(StubJob.perform_async arg1: 'val1').to eq(job_id)
+      expect(StubJob.perform_async 'arg1' => 'val1').to eq(job_id)
       expect(1..Sidekiq::Status::DEFAULT_EXPIRY).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
 
@@ -50,7 +50,7 @@ describe Sidekiq::Status::ClientMiddleware do
     end
 
     it "overwrites default expiry value" do
-      StubJob.perform_async arg1: 'val1'
+      StubJob.perform_async 'arg1' => 'val1'
       expect((Sidekiq::Status::DEFAULT_EXPIRY+1)..huge_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
 

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

@@ -10,7 +10,7 @@ describe Sidekiq::Status::ServerMiddleware 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)
+        expect(ConfirmationJob.perform_async 'arg1' => 'val1').to eq(job_id)
         expect(thread.value).to eq([
           job_id,
           job_id,
@@ -90,7 +90,7 @@ describe Sidekiq::Status::ServerMiddleware do
     it "sets status hash ttl" do
       allow(SecureRandom).to receive(:hex).once.and_return(job_id)
       start_server do
-        expect(StubJob.perform_async arg1: 'val1').to eq(job_id)
+        expect(StubJob.perform_async 'arg1' => 'val1').to eq(job_id)
       end
       expect(1..Sidekiq::Status::DEFAULT_EXPIRY).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
@@ -104,7 +104,7 @@ describe Sidekiq::Status::ServerMiddleware do
 
     it "overwrites default expiry value" do
       start_server(:expiration => huge_expiration) do
-        StubJob.perform_async arg1: 'val1'
+        StubJob.perform_async 'arg1' => 'val1'
       end
       expect((Sidekiq::Status::DEFAULT_EXPIRY-1)..huge_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
     end
@@ -113,7 +113,7 @@ describe Sidekiq::Status::ServerMiddleware do
       overwritten_expiration = huge_expiration * 100
       allow_any_instance_of(StubJob).to receive(:expiration).and_return(overwritten_expiration)
       start_server(:expiration => huge_expiration) do
-        StubJob.perform_async arg1: 'val1'
+        StubJob.perform_async 'arg1' => 'val1'
       end
       expect((huge_expiration+1)..overwritten_expiration).to cover redis.ttl("sidekiq:status:#{job_id}")
     end

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

@@ -61,7 +61,7 @@ describe 'sidekiq status web' do
     get "/statuses/#{job_id}"
     expect(last_response).to be_ok
     expect(last_response.body).to match(/#{job_id}/)
-    expect(last_response.body).to match(/1,"another argument"/)
+    expect(last_response.body).to match(/1,"another argument"/)
     expect(last_response.body).to match(/working/)
   end
 

data/spec/lib/sidekiq-status_spec.rb

@@ -159,7 +159,7 @@ describe Sidekiq::Status do
     end
 
     it "retries failed jobs" do
-      allow(SecureRandom).to receive(:hex).and_return(retried_job_id)
+      allow(SecureRandom).to receive(:hex).exactly(3).times.and_return(retried_job_id)
       start_server do
         expect(capture_status_updates(3) {
           expect(RetriedJob.perform_async()).to eq(retried_job_id)

data/spec/support/test_jobs.rb

@@ -119,13 +119,13 @@ end
 
 class RetriedJob < StubJob
 
-  sidekiq_options 'retry' => true
+  sidekiq_options retry: true
   sidekiq_retry_in do |count| 3 end # 3 second delay > job timeout in test suite
 
-  def perform()
+  def perform
     Sidekiq.redis do |conn|
       key = "RetriedJob_#{jid}"
-      unless conn.exists key
+      if [0, false].include? conn.exists(key)
         conn.set key, 'tried'
         raise StandardError
       end

data/web/views/status.erb

@@ -1,3 +1,4 @@
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
 <style>
   .progress {
     background-color: #C8E1ED;
@@ -14,9 +15,9 @@
 </style>
 
 <h3>
-  Job Status: <%= @status["jid"] %>
-  <span class='label label-<%= @status["label"] %>'>
-    <%= @status["status"] %>
+  Job Status: <%= h @status["jid"] %>
+  <span class='label label-<%= h @status["label"] %>'>
+    <%= h @status["status"] %>
   </span>
 </h3>
 
@@ -30,14 +31,14 @@
 
 <div class="panel panel-default" style="background-color: inherit">
   <div class="panel-body">
-    <h4><%= @status["worker"] %></h4>
+    <h4><%= h @status["worker"] %></h4>
 
     <div class="row">
       <div class="col-sm-2">
         <strong>Arguments</strong>
       </div>
       <div class="col-sm-10">
-        <p><%= @status["args"].empty? ? "<i>none</i>" : @status["args"] %></p>
+        <p><%= @status["args"].empty? ? "<i>none</i>" : h(@status["args"]) %></p>
       </div>
     </div>
 
@@ -46,7 +47,7 @@
         <strong>Message</strong>
       </div>
       <div class="col-sm-10">
-        <p><%= @status["message"] || "<i>none</i>" %></p>
+        <p><%= h(@status["message"]) || "<i>none</i>" %></p>
       </div>
     </div>
 
@@ -75,9 +76,9 @@
           </div>
           <div class="col-sm-10">
             <% if val && val.include?("\n") %>
-              <pre><%= val %></pre>
+              <pre><%= h val %></pre>
             <% else  %>
-              <p><%= val || "<i>none</i>" %></p>
+              <p><%= h(val) || "<i>none</i>" %></p>
             <% end %>
           </div>
         </div>

data/web/views/status_not_found.erb

@@ -1,5 +1,6 @@
-<h3>Job Status: <%= params[:jid] %></h3>
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
+<h3>Job Status: <%= h params[:jid] %></h3>
 
-<div class="alert alert-danger" role="alert">
+<div role="alert">
   <strong>Uh oh!</strong> That job can't be found. It may have expired already.
 </div>

data/web/views/statuses.erb

@@ -1,3 +1,4 @@
+<% require 'cgi'; def h(v); CGI.escape_html(v.to_s); end %>
 <style>
 .progress {
   background-color: #C8E1ED;
@@ -76,11 +77,11 @@ function setPerPage(select){
     </div>
   </div>
 </div>
-<table class="table table-hover table-bordered table-striped table-white">
+<table class="table table-hover table-bordered table-striped">
   <tr>
-    <% @headers.each do |h| %>
-      <th class="header <%= h[:class] %> header_<%= h[:id] %>">
-        <a href="<%= h[:url] %>"><%= h[:name] %></a>
+    <% @headers.each do |hdr| %>
+      <th class="header <%= h hdr[:class] %> header_<%= h hdr[:id] %>">
+        <a href="<%= h hdr[:url] %>"><%= h hdr[:name] %></a>
       </th>
     <% end %>
     <th class="header">
@@ -90,13 +91,13 @@ function setPerPage(select){
   <% @statuses.each do |container| %>
     <tr>
       <td>
-        <div title='<%= container["jid"] %>'><a href="<%= root_path %>statuses/<%= container["jid"] %>"><%= container["worker"] %></a></div>
+        <div title='<%= h container["jid"] %>'><a href="<%= root_path %>statuses/<%= h container["jid"] %>"><%= h container["worker"] %></a></div>
       </td>
       <td>
-        <div class='args' title='<%= container["jid"] %>'><%= container["args"] %></div>
+        <div class='args' title='<%= h container["jid"] %>'><%= h container["args"] %></div>
       </td>
       <td style='text-align: center;'>
-        <div class='label label-<%= container["label"] %>'><%= container["status"] %></div>
+        <div class='label label-<%= h container["label"] %>'><%= h container["status"] %></div>
       </td>
       <% secs = Time.now.to_i - container["update_time"].to_i %>
       <td style='text-align: center; white-space: nowrap;' title="<%= Time.at(container["update_time"].to_i) %>">
@@ -109,11 +110,11 @@ function setPerPage(select){
       <td>
         <div class="progress progress-striped" style="margin-bottom: 0">
           <div class='message' style='text-align:right; padding-right:0.5em; background-color: transparent; float:right;'>
-            <%= container["message"] %>
+            <%= h container["message"] %>
           </div>
           <% if container["pct_complete"].to_i > 0 %>
-            <div class="bar message" style="width: <%= container["pct_complete"] %>%;">
-              <%= container["pct_complete"] %>%
+            <div class="bar message" style="width: <%= h container["pct_complete"] %>%;">
+              <%= h container["pct_complete"] %>%
             </div>
           <% end %>
         </div>
@@ -121,7 +122,7 @@ function setPerPage(select){
       <td>
         <div class="actions">
           <form action="statuses" method="post">
-            <input type="hidden" name="jid" value="<%= container["jid"] %>" />
+            <input type="hidden" name="jid" value="<%= h container["jid"] %>" />
             <%= csrf_tag %>
             <% if container["status"] == "complete" %>
               <input type="hidden" name="_method" value="delete" />

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Evgeniy Tsvigun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -142,6 +142,7 @@ files:
 - README.md
 - Rakefile
 - gemfiles/sidekiq_5.x.gemfile
+- gemfiles/sidekiq_6.1.gemfile
 - gemfiles/sidekiq_6.x.gemfile
 - lib/sidekiq-status.rb
 - lib/sidekiq-status/client_middleware.rb
@@ -186,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs