flightdeck 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eceb3b8e057fc9c676f440e010d2c8944cf473603a2ef4acae924a270d80ed1
-  data.tar.gz: 3d40bf9079006d5c151a75496d9b70ebfff0c65536fcf05e84f31d78310f1be7
+  metadata.gz: 2da4d1e0df45cf87a2169a34d48f3e0f73f0a1cd841ee9bf811c97bf9b063e7d
+  data.tar.gz: a718fd3e9b4a41a59761eacc568ed8398976d53432271063c46bb151568099fa
 SHA512:
-  metadata.gz: 9f124a789e06b201f3783cb75adfbebb1327c0cd99f16d5557d3091e56413e85225fb1d8529cfa0df955ac6ba551bf918e1f74cbde3643a9e41a12b59d9680b7
-  data.tar.gz: 57d1acf75ad7ece585b994f95162a545f1010e8eeaafbbb2702e9dc81c1d445825953625fdcbe916588813108fa21c057ae7b4fc0f90686333d652e277fca7b7
+  metadata.gz: 12000285bbcba3858d2217cfb05949718ab71b54f907a34e191dcffb831c2ba23811b2e5b274c9447b18cce3792f5c7266b24dd69b19bf73839db8c562af7a67
+  data.tar.gz: 6070f0e1c197fdb0c8d2dfb10e62793ad1179d3dfaa34ab04c787ef5b79335d429c703ee944fc5c1c228b077fd6341bcb702809ea0389b804db219ca6afd3422

data/README.md

@@ -1,206 +1,15 @@
-# Flightdeck
+# flightdeck → solid_queue-flightdeck
 
