Rebuild @screenly/edge-apps with failure-mode algorithm and single-file deploy

[Sir-Monke]

Description of Changes

Rebuilt on @screenly/edge-apps, scaffolded with the official create command. TypeScript in src/, Bun and Vite, release plumbing per the Edge Apps development doc. index.html is now generated rather than hand-written; the design is unchanged, pixel for pixel.

The failure-mode algorithm. There are no credentials here — the USGS feed is public — so the credential half of the diagram does not apply. What is left:

Feed	display_errors	Result
OK	—	Cache the ten nearest, draw the closest
Failed	on	Show the error, draw nothing
Failed	off, cache present	Draw the last reading received
Failed	off, no cache	Say it is unavailable

display_errors follows the library exactly: same key, same false default, same panic-overlay, and the same signal-on-error, so a crash cannot stall a playlist. The last row is the diagram's Abort terminal — screenly.signalAbort() does not exist yet (T10903), so for now it states the problem and signals ready anyway, because an app that never signals holds the playlist for sixty seconds and is then dropped with PlaybackReason::LoadTimeout.

Only the ten nearest quakes are cached, trimmed to the five fields drawn — 491 bytes rather than the feed's few megabytes, and a cached render is identical to a live one.

Timings. One clock: an 8s feed timeout. The screenshotter allows 10s for the page to go quiet and 10s more for the ready signal, so timing out early leaves room to fall back to cache, draw and signal. Measured at 8,089 ms to signal on a hung feed.

Single-use values moved into the functions that use them — compass into heading(), the 1500/12000 clamps into widthToFitKept(), the feed URL into load(), units into away().

Release plumbing. CHANGELOG.md, CI and deploy workflows, user_version in the manifest. Drops .ignore — deploying from dist/ makes it unnecessary — and five workflows for Rust, Python and SQL, none of which this repo has ever contained.

• Are these changes breaking any existing functionality? No. Same design, same behaviour, plus failure handling that was not there before.
• Have tests been added/updated to cover the changes? e2e/failure-modes.mjs, 24 checks, one per branch of the diagram. bun run verify.

Checklist

• I have performed a self-review of my own code
• I have commented on my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Additional Notes/Comments

Two library bugs found on the way, both worth their own issues.

The default build output does not deploy. edge-apps-scripts build emits index.html plus js/ and css/ subdirectories. Deployed as-is, the player sticks in a "downloading content" loop and api/v3/assets/<id>/capture/ returns 500 — with a completely clean browser console, because nothing of the app ever executes. The same app as one file renders on both. Proven across three revisions: 49 (three files) broken, 50 (old single file) fine, 51 (rebuilt, inlined) fine. Root cause not isolated — either the player cannot serve nested asset paths, or type="module" crossorigin fails on it. scripts/inline-bundle.mjs sidesteps both by folding the CSS and JS back into index.html after Vite runs. If this reproduces generally, every app scaffolded today has it.

edge-apps-scripts does not run on Windows. lint, type-check, build, dev and build:dev all fail with "The system cannot find the path specified". resolveBin() returns node_modules/.bin/<tool> with no .cmd or .exe, and execSync/execFileSync route that through cmd.exe, which cannot execute it. CI is unaffected. The README documents the direct-invocation workaround.

Three things must be in place before either workflow can fire, none of which I can do:

1. master renamed to main — both workflows trigger on main and development per the doc, so while this PR targets master no checks will run on it.
2. A development branch, for the stage environment.
3. A SCREENLY_API_TOKEN repo secret.

Two conventions deliberately not adopted, both commented in place with the reason:

• The library stylesheet is not imported. It inlines three Inter faces as base64 — 444 KB of the 458 KB it emits — and this app is designed on system-ui on purpose. Skipping it takes the CSS from 458 KB to 3.4 KB.
• <auto-scaler> is not used. It scales a fixed 1920x1080 design, which would letterbox a portrait screen; the map window is fitted to the screen's real aspect ratio instead.

Happy to change either if you would rather have consistency than the behaviour.

[renatgalimov]

TODO: Discuss the idea of screenshot tests.

[renatgalimov]

Ask for an idea behind this file.

[renatgalimov]

This is a bit counterintuitive, though. Could we just move the whole SVG to a file instead?

[renatgalimov]

Coordinates of what?

[renatgalimov]

The variable name sounds like a boolean type.

[renatgalimov]

From the function content it's more like "setD"

[renatgalimov]

Magic number.

[renatgalimov]

The algorithm clearly says that we abort here.

[Copilot]

Pull request overview

Rebuilds the Earthquake Edge App on top of @screenly/edge-apps (TypeScript + Bun/Vite), adds explicit failure-mode handling with cache fallback, and adjusts the build/deploy pipeline to ship as a single-file index.html.

Changes:

