From 830cf1bf3d053873127a34a671c4c7f4f100d037 Mon Sep 17 00:00:00 2001 From: Dominik Sander Date: Tue, 26 Aug 2014 21:34:55 +0200 Subject: [PATCH] Simple job management page Also added a seperate `job-indicator` for every job state (pending/awaiting retry and failed) The jobs page is automatically reloading when jobs are enqueued, retried or failed. --- Gemfile | 3 - .../javascripts/worker-checker.js.coffee | 39 ++++++---- .../stylesheets/application.css.scss.erb | 7 +- app/assets/stylesheets/jobs.css.scss | 3 + app/controllers/application_controller.rb | 4 + app/controllers/jobs_controller.rb | 55 ++++++++++++++ app/helpers/application_helper.rb | 4 + app/helpers/jobs_helper.rb | 21 ++++++ app/views/jobs/index.html.erb | 73 +++++++++++++++++++ app/views/layouts/_navigation.html.erb | 28 ++++--- app/views/layouts/application.html.erb | 4 +- config/initializers/delayed_job.rb | 2 +- config/routes.rb | 12 ++- spec/controllers/jobs_controller_spec.rb | 67 +++++++++++++++++ spec/fixtures/users.yml | 3 +- spec/helpers/jobs_helper_spec.rb | 32 ++++++++ 16 files changed, 322 insertions(+), 35 deletions(-) create mode 100644 app/assets/stylesheets/jobs.css.scss create mode 100644 app/controllers/jobs_controller.rb create mode 100644 app/helpers/jobs_helper.rb create mode 100644 app/views/jobs/index.html.erb create mode 100644 spec/controllers/jobs_controller_spec.rb create mode 100644 spec/helpers/jobs_helper_spec.rb diff --git a/Gemfile b/Gemfile index e451f25c..978fcdd8 100644 --- a/Gemfile +++ b/Gemfile @@ -45,9 +45,6 @@ gem 'delayed_job', '~> 4.0.0' gem 'delayed_job_active_record', '~> 4.0.0' gem 'daemons', '~> 1.1.9' -# To enable DelayedJobWeb, see the 'Enable DelayedJobWeb' section of the README. -# gem 'delayed_job_web' - gem 'foreman', '~> 0.63.0' gem 'sass-rails', '~> 4.0.0' diff --git a/app/assets/javascripts/worker-checker.js.coffee b/app/assets/javascripts/worker-checker.js.coffee index 7e80cd88..4b8f4b8b 100644 --- a/app/assets/javascripts/worker-checker.js.coffee +++ b/app/assets/javascripts/worker-checker.js.coffee @@ -1,22 +1,29 @@ $ -> firstEventCount = null + previousJobs = null - if $("#job-indicator").length + if $(".job-indicator").length check = -> $.getJSON "/worker_status", (json) -> + for method in ['pending', 'awaiting_retry', 'recent_failures'] + count = json[method] + elem = $(".job-indicator[role=#{method}]") + if count > 0 + tooltipOptions = { + title: "#{count} jobs #{method.split('_').join(' ')}" + delay: 0 + placement: "bottom" + trigger: "hover" + } + if elem.is(":visible") + elem.tooltip('destroy').tooltip(tooltipOptions).find(".number").text(count) + else + elem.tooltip('destroy').tooltip(tooltipOptions).fadeIn().find(".number").text(count) + else + if elem.is(":visible") + elem.tooltip('destroy').fadeOut() + firstEventCount = json.event_count unless firstEventCount? - - if json.pending? && json.pending > 0 - tooltipOptions = { - title: "#{json.pending} jobs pending, #{json.awaiting_retry} awaiting retry, and #{json.recent_failures} recent failures" - delay: 0 - placement: "bottom" - trigger: "hover" - } - $("#job-indicator").tooltip('destroy').tooltip(tooltipOptions).fadeIn().find(".number").text(json.pending) - else - $("#job-indicator:visible").tooltip('destroy').fadeOut() - if firstEventCount? && json.event_count > firstEventCount $("#event-indicator").tooltip('destroy'). tooltip(title: "Click to reload", delay: 0, placement: "bottom", trigger: "hover"). @@ -26,6 +33,12 @@ $ -> else $("#event-indicator").tooltip('destroy').fadeOut() + currentJobs = [json.pending, json.awaiting_retry, json.recent_failures] + if document.location.pathname == '/jobs' && previousJobs? && previousJobs.join(',') != currentJobs.join(',') + $.get '/jobs', (data) => + $("#main-content").html(data) + previousJobs = currentJobs + window.workerCheckTimeout = setTimeout check, 2000 check() diff --git a/app/assets/stylesheets/application.css.scss.erb b/app/assets/stylesheets/application.css.scss.erb index 0e28bf53..837810f7 100644 --- a/app/assets/stylesheets/application.css.scss.erb +++ b/app/assets/stylesheets/application.css.scss.erb @@ -88,9 +88,10 @@ span.not-applicable:after { } // Navbar - -#job-indicator, #event-indicator { - display: none; +.nav > li { + &.job-indicator, &#event-indicator { + display: none; + } } .navbar-search > .spinner { diff --git a/app/assets/stylesheets/jobs.css.scss b/app/assets/stylesheets/jobs.css.scss new file mode 100644 index 00000000..d4d09a7c --- /dev/null +++ b/app/assets/stylesheets/jobs.css.scss @@ -0,0 +1,3 @@ +.big-modal-dialog { + width: 90% !important; +} \ No newline at end of file diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index 0b3132cb..e598c857 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -14,6 +14,10 @@ class ApplicationController < ActionController::Base devise_parameter_sanitizer.for(:account_update) { |u| u.permit(:username, :email, :password, :password_confirmation, :current_password) } end + def authenticate_admin! + redirect_to root_path unless current_user && current_user.admin + end + def upgrade_warning return unless current_user twitter_oauth_check diff --git a/app/controllers/jobs_controller.rb b/app/controllers/jobs_controller.rb new file mode 100644 index 00000000..d220adcd --- /dev/null +++ b/app/controllers/jobs_controller.rb @@ -0,0 +1,55 @@ +class JobsController < ApplicationController + before_filter :authenticate_admin! + + def index + @jobs = Delayed::Job.page(params[:page]) + + respond_to do |format| + format.html { render layout: !request.xhr? } + format.json { render json: @jobs } + end + end + + def destroy + @job = Delayed::Job.find(params[:id]) + + respond_to do |format| + if !running? && @job.destroy + format.html { redirect_to jobs_path, notice: "Job deleted." } + format.json { render json: "", status: :ok } + else + format.html { redirect_to jobs_path, alert: 'Can not delete a running job.' } + format.json { render json: "", status: :unprocessable_entity } + end + end + end + + def run + @job = Delayed::Job.find(params[:id]) + @job.last_error = nil + + respond_to do |format| + if !running? && @job.update_attributes!(run_at: Time.now, failed_at: nil) + format.html { redirect_to jobs_path, notice: "Job enqueued." } + format.json { render json: @job, status: :ok } + else + format.html { redirect_to jobs_path, alert: 'Can not enqueue a running job.' } + format.json { render json: "", status: :unprocessable_entity } + end + end + end + + def destroy_failed + Delayed::Job.where.not(failed_at: nil).destroy_all + + respond_to do |format| + format.html { redirect_to jobs_path, notice: "Failed jobs removed." } + format.json { render json: '', status: :ok } + end + end + + private + def running? + @job.locked_at || @job.locked_by + end +end diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb index 2e2074c0..a2b0ebbb 100644 --- a/app/helpers/application_helper.rb +++ b/app/helpers/application_helper.rb @@ -38,4 +38,8 @@ module ApplicationHelper link_to 'No', agent_path(agent, tab: (agent.recent_error_logs? ? 'logs' : 'details')), class: 'label label-danger' end end + + def user_is_admin? + current_user && current_user.admin == true + end end diff --git a/app/helpers/jobs_helper.rb b/app/helpers/jobs_helper.rb new file mode 100644 index 00000000..5fba11d7 --- /dev/null +++ b/app/helpers/jobs_helper.rb @@ -0,0 +1,21 @@ +module JobsHelper + + def status(job) + case + when job.failed_at + content_tag :span, 'failed', class: 'label label-danger' + when job.locked_at && job.locked_by + content_tag :span, 'running', class: 'label label-info' + else + content_tag :span, 'queued', class: 'label label-warning' + end + end + + def relative_distance_of_time_in_words(time) + if time < (now = Time.now) + time_ago_in_words(time) + ' ago' + else + 'in ' + distance_of_time_in_words(time, now) + end + end +end diff --git a/app/views/jobs/index.html.erb b/app/views/jobs/index.html.erb new file mode 100644 index 00000000..c4dda125 --- /dev/null +++ b/app/views/jobs/index.html.erb @@ -0,0 +1,73 @@ +
+
+
+
+

