solid_queue_dashboard 0.0.1 → 0.1.1

data/app/views/solid_queue_dashboard/recurring_tasks/index.html.erb

@@ -0,0 +1,21 @@
+<div class="card">
+  <div class="card-header border-b">
+    <h2 class="card-title">Recurring Tasks</h2>
+
+    <div class="!mt-4">
+      <%= render "solid_queue_dashboard/recurring_tasks/filters" %>
+    </div>
+  </div>
+
+  <div class="card-content !p-0">
+    <% if @recurring_tasks.any? %>
+      <%= render "solid_queue_dashboard/recurring_tasks/table", recurring_tasks: @recurring_tasks %>
+    <% else %>
+      <div class="px-6 py-12">
+        <p class="text-muted-foreground text-center">
+          No recurring tasks found
+        </p>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/solid_queue_dashboard/recurring_tasks/show.html.erb

@@ -0,0 +1,129 @@
+<h1 class="text-4xl flex items-center gap-2">
+  <%= recurring_task_circle(@recurring_task.type, class: "size-4") %>
+
+  <span class="tracking-tighter font-bold">
+    Recurring Task #<%= @recurring_task.id %>
+  </span>
+</h1>
+
+<div class="card mt-6">
+  <div class="card-content pt-6 grid grid-cols-1 sm:grid-cols-2 sm:gap-16">
+    <div class="space-y-4">
+      <div class="info-line">
+        <span class="info-line-label">Type</span>
+        <div class="info-line-separator"></div>
+        <span class="info-line-value"><%= recurring_task_type_badge(@recurring_task.type) %></span>
+      </div>
+
+      <div class="info-line">
+        <span class="info-line-label">Key</span>
+        <div class="info-line-separator"></div>
+        <span class="info-line-value"><%= @recurring_task.key %></span>
+      </div>
+
+      <div class="info-line">
+        <span class="info-line-label">Schedule</span>
+        <div class="info-line-separator"></div>
+        <span class="info-line-value"><%= @recurring_task.schedule %></span>
+      </div>
+
+      <% if @recurring_task.queue_name? %>
+        <div class="info-line">
+          <span class="info-line-label">Queue Name</span>
+          <div class="info-line-separator"></div>
+          <span class="info-line-value"><%= @recurring_task.queue_name %></span>
+        </div>
+      <% end %>
+    </div>
+
+    <div class="space-y-4">
+      <% if @recurring_task.priority? %>
+        <div class="info-line">
+          <span class="info-line-label">Priority</span>
+          <div class="info-line-separator"></div>
+          <span class="info-line-value"><%= @recurring_task.priority %></span>
+        </div>
+      <% end %>
+
+      <div class="info-line">
+        <span class="info-line-label">Static</span>
+        <div class="info-line-separator"></div>
+        <span class="info-line-value"><%= @recurring_task.static ? "Yes" : "No" %></span>
+      </div>
+
+      <div class="info-line">
+        <span class="info-line-label">Created At</span>
+        <div class="info-line-separator"></div>
+        <span class="info-line-value" data-date><%= @recurring_task.created_at.to_fs(:database) %></span>
+      </div>
+
+      <div class="info-line">
+        <span class="info-line-label">Updated At</span>
+        <div class="info-line-separator"></div>
+        <span class="info-line-value" data-date><%= @recurring_task.updated_at.to_fs(:database) %></span>
+      </div>
+    </div>
+  </div>
+</div>
+
+<% if @recurring_task.command.present? %>
+  <div class="card mt-8 overflow-hidden">
+    <div class="card-header border-b border-t-4 border-t-amber-500 dark:border-t-amber-600">
+      <h3 class="card-title">Command</h3>
+      <p class="card-description">The command to be executed</p>
+    </div>
+    <div class="card-content pt-6">
+      <pre><%= @recurring_task.command %></pre>
+    </div>
+  </div>
+<% end %>
+
+<% if @recurring_task.class_name.present? %>
+  <div class="card mt-8 overflow-hidden">
+    <div class="card-header border-b border-t-4 border-t-blue-500 dark:border-t-blue-600">
+      <h3 class="card-title">Job Class</h3>
+      <p class="card-description">The job class to be executed</p>
+    </div>
+    <div class="card-content pt-6">
+      <pre><%= @recurring_task.class_name %></pre>
+    </div>
+  </div>
+<% end %>
+
+<% if @recurring_task.arguments.present? %>
+  <div class="card mt-8 overflow-hidden">
+    <div class="card-header border-b border-t-4 border-t-purple-500 dark:border-t-purple-600">
+      <h3 class="card-title">Arguments</h3>
+      <p class="card-description">The arguments to be passed to the job</p>
+    </div>
+    <div class="card-content pt-6">
+      <pre><%= JSON.pretty_generate(@recurring_task.arguments) %></pre>
+    </div>
+  </div>
+<% end %>
+
+<% if @recurring_task.description.present? %>
+  <div class="card mt-8 overflow-hidden">
+    <div class="card-header border-b border-t-4 border-t-amber-500 dark:border-t-amber-600">
+      <h3 class="card-title">Description</h3>
+      <p class="card-description">Additional information about this recurring task</p>
+    </div>
+    <div class="card-content pt-6">
+      <pre><%= @recurring_task.description %></pre>
+    </div>
+  </div>
+<% end %>
+
+<div class="card mt-8 overflow-hidden">
+  <div class="card-header border-b border-t-4 border-t-zinc-500 dark:border-t-zinc-600">
+    <h3 class="card-title">Next Runs</h3>
+    <p class="card-description">Based on the current schedule</p>
+  </div>
+  <div class="card-content pt-5">
+    <ul class="list-decimal marker:text-sm marker:text-muted-foreground ml-4 space-y-1">
+      <% @recurring_task.next_runs.each do |run_time| %>
+        <li data-date><%= run_time.strftime("%Y-%m-%d %H:%M:%S %Z") %></li>
+      <% end %>
+    </ul>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,18 @@
+SolidQueueDashboard::Engine.routes.draw do
+  resources :jobs, only: [ :index, :show ] do
+    member do
+      post :retry
+    end
+  end
+
+  resources :processes, only: [ :index, :show ]
+
+  resources :recurring_tasks, path: "recurring-tasks", only: [ :index, :show ] do
+    member do
+      post :enqueue
+    end
+  end
+
+  post "appearance/toggle", to: "appearance#toggle", as: :toggle_appearance
+  root "dashboard#index"
+end

