katalyst-koi 5.7.1 → 5.8.1

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

@@ -0,0 +1,17 @@
+<%# locals: (collection:, state_counts:) %>
+
+<% content_for(:header) do %>
+  <h1>In progress 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/index.html.erb

@@ -0,0 +1,22 @@
+<%# locals: (collection:, state_counts:) %>
+
+<% content_for(:header) do %>
+  <h1>Pending jobs</h1>
+
+  <%= render "navigation", state_counts: %>
+<% end %>
+
+<%= table_query_with(collection:) %>
+
+<%= table_selection_with(collection:) do %>
+  <%= tag.button("Discard", formaction: discard_all_admin_background_jobs_path, formmethod: :delete, class: "button") %>
+<% 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(:scheduled_at, label: "Scheduled") %>
+<% end %>
+
+<%= table_pagination_with(collection:) %>

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

@@ -0,0 +1,17 @@
+<%# locals: (collection:, state_counts:) %>
+
+<% content_for(:header) do %>
+  <h1>Scheduled 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/show.html.erb

@@ -0,0 +1,41 @@
+<%# locals: (background_job:) %>
+
+<% content_for(:header) do %>
+  <%= breadcrumb_list do %>
+    <li><%= link_to("Background jobs", admin_background_jobs_path) %></li>
+  <% end %>
+
+  <h1><%= background_job %></h1>
+
+  <%= actions_list do %>
+    <% if background_job.failed? %>
+      <li><%= link_to("Retry", retry_admin_background_job_path(background_job), data: { turbo_method: :post }) %></li>
+    <% end %>
+    <% if background_job.discardable? %>
+      <li><%= link_to_delete(background_job.job, "Discard", url: discard_admin_background_job_path(background_job)) %></li>
+    <% end %>
+  <% end %>
+<% end %>
+
+<%= summary_table_with(model: background_job) do |row| %>
+  <% row.text(:serialized_arguments, label: "Arguments") do |cell| %>
+    <code><%= JSON.pretty_generate(cell.value).strip %></code>
+  <% end %>
+  <% row.text(:job_id) %>
+  <% row.text(:queue_name, label: "Queue") %>
+  <% row.datetime(:enqueued_at, label: "Enqueued") %>
+  <% if background_job.finished? %>
+    <% row.datetime(:finished_at, label: "Finished") %>
+    <% row.text(:duration, label: "Duration") %>
+  <% end %>
+  <% if background_job.failed? %>
+    <% row.datetime(:updated_at, label: "Last failed") %>
+    <% row.text(:failure_reason, label: "Reason") %>
+    <% row.text(:backtrace, label: "Stacktrace") do |cell| %>
+      <pre><%= cell.value %></pre>
+    <% end %>
+  <% end %>
+  <% row.text(:job, label: "Raw data") do |cell| %>
+    <pre><%= JSON.pretty_generate(cell.value.as_json).strip %></pre>
+  <% end %>
+<% end %>

data/app/views/admin/feature_flags/index.html.erb

@@ -0,0 +1,14 @@
+<%# locals: (collection:) %>
+
+<% content_for(:header) do %>
+  <h1>Feature flags</h1>
+
+  <%= actions_list do %>
+    <li><%= link_to("New", new_admin_feature_flag_path) %></li>
+  <% end %>
+<% end %>
+
+<%= table_with(collection:) do |row, feature_flag| %>
+  <% row.link(:key, url: ->(record) { admin_feature_flag_path(record) }, label: "Name") %>
+  <% row.text(:state, label: "Status") { |cell| cell.value.to_s.humanize } %>
+<% end %>

data/app/views/admin/feature_flags/new.html.erb

@@ -0,0 +1,14 @@
+<%# locals: (feature_flag:) %>
+
+<% content_for(:header) do %>
+  <%= breadcrumb_list do %>
+    <li><%= link_to("Feature flags", admin_feature_flags_path) %></li>
+  <% end %>
+
+  <h1>New feature flag</h1>
+<% end %>
+
+<%= form_with(model: feature_flag, url: admin_feature_flags_path) do |form| %>
+  <%= form.govuk_text_field(:key, label: { text: "Name" }) %>
+  <%= form.button("Create", class: "button") %>
+<% end %>

data/app/views/admin/feature_flags/show.html.erb

