flightdeck 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ca85b84ff8de470263e67d8ea54f382fb0223fa0c6dc515cf24381ba9a5fb5
-  data.tar.gz: 4a2f5f4f4c9397ce405997d26881131793c425963e956d056ed92baacdde523b
+  metadata.gz: cc0fbbb0dc81b9ebb46acbf4ffd958dad391b164adc7baebd3130bfa28ca7d53
+  data.tar.gz: d52f430ba7a8c3339fc40b4da463ac26ab024da7bcde764b359e978866eae4ef
 SHA512:
-  metadata.gz: 598821a4f92376bde89e2559bc9925f3f1450cfdf28ccc6c86e37aa7f97cef357d154f2cb2e9efc9e42acbc125cb970542d086e1a3f6f485113ecd5412ca85de
-  data.tar.gz: 438cad3e80e881b0622d4969a56ed9f740665e5794dfc0807ec1252b82e918269cd35d69561895102c767a07a3d9c8d57ff442d64daed9183c0d1790ab3a60ce
+  metadata.gz: 5f59a6371351b03d69176c8dd80fcd14d9b0b009189895b42d1926972d7c3d7353d9452f411f590d217c035e1143a6b2b704619cba8319d697167b28a6ac274e
+  data.tar.gz: 50ae1e3d7c0a1a8d0489e12f14f22eb0abe1c7d7fde0a9e6ee9a8290bc3ff27c71ced755997f0eee40f1151667c07e8f1b55e587f5f6aae85ffef5e862258980

data/README.md

@@ -103,12 +103,28 @@ request, never memoized at boot.
 In **API-only** apps there is no host session for Devise to use, so use
 Flightdeck's own HTTP Basic there.
 
+### Disabling authentication entirely
+
+```ruby
+# config/initializers/flightdeck.rb
+Flightdeck.configure do |config|
+  config.skip_authentication = true
+end
+```
+
+This serves the dashboard — which can retry, discard and delete jobs — to
+anyone who can reach the mount. It exists for deployments where something
+upstream already guards it: a routing constraint, a VPN, a reverse proxy. The
+routing-constraint caveat above still applies unless you set this: without it,
+the engine answers 401 behind your constraint.
+
 ## Configuration
 
 | Option | Default | Purpose |
 | --- | --- | --- |
 | `base_controller_class` | `nil` | Controller (a String) to inherit from, to reuse your app's authentication. |
 | `http_basic` | `nil` | `{ username:, password: }` or a callable. Falls back to `ENV`, then credentials. |
+| `skip_authentication` | `false` | Serve without any authentication. For mounts guarded upstream (routing constraint, VPN, proxy). |
 | `poll_interval` | `5.seconds` | Refresh rate for list and stat panels. |
 | `chart_poll_interval` | `30.seconds` | Refresh rate for charts. |
 | `per_page` | `25` | Rows per page in job lists. |

data/app/assets/flightdeck/{flightdeck-c02e38040ddb.js → flightdeck-747ab6d1a6fa.js}