data/lib/solid_queue_dashboard/configuration.rb

@@ -0,0 +1,17 @@
+module SolidQueueDashboard
+  class Configuration
+    attr_accessor :title
+
+    def initialize
+      @title = "Solid Queue Dashboard"
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/solid_queue_dashboard/decorators/job_decorator.rb

@@ -0,0 +1,63 @@
+module SolidQueueDashboard
+  module Decorators
+    class JobDecorator < SimpleDelegator
+      def color
+        Job.status_color(status)
+      end
+
+      def status
+        return @status if defined?(@status)
+
+        @status = if retried?
+          Job::RETRIED
+        elsif failed?
+          Job::FAILED
+        elsif success?
+          Job::SUCCESS
+        elsif scheduled?
+          Job::SCHEDULED
+        else
+          Job::PENDING
+        end
+      end
+
+      def success?
+        return @success if defined?(@success)
+        @success = finished_at.present? && !failed? && !retried?
+      end
+
+      def retried?
+        return @retried if defined?(@retried)
+        @retried = finished_at.present? && !failed_execution.present? &&
+          (arguments["executions"].to_i > 0 || execution_history.where(scheduled_at: finished_at..).any?)
+      end
+
+      def failed?
+        return @failed if defined?(@failed)
+        @failed = failed_execution.present?
+      end
+
+      def scheduled?
+        return @scheduled if defined?(@scheduled)
+        @scheduled = scheduled_at.present? && scheduled_at > Time.current
+      end
+
+      def pending?
+        return @pending if defined?(@pending)
+        @pending = !finished_at.present?
+      end
+
+      def execution_history
+        SolidQueue::Job.where(active_job_id: active_job_id)
+      end
+
+      def error_message
+        return @error_message if defined?(@error_message)
+
+        @error_message = failed_execution ?
+          "#{failed_execution.error["exception_class"]}: #{failed_execution.error["message"]}" :
+          nil
+      end
+    end
+  end
+end

