job_board 0.1.0

data/lib/job_board/assets/application.js

@@ -0,0 +1,39 @@
+(function () {
+  "use strict";
+
+  // Confirmation dialogs for destructive button_to forms (no Turbo/UJS assumed).
+  document.addEventListener("submit", function (event) {
+    var form = event.target;
+    var message = form.dataset && form.dataset.confirm;
+    if (message && !window.confirm(message)) {
+      event.preventDefault();
+    }
+  });
+
+  // Auto-refresh: re-fetch the current page and swap [data-poll-region] contents.
+  var interval = parseInt(document.body.dataset.pollInterval, 10);
+  if (!interval || interval <= 0) return;
+  if (!document.querySelector("[data-poll-region]")) return;
+
+  setInterval(function () {
+    if (document.hidden) return;
+
+    fetch(window.location.href, {
+      headers: { "Accept": "text/html" },
+      credentials: "same-origin"
+    })
+      .then(function (response) {
+        if (!response.ok) throw new Error("poll failed");
+        return response.text();
+      })
+      .then(function (html) {
+        var fresh = new DOMParser().parseFromString(html, "text/html");
+        document.querySelectorAll("[data-poll-region]").forEach(function (region) {
+          var key = region.getAttribute("data-poll-region");
+          var replacement = fresh.querySelector('[data-poll-region="' + key + '"]');
+          if (replacement) region.innerHTML = replacement.innerHTML;
+        });
+      })
+      .catch(function () { /* transient network errors are fine; try again next tick */ });
+  }, interval * 1000);
+})();

data/lib/job_board/configuration.rb

@@ -0,0 +1,32 @@
+module JobBoard
+  class Configuration
+    # nil, or { name: "...", password: "..." } to protect the UI with HTTP Basic auth.
+    attr_accessor :http_basic_auth
+
+    # Seconds between page auto-refreshes. nil or 0 disables polling.
+    attr_accessor :poll_interval
+
+    # Rows per page on job lists.
+    attr_accessor :per_page
+
+    # Heartbeat age after which a process is flagged stale.
+    # nil falls back to SolidQueue.process_alive_threshold.
+    attr_accessor :stale_process_threshold
+
+    # Seconds of latency after which a queue is highlighted as breaching.
+    # Per-queue override: latency_warning_thresholds["queue_name"] = seconds.
+    # Queues named in the within_* convention (e.g. "within_5_minutes") get
+    # their threshold parsed from the name automatically.
+    attr_accessor :latency_warning_threshold
+    attr_accessor :latency_warning_thresholds
+
+    def initialize
+      @http_basic_auth = nil
+      @poll_interval = 5
+      @per_page = 25
+      @stale_process_threshold = nil
+      @latency_warning_threshold = 60
+      @latency_warning_thresholds = {}
+    end
+  end
+end

data/lib/job_board/engine.rb

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

data/lib/job_board/version.rb

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

data/lib/job_board.rb

@@ -0,0 +1,17 @@
+require "solid_queue"
+
+require "job_board/version"
+require "job_board/configuration"
+require "job_board/engine"
+
+module JobBoard
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: job_board
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Mountable Rails engine that shows queue latency, jobs by status, failed
+  job management, workers, and recurring tasks for Solid Queue.
+email:
+- mike@rowhomelabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- app/controllers/job_board/application_controller.rb
+- app/controllers/job_board/assets_controller.rb
+- app/controllers/job_board/jobs_controller.rb
+- app/controllers/job_board/processes_controller.rb
+- app/controllers/job_board/queues/pauses_controller.rb
+- app/controllers/job_board/queues_controller.rb
+- app/controllers/job_board/recurring_tasks_controller.rb
+- app/helpers/job_board/application_helper.rb
+- app/models/job_board/job_presenter.rb
+- app/models/job_board/job_row.rb
+- app/models/job_board/jobs_query.rb
+- app/models/job_board/latency_sla.rb
+- app/models/job_board/page.rb
+- app/models/job_board/process_tree.rb
+- app/views/job_board/jobs/_filters.html.erb
+- app/views/job_board/jobs/_job_row.html.erb
+- app/views/job_board/jobs/index.html.erb
+- app/views/job_board/jobs/show.html.erb
+- app/views/job_board/processes/_process.html.erb
+- app/views/job_board/processes/index.html.erb
+- app/views/job_board/queues/index.html.erb
+- app/views/job_board/recurring_tasks/index.html.erb
+- app/views/job_board/shared/_nav.html.erb
+- app/views/job_board/shared/_pagination.html.erb
+- app/views/layouts/job_board/application.html.erb
+- config/routes.rb
+- lib/job_board.rb
+- lib/job_board/assets/application.css
+- lib/job_board/assets/application.js
+- lib/job_board/configuration.rb
+- lib/job_board/engine.rb
+- lib/job_board/version.rb
+homepage: https://github.com/kcdragon/job_board
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kcdragon/job_board
+  source_code_uri: https://github.com/kcdragon/job_board
+  changelog_uri: https://github.com/kcdragon/job_board/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: A dashboard for monitoring Solid Queue queues and jobs.
+test_files: []