panoptic 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d310e17406ea0681469b5f4f4ff1d456b9d24ad4c89d4498adc87643f9ed8c
-  data.tar.gz: 9e2faccbac6daf2820c63202adc28292918934e596462443b046be5d4b874c72
+  metadata.gz: 0c9c24666cf21962529d267d1432b25fb3b2ba813ec8997c5a50373da1b76f2b
+  data.tar.gz: 72eae4c018c7585f2abf3ec7968c94e9ccf223783d3f730e75d5796ff06b2f7b
 SHA512:
-  metadata.gz: b596a1d4224631ffb6f1e619958bbed94c20c4bfcb6c64fd967045efd40d785be72d2393b1317dc239866be6ba35952eebbf3eeac22e02cc270626475f325328
-  data.tar.gz: b07d2227e30e712aedaeb5d1213991fba6cb5e467f67466795c3b1fd8d10a92e9fa5c9a98e86f6afc2a71bd2ac4de963c3a5de2a49a3f74494973c666227d4ba
+  metadata.gz: 248f586bdf987718900bd83c4e9989b2f6b617853637e2a9ac690b94723e01cd5659126a01c812ee4ba7584ebfaa87778a1e3208cb6be442f415e348dfe6a1bc
+  data.tar.gz: 5e58e532a16725fc88dfc90f1a7321a20fc4730957a31db28e5e14952381ac5192c1afda78547395b1de833b5cbef45750cacd0effe1e5b822402b1afddfc866

data/README.md