@@ -0,0 +1,30 @@
+<%# locals: (feature_flag:, groups:) %>
+
+<% content_for(:header) do %>
+  <%= breadcrumb_list do %>
+    <li><%= link_to("Feature flags", admin_feature_flags_path) %></li>
+  <% end %>
+
+  <h1><%= feature_flag %></h1>
+
+  <%= actions_list do %>
+    <li><%= link_to_delete(feature_flag, "Delete", url: admin_feature_flag_path(feature_flag)) %></li>
+  <% end %>
+<% end %>
+
+<%= form_with(model: feature_flag, url: admin_feature_flag_path(feature_flag), method: :patch) do |form| %>
+  <%= form.govuk_radio_buttons_fieldset(:state, legend: { text: "Availability" }) do %>
+    <%= form.govuk_radio_button(:state, :on, label: { text: "On for everyone" }) %>
+    <%= form.govuk_radio_button(:state, :conditional, label: { text: "Conditional" }) do %>
+      <% if groups.any? %>
+        <%= form.govuk_collection_check_boxes(:groups, groups.map(&:to_s), :to_s, :humanize, legend: { text: "Groups" }) %>
+      <% end %>
+      <%= form.govuk_number_field(:percentage_of_actors, label: { text: "Percentage of actors" }, min: 0, max: 100) %>
+      <%= form.govuk_number_field(:percentage_of_time, label: { text: "Percentage of time" }, min: 0, max: 100) %>
+      <%= form.govuk_text_area(:actors, label: { text: "Actors" }, hint: { text: "One flipper id per line, e.g. Admin::User;1" }) %>
+    <% end %>
+    <%= form.govuk_radio_button(:state, :off, label: { text: "Off for everyone" }) %>
+  <% end %>
+
+  <%= form.button("Save", class: "button") %>
+<% end %>

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

@@ -0,0 +1,20 @@
+<%# locals: (collection:) %>
+
+<% content_for(:header) do %>
+  <%= breadcrumb_list do %>
+    <li><%= link_to("Background jobs", admin_background_jobs_path) %></li>
+  <% end %>
+
+  <h1>Recurring tasks</h1>
+
+<% end %>
+
+<%= table_query_with(collection:) %>
+
+<%= table_with(collection:) do |row| %>
+  <% row.link(:key, url: ->(record) { admin_recurring_task_path(record.key) }, label: "Job name") %>
+  <% row.text(:schedule, label: "Schedule") %>
+  <% row.datetime(:last_enqueued_time, label: "Last enqueued") %>
+<% end %>
+
+<%= table_pagination_with(collection:) %>

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

@@ -0,0 +1,33 @@
+<%# locals: (recurring_task:, jobs:) %>
+
+<% content_for(:header) do %>
+  <%= breadcrumb_list do %>
+    <li><%= link_to("Recurring tasks", admin_recurring_tasks_path) %></li>
+  <% end %>
+
+  <h1><%= recurring_task %></h1>
+
+  <%= actions_list do %>
+    <li><%= link_to("Run", run_admin_recurring_task_path(recurring_task), data: { turbo_method: :post }) %></li>
+  <% end %>
+<% end %>
+
+<%= summary_table_with(model: recurring_task) do |row| %>
+  <% row.text(:job_class) %>
+  <% row.text(:arguments) do |cell| %>
+    <code><%= JSON.pretty_generate(cell.value).strip %></code>
+  <% end %>
+  <% row.text(:schedule) %>
+<% end %>
+
+<h2>Jobs</h2>
+
+<%= table_with(collection: jobs) do |row| %>
+  <% row.link(:job_id, url: ->(record) { admin_background_job_path(record.active_job_id) }, label: "Job") %>
+  <% row.datetime(:enqueued_at) %>
+  <% row.datetime(:finished_at) %>
+  <% row.number(:duration) %>
+  <% row.enum(:state) %>
+<% end %>
+
+<%= table_pagination_with(collection: jobs) %>

data/app/views/layouts/action_text/contents/_content.html.erb

@@ -0,0 +1,3 @@
+<div class="<%= Koi.action_text_editor %>-content">
+  <%= yield -%>
+</div>

data/config/ci.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Run using bin/ci
+
+CI.run do
+  step "Style", "bundle exec rake lint"
+  step "Assets: Build", "bundle exec rake build"
+  step "Tests: RSpec", "bundle exec rake spec"
+  step "Security: Brakeman", "bundle exec rake security"
+end

data/config/importmap.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
-pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
-pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+pin "@hotwired/stimulus", to: "stimulus.min.js"
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"
+pin "@hotwired/turbo-rails", to: "turbo.min.js"
 pin "@katalyst/koi", to: "katalyst/koi.min.js"