data/lib/solid_queue_dashboard/decorators/jobs_decorator.rb

@@ -0,0 +1,74 @@
+module SolidQueueDashboard
+  module Decorators
+    class JobsDecorator < SimpleDelegator
+      def with_status(status)
+        case status.to_sym
+        when Job::SUCCESS
+          success
+        when Job::FAILED
+          failed
+        when Job::SCHEDULED
+          scheduled
+        when Job::PENDING
+          pending
+        when Job::RETRIED
+          retried
+        else
+          raise "Invalid status: #{status}"
+        end
+      end
+
+      def success
+        where.not(finished_at: nil)
+          .where.not(id: failed)
+          .where.not(id: retried)
+      end
+
+      def scheduled
+        where(finished_at: nil, scheduled_at: Time.current..)
+      end
+
+      def pending
+        where(finished_at: nil, scheduled_at: ..Time.current)
+          .where.not(id: failed)
+      end
+
+      def retried
+        where(finished_at: ..Time.current)
+          .where.not(id: failed)
+          .where(
+            active_job_id: SolidQueue::Job
+              .select(:active_job_id)
+              .group(:active_job_id)
+              .having("COUNT(*) > 1")
+          )
+          .where.not(
+            id: SolidQueue::Job
+              .select("MAX(id)")
+              .group(:active_job_id)
+          )
+      end
+
+      def failure_rate
+        success_count = success.count
+        retried_count = retried.count
+        failed_count = failed.count
+
+        total = success_count + retried_count + failed_count
+        return 0 if total.zero?
+
+        (failed_count + retried_count).to_f / total * 100
+      end
+
+      def each
+        super do |job|
+          yield JobDecorator.new(job)
+        end
+      end
+
+      def to_a
+        super.map { |job| JobDecorator.new(job) }
+      end
+    end
+  end
+end

data/lib/solid_queue_dashboard/decorators/process_decorator.rb

@@ -0,0 +1,13 @@
+module SolidQueueDashboard
+  module Decorators
+    class ProcessDecorator < SimpleDelegator
+      def color
+        Process.kind_color(kind)
+      end
+
+      def dead?
+        last_heartbeat_at < Process::HEARTBEAT_DEAD_THRESHOLD.ago
+      end
+    end
+  end
+end

data/lib/solid_queue_dashboard/decorators/processes_decorator.rb

@@ -0,0 +1,15 @@
+module SolidQueueDashboard
+  module Decorators
+    class ProcessesDecorator < SimpleDelegator
+      def each
+        super do |job|
+          yield ProcessDecorator.new(job)
+        end
+      end
+
+      def to_a
+        super.map { |job| ProcessDecorator.new(job) }
+      end
+    end
+  end
+end

data/lib/solid_queue_dashboard/decorators/recurring_task_decorator.rb

@@ -0,0 +1,22 @@
+module SolidQueueDashboard
+  module Decorators
+    class RecurringTaskDecorator < SimpleDelegator
+      def type
+        if command.present?
+          RecurringTask::COMMAND
+        elsif class_name.present?
+          RecurringTask::JOB
+        else
+          "Unknown"
+        end
+      end
+
+      def next_runs(count: 5)
+        cron = Fugit.parse(schedule)
+        return [] unless cron
+
+        cron.next.take(count)
+      end
+    end
+  end
+end

data/lib/solid_queue_dashboard/decorators/recurring_tasks_decorator.rb

@@ -0,0 +1,26 @@
+module SolidQueueDashboard
+  module Decorators
+    class RecurringTasksDecorator < SimpleDelegator
+      def with_type(type)
+        case type.to_sym
+        when RecurringTask::JOB
+          where.not(class_name: nil)
+        when RecurringTask::COMMAND
+          where.not(command: nil)
+        else
+          raise "Unknown type: #{type}"
+        end
+      end
+
+      def each
+        super do |task|
+          yield RecurringTaskDecorator.new(task)
+        end
+      end
+
+      def to_a
+        super.map { |task| RecurringTaskDecorator.new(task) }
+      end
+    end
+  end
+end