-A dashboard for [Solid Queue](https://github.com/rails/solid_queue) that is
-pleasant to look at and actually operational. Where Mission Control gives you
-lists, Flightdeck gives you a console: live-polling panels, throughput and
-completion-time charts computed straight from the Solid Queue tables, failure
-triage with grouping and bulk retry, queue pause/resume, fleet health with
-heartbeat detection, and recurring-task control. It ships precompiled assets
-(no pipeline configuration), works in API-only apps, mounts anywhere, and
-refuses to serve a single unauthenticated request.
+This gem has been renamed to
+[`solid_queue-flightdeck`](https://rubygems.org/gems/solid_queue-flightdeck).
 
-![Overview, dark](docs/screenshots/overview-dark.png)
-![Overview, light](docs/screenshots/overview-light.png)
-
-<details>
-<summary><strong>More screenshots</strong> — failed jobs, job detail, queues, processes</summary>
-
-![Failed jobs](docs/screenshots/jobs-failed-dark.png)
-![Job detail](docs/screenshots/job-detail-dark.png)
-![Queues](docs/screenshots/queues-dark.png)
-![Processes](docs/screenshots/processes-dark.png)
-
-</details>
-
-## Installation
-
-```ruby
-# Gemfile
-gem "flightdeck"
-```
-
-No migrations, no asset configuration. Requires Ruby >= 3.1, Rails >= 7.1 and
-Solid Queue >= 1.0.
-
-## Mounting
-
-```ruby
-# config/routes.rb
-mount Flightdeck::Engine => "/flightdeck"
-```
-
-Any path works, including nested ones — every URL Flightdeck emits comes from
-the request's own script name. Nested mounts have their own test suite.
-
-## Authentication
-
-**Flightdeck returns 401 until you configure it, in every environment.** It can
-retry, discard and delete jobs, so there is no default that lets anyone in.
-
-### Behind your app's own authentication (recommended)
-
-The usual shape — gate the route with Devise, and hand Flightdeck the same base
-controller your other admin pages use:
-
-```ruby
-# config/routes.rb
-authenticated :user, lambda { |u| u.admin? } do
-  namespace :admin do
-    root to: "dashboard#index"
-    mount Flightdeck::Engine, at: "/jobs"
-  end
-end
-```
-
-```ruby
-# config/initializers/flightdeck.rb
-Flightdeck.configure do |config|
-  config.base_controller_class = "Admin::BaseController"
-end
-```
-
-> **The routing constraint alone is not enough.** Flightdeck does not inspect
-> your routes; it refuses to serve until it is told how to authenticate. Setting
-> `base_controller_class` makes your controller's `before_action`s Flightdeck's
-> gate and skips its own challenge entirely. Without it, the engine still
-> answers 401 behind the constraint.
-
-### HTTP Basic
-
-For apps without such a base controller. Any one of these is enough:
-
-```bash
-FLIGHTDECK_USERNAME=admin FLIGHTDECK_PASSWORD=a-long-secret
-```
-
-```yaml
-# bin/rails credentials:edit
-flightdeck:
-  username: admin
-  password: a-long-secret
-```
-
-```ruby
-Flightdeck.configure do |config|
-  config.http_basic = { username: "admin", password: "a-long-secret" }
-end
-```
-
-`http_basic` also accepts a callable, re-evaluated per request, for rotating
-credentials. Credentials are compared with `secure_compare` and read per
-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. |
-| `count_cap` | `500_000` | Counting stops here; rendered as `500,000+`. |
-| `bulk_action_limit` | `1_000` | Cap on jobs touched by one bulk retry/discard. |
-| `chart_cache_ttl` | `30.seconds` | How long chart series are cached. |
-| `display_timezone` | `"UTC"` | Timezone for displayed timestamps. Queries stay in UTC. |
-| `backtrace_lines` | `50` | Backtrace frames shown on job detail. |
-
-## Chart history and job retention
-
-Flightdeck adds no tables and changes no retention: charts read Solid Queue's
-own rows, so history is bounded by your app's Solid Queue purge setting.
-Finished jobs are deleted after `clear_finished_jobs_after` — **1 day by
-default** — which leaves a 7-day throughput chart mostly empty. To keep charts
-honest for the windows you care about, raise it to at least the longest window:
+This final `flightdeck` version is an empty shell that depends on the new gem,
+so existing Gemfiles keep working. Update yours:
 
 ```ruby
-# config/application.rb (or an environment file)
-config.solid_queue.clear_finished_jobs_after = 14.days
-```
-
-The cost is `solid_queue_jobs` table size — retention × throughput (100k
-jobs/day × 14 days ≈ 1.4M rows). Flightdeck's chart queries are windowed and
-index-backed, and counts are capped, so the dashboard stays fast at that size.
-Failed jobs are unaffected: Solid Queue never purges them automatically.
-
-## API-only apps
-
-Works unchanged. Flightdeck carries its own cookies, session
-(`_flightdeck_session`) and flash as engine-local middleware wrapping only its
-own routes — your middleware stack is untouched. The whole suite runs a second
-time in API-only mode.
-
-## Solid Queue on a separate database
-
-Nothing to configure. Every query goes through `SolidQueue::Record` and the
-Solid Queue models, so your `connects_to` routing applies automatically.
-Flightdeck never joins your application's tables and never touches the database
-at boot — it mounts cleanly even when the queue database is unreachable.
-
-## Development
-
-```bash
-bin/demo                       # schema + seeds + server, auth off, on :3000
-bin/test                       # asset freshness + both host modes
-bundle exec rake test          # fast suite
-bundle exec rake test:system   # headless Chrome (skipped if none installed)
-bundle exec rake screenshots   # regenerate docs/screenshots
-bundle exec rake assets:build  # rebuild CSS/JS
-bundle exec rubocop
-bin/release                    # full release: verify, push, wait for CI, tag, gem push (--dry-run to rehearse)
+gem "solid_queue-flightdeck"
 ```
 
-Assets are committed, digest-named files under `app/assets/flightdeck/`, built
-from `assets-src/`. Tailwind scans `app/`, so **re-run `rake assets:build` and
-commit the result after changing a view** — CI fails on stale assets.
-
-CI runs the suite against SQLite, PostgreSQL and MySQL (via `DATABASE_URL`),
-each in normal and API-only mode. The database axis exists to protect
-`Flightdeck::Metrics::TimeBucket`, the only adapter-specific SQL in the gem.
-
-## Known limitations
-
-- **Long charts undercount.** Solid Queue's `clear_finished_jobs_after` defaults
-  to 1 day, so a 7-day throughput chart is missing purged jobs. Flightdeck
-  annotates the chart rather than drawing the cliff as a trend. See
-  [Chart history and job retention](#chart-history-and-job-retention) for the
-  one-line fix.
-- **No historical time-to-start.** The claimed-execution row is deleted when a
-  job finishes, so how long a finished job waited is unrecoverable. The chart
-  shows time to *completion* and says so.
-- **Counts are capped** at `count_cap` and render as `500,000+`.
-- **Bulk actions are capped** at `bulk_action_limit` or 10 seconds, committing
-  per batch, then offer to continue.
-
-## License
+The mount point, configuration and `Flightdeck` module are unchanged.
 
-MIT. See [MIT-LICENSE](MIT-LICENSE).
+Source: https://github.com/cmer/solid_queue-flightdeck

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flightdeck
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Carl Mercier
@@ -10,117 +10,29 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: solid_queue-flightdeck
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 0.6.0
   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.'
+        version: 0.6.0
+description: The flightdeck gem has been renamed to solid_queue-flightdeck. This version
+  only depends on the new gem so existing Gemfiles keep working. Please update your
+  Gemfile to gem "solid_queue-flightdeck".
 email:
 - carl@carlmercier.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
-- app/assets/flightdeck/flightdeck-3967b9e6c506.css
-- app/assets/flightdeck/flightdeck-3aac23f80afe.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/duration.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/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/queues/_cards.html.erb
-- app/views/flightdeck/queues/index.html.erb
-- app/views/flightdeck/recurring_tasks/_table.html.erb
-- app/views/flightdeck/recurring_tasks/index.html.erb
-- app/views/flightdeck/shared/_toast.html.erb
-- app/views/flightdeck/shared/refresh.turbo_stream.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
@@ -128,6 +40,10 @@ 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
+post_install_message: |
+  The flightdeck gem has been renamed to solid_queue-flightdeck.
+  Update your Gemfile:  gem "solid_queue-flightdeck"
+  Everything else (mount point, configuration, Flightdeck module) is unchanged.
 rdoc_options: []
 require_paths:
 - lib
@@ -144,5 +60,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: A beautiful, featureful dashboard for Solid Queue.
+summary: 'Renamed: use solid_queue-flightdeck instead.'
 test_files: []

data/MIT-LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Carl Mercier
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.