sidekiq-job_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3c554ad234720879c74de12d2cf115cb1708012
+  data.tar.gz: cc071f88a7897b1b81e0bd4969b0100b3e046544
+SHA512:
+  metadata.gz: f2a7a616be721bb98f986d7e730a8417fc4aa4a92807dd2b9dcf4825299f18b68f47d822d55cd76aed0604821e8e8db9861e80a4e0fb5f5bd92aaf3a3e5b6d24
+  data.tar.gz: f20aed8dca5422ad05d0b541ba158b214b4c55e9dc9b0333cfc67cad8fddbf86ddd2186e4a391b458167a1f4fa9337a8cee9a75fdf5917176a54335999e9d5e0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 vala
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sidekiq::JobMonitor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/sidekiq-job_monitor.coffee

@@ -0,0 +1,36 @@
+@Sidekiq ?= {}
+
+class Sidekiq.JobMonitor
+  constructor: (markup, options = {}) ->
+    @$el = $(markup)
+    @monitorURL = @$el.data('monitor-url')
+    setTimeout(@monitorProgress, 1000)
+    $('body').trigger('start', [this])
+    options.onStart?(@$el)
+
+  monitorProgress: =>
+    $.getJSON(@monitorURL)
+      .done(@onMonitorProgressData)
+      .fail(@jobFailed)
+
+  onMonitorProgressData: (data) =>
+    if data.state is 'complete'
+      @jobComplete(data)
+    else
+      setTimeout(@monitorProgress, 1000)
+
+  jobComplete: (data) ->
+    console.log "trigger completion : ", this, data
+    @$el.trigger('complete', [this, data])
+
+  jobFailed: =>
+    @$el.trigger('failed', [this])
+
+  trigger: (eventName, args...) ->
+    args = [this].concat(args)
+    @$el.trigger(eventName, args)
+
+$.fn.sidekiqJobMonitor = (options = {}) ->
+  @each (i, el) ->
+    $(el).on 'ajax:success', (e, response) ->
+      new Sidekiq.JobMonitor(response, options)

data/app/assets/javascripts/sidekiq_job_monitor/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/sidekiq_job_monitor/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/sidekiq/job_monitor/application_controller.rb

@@ -0,0 +1,6 @@
+module Sidekiq
+  module JobMonitor
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/sidekiq/job_monitor/job_progress_controller.rb

@@ -0,0 +1,22 @@
+module Sidekiq
+  module JobMonitor
+    class JobProgressController < ApplicationController
+      def show
+        job = Sidekiq::JobMonitor::Job.find(params[:id])
+        # Fail and return 404 if no job was found
+        return head 404 unless job
+        # The only intersting data from the job is its state,
+        # arguments shouldn't be returned to the client
+        data = { id: job.attributes['jid'], state: job.state }
+        # Allow the worker class to hook into data serialization by calling
+        # the #monitoring_data instance method with the job arguments and state
+        # as arguments
+        if (monitoring_data = job.monitoring_data)
+          data.merge!(monitoring_data)
+        end
+
+        render json: data
+      end
+    end
+  end
+end

data/app/helpers/sidekiq/job_monitor/application_helper.rb

@@ -0,0 +1,6 @@
+module Sidekiq
+  module JobMonitor
+    module ApplicationHelper
+    end
+  end
+end

data/app/views/layouts/sidekiq/job_monitor/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sidekiq::JobMonitor</title>
+  <%= stylesheet_link_tag    "sidekiq/job_monitor/application", media: "all" %>
+  <%= javascript_include_tag "sidekiq/job_monitor/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Sidekiq::JobMonitor::Engine.routes.draw do
+  resources :job_progress, only: [:show]
+end

data/lib/sidekiq/job_monitor.rb

@@ -0,0 +1,11 @@
+require 'sidekiq/api'
+
+require 'sidekiq/job_monitor/job'
+require 'sidekiq/job_monitor/middleware'
+
+require 'sidekiq/job_monitor/engine'
+
+module Sidekiq
+  module JobMonitor
+  end
+end

data/lib/sidekiq/job_monitor/engine.rb