data/lib/solid_queue_dashboard/engine.rb

@@ -0,0 +1,13 @@
+module SolidQueueDashboard
+  class Engine < ::Rails::Engine
+    isolate_namespace SolidQueueDashboard
+
+    initializer "solid_queue_dashboard.assets.precompile" do |app|
+      app.config.assets.precompile += %w[
+        solid_queue_dashboard/alpine.js
+        solid_queue_dashboard/application.js
+        solid_queue_dashboard/application.css
+      ]
+    end
+  end
+end

data/lib/solid_queue_dashboard/job.rb

@@ -0,0 +1,26 @@
+module SolidQueueDashboard
+  module Job
+    # Constants
+    SUCCESS = :success
+    RETRIED = :retried
+    FAILED = :failed
+    PENDING = :pending
+    SCHEDULED = :scheduled
+
+    STATUSES = [ SUCCESS, RETRIED, FAILED, SCHEDULED, PENDING ]
+
+    STATUS_COLORS = {
+      SUCCESS => "green",
+      RETRIED => "amber",
+      FAILED => "red",
+      SCHEDULED => "blue",
+      PENDING => "zinc"
+    }
+
+    COMMAND_CLASS_NAME = "SolidQueue::RecurringJob"
+
+    def self.status_color(status)
+      STATUS_COLORS[status] || "zinc"
+    end
+  end
+end

data/lib/solid_queue_dashboard/process.rb

@@ -0,0 +1,24 @@
+module SolidQueueDashboard
+  module Process
+    # Constants
+    SUPERVISOR = "Supervisor"
+    DISPATCHER = "Dispatcher"
+    WORKER = "Worker"
+    SCHEDULER = "Scheduler"
+
+    KINDS = [ SUPERVISOR, DISPATCHER, WORKER, SCHEDULER ]
+
+    KIND_COLORS = {
+      SUPERVISOR => "blue",
+      DISPATCHER => "green",
+      WORKER => "yellow",
+      SCHEDULER => "purple"
+    }
+
+    HEARTBEAT_DEAD_THRESHOLD = 1.minute
+
+    def self.kind_color(kind)
+      KIND_COLORS[kind] || "zinc"
+    end
+  end
+end

data/lib/solid_queue_dashboard/recurring_task.rb

@@ -0,0 +1,14 @@
+module SolidQueueDashboard
+  module RecurringTask
+    # Constants
+    COMMAND = :command
+    JOB = :job
+
+    TYPES = [ COMMAND, JOB ]
+
+    TYPE_COLORS = {
+      COMMAND => "amber",
+      JOB => "sky"
+    }
+  end
+end

data/lib/solid_queue_dashboard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidQueueDashboard
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/solid_queue_dashboard.rb

@@ -1,8 +1,46 @@
 # frozen_string_literal: true
 
+require "rails"
 require_relative "solid_queue_dashboard/version"
+require_relative "solid_queue_dashboard/configuration"
+require_relative "solid_queue_dashboard/engine"
+require_relative "solid_queue_dashboard/job"
+require_relative "solid_queue_dashboard/process"
+require_relative "solid_queue_dashboard/recurring_task"
+require_relative "solid_queue_dashboard/decorators/job_decorator"
+require_relative "solid_queue_dashboard/decorators/jobs_decorator"
+require_relative "solid_queue_dashboard/decorators/process_decorator"
+require_relative "solid_queue_dashboard/decorators/processes_decorator"
+require_relative "solid_queue_dashboard/decorators/recurring_task_decorator"
+require_relative "solid_queue_dashboard/decorators/recurring_tasks_decorator"
 
 module SolidQueueDashboard
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.job_queue_names
+    SolidQueue::Job.distinct.pluck(:queue_name)
+  end
+
+  def self.job_class_names
+    SolidQueue::Job.distinct.pluck(:class_name)
+  end
+
+  def self.decorate(object)
+    case object
+    when SolidQueue::Job
+      Decorators::JobDecorator.new(object)
+    when SolidQueue::Job.const_get(:ActiveRecord_Relation)
+      Decorators::JobsDecorator.new(object)
+    when SolidQueue::Process
+      Decorators::ProcessDecorator.new(object)
+    when SolidQueue::Process.const_get(:ActiveRecord_Relation)
+      Decorators::ProcessesDecorator.new(object)
+    when SolidQueue::RecurringTask
+      Decorators::RecurringTaskDecorator.new(object)
+    when SolidQueue::RecurringTask.const_get(:ActiveRecord_Relation)
+      Decorators::RecurringTasksDecorator.new(object)
+    else
+      raise Error, "Cannot decorate #{object.class}"
+    end
+  end
 end

