que-view 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a3458af823c9bb66e334138e63455e4c0dc94392d6f09b959276733bcb30ef3
-  data.tar.gz: c4b4be700ff4456f882488ccdd0adf34af14fa98bd9ab94380cc21a835ac1d49
+  metadata.gz: 9576dbcacaced63da0924a3315af1dede11887b6dcfdbca1029356691cd1dd02
+  data.tar.gz: abb8d73cfb96eda19ce45fe767edb91e57b9be595242c0a802503d0e16c3dc31
 SHA512:
-  metadata.gz: dd7d0ce017b6c4e2becf99b429dd0450aee7b250761ee3d9772d1dd5dc1e9f3bbfaf55508ab0e120ec3a30513e62a0857b5b3c375d2d44835c75f34b16b0c1aa
-  data.tar.gz: f3aeb0ced2fc4b59bf5e783073505a51f507ea5114a79df6034c9764a8e12637a18f912581399492fef18fb33973c53144493a25dffa86c57a1aaf6a6c2c64d4
+  metadata.gz: e44bde7cb0ffd37a3f7ec82dd85639c961a5cf10aab179b75a7f1ea02edc5e432cd1f9655a204f6d16e6d3addeb9d50ffc79df5b8b51d8b01d335433f8d1587a
+  data.tar.gz: fe3ada013eff8f6660126c56975e68e663f5c85ab2cd32957c4306e0c419d2285156604262677e02039c289cb22cf0921ca5541781dbb7b2efed1feec186c60e

data/README.md

@@ -1,10 +1,10 @@
 # Que::View
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+Rails engine inspired by [Que::Web](https://github.com/statianzo/que-web) for [Que](https://github.com/que-rb/que) job queue.
+SQL queries came from Que::Web, some styling from there too.
+Benefits for using this one: independent from Sinatra (que-web based on Sinatra)
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -17,13 +17,40 @@ And then execute:
 $ bundle install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install que-view
+## Configuration
+
+You can configure username/password for production web view.
+Add this lines to config/initializers/que_view.rb
+
+```ruby
+Que::View.configure do |config|
+  config.ui_username = 'username'
+  config.ui_password = 'password'
+  config.ui_secured_environments = ['production']
+end
 ```
 
-## Contributing
-Contribution directions go here.
+## Usage
+
+Add this line to config/routes.rb
+
+```ruby
+mount Que::Web::Engine => '/que_web'
+```
+
+Add this line to assets/config/manifest.js
+
+```js
+//= link que/view/application.css
+```
+
+## TODO
+
+- [X] rescheduling jobs
+- [X] deleting jobs
+- [ ] better styles for UI
+- [ ] rendering running jobs
+- [ ] tests
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/stylesheets/que/view/application.css

@@ -24,24 +24,45 @@
   display: flex;
   flex-direction: row;
   margin: 0 auto;
-  max-width: 62.5rem;
+  max-width: 75rem;
   width: 100%;
 }
 
