katalyst-koi 5.7.0 → 5.8.0

data/app/controllers/admin/background_jobs_controller.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Admin
+  class BackgroundJobsController < ApplicationController
+    before_action :set_background_job, only: %i[show retry discard]
+
+    attr_reader :collection, :background_job
+
+    def index       = render_state(:pending)
+    def scheduled   = render_state(:scheduled)
+    def in_progress = render_state(:in_progress)
+    def blocked     = render_state(:blocked)
+    def failed      = render_state(:failed)
+    def completed   = render_state(:completed)
+
+    def show
+      render locals: { background_job: }
+    end
+
+    def retry
+      background_job.retry
+
+      redirect_to admin_background_jobs_path, status: :see_other
+    end
+
+    def discard
+      redirect_target = background_job.failed? ? failed_admin_background_jobs_path : admin_background_jobs_path
+
+      background_job.discard
+
+      redirect_to redirect_target, status: :see_other
+    end
+
+    def retry_all
+      SolidQueue::Job.failed.where(id: params[:id]).find_each(&:retry)
+
+      redirect_back_or_to failed_admin_background_jobs_path, status: :see_other
+    end
+
+    def discard_all
+      SolidQueue::Job.where(id: params[:id]).find_each(&:discard)
+
+      redirect_back_or_to admin_background_jobs_path, status: :see_other
+    end
+
+    private
+
+    def render_state(state)
+      states      = BackgroundJob.states
+      @collection = Collection.with_params(params).apply(states.fetch(state).strict_loading)
+
+      render locals: { collection:, state_counts: states.transform_values(&:count) }
+    end
+
+    def set_background_job
+      job             = SolidQueue::Job.find_by!(active_job_id: params.expect(:active_job_id))
+      @background_job = BackgroundJob.new(job)
+    end
+
+    class Collection < Admin::Collection
+      config.paginate = true
+
+      attribute :class_name, :string
+      attribute :queue_name, :string
+      attribute :scheduled_at, :date
+    end
+  end
+end

data/app/controllers/admin/feature_flags_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Admin
+  class FeatureFlagsController < ApplicationController
+    before_action :set_feature_flag, only: %i[show update destroy]
+
+    attr_reader :collection, :feature_flag
+
+    def index
+      @collection = Collection.with_params(params).apply(FeatureFlag.all)
+
+      render locals: { collection: }
+    end
+
+    def show
+      render locals: { feature_flag:, groups: Flipper.group_names }
+    end
+
+    def new
+      @feature_flag = FeatureFlag.build
+
+      render locals: { feature_flag: }
+    end
+
+    def create
+      @feature_flag = FeatureFlag.build(key: params.expect(feature_flag: [:key]).fetch(:key, nil))
+
+      if feature_flag.save
+        redirect_to(admin_feature_flag_path(feature_flag), status: :see_other)
+      else
+        render(:new, locals: { feature_flag: }, status: :unprocessable_content)
+      end
+    end
+
+    def update
+      feature_flag.update(feature_flag_params)
+
+      redirect_to(admin_feature_flags_path, status: :see_other)
+    end
+
+    def destroy
+      feature_flag.destroy
+
+      redirect_to(admin_feature_flags_path, status: :see_other)
+    end
+
+    private
+
+    def set_feature_flag
+      @feature_flag = FeatureFlag.find(params.expect(:key))
+    end
+
+    def feature_flag_params
+      params.expect(feature_flag: [:state, :percentage_of_actors, :percentage_of_time, :actors, { groups: [] }])
+    end
+
+    class Collection < Katalyst::Tables::Collection::Array
+      def model
+        FeatureFlag
+      end
+
+      def model_name
+        FeatureFlag.model_name
+      end
+    end
+  end
+end

