Files
Emberfall/HANDOFF.md
T
2026-10-21 11:45:36 +11:00

6.9 KiB
Raw Blame History

HANDOFF.md — Session Handoff (OVERWRITE at the end of every phase or when context is getting long)

Read order for a new session: NOTES.md → STATUS.md → this file → then work. If this file disagrees with the code, trust the code and fix this file.

1. Where we are

  • Last completed step: 9.6 (Update README with real run instructions) — TICKED in STATUS.md
  • Next step: Phase 9 is complete. Ready to start Stretch Goals (S1–S7) or address Known Issues from STATUS.md.
  • Updated: 2026-10-21
  • Was the last session cut off mid-task? No

2. Verified state (run these first)

Command Expected
npm install succeeds
npm run migrate applies 001–006 / "nothing to do"
npm test 176 passing, 0 failing (85 unit + 91 integration incl. 1 e2e)
npm run seed:dev creates demo user "demo"/"demo123", hero "Aldric" (warrior), starter gear
npm start + curl localhost:3000/api/health {"ok":true}

3. What exists now (files that matter)

  • public/game.html — Dashboard with 3-col grid (stats | action | combat), mobile bottom nav (⚔️ Hunt / 🏕️ Trip / 🎒 Items), tabbed action area.
  • public/js/game.js — hunt UI + inventory UI + expedition UI + mobile nav init (DOMContentLoaded); uses shared toast.js.
  • public/css/main.css — All styles including 3-col desktop grid, mobile bottom nav (< 700px), stacked panels on mobile, spinner, toast, button loading states.
  • public/404.html — Custom 404 error page.
  • public/500.html — Custom 500 error page.
  • public/js/toast.js — Shared toast notification system.
  • public/shop.html / public/js/shop.js — Shop page (buy/sell).
  • public/login.html, public/register.html, public/create-hero.html — Auth & hero creation.
  • public/profile.html / public/js/profile.js — Public hero profile page.
  • public/js/auth.js — Shared API wrapper + showError.
  • scripts/seed-dev.js — Creates demo account + hero + starter gear.
  • src/app.js — Express app with helmet, rate limiters, catch-all 404, 500 HTML serving.
  • src/services/* — All game services.
  • src/routes/* — All route handlers.
  • src/game/* — Pure game logic.
  • tests/integration/*.test.js — 91 integration tests (incl. e2e-playable.test.js).
  • tests/unit/*.test.js — 85 unit tests.
  • README.md — Updated with real run instructions, play-through steps, project structure, known issues.

4. Half-finished / fragile things

  • No leaderboard UI yet (Phase 8 API done but no UI).
  • HP never regenerates naturally; only level-up restores it.
  • No restart-persistence test for sessions.
  • npm run seed script in package.json points to nonexistent scripts/seed.js.
  • Equipment bonuses not yet passed into combat (Issue #5 in STATUS.md).
  • Starter gear documented but not auto-created on character creation.
  • GET /api/zones documented in API.md but not implemented (Issue #2).
  • Mobile nav uses emoji icons (⚔️ 🏕️ 🎒) — verify they render acceptably on all platforms.

5. Decisions & deviations from the docs

  • D-004..D-007 in docs/DECISIONS.md (combat rounds, equipment counted once, session store, clock).
  • D-014: Mobile bottom nav uses emoji icons (⚔️ Hunt / 🏕️ Trip / 🎒 Items) instead of full text labels to save horizontal space on narrow screens.
  • D-015: Desktop tabs hidden via CSS (display: none) below 700px; mobile nav shown via CSS; JS syncMobileNav() keeps active state in sync.
  • Zod query param parsing uses zod.coerce.number() because Express query params are strings.
  • Inventory response uses itemId (item.id) and inventoryId (inventory row id) to avoid confusion.
  • Consumable effect parsing: regex ^(heal|energy):(\d+)$ on items.effect field.
  • Qty decrement avoids CHECK constraint violation: delete directly when qty==1, decrement when qty>1.
  • D-008..D-013 from previous steps.

6. Gotchas learned

  • npm test must be node --test with NO path/glob; files must be named *.test.js.
  • better-sqlite3-session-store ignores expired.clear: false; that's why the timer is unref'd.
  • Statement caches are per-DB-handle (WeakMap) in huntService; copy that pattern for new services.
  • Verify test COUNT, not just "all passing".
  • Node.js fetch doesn't persist cookies across calls — extract Set-Cookie header and pass manually in integration tests.
  • SQL SELECT id from inventory returns the auto-increment row id; rename with AS inventory_id when you also need item_id.
  • Transaction callback args must match the call order exactly.
  • Error responses from route-level AppErrors do NOT include data field.
  • setNow affects ALL now() calls including those in service logic.
  • Shop API returns { ok: true, data: { stock: [...], character: {...} } } — field is stock, not stocks.
  • Shop stock items have flat fields (itemId, buyPrice), not nested (item.id).
  • New characters have NO inventory items (starter gear not auto-created yet).
  • Hero profile endpoint is PUBLIC — no requireAuth middleware.
  • Profile page is public: no auth.js guard needed; uses ?name= query param for lookup.
  • Rate limiters in tests: set NODE_ENV=test to get 1000 req/window limit; otherwise tests fail with 429.
  • seed-dev.js must check NODE_ENV=production before any require() that loads config (config throws on placeholder SECRET).
  • Express sendFile rejects ../ path segments — use path.resolve() + path.join() for absolute paths.
  • express.static sends its own 404 responses; catch-all must be placed BEFORE static middleware.
  • Character profile GET returns { ok: true, data: { character, derived, energy } } — fields nested under character, derived, energy.
  • Register returns 201 (Created), not 200.
  • Character creation returns 201 (Created), not 200.
  • Expedition start uses defId in request body (not expeditionId).
  • Expedition claim uses expeditionId in request body.
  • Expedition start response returns data.expedition.id — capture this for claim.
  • src/utils/time exports { now, setNow, resetNow } directly — const time = require(...), not const { time }.
  • Inventory sell endpoint (POST /api/shop/sell) only accepts material-type items.
  • handleListInventory in src/routes/inventory.js — parameter name must be res, not _res.

7. Next-step briefing

  • Phase 9 is complete. All hardening and polish done.
  • Stretch Goals available: S1 (PvP duels), S2 (Skills/talents), S3 (Guilds), S4 (Player market), S5 (Daily rewards/quests), S6 (In-game chat), S7 (Achievements).
  • Or address Known Issues: Issue #2 (GET /api/zones missing — major), Issue #5 (equipment not in combat — minor), Issue #3 (npm run seed dead script — cosmetic).
  • Recommended next step: Fix Known Issue #2 (GET /api/zones) since it's a documented API gap and would improve the hunt UI. Then consider S7 (Achievements) as it's a self-contained, low-risk stretch goal that adds meaningful gameplay.