-.row .column, .row table {
+.row .column {
   flex: 1;
   padding: 1rem;
 }
 
+.row table {
+  flex: 1;
+  margin-bottom: 1rem;
+}
+
 table th, table td {
   padding: .25rem .75rem;
-  border-bottom: 1px solid #999;
+  border-bottom: 1px solid #BBB;
 }
 
-table tbody tr:nth-of-type(2n) {
+table th {
+  text-align: left;
+}
+
+table tbody tr:nth-of-type(2n), table tbody tr:hover {
   background: #DDD;
 }
 
+table tbody tr:nth-of-type(2n):hover {
+  background: #CCC;
+}
+
+table p {
+  margin: 0;
+}
+
+.actions {
+  display: flex;
+}
+
 .dashboard-stat {
   text-align: center;
   display: table;
@@ -67,18 +88,14 @@ table tbody tr:nth-of-type(2n) {
   margin: 0;
 }
 
-.dashboard-stat.total {
-  background: #828E8C;
+.dashboard-stat.running {
+  background: #CFD0C1;
 }
 
 .dashboard-stat.scheduled {
   background: #828E8C;
 }
 
-.dashboard-stat.running {
-  background: #CFD0C1;
-}
-
 .dashboard-stat.failing {
   background: #E8866C;
 }
@@ -88,3 +105,12 @@ table tbody tr:nth-of-type(2n) {
   line-height: 5rem;
   color: black;
 }
+
+.btn-danger {
+  cursor: pointer;
+  border: none;
+  border-radius: .25rem;
+  background: #E8866C;
+  padding: .25rem .5rem;
+  margin-right: .5rem;
+}

data/app/controllers/que/view/application_controller.rb

@@ -3,6 +3,20 @@
 module Que
   module View
     class ApplicationController < ActionController::Base
+      http_basic_authenticate_with name: ::Que::View.configuration.ui_username,
+                                   password: ::Que::View.configuration.ui_password,
+                                   if: -> { basic_auth_enabled? }
+
+      private
+
+      def basic_auth_enabled?
+        configuration = ::Que::View.configuration
+
+        return false if configuration.ui_username.blank?
+        return false if configuration.ui_password.blank?
+
+        configuration.ui_secured_environments.include?(Rails.env)
+      end
     end
   end
 end

data/app/controllers/que/view/jobs_controller.rb

@@ -5,15 +5,36 @@ module Que
     class JobsController < Que::View::ApplicationController
       PER_PAGE = 20
 
+      before_action :find_job, only: %i[show]
+
       def index
         @jobs = find_jobs(params[:status])
         @jobs_amount = find_jobs_amount(params[:status])
       end
 
+      def show; end
+
+      def update
+        updated_rows = ::Que::View.reschedule_job(params[:id], Time.now)
+        redirect_to(
+          root_path,
+          notice: updated_rows.empty? ? 'Job is not rescheduled' : 'Job is rescheduled'
+        )
+      end
+
       def destroy
+        updated_rows = ::Que::View.delete_job(params[:id])
+        redirect_to(
+          root_path,
+          notice: updated_rows.empty? ? 'Job is not deleted' : 'Job is deleted'
+        )
+      end
+
+      def reschedule_all
+        updated_rows = reschedule_all_jobs(params[:status], Time.now)
         redirect_to(
           jobs_path(status: params[:status]),
-          notice: 'Removing single job is not ready yet'
+          notice: updated_rows.empty? ? 'No jobs rescheduled' : "#{updated_rows.count} jobs rescheduled"
         )
       end
 
@@ -27,24 +48,54 @@ module Que
 
       private
 
+      def find_job
+        @job = ::Que::View.fetch_job(params[:id])[0]
+        return if @job
+
+        redirect_to root_path, notice: 'Job is not found'
+      end
+
       def find_jobs(status)
         case status&.to_sym
-        when :failing then ::Que::View.failing_jobs(PER_PAGE, offset, '%')
+        when :failed then ::Que::View.fetch_failed_jobs(PER_PAGE, offset, search)
+        when :scheduled then ::Que::View.fetch_scheduled_jobs(PER_PAGE, offset, search)
         else []
         end
       end
 
       def find_jobs_amount(status)
-        ::Que::View.dashboard_stats('%')[0][status&.to_sym]
+        ::Que::View.fetch_dashboard_stats(search)[0][status&.to_sym]
+      end
+
+      def reschedule_all_jobs(status, time)
+        case status&.to_sym
+        when :failed then ::Que::View.reschedule_failed_jobs(time)
+        when :scheduled then ::Que::View.reschedule_scheduled_jobs(time)
+        else 0
+        end
       end
 
       def destroy_all_jobs(status)
         case status&.to_sym
-        when :failing then ::Que::View.delete_all_failing_jobs
+        when :failed then ::Que::View.delete_failed_jobs
+        when :scheduled then ::Que::View.delete_scheduled_jobs
         else 0
         end
       end
 
+      def search
+        return '%' unless search_param
+
+        "%#{search_param}%"
+      end
+
+      def search_param
+        sanitised = (params[:search] || '').gsub(/[^0-9a-z:]/i, '')
+        return if sanitised.empty?
+
+        sanitised
+      end
+
       def page
         (params[:page] || 1).to_i
       end

data/app/controllers/que/view/welcome_controller.rb

@@ -4,7 +4,7 @@ module Que
   module View
     class WelcomeController < Que::View::ApplicationController
       def index
-        @dashboard_stats = ::Que::View.dashboard_stats('%')[0]
+        @dashboard_stats = ::Que::View.fetch_dashboard_stats('%')[0]
       end
     end
   end

data/app/helpers/que/view/application_helper.rb

@@ -3,8 +3,6 @@
 module Que
   module View
     module ApplicationHelper
-      include ::Pagy::Frontend
-
       def humanized_job_class(job)
         case job[:job_class]
         when 'ActiveJob::QueueAdapters::QueAdapter::JobWrapper' then job.dig(:args, 0, :job_class)

data/app/views/que/view/jobs/index.html.erb

@@ -4,24 +4,41 @@
       <thead>
         <tr>
           <th>ID</th>
-          <th>Failures</th>
+          <th>Run at</th>
           <th>Job</th>
+          <th>Arguments</th>
           <th>Queue</th>
-          <th>Error</th>
-          <th></th>
+          <% if params[:status] == 'failing' %>
+            <th>Failures</th>
+            <th>Error</th>
+          <% end %>
+          <% if %w[failing scheduled].include?(params[:status]) %>
+            <th></th>
+          <% end %>
         </tr>
       </thead>
       <tbody>
         <% @jobs.each do |job| %>
           <tr>
-            <td><%= job[:id] %></td>
-            <td><%= job[:error_count] %></td>
+            <td><%= link_to job[:id], job_path(job[:id]) %></td>
+            <td><%= job[:run_at].utc %></td>
             <td><%= humanized_job_class(job) %></td>
             <td><%= job[:queue] %></td>
-            <td><%= format_error(job) %></td>
             <td>
-              <%= button_to 'Delete', job_path(job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
+              <% job.dig(:args, 0, :arguments).each do |argument| %>
+                <p><%= argument %></p>
+              <% end %>
             </td>
+            <% if params[:status] == 'failing' %>
+              <td><%= job[:error_count] %></td>
+              <td><%= format_error(job) %></td>
+            <% end %>
+            <% if %w[failing scheduled].include?(params[:status]) %>
+              <td class="actions">
+                <%= button_to 'Run', job_path(job[:id]), class: 'btn-danger', method: :patch, onclick: "return confirm('Are you sure you wish to reschedule job?')" %>
+                <%= button_to 'Delete', job_path(job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
+              </td>
+            <% end %>
           </tr>
         <% end %>
       </tbody>
@@ -30,6 +47,9 @@
     <p>No jobs found</p>
   <% end %>
 </div>
-<% if @jobs_amount.positive? %>
-  <%= button_to 'Delete All', destroy_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete all jobs?')" %>
+<% if %w[failing scheduled].include?(params[:status]) && @jobs_amount.positive? %>
+  <div class="row">
+    <%= button_to 'Run All', reschedule_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :post, onclick: "return confirm('Are you sure you wish to reschedule all jobs?')" %>
+    <%= button_to 'Delete All', destroy_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete all jobs?')" %>
+  </div>
 <% end %>

data/app/views/que/view/jobs/show.html.erb

@@ -0,0 +1,51 @@
+<div class="row">
+  <div class="columns">
+    <h1>Job <%= @job[:id] %></h1>
+  </div>
+</div>
+<div class="row">
+  <table cellspacing="0">
+    <tbody>
+      <tr>
+        <th>Job</th>
+        <td><%= humanized_job_class(@job) %></td>
+      </tr>
+      <tr>
+        <th>Queue</th>
+        <td><%= @job[:queue] %></td>
+      </tr>
+      <tr>
+        <th>Priority</th>
+        <td><%= @job[:priority] %></td>
+      </tr>
+      <tr>
+        <th>Run at</th>
+        <td><%= @job[:run_at].utc %></td>
+      </tr>
+      <tr>
+        <th>Failures</th>
+        <td><%= @job[:error_count] %></td>
+      </tr>
+      <tr>
+        <th>Args</th>
+        <td>
+          <% @job.dig(:args, 0, :arguments).each do |argument| %>
+            <p><%= argument %></p>
+          <% end %>
+        </td>
+      </tr>
+      <tr>
+        <th>Last Error</th>
+        <td>
+          <%= format_error(@job) %>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<div class="row">
+  <div class="actions">
+    <%= button_to 'Run', job_path(@job[:id]), class: 'btn-danger', method: :patch, onclick: "return confirm('Are you sure you wish to reschedule job?')" %>
+    <%= button_to 'Delete', job_path(@job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
+  </div>
+</div>

data/app/views/que/view/welcome/index.html.erb

@@ -1,22 +1,26 @@
 <div class="row">
   <div class="column">
     <div class="dashboard-stat running">
-      <div class="cell">
-        <h2>Running</h2>
-        <span class="dashboard-value">
-          <%= @dashboard_stats[:running] %>
-        </span>
-      </div>
+      <%= link_to jobs_path(status: 'running') do %>
+        <div class="cell">
+          <h2>Running</h2>
+          <span class="dashboard-value">
+            <%= @dashboard_stats[:running] %>
+          </span>
+        </div>
+      <% end %>
     </div>
   </div>
   <div class="column">
     <div class="dashboard-stat scheduled">
-      <div class="cell">
-        <h2>Scheduled</h2>
-        <span class="dashboard-value">
-          <%= @dashboard_stats[:scheduled] %>
-        </span>
-      </div>
+      <%= link_to jobs_path(status: 'scheduled') do %>
+        <div class="cell">
+          <h2>Scheduled</h2>
+          <span class="dashboard-value">
+            <%= @dashboard_stats[:scheduled] %>
+          </span>
+        </div>
+      <% end %>
     </div>
   </div>
   <div class="column">

data/config/routes.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 Que::View::Engine.routes.draw do
-  resources :jobs, only: %i[index destroy] do
+  resources :jobs, only: %i[index show update destroy] do
+    post :reschedule_all, on: :collection
     delete :destroy_all, on: :collection
   end
 

data/lib/que/view/dsl.rb

@@ -2,23 +2,52 @@
 
 module Que
   module View
+    # rubocop: disable Metrics/ClassLength
     class DSL
-      def dashboard_stats(...)
-        execute(dashboard_stats_sql(...))
+      def fetch_dashboard_stats(...)
+        execute(fetch_dashboard_stats_sql(...))
       end
 
-      def failing_jobs(...)
-        execute(failing_jobs_sql(...))
+      def fetch_failing_jobs(...)
+        execute(fetch_failing_jobs_sql(...))
       end
 
-      def delete_all_failing_jobs
-        execute(delete_jobs_query(lock_all_failing_jobs_sql))
+      def fetch_scheduled_jobs(...)
+        execute(fetch_scheduled_jobs_sql(...))
+      end
+
+      def fetch_job(...)
+        execute(fetch_job_sql(...))
+      end
+
+      def delete_failing_jobs
+        execute(delete_jobs_sql(lock_failing_jobs_sql))
+      end
+
+      def delete_scheduled_jobs
+        execute(delete_jobs_sql(lock_scheduled_jobs_sql))
+      end
+
+      def delete_job(...)
+        execute(delete_jobs_sql(lock_job_sql(...)))
+      end
+
+      def reschedule_scheduled_jobs(time)
+        execute(reschedule_jobs_sql(lock_scheduled_jobs_sql, time))
+      end
+
+      def reschedule_failing_jobs(time)
+        execute(reschedule_jobs_sql(lock_failing_jobs_sql, time))
+      end
+
+      def reschedule_job(job_id, time)
+        execute(reschedule_jobs_sql(lock_job_sql(job_id), time))
       end
 
       private
 
       # rubocop: disable Metrics/MethodLength
-      def dashboard_stats_sql(search)
+      def fetch_dashboard_stats_sql(search)
         <<-SQL.squish
           SELECT count(*)                    AS total,
                  count(locks.job_id)         AS running,
@@ -36,7 +65,7 @@ module Que
         SQL
       end
 
-      def failing_jobs_sql(per_page, offset, search)
+      def fetch_failing_jobs_sql(per_page, offset, search)
         <<-SQL.squish
           SELECT que_jobs.*
           FROM que_jobs
@@ -57,6 +86,36 @@ module Que
         SQL
       end
 
+      def fetch_scheduled_jobs_sql(per_page, offset, search)
+        <<-SQL.squish
+          SELECT que_jobs.*
+          FROM que_jobs
+          LEFT JOIN (
+            SELECT (classid::bigint << 32) + objid::bigint AS job_id
+            FROM pg_locks
+            WHERE locktype = 'advisory'
+          ) locks ON (que_jobs.id=locks.job_id)
+          WHERE locks.job_id IS NULL
+            AND error_count = 0
+            AND (
+              job_class ILIKE ('#{search}')
+              OR que_jobs.args #>> '{0, job_class}' ILIKE ('#{search}')
+            )
+          ORDER BY run_at, id
+          LIMIT #{per_page}::int
+          OFFSET #{offset}::int
+        SQL
+      end
+
+      def fetch_job_sql(job_id)
+        <<-SQL.squish
+          SELECT *
+          FROM que_jobs
+          WHERE id = #{job_id}::bigint
+          LIMIT 1
+        SQL
+      end
+
       def delete_jobs_sql(scope)
         <<-SQL.squish
           WITH target AS (#{scope})
@@ -68,18 +127,47 @@ module Que
         SQL
       end
 
-      def lock_all_failing_jobs_sql
+      def reschedule_jobs_sql(scope, time)
+        <<-SQL.squish
+          WITH target AS (#{scope})
+          UPDATE que_jobs
+          SET run_at = '#{time}'::timestamptz, expired_at = NULL
+          FROM target
+          WHERE target.locked
+          AND target.id = que_jobs.id
+          RETURNING pg_advisory_unlock(target.id)
+        SQL
+      end
+
+      def lock_failing_jobs_sql
         <<-SQL.squish
           SELECT id, pg_try_advisory_lock(id) AS locked
           FROM que_jobs
           WHERE error_count > 0
         SQL
       end
+
+      def lock_scheduled_jobs_sql
+        <<-SQL.squish
+          SELECT id, pg_try_advisory_lock(id) AS locked
+          FROM que_jobs
+          WHERE error_count = 0
+        SQL
+      end
+
+      def lock_job_sql(job_id)
+        <<-SQL.squish
+          SELECT id, pg_try_advisory_lock(id) AS locked
+          FROM que_jobs
+          WHERE id = #{job_id}::bigint
+        SQL
+      end
       # rubocop: enable Metrics/MethodLength
 
       def execute(sql)
         Que.execute(sql)
       end
     end
+    # rubocop: enable Metrics/ClassLength
   end
 end

data/lib/que/view/version.rb

@@ -2,6 +2,6 @@
 
 module Que
   module View
-    VERSION = '0.1.0'
+    VERSION = '0.2.1'
   end
 end

data/lib/que/view.rb

@@ -34,6 +34,8 @@ module Que
 
     # Public: All the methods delegated to instance. These should match the interface of Que::View::DSL.
     def_delegators :instance,
-                   :dashboard_stats, :failing_jobs, :delete_all_failing_jobs
+                   :fetch_dashboard_stats, :fetch_failing_jobs, :fetch_scheduled_jobs, :fetch_job,
+                   :delete_failing_jobs, :delete_scheduled_jobs, :delete_job,
+                   :reschedule_scheduled_jobs, :reschedule_failing_jobs, :reschedule_job
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-view
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: que
@@ -168,6 +168,7 @@ files:
 - app/helpers/que/view/application_helper.rb
 - app/views/layouts/que/view/application.html.erb
 - app/views/que/view/jobs/index.html.erb
+- app/views/que/view/jobs/show.html.erb
 - app/views/que/view/welcome/index.html.erb
 - config/routes.rb
 - lib/que/view.rb