Files
Stirling-PDF/frontend
Connor Yoh cabba5a94b fix(desktop): key endpoint availability by the endpoint set
Review caught a real fail-open regression. The multiple-endpoint query keyed on
a constant, which asserts the value is caller-independent, but on two paths it
is not: the self-hosted-offline check and the legacy ?endpoints= fallback both
resolve only the endpoints they were handed. Consumers pass disjoint sets, so
whichever mounted first froze a partial map into the shared entry, and a later
consumer projected endpoints nobody had checked. Those read as available on
exactly the paths where desktop means to fail closed, and being mount-order
dependent it would not have reproduced reliably.

Keying by the endpoint set restores the old per-consumer semantics and removes
the mount-order dependence. Prefix invalidation still covers every set, so the
reconnect swap is unaffected. This costs the cross-consumer dedup the PR
claimed: that saving only held while the whole-map response made the shared
entry complete, which those two paths break.

Also stops the readiness effect invalidating on mount, which was forcing a
redundant second fetch behind the first.
2026-09-02 17:48:46 +01:00
..
2026-04-27 11:35:50 +01:00
2026-08-24 10:34:12 +00:00

Frontend

All frontend commands are run from the repository root using Task:

  • task frontend:dev — start Vite dev server (localhost:5173)
  • task frontend:build — production build
  • task frontend:test — run tests
  • task frontend:test:watch — run tests in watch mode
  • task frontend:lint — run linting
  • task frontend:typecheck — run TypeScript type checking
  • task frontend:check — run typecheck + lint + test
  • task frontend:install — install npm dependencies

For desktop app development, see the Tauri section below.

Layout

frontend/ is a workspace containing one or more apps. Today it holds the PDF editor under frontend/editor/; new apps (the developer portal, etc.) will sit alongside it as siblings. Shared tooling — package.json, node_modules, .storybook/, oxlint, oxfmt — lives at frontend/ so every app installs once and lints with the same config.

Environment Variables

The editor's environment variables live in committed .env files at frontend/editor/:

  • .env — used by all builds (core, proprietary, and as the base for desktop/SaaS)
  • .env.desktop — additional vars loaded in desktop (Tauri) mode
  • .env.saas — additional vars loaded in SaaS mode

These files contain non-secret defaults and are checked into Git, so most dev work needs no further setup.

To override values locally (API keys, machine-specific settings), create an uncommitted sibling editor/.env.local / editor/.env.desktop.local / editor/.env.saas.local. Vite automatically layers these on top of the committed files.

Docker Setup

For Docker deployments and configuration, see the Docker README.

Tauri

All desktop tasks are available via Task. From the root of the repo:

Dev

task desktop:dev

This ensures the JLink runtime and backend JAR exist (skipping if already built), then starts Tauri in dev mode.

Build

task desktop:build

This does a full clean rebuild of the backend JAR and JLink runtime, then builds the Tauri app for production.

Platform-specific dev builds are also available:

task desktop:build:dev           # No bundling
task desktop:build:dev:mac       # macOS .app bundle
task desktop:build:dev:windows   # Windows NSIS installer
task desktop:build:dev:linux     # Linux AppImage

You can also run JLink steps individually:

task desktop:jlink          # Build JAR + create JLink runtime
task desktop:jlink:jar      # Build backend JAR only
task desktop:jlink:runtime  # Create JLink custom JRE only
task desktop:jlink:clean    # Remove JLink artifacts

Clean

task desktop:clean

Removes all desktop build artifacts including JLink runtime, bundled JARs, Cargo build, and dist/build directories.