sidekiq-status 0.3.2 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70899fafcf4e5aa712b2df57e34700cba6d001fe
+  data.tar.gz: cd4801e8d4678b515f3a597438953c3430066a30
+SHA512:
+  metadata.gz: 1669fb78f47cc77930d4b93f7c7a1537526d426cf0e99c4c5bb8b13e271ed66711e15276959a381216710aca8cfac60f90fc0790719db2c9a8f4c3faaa046a41
+  data.tar.gz: d7e697fdb8ee26e50f125b73b44abe2f5c796e74ad9242d76bc85964e526c33b9d81916fa49a3623c29bb55b2b9a5126b30db8e730c5668d34d1a6f7dbcfd024

data/CHANGELOG

@@ -0,0 +1 @@
+Version 0.4.0:WebUI added, per-worker expiration setting enabled

data/README.md

@@ -31,6 +31,9 @@ Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Sidekiq::Status::ServerMiddleware, expiration: 30.minutes # default
   end
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Status::ClientMiddleware
+  end
 end
 ```
 
@@ -46,6 +49,24 @@ class MyJob
 end
 ```
 
+To overwrite expiration on worker basis and don't use global expiration for all workers write a expiration method like this below:
+
+``` ruby
+class MyJob
+  include Sidekiq::Worker
+
+  def expiration
+    @expiration ||= 60*60*24*30 # 30 days
+  end
+
+  def perform(*args)
+    # your code goes here
+  end
+end
+```
+
+But keep in mind that such thing will store details of job as long as expiration is set, so it may charm your Redis storage/memory consumption. Because Redis stores all data in RAM.
+
 ### Retrieving status
 
 Query for job status any time later:
@@ -122,9 +143,9 @@ To use `sidekiq-status` inlining, require it too in your `{test,spec}_helper.rb`
 
 ### Features coming
 * Stopping jobs by id
-* Minimal web UI
 
 ## Thanks
+* Clay Allsopp
 * Andrew Korzhuev
 * Jon Moses
 * Wayne Hoover
@@ -132,4 +153,4 @@ To use `sidekiq-status` inlining, require it too in your `{test,spec}_helper.rb`
 
 ## License
 MIT License , see LICENSE for more details.
-© 2012 - 2013 Evgeniy Tsvigun
+© 2012 - 2014 Evgeniy Tsvigun

data/lib/sidekiq-status.rb

@@ -3,6 +3,7 @@ require 'sidekiq-status/storage'
 require 'sidekiq-status/worker'
 require 'sidekiq-status/client_middleware'
 require 'sidekiq-status/server_middleware'
+require 'sidekiq-status/web' if defined?(Sidekiq::Web)
 
 module Sidekiq::Status
   extend Storage

data/lib/sidekiq-status/server_middleware.rb

@@ -24,7 +24,14 @@ module Sidekiq::Status
     def call(worker, msg, queue)
       # a way of overriding default expiration time,
       # so worker wouldn't lose its data
-      worker.expiration = @expiration  if worker.respond_to? :expiration
+      # and it allows also to overwrite global expiration time on worker basis
+      if worker.respond_to? :expiration
+        if !worker.expiration && worker.respond_to?(:expiration=)
+          worker.expiration = @expiration
+        else
+          @expiration = worker.expiration
+        end
+      end
 
       store_status worker.jid, :working,  @expiration
       yield

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = "0.3.2"
+    VERSION = "0.4.0"
   end
 end

data/lib/sidekiq-status/web.rb

@@ -0,0 +1,46 @@
+# adapted from https://github.com/cryo28/sidekiq_status
+
+module Sidekiq::Status
+  # Hook into *Sidekiq::Web* Sinatra app which adds a new "/statuses" page
+  module Web
+    # Location of Sidekiq::Status::Web view templates
+    VIEW_PATH = File.expand_path('../../../web/views', __FILE__)
+
+    # @param [Sidekiq::Web] app
+    def self.registered(app)
+      app.helpers do
+        def sidekiq_status_template(name)
+          path = File.join(VIEW_PATH, name.to_s) + ".erb"
+          File.open(path).read
+        end
+      end
+
+      app.get '/statuses' do
+        queue = Sidekiq::Workers.new
+        @statuses = []
+
+        queue.each do |name, work, started_at|
+          job = Struct.new(:jid, :klass, :args).new(work["payload"]["jid"], work["payload"]["class"], work["payload"]["args"])
+          status = Sidekiq::Status::get_all job.jid
+          next if !status || status.count <= 2
+          status["worker"] = job.klass
+          status["args"] = job.args
+          status["jid"] = job.jid
+          status["pct_complete"] = ((status["num"].to_f / status["total"].to_f) * 100).to_i
+          @statuses << OpenStruct.new(status)
+        end
+
+        erb(sidekiq_status_template(:statuses))
+      end
+    end
+  end
+end
+
+require 'sidekiq/web' unless defined?(Sidekiq::Web)
+Sidekiq::Web.register(Sidekiq::Status::Web)
+if Sidekiq::Web.tabs.is_a?(Array)
+  # For sidekiq < 2.5
+  Sidekiq::Web.tabs << "statuses"
+else
+  Sidekiq::Web.tabs["Statuses"] = "statuses"
+end

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

