sidekiq-job_monitor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b1d3e4b21e888c43304c1353a7cd44d9bd9fb7f
-  data.tar.gz: a4b8740f91c16aeb23fccf94f0c47c980857bb28
+  metadata.gz: 319d954ebcdf311eb5fa65d407ab02e466512a1e
+  data.tar.gz: 8e5f2abfba3189ec211b5fe2ff0d1dac61b490e0
 SHA512:
-  metadata.gz: 3549b4f766d1742c3222f316797c5ba60ac519579beb2b21a05ab752114fce74450ebca64284feeacd5c6d87666fc7415eb9992a016fb88a7a858592f5e22deb
-  data.tar.gz: b7810de4b7c3030f9feff07e38c28bc6ba68daddb2d3d993c819737ee8d3423ac781cc097c1a47fc5ca3f218f93c69a13dd0cd257ea936f0d1b6335c20e98120
+  metadata.gz: 541469c7e9534e2a55214d4f6066b95a01af869feede6bf6230b0a580821fcb6910e03aa64f1bcdafd09f288bd5fb1bd9a99d5dbe0865c11bad756de4c6e655c
+  data.tar.gz: e59303b4780c868f54e2b5ad0199bb5923ab2f22ccd7d1af7e6e477cda3081fdb6b06ce53855fc993dddfc4d9e5de0d410376578d64c5c1be287b747a36633a5

data/README.md

@@ -29,6 +29,12 @@ Mount the engine in your routes.rb :
 mount Sidekiq::JobMonitor::Engine => '/job-monitor', as: :job_monitor
 ```
 
+Then load the js library by adding the following to your `application.js` :
+
+```javascript
+//= require sidekiq-job_monitor
+```
+
 ## Usage
 
 The supported workflow for the gem is the following :

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

@@ -5,8 +5,9 @@ class Sidekiq.JobMonitor
     @$el = $(markup)
     @monitorURL = @$el.data('monitor-url')
     @monitor()
-    options.onStart?(@$el)
+    options.onStart?(this)
     @$el.on('stop', @stopMonitoring)
+    @$el.on('cancel', @cancelJob)
     $('body').trigger('start', [this])
 
   monitorProgress: =>
@@ -15,16 +16,15 @@ class Sidekiq.JobMonitor
       .fail(@jobFailed)
 
   onMonitorProgressData: (data) =>
-    if data.state is 'complete'
-      @jobComplete(data)
-    else
-      @monitor()
+    switch data.state
+      when 'complete' then @jobComplete(data)
+      when 'failed' then @jobFailed(data)
+      else @monitor()
 
   monitor: ->
     @monitorTimer = setTimeout(@monitorProgress, 1000)
 
   jobComplete: (data) ->
-    console.log "trigger completion : ", this, data
     @$el.trigger('complete', [this, data])
 
   jobFailed: =>
@@ -33,6 +33,23 @@ class Sidekiq.JobMonitor
   stopMonitoring: =>
     clearTimeout(@monitorTimer) if @monitorTimer
 
+  # Canceling job will only work for queued jobs, and not for running ones
+  #
+  # If the job is running, cancelation will be ignored and no error raised
+  #
+  cancelJob: =>
+    $.get(@remoteURL('cancel')).done(@jobCanceled)
+
+  jobCanceled: =>
+    @$el.trigger('canceled', [this])
+
+  remoteURL: (action = null) ->
+    return @monitorURL unless action
+    urlParts = @monitorURL.split('?')
+    url = [urlParts[0], action].join('/')
+    queryParams = urlParts[1]
+    if queryParams then [url, queryParams].join('?') else url
+
 $.fn.sidekiqJobMonitor = (options = {}) ->
   @each (i, el) ->
     $(el).on 'ajax:success', (e, response) ->

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

@@ -1,21 +1,37 @@
 module Sidekiq
   module JobMonitor
     class JobProgressController < ApplicationController
+      before_action :load_job
+
       def show
-        job = Sidekiq::JobMonitor::Job.find(params[:id])
+        render json: data
+      end
+
+      def cancel
+        @job.cancel
+        load_job # Reload job to update state
+        render json: data
+      end
+
+      private
+
+      def load_job
+        @job = Sidekiq::JobMonitor::Job.find(params[:id])
         # Fail and return 404 if no job was found
-        return head 404 unless job
+        head 404 unless @job
+      end
+
+      def data
         # 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)
+        { id: @job.attributes['jid'], state: @job.state }.tap do |data|
+          # 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
         end
-
-        render json: data
       end
     end
   end

data/config/routes.rb

@@ -1,3 +1,7 @@
 Sidekiq::JobMonitor::Engine.routes.draw do
-  resources :job_progress, only: [:show]
+  resources :job_progress, only: [:show] do
+    member do
+      get 'cancel'
+    end
+  end
 end

data/lib/sidekiq/job_monitor/job.rb

@@ -1,10 +1,11 @@
 module Sidekiq
   module JobMonitor
     class Job
-      attr_reader :attributes
+      attr_reader :attributes, :original_job
 
       def initialize(attributes)
         @attributes = attributes.as_json(only: %w(class jid args state))
+        @original_job = attributes[:original_job]
       end
 
       def save
@@ -49,12 +50,18 @@ module Sidekiq
 
       def monitoring_data
         worker_instance = worker.new
+        worker_instance.jid = attributes['jid']
 
         if worker_instance.respond_to?(:monitoring_data)
           worker_instance.monitoring_data(*attributes['args'], state)
         end
       end
 
+      def cancel
+        return unless original_job
+        original_job.delete
+      end
+
       class << self
         def find(jid)
           find_in_queues(jid) || find_in_previous(jid)
@@ -68,7 +75,10 @@ module Sidekiq
 
         def find_in_queues(jid)
           job = Sidekiq::Queue.new.find_job(jid)
-          new(job.item) if job
+          return unless job
+
+          attributes = { original_job: job }.merge(job.item)
+          new(attributes)
         end
 
         def find_in_previous(jid)

data/lib/sidekiq/job_monitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module JobMonitor
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-job_monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - vala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails