From 05e2bc9f0a989f6023e659e12dd09d3d2a98b58e Mon Sep 17 00:00:00 2001 From: scamiv <6170744+scamiv@users.noreply.github.com> Date: Mon, 23 Mar 2026 19:36:52 +0100 Subject: [PATCH] Improve cacheability with content-hashed public assets and a cacheable app shell (#3494) ## Description: This reworks asset delivery and cacheability across the app and moves non-bundled public resources onto immutable, content-hashed URLs. Vite bundle outputs continue to live under `/assets/**` and remain content-hashed by Vite. Public resources that were previously fetched from stable paths in `resources/` now go through a custom hashed namespace under `/_assets/**`, backed by a generated asset manifest that is available to the server, browser, and worker runtime. In parallel, the root app shell is now cacheable shared HTML instead of request-time `no-store` HTML. Dynamic and live routes remain explicitly uncached. ## Why - Improve browser and Cloudflare cacheability for static assets. - Remove query-string and release-version cache busting for runtime-fetched assets. - Allow unchanged public assets to keep the same URL across releases. - Reduce avoidable work on `/` by serving a shared app shell instead of rendering HTML on every request. - Make cache behavior explicit instead of relying on mixed framework defaults and file-extension heuristics. ## What Changed ### 1. Content-hashed public asset pipeline - Added a build-time public asset manifest and hashing pipeline for non-Vite resources. - Production now emits hashed public assets under `/_assets/**`. - Added runtime manifest loading for Node so server-rendered paths resolve against built hashed files instead of rebuilding from source at runtime. - Emitted the runtime asset manifest as an ESM module for server consumption. Result: - `/assets/**` = Vite-managed hashed bundle outputs - `/_assets/**` = custom content-hashed public resources ### 2. Runtime asset URL migration - Added a shared `assetUrl(...)` resolution path. - Migrated runtime references away from query-string versioning and stable source paths. - Updated browser, worker, and server-side rendering paths to resolve through the asset manifest. - Moved map manifests, map binaries, thumbnails, sprites, sounds, fonts, flags, icons, screenshots, and other runtime-fetched resources onto hashed URLs. ### 3. Map and preview fixes - Fixed directory and per-file map asset resolution so map manifest and binary fetches resolve to the correct hashed URLs. - Updated preview metadata and map thumbnail paths to use the hashed asset namespace. - Fixed runtime manifest loading in prod after deployment. ### 4. Explicit cache policies - Added explicit immutable cache headers for: - `/assets/**` - `/_assets/**` - worker-prefixed equivalents under `/wN/...` - Added explicit `no-store` headers for live and dynamic APIs. - Removed the old `/api/env` bootstrap request and baked `gameEnv` into the HTML bootstrap instead. ### 5. Cacheable root app shell - Refactored the root HTML path to serve a shared app shell with: - `Cache-Control: public, max-age=0, s-maxage=300, stale-while-revalidate=86400` - `/` and the SPA fallback now serve shared cacheable HTML instead of request-time `no-store` rendering. - `/game/:id` remains dynamic and `no-store`, but now reuses the shared shell before injecting preview tags. ### 6. Matchmaking instance handling - Because the app shell is now cacheable, `INSTANCE_ID` was removed from shared HTML. - Added `/api/instance` as a temporary `no-store` runtime lookup used only by matchmaking. - This preserves correctness with the current random-per-boot `INSTANCE_ID` model while keeping `/` cacheable, but it is not the intended long-term design. ## Behavior Changes ### Asset URL contract Production URLs for non-Vite public resources now change from stable paths such as: - `/maps/...` - `/images/...` - `/manifest.json` to content-hashed paths under: - `/_assets/...` Examples: - `/_assets/maps//manifest..json` - `/_assets/images/Favicon..svg` ### Bootstrap/config - `/api/env` is removed. - `gameEnv` is now bootstrapped from HTML. ### HTML caching - `/` and the SPA fallback are now cacheable shared HTML. - `/game/:id` remains dynamic. ## Cache Matrix After This Branch - `/_assets/**`: `public, max-age=31536000, immutable` - `/assets/**`: `public, max-age=31536000, immutable` - live `/api/**`: explicit `no-store` - `/api/health`: explicit `no-store` - `/api/instance`: explicit `no-store` - `/game/:id`: explicit `no-store` - `/` and SPA fallback: `public, max-age=0, s-maxage=300, stale-while-revalidate=86400` ## Notes / Tradeoffs - `/api/instance` is a temporary compromise. It exists because `INSTANCE_ID` is currently random per boot, which is not safe to embed into cacheable shared HTML. - The current matchmaking flow still asks the client to provide `instance_id` during `matchmaking/join`. That is functional, but it is the wrong ownership boundary: instance selection should be handled by the matchmaking service, not by the browser. - The cleaner end-state would be: - make `matchmaking/join` stop requiring `instance_id` from the client, and let the matchmaking service select a healthy instance from worker check-ins - This branch makes the origin behavior edge-cache-friendly, but Cloudflare still needs matching cache rules if HTML itself should be cached at the edge. ## Validation Verified during development with: - `npx tsc --noEmit` - `node node_modules\\vite\\bin\\vite.js build` - `node node_modules\\vitest\\vitest.mjs run tests/server/RenderHtml.test.ts tests/server/NoStoreHeaders.test.ts tests/server/StaticAssetCache.test.ts tests/core/configuration/ConfigLoader.test.ts` Additional targeted tests added: - `tests/AssetUrls.test.ts` - `tests/core/game/FetchGameMapLoader.test.ts` - `tests/core/configuration/ConfigLoader.test.ts` - `tests/server/NoStoreHeaders.test.ts` - `tests/server/StaticAssetCache.test.ts` - `tests/server/RenderHtml.test.ts` ## Known Existing Warnings The production build still reports pre-existing warnings that are not addressed by this branch: - inconsistent JSON import attributes for `resources/countries.json` - inconsistent JSON import attributes for `resources/QuickChat.json` - large chunk warnings from Vite ## Rollout Notes - Cache rules should treat `/_assets/**` and `/assets/**` as immutable. - Cloudflare will still classify HTML as dynamic after deploy unless matching edge cache rules are configured for it. ## Follow-ups - Remove `/api/instance` by changing `matchmaking/join` so the server selects the target instance, or by making `INSTANCE_ID` deploy-stable if the current contract must remain. ## Please complete the following: - [ ] I have added screenshots for all UI updates - [ ] I process any text displayed to the user through translateText() and I've added it to the en.json file - [ ] I have added relevant tests to the test directory - [ ] I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced ## Please put your Discord username so you can be contacted if a bug or regression is found: DISCORD_USERNAME --- index.html | 40 ++-- nginx.conf | 126 +++++++++--- src/client/AccountModal.ts | 3 +- src/client/FlagInput.ts | 10 +- src/client/FlagInputModal.ts | 5 +- src/client/HelpModal.ts | 81 ++++---- src/client/JoinLobbyModal.ts | 5 +- src/client/LangSelector.ts | 7 +- src/client/LanguageModal.ts | 3 +- src/client/Main.ts | 1 - src/client/Matchmaking.ts | 30 ++- src/client/NewsModal.ts | 7 +- src/client/SinglePlayerModal.ts | 3 +- src/client/TerrainMapFileLoader.ts | 6 +- src/client/TroubleshootingModal.ts | 3 +- src/client/components/Footer.ts | 5 +- .../baseComponents/ranking/PlayerRow.ts | 17 +- src/client/components/map/MapDisplay.ts | 4 +- src/client/components/map/MapPicker.ts | 3 +- src/client/graphics/PlayerIcons.ts | 31 +-- src/client/graphics/SpriteLoader.ts | 21 +- .../graphics/layers/AttackingTroopsOverlay.ts | 5 +- src/client/graphics/layers/AttacksDisplay.ts | 5 +- src/client/graphics/layers/BuildMenu.ts | 23 +-- src/client/graphics/layers/ControlPanel.ts | 7 +- src/client/graphics/layers/EventsDisplay.ts | 11 +- src/client/graphics/layers/GameLeftSidebar.ts | 11 +- .../graphics/layers/GameRightSidebar.ts | 11 +- src/client/graphics/layers/MainRadialMenu.ts | 5 +- src/client/graphics/layers/NameLayer.ts | 3 +- .../graphics/layers/PlayerInfoOverlay.ts | 21 +- .../graphics/layers/PlayerModerationModal.ts | 5 +- src/client/graphics/layers/PlayerPanel.ts | 25 +-- src/client/graphics/layers/RadialMenu.ts | 3 +- .../graphics/layers/RadialMenuElements.ts | 25 +-- src/client/graphics/layers/SettingsModal.ts | 27 +-- .../graphics/layers/StructureDrawingUtils.ts | 13 +- .../graphics/layers/StructureIconsLayer.ts | 3 +- src/client/graphics/layers/StructureLayer.ts | 13 +- src/client/graphics/layers/UnitDisplay.ts | 23 +-- src/client/sound/SoundManager.ts | 3 +- src/client/vite-env.d.ts | 10 - src/core/AssetUrls.ts | 86 ++++++++ src/core/CustomFlag.ts | 3 +- src/core/configuration/ConfigLoader.ts | 25 ++- src/core/game/BinaryLoaderGameMapLoader.ts | 15 +- src/core/game/FetchGameMapLoader.ts | 18 +- src/core/worker/Worker.worker.ts | 5 +- src/server/GamePreviewBuilder.ts | 16 +- src/server/GamePreviewRoute.ts | 8 +- src/server/Master.ts | 47 ++--- src/server/NoStoreHeaders.ts | 10 + src/server/PublicAssetManifest.ts | 187 ++++++++++++++++++ src/server/RenderHtml.ts | 55 +++++- src/server/RuntimeAssetManifest.ts | 40 ++++ src/server/StaticAssetCache.ts | 33 ++++ src/server/Worker.ts | 18 +- tests/AssetUrls.test.ts | 46 +++++ tests/core/configuration/ConfigLoader.test.ts | 24 +++ tests/core/game/FetchGameMapLoader.test.ts | 30 +++ tests/server/NoStoreHeaders.test.ts | 21 ++ tests/server/PublicAssetManifest.test.ts | 71 +++++++ tests/server/RenderHtml.test.ts | 60 ++++++ tests/server/StaticAssetCache.test.ts | 21 ++ vite.config.ts | 43 +++- 65 files changed, 1214 insertions(+), 331 deletions(-) create mode 100644 src/core/AssetUrls.ts create mode 100644 src/server/NoStoreHeaders.ts create mode 100644 src/server/PublicAssetManifest.ts create mode 100644 src/server/RuntimeAssetManifest.ts create mode 100644 src/server/StaticAssetCache.ts create mode 100644 tests/AssetUrls.test.ts create mode 100644 tests/core/configuration/ConfigLoader.test.ts create mode 100644 tests/core/game/FetchGameMapLoader.test.ts create mode 100644 tests/server/NoStoreHeaders.test.ts create mode 100644 tests/server/PublicAssetManifest.test.ts create mode 100644 tests/server/RenderHtml.test.ts create mode 100644 tests/server/StaticAssetCache.test.ts diff --git a/index.html b/index.html index 5db9deb74..ebb12432d 100644 --- a/index.html +++ b/index.html @@ -7,8 +7,8 @@ content="width=device-width, initial-scale=1.0, viewport-fit=cover" /> OpenFront (ALPHA) - - + +