@@ -40,6 +40,27 @@ describe Sidekiq::Status::ServerMiddleware do
       StubJob.perform_async(:arg1 => 'val1').should == job_id
       (1..Sidekiq::Status::DEFAULT_EXPIRY).should cover redis.ttl(job_id)
     end
+  end
+
+  describe ":expiration parameter" do
+    let(:huge_expiration) { Sidekiq::Status::DEFAULT_EXPIRY * 100 }
+    before do
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
+    end
+    it "overwrites default expiry value" do
+      start_server(:expiration => huge_expiration) do
+        StubJob.perform_async(:arg1 => 'val1')
+      end
+      ((Sidekiq::Status::DEFAULT_EXPIRY+1)..huge_expiration).should cover redis.ttl(job_id)
+    end
 
+    it "can be overwritten by worker expiration method" do
+      overwritten_expiration = huge_expiration * 100
+      StubJob.any_instance.stub(expiration: overwritten_expiration)
+      start_server(:expiration => huge_expiration) do
+        StubJob.perform_async(:arg1 => 'val1')
+      end
+      ((huge_expiration+1)..overwritten_expiration).should cover redis.ttl(job_id)
+    end
   end
-end
+end

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

@@ -10,4 +10,13 @@ describe Sidekiq::Status::Worker do
       StubJob.perform_async().should == job_id
     end
   end
-end
+
+  describe ".expiration" do
+    subject { StubJob.new }
+    it "allows to set/get expiration" do
+      expect(subject.expiration).to be_nil
+      subject.expiration = :val
+      expect(subject.expiration).to eq(:val)
+    end
+  end
+end

data/spec/lib/sidekiq-status_spec.rb

@@ -120,19 +120,13 @@ describe Sidekiq::Status do
   end
 
   context "keeps normal Sidekiq functionality" do
+    let(:expiration_param) { nil }
+
     it "does jobs with and without included worker module" do
-      SecureRandom.should_receive(:hex).exactly(4).times.and_return(plain_sidekiq_job_id, plain_sidekiq_job_id, job_id_1, job_id_1)
-      start_server do
-        capture_status_updates(12) {
-          StubJob.perform_async.should == plain_sidekiq_job_id
-          NoStatusConfirmationJob.perform_async(1)
-          StubJob.perform_async.should == job_id_1
-          NoStatusConfirmationJob.perform_async(2)
-        }.should =~ [plain_sidekiq_job_id, job_id_1] * 6
-      end
-      redis.mget('NoStatusConfirmationJob_1', 'NoStatusConfirmationJob_2').should == %w(done)*2
-      Sidekiq::Status.status(plain_sidekiq_job_id).should == :complete
-      Sidekiq::Status.status(job_id_1).should == :complete
+      seed_secure_random_with_job_ids
+      run_2_jobs!
+      expect_2_jobs_are_done_and_status_eq :complete
+      expect_2_jobs_ttl_covers 1..Sidekiq::Status::DEFAULT_EXPIRY
     end
 
     it "retries failed jobs" do
@@ -144,6 +138,52 @@ describe Sidekiq::Status do
       end
       Sidekiq::Status.status(retried_job_id).should == :complete
     end
