sidekiq-history 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c189112d4823a4d54d8a5a32f4b27e9060ca1a84
-  data.tar.gz: 41e45ae2c8a55aa9e28d372ff01de40a02aa6772
+  metadata.gz: e960876faa26b6bc5144bf2651c229e9863f4c01
+  data.tar.gz: 41f8495091e1fa008ff9f19cf4165c0939544e3b
 SHA512:
-  metadata.gz: 8e3aa1e54ad7d6987528ad19d5557f090dacf7bdefee24400ad6a80ca97349c668ab18b3c939096c17cc1e1528b2dcacfca91dce49eb3f052cd490e49b0e7d3b
-  data.tar.gz: 8fd4405a7368e0fdf800298bbc66acbc71e51bfc8670322a593318469184258b299924825138e3c78d335cb3541305b77740c3d1b49786e9766f43c9b7704dcd
+  metadata.gz: de904b6ec8eae8dc5416d00c09c07af70eb0e5288a15f05c0d5a6020d8e1522f967b0587566b8fde41d2ae8d65fc9c13616b76c86ef3ee22163fd241a24a5d61
+  data.tar.gz: 87d356426ec6ab4025880a983d0d02c6dd501914f9e103a560710da04588eff2f9fbfc11866fd6a66ed6ae4db2874063c4e84ea7a311449fe404d816187ef155

data/README.md

@@ -20,9 +20,9 @@ Or install it yourself as:
 
 Nothing left to do. Mount sidekiq, and go to the web interface. You'll see a shiny new History tab!
 
-By default it will keep history on the last 1000 jobs.  To change that set `Sidekiq::History::Middleware::MAX_COUNT = 10000`.  Be careful because the data is persisted in Redis Sorted Set and it WILL take up RAM.  Max possible value is 4294967295 per Redis limit.
+By default it will keep history on the last 1000 jobs.  To change that set `Sidekiq.history_max_count = 10000`.  Be careful because the data is persisted in Redis Sorted Set and it WILL take up RAM.  Max possible value is 4294967295 per Redis limit.
 
-If you want to only record history for specific jobs you can set `Sidekiq::History::Middleware::EXCLUDE_JOBS = ['OneJob']` (do not record for specified jobs) and `Sidekiq::History::Middleware::INCLUDE_JOBS = ['AnotherJob']` (record ONLY jobs specified).  INCLUDE will take precedence so if you set it to blank array nothing will be recorded.
+If you want to only record history for specific jobs you can set `Sidekiq.history_exclude_jobs = ['OneJob']` (do not record for specified jobs) and `Sidekiq.history_include_jobs = ['AnotherJob']` (record ONLY jobs specified).  INCLUDE will take precedence so if you set it to blank array nothing will be recorded.
 
 ## Screenshot
 

data/lib/sidekiq/history.rb

@@ -9,26 +9,51 @@ module Sidekiq
   end
 
   def self.history_max_count
-    # => use default 1000 unless specified in config.  Max is 4294967295 per Redis Sorted Set limit
-    if defined? MAX_COUNT
-      hmc = [MAX_COUNT, 4294967295].min
-    else
-      hmc = 1000
-    end
+    # => use default 1000 unless specified in config.
+    # Max is 4294967295 per Redis Sorted Set limit
+    hmc = if defined? MAX_COUNT
+            [MAX_COUNT, 4_294_967_295].min
+          else
+            1000
+          end
     return hmc if @history_max_count.nil?
     @history_max_count
   end
 
+  def self.history_exclude_jobs=(value)
+    @history_exclude_jobs = value
+  end
+
+  def self.history_exclude_jobs
+    if defined? Sidekiq::History::Middleware::EXCLUDE_JOBS
+      jobs = Sidekiq::History::Middleware::EXCLUDE_JOBS
+    end
+    return jobs if @history_exclude_jobs.nil?
+    @history_exclude_jobs
+  end
+
+  def self.history_include_jobs=(value)
+    @history_include_jobs = value
+  end
+
+  def self.history_include_jobs
+    if defined? Sidekiq::History::Middleware::INCLUDE_JOBS
+      jobs = Sidekiq::History::Middleware::INCLUDE_JOBS
+    end
+    return jobs if @history_include_jobs.nil?
+    @history_include_jobs
+  end
+
   module History
     LIST_KEY = :history
 
     def self.reset_history(options = {})