data/package.json

@@ -0,0 +1,13 @@
+{
+  "private": true,
+  "scripts": {
+    "build": "tailwindcss -i ./app/assets/stylesheets/solid_queue_dashboard/tailwind.css -o ./app/assets/stylesheets/solid_queue_dashboard/application.css",
+    "watch": "tailwindcss -i ./app/assets/stylesheets/solid_queue_dashboard/tailwind.css -o ./app/assets/stylesheets/solid_queue_dashboard/application.css --watch"
+  },
+  "devDependencies": {
+    "@tailwindcss/forms": "^0.5.9",
+    "@tailwindcss/typography": "^0.5.15",
+    "tailwindcss": "^3.4.13",
+    "tailwindcss-animate": "^1.0.7"
+  }
+}

data/tailwind.config.js

@@ -0,0 +1,83 @@
+const { fontFamily } = require("tailwindcss/defaultTheme")
+
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  darkMode: ["class"],
+  content: [
+    "./app/views/**/*.html.erb",
+    "./app/helpers/**/*.rb",
+    "./app/javascript/**/*.js",
+  ],
+  theme: {
+    container: {
+      center: true,
+      padding: "2rem",
+      screens: {
+        "2xl": "1400px",
+      },
+    },
+    extend: {
+      colors: {
+        border: "hsl(var(--border))",
+        input: "hsl(var(--input))",
+        ring: "hsl(var(--ring))",
+        background: "hsl(var(--background))",
+        foreground: "hsl(var(--foreground))",
+        primary: {
+          DEFAULT: "hsl(var(--primary))",
+          foreground: "hsl(var(--primary-foreground))",
+        },
+        secondary: {
+          DEFAULT: "hsl(var(--secondary))",
+          foreground: "hsl(var(--secondary-foreground))",
+        },
+        destructive: {
+          DEFAULT: "hsl(var(--destructive))",
+          foreground: "hsl(var(--destructive-foreground))",
+        },
+        muted: {
+          DEFAULT: "hsl(var(--muted))",
+          foreground: "hsl(var(--muted-foreground))",
+        },
+        accent: {
+          DEFAULT: "hsl(var(--accent))",
+          foreground: "hsl(var(--accent-foreground))",
+        },
+        popover: {
+          DEFAULT: "hsl(var(--popover))",
+          foreground: "hsl(var(--popover-foreground))",
+        },
+        card: {
+          DEFAULT: "hsl(var(--card))",
+          foreground: "hsl(var(--card-foreground))",
+        },
+      },
+      borderRadius: {
+        lg: `var(--radius)`,
+        md: `calc(var(--radius) - 2px)`,
+        sm: "calc(var(--radius) - 4px)",
+      },
+      opacity: {
+        7.5: "0.075",
+      },
+      keyframes: {
+        "accordion-down": {
+          from: { height: "0" },
+          to: { height: "var(--radix-accordion-content-height)" },
+        },
+        "accordion-up": {
+          from: { height: "var(--radix-accordion-content-height)" },
+          to: { height: "0" },
+        },
+      },
+      animation: {
+        "accordion-down": "accordion-down 0.2s ease-out",
+        "accordion-up": "accordion-up 0.2s ease-out",
+      },
+    },
+  },
+  plugins: [
+    require("tailwindcss-animate"),
+    require("@tailwindcss/forms")({ strategy: "class" }),
+  ],
+}