mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-07-10 17:44:36 +00:00
Evan Pelle
a7f992e9b0
Restructure the single src/ tree into an npm-workspaces monorepo under
packages/, rename core -> engine, extract a types-only core-public layer,
and break the pre-existing engine -> client dependency cycle.
Structure (packages/):
core-public public API/wire schemas + shared enums (clean leaf)
shared framework-agnostic helpers (clean leaf)
engine deterministic simulation (was src/core)
client rendering/UI (was src/client)
server coordination (was src/server)
Dependency DAG: engine -> {core-public, shared}; client -> {core-public,
shared, engine}; server -> {core-public, engine}.
- npm workspaces: root package.json workspaces + per-package package.json;
tsconfig.base.json holds shared options + path aliases
(core-public/* shared/* engine/* client/* server/*) resolved uniformly by
tsc, Vite (resolve.tsconfigPaths), Vitest, and tsx. Lockfile regenerated.
- core-public: moved Schemas/ApiSchemas/CosmeticSchemas/StatsSchemas/
ClanApiSchemas/WorkerSchemas/Base64/PatternDecoder; extracted the enums
(GameTypes), GameEvent type, emoji table, and GraphicsOverrides schema.
Engine re-exports the moved enums/types so existing imports keep working.
- Broke engine -> client cycle:
- renderNumber/renderTroops -> shared/format
- NameBoxCalculator moved into engine
- username validation returns translation key + params; client translates
- applyStateUpdate moved to client (operates on the render-only PlayerState)
- Config/UnitGrid/execution-Util/GameImpl now use structural read
interfaces (engine/game/ReadViews: PlayerLike/UnitLike/GameLike) instead
of importing client view classes; client imports view classes from a new
client/view barrel; deleted the engine/game/GameView re-export shim.
- Build/deploy updated: vite.config, index.html, eslint, Dockerfile
(copies packages/ + tsconfig.base.json before npm ci), .vscode, tests.
Verified: tsc --noEmit clean; 1364 + 65 tests pass; production vite build
succeeds; engine has zero client/server imports; core-public and shared are
dependency leaves.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
88 lines
2.7 KiB
TypeScript
88 lines
2.7 KiB
TypeScript
import { ClientEnv } from "client/ClientEnv";
|
|
import { beforeEach, describe, expect, test, vi } from "vitest";
|
|
import { GameEnv, parseGameEnv } from "engine/configuration/Config";
|
|
|
|
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;
|
|
ClientEnv.reset();
|
|
});
|
|
|
|
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");
|
|
|
|
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("throws when BOOTSTRAP_CONFIG is undefined", () => {
|
|
expect(() => ClientEnv.env()).toThrow(/Missing BOOTSTRAP_CONFIG/);
|
|
});
|
|
|
|
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/);
|
|
});
|
|
|
|
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");
|
|
});
|
|
|
|
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");
|
|
});
|
|
});
|