-pin "@rails/actiontext", to: "actiontext.js", preload: true
+pin "@rails/actiontext", to: "actiontext.js"
+pin "@rails/activestorage", to: "activestorage.esm.js"
+pin "lexxy"
 pin "trix"

data/config/routes.rb

@@ -16,6 +16,10 @@ Rails.application.routes.draw do
     resources :device_authorizations, param: :user_code, only: %i[create show update]
     resources :device_tokens, only: %i[create]
 
+    scope :active_storage, module: :active_storage do
+      post :direct_uploads, to: "direct_uploads#create"
+    end
+
     resource :profile, only: %i[show edit update], shallow: true do
       resources :credentials, only: %i[show new create update destroy]
       resource :otp, only: %i[new create destroy]
@@ -26,6 +30,27 @@ Rails.application.routes.draw do
       resources :tokens, param: :token, only: %i[show update], token: /[^\/]+/
     end
 
+    resources :background_jobs, only: %i[index show], param: :active_job_id do
+      collection do
+        get :scheduled
+        get :in_progress
+        get :blocked
+        get :failed
+        get :completed
+
+        post :retry_all
+        delete :discard_all
+      end
+
+      member do
+        post :retry
+        delete :discard
+      end
+    end
+    resources :recurring_tasks, only: %i[index show], param: :key do
+      post :run, on: :member
+    end
+    resources :feature_flags, except: :edit, param: :key if Object.const_defined?(:Flipper)
     resources :url_rewrites
     resources :well_knowns
 
@@ -35,8 +60,15 @@ Rails.application.routes.draw do
   scope :admin do
     mount Katalyst::Content::Engine, at: "content"
     mount Katalyst::Navigation::Engine, at: "navigation"
+
+    # @deprecated use /admin/feature_flags instead, remove in 6.0
     mount Flipper::UI.app(Flipper) => "flipper" if Object.const_defined?("Flipper::UI")
   end
 
   resources :well_knowns, path: ".well-known", param: :name, only: %i[show], name: /.+/
+
+  # Fallbacks for optional dependencies
+  unless Object.const_defined?("HotwireCombobox")
+    get "hotwire_combobox", to: ->(_) { [204, {}, []] }, as: nil
+  end
 end

data/lib/generators/koi/admin_route/templates/initializer.rb.tt

@@ -7,7 +7,8 @@ Koi::Menu.modules = {
 }
 
 Koi::Menu.advanced = {
-  "Admin Users"  => "/admin/admin_users",
-  "URL Rewriter" => "/admin/url_rewrites",
-  "Well Knowns"  => "/admin/well_knowns",
+  "Admin users"      => "/admin/admin_users",
+  "Background jobs"  => "/admin/background_jobs",
+  "URL rewriter"     => "/admin/url_rewrites",
+  "Well knowns"      => "/admin/well_knowns",
 }