@@ -0,0 +1,7 @@
+module Sidekiq
+  module JobMonitor
+    class Engine < ::Rails::Engine
+      isolate_namespace Sidekiq::JobMonitor
+    end
+  end
+end

data/lib/sidekiq/job_monitor/job.rb

@@ -0,0 +1,84 @@
+module Sidekiq
+  module JobMonitor
+    class Job
+      attr_reader :attributes
+
+      def initialize(attributes)
+        @attributes = attributes.as_json(only: %w(class jid args state))
+      end
+
+      def save
+        Sidekiq.redis do |conn|
+          conn.set(store_key, serialize)
+          # Expire key in 1 hours to avoid garbage keys
+          conn.expire(store_key, 3_600) if conn.ttl(store_key) == -1
+        end
+      end
+
+      def store_key
+        @store_key ||= self.class.store_key_for(attributes['jid'])
+      end
+
+      def serialize
+        attributes.to_json
+      end
+
+      def state
+        @state ||= attributes['state'] || 'pending'
+      end
+
+      # Add #processing!, #complete! and #failed! methods
+      %w(processing complete failed).each do |key|
+        define_method(:"#{ key }!") do
+          self.state = key
+          save
+        end
+      end
+
+      def state=(value)
+        @state = attributes['state'] = value
+      end
+
+      def as_json(*args)
+        attributes.as_json(*args)
+      end
+
+      def worker
+        attributes['class'].constantize
+      end
+
+      def monitoring_data
+        worker_instance = worker.new
+
+        if worker_instance.respond_to?(:monitoring_data)
+          worker_instance.monitoring_data(*attributes['args'], state)
+        end
+      end
+
+      class << self
+        def find(jid)
+          find_in_queues(jid) || find_in_previous(jid)
+        end
+
+        def store_key_for(jid)
+          ['sidekiq-job_monitor', jid].join(':')
+        end
+
+        private
+
+        def find_in_queues(jid)
+          job = Sidekiq::Queue.new.find_job(jid)
+          new(job.item) if job
+        end
+
+        def find_in_previous(jid)
+          data = Sidekiq.redis do |conn|
+            conn.get(store_key_for(jid))
+          end
+
+          new(JSON.parse(data)) if data
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/job_monitor/middleware.rb

@@ -0,0 +1,27 @@
+module Sidekiq
+  module JobMonitor
+    class Middleware
+      # Wrap Sidekiq default job execution with completion and failure handling
+      # to make previous jobs tracking easy
+      def call(worker, msg, queue)
+        job = Sidekiq::JobMonitor::Job.new(msg)
+
+        job.processing!
+
+        begin
+          yield
+          job.complete!
+        rescue
+          job.failed!
+          raise
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::JobMonitor::Middleware
+  end
+end

data/lib/sidekiq/job_monitor/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module JobMonitor
+    VERSION = "0.1.0"
+  end
+end

data/lib/tasks/sidekiq_job_monitor_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sidekiq_job_monitor do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-job_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Monitor currently running Sidekiq jobs to give user feedback
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/sidekiq-job_monitor.coffee
+- app/assets/javascripts/sidekiq_job_monitor/application.js
+- app/assets/stylesheets/sidekiq_job_monitor/application.css
+- app/controllers/sidekiq/job_monitor/application_controller.rb
+- app/controllers/sidekiq/job_monitor/job_progress_controller.rb
+- app/helpers/sidekiq/job_monitor/application_helper.rb
+- app/views/layouts/sidekiq/job_monitor/application.html.erb
+- config/routes.rb
+- lib/sidekiq/job_monitor.rb
+- lib/sidekiq/job_monitor/engine.rb
+- lib/sidekiq/job_monitor/job.rb
+- lib/sidekiq/job_monitor/middleware.rb
+- lib/sidekiq/job_monitor/version.rb
+- lib/tasks/sidekiq_job_monitor_tasks.rake
+homepage: https://github.com/glyph-fr/sidekiq-job_monitor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Monitor currently running Sidekiq jobs to give user feedback
+test_files: []