refactor: collapse per-env Configs into ClientEnv + ServerEnv (#3906)

## 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
This commit is contained in:
Evan
2026-05-11 19:24:01 -07:00
committed by GitHub
parent a597262af9
commit 275fd0dccc
74 changed files with 1627 additions and 1956 deletions
+69 -26
View File
@@ -1,44 +1,87 @@
import { ClientEnv } from "src/client/ClientEnv";
import { beforeEach, describe, expect, test, vi } from "vitest";
import { GameEnv } from "../../../src/core/configuration/Config";
import {
clearCachedRuntimeClientServerConfig,
GameLogicEnv,
getBuildTimeGameLogicEnv,
getGameLogicConfig,
getRuntimeClientServerConfig,
getServerConfigForGameLogicEnv,
} from "../../../src/core/configuration/ConfigLoader";
import { GameEnv, parseGameEnv } from "../../../src/core/configuration/Config";
describe("ConfigLoader", () => {
const originalGameEnv = process.env.GAME_ENV;
describe("parseGameEnv", () => {
test("maps 'dev' to GameEnv.Dev", () => {
expect(parseGameEnv("dev")).toBe(GameEnv.Dev);
});
test("maps 'staging' to GameEnv.Preprod", () => {
expect(parseGameEnv("staging")).toBe(GameEnv.Preprod);
});
test("maps 'prod' to GameEnv.Prod", () => {
expect(parseGameEnv("prod")).toBe(GameEnv.Prod);
});
test("throws on undefined", () => {
expect(() => parseGameEnv(undefined)).toThrow(/unsupported game env/);
});
test("throws on unknown value", () => {
expect(() => parseGameEnv("production")).toThrow(/unsupported game env/);
});
});
describe("ClientEnv", () => {
beforeEach(() => {
vi.restoreAllMocks();
window.BOOTSTRAP_CONFIG = undefined;
process.env.GAME_ENV = originalGameEnv;
clearCachedRuntimeClientServerConfig();
ClientEnv.reset();
});
test("uses runtime bootstrap config without fetching /api/env", async () => {
window.BOOTSTRAP_CONFIG = { gameEnv: "staging" };
test("reads from window.BOOTSTRAP_CONFIG without fetching", () => {
window.BOOTSTRAP_CONFIG = {
gameEnv: "staging",
numWorkers: 4,
turnstileSiteKey: "test-key",
jwtAudience: "openfront.dev",
instanceId: "TEST_ID",
gitCommit: "abc123",
};
const fetchSpy = vi.spyOn(globalThis, "fetch");
const config = await getRuntimeClientServerConfig();
expect(config.env()).toBe(GameEnv.Preprod);
expect(ClientEnv.env()).toBe(GameEnv.Preprod);
expect(ClientEnv.numWorkers()).toBe(4);
expect(ClientEnv.turnstileSiteKey()).toBe("test-key");
expect(ClientEnv.jwtAudience()).toBe("openfront.dev");
expect(ClientEnv.instanceId()).toBe("TEST_ID");
expect(fetchSpy).not.toHaveBeenCalled();
});
test("maps staging builds to the default game logic config", async () => {
process.env.GAME_ENV = "staging";
test("throws when BOOTSTRAP_CONFIG is undefined", () => {
expect(() => ClientEnv.env()).toThrow(/Missing BOOTSTRAP_CONFIG/);
});
expect(getBuildTimeGameLogicEnv()).toBe(GameLogicEnv.Default);
expect(getServerConfigForGameLogicEnv(GameLogicEnv.Default).env()).toBe(
GameEnv.Prod,
);
test("throws when a required field is missing", () => {
window.BOOTSTRAP_CONFIG = {
gameEnv: "dev",
numWorkers: 1,
turnstileSiteKey: "k",
jwtAudience: "localhost",
// instanceId missing
};
expect(() => ClientEnv.instanceId()).toThrow(/Missing BOOTSTRAP_CONFIG/);
});
const config = await getGameLogicConfig({} as any, null);
test("jwtIssuer maps 'localhost' to http://localhost:8787", () => {
window.BOOTSTRAP_CONFIG = {
gameEnv: "dev",
numWorkers: 1,
turnstileSiteKey: "k",
jwtAudience: "localhost",
instanceId: "x",
gitCommit: "DEV",
};
expect(ClientEnv.jwtIssuer()).toBe("http://localhost:8787");
});
expect(config.serverConfig().env()).toBe(GameEnv.Prod);
test("jwtIssuer derives api.<audience> for non-localhost", () => {
window.BOOTSTRAP_CONFIG = {
gameEnv: "prod",
numWorkers: 1,
turnstileSiteKey: "k",
jwtAudience: "openfront.io",
instanceId: "x",
gitCommit: "abc123",
};
expect(ClientEnv.jwtIssuer()).toBe("https://api.openfront.io");
});
});
+4 -11
View File
@@ -1,6 +1,6 @@
import { GameUpdateType } from "src/core/game/GameUpdates";
import { vi, type Mocked } from "vitest";
import { DefaultConfig } from "../../../src/core/configuration/DefaultConfig";
import { Config } from "../../../src/core/configuration/Config";
import { TrainExecution } from "../../../src/core/execution/TrainExecution";
import {
Difficulty,
@@ -16,7 +16,6 @@ import {
import { Cluster, TrainStation } from "../../../src/core/game/TrainStation";
import { UserSettings } from "../../../src/core/game/UserSettings";
import { GameConfig } from "../../../src/core/Schemas";
import { TestServerConfig } from "../../util/TestServerConfig";
vi.mock("../../../src/core/game/Game");
vi.mock("../../../src/core/execution/TrainExecution");
@@ -206,12 +205,11 @@ describe("TrainStation", () => {
});
});
describe("DefaultConfig.trainGold trade stop penalty", () => {
let config: DefaultConfig;
describe("Config.trainGold trade stop penalty", () => {
let config: Config;
let mockPlayer: Player;
beforeEach(() => {
const serverConfig = new TestServerConfig();
const gameConfig: GameConfig = {
gameMap: GameMapType.Asia,
gameMapSize: GameMapSize.Normal,
@@ -228,12 +226,7 @@ describe("DefaultConfig.trainGold trade stop penalty", () => {
disableNavMesh: false,
randomSpawn: false,
};
config = new DefaultConfig(
serverConfig,
gameConfig,
new UserSettings(),
false,
);
config = new Config(gameConfig, new UserSettings(), false);
mockPlayer = { isLobbyCreator: () => false } as unknown as Player;
});
+1 -8
View File
@@ -13,7 +13,6 @@ import { GameMapImpl } from "../../../src/core/game/GameMap";
import { UserSettings } from "../../../src/core/game/UserSettings";
import { GameConfig } from "../../../src/core/Schemas";
import { TestConfig } from "../../util/TestConfig";
import { TestServerConfig } from "../../util/TestServerConfig";
export const W = "W"; // Water
export const L = "L"; // Land
@@ -131,7 +130,6 @@ export function createGame(data: TestMapData): Game {
miniNumLand,
);
const serverConfig = new TestServerConfig();
const gameConfig: GameConfig = {
gameMap: GameMapType.Asia,
gameMapSize: GameMapSize.Normal,
@@ -148,12 +146,7 @@ export function createGame(data: TestMapData): Game {
disableNavMesh: false,
randomSpawn: false,
};
const config = new TestConfig(
serverConfig,
gameConfig,
new UserSettings(),
false,
);
const config = new TestConfig(gameConfig, new UserSettings(), false);
return createGameImpl([], [], gameMap, miniGameMap, config);
}