upright 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccb561e794bdafa5e31caed2347f7d371d02e5230ca875c5f507d1d0620d7363
-  data.tar.gz: 3bc20100e850cdd93a81e58b7e9b6f3ef9377c44b17bbd7891dbe697699b23a6
+  metadata.gz: c91a962bc77007bffeebba4df5da09c213a42c46a416de5fce7d19e9169258f7
+  data.tar.gz: 47b63615e16a15aede26f738a3ffc7256fada1aab09b775ff7ddd90282c91ea0
 SHA512:
-  metadata.gz: 474970b3ccbce05a396ceb2a3575a58272b602d679cf70d55d10538cc546aa31d6142e1de401ee5098c6c3a2733a624cba54e34b79a0dcd9c6af7ad7e8124f0d
-  data.tar.gz: 35ed0971379b1c50dd9583f95ed27aa2586f53002e8acd81c05851797d6f2d1c59ced8d6a08817613ecb89ab376d453a9697cf241b82be1409c11f1caa87c6d3
+  metadata.gz: 25a77e92224a4869f1da746deba9f5a4440c4a071d2e3b0c8fef363c2abd36e270cc9a1147a11081284a85f0deb8e22cc73a09d8a3dcd183ea29dd7a0419e872
+  data.tar.gz: a5e047ccb8feb9e864652496e81cdbb17ea4e0ae0972b8e380df9fa1206b011c23d5fd0b1e8bae2f366313dcb48b7af25d3babeba1f96e1211967bf70e954415

data/README.md

@@ -59,7 +59,7 @@ rails new my-upright --database=sqlite3 --skip-test
 cd my-upright
 bundle add upright
 bin/rails generate upright:install
-bin/rails db:migrate
+bin/rails db:prepare
 ```
 
 Start the server:
@@ -76,7 +76,10 @@ Visit http://app.my-upright.localhost:3000 to see your Upright instance.
 
 The `upright:install` generator creates:
 
+- `config/database.yml` - Development and test split into `primary` (probe results), `persistent` (rollups and incidents, migrated from the gem) and `queue` (Solid Queue) databases
+- `config/recurring.yml` - Probe schedules and the engine's housekeeping, health, rollup, incident and maintenance jobs
 - `config/initializers/upright.rb` - Engine configuration
+- `config/initializers/content_security_policy.rb` - Ready-to-enable CSP covering the engine's CDN dependencies
 - `config/sites.yml` - Site definitions for each VPS you host Upright on
 - `config/prometheus/prometheus.yml` - Prometheus configuration
 - `config/alertmanager/alertmanager.yml` - AlertManager configuration
@@ -122,6 +125,8 @@ shared:
       country: NL
       geohash: u17982
       provider: digitalocean
+      stores_metrics: true
+      primary: true
 
     - code: sfo
       city: San Francisco
@@ -132,14 +137,16 @@ shared:
 
 Each site node identifies itself via the `SITE_SUBDOMAIN` environment variable, configured in your Kamal deploy.yml.
 
+Two optional flags give a site a role beyond running probes: `primary` serves the app and status hostnames and runs the jobs writing the shared database, and `stores_metrics` runs a local Prometheus and Alertmanager. See [Sites and their roles](https://github.com/basecamp/upright/blob/main/docs/sites.md) for what each one changes, the health metrics every site exports, and how daily rollups read across them.
+
 ### Authentication
 
 #### Static Credentials
 
-Upright uses static credentials by default with username `admin` and password `upright`.
+Upright uses static credentials by default with username `admin` and the password taken from the `ADMIN_PASSWORD` environment variable.
 
-> [!WARNING]
-> Change the default password before deploying to production by setting the `ADMIN_PASSWORD` environment variable.
+> [!IMPORTANT]
+> There is no default password: `ADMIN_PASSWORD` must be set, and sign-in fails closed without it. Set it as a Kamal secret in production (the generated `config/deploy.yml` already lists it) and export it locally for development.
 
 
 #### OpenID Connect
@@ -197,8 +204,14 @@ class PingProbe < FrozenRecord::Base
 
   stagger_by_site 3.seconds
 
+  # Hostnames, IPv4, and IPv6 addresses only. The first character may not be
+  # a dash, so a configured host can never be mistaken for a ping flag.
+  HOST_PATTERN = /\A[a-z0-9:][a-z0-9:._-]*\z/i
+
   def check
-    @ping_output, status = Open3.capture2e("ping", "-c", "1", "-W", "5", host)
+    raise ArgumentError, "invalid ping host: #{host.inspect}" unless HOST_PATTERN.match?(host.to_s)
+
+    @ping_output, status = Open3.capture2e("ping", "-c", "1", "-W", "5", "--", host)
     status.success?
   end
 
@@ -425,6 +438,7 @@ proxy:
 env:
   secret:
     - RAILS_MASTER_KEY
+    - ADMIN_PASSWORD
   tags:
     amsterdam:
       SITE_SUBDOMAIN: ams
@@ -536,20 +550,65 @@ bin/dev
 
 Visit http://app.upright.localhost:3000 and sign in with:
 - **Username**: `admin`
-- **Password**: `upright` (or value of `ADMIN_PASSWORD` env var)
+- **Password**: the value of the `ADMIN_PASSWORD` env var, e.g. `ADMIN_PASSWORD=upright bin/dev` (a throwaway value like this is fine for local testing only — never for a deployed site)
 
 ### Testing Playwright Probes
 
 Run probes with a visible browser window:
 
 ```bash
