flightdeck 0.5.0

data/lib/flightdeck/assets.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "json"
+require "pathname"
+
+module Flightdeck
+  # In-memory view of the precompiled asset manifest committed under
+  # app/assets/flightdeck/. Loaded lazily and memoized: the gem must boot
+  # cleanly in a checkout where `rake assets:build` has not run yet.
+  module Assets
+    CONTENT_TYPES = {
+      ".css" => "text/css; charset=utf-8",
+      ".js" => "text/javascript; charset=utf-8"
+    }.freeze
+
+    LOGICAL_NAMES = %w[flightdeck.css flightdeck.js].freeze
+
+    class << self
+      def root
+        @root ||= Pathname.new(File.expand_path("../../app/assets/flightdeck", __dir__))
+      end
+
+      def manifest
+        return @manifest if defined?(@manifest) && @manifest
+
+        @manifest = load_manifest
+      end
+
+      # Reverse index: digested filename => entry. The only lookup the
+      # controller performs, so a request can never name a file we did not
+      # build.
+      def by_digested_name
+        @by_digested_name ||= manifest.each_with_object({}) do |(logical, entry), index|
+          index[entry["file"]] = entry.merge("logical" => logical)
+        end.freeze
+      end
+
+      def digested_name(logical)
+        entry = manifest[logical.to_s]
+        entry && entry["file"]
+      end
+
+      def find(digested_name)
+        by_digested_name[digested_name.to_s]
+      end
+
+      def read(digested_name)
+        entry = find(digested_name)
+        return nil unless entry
+
+        path = root.join(entry["file"])
+        return nil unless path.file?
+
+        path.binread
+      end
+
+      def content_type_for(file)
+        CONTENT_TYPES.fetch(File.extname(file), "application/octet-stream")
+      end
+
+      def reload!
+        remove_instance_variable(:@manifest) if defined?(@manifest)
+        remove_instance_variable(:@by_digested_name) if defined?(@by_digested_name)
+        manifest
+      end
+
+      private
+        def load_manifest
+          path = root.join("manifest.json")
+          return {} unless path.file?
+
+          JSON.parse(path.read).freeze
+        rescue JSON::ParserError
+          {}
+        end
+    end
+  end
+end

data/lib/flightdeck/configuration.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Flightdeck
+  class Configuration
+    attr_accessor :base_controller_class,
+                  :http_basic,
+                  :poll_interval,
+                  :chart_poll_interval,
+                  :per_page,
+                  :count_cap,
+                  :bulk_action_limit,
+                  :chart_cache_ttl,
+                  :display_timezone,
+                  :backtrace_lines
+
+    def initialize
+      @base_controller_class = nil
+      @http_basic = nil
+      @poll_interval = 5.seconds
+      @chart_poll_interval = 30.seconds
+      @per_page = 25
+      @count_cap = 500_000
+      @bulk_action_limit = 1_000
+      @chart_cache_ttl = 30.seconds
+      @display_timezone = "UTC"
+      @backtrace_lines = 50
+    end
+
+    # Resolved fresh on every call so that credentials rotated in the
+    # environment (or in Rails credentials) take effect without a restart,
+    # and so that nothing touches Rails.application.credentials at boot.
+    #
+    # Returns a { username:, password: } hash, or nil when unconfigured.
+    def resolve_http_basic
+      from_explicit || from_env || from_credentials
+    end
+
+    private
+      def from_explicit
+        normalize(http_basic)
+      end
+
+      def from_env
+        normalize(username: ENV["FLIGHTDECK_USERNAME"], password: ENV["FLIGHTDECK_PASSWORD"])
+      end
+
+      def from_credentials
+        return nil unless defined?(Rails) && Rails.application
+
+        normalize(Rails.application.credentials.flightdeck)
+      rescue StandardError
+        nil
+      end
+
+      def normalize(source)
+        return nil if source.nil?
+
+        source = source.call if source.respond_to?(:call)
+        return nil if source.nil?
+
+        username = fetch(source, :username)
+        password = fetch(source, :password)
+        return nil if username.nil? || password.nil?
+
+        username = username.to_s
+        password = password.to_s
+        return nil if username.empty? || password.empty?
+
+        { username: username, password: password }
+      end
+
+      def fetch(source, key)
+        if source.respond_to?(:[])
+          source[key] || source[key.to_s]
+        elsif source.respond_to?(key)
+          source.public_send(key)
+        end
+      end
+  end
+end

data/lib/flightdeck/engine.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "solid_queue"
+
+module Flightdeck
+  class Engine < ::Rails::Engine
+    isolate_namespace Flightdeck
+
+    # Engine-local middleware: wraps only requests routed into the mount, so
+    # Flightdeck has cookies, a session and flash even when the host app is
+    # `config.api_only = true` and carries none of them.
+    middleware.use ActionDispatch::Cookies
+    middleware.use ActionDispatch::Session::CookieStore,
+                   key: "_flightdeck_session",
+                   same_site: :lax,
+                   httponly: true
+    middleware.use ActionDispatch::Flash
+
+    config.flightdeck = Flightdeck.config
+
+    # Flightdeck speaks Turbo Streams but does not depend on turbo-rails: the
+    # engine ships its own Turbo build. Registering the type is all the server
+    # side actually needs, and the host may well have registered it already.
+    initializer "flightdeck.mime_types" do
+      Mime::Type.register "text/vnd.turbo-stream.html", :turbo_stream unless Mime[:turbo_stream]
+    end
+  end
+end

data/lib/flightdeck/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Flightdeck
+  VERSION = "0.5.0"
+end

data/lib/flightdeck.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/numeric/time"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/inflections"
+
+require "flightdeck/version"
+require "flightdeck/configuration"
+require "flightdeck/assets"
+
+module Flightdeck
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    # Resolved at controller-definition time. Zeitwerk loads the engine's
+    # controllers lazily, so host configuration set in an initializer wins.
+    def base_controller_class
+      name = config.base_controller_class
+      name.presence ? name.to_s.constantize : ActionController::Base
+    end
+  end
+end
+
+require "flightdeck/engine"

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: flightdeck
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Carl Mercier
+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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Flightdeck is a mountable Rails engine that gives Solid Queue a fast,
+  polished dashboard: jobs, failures, queues, processes, recurring tasks and live
+  charts. Works in API-only hosts and ships its own precompiled assets.'
+email:
+- carl@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/assets/flightdeck/flightdeck-00403457c5d9.css
+- app/assets/flightdeck/flightdeck-c02e38040ddb.js
+- app/assets/flightdeck/manifest.json
+- app/controllers/concerns/flightdeck/toasts.rb
+- app/controllers/flightdeck/application_controller.rb
+- app/controllers/flightdeck/assets_controller.rb
+- app/controllers/flightdeck/jobs/actions_controller.rb
+- app/controllers/flightdeck/jobs/discards_controller.rb
+- app/controllers/flightdeck/jobs/retries_controller.rb
+- app/controllers/flightdeck/jobs_controller.rb
+- app/controllers/flightdeck/overview_controller.rb
+- app/controllers/flightdeck/processes_controller.rb
+- app/controllers/flightdeck/queues_controller.rb
+- app/controllers/flightdeck/recurring_tasks_controller.rb
+- app/helpers/flightdeck/application_helper.rb
+- app/helpers/flightdeck/infrastructure_helper.rb
+- app/helpers/flightdeck/jobs_helper.rb
+- app/helpers/flightdeck/metrics_helper.rb
+- app/models/flightdeck/arguments_preview.rb
+- app/models/flightdeck/bulk_action.rb
+- app/models/flightdeck/cache.rb
+- app/models/flightdeck/cron_schedule.rb
+- app/models/flightdeck/error_summary.rb
+- app/models/flightdeck/grouped_failures.rb
+- app/models/flightdeck/job_detail.rb
+- app/models/flightdeck/job_row.rb
+- app/models/flightdeck/jobs_query.rb
+- app/models/flightdeck/metrics/bar_chart.rb
+- app/models/flightdeck/metrics/chart.rb
+- app/models/flightdeck/metrics/line_chart.rb
+- app/models/flightdeck/metrics/series.rb
+- app/models/flightdeck/metrics/sparkline.rb
+- app/models/flightdeck/metrics/time_bucket.rb
+- app/models/flightdeck/overview.rb
+- app/models/flightdeck/process_registry.rb
+- app/models/flightdeck/queue_stats.rb
+- app/models/flightdeck/recurring_catalog.rb
+- app/views/flightdeck/jobs/_failed_row.html.erb
+- app/views/flightdeck/jobs/_filter_bar.html.erb
+- app/views/flightdeck/jobs/_list.html.erb
+- app/views/flightdeck/jobs/_pager.html.erb
+- app/views/flightdeck/jobs/_row.html.erb
+- app/views/flightdeck/jobs/_state_tabs.html.erb
+- app/views/flightdeck/jobs/actions/create.turbo_stream.erb
+- app/views/flightdeck/jobs/index.html.erb
+- app/views/flightdeck/jobs/show.html.erb
+- app/views/flightdeck/metrics/_bar_chart.html.erb
+- app/views/flightdeck/metrics/_line_chart.html.erb
+- app/views/flightdeck/metrics/_range_control.html.erb
+- app/views/flightdeck/metrics/_sparkline.html.erb
+- app/views/flightdeck/overview/_completion.html.erb
+- app/views/flightdeck/overview/_failures.html.erb
+- app/views/flightdeck/overview/_fleet.html.erb
+- app/views/flightdeck/overview/_queues.html.erb
+- app/views/flightdeck/overview/_throughput.html.erb
+- app/views/flightdeck/overview/_tiles.html.erb
+- app/views/flightdeck/overview/index.html.erb
+- app/views/flightdeck/processes/_fleet.html.erb
+- app/views/flightdeck/processes/_row.html.erb
+- app/views/flightdeck/processes/index.html.erb
+- app/views/flightdeck/processes/prune.turbo_stream.erb
+- app/views/flightdeck/queues/_cards.html.erb
+- app/views/flightdeck/queues/index.html.erb
+- app/views/flightdeck/queues/update.turbo_stream.erb
+- app/views/flightdeck/recurring_tasks/_table.html.erb
+- app/views/flightdeck/recurring_tasks/index.html.erb
+- app/views/flightdeck/recurring_tasks/run.turbo_stream.erb
+- app/views/flightdeck/shared/_toast.html.erb
+- app/views/layouts/flightdeck/application.html.erb
+- config/routes.rb
+- lib/flightdeck.rb
+- lib/flightdeck/assets.rb
+- lib/flightdeck/configuration.rb
+- lib/flightdeck/engine.rb
+- lib/flightdeck/version.rb
+homepage: https://github.com/cmer/solid_queue-flightdeck
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cmer/solid_queue-flightdeck
+  source_code_uri: https://github.com/cmer/solid_queue-flightdeck
+  changelog_uri: https://github.com/cmer/solid_queue-flightdeck/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: A beautiful, featureful dashboard for Solid Queue.
+test_files: []