panoptic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 243ea0a4585f5384dd5287ce50c678f830f4e3eff5186fd9974eaef89d40a448
+  data.tar.gz: 1ccae354aed4823252e3fc8c943ca5d3fb53b5e143c0f6ee0994b22a665a0c27
+SHA512:
+  metadata.gz: b926aef681978c208c42ae9420d98e2211e7dd79fbcc6920368317f3e7fac9564736005ceb0cdd38a8ed4aba60d98153bdf2122650402c9a66d6634de996794f
+  data.tar.gz: 54cc316be3314aa9d935be5b44d7739ef5fd475c10d3dcef1e89b90a2f8afcd883c5b200debb17ba9b5acc1c12080666d5687e43c277673002e4a34a96096704

data/MIT-LICENSE

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

data/README.md

@@ -0,0 +1,28 @@
+# Panoptic
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "panoptic"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install panoptic
+```
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/panoptic_manifest.js

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

data/app/assets/stylesheets/panoptic/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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
+ */

data/app/controllers/panoptic/application_controller.rb

@@ -0,0 +1,4 @@
+module Panoptic
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/panoptic/jobs_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class JobsController < ApplicationController
+    def index
+      @jobs = SolidQueue::Job.order(created_at: :asc).page(params[:page])
+    end
+  end
+end

data/app/controllers/panoptic/processes_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class ProcessesController < ApplicationController
+    def index
+      @hosts = Process.supervisors.includes(:forks)
+    end
+  end
+end

data/app/controllers/panoptic/queues_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class QueuesController < ApplicationController
+    def index
+      @queues = SolidQueue::Queue.all
+    end
+  end
+end

data/app/helpers/panoptic/application_helper.rb

@@ -0,0 +1,4 @@
+module Panoptic
+  module ApplicationHelper
+  end
+end

data/app/jobs/panoptic/application_job.rb

@@ -0,0 +1,4 @@
+module Panoptic
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/panoptic/application_mailer.rb

@@ -0,0 +1,6 @@
+module Panoptic
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/panoptic/application_record.rb

@@ -0,0 +1,5 @@
+module Panoptic
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/panoptic/process.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class Process
+    def self.supervisors
+      SolidQueue::Process.where(supervisor_id: nil)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Panoptic</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "panoptic/application", media: "all" %>
+  <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>
+  <%= render "shared/navbar" %>
+
+  <main class="container mt-2">
+    <%= 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>
+</body>
+</html>

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

@@ -0,0 +1,8 @@
+<tr>
+  <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>
+</tr>

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

@@ -0,0 +1,28 @@
+<h1>Jobs</h1>
+
+<div class="d-flex justify-content-end">
+  <div>
+    <%= page_entries_info @jobs %>
+  </div>
+</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>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%= render partial: "job", collection: @jobs %>  
+  </tbody>
+</table>
+
+<div class="d-flex justify-content-center">
+  <%= paginate @jobs, views_prefix: "panoptic" %>
+</div>

data/app/views/panoptic/kaminari/_first_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, remote: remote, class: 'page-link' %>
+</li>

data/app/views/panoptic/kaminari/_gap.html.erb

@@ -0,0 +1,3 @@
+<li class='page-item disabled'>
+  <%= link_to raw(t 'views.pagination.truncate'), '#', class: 'page-link' %>
+</li>

data/app/views/panoptic/kaminari/_last_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, remote: remote, class: 'page-link' %>
+</li>

data/app/views/panoptic/kaminari/_next_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.next'), url, rel: 'next', remote: remote, class: 'page-link' %>
+</li>

data/app/views/panoptic/kaminari/_page.html.erb

@@ -0,0 +1,9 @@
+<% if page.current? %>
+  <li class="page-item active">
+    <%= content_tag :a, page, data: { remote: remote }, rel: page.rel, class: 'page-link' %>
+  </li>
+<% else %>
+  <li class="page-item">
+    <%= link_to page, url, remote: remote, rel: page.rel, class: 'page-link' %>
+  </li>
+<% end %>

data/app/views/panoptic/kaminari/_paginator.html.erb

@@ -0,0 +1,17 @@
+<%= paginator.render do %>
+  <nav>
+    <ul class="pagination">
+      <%= first_page_tag unless current_page.first? %>
+      <%= prev_page_tag unless current_page.first? %>
+      <% each_page do |page| %>
+        <% if page.left_outer? || page.right_outer? || page.inside_window? %>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? -%>
+          <%= gap_tag %>
+        <% end %>
+      <% end %>
+      <%= next_page_tag unless current_page.last? %>
+      <%= last_page_tag unless current_page.last? %>
+    </ul>
+  </nav>
+<% end %>

data/app/views/panoptic/kaminari/_prev_page.html.erb

@@ -0,0 +1,3 @@
+<li class="page-item">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.previous'), url, rel: 'prev', remote: remote, class: 'page-link' %>
+</li>

data/app/views/panoptic/processes/_process.html.erb

@@ -0,0 +1,18 @@
+<li class="list-group-item">
+  <h5><%= process.kind %></h5>
+  
+  <div>
+    <span class="badge text-bg-primary">PID: <%= process.pid %></span>
+    <span class="badge text-bg-secondary">Created: <%= time_ago_in_words process.created_at %></span> 
+    <span class="badge text-bg-secondary">Last heartbeat: <%= time_ago_in_words process.last_heartbeat_at %></span> 
+  </div>
+
+  <div class="mt-2">
+    <% process.metadata.each do |setting, value| %> 
+      <div class="d-flex justify-content-between">
+        <div><%= setting %></div>
+        <div><%= value %></div>
+      </div>
+    <% end %>
+  </div>
+</li>

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

@@ -0,0 +1,15 @@
+<h1>Processes</h1>
+
+<div class="d-grid gap-3">
+  <% @hosts.each do |host| %>
+    <div class="card">
+      <div class="card-header">
+        <b>Host:</b> <%= host.hostname %>
+      </div>
+      
+      <ul class="list-group list-group-flush">
+        <%= render partial: "process", collection: host.forks %>
+      </ul>
+    </div>
+  <% end %>
+</div>

data/app/views/panoptic/queues/_queue.html.erb

@@ -0,0 +1,4 @@
+<li class="list-group-item">
+  <b><%= queue.name %></b>
+  <span class="badge text-bg-primary">Size: <%= queue.size %></span>
+</li>

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

@@ -0,0 +1,11 @@
+<h1>Queues</h1>
+
+<div class="card">
+  <div class="card-header">
+    Queue name
+  </div>
+  
+  <ul class="list-group list-group-flush">
+    <%= render partial: "queue", collection: @queues %>
+  </ul>
+</div>

data/app/views/shared/_navbar.html.erb

@@ -0,0 +1,23 @@
+<nav class="navbar navbar-expand-lg bg-body-tertiary">
+  <div class="container-fluid">
+    <%= link_to "Panoptic", root_path, class: "navbar-brand" %>
+    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+    <div class="collapse navbar-collapse" id="navbarNav">
+      <ul class="navbar-nav">
+        <li class="nav-item">
+          <%= link_to "Processes", root_path, class: class_names("nav-link", "active": current_page?(root_path)) %>
+        </li>
+
+        <li class="nav-item">
+          <%= link_to "Queues", queues_path, class: class_names("nav-link", "active": current_page?(queues_path)) %>
+        </li>
+
+        <li class="nav-item">
+          <%= link_to "Jobs", jobs_path, class: class_names("nav-link", "active": current_page?(jobs_path)) %>
+        </li>
+      </ul>
+    </div>
+  </div>
+</nav>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Panoptic::Engine.routes.draw do
+  root to: "processes#index"
+
+  resources :queues, only: [:index]
+  resources :jobs, only: [:index]
+end

data/lib/panoptic/engine.rb

@@ -0,0 +1,5 @@
+module Panoptic
+  class Engine < ::Rails::Engine
+    isolate_namespace Panoptic
+  end
+end

data/lib/panoptic/version.rb

@@ -0,0 +1,3 @@
+module Panoptic
+  VERSION = "0.1.0"
+end

data/lib/panoptic.rb

@@ -0,0 +1,6 @@
+require "panoptic/version"
+require "panoptic/engine"
+
+module Panoptic
+  # Your code goes here...
+end

data/lib/tasks/panoptic_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :panoptic do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: panoptic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Rolea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: solid_queue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Web interface for the SoldiQueue queuing backend
+email:
+- 3525369+virolea@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/panoptic_manifest.js
+- app/assets/stylesheets/panoptic/application.css
+- app/controllers/panoptic/application_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/jobs/panoptic/application_job.rb
+- app/mailers/panoptic/application_mailer.rb
+- app/models/panoptic/application_record.rb
+- app/models/panoptic/process.rb
+- app/views/layouts/panoptic/application.html.erb
+- app/views/panoptic/jobs/_job.html.erb
+- app/views/panoptic/jobs/index.html.erb
+- app/views/panoptic/kaminari/_first_page.html.erb
+- app/views/panoptic/kaminari/_gap.html.erb
+- app/views/panoptic/kaminari/_last_page.html.erb
+- app/views/panoptic/kaminari/_next_page.html.erb
+- app/views/panoptic/kaminari/_page.html.erb
+- app/views/panoptic/kaminari/_paginator.html.erb
+- app/views/panoptic/kaminari/_prev_page.html.erb
+- app/views/panoptic/processes/_process.html.erb
+- app/views/panoptic/processes/index.html.erb
+- app/views/panoptic/queues/_queue.html.erb
+- app/views/panoptic/queues/index.html.erb
+- app/views/shared/_navbar.html.erb
+- config/routes.rb
+- lib/panoptic.rb
+- lib/panoptic/engine.rb
+- lib/panoptic/version.rb
+- lib/tasks/panoptic_tasks.rake
+homepage: https://github.com/virolea/panoptic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/virolea/panoptic
+  source_code_uri: https://github.com/virolea/panoptic
+  changelog_uri: https://github.com/virolea/panoptic/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Web interface for the SoldiQueue queuing backend
+test_files: []