@@ -1,8 +1,12 @@
 # Panoptic
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+[![Gem Version](https://badge.fury.io/rb/panoptic.svg)](https://badge.fury.io/rb/panoptic)
+
+Panoptic is a web interface for the [SolidQueue](https://github.com/basecamp/solid_queue) queuing backend.
+
+![](./images/demo.png)
+
+While MissionControl is getting ready for release, this gem offers a visual interface for testing purposes with SolidQueue. 
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -11,18 +15,23 @@ Add this line to your application's Gemfile:
 gem "panoptic"
 ```
 
-And then execute:
-```bash
-$ bundle
-```
+Then mount the engine in your `config/routes.rb` file 
 
-Or install it yourself as:
-```bash
-$ gem install panoptic
+```ruby
+mount Panoptic::Engine => "/panoptic"
 ```
 
-## Contributing
-Contribution directions go here.
+## Usage 
+
+Once the gem is installed and the Engine mounted, visit your engine route to access Panoptic. For now, it offers three views: 
+- Processes 
+- Queues 
+- A first version of the jobs view 
+
+In the near future, the following features could be implemented: 
+- Pause and clear queues 
+- Advanced jobs view, with filters for executed, failed and scheduled jobs
+- Search and retries
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/panoptic/application_controller.rb

@@ -1,4 +1,5 @@
 module Panoptic
   class ApplicationController < ActionController::Base
+    include Pagy::Backend
   end
 end

data/app/controllers/panoptic/jobs/failed_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class Jobs::FailedController < ApplicationController
+    layout "panoptic/jobs", only: :index
+
+    def index
+      @pagy, @jobs = pagy(
+        Panoptic::FailedJob.order(created_at: :asc)
+      )
+    end
+
+    def show
+      @job = Panoptic::FailedJob.find(params[:id])
+    end
+  end
+end

data/app/controllers/panoptic/jobs/scheduled_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class Jobs::ScheduledController < ApplicationController
+    layout "panoptic/jobs"
+
+    def index
+      # TODO: use the `scheduled` scope available in SolidQueue next release
+      @pagy, @jobs = pagy(
+        SolidQueue::Job.joins(:scheduled_execution).order(created_at: :asc)
+      )
+
+      render "panoptic/jobs/index"
+    end
+  end
+end

data/app/controllers/panoptic/jobs_controller.rb

@@ -2,8 +2,6 @@
 
 module Panoptic
   class JobsController < ApplicationController
-    include Pagy::Backend
-
     def index
       @pagy, @jobs = pagy(SolidQueue::Job.order(created_at: :asc))
     end

data/app/helpers/panoptic/application_helper.rb

@@ -1,5 +1,7 @@
 module Panoptic
   module ApplicationHelper
     include Pagy::Frontend
+    include BreadcrumbsHelper
+    include DateTimeHelper
   end
 end

data/app/helpers/panoptic/breadcrumbs_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Panoptic
+  module BreadcrumbsHelper
+    def breadcrumb_items
+      @breadcrumb_items ||= []
+    end
+
+    def breadcrumbs
+      tag.nav(aria: { label: "breadcrumb" }) do
+        tag.ol(class: "breadcrumb") do
+          breadcrumb_items.map do |item|
+            concat tag.li(item, class: "breadcrumb-item")
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/panoptic/date_time_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Panoptic
+  module DateTimeHelper
+    def safe_time_tag(date_or_time, *args, &block)
+      return "-" unless date_or_time
+
+      time_tag(date_or_time, *args, &block)
+    end
+  end
+end

data/app/models/panoptic/failed_job.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class FailedJob < SolidQueue::Job
+    # TODO: use the `failed` scope available in SolidQueue next release
+    default_scope { joins(:failed_execution) }
+
+    def enqueued_at
+      Time.parse(arguments["enqueued_at"])
+    end
+
+    def exception_class
+      failed_execution.error["exception_class"]
+    end
+
+    def exception_message
+      failed_execution.error["message"]
+    end
+
+    def stacktrace
+      failed_execution.error["backtrace"]
+    end
+  end
+end

data/app/views/layouts/panoptic/application.html.erb

@@ -7,11 +7,11 @@
 
   <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous">
 </head>
-<body>
+<body class="pb-4">
   <%= render "shared/navbar" %>
 
   <main class="container mt-2">
-    <%= yield %>
+    <%= content_for?(:content) ? yield(:content) : yield %>
   </main>
 
   <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-C6RzsynM9kWDrMNeT87bh95OGNyZPhcTNXj1NW7RuBCsyN/o0jlpcV8Qyq46cDfL" crossorigin="anonymous"></script>

data/app/views/layouts/panoptic/jobs.html.erb

@@ -0,0 +1,27 @@
+<% content_for(:content) do %>
+  <h1>Jobs</h1>
+
+  <ul class="nav nav-underline">
+    <li class="nav-item">
+      <%= link_to "All", jobs_path, class: class_names("nav-link", "active": current_page?(jobs_path)) %>
+    </li>
+    <li class="nav-item">
+      <%= link_to "Scheduled", scheduled_jobs_path, class: class_names("nav-link", "active": current_page?(scheduled_jobs_path)) %>
+    </li>
+    <li class="nav-item">
+      <%= link_to "Failed", failed_jobs_path, class: class_names("nav-link", "active": current_page?(failed_jobs_path)) %>
+    </li>
+  </ul>
+
+  <div class="d-flex justify-content-end">
+    <%== pagy_info(@pagy)  %> 
+  </div>
+  
+  <%= yield %>
+
+  <div class="d-flex justify-content-center">
+    <%== pagy_bootstrap_nav(@pagy) if @pagy.pages > 1 %>
+  </div>
+<% end %>
+
+<%= render template: "layouts/panoptic/application" %>

data/app/views/panoptic/jobs/_job.html.erb

@@ -2,7 +2,6 @@
   <th scope="row"><%= job.id %></th>
   <td scope="col"><%= job.class_name %></td>
   <td scope="col"><%= job.queue_name %></td>
-  <td scope="col"><%= job.arguments %></td>
-  <td scope="col"><% job.scheduled_at %></td>
-  <td scope="col"><% job.finished_at %></td>
+  <td scope="col"><%= safe_time_tag job.scheduled_at %></td>
+  <td scope="col"><%= safe_time_tag job.finished_at %></td>
 </tr>

data/app/views/panoptic/jobs/failed/_job.html.erb

@@ -0,0 +1,10 @@
+<tr>
+  <th scope="row"><%= job.id %></th>
+  <td scope="col"><%= job.class_name %></td>
+  <td scope="col"><%= job.queue_name %></td>
+  <td scope="col" class="font-monospace"><%= job.exception_class %></td>
+  <td scope="col"><%= safe_time_tag job.enqueued_at %></td>
+  <td scope="col">
+    <%= link_to "Details", failed_job_path(job) %>
+  </td>
+</tr>

data/app/views/panoptic/jobs/failed/index.html.erb

@@ -0,0 +1,16 @@
+<table class="table">
+  <thead>
+    <tr>
+      <th scope="col">#</th>
+      <th scope="col">Class</th>
+      <th scope="col">Queue</th>
+      <th scope="col">Exception</th>
+      <th scope="col">Enqueued</th>
+      <th scope="col"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%= render partial: "job", collection: @jobs %>  
+  </tbody>
+</table>

data/app/views/panoptic/jobs/failed/show.html.erb

@@ -0,0 +1,24 @@
+<% breadcrumb_items.push link_to("Jobs", jobs_path) %>
+<% breadcrumb_items.push link_to("Failed", failed_jobs_path) %>
+<% breadcrumb_items.push @job.id %>
+<%= breadcrumbs %>
+
+<h1><%= @job.class_name %></h1>
+
+<div class="alert alert-danger" role="alert">
+  <h4 class="alert-heading"><%= @job.exception_class %></h4>
+  <p class="font-monospace mb-0">
+    <%= @job.exception_message %>
+  </p>
+</div>
+
+<div class="card" >
+  <div class="card-header">
+    Stacktrace
+  </div>
+  <ul class="list-group list-group-flush font-monospace text-xs">
+    <% @job.stacktrace.each do |trace| %>
+      <li class="list-group-item"><%= trace %></li>
+    <% end %>
+  </ul>
+</div>

data/app/views/panoptic/jobs/index.html.erb

@@ -1,26 +1,15 @@
-<h1>Jobs</h1>
-
-<div class="d-flex justify-content-end">
-  <%== pagy_info(@pagy)  %> 
-</div>
-
 <table class="table">
   <thead>
     <tr>
       <th scope="col">#</th>
       <th scope="col">Class</th>
       <th scope="col">Queue</th>
-      <th scope="col">Arguments</th>
-      <th scope="col">Scheduled at</th>
-      <th scope="col">Finished at</th>
+      <th scope="col">Scheduled</th>
+      <th scope="col">Finished</th>
     </tr>
   </thead>
 
   <tbody>
-    <%= render partial: "job", collection: @jobs %>  
+    <%= render partial: "panoptic/jobs/job", collection: @jobs %>  
   </tbody>
 </table>
-
-<div class="d-flex justify-content-center">
-  <%== pagy_bootstrap_nav(@pagy) if @pagy.pages > 1 %>
-</div>

data/config/routes.rb

@@ -2,5 +2,13 @@ Panoptic::Engine.routes.draw do
   root to: "processes#index"
 
   resources :queues, only: [:index]
-  resources :jobs, only: [:index]
+
+  scope "jobs" do
+    get "all", to: "jobs#index", as: "jobs"
+
+    scope module: "jobs" do
+      resources :scheduled, only: :index, as: :scheduled_jobs
+      resources :failed, only: [:index, :show], as: :failed_jobs
+    end
+  end
 end

data/lib/panoptic/version.rb

@@ -1,3 +1,3 @@
 module Panoptic
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panoptic
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Vincent Rolea
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,20 +59,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - app/controllers/panoptic/application_controller.rb
+- app/controllers/panoptic/jobs/failed_controller.rb
+- app/controllers/panoptic/jobs/scheduled_controller.rb
 - app/controllers/panoptic/jobs_controller.rb
 - app/controllers/panoptic/processes_controller.rb
 - app/controllers/panoptic/queues_controller.rb
 - app/helpers/panoptic/application_helper.rb
+- app/helpers/panoptic/breadcrumbs_helper.rb
+- app/helpers/panoptic/date_time_helper.rb
 - app/jobs/panoptic/application_job.rb
 - app/mailers/panoptic/application_mailer.rb
 - app/models/panoptic/application_record.rb
+- app/models/panoptic/failed_job.rb
 - app/models/panoptic/process.rb
 - app/views/layouts/panoptic/application.html.erb
+- app/views/layouts/panoptic/jobs.html.erb
 - app/views/panoptic/jobs/_job.html.erb
+- app/views/panoptic/jobs/failed/_job.html.erb
+- app/views/panoptic/jobs/failed/index.html.erb
+- app/views/panoptic/jobs/failed/show.html.erb
 - app/views/panoptic/jobs/index.html.erb
 - app/views/panoptic/processes/_process.html.erb
 - app/views/panoptic/processes/index.html.erb

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright Vincent Rolea
-
-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.