-LOCAL_PLAYWRIGHT=1 bin/rails console
+HEADLESS=false bin/rails console
 ```
 
 ```ruby
 Probes::Playwright::MyServiceAuthProbe.check
 ```
 
+### Upgrading Playwright
+
+Playwright versions are pinned via `Upright::PLAYWRIGHT_VERSION` in `lib/upright/version.rb`. This drives the Ruby gem and npm package versions. To upgrade:
+
+1. Update `PLAYWRIGHT_VERSION` in `lib/upright/version.rb`
+2. Update the version in `package.json`
+3. Run `bin/setup` (or manually: `npm install && npx playwright install chromium`)
+4. Run `bin/rails test` to verify compatibility
+5. Commit the updated `package.json` and `package-lock.json`
+
+### Viewing Playwright Traces
+
+Upright stores a Playwright trace as a probe result artifact and does not serve
+the Playwright Trace Viewer. The viewer renders a trace's tags and attributes as
+HTML in its own origin, so serving it from Upright's hostname would let a trace
+run script against an admin session.
+
+A trace artifact links to `config.trace_viewer_url`, which defaults to
+upstream's hosted viewer at `https://trace.playwright.dev`. That viewer runs
+entirely in the browser, and being on its own registrable domain is what keeps a
+trace's contents off Upright's origin.
+
+Following the link hands that origin a URL it can read for 24 hours. Set
+`config.trace_viewer_url` to a viewer you host to keep traces to yourself, or
+assign `nil` to keep them download-only:
+
+```bash
+npx playwright show-trace trace.zip
+```
+
+A URL under `config.hostname` raises `Upright::ConfigurationError`, since that
+would put the trace back on the admin origin.
+
+That trace URL is served by `Upright::TracesController`, not Active Storage. The
+viewer fetches it from its own origin, so the request arrives without the admin
+session and needs `Access-Control-Allow-Origin` to be readable at all. The
+controller sends that header for the configured viewer's origin and nothing
+else, and takes a signed id in place of the session: scoped to a purpose,
+expiring after 24 hours, and resolvable only to a blob attached to an
+`Upright::ProbeResult` under a `.zip` filename. With no viewer configured the
+route 404s, so it exists only where it's used.
+
+Range requests are answered, which is how the viewer reads a ZIP's central
+directory without downloading the whole archive.
+
 ### Running Tests
 
 ```bash

data/Rakefile

@@ -4,3 +4,25 @@ APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
 require "bundler/gem_tasks"
+
+Dir.glob("lib/tasks/**/*.rake").each { |r| load r }
+
+desc "Tag v<current version> and push it, which starts the Release workflow"
+task :tag do
+  require_relative "lib/upright/version"
+  tag = "v#{Upright::VERSION}"
+
+  abort "tag: the working tree has uncommitted changes" unless `git status --porcelain`.empty?
+
+  branch = `git rev-parse --abbrev-ref HEAD`.strip
+  abort "tag: run this on main (currently on #{branch})" unless branch == "main"
+
+  sh "git fetch origin main --quiet"
+  abort "tag: HEAD differs from origin/main; pull or push first" unless `git rev-parse HEAD`.strip == `git rev-parse origin/main`.strip
+  abort "tag: #{tag} already exists locally" unless `git tag --list #{tag}`.strip.empty?
+  abort "tag: #{tag} already exists on origin" unless `git ls-remote --tags origin refs/tags/#{tag}`.strip.empty?
+
+  sh "git tag --annotate #{tag} --message 'upright #{tag}'"
+  sh "git push origin #{tag}"
+  puts "Pushed #{tag}. Approve the release-rubygems environment when the Release workflow pauses."
+end