data/lib/koi/action_text.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Koi
+  module ActionText
+    module TagHelper
+      using Katalyst::HtmlAttributes::HasHtmlAttributes
+
+      def koi_trix_toolbar_tag(**)
+        Tags::TrixToolbar.new(**).render
+      end
+
+      def koi_rich_textarea_tag(name, value = nil, options = {}, &)
+        case Koi.action_text_editor
+        when :lexxy
+          lexxy_rich_textarea_tag(name, value, options, &)
+        when :trix
+          options = options.symbolize_keys
+          trix_id = options[:id]
+
+          toolbar = koi_trix_toolbar_tag(id: "trix-toolbar-#{trix_id}")
+          editor  = trix_rich_textarea_tag(name, value, {
+            data:    { turbo_permanent: "" },
+            toolbar: "trix-toolbar-#{trix_id}",
+            trix_id:,
+          }.merge_html(options), &)
+
+          toolbar + editor
+        end
+      end
+    end
+
+    module FormHelper
+      def koi_rich_textarea(...)
+        case Koi.action_text_editor
+        when :lexxy
+          lexxy_rich_textarea(...)
+        when :trix
+          trix_rich_textarea(...)
+        end
+      end
+    end
+
+    module FormBuilder
+      def koi_rich_textarea(...)
+        case Koi.action_text_editor
+        when :lexxy
+          lexxy_rich_textarea(...)
+        when :trix
+          trix_rich_textarea(...)
+        end
+      end
+    end
+
+    module ActionTextTag
+      def koi_render(...)
+        case Koi.action_text_editor
+        when :lexxy
+          lexxy_render(...)
+        when :trix
+          trix_render(...)
+        end
+      end
+    end
+
+    # Add aliases for trix default methods so that Koi can swap between trix and lexxy based on feature flags.
+    def capture_action_text_defaults
+      ::ActionText::TagHelper.module_eval do
+        alias_method :trix_rich_textarea_tag, :rich_textarea_tag
+        alias_method :trix_rich_text_area_tag, :rich_text_area_tag
+      end
+
+      ::ActionView::Helpers::FormHelper.module_eval do
+        alias_method :trix_rich_textarea, :rich_textarea
+        alias_method :trix_rich_text_area, :rich_text_area
+      end
+
+      ::ActionView::Helpers::FormBuilder.module_eval do
+        alias_method :trix_rich_textarea, :rich_textarea
+        alias_method :trix_rich_text_area, :rich_textarea
+      end
+
+      ::ActionView::Helpers::Tags::ActionText.module_eval do
+        alias_method :trix_render, :render
+      end
+    end
+    module_function :capture_action_text_defaults
+
+    # Add shims for rich_textarea and friends.
+    # This is intended as a migration path and will be removed when Rails 8.2 is released.
+    def override_action_text_defaults
+      ::ActionText::TagHelper.module_eval do
+        alias_method :rich_textarea_tag, :koi_rich_textarea_tag
+        alias_method :rich_text_area_tag, :koi_rich_textarea_tag
+      end
+
+      ::ActionView::Helpers::FormHelper.module_eval do
+        alias_method :rich_textarea, :koi_rich_textarea
+        alias_method :rich_text_area, :koi_rich_textarea
+      end
+
+      ::ActionView::Helpers::FormBuilder.module_eval do
+        alias_method :rich_textarea, :koi_rich_textarea
+        alias_method :rich_text_area, :koi_rich_textarea
+      end
+
+      ::ActionView::Helpers::Tags::ActionText.module_eval do
+        alias_method :render, :koi_render
+      end
+    end
+    module_function :override_action_text_defaults
+  end
+end

data/lib/koi/config.rb

@@ -4,7 +4,8 @@ require "active_support/core_ext/numeric"
 
 module Koi
   class Config
-    attr_accessor :admin_name,
+    attr_accessor :action_text_editor,
+                  :admin_name,
                   :authenticate_local_admins,
                   :resource_name_candidates,
                   :admin_stylesheet,
@@ -16,6 +17,7 @@ module Koi
                   :site_name
 
     def initialize
+      @action_text_editor           = nil
       @admin_name                   = "Koi"
       @authenticate_local_admins    = Rails.env.development?
       @resource_name_candidates     = %i[title name]

data/lib/koi/engine.rb

@@ -5,6 +5,7 @@ require "katalyst/content"
 require "katalyst-govuk-formbuilder"
 require "katalyst/navigation"
 require "katalyst/tables"
+require "lexxy"
 require "pagy"
 require "rotp"
 require "rqrcode"
@@ -39,6 +40,28 @@ module Koi
       end
     end
 
+    # Rails 8.0/8.1 shim for allowing flipper swapping between lexxy/trix
+    # Rails 8.2 will introduce action_text.editors, not yet implemented.
+    initializer "koi.actiontext.initialize", after: "lexxy.initialize" do |app|
+      # disable lexxy injection in favour of Koi injection
+      app.config.lexxy.override_action_text_defaults = false
+
+      # Capture ActionText defaults (trix) once
+      ActionText.capture_action_text_defaults
+
+      # Based on Lexxy::Engine's 'lexxy.initialize'
+      app.config.to_prepare do
+        ::ActionText::TagHelper.prepend(ActionText::TagHelper)
+        ::ActionView::Helpers::FormHelper.prepend(ActionText::FormHelper)
+        ::ActionView::Helpers::FormBuilder.prepend(ActionText::FormBuilder)
+        ::ActionView::Helpers::Tags::ActionText.prepend(ActionText::ActionTextTag)
+
+        # Install Koi's stubs.
+        # In Rails 8.2 this should be replaced by action_text.editors
+        ActionText.override_action_text_defaults
+      end
+    end
+
     initializer "koi.content" do
       Katalyst::Content.config.base_controller  = "Admin::ApplicationController"
       Katalyst::Content.config.errors_component = "Koi::Content::Editor::ErrorsComponent"

data/lib/koi/form/builder.rb