@@ -1,4 +1,4 @@
-/* Flightdeck 0.5.0 — bundled @hotwired/turbo + @hotwired/stimulus. Generated by `rake assets:build`; do not edit. */
+/* Flightdeck 0.5.2 — bundled @hotwired/turbo + @hotwired/stimulus. Generated by `rake assets:build`; do not edit. */
 (function(){
 /**
  * Minified by jsDelivr using Terser v5.39.0.
@@ -408,7 +408,7 @@ class ToastController extends Stimulus.Controller {
   application.register("theme", ThemeController)
   application.register("toast", ToastController)
 
-  window.Flightdeck = { application: application, version: "0.5.0" }
+  window.Flightdeck = { application: application, version: "0.5.2" }
 })()
 
 })();

data/app/assets/flightdeck/manifest.json

@@ -7,9 +7,9 @@
     "size": 118411
   },
   "flightdeck.js": {
-    "file": "flightdeck-c02e38040ddb.js",
-    "digest": "c02e38040ddb",
-    "sha256": "c02e38040ddb22871c1cb96daa7cb78242ceda0dd243c1ab3678fcf6f022d73e",
+    "file": "flightdeck-747ab6d1a6fa.js",
+    "digest": "747ab6d1a6fa",
+    "sha256": "747ab6d1a6fafd8eb6ff4eca9f487ad62a11fdb0df52e8293db0d2699a575dcd",
     "content_type": "text/javascript; charset=utf-8",
     "size": 150889
   }

data/app/controllers/flightdeck/application_controller.rb

@@ -33,7 +33,16 @@ module Flightdeck
              config.base_controller_class = "Admin::BaseController"
            end
 
-      Flightdeck never serves unauthenticated requests, in any environment.
+      5. If something upstream (a routing constraint, VPN, or reverse proxy)
+         already guards this mount and you accept the risk, turn Flightdeck's
+         gate off entirely:
+
+           Flightdeck.configure do |config|
+             config.skip_authentication = true
+           end
+
+      Flightdeck never serves unauthenticated requests, in any environment,
+      unless it is explicitly told to with skip_authentication.
     TEXT
 
     protect_from_forgery with: :exception if respond_to?(:protect_from_forgery)
@@ -73,7 +82,12 @@ module Flightdeck
         }.compact
       end
 
+      # Read per request, like the rest of the auth config, so nothing is
+      # resolved at boot. `skip_authentication` is the explicit opt-out for
+      # deployments that gate the mount upstream — a routing constraint, a VPN,
+      # a reverse proxy — and it wins over every other setting here.
       def authenticate_flightdeck!
+        return if Flightdeck.config.skip_authentication
         return if self.class.host_authenticated?
 
         credentials = Flightdeck.config.resolve_http_basic

data/app/helpers/flightdeck/application_helper.rb

@@ -9,7 +9,7 @@ module Flightdeck
       digested = Flightdeck::Assets.digested_name(logical_name)
       return nil unless digested
 
-      flightdeck.asset_file_path(name: digested)
+      asset_file_path(name: digested)
     end
 
     # Sidebar counts are capped like every other count, and degrade to "—"

data/app/views/layouts/flightdeck/application.html.erb

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title><%= content_for?(:title) ? yield(:title) : "Flightdeck" %></title>
-    <meta name="turbo-root" content="<%= flightdeck.root_path %>">
+    <meta name="turbo-root" content="<%= root_path %>">
     <%= csrf_meta_tags %>
     <% if (css = flightdeck_asset_path("flightdeck.css")) %>
       <link rel="stylesheet" href="<%= css %>">
@@ -22,36 +22,36 @@
         </div>
 
         <nav class="fd-nav">
-          <%= link_to flightdeck.root_path, class: "fd-nav-link#{" on" if current_page?(flightdeck.root_path)}" do %>
+          <%= link_to root_path, class: "fd-nav-link#{" on" if current_page?(root_path)}" do %>
             <svg width="15" height="15" viewBox="0 0 15 15" fill="none" stroke="currentColor" stroke-width="1.4"><path d="M1.5 13.5v-5h3v5m1.5 0v-9h3v9m1.5 0v-12h3v12" stroke-linejoin="round"/></svg>
             Overview
           <% end %>
 
           <span class="fd-nav-section">Jobs</span>
 
-          <%= link_to flightdeck.jobs_path, class: "fd-nav-link#{" on" if fd_nav_active?(:all)}" do %>
+          <%= link_to jobs_path, class: "fd-nav-link#{" on" if fd_nav_active?(:all)}" do %>
             <svg width="15" height="15" viewBox="0 0 15 15" fill="none" stroke="currentColor" stroke-width="1.4"><rect x="1.5" y="2.5" width="12" height="10" rx="1.5"/><path d="M4.5 6h6M4.5 9h4"/></svg>
             All jobs <span class="fd-nav-count"><%= fd_nav_count(:all) %></span>
           <% end %>
 
-          <%= link_to flightdeck.jobs_path(state: :failed), class: "fd-nav-link#{" on" if fd_nav_active?(:failed)}" do %>
+          <%= link_to jobs_path(state: :failed), class: "fd-nav-link#{" on" if fd_nav_active?(:failed)}" do %>
             <svg width="15" height="15" viewBox="0 0 15 15" fill="none" stroke="currentColor" stroke-width="1.4"><circle cx="7.5" cy="7.5" r="6"/><path d="M7.5 4.5v3.5M7.5 10.4v.2"/></svg>
             Failed <span class="fd-nav-count"><%= fd_nav_count(:failed) %></span>
           <% end %>
 
           <span class="fd-nav-section">Infrastructure</span>
 
-          <%= link_to flightdeck.queues_path, class: "fd-nav-link#{" on" if controller_name == "queues"}" do %>
+          <%= link_to queues_path, class: "fd-nav-link#{" on" if controller_name == "queues"}" do %>
             <svg width="15" height="15" viewBox="0 0 15 15" fill="none" stroke="currentColor" stroke-width="1.4"><path d="M2 4h11M2 7.5h11M2 11h7"/></svg>
             Queues <span class="fd-nav-count"><%= fd_nav_queue_count %></span>
           <% end %>
 
-          <%= link_to flightdeck.processes_path, class: "fd-nav-link#{" on" if controller_name == "processes"}" do %>
+          <%= link_to processes_path, class: "fd-nav-link#{" on" if controller_name == "processes"}" do %>
             <svg width="15" height="15" viewBox="0 0 15 15" fill="none" stroke="currentColor" stroke-width="1.4"><rect x="2" y="2" width="11" height="7" rx="1.5"/><path d="M5 13h5M7.5 9v4"/></svg>
             Processes <span class="fd-nav-count <%= "alert" if fd_nav_any_dead_processes? %>"><%= fd_nav_process_count %></span>
           <% end %>
 
-          <%= link_to flightdeck.recurring_tasks_path, class: "fd-nav-link#{" on" if controller_name == "recurring_tasks"}" do %>
+          <%= link_to recurring_tasks_path, class: "fd-nav-link#{" on" if controller_name == "recurring_tasks"}" do %>
             <svg width="15" height="15" viewBox="0 0 15 15" fill="none" stroke="currentColor" stroke-width="1.4"><circle cx="7.5" cy="7.5" r="6"/><path d="M7.5 4v3.5l2.5 1.5"/></svg>
             Recurring <span class="fd-nav-count"><%= fd_nav_recurring_count %></span>
           <% end %>

data/lib/flightdeck/configuration.rb

@@ -4,6 +4,7 @@ module Flightdeck
   class Configuration
     attr_accessor :base_controller_class,
                   :http_basic,
+                  :skip_authentication,
                   :poll_interval,
                   :chart_poll_interval,
                   :per_page,
@@ -16,6 +17,7 @@ module Flightdeck
     def initialize
       @base_controller_class = nil
       @http_basic = nil
+      @skip_authentication = false
       @poll_interval = 5.seconds
       @chart_poll_interval = 30.seconds
       @per_page = 25

data/lib/flightdeck/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flightdeck
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Carl Mercier
@@ -49,7 +49,7 @@ files:
 - MIT-LICENSE
 - README.md
 - app/assets/flightdeck/flightdeck-00403457c5d9.css
-- app/assets/flightdeck/flightdeck-c02e38040ddb.js
+- app/assets/flightdeck/flightdeck-747ab6d1a6fa.js
 - app/assets/flightdeck/manifest.json
 - app/controllers/concerns/flightdeck/toasts.rb
 - app/controllers/flightdeck/application_controller.rb