que-view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a3458af823c9bb66e334138e63455e4c0dc94392d6f09b959276733bcb30ef3
+  data.tar.gz: c4b4be700ff4456f882488ccdd0adf34af14fa98bd9ab94380cc21a835ac1d49
+SHA512:
+  metadata.gz: dd7d0ce017b6c4e2becf99b429dd0450aee7b250761ee3d9772d1dd5dc1e9f3bbfaf55508ab0e120ec3a30513e62a0857b5b3c375d2d44835c75f34b16b0c1aa
+  data.tar.gz: f3aeb0ced2fc4b59bf5e783073505a51f507ea5114a79df6034c9764a8e12637a18f912581399492fef18fb33973c53144493a25dffa86c57a1aaf6a6c2c64d4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Bogdanov Anton
+
+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/README.md

@@ -0,0 +1,29 @@
+# Que::View
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'que'
+gem 'que-view'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install que-view
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/que_view_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/que/view .css

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

@@ -0,0 +1,90 @@
+/*
+ * 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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+@import url('https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600&display=swap&subset=cyrillic');
+
+* {
+  font-family: 'Source Sans Pro';
+}
+
+.row {
+  display: flex;
+  flex-direction: row;
+  margin: 0 auto;
+  max-width: 62.5rem;
+  width: 100%;
+}
+
+.row .column, .row table {
+  flex: 1;
+  padding: 1rem;
+}
+
+table th, table td {
+  padding: .25rem .75rem;
+  border-bottom: 1px solid #999;
+}
+
+table tbody tr:nth-of-type(2n) {
+  background: #DDD;
+}
+
+.dashboard-stat {
+  text-align: center;
+  display: table;
+  width: 100%;
+}
+
+.dashboard-stat a {
+  text-decoration: none;
+}
+
+.dashboard-stat .cell {
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  height: 200px;
+}
+
+.dashboard-stat h2 {
+  color: #222;
+  font-size: 1rem;
+  font-weight: normal;
+  text-transform: uppercase;
+  margin: 0;
+}
+
+.dashboard-stat.total {
+  background: #828E8C;
+}
+
+.dashboard-stat.scheduled {
+  background: #828E8C;
+}
+
+.dashboard-stat.running {
+  background: #CFD0C1;
+}
+
+.dashboard-stat.failing {
+  background: #E8866C;
+}
+
+.dashboard-value {
+  font-size: 5rem;
+  line-height: 5rem;
+  color: black;
+}

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class JobsController < Que::View::ApplicationController
+      PER_PAGE = 20
+
+      def index
+        @jobs = find_jobs(params[:status])
+        @jobs_amount = find_jobs_amount(params[:status])
+      end
+
+      def destroy
+        redirect_to(
+          jobs_path(status: params[:status]),
+          notice: 'Removing single job is not ready yet'
+        )
+      end
+
+      def destroy_all
+        updated_rows = destroy_all_jobs(params[:status])
+        redirect_to(
+          jobs_path(status: params[:status]),
+          notice: updated_rows.empty? ? 'No jobs deleted' : "#{updated_rows.count} jobs deleted"
+        )
+      end
+
+      private
+
+      def find_jobs(status)
+        case status&.to_sym
+        when :failing then ::Que::View.failing_jobs(PER_PAGE, offset, '%')
+        else []
+        end
+      end
+
+      def find_jobs_amount(status)
+        ::Que::View.dashboard_stats('%')[0][status&.to_sym]
+      end
+
+      def destroy_all_jobs(status)
+        case status&.to_sym
+        when :failing then ::Que::View.delete_all_failing_jobs
+        else 0
+        end
+      end
+
+      def page
+        (params[:page] || 1).to_i
+      end
+
+      def offset
+        (page - 1) * PER_PAGE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class WelcomeController < Que::View::ApplicationController
+      def index
+        @dashboard_stats = ::Que::View.dashboard_stats('%')[0]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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)
+        else job[:job_class]
+        end
+      end
+
+      def format_error(job)
+        return unless job[:last_error_message]
+
+        job[:last_error_message].lines.first || ''
+      end
+    end
+  end
+end

data/app/views/layouts/que/view/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Que View</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag 'que/view/application', media: 'all' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -0,0 +1,35 @@
+<div class="row">
+  <% if @jobs.size.positive? %>
+    <table cellspacing="0">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>Failures</th>
+          <th>Job</th>
+          <th>Queue</th>
+          <th>Error</th>
+          <th></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @jobs.each do |job| %>
+          <tr>
+            <td><%= job[:id] %></td>
+            <td><%= job[:error_count] %></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?')" %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% else %>
+    <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?')" %>
+<% end %>

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

@@ -0,0 +1,34 @@
+<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>
+    </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>
+    </div>
+  </div>
+  <div class="column">
+    <div class="dashboard-stat failing">
+      <%= link_to jobs_path(status: 'failing') do %>
+        <div class="cell">
+          <h2>Failing</h2>
+          <span class="dashboard-value">
+            <%= @dashboard_stats[:failing] %>
+          </span>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Que::View::Engine.routes.draw do
+  resources :jobs, only: %i[index destroy] do
+    delete :destroy_all, on: :collection
+  end
+
+  root 'welcome#index'
+end

data/lib/que/view/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class Configuration
+      attr_accessor :ui_username, :ui_password, :ui_secured_environments
+
+      def initialize
+        # It's required to specify these 3 variables to enable basic auth to UI
+        @ui_username = ''
+        @ui_password = ''
+        # Secured environments variable must directly contains environment names
+        @ui_secured_environments = []
+      end
+    end
+  end
+end

data/lib/que/view/dsl.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class DSL
+      def dashboard_stats(...)
+        execute(dashboard_stats_sql(...))
+      end
+
+      def failing_jobs(...)
+        execute(failing_jobs_sql(...))
+      end
+
+      def delete_all_failing_jobs
+        execute(delete_jobs_query(lock_all_failing_jobs_sql))
+      end
+
+      private
+
+      # rubocop: disable Metrics/MethodLength
+      def dashboard_stats_sql(search)
+        <<-SQL.squish
+          SELECT count(*)                    AS total,
+                 count(locks.job_id)         AS running,
+                 coalesce(sum((error_count > 0 AND locks.job_id IS NULL)::int), 0) AS failing,
+                 coalesce(sum((error_count = 0 AND locks.job_id IS NULL)::int), 0) AS scheduled
+          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
+            job_class ILIKE ('#{search}')
+            OR que_jobs.args #>> '{0, job_class}' ILIKE ('#{search}')
+        SQL
+      end
+
+      def failing_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 delete_jobs_sql(scope)
+        <<-SQL.squish
+          WITH target AS (#{scope})
+          DELETE FROM que_jobs
+          USING target
+          WHERE target.locked
+          AND target.id = que_jobs.id
+          RETURNING pg_advisory_unlock(target.id)
+        SQL
+      end
+
+      def lock_all_failing_jobs_sql
+        <<-SQL.squish
+          SELECT id, pg_try_advisory_lock(id) AS locked
+          FROM que_jobs
+          WHERE error_count > 0
+        SQL
+      end
+      # rubocop: enable Metrics/MethodLength
+
+      def execute(sql)
+        Que.execute(sql)
+      end
+    end
+  end
+end

data/lib/que/view/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class Engine < ::Rails::Engine
+      isolate_namespace Que::View
+    end
+  end
+end

data/lib/que/view/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    VERSION = '0.1.0'
+  end
+end

data/lib/que/view.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require 'que/view/version'
+require 'que/view/engine'
+require 'que/view/configuration'
+require 'que/view/dsl'
+
+module Que
+  module View
+    extend self
+    extend Forwardable
+
+    # Public: Configure emailbutler.
+    #
+    #   Que::View.configure do |config|
+    #   end
+    #
+    def configure
+      yield configuration
+    end
+
+    # Public: Returns Que::View::Configuration instance.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Public: Default per thread emailbutler instance if configured.
+    # Returns Que::View::DSL instance.
+    def instance
+      Thread.current[:que_view_instance] ||= DSL.new
+    end
+
+    # 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
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: que-view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bogdanov Anton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: que
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Rails engine as web interface for Que for inspecting jobs.
+email:
+- kortirso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/que_view_manifest.js
+- app/assets/stylesheets/que/view/application.css
+- app/controllers/que/view/application_controller.rb
+- app/controllers/que/view/jobs_controller.rb
+- app/controllers/que/view/welcome_controller.rb
+- 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/welcome/index.html.erb
+- config/routes.rb
+- lib/que/view.rb
+- lib/que/view/configuration.rb
+- lib/que/view/dsl.rb
+- lib/que/view/engine.rb
+- lib/que/view/version.rb
+homepage: https://github.com/kortirso/que-view
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kortirso/que-view
+  source_code_uri: https://github.com/kortirso/que-view
+  changelog_uri: https://github.com/kortirso/que-view/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Web interface for Que.
+test_files: []