-      Sidekiq.redis { |c|
+      Sidekiq.redis do |c|
         c.multi do
           c.del(LIST_KEY)
           c.set('stat:history', 0) if options[:counter] || options['counter']
         end
-      }
+      end
     end
 
     def self.count
@@ -40,9 +65,7 @@ module Sidekiq
         super LIST_KEY
       end
     end
-
   end
-
 end
 
 Sidekiq.configure_server do |config|

data/lib/sidekiq/history/middleware.rb

@@ -7,14 +7,22 @@ module Sidekiq
 
       attr_accessor :msg
 
-      def call(worker, msg, queue)
+      def call(_worker, msg, queue)
         self.msg = msg
-        job_class = msg['class']
+
+        # Use the Sidekiq API to unwrap the job
+        job = Sidekiq::Job.new(msg)
+        job_class = job.display_class
+
+        # Setup a unwraped copy of the bare job data
+        payload = msg.dup
+        payload['class'] = job_class
+        payload['args'] = job.display_args
 
         data = {
           started_at: Time.now.utc,
-          payload: msg,
-          worker: msg['class'],
+          payload: payload,
+          worker: job_class,
           processor: "#{identity}-#{Thread.current.object_id}",
           queue: queue
         }
@@ -28,7 +36,8 @@ module Sidekiq
             list.each do |entry|
               migrated_data = JSON.parse(entry)
               if record_history(job_class) == true
-                conn.zadd(LIST_KEY, data[:started_at].to_f, Sidekiq.dump_json(migrated_data))
+                conn.zadd(LIST_KEY, data[:started_at].to_f,
+                          Sidekiq.dump_json(migrated_data))
               end
             end
           end
@@ -48,25 +57,17 @@ module Sidekiq
       private
 
       # check if this job should be recorded
-      def record_history job_class
-        # first check inclusion
-        if defined? INCLUDE_JOBS
-          if INCLUDE_JOBS.include? job_class
-            return true
-          else
-            return false
-          end
-        elsif defined? EXCLUDE_JOBS
-          if EXCLUDE_JOBS.include? job_class
-            return false
-          else
-            return true
-          end
-        else
-          return true
+      def record_history(job_class)
+        # first check inclusion, when present
+        # it will take precedence over exclude
+        if !Sidekiq.history_include_jobs.nil?
+          return Sidekiq.history_include_jobs.include?(job_class)
+        elsif !Sidekiq.history_exclude_jobs.nil?
+          return !Sidekiq.history_exclude_jobs.include?(job_class)
         end
-      end
 
+        true
+      end
     end
   end
 end

data/lib/sidekiq/history/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module History
-    VERSION = "0.0.9"
+    VERSION = '0.0.10'.freeze
   end
 end

data/lib/sidekiq/history/web_extension.rb

@@ -1,7 +1,7 @@
 module Sidekiq
   module History
     module WebExtension
-      ROOT = File.expand_path('../../../../web', __FILE__)
+      ROOT = File.expand_path('../../../web', __dir__)
 
       def self.registered(app)
         app.get '/history' do

data/web/views/history.erb

@@ -24,7 +24,9 @@
         <td>
           <%= relative_time(Time.parse(entry['started_at'])) %>
         </td>
-        <td><%= entry.queue %></td>
+        <td>
+          <a href="<%= root_path %>queues/<%= entry.queue %>"><%= entry.queue %></a>
+        </td>
         <td>
           <%= entry['payload']['class'] %>
         </td>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-history
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Russ Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: History for sidekiq jobs.