data/app/controllers/admin/recurring_tasks_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Admin
+  class RecurringTasksController < ApplicationController
+    before_action :set_recurring_task, only: %i[show run]
+
+    attr_reader :recurring_task
+
+    def index
+      collection = Collection.with_params(params).apply(SolidQueue::RecurringTask.all)
+
+      render locals: { collection: }
+    end
+
+    def show
+      jobs = JobsCollection.with_params(params).apply(jobs_scope)
+
+      render locals: { recurring_task:, jobs: }
+    end
+
+    def run
+      recurring_task.run
+
+      redirect_to(admin_recurring_task_path(recurring_task), status: :see_other)
+    end
+
+    private
+
+    def set_recurring_task
+      task            = SolidQueue::RecurringTask.find_by!(key: params.expect(:key))
+      @recurring_task = RecurringTask.new(task)
+    end
+
+    def jobs_scope
+      SolidQueue::Job.joins(:recurring_execution)
+        .where(solid_queue_recurring_executions: { task_key: recurring_task.key })
+        .order(scheduled_at: :desc)
+    end
+
+    class Collection < Admin::Collection
+      config.sorting  = :key
+      config.paginate = true
+
+      attribute :key, :string
+      attribute :schedule, :string
+      attribute :last_enqueued_time, :date
+    end
+
+    class JobsCollection < Admin::Collection
+      config.paginate = true
+
+      def apply(items)
+        super.tap do
+          self.items = self.items.map { |job| BackgroundJob.new(job) }
+        end
+      end
+
+      def model
+        BackgroundJob
+      end
+
+      def model_name
+        BackgroundJob.model_name
+      end
+    end
+  end
+end

data/app/helpers/admin/background_jobs_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Admin
+  module BackgroundJobsHelper
+    # The listing path for a job state. Pending is the index; the rest are
+    # collection routes named after the state.
+    def background_job_state_path(state)
+      if state == :pending
+        admin_background_jobs_path
+      else
+        public_send(:"#{state}_admin_background_jobs_path")
+      end
+    end
+  end
+end

data/app/helpers/koi/tags/trix_toolbar.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Koi
+  module Tags
+    class TrixToolbar
+      include ActionView::Helpers::TagHelper
+      include Katalyst::HtmlAttributes
+
+      TRIX_BUTTON_ROW_TEMPLATE = <<~HTML.html_safe.freeze
+        <div class="trix-button-row">
+          <span class="trix-button-group trix-button-group--text-tools" data-trix-button-group="text-tools">
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-bold" data-trix-attribute="bold" data-trix-key="b" title="Bold" tabindex="-1">Bold</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-italic" data-trix-attribute="italic" data-trix-key="i" title="Italic" tabindex="-1">Italic</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-strike" data-trix-attribute="strike" title="Strikethrough" tabindex="-1">Strikethrough</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-link" data-trix-attribute="href" data-trix-action="link" data-trix-key="k" title="Link" tabindex="-1">Link</button>
+          </span>
+
+          <span class="trix-button-group trix-button-group--block-tools" data-trix-button-group="block-tools">
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-heading-1" data-trix-attribute="heading4" title="Heading" tabindex="-1">Heading</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-quote" data-trix-attribute="quote" title="Quote" tabindex="-1">Quote</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-code" data-trix-attribute="code" title="Code" tabindex="-1">Code</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-bullet-list" data-trix-attribute="bullet" title="Bullets" tabindex="-1">Bullets</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-number-list" data-trix-attribute="number" title="Numbers" tabindex="-1">Numbers</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-decrease-nesting-level" data-trix-action="decreaseNestingLevel" title="Decrease level" tabindex="-1">Decrease level</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-increase-nesting-level" data-trix-action="increaseNestingLevel" title="Increase level" tabindex="-1">Increase level</button>
+          </span>
+
+          <span class="trix-button-group trix-button-group--file-tools" data-trix-button-group="file-tools">
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-attach" data-trix-action="attachFiles" title="Attach files" tabindex="-1">Attach files</button>
+          </span>
+
+          <span class="trix-button-group-spacer"></span>
+
+          <span class="trix-button-group trix-button-group--history-tools" data-trix-button-group="history-tools">
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-undo" data-trix-action="undo" data-trix-key="z" title="Undo" tabindex="-1">Undo</button>
+            <button type="button" class="trix-button trix-button--icon trix-button--icon-redo" data-trix-action="redo" data-trix-key="shift+z" title="Redo" tabindex="-1">Redo</button>
+          </span>
+        </div>
+      HTML
+
+      TRIX_DIALOGS_TEMPLATE    = <<~HTML.html_safe.freeze
+        <div class="trix-dialogs" data-trix-dialogs>
+          <div class="trix-dialog trix-dialog--link" data-trix-dialog="href" data-trix-dialog-attribute="href">
+            <div class="trix-dialog__link-fields">
+              <input type="text" name="href" pattern="(https?|mailto:|tel:|/|#).*?" class="trix-input trix-input--dialog" placeholder="Enter a URL…" aria-label="URL" data-trix-validate-href required data-trix-input>
+              <div class="trix-button-group">
+                <input type="button" class="trix-button trix-button--dialog" value="Link" data-trix-method="setAttribute">
+                <input type="button" class="trix-button trix-button--dialog" value="Unlink" data-trix-method="removeAttribute">
+              </div>
+            </div>
+          </div>
+        </div>
+      HTML
+
+      def render
+        content_tag("trix-toolbar", TRIX_BUTTON_ROW_TEMPLATE + TRIX_DIALOGS_TEMPLATE, **html_attributes)
+      end
+
+      def default_html_attributes
+        { data: { turbo_permanent: "" } }
+      end
+    end
+  end
+end