+ Background Jobs +

+
+ +
+ + + + + + + + + + + <% @jobs.each do |job| %> + + + + + + + + + <% end %> +
StatusCreatedNext RunAttemptsLast Error
<%= status(job) %><%= time_ago_in_words job.created_at %> ago + <% if !job.failed_at %> + <%= relative_distance_of_time_in_words job.run_at %> + <% end %> + <%= job.attempts %> + <%= truncate job.last_error, :length => 90, :omission => "", :separator => "\n" %> + + + <% if !job.locked_at && !job.locked_by %> +
+ <% if job.run_at > Time.now %> + <%= link_to 'Run now', run_job_path(job), class: "btn btn-default", method: :put %> + <% end %> + <%= link_to 'Delete', job_path(job), class: "btn btn-danger", method: :delete, data: { confirm: 'Really delete this job?' } %> +
+ <% end %> +
+
+ + <%= paginate @jobs, :theme => 'twitter-bootstrap-3' %> + +
+
+ <%= link_to destroy_failed_jobs_path, class: "btn btn-default", method: :delete do %> + Remove failed jobs + <% end %> +
+
+
+
+ diff --git a/app/views/layouts/_navigation.html.erb b/app/views/layouts/_navigation.html.erb index df28c65a..6ef2dc54 100644 --- a/app/views/layouts/_navigation.html.erb +++ b/app/views/layouts/_navigation.html.erb @@ -35,15 +35,19 @@ -
  • - <% if defined?(DelayedJobWeb) %> - - 0 - - <% else %> - - 0 - +
  • + <%= link_to jobs_path do %> + 0 + <% end %> +
    • +
  • + <%= link_to jobs_path do %> + 0 + <% end %> +
    • +
  • + <%= link_to jobs_path do %> + 0 <% end %>
  • @@ -66,7 +70,11 @@ <%= link_to 'Sign up', new_user_registration_path, :tabindex => "-1" %> <% end %>
    • - + <% if user_signed_in? && current_user.admin %> +
  • + <%= link_to 'Job Management', jobs_path, :tabindex => '-1' %> +
    • + <% end %>
  • <%= link_to 'About', 'https://github.com/cantino/huginn', :tabindex => "-1" %>
    • diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb index 6bcf34ee..dd79e596 100644 --- a/app/views/layouts/application.html.erb +++ b/app/views/layouts/application.html.erb @@ -28,7 +28,9 @@ <%= render "upgrade_warning" %> <% end %> - <%= yield %> +
    + <%= yield %> +
    diff --git a/config/initializers/delayed_job.rb b/config/initializers/delayed_job.rb index 0b295536..c3c7e78d 100644 --- a/config/initializers/delayed_job.rb +++ b/config/initializers/delayed_job.rb @@ -1,4 +1,4 @@ -Delayed::Worker.destroy_failed_jobs = true +Delayed::Worker.destroy_failed_jobs = false Delayed::Worker.max_attempts = 5 Delayed::Worker.max_run_time = 20.minutes Delayed::Worker.read_ahead = 5 diff --git a/config/routes.rb b/config/routes.rb index 37c3b46e..67e5a4ff 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -51,6 +51,15 @@ Huginn::Application.routes.draw do end end + resources :jobs, :only => [:index, :destroy] do + member do + put :run + end + collection do + delete :destroy_failed + end + end + get "/worker_status" => "worker_status#show" post "/users/:user_id/update_location/:secret" => "user_location_updates#create" @@ -58,9 +67,6 @@ Huginn::Application.routes.draw do match "/users/:user_id/web_requests/:agent_id/:secret" => "web_requests#handle_request", :as => :web_requests, :via => [:get, :post, :put, :delete] post "/users/:user_id/webhooks/:agent_id/:secret" => "web_requests#handle_request" # legacy -# To enable DelayedJobWeb, see the 'Enable DelayedJobWeb' section of the README. -# get "/delayed_job" => DelayedJobWeb, :anchor => false - devise_for :users, :sign_out_via => [ :post, :delete ] get '/auth/:provider/callback', to: 'services#callback' diff --git a/spec/controllers/jobs_controller_spec.rb b/spec/controllers/jobs_controller_spec.rb new file mode 100644 index 00000000..c6f3550d --- /dev/null +++ b/spec/controllers/jobs_controller_spec.rb @@ -0,0 +1,67 @@ +require 'spec_helper' + +describe JobsController do + + describe "GET index" do + before do + Delayed::Job.create + Delayed::Job.create + Delayed::Job.count.should > 0 + end + + it "does not allow normal users"do + sign_in users(:bob) + get(:index).should redirect_to(root_path) + end + it "returns all jobs", focus: true do + sign_in users(:jane) + get :index + assigns(:jobs).length.should == 2 + end + end + + describe "DELETE destroy" do + before do + @not_running = Delayed::Job.create + @running = Delayed::Job.create(locked_at: Time.now, locked_by: 'test') + sign_in users(:jane) + end + + it "destroy a job which is not running" do + expect { delete :destroy, id: @not_running.id }.to change(Delayed::Job, :count).by(-1) + end + + it "does not destroy a running job" do + expect { delete :destroy, id: @running.id }.to change(Delayed::Job, :count).by(0) + end + end + + describe "PUT run" do + before do + @not_running = Delayed::Job.create(run_at: Time.now - 1.hour) + @running = Delayed::Job.create(locked_at: Time.now, locked_by: 'test') + sign_in users(:jane) + end + + it "queue a job which is not running" do + expect { put :run, id: @not_running.id }.to change { @not_running.reload.run_at } + end + + it "not queue a running job" do + expect { put :run, id: @running.id }.not_to change { @not_running.reload.run_at } + end + end + + describe "DELETE destroy_failed" do + before do + @failed = Delayed::Job.create(failed_at: Time.now - 1.minute) + @running = Delayed::Job.create(locked_at: Time.now, locked_by: 'test') + sign_in users(:jane) + end + + it "just destroy failed jobs" do + expect { delete :destroy_failed, id: @failed.id }.to change(Delayed::Job, :count).by(-1) + expect { delete :destroy_failed, id: @running.id }.to change(Delayed::Job, :count).by(0) + end + end +end diff --git a/spec/fixtures/users.yml b/spec/fixtures/users.yml index fe553b4b..a8d9fb3b 100644 --- a/spec/fixtures/users.yml +++ b/spec/fixtures/users.yml @@ -10,4 +10,5 @@ jane: email: "jane@example.com" username: jane invitation_code: <%= User::INVITATION_CODES.last %> - scenario_count: 1 \ No newline at end of file + scenario_count: 1 + admin: true \ No newline at end of file diff --git a/spec/helpers/jobs_helper_spec.rb b/spec/helpers/jobs_helper_spec.rb new file mode 100644 index 00000000..105fbc3b --- /dev/null +++ b/spec/helpers/jobs_helper_spec.rb @@ -0,0 +1,32 @@ +require 'spec_helper' + +describe JobsHelper do + let(:job) { Delayed::Job.new } + + describe '#status' do + it "works for failed jobs" do + job.failed_at = Time.now + status(job).should == 'failed' + end + + it "works for running jobs" do + job.locked_at = Time.now + job.locked_by = 'test' + status(job).should == 'running' + end + + it "works for queued jobs" do + status(job).should == 'queued' + end + end + + describe '#relative_distance_of_time_in_words' do + it "in the past" do + relative_distance_of_time_in_words(Time.now-5.minutes).should == '5m ago' + end + + it "in the furute" do + relative_distance_of_time_in_words(Time.now+5.minutes).should == 'in 5m' + end + end +end