mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 15:30:43 +00:00
Evan
275fd0dccc
## Description: This is a refactor to simplify config handling. Replaces the per-environment DevConfig/PreprodConfig/ProdConfig class hierarchy with two static classes: ClientEnv (browser main thread, reads from window.BOOTSTRAP_CONFIG) and ServerEnv (Node server, reads from process.env). The four config classes are deleted, the abstract DefaultServerConfig is gone, and DefaultConfig is renamed to Config. The values that flow server → client (gameEnv, numWorkers, turnstileSiteKey, jwtAudience, instanceId) used to be baked into the hardcoded per-env classes. They're now real env vars on the server, embedded into a single window.BOOTSTRAP_CONFIG object in index.html at request time (alongside the existing gitCommit/assetManifest/cdnBase globals, which moved into the same object), and read back by ClientEnv on the client. The dev defaults previously hidden inside DevServerConfig are now explicit in start:server-dev (NUM_WORKERS=2, TURNSTILE_SITE_KEY=1x..., JWT_AUDIENCE=localhost, etc.) and in vite.config.ts's html plugin inject.data. Production deploys plumb NUM_WORKERS and TURNSTILE_SITE_KEY through deploy.yml (GitHub vars) into the remote env file; JWT_AUDIENCE is derived from DOMAIN in deploy.sh. The dynamic /api/instance endpoint is gone — INSTANCE_ID rides along in BOOTSTRAP_CONFIG now. ServerEnv is the only thing server code touches; ClientEnv is browser-only. The two classes have intentional overlap (env, numWorkers, jwtIssuer, gameCreationRate, workerIndex, etc.) since they derive identical logic from different sources — there's a TODO in each to consolidate via a shared helper later. The game-logic Config no longer stores a ServerConfig/ClientEnv reference and its serverConfig() getter is gone; the one caller (MultiTabModal) now reads ClientEnv.env() directly. Worker init no longer carries server-config values since nothing in the worker actually reads them. ## Please complete the following: - [x] I have added screenshots for all UI updates - [x] I process any text displayed to the user through translateText() and I've added it to the en.json file - [x] I have added relevant tests to the test directory - [x] 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: evan
68 lines
1.8 KiB
TypeScript
68 lines
1.8 KiB
TypeScript
import fs from "fs/promises";
|
|
import os from "os";
|
|
import path from "path";
|
|
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
|
|
import {
|
|
clearAppShellContentCache,
|
|
getAppShellContent,
|
|
setAppShellCacheHeaders,
|
|
} from "../../src/server/RenderHtml";
|
|
|
|
describe("RenderHtml", () => {
|
|
const originalGitCommit = process.env.GIT_COMMIT;
|
|
let tempDir: string | null = null;
|
|
|
|
beforeEach(() => {
|
|
vi.stubEnv("NUM_WORKERS", "1");
|
|
vi.stubEnv("TURNSTILE_SITE_KEY", "test-key");
|
|
vi.stubEnv("DOMAIN", "localhost");
|
|
});
|
|
|
|
afterEach(async () => {
|
|
vi.unstubAllEnvs();
|
|
process.env.GIT_COMMIT = originalGitCommit;
|
|
clearAppShellContentCache();
|
|
|
|
if (tempDir) {
|
|
await fs.rm(tempDir, { recursive: true, force: true });
|
|
tempDir = null;
|
|
}
|
|
});
|
|
|
|
test("reuses cached app shell content", async () => {
|
|
tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "render-html-"));
|
|
const htmlPath = path.join(tempDir, "index.html");
|
|
await fs.writeFile(
|
|
htmlPath,
|
|
"<script>window.GIT_COMMIT = <%- gitCommit %>;</script>",
|
|
"utf8",
|
|
);
|
|
|
|
process.env.GIT_COMMIT = "first";
|
|
const first = await getAppShellContent(htmlPath);
|
|
|
|
process.env.GIT_COMMIT = "second";
|
|
const second = await getAppShellContent(htmlPath);
|
|
|
|
expect(first).toContain('"first"');
|
|
expect(second).toBe(first);
|
|
expect(second).not.toContain('"second"');
|
|
});
|
|
|
|
test("sets shared-cache headers for the app shell", () => {
|
|
const headers = new Map<string, string>();
|
|
const response = {
|
|
setHeader(name: string, value: string) {
|
|
headers.set(name, value);
|
|
},
|
|
} as any;
|
|
|
|
setAppShellCacheHeaders(response);
|
|
|
|
expect(headers.get("Cache-Control")).toBe(
|
|
"public, max-age=0, s-maxage=300, stale-while-revalidate=86400",
|
|
);
|
|
expect(headers.get("Content-Type")).toBe("text/html");
|
|
});
|
|
});
|