data/app/javascript/koi/application.js

@@ -1,7 +1,8 @@
 import "@hotwired/turbo-rails";
 import { initAll } from "@katalyst/govuk-formbuilder";
 import "@rails/actiontext";
-import "trix";
+import Lexxy from "./utils/lexxy";
+import Trix from "./utils/trix";
 
 import "./controllers";
 import "./elements";
@@ -18,3 +19,5 @@ function initGOVUK() {
 
 window.addEventListener("turbo:load", initGOVUK);
 if (window.Turbo) initGOVUK();
+
+export default { Lexxy, Trix };

data/app/javascript/koi/utils/lexxy.js

@@ -0,0 +1,23 @@
+import * as Lexxy from "lexxy";
+
+Lexxy.configure({
+  global: {
+    authenticatedUploads: true,
+  },
+});
+
+// The link toolbar's URL input is type=url, whose checkValidity() rejects
+// schemeless values like #anchor and /relative that lexxy's link node happily
+// preserves. Switch it to type=text with the same pattern Koi applies to the
+// trix link dialog (see Koi::Tags::TrixToolbar::TRIX_DIALOGS_TEMPLATE) so both
+// editors validate link input identically.
+document.addEventListener("lexxy:initialize", ({ target }) => {
+  target
+    .querySelectorAll("lexxy-link-dropdown input[type=url]")
+    .forEach((input) => {
+      input.type = "text";
+      input.pattern = "(https?|mailto:|tel:|/|#).*?";
+    });
+});
+
+export default Lexxy;

data/app/javascript/koi/utils/trix.js

@@ -0,0 +1,17 @@
+import "trix";
+
+// Trix does not provide an export
+const Trix = window.Trix;
+
+// Koi uses H4 for headings instead of H1
+Trix.config.blockAttributes["heading4"] = {
+  tagName: "h4",
+  terminal: true,
+  breakOnReturn: true,
+  group: false,
+};
+
+// Remove H1 from trix list of acceptable tags
+delete Trix.config.blockAttributes.heading1;
+
+export default Trix;

data/app/models/background_job.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class BackgroundJob
+  include ActiveModel::Model
+
+  # @return [SolidQueue::Job]
+  attr_reader :job
+
+  delegate_missing_to :job
+
+  # The SolidQueue relation backing each job state, in display order. A job that
+  # isn't finished holds exactly one execution; finished jobs carry a finished_at.
+  def self.states
+    {
+      pending:     SolidQueue::Job.where.associated(:ready_execution),
+      scheduled:   SolidQueue::Job.where.associated(:scheduled_execution),
+      in_progress: SolidQueue::Job.where.associated(:claimed_execution),
+      blocked:     SolidQueue::Job.where.associated(:blocked_execution),
+      failed:      SolidQueue::Job.failed,
+      completed:   SolidQueue::Job.finished,
+    }
+  end
+
+  # @param [SolidQueue::Job] job
+  def initialize(job)
+    @job = job
+  end
+
+  # ActiveJob's job id, stored in the serialized payload rather than as a column.
+  def job_id
+    job.arguments["job_id"]
+  end
+
+  # Serialized as an ISO8601 string in the payload; parse so views can format it.
+  def enqueued_at
+    job.arguments["enqueued_at"]&.then { |value| Time.iso8601(value) }
+  end
+
+  # The arguments the job was enqueued with, from the serialized payload.
+  def serialized_arguments
+    job.arguments["arguments"]
+  end
+
+  # Human-readable run time once finished, e.g. "1 minute and 35 seconds".
+  def duration
+    return unless finished? && enqueued_at
+
+    seconds   = finished_at - enqueued_at
+    precision = case seconds
+                when 0...1  then 2
+                when 1...10 then 1
+                else             0
+                end
+    ActiveSupport::Duration.build(seconds.round(precision)).inspect
+  end
+
+  # SolidQueue::Job#discard only acts on a ready, claimed, or failed execution;
+  # it's a no-op for scheduled, blocked, or finished jobs.
+  def discardable?
+    ready_execution.present? || claimed_execution.present? || failed_execution.present?
+  end
+
+  # Exception class and message from the current failure, e.g. "RuntimeError: boom".
+  def failure_reason
+    return unless (failure = failed_execution)
+
+    "#{failure.exception_class}: #{failure.message}"
+  end
+
+  def state
+    if finished?
+      :finished
+    elsif failed?
+      :failed
+    elsif claimed_execution.present?
+      :in_progress
+    elsif blocked_execution.present?
+      :blocked
+    elsif scheduled_execution.present?
+      :scheduled
+    else
+      :pending
+    end
+  end
+
+  # Backtrace lines from the current failure, joined into a single string.
+  def backtrace
+    failed_execution&.backtrace&.join("\n")
+  end
+
+  def to_param
+    active_job_id
+  end
+
+  def to_s
+    class_name
+  end
+end

data/app/models/feature_flag.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Presents a Flipper feature for the admin UI. Wrapping Flipper::Feature in an
+# ActiveModel-compatible object lets it flow through Koi's table, form, and
+# routing helpers.
+class FeatureFlag
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  def self.all
+    Flipper.features.sort_by(&:key).map { |feature| new(feature:) }
+  end
+
+  def self.find(key)
+    raise ActiveRecord::RecordNotFound, "Couldn't find feature #{key.inspect}" unless Flipper.exist?(key)
+
+    new(key:)
+  end
+
+  def self.build(key: nil)
+    new(key:)
+  end
+
+  attribute :key, :string
+
+  validates :key, presence: true
+  validates :key, format: { with: /\A[a-z0-9_]+\z/i }, allow_blank: true
+
+  # @return [Flipper::Feature]
+  attr_reader :feature
+
+  delegate_missing_to :feature
+
+  # @param [Flipper::Feature] feature
+  def initialize(feature: nil, **)
+    super(**)
+
+    if feature
+      self.key = feature.key
+      @feature = feature
+    else
+      @feature = Flipper.feature(key.to_s)
+    end
+  end
+
+  # Validate and register the feature. Returns false (leaving errors populated)
+  # when invalid. Adding is idempotent, so re-saving an existing key is a no-op.
+  def save # rubocop:disable Naming/PredicateMethod
+    return false unless valid?
+
+    Flipper.add(key)
+    true
+  end
+
+  # Apply the desired availability from the form: fully on, fully off, or a set
+  # of conditional rules. Clear the gates before applying rules so a previously
+  # set boolean gate can't mask them — Flipper reads a feature as fully on
+  # whenever its boolean gate is set, and there's no way to disable only that
+  # gate.
+  def update(attributes) # rubocop:disable Naming/PredicateMethod
+    case attributes[:state]
+    when "on"  then enable
+    when "off" then disable
+    else            configure(attributes)
+    end
+
+    true
+  end
+
+  # Remove the feature from Flipper entirely.
+  def destroy
+    Flipper.remove(key)
+  end
+
+  # Enabled groups as names, for display and form pre-fill.
+  def groups
+    groups_value.to_a
+  end
+
+  def percentage_of_actors
+    percentage_of_actors_value
+  end
+
+  def percentage_of_time
+    percentage_of_time_value
+  end
+
+  # Enabled actors as a newline-separated list of flipper ids, for editing.
+  def actors
+    actors_value.to_a.join("\n")
+  end
+
+  # A wrapped feature is backed by a registered Flipper feature, so it counts as
+  # persisted. Lets Koi helpers (e.g. link_to_delete) treat it like a record.
+  def persisted?
+    key.present? && Flipper.exist?(key)
+  end
+
+  def to_param
+    key
+  end
+
+  def to_s
+    key
+  end
+
+  private
+
+  def configure(attributes)
+    clear
+
+    Array(attributes[:groups]).compact_blank.each { |name| enable_group(name) }
+    parse_actors(attributes[:actors]).each { |id| enable_actor(Flipper::Actor.new(id)) }
+
+    apply_percentage(:enable_percentage_of_actors, attributes[:percentage_of_actors])
+    apply_percentage(:enable_percentage_of_time, attributes[:percentage_of_time])
+  end
+
+  def apply_percentage(method, value)
+    percentage = value.to_i
+
+    public_send(method, percentage) if percentage.positive?
+  end
+
+  def parse_actors(value)
+    value.to_s.split(/[\s,]+/)
+  end
+end

data/app/models/recurring_task.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class RecurringTask
+  include ActiveModel::Model
+
+  # @return [SolidQueue::RecurringTask]
+  attr_reader :task
+
+  delegate_missing_to :task
+
+  # @param [SolidQueue::RecurringTask] task
+  def initialize(task)
+    @task = task
+  end
+
+  def job_class
+    class_name.presence || command
+  end
+
+  def run
+    task.enqueue(at: Time.current)
+  end
+
+  def to_param
+    key
+  end
+
+  def to_s
+    key
+  end
+end

data/app/views/admin/background_jobs/_navigation.html.erb

@@ -0,0 +1,8 @@
+<%# locals: (state_counts:) %>
+
+<%= actions_list do %>
+  <% state_counts.each do |state, count| %>
+    <li><%= link_to("#{state.to_s.humanize} (#{count})", background_job_state_path(state)) %></li>
+  <% end %>
+  <li><%= link_to("Recurring tasks", admin_recurring_tasks_path) %></li>
+<% end %>

data/app/views/admin/background_jobs/blocked.html.erb

@@ -0,0 +1,17 @@
+<%# locals: (collection:, state_counts:) %>
+
+<% content_for(:header) do %>
+  <h1>Blocked jobs</h1>
+
+  <%= render "navigation", state_counts: %>
+<% end %>
+
+<%= table_query_with(collection:) %>
+
+<%= table_with(collection:) do |row, job| %>
+  <% row.link(:class_name, url: ->(record) { admin_background_job_path(record.active_job_id) }, label: "Job") %>
+  <% row.text(:queue_name, label: "Queue") %>
+  <% row.datetime(:scheduled_at, label: "Scheduled") %>
+<% end %>
+
+<%= table_pagination_with(collection:) %>

data/app/views/admin/background_jobs/completed.html.erb

@@ -0,0 +1,17 @@
+<%# locals: (collection:, state_counts:) %>
+
+<% content_for(:header) do %>
+  <h1>Completed jobs</h1>
+
+  <%= render "navigation", state_counts: %>
+<% end %>
+
+<%= table_query_with(collection:) %>
+
+<%= table_with(collection:) do |row, job| %>
+  <% row.link(:class_name, url: ->(record) { admin_background_job_path(record.active_job_id) }, label: "Job") %>
+  <% row.text(:queue_name, label: "Queue") %>
+  <% row.datetime(:finished_at, label: "Finished") %>
+<% end %>
+
+<%= table_pagination_with(collection:) %>

data/app/views/admin/background_jobs/failed.html.erb

@@ -0,0 +1,26 @@
+<%# locals: (collection:, state_counts:) %>
+
+<% content_for(:header) do %>
+  <h1>Failed jobs</h1>
+
+  <%= render "navigation", state_counts: %>
+<% end %>
+
+<%= table_query_with(collection:) %>
+
+<%= table_selection_with(collection:) do %>
+  <%= tag.button("Retry", formaction: retry_all_admin_background_jobs_path, formmethod: :post, class: "button") %>
+  <%= tag.button("Discard", formaction: discard_all_admin_background_jobs_path, formmethod: :delete, class: "button button--secondary") %>
+<% end %>
+
+<%= table_with(collection:) do |row, job| %>
+  <% row.select %>
+  <% row.link(:class_name, url: ->(record) { admin_background_job_path(record.active_job_id) }, label: "Job") %>
+  <% row.text(:queue_name, label: "Queue") %>
+  <% row.datetime(:updated_at, label: "Last failed") %>
+  <% row.text(:error, label: "Error") do %>
+    <%= BackgroundJob.new(job).failure_reason %>
+  <% end %>
+<% end %>
+
+<%= table_pagination_with(collection:) %>