@@ -5,17 +5,15 @@ module Koi
     module Builder
       extend ActiveSupport::Concern
 
-      included do
-        delegate_missing_to :@template
-      end
-
       # Generates a submit button for saving admin resources.
+      # @deprecated will be removed in Koi 6.0
       def admin_save(text = "Save", name: :commit, value: :save, class: "button", **)
         button(text, name:, value:, class:, **)
       end
 
       # Generates a delete link formatted as a button that will perform a turbo
       # delete with a confirmation.
+      # @deprecated will be removed in Koi 6.0
       def admin_delete(text = "Delete", url: nil, confirm: "Are you sure?", data: {}, **)
         return unless object.persisted?
 
@@ -27,12 +25,14 @@ module Koi
 
       # Generates an archive link formatted as a button that will perform a turbo
       # delete with a confirmation.
+      # @deprecated will be removed in Koi 6.0
       def admin_archive(text = "Archive", **)
         admin_delete(text, **)
       end
 
       # Generates a discard changes link formatted as a text button that navigates
       # the user back to the previous page.
+      # @deprecated will be removed in Koi 6.0
       def admin_discard(text = "Discard", url: :back, **)
         link_to(text, url, class: "button", data: { text_button: "" }, **)
       end
@@ -59,16 +59,31 @@ module Koi
         super
       end
 
-      # Use content editor trix setup by default.
+      using Katalyst::HtmlAttributes::HasHtmlAttributes
+
+      # Use Koi's admin direct uploads URL.
+      #
+      # @api internal
+      # @see Lexxy::FormBuilder#lexxy_rich_textarea
+      def lexxy_rich_textarea(attribute_name, **attributes, &)
+        attributes = {
+          class: "lexxy-content",
+          data:  { direct_upload_url: @template.admin_direct_uploads_url },
+        }.merge_html(**attributes)
+
+        super
+      end
+
+      # Use Koi's admin direct uploads URL.
       #
       # @api internal
-      # @see GOVUKDesignSystemFormBuilder::Builder#govuk_rich_text_area
-      def govuk_rich_text_area(attribute_name, data: {}, **, &)
-        data = data.reverse_merge(
-          direct_upload_url: @template.katalyst_content.direct_uploads_url,
-          controller:        "content--editor--trix",
-          action:            "trix-initialize->content--editor--trix#trixInitialize",
-        )
+      # @see Koi::ActionText::FormBuilder#trix_rich_textarea
+      def trix_rich_textarea(attribute_name, **attributes, &)
+        attributes = {
+          class: "trix-content",
+          data:  { direct_upload_url: @template.admin_direct_uploads_url },
+        }.merge_html(**attributes)
+
         super
       end
     end

data/lib/koi/form_builder.rb

@@ -4,5 +4,7 @@ module Koi
   class FormBuilder < ActionView::Helpers::FormBuilder
     include GOVUKDesignSystemFormBuilder::Builder
     include Koi::Form::Builder
+
+    delegate :content_tag, :tag, :safe_join, :link_to, :capture, to: :@template
   end
 end

data/lib/koi/menu.rb

@@ -27,14 +27,18 @@ module Koi
       builder.add_menu(title: "Advanced") do |b|
         b.add_items(advanced)
 
+        # @deprecated use /admin/feature_flags instead, remove in 6.0
         if Object.const_defined?("Flipper::UI")
           b.add_link(title:  "Flipper", url: context.main_app.admin_root_path.concat("/flipper"),
                      target: :blank)
         end
+
+        # @deprecated superseded by /admin/background_jobs for Solid Queue apps, remove in 6.0
         if Object.const_defined?("Sidekiq::Web")
           b.add_link(title:  "Sidekiq", url: context.main_app.admin_root_path.concat("sidekiq"),
                      target: :blank)
         end
+
         b.add_button(title:       "Clear cache", url: context.main_app.admin_cache_path,
                      http_method: :delete)
       end

data/lib/koi.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
 
 module Koi
-  extend self
+  class << self
+    def config
+      @config ||= Config.new
+    end
 
-  def config
-    @config ||= Config.new
-  end
+    def configure
+      yield config
+    end
+
+    def action_text_editor
+      return config.action_text_editor if config.action_text_editor.present?
 
-  def configure
-    yield config
+      defined?(::Lexxy) && defined?(::Flipper) && Flipper.enabled?(:lexxy, Koi::Current.admin_user) ? :lexxy : :trix
+    end
   end
 end