data/app/assets/stylesheets/upright/_global.css

@@ -35,6 +35,7 @@
 
   --lch-green-dark: 55% 0.162 147;
   --lch-red-dark: 59% 0.19 38;
+  --lch-orange-dark: 70% 0.17 65;
 
   /* Colors: Semantic */
   --color-black: oklch(var(--lch-black));
@@ -52,6 +53,7 @@
   --color-link: oklch(var(--lch-blue-dark));
   --color-positive: oklch(var(--lch-green-dark));
   --color-negative: oklch(var(--lch-red-dark));
+  --color-warning: oklch(var(--lch-orange-dark));
   --color-selected: oklch(var(--lch-blue-lighter));
 
   /* Borders & Shadows */

data/app/assets/stylesheets/upright/artifact.css

@@ -22,17 +22,11 @@
 
   .artifact__content {
     background: var(--color-ink-lightest);
-    border-radius: 0.25rem;
-    box-shadow: var(--shadow);
     display: flex;
     flex-direction: column;
-    height: 80vh;
-    left: 50%;
+    inset: 0;
     overflow: hidden;
     position: fixed;
-    top: 50%;
-    transform: translate(-50%, -50%);
-    width: 80vw;
     z-index: 1000;
   }
 
@@ -123,26 +117,14 @@
     }
   }
 
-  td .artifact + .artifact {
-    margin-left: calc(var(--inline-space) / 2);
+  .artifact__trace {
+    display: flex;
+    flex-direction: column;
+    gap: 0.5em;
   }
 
-  @media (max-width: 140ch) {
-    .artifact__content {
-      width: calc(100vw - var(--block-space) * 2);
-      height: calc(100vh - var(--block-space) * 2);
-      left: 50%;
-      top: 50%;
-    }
+  td .artifact + .artifact {
+    margin-left: calc(var(--inline-space) / 2);
   }
 
-  @media (max-width: 55ch) {
-    .artifact__content {
-      inset: 0;
-      width: 100%;
-      height: 100%;
-      transform: none;
-      border-radius: 0;
-    }
-  }
 }

data/app/assets/stylesheets/upright/flash.css

@@ -0,0 +1,19 @@
+@layer components {
+  .flash {
+    border-radius: 0.5rem;
+    color: var(--color-ink);
+    font-size: var(--text-small);
+    margin-block-end: var(--block-space);
+    padding: 0.75rem 1rem;
+  }
+
+  .flash--notice {
+    background: color-mix(in oklab, var(--color-positive) 12%, var(--color-canvas));
+    border: 1px solid color-mix(in oklab, var(--color-positive) 40%, var(--color-canvas));
+  }
+
+  .flash--alert {
+    background: color-mix(in oklab, var(--color-negative) 12%, var(--color-canvas));
+    border: 1px solid color-mix(in oklab, var(--color-negative) 40%, var(--color-canvas));
+  }
+}

data/app/assets/stylesheets/upright/header.css

@@ -38,6 +38,15 @@
     text-transform: uppercase;
   }
 
+  .header__env {
+    color: var(--color-warning);
+    font-size: var(--text-x-small);
+    font-weight: 500;
+    letter-spacing: 0.06em;
+    margin-right: calc(var(--inline-space) * 2);
+    text-transform: uppercase;
+  }
+
   .header__nav {
     align-items: center;
     display: flex;
@@ -62,6 +71,11 @@
     &.active {
       color: var(--color-positive);
     }
+
+    &.unavailable {
+      color: var(--color-ink-light);
+      cursor: help;
+    }
   }
 
   .header__divider {