ui/phase-17: ship-class CRUD without calc

Phase 17 lights up the ship-class table and designer active views,
extends the order-draft pipeline with createShipClass and
removeShipClass commands, and projects pending Save/Delete actions
through applyOrderOverlay so the table reflects the player's
intent before auto-sync lands. The plan is corrected in the same
patch: per game/rules.txt, ship classes are designed once and
cannot be edited — the engine has no Update command, so the UI
exposes only Create + Delete.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Ilia Denisov
2026-05-09 21:44:21 +02:00
parent 8a236bef14
commit 785c3483f8
23 changed files with 2456 additions and 99 deletions
@@ -0,0 +1,262 @@
// Vitest coverage for the Phase 17 ship-class designer. Drives the
// component against a real `OrderDraftStore` (with `fake-indexeddb`
// standing in for the browser's IDB factory) so the local-validation
// + auto-sync side-effects are exercised end-to-end. The optimistic
// overlay arrives through a synthetic `RenderedReportSource` instead
// of a live report so the tests do not have to thread a full
// `GameStateStore` boot.
import "@testing-library/jest-dom/vitest";
import "fake-indexeddb/auto";
import { fireEvent, render, waitFor } from "@testing-library/svelte";
import {
afterEach,
beforeEach,
describe,
expect,
test,
vi,
} from "vitest";
import { i18n } from "../src/lib/i18n/index.svelte";
import type { GameReport, ShipClassSummary } from "../src/api/game-state";
import {
ORDER_DRAFT_CONTEXT_KEY,
OrderDraftStore,
} from "../src/sync/order-draft.svelte";
import { RENDERED_REPORT_CONTEXT_KEY } from "../src/lib/rendered-report.svelte";
import { IDBCache } from "../src/platform/store/idb-cache";
import { openGalaxyDB, type GalaxyDB } from "../src/platform/store/idb";
import type { Cache } from "../src/platform/store/index";
import type { IDBPDatabase } from "idb";
const GAME_ID = "11111111-2222-3333-4444-555555555555";
const pageMock = vi.hoisted(() => ({
url: new URL("http://localhost/games/g1/designer/ship-class"),
params: { id: "g1" } as Record<string, string>,
}));
const gotoMock = vi.hoisted(() => vi.fn());
vi.mock("$app/state", () => ({
page: pageMock,
}));
vi.mock("$app/navigation", () => ({
goto: gotoMock,
}));
import DesignerShipClass from "../src/lib/active-view/designer-ship-class.svelte";
let db: IDBPDatabase<GalaxyDB>;
let dbName: string;
let cache: Cache;
let draft: OrderDraftStore;
beforeEach(async () => {
dbName = `galaxy-designer-${crypto.randomUUID()}`;
db = await openGalaxyDB(dbName);
cache = new IDBCache(db);
draft = new OrderDraftStore();
await draft.init({ cache, gameId: GAME_ID });
i18n.resetForTests("en");
pageMock.params = { id: "g1" };
gotoMock.mockClear();
});
afterEach(async () => {
draft.dispose();
db.close();
await new Promise<void>((resolve) => {
const req = indexedDB.deleteDatabase(dbName);
req.onsuccess = () => resolve();
req.onerror = () => resolve();
req.onblocked = () => resolve();
});
});
function shipClass(
overrides: Partial<ShipClassSummary> & Pick<ShipClassSummary, "name">,
): ShipClassSummary {
return {
drive: 0,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
...overrides,
};
}
function makeReport(localShipClass: ShipClassSummary[] = []): GameReport {
return {
turn: 1,
mapWidth: 1000,
mapHeight: 1000,
planetCount: 0,
planets: [],
race: "",
localShipClass,
routes: [],
localPlayerDrive: 0,
};
}
function mountDesigner(opts: {
classId?: string;
report?: GameReport | null;
}) {
const report = opts.report ?? makeReport();
pageMock.params = opts.classId
? { id: "g1", classId: opts.classId }
: { id: "g1" };
const renderedReport = { get report() { return report; } };
const context = new Map<unknown, unknown>([
[ORDER_DRAFT_CONTEXT_KEY, draft],
[RENDERED_REPORT_CONTEXT_KEY, renderedReport],
]);
return render(DesignerShipClass, { context });
}
describe("ship-class designer (new mode)", () => {
test("renders the form with a Save button disabled by default", () => {
const ui = mountDesigner({});
expect(
ui.getByTestId("active-view-designer-ship-class"),
).toHaveAttribute("data-mode", "new");
expect(ui.getByTestId("designer-ship-class-save")).toBeDisabled();
expect(ui.getByTestId("designer-ship-class-error")).toHaveTextContent(
"name cannot be empty",
);
});
test("Save adds a createShipClass to the draft after a valid edit", async () => {
const ui = mountDesigner({});
const nameInput = ui.getByTestId("designer-ship-class-input-name");
await fireEvent.input(nameInput, { target: { value: "Drone" } });
const driveInput = ui.getByTestId("designer-ship-class-input-drive");
await fireEvent.input(driveInput, { target: { value: "1" } });
await waitFor(() =>
expect(ui.getByTestId("designer-ship-class-save")).not.toBeDisabled(),
);
await fireEvent.click(ui.getByTestId("designer-ship-class-save"));
await waitFor(() => expect(draft.commands).toHaveLength(1));
const cmd = draft.commands[0]!;
if (cmd.kind !== "createShipClass") throw new Error("wrong kind");
expect(cmd.name).toBe("Drone");
expect(cmd.drive).toBe(1);
expect(cmd.armament).toBe(0);
await waitFor(() =>
expect(gotoMock).toHaveBeenCalledWith("/games/g1/table/ship-classes"),
);
});
test("rejects a duplicate name from the overlay before any sync", async () => {
const ui = mountDesigner({
report: makeReport([
shipClass({ name: "Scout", drive: 1 }),
]),
});
await fireEvent.input(
ui.getByTestId("designer-ship-class-input-name"),
{ target: { value: "Scout" } },
);
await fireEvent.input(
ui.getByTestId("designer-ship-class-input-drive"),
{ target: { value: "1" } },
);
await waitFor(() =>
expect(ui.getByTestId("designer-ship-class-error")).toHaveTextContent(
"already exists",
),
);
expect(ui.getByTestId("designer-ship-class-save")).toBeDisabled();
});
test("rejects nonzero armament with zero weapons", async () => {
const ui = mountDesigner({});
await fireEvent.input(
ui.getByTestId("designer-ship-class-input-name"),
{ target: { value: "Bad" } },
);
await fireEvent.input(
ui.getByTestId("designer-ship-class-input-armament"),
{ target: { value: "1" } },
);
await fireEvent.input(
ui.getByTestId("designer-ship-class-input-drive"),
{ target: { value: "1" } },
);
await waitFor(() =>
expect(ui.getByTestId("designer-ship-class-error")).toHaveTextContent(
"armament and weapons must be both zero or both nonzero",
),
);
});
test("Cancel navigates back without mutating the draft", async () => {
const ui = mountDesigner({});
await fireEvent.click(ui.getByTestId("designer-ship-class-cancel"));
expect(draft.commands).toHaveLength(0);
expect(gotoMock).toHaveBeenCalledWith("/games/g1/table/ship-classes");
});
});
describe("ship-class designer (view mode)", () => {
test("renders the read-only summary plus Delete + Back affordances", () => {
const ui = mountDesigner({
classId: "Cruiser",
report: makeReport([
shipClass({
name: "Cruiser",
drive: 15,
armament: 1,
weapons: 15,
shields: 15,
cargo: 0,
}),
]),
});
expect(
ui.getByTestId("active-view-designer-ship-class"),
).toHaveAttribute("data-mode", "view");
expect(ui.getByTestId("designer-ship-class-view-name")).toHaveTextContent(
"Cruiser",
);
expect(ui.getByTestId("designer-ship-class-view-drive")).toHaveTextContent(
"15",
);
expect(
ui.getByTestId("designer-ship-class-view-armament"),
).toHaveTextContent("1");
expect(ui.getByTestId("designer-ship-class-delete")).toBeInTheDocument();
expect(ui.getByTestId("designer-ship-class-back")).toBeInTheDocument();
});
test("Delete adds a removeShipClass and navigates back", async () => {
const ui = mountDesigner({
classId: "Cruiser",
report: makeReport([shipClass({ name: "Cruiser", drive: 15 })]),
});
await fireEvent.click(ui.getByTestId("designer-ship-class-delete"));
await waitFor(() => expect(draft.commands).toHaveLength(1));
const cmd = draft.commands[0]!;
if (cmd.kind !== "removeShipClass") throw new Error("wrong kind");
expect(cmd.name).toBe("Cruiser");
await waitFor(() =>
expect(gotoMock).toHaveBeenCalledWith("/games/g1/table/ship-classes"),
);
});
test("renders a not-found message when the class is missing from the overlay", () => {
const ui = mountDesigner({
classId: "Ghost",
report: makeReport([]),
});
expect(
ui.getByTestId("designer-ship-class-not-found"),
).toHaveTextContent("Ghost");
});
});
+43 -1
View File
@@ -16,6 +16,8 @@ import {
CommandPlanetRename,
CommandPlanetRouteRemove,
CommandPlanetRouteSet,
CommandShipClassCreate,
CommandShipClassRemove,
PlanetProduction,
PlanetRouteLoadType,
UserGamesOrder,
@@ -65,11 +67,28 @@ export interface RemoveCargoRouteResultFixture
loadType: "COL" | "CAP" | "MAT" | "EMP";
}
export interface CreateShipClassResultFixture extends CommandResultFixtureBase {
kind: "createShipClass";
name: string;
drive: number;
armament: number;
weapons: number;
shields: number;
cargo: number;
}
export interface RemoveShipClassResultFixture extends CommandResultFixtureBase {
kind: "removeShipClass";
name: string;
}
export type CommandResultFixture =
| PlanetRenameResultFixture
| SetProductionTypeResultFixture
| SetCargoRouteResultFixture
| RemoveCargoRouteResultFixture;
| RemoveCargoRouteResultFixture
| CreateShipClassResultFixture
| RemoveShipClassResultFixture;
export function buildOrderResponsePayload(
gameId: string,
@@ -173,6 +192,29 @@ function encodeItem(builder: Builder, c: CommandResultFixture): number {
payloadType = CommandPayload.CommandPlanetRouteRemove;
break;
}
case "createShipClass": {
const nameOffset = builder.createString(c.name);
inner = CommandShipClassCreate.createCommandShipClassCreate(
builder,
nameOffset,
c.drive,
BigInt(c.armament),
c.weapons,
c.shields,
c.cargo,
);
payloadType = CommandPayload.CommandShipClassCreate;
break;
}
case "removeShipClass": {
const nameOffset = builder.createString(c.name);
inner = CommandShipClassRemove.createCommandShipClassRemove(
builder,
nameOffset,
);
payloadType = CommandPayload.CommandShipClassRemove;
break;
}
}
CommandItem.startCommandItem(builder);
CommandItem.addCmdId(builder, cmdIdOffset);
@@ -53,6 +53,11 @@ export interface OtherPlanetFixture extends InhabitedFixture {
export interface ShipClassFixture {
name: string;
drive?: number;
armament?: number;
weapons?: number;
shields?: number;
cargo?: number;
}
export interface PlayerFixture {
@@ -165,6 +170,11 @@ export function buildReportPayload(fixture: ReportFixture): Uint8Array {
const name = builder.createString(cls.name);
ShipClass.startShipClass(builder);
ShipClass.addName(builder, name);
ShipClass.addDrive(builder, cls.drive ?? 0);
ShipClass.addArmament(builder, BigInt(cls.armament ?? 0));
ShipClass.addWeapons(builder, cls.weapons ?? 0);
ShipClass.addShields(builder, cls.shields ?? 0);
ShipClass.addCargo(builder, cls.cargo ?? 0);
return ShipClass.endShipClass(builder);
});
+385
View File
@@ -0,0 +1,385 @@
// Phase 17 end-to-end coverage for the ship-class CRUD flow. Boots
// an authenticated session, mocks the gateway with a single local
// planet plus an empty `localShipClass` projection, navigates to
// the ship-classes table, opens the designer, fills the form, and
// asserts that:
//
// 1. Save adds a `createShipClass` row to the local order draft,
// auto-syncs through `user.games.order`, and the new class
// appears in the table immediately (overlay) and in the
// sidebar order tab as `applied`;
// 2. invalid input keeps the Save button disabled and surfaces
// the localised reason;
// 3. Delete on a row adds a `removeShipClass` and the class
// disappears from the table; the order tab reflects both rows;
// 4. a rejected `createShipClass` (engine-side `cmdApplied=false`)
// surfaces as `rejected` in the order tab and the table no
// longer shows the optimistic class.
import { fromJson, type JsonValue } from "@bufbuild/protobuf";
import { expect, test, type Page } from "@playwright/test";
import { ByteBuffer } from "flatbuffers";
import { ExecuteCommandRequestSchema } from "../../src/proto/galaxy/gateway/v1/edge_gateway_pb";
import { UUID } from "../../src/proto/galaxy/fbs/common";
import {
CommandPayload,
CommandShipClassCreate,
CommandShipClassRemove,
UserGamesOrder,
UserGamesOrderGet,
} from "../../src/proto/galaxy/fbs/order";
import { GameReportRequest } from "../../src/proto/galaxy/fbs/report";
import { forgeExecuteCommandResponseJson } from "./fixtures/sign-response";
import {
buildMyGamesListPayload,
type GameFixture,
} from "./fixtures/lobby-fbs";
import {
buildReportPayload,
type ShipClassFixture,
} from "./fixtures/report-fbs";
import {
buildOrderGetResponsePayload,
buildOrderResponsePayload,
type CommandResultFixture,
} from "./fixtures/order-fbs";
const SESSION_ID = "phase-17-ship-class-session";
const GAME_ID = "17171717-1717-1717-1717-171717171717";
interface MockOpts {
createOutcome: "applied" | "rejected";
initialClasses?: ShipClassFixture[];
}
interface MockHandle {
get lastCreate(): {
name: string;
drive: number;
armament: number;
weapons: number;
shields: number;
cargo: number;
} | null;
get lastRemove(): { name: string } | null;
get submittedCount(): number;
}
async function mockGateway(page: Page, opts: MockOpts): Promise<MockHandle> {
const game: GameFixture = {
gameId: GAME_ID,
gameName: "Phase 17 Game",
gameType: "private",
status: "running",
ownerUserId: "user-1",
minPlayers: 2,
maxPlayers: 8,
enrollmentEndsAtMs: BigInt(Date.now() + 86_400_000),
createdAtMs: BigInt(Date.now() - 86_400_000),
updatedAtMs: BigInt(Date.now()),
currentTurn: 1,
};
let storedOrder: CommandResultFixture[] = [];
let lastCreate: MockHandle["lastCreate"] = null;
let lastRemove: MockHandle["lastRemove"] = null;
let submittedCount = 0;
const reportClasses: ShipClassFixture[] = [...(opts.initialClasses ?? [])];
await page.route(
"**/galaxy.gateway.v1.EdgeGateway/ExecuteCommand",
async (route) => {
const reqText = route.request().postData();
if (reqText === null) {
await route.fulfill({ status: 400 });
return;
}
const req = fromJson(
ExecuteCommandRequestSchema,
JSON.parse(reqText) as JsonValue,
);
let resultCode = "ok";
let payload: Uint8Array;
switch (req.messageType) {
case "lobby.my.games.list":
payload = buildMyGamesListPayload([game]);
break;
case "user.games.report": {
GameReportRequest.getRootAsGameReportRequest(
new ByteBuffer(req.payloadBytes),
).gameId(new UUID());
payload = buildReportPayload({
turn: 1,
mapWidth: 4000,
mapHeight: 4000,
race: "Earthlings",
players: [{ name: "Earthlings", drive: 1 }],
localPlanets: [
{
number: 1,
name: "Earth",
x: 1000,
y: 1000,
size: 1000,
resources: 5,
population: 800,
industry: 600,
},
],
localShipClass: reportClasses,
});
break;
}
case "user.games.order": {
const decoded = UserGamesOrder.getRootAsUserGamesOrder(
new ByteBuffer(req.payloadBytes),
);
submittedCount += 1;
const length = decoded.commandsLength();
const fixtures: CommandResultFixture[] = [];
for (let i = 0; i < length; i++) {
const item = decoded.commands(i);
if (item === null) continue;
const cmdId = item.cmdId() ?? "";
const payloadType = item.payloadType();
if (payloadType === CommandPayload.CommandShipClassCreate) {
const inner = new CommandShipClassCreate();
item.payload(inner);
lastCreate = {
name: inner.name() ?? "",
drive: inner.drive(),
armament: Number(inner.armament()),
weapons: inner.weapons(),
shields: inner.shields(),
cargo: inner.cargo(),
};
const applied = opts.createOutcome === "applied";
fixtures.push({
kind: "createShipClass",
cmdId,
name: lastCreate.name,
drive: lastCreate.drive,
armament: lastCreate.armament,
weapons: lastCreate.weapons,
shields: lastCreate.shields,
cargo: lastCreate.cargo,
applied,
errorCode: applied ? null : 1,
});
continue;
}
if (payloadType === CommandPayload.CommandShipClassRemove) {
const inner = new CommandShipClassRemove();
item.payload(inner);
lastRemove = { name: inner.name() ?? "" };
fixtures.push({
kind: "removeShipClass",
cmdId,
name: lastRemove.name,
applied: true,
errorCode: null,
});
continue;
}
}
storedOrder = fixtures;
payload = buildOrderResponsePayload(GAME_ID, fixtures, Date.now());
break;
}
case "user.games.order.get": {
UserGamesOrderGet.getRootAsUserGamesOrderGet(
new ByteBuffer(req.payloadBytes),
);
payload = buildOrderGetResponsePayload(
GAME_ID,
storedOrder,
Date.now(),
storedOrder.length > 0,
);
break;
}
default:
resultCode = "internal_error";
payload = new Uint8Array();
}
const body = await forgeExecuteCommandResponseJson({
requestId: req.requestId,
timestampMs: BigInt(Date.now()),
resultCode,
payloadBytes: payload,
});
await route.fulfill({
status: 200,
contentType: "application/json",
body,
});
},
);
await page.route(
"**/galaxy.gateway.v1.EdgeGateway/SubscribeEvents",
async () => {
await new Promise<void>(() => {});
},
);
return {
get lastCreate() {
return lastCreate;
},
get lastRemove() {
return lastRemove;
},
get submittedCount() {
return submittedCount;
},
};
}
async function bootSession(page: Page): Promise<void> {
await page.goto("/__debug/store");
await expect(page.getByTestId("debug-store-ready")).toBeVisible();
await page.waitForFunction(() => window.__galaxyDebug?.ready === true);
await page.evaluate(() => window.__galaxyDebug!.clearSession());
await page.evaluate(
(id) => window.__galaxyDebug!.setDeviceSessionId(id),
SESSION_ID,
);
await page.evaluate(
(gameId) => window.__galaxyDebug!.clearOrderDraft(gameId),
GAME_ID,
);
}
test("create / list / delete ship class via the table + designer", async ({
page,
}, testInfo) => {
test.skip(
testInfo.project.name.startsWith("chromium-mobile"),
"phase 17 spec covers desktop layout; mobile inherits the same store",
);
const handle = await mockGateway(page, { createOutcome: "applied" });
await bootSession(page);
await page.goto(`/games/${GAME_ID}/table/ship-classes`);
const tableHost = page.getByTestId("active-view-table");
await expect(tableHost).toBeVisible();
await expect(page.getByTestId("ship-classes-empty")).toBeVisible();
await page.getByTestId("ship-classes-new").click();
await expect(page.getByTestId("active-view-designer-ship-class")).toHaveAttribute(
"data-mode",
"new",
);
await page.getByTestId("designer-ship-class-input-name").fill("Drone");
await page.getByTestId("designer-ship-class-input-drive").fill("1");
const save = page.getByTestId("designer-ship-class-save");
await expect(save).toBeEnabled();
await save.click();
// Returns to the table; the optimistic overlay shows the new class.
await expect(page.getByTestId("ship-classes-table")).toBeVisible();
const row = page.getByTestId("ship-classes-row");
await expect(row).toHaveAttribute("data-name", "Drone");
await expect(page.getByTestId("ship-classes-cell-drive")).toHaveText("1");
// The auto-sync round-trip lands as applied.
await page.getByTestId("sidebar-tab-order").click();
const orderTool = page.getByTestId("sidebar-tool-order");
await expect(orderTool.getByTestId("order-command-label-0")).toContainText(
"Drone",
);
await expect(orderTool.getByTestId("order-command-status-0")).toHaveText(
"applied",
);
expect(handle.lastCreate?.name).toBe("Drone");
expect(handle.lastCreate?.drive).toBe(1);
// Delete the class through the table action; the row disappears
// and the order tab gets a second row.
await page.getByTestId("sidebar-tab-inspector").click();
await page.getByTestId("ship-classes-delete").click();
await expect(page.getByTestId("ship-classes-empty")).toBeVisible();
await page.getByTestId("sidebar-tab-order").click();
await expect(orderTool.getByTestId("order-command-label-1")).toContainText(
"Drone",
);
expect(handle.lastRemove?.name).toBe("Drone");
});
test("designer keeps Save disabled while the form is invalid", async ({
page,
}, testInfo) => {
test.skip(
testInfo.project.name.startsWith("chromium-mobile"),
"phase 17 spec covers desktop layout; mobile inherits the same store",
);
await mockGateway(page, { createOutcome: "applied" });
await bootSession(page);
await page.goto(`/games/${GAME_ID}/designer/ship-class`);
const save = page.getByTestId("designer-ship-class-save");
await expect(save).toBeDisabled();
// Empty name surfaces the entity-name error.
await expect(page.getByTestId("designer-ship-class-error")).toHaveText(
"name cannot be empty",
);
// Mismatched armament / weapons triggers the pair rule.
await page.getByTestId("designer-ship-class-input-name").fill("Bad");
await page.getByTestId("designer-ship-class-input-armament").fill("1");
await page.getByTestId("designer-ship-class-input-drive").fill("1");
await expect(page.getByTestId("designer-ship-class-error")).toHaveText(
"armament and weapons must be both zero or both nonzero",
);
await expect(save).toBeDisabled();
// Filling weapons resolves the pair rule.
await page.getByTestId("designer-ship-class-input-weapons").fill("1");
await expect(save).toBeEnabled();
});
test("rejected createShipClass keeps the table empty and surfaces the failure", async ({
page,
}, testInfo) => {
test.skip(
testInfo.project.name.startsWith("chromium-mobile"),
"phase 17 spec covers desktop layout; mobile inherits the same store",
);
await mockGateway(page, { createOutcome: "rejected" });
await bootSession(page);
await page.goto(`/games/${GAME_ID}/designer/ship-class`);
await page.getByTestId("designer-ship-class-input-name").fill("Drone");
await page.getByTestId("designer-ship-class-input-drive").fill("1");
await page.getByTestId("designer-ship-class-save").click();
// Designer's save() calls SvelteKit `goto` to navigate back to
// the table. SPA navigation keeps the per-game `OrderDraftStore`
// alive so the auto-sync round-trip (which flips the status from
// `submitting` to `rejected`) lands while the table is showing.
// Order tab carries a `rejected` row; the optimistic overlay
// drops the class once the engine answers `cmdApplied=false`.
await page.getByTestId("sidebar-tab-order").click();
const orderTool = page.getByTestId("sidebar-tool-order");
await expect(orderTool.getByTestId("order-command-status-0")).toHaveText(
"rejected",
);
await expect(orderTool.getByTestId("order-sync")).toHaveAttribute(
"data-sync-status",
"error",
);
// Switch sidebar back to inspector so the active-view (table)
// regains focus, and assert the optimistic class is gone.
await page.getByTestId("sidebar-tab-inspector").click();
await expect(page.getByTestId("ship-classes-empty")).toBeVisible();
});
+20 -20
View File
@@ -1,9 +1,13 @@
// Component tests for every Phase 10 active-view stub. Each stub
// renders the localised view title plus the `coming soon` body copy
// and exposes a stable `data-testid` so later phases can replace the
// content without renaming the test hook. The table stub additionally
// honours its `entity` prop and falls back to the snake_case i18n key
// for an unknown slug.
// Component tests for the remaining Phase 10 active-view stubs. Each
// stub renders the localised view title plus the `coming soon` body
// copy and exposes a stable `data-testid` so later phases can replace
// the content without renaming the test hook. Phase 17 lit up the
// ship-classes table and the ship-class designer, so the assertions
// for those slugs / components moved to the dedicated suites
// (`table-ship-classes.test.ts`, `designer-ship-class.test.ts`); the
// `table.svelte` router still falls back to the stub for the
// not-yet-implemented entities (planets, ship-groups, fleets,
// sciences, races) and that fallback is exercised here.
import "@testing-library/jest-dom/vitest";
import { render } from "@testing-library/svelte";
@@ -16,7 +20,6 @@ import TableView from "../src/lib/active-view/table.svelte";
import ReportView from "../src/lib/active-view/report.svelte";
import BattleView from "../src/lib/active-view/battle.svelte";
import MailView from "../src/lib/active-view/mail.svelte";
import DesignerShipClass from "../src/lib/active-view/designer-ship-class.svelte";
import DesignerScience from "../src/lib/active-view/designer-science.svelte";
beforeEach(() => {
@@ -38,20 +41,22 @@ describe("active-view stubs", () => {
expect(ui.getByTestId("map-canvas-wrap")).toBeInTheDocument();
});
test("table stub maps a kebab-case entity to the right i18n title", () => {
const ui = render(TableView, { props: { entity: "ship-classes" } });
test("table stub falls back for not-yet-implemented entities", () => {
const ui = render(TableView, { props: { entity: "planets" } });
const node = ui.getByTestId("active-view-table");
expect(node).toHaveAttribute("data-entity", "ship-classes");
expect(node).toHaveTextContent("ship classes");
expect(node).toHaveAttribute("data-entity", "planets");
expect(node).toHaveTextContent("planets");
expect(node).toHaveTextContent("coming soon");
});
test("table stub also handles a single-word entity", () => {
const ui = render(TableView, { props: { entity: "planets" } });
expect(ui.getByTestId("active-view-table")).toHaveTextContent("planets");
test("table stub also handles multi-word entities", () => {
const ui = render(TableView, { props: { entity: "ship-groups" } });
const node = ui.getByTestId("active-view-table");
expect(node).toHaveAttribute("data-entity", "ship-groups");
expect(node).toHaveTextContent("ship groups");
});
test("report / mail / designer stubs render their localised titles", () => {
test("report / mail / designer-science stubs render their localised titles", () => {
const r = render(ReportView);
expect(r.getByTestId("active-view-report")).toHaveTextContent(
"turn report",
@@ -62,11 +67,6 @@ describe("active-view stubs", () => {
"diplomatic mail",
);
const sc = render(DesignerShipClass);
expect(
sc.getByTestId("active-view-designer-ship-class"),
).toHaveTextContent("ship-class designer");
const sci = render(DesignerScience);
expect(
sci.getByTestId("active-view-designer-science"),
+43 -5
View File
@@ -98,12 +98,21 @@ interface PlanetFixture {
y: number;
}
interface ShipClassFixture {
name: string;
drive?: number;
armament?: number;
weapons?: number;
shields?: number;
cargo?: number;
}
function buildReportPayload(opts: {
turn: number;
width?: number;
height?: number;
planets?: PlanetFixture[];
shipClasses?: { name: string }[];
shipClasses?: ShipClassFixture[];
}): Uint8Array {
const builder = new Builder(256);
const planetOffsets = (opts.planets ?? []).map((planet) => {
@@ -121,6 +130,11 @@ function buildReportPayload(opts: {
const name = builder.createString(cls.name);
ShipClass.startShipClass(builder);
ShipClass.addName(builder, name);
ShipClass.addDrive(builder, cls.drive ?? 0);
ShipClass.addArmament(builder, BigInt(cls.armament ?? 0));
ShipClass.addWeapons(builder, cls.weapons ?? 0);
ShipClass.addShields(builder, cls.shields ?? 0);
ShipClass.addCargo(builder, cls.cargo ?? 0);
return ShipClass.endShipClass(builder);
});
const localPlanetVec =
@@ -277,21 +291,45 @@ describe("GameStateStore", () => {
expect(store.error).toBe("device session missing");
});
test("decodeReport surfaces the localShipClass projection by name", async () => {
test("decodeReport surfaces the localShipClass projection with full attributes", async () => {
listMyGamesSpy.mockResolvedValue([makeGameSummary(1)]);
const client = makeFakeClient(async () => ({
resultCode: "ok",
payloadBytes: buildReportPayload({
turn: 1,
planets: [{ number: 1, name: "Earth", x: 100, y: 100 }],
shipClasses: [{ name: "Scout" }, { name: "Destroyer" }],
shipClasses: [
{
name: "Scout",
drive: 1,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
},
{
name: "Destroyer",
drive: 6,
armament: 1,
weapons: 8,
shields: 4,
cargo: 0,
},
],
}),
}));
const store = new GameStateStore();
await store.init({ client, cache, gameId: GAME_ID });
expect(store.report?.localShipClass).toEqual([
{ name: "Scout" },
{ name: "Destroyer" },
{ name: "Scout", drive: 1, armament: 0, weapons: 0, shields: 0, cargo: 0 },
{
name: "Destroyer",
drive: 6,
armament: 1,
weapons: 8,
shields: 4,
cargo: 0,
},
]);
store.dispose();
});
@@ -78,6 +78,19 @@ function localPlanet(
};
}
function shipClass(
overrides: Partial<ShipClassSummary> & Pick<ShipClassSummary, "name">,
): ShipClassSummary {
return {
drive: 0,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
...overrides,
};
}
function mountProduction(
planet: ReportPlanet,
localShipClass: ShipClassSummary[] = [],
@@ -167,8 +180,8 @@ describe("planet inspector — production controls", () => {
test("Build-Ship click on a class emits a SHIP setProductionType command", async () => {
const ui = mountProduction(localPlanet({ number: 7 }), [
{ name: "Scout" },
{ name: "Destroyer" },
shipClass({ name: "Scout" }),
shipClass({ name: "Destroyer" }),
]);
await fireEvent.click(
ui.getByTestId("inspector-planet-production-segment-ship"),
@@ -185,7 +198,7 @@ describe("planet inspector — production controls", () => {
test("re-clicks on the same planet collapse to the latest entry via the store", async () => {
const ui = mountProduction(localPlanet({ number: 7 }), [
{ name: "Scout" },
shipClass({ name: "Scout" }),
]);
await fireEvent.click(
ui.getByTestId("inspector-planet-production-segment-industry"),
@@ -224,7 +237,7 @@ describe("planet inspector — production controls", () => {
for (const tc of cases) {
const ui = mountProduction(
localPlanet({ number: 1, production: tc.production }),
[{ name: "Scout" }],
[shipClass({ name: "Scout" })],
);
const ids: ReadonlyArray<
"industry" | "materials" | "research" | "ship"
@@ -268,7 +281,7 @@ describe("planet inspector — production controls", () => {
test("ship class sub-row matches when production equals a class name", async () => {
const ui = mountProduction(
localPlanet({ number: 1, production: "Scout" }),
[{ name: "Scout" }, { name: "Destroyer" }],
[shipClass({ name: "Scout" }), shipClass({ name: "Destroyer" })],
);
expect(
ui.getByTestId("inspector-planet-production-ship-Scout").classList
@@ -0,0 +1,193 @@
// Vitest coverage for `lib/util/ship-class-validation.ts`. The
// validator is a TS port of `pkg/calc/validator.go` plus the
// `validateEntityName` rules and a UX-only duplicate-name check.
// Each branch is exercised explicitly so a future engine
// validator change cannot drift silently.
import { describe, expect, test } from "vitest";
import {
validateShipClass,
type ShipClassDraft,
} from "../src/lib/util/ship-class-validation";
function draft(overrides: Partial<ShipClassDraft>): ShipClassDraft {
return {
name: "Scout",
drive: 1,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
...overrides,
};
}
describe("validateShipClass", () => {
test("accepts a minimal valid drone-style class", () => {
const result = validateShipClass(
draft({ name: "Drone", drive: 1, armament: 0, weapons: 0 }),
);
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(result.value.name).toBe("Drone");
});
test("trims surrounding whitespace from the name", () => {
const result = validateShipClass(draft({ name: " Scout " }));
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(result.value.name).toBe("Scout");
});
test("rejects empty name", () => {
const result = validateShipClass(draft({ name: "" }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("empty");
});
test("rejects name longer than 30 runes", () => {
const result = validateShipClass(draft({ name: "a".repeat(31) }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("too_long");
});
test("rejects name with whitespace inside", () => {
const result = validateShipClass(draft({ name: "Big Ship" }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("whitespace");
});
test.each([
{ value: 0.5, reason: "drive_value" as const, field: "drive" as const },
{ value: -1, reason: "drive_value" as const, field: "drive" as const },
{
value: Number.POSITIVE_INFINITY,
reason: "drive_value" as const,
field: "drive" as const,
},
{ value: 0.5, reason: "weapons_value" as const, field: "weapons" as const },
{ value: 0.5, reason: "shields_value" as const, field: "shields" as const },
{ value: 0.5, reason: "cargo_value" as const, field: "cargo" as const },
])(
"rejects $field = $value with reason $reason",
({ value, reason, field }) => {
// Make sure both armament/weapons stay coupled (both nonzero or both zero) so we
// trip the per-field rule before the pair rule kicks in.
const overrides: Partial<ShipClassDraft> = {
drive: 1,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
};
if (field === "weapons") {
overrides.armament = 1;
}
(overrides as Record<typeof field, number>)[field] = value;
const result = validateShipClass(draft(overrides));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe(reason);
},
);
test("rejects negative armament", () => {
const result = validateShipClass(draft({ armament: -1 }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("armament_value");
});
test("rejects fractional armament", () => {
const result = validateShipClass(draft({ armament: 1.5, weapons: 1 }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("armament_not_integer");
});
test("rejects nonzero armament with zero weapons", () => {
const result = validateShipClass(draft({ armament: 2, weapons: 0 }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("armament_weapons_pair");
});
test("rejects zero armament with nonzero weapons", () => {
const result = validateShipClass(draft({ armament: 0, weapons: 5 }));
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("armament_weapons_pair");
});
test("rejects all-zero values", () => {
const result = validateShipClass(
draft({
drive: 0,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
}),
);
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("all_zero");
});
test("accepts the canonical Cruiser fixture from rules.txt", () => {
const result = validateShipClass(
draft({
name: "Cruiser",
drive: 15,
armament: 1,
weapons: 15,
shields: 15,
cargo: 0,
}),
);
expect(result.ok).toBe(true);
});
test("accepts the canonical Megafreighter fixture", () => {
const result = validateShipClass(
draft({
name: "Megafreighter",
drive: 80,
armament: 2,
weapons: 2,
shields: 30,
cargo: 100,
}),
);
expect(result.ok).toBe(true);
});
test("flags duplicate names against existingNames", () => {
const result = validateShipClass(draft({ name: "Scout" }), {
existingNames: ["Scout", "Destroyer"],
});
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("duplicate_name");
});
test("compares duplicate names after trimming", () => {
const result = validateShipClass(draft({ name: " Scout " }), {
existingNames: ["Scout"],
});
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.reason).toBe("duplicate_name");
});
test("does not flag duplicates when existingNames is empty", () => {
const result = validateShipClass(draft({ name: "Scout" }), {
existingNames: [],
});
expect(result.ok).toBe(true);
});
});
@@ -0,0 +1,210 @@
// Vitest coverage for the Phase 17 ship-classes table active view.
// The component renders against a synthetic `RenderedReportSource`
// (so the suite does not need a live `GameStateStore`) and a real
// `OrderDraftStore` (so the per-row Delete affordance exercises
// the `removeShipClass` add path including persistence).
import "@testing-library/jest-dom/vitest";
import "fake-indexeddb/auto";
import { fireEvent, render, waitFor } from "@testing-library/svelte";
import {
afterEach,
beforeEach,
describe,
expect,
test,
vi,
} from "vitest";
import { i18n } from "../src/lib/i18n/index.svelte";
import type { GameReport, ShipClassSummary } from "../src/api/game-state";
import {
ORDER_DRAFT_CONTEXT_KEY,
OrderDraftStore,
} from "../src/sync/order-draft.svelte";
import { RENDERED_REPORT_CONTEXT_KEY } from "../src/lib/rendered-report.svelte";
import { IDBCache } from "../src/platform/store/idb-cache";
import { openGalaxyDB, type GalaxyDB } from "../src/platform/store/idb";
import type { Cache } from "../src/platform/store/index";
import type { IDBPDatabase } from "idb";
const GAME_ID = "11111111-2222-3333-4444-555555555555";
const pageMock = vi.hoisted(() => ({
url: new URL("http://localhost/games/g1/table/ship-classes"),
params: { id: "g1" } as Record<string, string>,
}));
const gotoMock = vi.hoisted(() => vi.fn());
vi.mock("$app/state", () => ({
page: pageMock,
}));
vi.mock("$app/navigation", () => ({
goto: gotoMock,
}));
import TableShipClasses from "../src/lib/active-view/table-ship-classes.svelte";
let db: IDBPDatabase<GalaxyDB>;
let dbName: string;
let cache: Cache;
let draft: OrderDraftStore;
beforeEach(async () => {
dbName = `galaxy-table-ship-classes-${crypto.randomUUID()}`;
db = await openGalaxyDB(dbName);
cache = new IDBCache(db);
draft = new OrderDraftStore();
await draft.init({ cache, gameId: GAME_ID });
i18n.resetForTests("en");
pageMock.params = { id: "g1" };
gotoMock.mockClear();
});
afterEach(async () => {
draft.dispose();
db.close();
await new Promise<void>((resolve) => {
const req = indexedDB.deleteDatabase(dbName);
req.onsuccess = () => resolve();
req.onerror = () => resolve();
req.onblocked = () => resolve();
});
});
function shipClass(
overrides: Partial<ShipClassSummary> & Pick<ShipClassSummary, "name">,
): ShipClassSummary {
return {
drive: 0,
armament: 0,
weapons: 0,
shields: 0,
cargo: 0,
...overrides,
};
}
function makeReport(localShipClass: ShipClassSummary[]): GameReport {
return {
turn: 1,
mapWidth: 1000,
mapHeight: 1000,
planetCount: 0,
planets: [],
race: "",
localShipClass,
routes: [],
localPlayerDrive: 0,
};
}
function mountTable(report: GameReport | null) {
const renderedReport = { get report() { return report; } };
const context = new Map<unknown, unknown>([
[ORDER_DRAFT_CONTEXT_KEY, draft],
[RENDERED_REPORT_CONTEXT_KEY, renderedReport],
]);
return render(TableShipClasses, { context });
}
describe("ship-classes table", () => {
test("renders a loading placeholder before the report lands", () => {
const ui = mountTable(null);
expect(ui.getByTestId("ship-classes-loading")).toBeInTheDocument();
});
test("renders an empty placeholder when no classes are designed", () => {
const ui = mountTable(makeReport([]));
expect(ui.getByTestId("ship-classes-empty")).toBeInTheDocument();
});
test("renders one row per ship class with full attributes", () => {
const ui = mountTable(
makeReport([
shipClass({
name: "Cruiser",
drive: 15,
armament: 1,
weapons: 15,
shields: 15,
cargo: 0,
}),
]),
);
const rows = ui.getAllByTestId("ship-classes-row");
expect(rows).toHaveLength(1);
expect(rows[0]).toHaveAttribute("data-name", "Cruiser");
expect(ui.getByTestId("ship-classes-cell-drive")).toHaveTextContent("15");
expect(ui.getByTestId("ship-classes-cell-armament")).toHaveTextContent("1");
});
test("filters rows by case-insensitive name match", async () => {
const ui = mountTable(
makeReport([
shipClass({ name: "Drone", drive: 1 }),
shipClass({ name: "Cruiser", drive: 15, armament: 1, weapons: 15 }),
]),
);
await fireEvent.input(ui.getByTestId("ship-classes-filter"), {
target: { value: "cru" },
});
const rows = ui.getAllByTestId("ship-classes-row");
expect(rows).toHaveLength(1);
expect(rows[0]).toHaveAttribute("data-name", "Cruiser");
});
test("toggles sort direction when the same column is clicked twice", async () => {
const ui = mountTable(
makeReport([
shipClass({ name: "Drone", drive: 1 }),
shipClass({
name: "Cruiser",
drive: 15,
armament: 1,
weapons: 15,
shields: 15,
}),
shipClass({ name: "Battleship", drive: 25 }),
]),
);
const driveHeader = ui.getByTestId("ship-classes-column-drive");
await fireEvent.click(driveHeader);
let names = ui
.getAllByTestId("ship-classes-row")
.map((row) => row.getAttribute("data-name"));
expect(names).toEqual(["Drone", "Cruiser", "Battleship"]);
await fireEvent.click(driveHeader);
names = ui
.getAllByTestId("ship-classes-row")
.map((row) => row.getAttribute("data-name"));
expect(names).toEqual(["Battleship", "Cruiser", "Drone"]);
});
test("dblclick on a row navigates to the designer for that class", async () => {
const ui = mountTable(
makeReport([shipClass({ name: "Drone", drive: 1 })]),
);
await fireEvent.dblClick(ui.getByTestId("ship-classes-row"));
expect(gotoMock).toHaveBeenCalledWith("/games/g1/designer/ship-class/Drone");
});
test("delete button adds a removeShipClass to the draft", async () => {
const ui = mountTable(
makeReport([shipClass({ name: "Drone", drive: 1 })]),
);
await fireEvent.click(ui.getByTestId("ship-classes-delete"));
await waitFor(() => expect(draft.commands).toHaveLength(1));
const cmd = draft.commands[0]!;
if (cmd.kind !== "removeShipClass") throw new Error("wrong kind");
expect(cmd.name).toBe("Drone");
});
test("new button navigates to the empty designer", async () => {
const ui = mountTable(makeReport([]));
await fireEvent.click(ui.getByTestId("ship-classes-new"));
expect(gotoMock).toHaveBeenCalledWith("/games/g1/designer/ship-class");
});
});