BlueGit

timfa questward

Files

questward / server / tests / gifts.test.js

gifts.test.js

gifts.test.js 6.7 KiB Download Raw
1import test from "node:test";
2import assert from "node:assert/strict";
3import {
4 validateCharacterNamePart,
5 validateCharacterNames,
6 RESERVED_ADMIN_SURNAME
7} from "../../shared/characters/names.js";
8import {
9 formatGiftLetterBody,
10 QUESTWARD_GIFT_AUTHOR,
11 QUESTWARD_GIFT_ORG
12} from "../../shared/courier/giftLetters.js";
13import { giftItemOrigin } from "../../shared/courier/giftOrigin.js";
14import { formatLetterSignature } from "../../shared/courier/systemLetters.js";
15import { ItemId } from "../../shared/definitions/items.js";
16import { CraftingItemId } from "../../shared/definitions/craftingItems.js";
17import { originLabel, ItemOriginKind, CraftOriginVerb, GatherOriginVerb } from "../../shared/items/origin.js";
18import { BlockType } from "../../shared/definitions/tiles.js";
19import { createEmptyChunkData, encodeChunkBlob, decodeChunkBlob } from "../src/world/chunkData.js";
20import { GiftService } from "../src/gifts/service.js";
21import { makeCharacter, makeSimulation, stepTimes } from "./helpers/simulationHarness.js";
22
23function placeBank (worldDb, tileX, tileY)
24{
25 const chunkX = Math.floor(tileX / 16);
26 const chunkY = Math.floor(tileY / 16);
27 const localX = ((tileX % 16) + 16) % 16;
28 const localY = ((tileY % 16) + 16) % 16;
29 const revisionId = worldDb.getActiveRevisionId();
30 const row = worldDb.getChunkVersion(chunkX, chunkY, revisionId);
31 const data = row
32 ? decodeChunkBlob(row.data_blob, undefined, chunkX, chunkY)
33 : createEmptyChunkData();
34 data.open = true;
35 data.blocks[localY * 16 + localX] = { typeId: BlockType.bank, state: 0 };
36 worldDb.saveChunkVersion(chunkX, chunkY, revisionId, true, encodeChunkBlob(data));
37}
38
39test("character names allow letters and hyphens only", () =>
40{
41 assert.equal(validateCharacterNamePart("Anne-Marie").ok, true);
42 assert.equal(validateCharacterNamePart("Bob").ok, true);
43 assert.equal(validateCharacterNamePart("Bob Smith").ok, false);
44 assert.equal(validateCharacterNamePart("Bob2").ok, false);
45 assert.equal(validateCharacterNamePart("O'Brien").ok, false);
46 assert.equal(validateCharacterNamePart("---").ok, false);
47});
48
49test("Questward surname is admin-only", () =>
50{
51 const denied = validateCharacterNames({
52 firstName: "John",
53 lastName: "Questward",
54 isAdmin: false
55 });
56 assert.equal(denied.ok, false);
57 const allowed = validateCharacterNames({
58 firstName: "John",
59 lastName: RESERVED_ADMIN_SURNAME,
60 isAdmin: true
61 });
62 assert.equal(allowed.ok, true);
63 assert.equal(allowed.lastName, RESERVED_ADMIN_SURNAME);
64});
65
66test("gift letter body and signature match Questward CEO format", () =>
67{
68 const body = formatGiftLetterBody({
69 characterDisplayName: "Tim Falken",
70 message: "Enjoy these supplies.",
71 items: [{ displayName: "Stick", quantity: 3 }]
72 });
73 assert.match(body, /^Dear Tim Falken\n/);
74 assert.match(body, /Enjoy these supplies\./);
75 assert.match(body, /• 3× Stick/);
76 assert.match(body, /Thank you for playing Questward\./);
77 assert.equal(
78 formatLetterSignature({
79 authorDisplayName: QUESTWARD_GIFT_AUTHOR,
80 authorOrganization: QUESTWARD_GIFT_ORG
81 }),
82 "Signed:\nJohn Questward\nCEO of Questward"
83 );
84
85 const noMessage = formatGiftLetterBody({
86 characterDisplayName: "Tim Falken",
87 message: " ",
88 items: [{ displayName: "Stick", quantity: 1 }]
89 });
90 assert.equal(
91 noMessage,
92 [
93 "Dear Tim Falken",
94 "",
95 "The following items were added to your bank:",
96 "• 1× Stick",
97 "",
98 "Thank you for playing Questward."
99 ].join("\n")
100 );
101});
102
103test("gift item origins use natural verbs with John Questward", () =>
104{
105 assert.equal(
106 originLabel(giftItemOrigin(ItemId.stick)),
107 "Carved by John Questward"
108 );
109 assert.equal(
110 originLabel(giftItemOrigin(CraftingItemId.copperOre)),
111 "Mined by John Questward"
112 );
113 const made = giftItemOrigin(ItemId.letter);
114 assert.equal(made.kind, ItemOriginKind.crafted);
115 assert.equal(made.displayName, QUESTWARD_GIFT_AUTHOR);
116 assert.equal(made.verb, CraftOriginVerb.made);
117 assert.equal(giftItemOrigin(CraftingItemId.copperOre).verb, GatherOriginVerb.mined);
118});
119
120test("admin gift credits bank and queues a system letter", () =>
121{
122 const harness = makeSimulation({ workerCount: 1 });
123 try
124 {
125 placeBank(harness.worldDb, 8, 8);
126 harness.simulation.courier.refreshBankIndex();
127 harness.simulation.applySettings({
128 pigeonTakeoffTilesPerSec: 40,
129 pigeonCruiseTilesPerSec: 40,
130 pigeonLandingTilesPerSec: 40,
131 simulationTickHz: 20
132 });
133
134 const character = makeCharacter(harness.stateDb, {
135 tileX: 8,
136 tileY: 8,
137 firstName: "Gift",
138 lastName: "Target"
139 });
140 const gifts = new GiftService(harness.stateDb, harness.simulation);
141 const before = harness.stateDb.getBag(character.character_id);
142 const stickBefore = (before.vault ?? []).reduce(
143 (sum, slot) => sum + (slot?.itemId === ItemId.stick ? (slot.quantity | 0) : 0),
144 0
145 );
146
147 const result = gifts.sendGift({
148 characterId: character.character_id,
149 message: "A small thank-you.",
150 items: [{ itemId: ItemId.stick, quantity: 5 }]
151 });
152 assert.equal(result.ok, true);
153
154 const after = harness.stateDb.getBag(character.character_id);
155 const stickStack = (after.vault ?? []).find((slot) => slot?.itemId === ItemId.stick);
156 assert.equal(stickStack?.quantity, stickBefore + 5);
157 assert.equal(
158 originLabel(stickStack?.origins?.[0]?.origin),
159 "Carved by John Questward"
160 );
161 assert.equal(
162 (after.vault ?? []).some((slot) => slot?.itemId === ItemId.letter),
163 false,
164 "gift letter must not be deposited in the bank"
165 );
166
167 const held = harness.stateDb.listHeldCourierDeliveries(character.character_id);
168 const giftHold = held.find((row) =>
169 row.cargo?.stack?.instance?.authorDisplayName === QUESTWARD_GIFT_AUTHOR
170 );
171 assert.ok(giftHold, "expected a held gift letter for the offline character");
172 assert.equal(giftHold.destinationKind, "player");
173
174 const entityId = harness.simulation.spawnCharacter(1, character);
175 const active = harness.stateDb.listActiveCourierTransits();
176 assert.equal(active.length, 1);
177 assert.equal(active[0].destinationKind, "player");
178 assert.equal(active[0].cargo.stack.instance.authorDisplayName, QUESTWARD_GIFT_AUTHOR);
179
180 const events = stepTimes(harness.simulation, 40);
181
182 const bag = harness.simulation.bagOf(entityId);
183 const letter = (bag.inventory ?? []).find((slot) => slot?.itemId === ItemId.letter);
184 assert.ok(letter, "gift letter should arrive in inventory via pigeon");
185 assert.equal(letter.instance.authorDisplayName, QUESTWARD_GIFT_AUTHOR);
186 assert.equal(letter.instance.authorOrganization, QUESTWARD_GIFT_ORG);
187 assert.match(letter.instance.body, /A small thank-you/);
188 assert.ok(events.some((event) =>
189 event.type === "item-bubble"
190 && event.entityId === entityId
191 && event.itemId === ItemId.letter
192 ));
193 assert.equal(
194 (harness.stateDb.getBag(character.character_id).vault ?? [])
195 .some((slot) => slot?.itemId === ItemId.letter),
196 false
197 );
198 }
199 finally
200 { harness.close(); }
201});