• Implement USGS fetch + cache fallback behavior per the documented failure-mode algorithm, including abort/unlocated states.
• Add post-build inlining (scripts/inline-bundle.mjs) so dist/ deploys as a single self-contained HTML file.
• Introduce Bun-based dev tooling and Playwright e2e coverage, plus streamlined CI/deploy workflows and release plumbing.

Reviewed changes

Copilot reviewed 18 out of 25 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tsconfig.json	Adds TS project config extending @screenly/edge-apps defaults.
src/style.css	Introduces the app’s custom stylesheet (intentionally not using the library CSS).
src/main.ts	Core app logic: rendering, fetch/cache behavior, and failure modes.
scripts/inline-bundle.mjs	Post-build step to inline JS/CSS into dist/index.html and remove subfolders.
screenly.yml	Updates manifest metadata and adds settings (display_errors, sentry_dsn, etc.).
README.md	Updates documentation to match the rebuilt app + failure-mode behavior + tooling.
package.json	Adds Bun/Vite build scripts, lint/typecheck, deploy, and e2e commands.
e2e/screenshots.spec.ts	Adds Playwright-based screenshot coverage across supported resolutions.
e2e/failure-modes.mjs	Adds e2e verification of each failure-mode branch against built dist/.
CHANGELOG.md	Adds user-facing changelog for releases.
bun.lock	Locks dependencies for Bun.
.prettierrc.json	Adds Prettier configuration.
.ignore	Removes legacy deploy ignore file (deploy now happens from dist/).
.gitignore	Adds standard ignores for node/bun output and local mock data.
.github/workflows/deploy.yml	Adds deploy workflow for main/development branches.
.github/workflows/ci.yml	Adds CI workflow for lint/format/typecheck/build/test on main/development.
.github/workflows/sqllint.yml	Removes unused SQL lint workflow.
.github/workflows/ruff.yml	Removes unused Python Ruff workflow.
.github/workflows/pyright-annotations.yml	Removes unused Pyright workflow.
.github/workflows/codecov.yml	Removes unused Codecov workflow.
.github/workflows/clippy.yml	Removes unused Rust Clippy workflow.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[renatgalimov]

This type of error-catching will also handle all non-data-related errors, as it would handle the data-fetch error.

For example, you got the quakes but failed to write the cache, or, because of a bug or something else, the show failed; then, if display_errors is off, you will read the cache and redo it.

You should first get the data from the site or cache, and then render it.

Keep your eye on the try-catch block. If they're super-wide or if you throw an error straight from the try block like

try {
...
throw new Error()
...
} catch (error) {
handle error here
}

looks bad to me, but there are situations where it's ok. I just don't like it.

https://github.com/Screenly/salesforce-app/blob/main/src/content.ts#L72

[renatgalimov]

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DurationFormat#browser_compatibility

[Copilot]

🔵 Needs a closer look

The manifest’s display_errors type/default don’t match how the app reads the setting, and the new CI workflow won’t run for the repo’s current master-targeted PRs/pushes.

Review details

Suppressed comments (6)

Previously missed (3) — in code that hasn't changed since the last review.

package.json:19

• verify runs node e2e/failure-modes.mjs, which expects a built dist/ directory (the script comment says it runs against BUILT dist/). As written, bun run verify will fail unless the developer happens to have run a build first.
  screenly.yml:6
• The icon URL points at the main branch (.../Earthquake-App/main/icon.png), but this repo currently uses master (and the PR notes the rename isn’t done yet). This will 404 until the branch rename happens.
  screenly.yml:31
• display_errors is declared as a string with a string default ('false'), but the UI schema says it’s boolean and the app reads it as a boolean (see src/main.ts calling getSettingWithDefault<boolean>('display_errors', false)). If the runtime value is the string 'false', it will be truthy and incorrectly enable the error-throwing path.

.github/workflows/ci.yml:8

• CI is configured to run only on pushes to main/development. Since this PR targets master, CI won’t run on pushes to the current default branch until the branch rename happens.

on:
  push:
    branches:
      - main
      - development

e2e/failure-modes.mjs:14

• This script is executed with node (see package.json), but it relies on import.meta.dirname. For broader Node compatibility, compute the directory from import.meta.url instead.

import { chromium } from 'playwright'
import http from 'http'
import fs from 'fs'
import path from 'path'

const DIST = path.join(import.meta.dirname, '..', 'dist')
const MIME = {

.github/workflows/ci.yml:13

• CI is configured to run only for PRs targeting main/development. PRs opened against master won’t get CI checks until the branch rename happens.

  pull_request:
    branches:
      - main
      - development

• Files reviewed: 18/25 changed files
• Comments generated: 0 new
• Review effort level: Lite

[renatgalimov]

Approved, but I'd ask @nicomiguelino also do a review.