refactor: extract shuffleArray to lib/utils, rename correctAnswers to terms

This commit is contained in:
lila 2026-04-28 13:17:24 +02:00
parent c46729f365
commit 2ff7d1759e
5 changed files with 59 additions and 60 deletions

10
apps/api/src/lib/utils.ts Normal file
View file

@ -0,0 +1,10 @@
export const shuffleArray = <T>(array: T[]): T[] => {
const result = [...array];
for (let i = result.length - 1; i > 0; i--) {
const j = Math.floor(Math.random() * (i + 1));
const temp = result[i]!;
result[i] = result[j]!;
result[j] = temp;
}
return result;
};

View file

@ -10,13 +10,14 @@ import type {
} from "@lila/shared"; } from "@lila/shared";
import { InMemoryGameSessionStore } from "../gameSessionStore/index.js"; import { InMemoryGameSessionStore } from "../gameSessionStore/index.js";
import { NotFoundError } from "../errors/AppError.js"; import { NotFoundError } from "../errors/AppError.js";
import { shuffleArray } from "../lib/utils.js";
const gameSessionStore = new InMemoryGameSessionStore(); const gameSessionStore = new InMemoryGameSessionStore();
export const createGameSession = async ( export const createGameSession = async (
request: GameRequest, request: GameRequest,
): Promise<GameSession> => { ): Promise<GameSession> => {
const correctAnswers = await getGameTerms( const terms = await getGameTerms(
request.source_language, request.source_language,
request.target_language, request.target_language,
request.pos, request.pos,
@ -27,19 +28,19 @@ export const createGameSession = async (
const answerKey = new Map<string, number>(); const answerKey = new Map<string, number>();
const questions: GameQuestion[] = await Promise.all( const questions: GameQuestion[] = await Promise.all(
correctAnswers.map(async (correctAnswer) => { terms.map(async (term) => {
const distractorTexts = await getDistractors( const distractorTexts = await getDistractors(
correctAnswer.termId, term.termId,
correctAnswer.targetText, term.targetText,
request.target_language, request.target_language,
request.pos, request.pos,
request.difficulty, request.difficulty,
3, 3,
); );
const optionTexts = [correctAnswer.targetText, ...distractorTexts]; const optionTexts = [term.targetText, ...distractorTexts];
const shuffledTexts = shuffle(optionTexts); const shuffledTexts = shuffleArray(optionTexts);
const correctOptionId = shuffledTexts.indexOf(correctAnswer.targetText); const correctOptionId = shuffledTexts.indexOf(term.targetText);
const options: AnswerOption[] = shuffledTexts.map((text, index) => ({ const options: AnswerOption[] = shuffledTexts.map((text, index) => ({
optionId: index, optionId: index,
@ -51,8 +52,8 @@ export const createGameSession = async (
return { return {
questionId, questionId,
prompt: correctAnswer.sourceText, prompt: term.sourceText,
gloss: correctAnswer.sourceGloss, gloss: term.sourceGloss,
options, options,
}; };
}), }),
@ -64,17 +65,6 @@ export const createGameSession = async (
return { sessionId, questions }; return { sessionId, questions };
}; };
const shuffle = <T>(array: T[]): T[] => {
const result = [...array];
for (let i = result.length - 1; i > 0; i--) {
const j = Math.floor(Math.random() * (i + 1));
const temp = result[i]!;
result[i] = result[j]!;
result[j] = temp;
}
return result;
};
export const evaluateAnswer = async ( export const evaluateAnswer = async (
submission: AnswerSubmission, submission: AnswerSubmission,
): Promise<AnswerResult> => { ): Promise<AnswerResult> => {

View file

@ -103,10 +103,10 @@ Directionally right, timing is unclear. Revisit when the next/now work is done.
Shipped milestones, newest first. Shipped milestones, newest first.
- **04 - 2026 - t00001 - Docker credential helper** - **04 - 2026 - t00001 - Docker credential helper**
- **04 - 2026 - Pin dependencies in package.json** - Unpinned deps in a CI/CD pipeline are a real risk. - **04 - 2026 - Pin dependencies in package.json** - Unpinned deps in a CI/CD pipeline are a real risk.
- **04 - 2026 - React error boundaries** - Catch and display runtime errors gracefully instead of crashing the entire app. - **04 - 2026 - React error boundaries** - Catch and display runtime errors gracefully instead of crashing the entire app.
- **04 - 2026 - 404 and redirect handling** - Unknown routes return raw errors. Add a catch-all route on the frontend for client-side 404s. - **04 - 2026 - 404 and redirect handling** - Unknown routes return raw errors. Add a catch-all route on the frontend for client-side 404s.
- **04 - 2026 - Multiplayer GameService unit tests** - round evaluation, scoring, tie-breaking, timeout handling - **04 - 2026 - Multiplayer GameService unit tests** - round evaluation, scoring, tie-breaking, timeout handling
- **04 - 2026 - Security headers with helmet** - Add helmet middleware to set secure HTTP response headers. - **04 - 2026 - Security headers with helmet** - Add helmet middleware to set secure HTTP response headers.
- **04 - 2026 - Rate limiting on API endpoints** - At minimum: auth endpoints (brute force prevention) and game endpoints (spam prevention) - **04 - 2026 - Rate limiting on API endpoints** - At minimum: auth endpoints (brute force prevention) and game endpoints (spam prevention)
- **04 - 2026 — Migrations in deploy pipeline** — Drizzle migrate runs as a CI/CD step before the API container restarts - **04 - 2026 — Migrations in deploy pipeline** — Drizzle migrate runs as a CI/CD step before the API container restarts

View file

@ -115,42 +115,6 @@ export class InMemoryGameSessionStore implements GameSessionStore {
--- ---
## 3. `shuffle` is defined after it's used
**Problem**
`shuffle` is called inside `createGameSession` but defined below it. It works at runtime (module evaluation order), but reads as if the file was written top-to-bottom without a plan.
```ts
// ❌ shuffle appears after the function that calls it
export const createGameSession = async (...) => {
const shuffledTexts = shuffle(optionTexts); // used here
};
const shuffle = <T>(array: T[]): T[] => { ... }; // defined down here
```
**Fix — move helpers to the top, exports to the bottom**
```ts
// ✅ utilities first, then exported functions
const shuffle = <T>(array: T[]): T[] => {
const result = [...array];
for (let i = result.length - 1; i > 0; i--) {
const j = Math.floor(Math.random() * (i + 1));
const temp = result[i]!;
result[i] = result[j]!;
result[j] = temp;
}
return result;
};
export const createGameSession = async (...) => { ... };
export const evaluateAnswer = async (...) => { ... };
```
---
**Problem** **Problem**
@ -181,8 +145,6 @@ The `z.coerce.number()` handles the case where the value arrives as a string fro
--- ---
## 5. `correctAnswers` is a misleading variable name
**Problem** **Problem**
The variable holds `terms` — word pairs fetched from the database. Calling them `correctAnswers` jumps ahead semantically; they only become "correct answers" once options are constructed around them. The variable holds `terms` — word pairs fetched from the database. Calling them `correctAnswers` jumps ahead semantically; they only become "correct answers" once options are constructed around them.

View file

@ -0,0 +1,37 @@
# refactor: extract shuffleArray to lib/utils, rename correctAnswers to terms
## Problem
Two readability issues in `gameService.ts`:
1. `shuffle` was defined as a private function at the bottom of `gameService.ts`, after the function that calls it. It is a pure generic utility with no dependency on game domain logic, so it had no business living there.
2. The variable holding terms fetched from the database was named `correctAnswers`. These are word pairs — they only become "correct answers" once options are built around them. The name was premature and misleading.
## Options considered
### Option A — Move `shuffle` up in the same file
Simple, no new files. Fixes the ordering issue but keeps a generic utility buried in domain code.
### Option B — Extract to `lib/utils.ts`
Move `shuffle` (renamed `shuffleArray`) to `apps/api/src/lib/utils.ts` and import it. Cleaner separation: domain logic stays in services, generic utilities live in `lib/`.
Chosen because `lib/` already exists, the function is reusable, and it gives future utilities a home.
## Solution
- Created `apps/api/src/lib/utils.ts` with `shuffleArray`
- Renamed `shuffle``shuffleArray` for clarity at the call site
- Removed the inline `shuffle` from `gameService.ts` and imported from `lib/utils.ts`
- Renamed `correctAnswers``terms` and `correctAnswer``term` throughout `gameService.ts`
## Files changed
- `apps/api/src/lib/utils.ts` — created
- `apps/api/src/services/gameService.ts` — removed `shuffle`, updated import, renamed variables
## Commit
`refactor: extract shuffleArray to lib/utils, rename correctAnswers to terms`