mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-27 04:02:46 +00:00
05e2bc9f0a
## 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/<map>/manifest.<hash>.json` - `/_assets/images/Favicon.<hash>.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
311 lines
9.8 KiB
TypeScript
311 lines
9.8 KiB
TypeScript
import { html, LitElement } from "lit";
|
|
import { customElement } from "lit/decorators.js";
|
|
import { assetUrl } from "../../../core/AssetUrls";
|
|
import { EventBus } from "../../../core/EventBus";
|
|
import {
|
|
BuildableUnit,
|
|
BuildMenus,
|
|
Gold,
|
|
PlayerBuildableUnitType,
|
|
UnitType,
|
|
} from "../../../core/game/Game";
|
|
import { GameView } from "../../../core/game/GameView";
|
|
import {
|
|
GhostStructureChangedEvent,
|
|
ToggleStructureEvent,
|
|
} from "../../InputHandler";
|
|
import { renderNumber, translateText } from "../../Utils";
|
|
import { UIState } from "../UIState";
|
|
import { Layer } from "./Layer";
|
|
const warshipIcon = assetUrl("images/BattleshipIconWhite.svg");
|
|
const cityIcon = assetUrl("images/CityIconWhite.svg");
|
|
const factoryIcon = assetUrl("images/FactoryIconWhite.svg");
|
|
const goldCoinIcon = assetUrl("images/GoldCoinIcon.svg");
|
|
const mirvIcon = assetUrl("images/MIRVIcon.svg");
|
|
const missileSiloIcon = assetUrl("images/MissileSiloIconWhite.svg");
|
|
const hydrogenBombIcon = assetUrl("images/MushroomCloudIconWhite.svg");
|
|
const atomBombIcon = assetUrl("images/NukeIconWhite.svg");
|
|
const portIcon = assetUrl("images/PortIcon.svg");
|
|
const samLauncherIcon = assetUrl("images/SamLauncherIconWhite.svg");
|
|
const defensePostIcon = assetUrl("images/ShieldIconWhite.svg");
|
|
|
|
@customElement("unit-display")
|
|
export class UnitDisplay extends LitElement implements Layer {
|
|
public game: GameView;
|
|
public eventBus: EventBus;
|
|
public uiState: UIState;
|
|
private playerBuildables: BuildableUnit[] | null = null;
|
|
private keybinds: Record<string, { value: string; key: string }> = {};
|
|
private _cities = 0;
|
|
private _warships = 0;
|
|
private _factories = 0;
|
|
private _missileSilo = 0;
|
|
private _port = 0;
|
|
private _defensePost = 0;
|
|
private _samLauncher = 0;
|
|
private allDisabled = false;
|
|
private _hoveredUnit: PlayerBuildableUnitType | null = null;
|
|
|
|
createRenderRoot() {
|
|
return this;
|
|
}
|
|
|
|
init() {
|
|
const config = this.game.config();
|
|
|
|
const savedKeybinds = localStorage.getItem("settings.keybinds");
|
|
if (savedKeybinds) {
|
|
try {
|
|
this.keybinds = JSON.parse(savedKeybinds);
|
|
} catch (e) {
|
|
console.warn("Invalid keybinds JSON:", e);
|
|
}
|
|
}
|
|
|
|
this.allDisabled = BuildMenus.types.every((u) => config.isUnitDisabled(u));
|
|
this.requestUpdate();
|
|
}
|
|
|
|
private cost(item: UnitType): Gold {
|
|
for (const bu of this.playerBuildables ?? []) {
|
|
if (bu.type === item) {
|
|
return bu.cost;
|
|
}
|
|
}
|
|
return 0n;
|
|
}
|
|
|
|
private canBuild(item: UnitType): boolean {
|
|
if (this.game?.config().isUnitDisabled(item)) return false;
|
|
const player = this.game?.myPlayer();
|
|
switch (item) {
|
|
case UnitType.AtomBomb:
|
|
case UnitType.HydrogenBomb:
|
|
case UnitType.MIRV:
|
|
return (
|
|
this.cost(item) <= (player?.gold() ?? 0n) &&
|
|
(player?.units(UnitType.MissileSilo).length ?? 0) > 0
|
|
);
|
|
case UnitType.Warship:
|
|
return (
|
|
this.cost(item) <= (player?.gold() ?? 0n) &&
|
|
(player?.units(UnitType.Port).length ?? 0) > 0
|
|
);
|
|
default:
|
|
return this.cost(item) <= (player?.gold() ?? 0n);
|
|
}
|
|
}
|
|
|
|
tick() {
|
|
const player = this.game?.myPlayer();
|
|
if (!player) return;
|
|
player.buildables(undefined, BuildMenus.types).then((buildables) => {
|
|
this.playerBuildables = buildables;
|
|
});
|
|
this._cities = player.totalUnitLevels(UnitType.City);
|
|
this._missileSilo = player.totalUnitLevels(UnitType.MissileSilo);
|
|
this._port = player.totalUnitLevels(UnitType.Port);
|
|
this._defensePost = player.totalUnitLevels(UnitType.DefensePost);
|
|
this._samLauncher = player.totalUnitLevels(UnitType.SAMLauncher);
|
|
this._factories = player.totalUnitLevels(UnitType.Factory);
|
|
this._warships = player.totalUnitLevels(UnitType.Warship);
|
|
this.requestUpdate();
|
|
}
|
|
|
|
render() {
|
|
const myPlayer = this.game?.myPlayer();
|
|
if (
|
|
!this.game ||
|
|
!myPlayer ||
|
|
this.game.inSpawnPhase() ||
|
|
!myPlayer.isAlive()
|
|
) {
|
|
return null;
|
|
}
|
|
if (this.allDisabled) {
|
|
return null;
|
|
}
|
|
|
|
return html`
|
|
<div class="border-t border-white/10 p-0.5 w-full">
|
|
<div
|
|
class="grid grid-rows-1 auto-cols-max grid-flow-col gap-0.5 w-fit mx-auto"
|
|
>
|
|
${this.renderUnitItem(
|
|
cityIcon,
|
|
this._cities,
|
|
UnitType.City,
|
|
"city",
|
|
this.keybinds["buildCity"]?.key ?? "1",
|
|
)}
|
|
${this.renderUnitItem(
|
|
factoryIcon,
|
|
this._factories,
|
|
UnitType.Factory,
|
|
"factory",
|
|
this.keybinds["buildFactory"]?.key ?? "2",
|
|
)}
|
|
${this.renderUnitItem(
|
|
portIcon,
|
|
this._port,
|
|
UnitType.Port,
|
|
"port",
|
|
this.keybinds["buildPort"]?.key ?? "3",
|
|
)}
|
|
${this.renderUnitItem(
|
|
defensePostIcon,
|
|
this._defensePost,
|
|
UnitType.DefensePost,
|
|
"defense_post",
|
|
this.keybinds["buildDefensePost"]?.key ?? "4",
|
|
)}
|
|
${this.renderUnitItem(
|
|
missileSiloIcon,
|
|
this._missileSilo,
|
|
UnitType.MissileSilo,
|
|
"missile_silo",
|
|
this.keybinds["buildMissileSilo"]?.key ?? "5",
|
|
)}
|
|
${this.renderUnitItem(
|
|
samLauncherIcon,
|
|
this._samLauncher,
|
|
UnitType.SAMLauncher,
|
|
"sam_launcher",
|
|
this.keybinds["buildSamLauncher"]?.key ?? "6",
|
|
)}
|
|
${this.renderUnitItem(
|
|
warshipIcon,
|
|
this._warships,
|
|
UnitType.Warship,
|
|
"warship",
|
|
this.keybinds["buildWarship"]?.key ?? "7",
|
|
)}
|
|
${this.renderUnitItem(
|
|
atomBombIcon,
|
|
null,
|
|
UnitType.AtomBomb,
|
|
"atom_bomb",
|
|
this.keybinds["buildAtomBomb"]?.key ?? "8",
|
|
)}
|
|
${this.renderUnitItem(
|
|
hydrogenBombIcon,
|
|
null,
|
|
UnitType.HydrogenBomb,
|
|
"hydrogen_bomb",
|
|
this.keybinds["buildHydrogenBomb"]?.key ?? "9",
|
|
)}
|
|
${this.renderUnitItem(
|
|
mirvIcon,
|
|
null,
|
|
UnitType.MIRV,
|
|
"mirv",
|
|
this.keybinds["buildMIRV"]?.key ?? "0",
|
|
)}
|
|
</div>
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
private renderUnitItem(
|
|
icon: string,
|
|
number: number | null,
|
|
unitType: PlayerBuildableUnitType,
|
|
structureKey: string,
|
|
hotkey: string,
|
|
) {
|
|
if (this.game.config().isUnitDisabled(unitType)) {
|
|
return html``;
|
|
}
|
|
const selected = this.uiState.ghostStructure === unitType;
|
|
const hovered = this._hoveredUnit === unitType;
|
|
const displayHotkey = hotkey
|
|
.replace("Digit", "")
|
|
.replace("Key", "")
|
|
.toUpperCase();
|
|
|
|
return html`
|
|
<div
|
|
class="flex flex-col items-center relative"
|
|
@mouseenter=${() => {
|
|
this._hoveredUnit = unitType;
|
|
this.requestUpdate();
|
|
}}
|
|
@mouseleave=${() => {
|
|
this._hoveredUnit = null;
|
|
this.requestUpdate();
|
|
}}
|
|
>
|
|
${hovered
|
|
? html`
|
|
<div
|
|
class="absolute -top-[250%] left-1/2 -translate-x-1/2 text-gray-200 text-center w-max text-xs bg-gray-800/90 backdrop-blur-xs rounded-sm p-1 z-[100] shadow-lg pointer-events-none"
|
|
>
|
|
<div class="font-bold text-sm mb-1">
|
|
${translateText(
|
|
"unit_type." + structureKey,
|
|
)}${` [${displayHotkey}]`}
|
|
</div>
|
|
<div class="p-2">
|
|
${translateText("build_menu.desc." + structureKey)}
|
|
</div>
|
|
<div class="flex items-center justify-center gap-1">
|
|
<img src=${goldCoinIcon} width="13" height="13" />
|
|
<span class="text-yellow-300"
|
|
>${renderNumber(this.cost(unitType))}</span
|
|
>
|
|
</div>
|
|
</div>
|
|
`
|
|
: null}
|
|
<div
|
|
class="${this.canBuild(unitType)
|
|
? ""
|
|
: "opacity-40"} border border-slate-500 rounded-sm px-0.5 pb-0.5 flex items-center gap-0.5 cursor-pointer
|
|
${selected ? "hover:bg-gray-400/10" : "hover:bg-gray-800"}
|
|
rounded-sm text-white ${selected ? "bg-slate-400/20" : ""}"
|
|
@click=${() => {
|
|
if (selected) {
|
|
this.uiState.ghostStructure = null;
|
|
this.eventBus?.emit(new GhostStructureChangedEvent(null));
|
|
} else if (this.canBuild(unitType)) {
|
|
this.uiState.ghostStructure = unitType;
|
|
this.eventBus?.emit(new GhostStructureChangedEvent(unitType));
|
|
}
|
|
this.requestUpdate();
|
|
}}
|
|
@mouseenter=${() => {
|
|
switch (unitType) {
|
|
case UnitType.AtomBomb:
|
|
case UnitType.HydrogenBomb:
|
|
this.eventBus?.emit(
|
|
new ToggleStructureEvent([
|
|
UnitType.MissileSilo,
|
|
UnitType.SAMLauncher,
|
|
]),
|
|
);
|
|
break;
|
|
case UnitType.Warship:
|
|
this.eventBus?.emit(new ToggleStructureEvent([UnitType.Port]));
|
|
break;
|
|
default:
|
|
this.eventBus?.emit(new ToggleStructureEvent([unitType]));
|
|
}
|
|
}}
|
|
@mouseleave=${() =>
|
|
this.eventBus?.emit(new ToggleStructureEvent(null))}
|
|
>
|
|
${html`<div class="ml-0.5 text-[10px] relative -top-1 text-gray-400">
|
|
${displayHotkey}
|
|
</div>`}
|
|
<div class="flex items-center gap-0.5 pt-0.5">
|
|
<img src=${icon} alt=${structureKey} class="align-middle size-5" />
|
|
${number !== null
|
|
? html`<span class="text-xs">${renderNumber(number)}</span>`
|
|
: null}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
`;
|
|
}
|
|
}
|