+
+    context ":expiration param" do
+      before { seed_secure_random_with_job_ids }
+      let(:expiration_param) { Sidekiq::Status::DEFAULT_EXPIRY * 100 }
+
+      it "allow to overwrite :expiration parameter" do
+        run_2_jobs!
+        expect_2_jobs_are_done_and_status_eq :complete
+        expect_2_jobs_ttl_covers (Sidekiq::Status::DEFAULT_EXPIRY+1)..expiration_param
+      end
+
+      it "allow to overwrite :expiration parameter by .expiration method from worker" do
+        overwritten_expiration = expiration_param * 100
+        NoStatusConfirmationJob.any_instance.stub(:expiration => overwritten_expiration)
+        StubJob.any_instance.stub(:expiration => overwritten_expiration)
+        run_2_jobs!
+        expect_2_jobs_are_done_and_status_eq :complete
+        expect_2_jobs_ttl_covers (expiration_param+1)..overwritten_expiration
+      end
+    end
+
+    def seed_secure_random_with_job_ids
+      SecureRandom.should_receive(:hex).exactly(4).times.and_return(plain_sidekiq_job_id, plain_sidekiq_job_id, job_id_1, job_id_1)
+    end
+
+    def run_2_jobs!
+      start_server(:expiration => expiration_param) do
+        capture_status_updates(12) {
+          StubJob.perform_async.should == plain_sidekiq_job_id
+          NoStatusConfirmationJob.perform_async(1)
+          StubJob.perform_async.should == job_id_1
+          NoStatusConfirmationJob.perform_async(2)
+        }.should =~ [plain_sidekiq_job_id, job_id_1] * 6
+      end
+    end
+
+    def expect_2_jobs_ttl_covers(range)
+      range.should cover redis.ttl(plain_sidekiq_job_id)
+      range.should cover redis.ttl(job_id_1)
+    end
+
+    def expect_2_jobs_are_done_and_status_eq(status)
+      redis.mget('NoStatusConfirmationJob_1', 'NoStatusConfirmationJob_2').should == %w(done)*2
+      Sidekiq::Status.status(plain_sidekiq_job_id).should == status
+      Sidekiq::Status.status(job_id_1).should == status
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -44,7 +44,7 @@ def capture_status_updates(n, &block)
   confirmations_thread(n, "status_updates", &block).value
 end
 
-def start_server()
+def start_server(server_middleware_options={})
   pid = Process.fork do
     $stdout.reopen File::NULL, 'w'
     $stderr.reopen File::NULL, 'w'
@@ -53,7 +53,7 @@ def start_server()
     Sidekiq.configure_server do |config|
       config.redis = Sidekiq::RedisConnection.create
       config.server_middleware do |chain|
-        chain.add Sidekiq::Status::ServerMiddleware
+        chain.add Sidekiq::Status::ServerMiddleware, server_middleware_options
       end
     end
     Sidekiq::CLI.instance.run

data/web/views/statuses.erb

@@ -0,0 +1,36 @@
+<h3 class="wi">Recent job statuses</h3>
+
+
+<table class="table table-striped table-bordered">
+  <tr>
+    <th>Worker/jid</th>
+    <th>Status</th>
+    <th>Last Updated ↆ</th>
+    <th>Progress</th>
+    <th>Message</th>
+  </tr>
+  <% @statuses.each do |container| -%>
+    <tr>
+      <td>
+          <%= container.worker %>
+          <br />
+          <%= container.jid %>
+      </td>
+      <td><%= container.status %></td>
+      <td><%= Time.at(container.update_time.to_i) %></td>
+      <td>
+        <div class="progress progress-striped" style="margin-bottom: 0">
+          <div class="bar" style="width: <%= container.pct_complete %>%; text-shadow: 1px 1px 1px black; background-color: #AD003D;
+color: white;">
+            <%= container.pct_complete %>%
+          </div>
+        </div>
+      <td><%= container.message %></td>
+    </tr>
+  <% end -%>
+  <% if @statuses.empty? -%>
+    <tr>
+      <td colspan="6"></td>
+    </tr>
+  <% end -%>
+</table>

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Evgeniy Tsvigun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,33 +27,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -69,6 +62,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -79,6 +73,7 @@ files:
 - lib/sidekiq-status/storage.rb
 - lib/sidekiq-status/testing/inline.rb
 - lib/sidekiq-status/version.rb
+- lib/sidekiq-status/web.rb
 - lib/sidekiq-status/worker.rb
 - sidekiq-status.gemspec
 - spec/lib/sidekiq-status/client_middleware_spec.rb
@@ -88,30 +83,30 @@ files:
 - spec/lib/sidekiq-status_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_jobs.rb
+- web/views/statuses.erb
 homepage: http://github.com/utgarda/sidekiq-status
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs
 test_files:
 - spec/lib/sidekiq-status/client_middleware_spec.rb