From fbb4e592744c9d1047b0afef8ddb893cf31be987 Mon Sep 17 00:00:00 2001 From: lila Date: Sun, 26 Apr 2026 10:51:45 +0200 Subject: [PATCH 01/19] adding ticket structure, finishing docker credential helper setup --- documentation/backlog.md | 8 +-- documentation/notes.md | 1 + documentation/tickets/blueprint.md | 77 ++++++++++++++++++++++++ documentation/tickets/t00001.md | 95 ++++++++++++++++++++++++++++++ 4 files changed, 175 insertions(+), 6 deletions(-) create mode 100644 documentation/tickets/blueprint.md create mode 100644 documentation/tickets/t00001.md diff --git a/documentation/backlog.md b/documentation/backlog.md index 865c9f2..4e6af84 100644 --- a/documentation/backlog.md +++ b/documentation/backlog.md @@ -8,12 +8,6 @@ Labels: `[feature]` `[infra]` `[security]` `[ux]` `[debt]` Things that are actively in progress or should be picked up immediately. Mostly operational risk and the remaining phase 7 hardening work. -- **Pin dependencies in package.json** `[debt]` `[infra]` - Unpinned deps in a CI/CD pipeline are a real risk. Pin all versions to exact values to prevent unexpected breakage on build. - -- **Docker credential helper** `[debt]` `[infra]` - Credentials are stored unencrypted in `~/.docker/config.json`. Set up a credential helper. See https://docs.docker.com/go/credential-store/ - - **Google OAuth publishing** `[infra]` Only test users can currently log in via Google. Publish the OAuth consent screen so any Google user can sign in — requires branding verification in Google Cloud Console. @@ -108,6 +102,8 @@ Directionally right, timing is unclear. Revisit when the next/now work is done. Shipped milestones, newest first. +- **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 - 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 - Multiplayer GameService unit tests** - round evaluation, scoring, tie-breaking, timeout handling diff --git a/documentation/notes.md b/documentation/notes.md index eb25e7a..8a8d414 100644 --- a/documentation/notes.md +++ b/documentation/notes.md @@ -13,6 +13,7 @@ task description. 4. if we go through a file, we'll do it slowly section by section, no matter how many sections 5. how to name the current feature branch? also tell me when its time to git commit and provide a commit message 6. if we have multiple options to do something, also always provide options that reflect current industry standards and best practices +7. For every completed task, produce a ticket file in documentation/tickets/. Use ADR format (adr-) for decisions between options with long-term consequences. Use feat-/fix-/chore- for routine tasks. Always include a setup guide or summary of what was done. Suggest the filename. ## tasks diff --git a/documentation/tickets/blueprint.md b/documentation/tickets/blueprint.md new file mode 100644 index 0000000..7e612bb --- /dev/null +++ b/documentation/tickets/blueprint.md @@ -0,0 +1,77 @@ +# Ticket Blueprint + +Two formats depending on task type. Choose based on whether a meaningful +decision between options was made. + +--- + +## Format A — ADR (architectural/infrastructural decisions) +Use when: you chose between options with long-term consequences. +Prefix: `adr-` + +--- + +# ADR: + +## Status +Accepted | Superseded by | Deprecated + +## Date +YYYY-MM-DD + +## Context +What is the problem? Why does it need to be solved? + +## Decision +What was chosen and why in one or two sentences. + +## Options considered + +### Option A — <name> ✅ +Description. Why it was chosen. + +### Option B — <name> +Description. Why it was rejected. + +## Consequences +- What gets better +- What gets worse or more complex +- Operational implications +- What breaks if this needs to be redone + +## Affected files / machines +- List files, servers, or systems touched + +## References +- Links to relevant docs + +--- + +## Setup guide / implementation notes +Step-by-step of what was actually done. + +--- + +## Format B — Task (features, fixes, chores) +Use when: routine task with a clear solution. +Prefix: `feat-` / `fix-` / `chore-` + +--- + +# <prefix>: <title> + +## Problem +What was wrong or missing? + +## Options considered +### Option A — <name> ✅ +### Option B — <name> + +## Solution +What was done and why. + +## Files changed +- `path/to/file.ts` + +## Commit +`<type>: <message>` diff --git a/documentation/tickets/t00001.md b/documentation/tickets/t00001.md new file mode 100644 index 0000000..d15f242 --- /dev/null +++ b/documentation/tickets/t00001.md @@ -0,0 +1,95 @@ +# ADR: Docker Credential Helper Setup + +## Status +Accepted + +## Date +2026-04-26 + +## Context +Docker credentials for `git.lilastudy.com` and `dhi.io` were stored as +base64-encoded strings in `~/.docker/config.json` on both the dev laptop +and the VPS. Base64 is not encryption — anyone with read access to the +file can decode the credentials instantly. + +## Decision +Use `pass` (GPG-backed password store) as the Docker credential helper +on both machines. + +## Options considered + +### Option A — `pass` (GPG-backed) ✅ +Stores credentials encrypted with a GPG key. Works on headless servers +and desktops without GNOME. Industry standard for Linux servers. + +### Option B — `secretservice` (GNOME keyring) +Uses the desktop keyring daemon. Not suitable for a headless VPS, and +not suitable for an i3 desktop without running `gnome-keyring-daemon` +manually. + +### Option C — `gnome-libsecret` +Same limitations as Option B. + +## Consequences +- Credentials are now GPG-encrypted at rest on both machines +- Requires GPG passphrase entry when Docker needs to pull credentials + in a new session +- Must be set up manually on each machine — not reproducible via the repo +- VPS setup must be repeated if the server is reprovisioned + +## Affected machines +- Dev laptop (Debian 13, i3) +- VPS (Debian 13, ARM64, headless) + +## References +- https://docs.docker.com/reference/cli/docker/login/#credential-stores +- https://www.passwordstore.org/ + +--- + +## Setup guide + +Repeat these steps on each machine. + +### 1. Install dependencies +```bash +sudo apt-get install -y pass gnupg2 golang-docker-credential-helpers +``` + +### 2. Generate a GPG key +```bash +gpg --full-generate-key +``` +Choose RSA, 4096 bits, no expiry. Set a strong passphrase. + +### 3. Get the key ID +```bash +gpg --list-secret-keys --keyid-format LONG +``` +Copy the hex string after the `/` on the `sec` line. + +### 4. Initialise pass +```bash +pass init <your-key-id> +``` + +### 5. Update `~/.docker/config.json` +Replace the entire file contents with: +```json +{ + "credsStore": "pass" +} +``` + +### 6. Re-login to registries +```bash +docker login git.lilastudy.com +# dev laptop only: +docker login dhi.io +``` + +### 7. Verify +```bash +cat ~/.docker/config.json +``` +Should show only `"credsStore": "pass"` with no `auths` block. From 6b6a8aac3e93336e51e073178bf2a668c2be1a97 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Mon, 27 Apr 2026 17:47:05 +0200 Subject: [PATCH 02/19] adding roasts of gameservice --- documentation/roasts/gameService.md | 397 ++++++++++++++++++++++++++++ 1 file changed, 397 insertions(+) create mode 100644 documentation/roasts/gameService.md diff --git a/documentation/roasts/gameService.md b/documentation/roasts/gameService.md new file mode 100644 index 0000000..871ff7a --- /dev/null +++ b/documentation/roasts/gameService.md @@ -0,0 +1,397 @@ +# `gameService.ts` — Code Review & Fixes + +--- + +## 1. Hardcoded singleton kills the abstraction + +**Problem** + +A `GameSessionStore` interface exists, an `InMemoryGameSessionStore` implements it, and then the concrete class is immediately hardcoded as a module-level singleton. The interface is decorative — nothing can inject an alternative implementation without editing this file. + +```ts +// ❌ current — store is unreachable from outside +const gameSessionStore = new InMemoryGameSessionStore(); + +export const createGameSession = async (request: GameRequest) => { ... }; +export const evaluateAnswer = async (submission: AnswerSubmission) => { ... }; +``` + +**Fix — inject the store** + +Accept the store as a parameter (or use a factory). The simplest approach that requires no framework: + +```ts +// ✅ inject the store +export const createGameSession = async ( + request: GameRequest, + store: GameSessionStore, +): Promise<GameSession> => { ... }; + +export const evaluateAnswer = async ( + submission: AnswerSubmission, + store: GameSessionStore, +): Promise<AnswerResult> => { ... }; +``` + +The call site (controller) owns the store instance and passes it in. Tests can pass a fresh `InMemoryGameSessionStore` per test — no mocking required, no shared state. + +```ts +// gameController.ts +const store = new InMemoryGameSessionStore(); + +// later, swap for ValKeyGameSessionStore with one line change +``` + +--- + +## 2. Sessions are never deleted — memory leak + +**Problem** + +`GameSessionStore.delete()` is defined and implemented but never called. Every session ever created stays in the Map until the process restarts. Under real traffic this is a slow memory leak; under a spike it's a fast one. + +**Fix — delete after answer, or add a TTL** + +The simplest fix: delete the session once the last question is answered. If partial completion is needed, add a TTL on creation instead. + +```ts +// ✅ option A — delete on answer +export const evaluateAnswer = async ( + submission: AnswerSubmission, + store: GameSessionStore, +): Promise<AnswerResult> => { + const session = await store.get(submission.sessionId); + if (!session) throw new NotFoundError(`Game session not found: ${submission.sessionId}`); + + const correctOptionId = session.answers.get(submission.questionId); + if (correctOptionId === undefined) throw new NotFoundError(`Question not found: ${submission.questionId}`); + + // delete answered question; delete session when all questions are answered + session.answers.delete(submission.questionId); + if (session.answers.size === 0) { + await store.delete(submission.sessionId); + } + + return { + questionId: submission.questionId, + isCorrect: submission.selectedOptionId === correctOptionId, + correctOptionId, + selectedOptionId: submission.selectedOptionId, + }; +}; +``` + +```ts +// ✅ option B — TTL in InMemoryGameSessionStore +export class InMemoryGameSessionStore implements GameSessionStore { + private sessions = new Map<string, { data: GameSessionData; expiresAt: number }>(); + private readonly ttlMs: number; + + constructor(ttlMs = 30 * 60 * 1000) { // 30 minutes default + this.ttlMs = ttlMs; + } + + create(sessionId: string, data: GameSessionData): Promise<void> { + this.sessions.set(sessionId, { data, expiresAt: Date.now() + this.ttlMs }); + return Promise.resolve(); + } + + get(sessionId: string): Promise<GameSessionData | null> { + const entry = this.sessions.get(sessionId); + if (!entry) return Promise.resolve(null); + if (Date.now() > entry.expiresAt) { + this.sessions.delete(sessionId); + return Promise.resolve(null); + } + return Promise.resolve(entry.data); + } + + delete(sessionId: string): Promise<void> { + this.sessions.delete(sessionId); + return Promise.resolve(); + } +} +``` + +--- + +## 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 (...) => { ... }; +``` + +--- + +## 4. `rounds` is typed as a string + +**Problem** + +`GameRequest.rounds` is typed as `string` in `@lila/shared`, forcing the service to cast it every time: + +```ts +// ❌ why is a round count a string? +Number(request.rounds) +``` + +**Fix — fix the schema in `@lila/shared`** + +```ts +// ✅ in packages/shared +export const GameRequestSchema = z.object({ + source_language: z.string(), + target_language: z.string(), + pos: z.string(), + difficulty: z.string(), + rounds: z.coerce.number().int().min(1).max(50), // coerce handles form inputs, validates range +}); + +export type GameRequest = z.infer<typeof GameRequestSchema>; +``` + +The `z.coerce.number()` handles the case where the value arrives as a string from a query param or form — Zod does the conversion at the boundary so the rest of the system never sees a string. + +--- + +## 5. `correctAnswers` is a misleading variable name + +**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. + +```ts +// ❌ these are terms, not answers yet +const correctAnswers = await getGameTerms(...); +``` + +**Fix** + +```ts +// ✅ +const terms = await getGameTerms(...); + +// and inside the map: +terms.map(async (term) => { + const distractorTexts = await getDistractors( + term.termId, + term.targetText, + ... + ); + ... + const correctOptionId = shuffledTexts.indexOf(term.targetText); + ... +}); +``` + +--- + +## 6. Tautological test: `"distractors are never the correct answer"` + +**Problem** + +The test filters the correct answer out of the options array, then asserts the remaining items are not the correct answer. It is testing that `Array.filter` works. + +```ts +// ❌ this cannot fail +it("distractors are never the correct answer", async () => { + const distractorTexts = question.options + .map((o) => o.text) + .filter((t) => t !== correctText); // removes correct answer... + + for (const text of distractorTexts) { + expect(text).not.toBe(correctText); // ...then checks they're not the correct answer + } +}); +``` + +**What to actually test** + +The real concern is that `getDistractors` doesn't return the target word. Test that the service handles it correctly if it does: + +```ts +// ✅ test that the correct answer appears exactly once even if a distractor collides +it("correct answer appears exactly once in options even if distractor matches", async () => { + // simulate getDistractors returning the correct answer as one of the distractors + mockGetDistractors.mockResolvedValueOnce(["cane", "wrong2", "wrong3"]); + + const session = await createGameSession(validRequest, new InMemoryGameSessionStore()); + const question = session.questions[0]!; + const optionTexts = question.options.map((o) => o.text); + + // "cane" should only appear once regardless of the duplicate from getDistractors + expect(optionTexts.filter((t) => t === "cane")).toHaveLength(1); + expect(question.options).toHaveLength(4); +}); +``` + +> **Note:** the current implementation doesn't actually handle this case — a duplicate distractor would produce a 4-option list where the correct answer appears twice and one distractor slot is wasted. Worth fixing in `createGameSession` alongside the test. + +--- + +## 7. Store not reset between tests + +**Problem** + +`beforeEach` calls `vi.clearAllMocks()` which resets mock functions, but the `gameSessionStore` module-level singleton is never cleared. Ghost sessions from earlier tests persist for the entire test run. + +It doesn't bite today because each session gets a unique UUID and tests don't share IDs — but it's one non-UUID lookup away from a very confusing afternoon. + +**Fix — a consequence of fixing issue #1** + +Once the store is injected rather than module-level, each test creates its own instance: + +```ts +// ✅ no shared state, no ghost sessions +describe("evaluateAnswer", () => { + it("returns isCorrect: true for correct option", async () => { + const store = new InMemoryGameSessionStore(); + const session = await createGameSession(validRequest, store); + ... + const result = await evaluateAnswer({ ... }, store); + ... + }); +}); +``` + +No `beforeEach` cleanup needed — the store simply doesn't outlive the test that created it. + +--- + +## 8. No answer replay protection + +**Problem** + +`evaluateAnswer` can be called multiple times with the same `questionId`. The +service will evaluate it every time. In multiplayer this could be abused to +farm points or desync state. + +**Fix — delete the question from the answer key after first evaluation** + +```ts +// ✅ inside evaluateAnswer, after retrieving correctOptionId +session.answers.delete(submission.questionId); + +if (submission.selectedOptionId !== correctOptionId) { + // already removed — can't retry +} +``` + +Once the question key is deleted, a second submission hits the +`correctOptionId === undefined` branch and throws `NotFoundError`. One shot +per question. + +--- + +## 9. No ownership check in `evaluateAnswer` + +**Problem** + +The service accepts any `sessionId` without verifying it belongs to the +requesting user. If auth middleware doesn't tie sessions to users at a higher +layer, Alice can submit answers for Bob's session by guessing or intercepting +his `sessionId`. + +**Fix — store `userId` alongside the session and assert it on retrieval** + +```ts +// GameSessionStore.ts +export type GameSessionData = { + answers: Map<string, number>; + userId: string; +}; + +// evaluateAnswer +const session = await store.get(submission.sessionId); + +if (!session) throw new NotFoundError(`Game session not found`); +if (session.userId !== requestingUserId) throw new NotFoundError(`Game session not found`); +// ^^^ same error — don't confirm the session exists to the wrong user +``` + +Pass `requestingUserId` in from the controller, where it's already available +via auth middleware. + +--- + +## 10. No test for empty `getGameTerms` result + +**Problem** + +If the database returns zero terms (no words match the difficulty/language/pos +filter), `createGameSession` happily returns a session with an empty +`questions` array. The frontend receives it, tries to render question 1, and +crashes. The user sees nothing useful. + +**Fix — guard in the service and add a test** + +```ts +// ✅ inside createGameSession, after fetching terms +if (terms.length === 0) { + throw new AppError("No terms found for the given filters", 404); +} +``` + +```ts +// ✅ test +it("throws when getGameTerms returns no terms", async () => { + mockGetGameTerms.mockResolvedValue([]); + + await expect(createGameSession(validRequest, new InMemoryGameSessionStore())) + .rejects.toThrow("No terms found"); +}); +``` + +--- + +## 11. No test for `getDistractors` rejection + +**Problem** + +`createGameSession` uses `Promise.all` over the terms array. If +`getDistractors` rejects for any single term, the entire `Promise.all` rejects +— no session is created, no partial recovery, the user gets a 500 with +"connection refused" leaking through. + +**Fix — test the failure path and consider a fallback** + +```ts +// ✅ test +it("propagates getDistractors failure", async () => { + mockGetDistractors.mockRejectedValue(new Error("db timeout")); + + await expect(createGameSession(validRequest, new InMemoryGameSessionStore())) + .rejects.toThrow("db timeout"); +}); +``` + +For resilience, consider catching per-term distractor failures and falling back +to random terms from the already-fetched set rather than collapsing the whole +session. From 7d3c456efeacee020923ec337ba03f63413b1c7a Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 12:29:32 +0200 Subject: [PATCH 03/19] formatting --- documentation/tickets/t00001.md | 42 ++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/documentation/tickets/t00001.md b/documentation/tickets/t00001.md index d15f242..4fffaec 100644 --- a/documentation/tickets/t00001.md +++ b/documentation/tickets/t00001.md @@ -1,49 +1,52 @@ # ADR: Docker Credential Helper Setup ## Status + Accepted ## Date + 2026-04-26 ## Context -Docker credentials for `git.lilastudy.com` and `dhi.io` were stored as -base64-encoded strings in `~/.docker/config.json` on both the dev laptop -and the VPS. Base64 is not encryption — anyone with read access to the -file can decode the credentials instantly. + +Docker credentials for `git.lilastudy.com` and `dhi.io` were stored as base64-encoded strings in `~/.docker/config.json` on both the dev laptop and the VPS. Base64 is not encryption — anyone with read access to the file can decode the credentials instantly. ## Decision -Use `pass` (GPG-backed password store) as the Docker credential helper -on both machines. + +Use `pass` (GPG-backed password store) as the Docker credential helper on both machines. ## Options considered ### Option A — `pass` (GPG-backed) ✅ -Stores credentials encrypted with a GPG key. Works on headless servers -and desktops without GNOME. Industry standard for Linux servers. + +Stores credentials encrypted with a GPG key. Works on headless servers and desktops without GNOME. Industry standard for Linux servers. ### Option B — `secretservice` (GNOME keyring) -Uses the desktop keyring daemon. Not suitable for a headless VPS, and -not suitable for an i3 desktop without running `gnome-keyring-daemon` -manually. + +Uses the desktop keyring daemon. Not suitable for a headless VPS, and not suitable for an i3 desktop without running `gnome-keyring-daemon` manually. ### Option C — `gnome-libsecret` + Same limitations as Option B. ## Consequences + - Credentials are now GPG-encrypted at rest on both machines -- Requires GPG passphrase entry when Docker needs to pull credentials +- Requires GPG passphrase entry when Docker needs to pull credentials in a new session - Must be set up manually on each machine — not reproducible via the repo - VPS setup must be repeated if the server is reprovisioned ## Affected machines + - Dev laptop (Debian 13, i3) - VPS (Debian 13, ARM64, headless) ## References -- https://docs.docker.com/reference/cli/docker/login/#credential-stores -- https://www.passwordstore.org/ + +- [docker docs](https://docs.docker.com/reference/cli/docker/login/#credential-stores) +- [pass docs](https://www.passwordstore.org/) --- @@ -52,29 +55,37 @@ Same limitations as Option B. Repeat these steps on each machine. ### 1. Install dependencies + ```bash sudo apt-get install -y pass gnupg2 golang-docker-credential-helpers ``` ### 2. Generate a GPG key + ```bash gpg --full-generate-key ``` + Choose RSA, 4096 bits, no expiry. Set a strong passphrase. ### 3. Get the key ID + ```bash gpg --list-secret-keys --keyid-format LONG ``` + Copy the hex string after the `/` on the `sec` line. ### 4. Initialise pass + ```bash pass init <your-key-id> ``` ### 5. Update `~/.docker/config.json` + Replace the entire file contents with: + ```json { "credsStore": "pass" @@ -82,6 +93,7 @@ Replace the entire file contents with: ``` ### 6. Re-login to registries + ```bash docker login git.lilastudy.com # dev laptop only: @@ -89,7 +101,9 @@ docker login dhi.io ``` ### 7. Verify + ```bash cat ~/.docker/config.json ``` + Should show only `"credsStore": "pass"` with no `auths` block. From 02ccc88d242d685385ff4032a732170bbfb37131 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 12:29:46 +0200 Subject: [PATCH 04/19] fix: change GAME_ROUNDS from strings to numbers --- .../src/controllers/gameController.test.ts | 20 ++- apps/api/src/services/gameService.test.ts | 2 +- apps/api/src/services/gameService.ts | 2 +- apps/web/src/components/game/GameSetup.tsx | 16 +- documentation/roasts/gameService.md | 2 +- documentation/tickets/t00002.md | 149 ++++++++++++++++++ packages/shared/src/constants.ts | 2 +- packages/shared/src/schemas/game.ts | 2 +- 8 files changed, 181 insertions(+), 14 deletions(-) create mode 100644 documentation/tickets/t00002.md diff --git a/apps/api/src/controllers/gameController.test.ts b/apps/api/src/controllers/gameController.test.ts index 7c4d563..cfbe065 100644 --- a/apps/api/src/controllers/gameController.test.ts +++ b/apps/api/src/controllers/gameController.test.ts @@ -60,7 +60,7 @@ const validBody = { target_language: "it", pos: "noun", difficulty: "easy", - rounds: "3", + rounds: 3, }; const fakeTerms = [ @@ -177,4 +177,22 @@ describe("POST /api/v1/game/answer", () => { expect(body.success).toBe(false); expect(body.error).toContain("Question not found"); }); + + it("returns 400 when a field has an invalid value", async () => { + const res = await request(app) + .post("/api/v1/game/start") + .send({ ...validBody, difficulty: "impossible" }); + const body = res.body as ErrorResponse; + expect(res.status).toBe(400); + expect(body.success).toBe(false); + }); + + it("returns 400 when rounds has an invalid value", async () => { + const res = await request(app) + .post("/api/v1/game/start") + .send({ ...validBody, rounds: "invalid" }); + const body = res.body as ErrorResponse; + expect(res.status).toBe(400); + expect(body.success).toBe(false); + }); }); diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index 66b7470..2c7daf8 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -14,7 +14,7 @@ const validRequest: GameRequest = { target_language: "it", pos: "noun", difficulty: "easy", - rounds: "3", + rounds: 3, }; const fakeTerms = [ diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index b015271..d0f0781 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -21,7 +21,7 @@ export const createGameSession = async ( request.target_language, request.pos, request.difficulty, - Number(request.rounds), + request.rounds, ); const answerKey = new Map<string, number>(); diff --git a/apps/web/src/components/game/GameSetup.tsx b/apps/web/src/components/game/GameSetup.tsx index 89c9f17..269818c 100644 --- a/apps/web/src/components/game/GameSetup.tsx +++ b/apps/web/src/components/game/GameSetup.tsx @@ -24,19 +24,19 @@ const LABELS: Record<string, string> = { type GameSetupProps = { onStart: (settings: GameRequest) => void }; -type SettingGroupProps = { +type SettingGroupProps<T extends string | number> = { label: string; - options: readonly string[]; - selected: string; - onSelect: (value: string) => void; + options: readonly T[]; + selected: T; + onSelect: (value: T) => void; }; -const SettingGroup = ({ +const SettingGroup = <T extends string | number>({ label, options, selected, onSelect, -}: SettingGroupProps) => ( +}: SettingGroupProps<T>) => ( <div className="w-full"> <p className="text-xs font-bold tracking-widest uppercase text-(--color-primary) mb-2"> {label} @@ -52,7 +52,7 @@ const SettingGroup = ({ : "bg-white text-(--color-primary-dark) border-(--color-primary-light) hover:bg-(--color-surface) hover:-translate-y-0.5 active:translate-y-0" }`} > - {LABELS[option] ?? option} + {LABELS[String(option)] ?? option} </button> ))} </div> @@ -68,7 +68,7 @@ export const GameSetup = ({ onStart }: GameSetupProps) => { ); const [pos, setPos] = useState<string>(SUPPORTED_POS[0]); const [difficulty, setDifficulty] = useState<string>(DIFFICULTY_LEVELS[0]); - const [rounds, setRounds] = useState<string>(GAME_ROUNDS[0]); + const [rounds, setRounds] = useState<number>(GAME_ROUNDS[0]); const handleSourceLanguage = (value: string) => { if (value === targetLanguage) { diff --git a/documentation/roasts/gameService.md b/documentation/roasts/gameService.md index 871ff7a..e5663b5 100644 --- a/documentation/roasts/gameService.md +++ b/documentation/roasts/gameService.md @@ -151,7 +151,7 @@ export const evaluateAnswer = async (...) => { ... }; --- -## 4. `rounds` is typed as a string + **Problem** diff --git a/documentation/tickets/t00002.md b/documentation/tickets/t00002.md new file mode 100644 index 0000000..dc93605 --- /dev/null +++ b/documentation/tickets/t00002.md @@ -0,0 +1,149 @@ +# ADR: Change GAME_ROUNDS from strings to numbers + +## Status + +Accepted + +## Date + +2026-04-28 + +## Context + +`GAME_ROUNDS` in `packages/shared/src/constants.ts` was typed as `["3", "10"] as const`, making `GameRounds` a string union (`"3" | "10"`). This meant `gameService.ts` had to cast the value with `Number(request.rounds)` deep in business logic — a type conversion happening far from the boundary where data enters the system. The type system was lying: `rounds` was described as a string everywhere but used as a number where it mattered. + +## Decision + +Change `GAME_ROUNDS` to `[3, 10] as const` and update the Zod schema to use `z.literal(GAME_ROUNDS)` instead of `z.enum(GAME_ROUNDS)`. The single source of truth remains `constants.ts` — adding a new round count (e.g. `20`) requires only editing that file. + +## Options considered + +### Option A — Numbers everywhere ✅ + +Change `GAME_ROUNDS` to `[3, 10] as const`. Use `z.literal(GAME_ROUNDS)` in the schema. Update the frontend component state and `SettingGroup` props. Drop `Number()` cast in the service. + +Chosen because: JSON carries numbers natively, both ends of the wire are owned by this codebase, and type conversions belong at the boundary — not inside business logic. + +### Option B — Keep strings, accept the cast + +Leave `GAME_ROUNDS` as `["3", "10"]`. The `Number()` cast stays in `gameService.ts`. + +Rejected because: it pushes type conversion into business logic and makes the inferred `GameRequest` type misleading. The cast has to live somewhere — the schema boundary is the right place. + +### Option C — Coerce at the schema boundary + +Keep `GAME_ROUNDS` as numbers but use `z.coerce.number().pipe(z.literal(GAME_ROUNDS))` so the frontend can keep sending strings. + +Rejected because: coercion is for untrusted or uncontrolled inputs (form fields, query params, third-party clients). We control both ends of the wire. Coercing a self-inflicted type mismatch is treating a wound we gave ourselves. + +## Consequences + +- `GameRounds` is now `3 | 10` instead of `"3" | "10"` +- `Number(request.rounds)` cast removed from `gameService.ts` +- `SettingGroup` in `GameSetup.tsx` now accepts `string | number` options +- `useState<string>` for rounds changed to `useState<number>` +- Adding a new round count requires only editing `GAME_ROUNDS` in `constants.ts` +- `z.enum` cannot be used for number literals — `z.literal` must be used instead (this is a Zod constraint, not a project convention) + +## Affected files + +- `packages/shared/src/constants.ts` +- `packages/shared/src/schemas/game.ts` +- `apps/api/src/services/gameService.ts` +- `apps/api/src/services/gameService.test.ts` +- `apps/api/src/controllers/gameController.test.ts` +- `apps/web/src/components/game/GameSetup.tsx` + +## References + +- [Zod literals](https://zod.dev/?id=literals) + +--- + +## Setup guide / implementation notes + +1. In `packages/shared/src/constants.ts`, change: + + ```ts + export const GAME_ROUNDS = ["3", "10"] as const; + ``` + + to: + + ```ts + export const GAME_ROUNDS = [3, 10] as const; + ``` + +2. In `packages/shared/src/schemas/game.ts`, change: + + ```ts + rounds: z.enum(GAME_ROUNDS), + ``` + + to: + + ```ts + rounds: z.literal(GAME_ROUNDS), + ``` + +3. In `apps/api/src/services/gameService.ts`, change: + + ```ts + Number(request.rounds), + ``` + + to: + + ```ts + request.rounds, + ``` + +4. In `apps/api/src/services/gameService.test.ts`, change: + + ```ts + rounds: "3", + ``` + + to: + + ```ts + rounds: 3, + ``` + +5. In `apps/api/src/controllers/gameController.test.ts`, change: + + ```ts + rounds: "3", + ``` + + to: + + ```ts + rounds: 3, + ``` + + Also add a pinning test before the refactor: + + ```ts + it("returns 400 when rounds has an invalid value", async () => { + const res = await request(app) + .post("/api/v1/game/start") + .send({ ...validBody, rounds: "invalid" }); + expect(res.status).toBe(400); + expect(res.body.success).toBe(false); + }); + ``` + +6. In `apps/web/src/components/game/GameSetup.tsx`: + - Update `SettingGroup` props to accept `string | number`: + + ```ts + type SettingGroupProps = { + options: readonly (string | number)[]; + selected: string | number; + onSelect: (value: string | number) => void; + }; + ``` + + - Update `LABELS` lookup to `LABELS[String(option)]` + - Change rounds state from `useState<string>` to `useState<number>` diff --git a/packages/shared/src/constants.ts b/packages/shared/src/constants.ts index ebe90ce..252bfff 100644 --- a/packages/shared/src/constants.ts +++ b/packages/shared/src/constants.ts @@ -4,7 +4,7 @@ export type SupportedLanguageCode = (typeof SUPPORTED_LANGUAGE_CODES)[number]; export const SUPPORTED_POS = ["noun", "verb", "adjective", "adverb"] as const; export type SupportedPos = (typeof SUPPORTED_POS)[number]; -export const GAME_ROUNDS = ["3", "10"] as const; +export const GAME_ROUNDS = [3, 10] as const; export type GameRounds = (typeof GAME_ROUNDS)[number]; export const CEFR_LEVELS = ["A1", "A2", "B1", "B2", "C1", "C2"] as const; diff --git a/packages/shared/src/schemas/game.ts b/packages/shared/src/schemas/game.ts index 2a32a24..51f1cc2 100644 --- a/packages/shared/src/schemas/game.ts +++ b/packages/shared/src/schemas/game.ts @@ -12,7 +12,7 @@ export const GameRequestSchema = z.object({ target_language: z.enum(SUPPORTED_LANGUAGE_CODES), pos: z.enum(SUPPORTED_POS), difficulty: z.enum(DIFFICULTY_LEVELS), - rounds: z.enum(GAME_ROUNDS), + rounds: z.literal(GAME_ROUNDS), }); export type GameRequest = z.infer<typeof GameRequestSchema>; From c46729f3656c6536eaf8a75d3a9555dcf168946b Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 12:32:44 +0200 Subject: [PATCH 05/19] formatting --- documentation/tickets/blueprint.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/documentation/tickets/blueprint.md b/documentation/tickets/blueprint.md index 7e612bb..8a3c065 100644 --- a/documentation/tickets/blueprint.md +++ b/documentation/tickets/blueprint.md @@ -6,6 +6,7 @@ decision between options was made. --- ## Format A — ADR (architectural/infrastructural decisions) + Use when: you chose between options with long-term consequences. Prefix: `adr-` @@ -14,45 +15,56 @@ Prefix: `adr-` # ADR: <title> ## Status + Accepted | Superseded by | Deprecated ## Date + YYYY-MM-DD ## Context + What is the problem? Why does it need to be solved? ## Decision + What was chosen and why in one or two sentences. ## Options considered ### Option A — <name> ✅ + Description. Why it was chosen. ### Option B — <name> + Description. Why it was rejected. ## Consequences + - What gets better - What gets worse or more complex - Operational implications - What breaks if this needs to be redone ## Affected files / machines + - List files, servers, or systems touched ## References + - Links to relevant docs --- ## Setup guide / implementation notes + Step-by-step of what was actually done. --- ## Format B — Task (features, fixes, chores) + Use when: routine task with a clear solution. Prefix: `feat-` / `fix-` / `chore-` @@ -61,17 +73,23 @@ Prefix: `feat-` / `fix-` / `chore-` # <prefix>: <title> ## Problem + What was wrong or missing? ## Options considered + ### Option A — <name> ✅ + ### Option B — <name> ## Solution + What was done and why. ## Files changed + - `path/to/file.ts` ## Commit + `<type>: <message>` From 2ff7d1759e9a6bc1378f9a9f00b231b61ea04aac Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 13:17:24 +0200 Subject: [PATCH 06/19] refactor: extract shuffleArray to lib/utils, rename correctAnswers to terms --- apps/api/src/lib/utils.ts | 10 ++++++++ apps/api/src/services/gameService.ts | 30 ++++++++-------------- documentation/backlog.md | 4 +-- documentation/roasts/gameService.md | 38 ---------------------------- documentation/tickets/t00003.md | 37 +++++++++++++++++++++++++++ 5 files changed, 59 insertions(+), 60 deletions(-) create mode 100644 apps/api/src/lib/utils.ts create mode 100644 documentation/tickets/t00003.md diff --git a/apps/api/src/lib/utils.ts b/apps/api/src/lib/utils.ts new file mode 100644 index 0000000..4912c8c --- /dev/null +++ b/apps/api/src/lib/utils.ts @@ -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; +}; diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index d0f0781..64f90f6 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -10,13 +10,14 @@ import type { } from "@lila/shared"; import { InMemoryGameSessionStore } from "../gameSessionStore/index.js"; import { NotFoundError } from "../errors/AppError.js"; +import { shuffleArray } from "../lib/utils.js"; const gameSessionStore = new InMemoryGameSessionStore(); export const createGameSession = async ( request: GameRequest, ): Promise<GameSession> => { - const correctAnswers = await getGameTerms( + const terms = await getGameTerms( request.source_language, request.target_language, request.pos, @@ -27,19 +28,19 @@ export const createGameSession = async ( const answerKey = new Map<string, number>(); const questions: GameQuestion[] = await Promise.all( - correctAnswers.map(async (correctAnswer) => { + terms.map(async (term) => { const distractorTexts = await getDistractors( - correctAnswer.termId, - correctAnswer.targetText, + term.termId, + term.targetText, request.target_language, request.pos, request.difficulty, 3, ); - const optionTexts = [correctAnswer.targetText, ...distractorTexts]; - const shuffledTexts = shuffle(optionTexts); - const correctOptionId = shuffledTexts.indexOf(correctAnswer.targetText); + const optionTexts = [term.targetText, ...distractorTexts]; + const shuffledTexts = shuffleArray(optionTexts); + const correctOptionId = shuffledTexts.indexOf(term.targetText); const options: AnswerOption[] = shuffledTexts.map((text, index) => ({ optionId: index, @@ -51,8 +52,8 @@ export const createGameSession = async ( return { questionId, - prompt: correctAnswer.sourceText, - gloss: correctAnswer.sourceGloss, + prompt: term.sourceText, + gloss: term.sourceGloss, options, }; }), @@ -64,17 +65,6 @@ export const createGameSession = async ( 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 ( submission: AnswerSubmission, ): Promise<AnswerResult> => { diff --git a/documentation/backlog.md b/documentation/backlog.md index 4e6af84..d0cb202 100644 --- a/documentation/backlog.md +++ b/documentation/backlog.md @@ -103,10 +103,10 @@ Directionally right, timing is unclear. Revisit when the next/now work is done. Shipped milestones, newest first. - **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 - 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 - 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 diff --git a/documentation/roasts/gameService.md b/documentation/roasts/gameService.md index e5663b5..de8f968 100644 --- a/documentation/roasts/gameService.md +++ b/documentation/roasts/gameService.md @@ -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** @@ -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** 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. diff --git a/documentation/tickets/t00003.md b/documentation/tickets/t00003.md new file mode 100644 index 0000000..774fe42 --- /dev/null +++ b/documentation/tickets/t00003.md @@ -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` From 4f59f3bc1488e072b9e58e3978c16a443223235b Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 13:18:18 +0200 Subject: [PATCH 07/19] formatting --- README.md | 50 +- apps/web/src/components/game/QuestionCard.tsx | 22 +- .../multiplayer/MultiplayerScoreScreen.tsx | 4 +- apps/web/src/components/ui/ConfettiBurst.tsx | 10 +- apps/web/src/routes/multiplayer/index.tsx | 4 +- data-pipeline/test/output/sample.json | 3268 ++++------------- data-pipeline/tsconfig.json | 4 +- documentation/data-pipeline.md | 91 +- documentation/deployment.md | 14 +- documentation/llm-setup.md | 88 +- documentation/notes.md | 9 +- documentation/roasts/gameService.md | 41 +- documentation/spec.md | 73 +- documentation/tickets/blueprint.md | 2 +- documentation/tickets/t00001.md | 4 +- documentation/tickets/t00002.md | 2 +- packages/db/drizzle/meta/0007_snapshot.json | 148 +- packages/db/drizzle/meta/0008_snapshot.json | 162 +- packages/db/drizzle/meta/0009_snapshot.json | 162 +- packages/db/drizzle/meta/0010_snapshot.json | 162 +- packages/db/drizzle/meta/_journal.json | 2 +- packages/db/tsconfig.json | 6 +- tsconfig.json | 4 +- 23 files changed, 994 insertions(+), 3338 deletions(-) diff --git a/README.md b/README.md index 32af038..e212a55 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,21 @@ Live at [lilastudy.com](https://lilastudy.com). ## Stack -| Layer | Technology | -|---|---| -| Monorepo | pnpm workspaces | -| Frontend | React 18, Vite, TypeScript | -| Routing | TanStack Router | -| Server state | TanStack Query | -| Styling | Tailwind CSS | -| Backend | Node.js, Express, TypeScript | -| Database | PostgreSQL + Drizzle ORM | -| Validation | Zod (shared schemas) | -| Auth | Better Auth (Google + GitHub) | -| Realtime | WebSockets (`ws` library) | -| Testing | Vitest, supertest | -| Deployment | Docker Compose, Caddy, Hetzner VPS | -| CI/CD | Forgejo Actions | +| Layer | Technology | +| ------------ | ---------------------------------- | +| Monorepo | pnpm workspaces | +| Frontend | React 18, Vite, TypeScript | +| Routing | TanStack Router | +| Server state | TanStack Query | +| Styling | Tailwind CSS | +| Backend | Node.js, Express, TypeScript | +| Database | PostgreSQL + Drizzle ORM | +| Validation | Zod (shared schemas) | +| Auth | Better Auth (Google + GitHub) | +| Realtime | WebSockets (`ws` library) | +| Testing | Vitest, supertest | +| Deployment | Docker Compose, Caddy, Hetzner VPS | +| CI/CD | Forgejo Actions | --- @@ -156,15 +156,15 @@ pnpm --filter web test ## Roadmap -| Phase | Description | Status | -|---|---|---| -| 0 | Foundation — monorepo, tooling, dev environment | ✅ | -| 1 | Vocabulary data pipeline + REST API | ✅ | -| 2 | Singleplayer quiz UI | ✅ | -| 3 | Auth (Google + GitHub) | ✅ | -| 4 | Multiplayer lobby (WebSockets) | ✅ | -| 5 | Multiplayer game (real-time, server timer) | ✅ | -| 6 | Production deployment + CI/CD | ✅ | -| 7 | Hardening (rate limiting, error boundaries, monitoring, accessibility) | 🔄 | +| Phase | Description | Status | +| ----- | ---------------------------------------------------------------------- | ------ | +| 0 | Foundation — monorepo, tooling, dev environment | ✅ | +| 1 | Vocabulary data pipeline + REST API | ✅ | +| 2 | Singleplayer quiz UI | ✅ | +| 3 | Auth (Google + GitHub) | ✅ | +| 4 | Multiplayer lobby (WebSockets) | ✅ | +| 5 | Multiplayer game (real-time, server timer) | ✅ | +| 6 | Production deployment + CI/CD | ✅ | +| 7 | Hardening (rate limiting, error boundaries, monitoring, accessibility) | 🔄 | See `documentation/roadmap.md` for task-level detail. diff --git a/apps/web/src/components/game/QuestionCard.tsx b/apps/web/src/components/game/QuestionCard.tsx index 7878a5b..2d4c633 100644 --- a/apps/web/src/components/game/QuestionCard.tsx +++ b/apps/web/src/components/game/QuestionCard.tsx @@ -53,7 +53,11 @@ export const QuestionCard = ({ Round {questionNumber}/{totalQuestions} </div> <div className="text-xs font-semibold text-(--color-text-muted)"> - {currentResult ? "Checked" : selectedOptionId !== null ? "Ready" : "Pick one"} + {currentResult + ? "Checked" + : selectedOptionId !== null + ? "Ready" + : "Pick one"} </div> </div> @@ -73,14 +77,14 @@ export const QuestionCard = ({ <div className="w-full rounded-3xl border border-(--color-primary-light) bg-white/55 dark:bg-black/10 backdrop-blur shadow-sm p-4"> <div className="flex flex-col gap-3"> - {question.options.map((option) => ( - <OptionButton - key={option.optionId} - text={option.text} - state={getOptionState(option.optionId)} - onSelect={() => handleSelect(option.optionId)} - /> - ))} + {question.options.map((option) => ( + <OptionButton + key={option.optionId} + text={option.text} + state={getOptionState(option.optionId)} + onSelect={() => handleSelect(option.optionId)} + /> + ))} </div> </div> diff --git a/apps/web/src/components/multiplayer/MultiplayerScoreScreen.tsx b/apps/web/src/components/multiplayer/MultiplayerScoreScreen.tsx index f530db8..8b82f1a 100644 --- a/apps/web/src/components/multiplayer/MultiplayerScoreScreen.tsx +++ b/apps/web/src/components/multiplayer/MultiplayerScoreScreen.tsx @@ -69,7 +69,9 @@ export const MultiplayerScoreScreen = ({ </span> <span className={`text-sm font-semibold ${ - isCurrentUser ? "text-(--color-text)" : "text-(--color-text)" + isCurrentUser + ? "text-(--color-text)" + : "text-(--color-text)" }`} > {player.user.name} diff --git a/apps/web/src/components/ui/ConfettiBurst.tsx b/apps/web/src/components/ui/ConfettiBurst.tsx index 66285d4..ee1fcfd 100644 --- a/apps/web/src/components/ui/ConfettiBurst.tsx +++ b/apps/web/src/components/ui/ConfettiBurst.tsx @@ -6,10 +6,7 @@ type ConfettiBurstProps = { count?: number; }; -type Piece = { - id: number; - style: React.CSSProperties & ConfettiVars; -}; +type Piece = { id: number; style: React.CSSProperties & ConfettiVars }; type ConfettiVars = { ["--x0"]: string; @@ -56,7 +53,9 @@ export const ConfettiBurst = ({ }, []); const pieces = useMemo<Piece[]>(() => { - const seed = hashStringToUint32(`${instanceId}:${count}:${colors.join(",")}`); + const seed = hashStringToUint32( + `${instanceId}:${count}:${colors.join(",")}`, + ); const rand = mulberry32(seed); const rnd = (min: number, max: number) => min + rand() * (max - min); @@ -100,4 +99,3 @@ export const ConfettiBurst = ({ </div> ); }; - diff --git a/apps/web/src/routes/multiplayer/index.tsx b/apps/web/src/routes/multiplayer/index.tsx index ee757f4..2780eab 100644 --- a/apps/web/src/routes/multiplayer/index.tsx +++ b/apps/web/src/routes/multiplayer/index.tsx @@ -108,7 +108,9 @@ function MultiplayerPage() { {/* Join lobby */} <div className="flex flex-col gap-2"> - <h2 className="text-lg font-bold text-(--color-text)">Join a lobby</h2> + <h2 className="text-lg font-bold text-(--color-text)"> + Join a lobby + </h2> <p className="text-sm text-(--color-text-muted)"> Enter the code shared by your host. </p> diff --git a/data-pipeline/test/output/sample.json b/data-pipeline/test/output/sample.json index 5dd774f..3177e22 100644 --- a/data-pipeline/test/output/sample.json +++ b/data-pipeline/test/output/sample.json @@ -3,12 +3,8 @@ "source_id": "ili:i90862", "pos": "noun", "translations": { - "en": [ - "kinsman" - ], - "es": [ - "pariente" - ], + "en": ["kinsman"], + "es": ["pariente"], "de": [ "Gevatter", "Anverwandter", @@ -18,17 +14,11 @@ "Angehöriger", "Verwandte" ], - "fr": [ - "parent" - ] + "fr": ["parent"] }, "glosses": { - "en": [ - "a male relative" - ], - "de": [ - "ein männlicher Verwandter" - ] + "en": ["a male relative"], + "de": ["ein männlicher Verwandter"] }, "examples": { "de": [ @@ -44,16 +34,10 @@ "text": "Alle Familienangehörigen kamen zum Treffen.", "source": "cefr" }, - { - "text": "Er ist ein Angehöriger der Familie.", - "source": "cefr" - } + { "text": "Er ist ein Angehöriger der Familie.", "source": "cefr" } ], "fr": [ - { - "text": "Ses parents sont très fiers de lui.", - "source": "cefr" - } + { "text": "Ses parents sont très fiers de lui.", "source": "cefr" } ], "es": [ { @@ -63,35 +47,15 @@ ] }, "votes": { - "en": { - "kinsman": { - "cefr_source": "C1" - } - }, + "en": { "kinsman": { "cefr_source": "C1" } }, "de": { - "Familienmitglied": { - "cefr_source": "A2" - }, - "Verwandter": { - "cefr_source": "B1" - }, - "Familienangehöriger": { - "cefr_source": "B1" - }, - "Angehöriger": { - "cefr_source": "B2" - } + "Familienmitglied": { "cefr_source": "A2" }, + "Verwandter": { "cefr_source": "B1" }, + "Familienangehöriger": { "cefr_source": "B1" }, + "Angehöriger": { "cefr_source": "B2" } }, - "fr": { - "parent": { - "cefr_source": "A1" - } - }, - "es": { - "pariente": { - "cefr_source": "A2" - } - } + "fr": { "parent": { "cefr_source": "A1" } }, + "es": { "pariente": { "cefr_source": "A2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -99,96 +63,41 @@ "source_id": "ili:i23087", "pos": "verb", "translations": { - "en": [ - "teach" - ], - "it": [ - "addestrare", - "ammaestrare", - "insegnare" - ], - "es": [ - "enseñar" - ], - "fr": [ - "enseigner", - "apprendre", - "guider" - ] - }, - "glosses": { - "en": [ - "accustom gradually to some action or attitude" - ] + "en": ["teach"], + "it": ["addestrare", "ammaestrare", "insegnare"], + "es": ["enseñar"], + "fr": ["enseigner", "apprendre", "guider"] }, + "glosses": { "en": ["accustom gradually to some action or attitude"] }, "examples": { "en": [ - { - "text": "The child is taught to obey her parents", - "source": "omw" - } + { "text": "The child is taught to obey her parents", "source": "omw" } ], "it": [ - { - "text": "Stiamo addestrando il nostro cane.", - "source": "cefr" - }, - { - "text": "Lei insegna italiano ai bambini.", - "source": "cefr" - } + { "text": "Stiamo addestrando il nostro cane.", "source": "cefr" }, + { "text": "Lei insegna italiano ai bambini.", "source": "cefr" } ], "fr": [ - { - "text": "Elle enseigne le français au lycée.", - "source": "cefr" - }, - { - "text": "J'apprends le français.", - "source": "cefr" - }, - { - "text": "Il va nous guider à travers la forêt.", - "source": "cefr" - } + { "text": "Elle enseigne le français au lycée.", "source": "cefr" }, + { "text": "J'apprends le français.", "source": "cefr" }, + { "text": "Il va nous guider à travers la forêt.", "source": "cefr" } ], "es": [ - { - "text": "Ella enseña español en la universidad.", - "source": "cefr" - } + { "text": "Ella enseña español en la universidad.", "source": "cefr" } ] }, "votes": { - "en": { - "teach": { - "cefr_source": "A1" - } - }, + "en": { "teach": { "cefr_source": "A1" } }, "it": { - "addestrare": { - "cefr_source": "B1" - }, - "insegnare": { - "cefr_source": "A1" - } + "addestrare": { "cefr_source": "B1" }, + "insegnare": { "cefr_source": "A1" } }, "fr": { - "enseigner": { - "cefr_source": "A2" - }, - "apprendre": { - "cefr_source": "A1" - }, - "guider": { - "cefr_source": "A2" - } + "enseigner": { "cefr_source": "A2" }, + "apprendre": { "cefr_source": "A1" }, + "guider": { "cefr_source": "A2" } }, - "es": { - "enseñar": { - "cefr_source": "A1" - } - } + "es": { "enseñar": { "cefr_source": "A1" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -196,39 +105,19 @@ "source_id": "ili:i26718", "pos": "verb", "translations": { - "en": [ - "dub", - "nickname" - ], - "it": [ - "battezzare", - "cognominare", - "doppiare", - "soprannominare" - ], - "es": [ - "apodar" - ], - "fr": [ - "surnom", - "baptiser" - ] - }, - "glosses": { - "en": [ - "give a nickname to" - ] + "en": ["dub", "nickname"], + "it": ["battezzare", "cognominare", "doppiare", "soprannominare"], + "es": ["apodar"], + "fr": ["surnom", "baptiser"] }, + "glosses": { "en": ["give a nickname to"] }, "examples": { "it": [ { "text": "Hanno deciso di battezzare il loro figlio la prossima primavera.", "source": "cefr" }, - { - "text": "Lo hanno soprannominato 'il Professore'.", - "source": "cefr" - } + { "text": "Lo hanno soprannominato 'il Professore'.", "source": "cefr" } ], "fr": [ { @@ -238,24 +127,12 @@ ] }, "votes": { - "en": { - "dub": { - "cefr_source": "B2" - } - }, + "en": { "dub": { "cefr_source": "B2" } }, "it": { - "battezzare": { - "cefr_source": "B1" - }, - "soprannominare": { - "cefr_source": "B2" - } + "battezzare": { "cefr_source": "B1" }, + "soprannominare": { "cefr_source": "B2" } }, - "fr": { - "baptiser": { - "cefr_source": "B1" - } - } + "fr": { "baptiser": { "cefr_source": "B1" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -263,92 +140,46 @@ "source_id": "ili:i4448", "pos": "adjective", "translations": { - "en": [ - "drab", - "dreary" - ], - "es": [ - "igual", - "rutinario" - ], - "fr": [ - "morne", - "maussade", - "sombre" - ] - }, - "glosses": { - "en": [ - "lacking in liveliness or charm or surprise" - ] + "en": ["drab", "dreary"], + "es": ["igual", "rutinario"], + "fr": ["morne", "maussade", "sombre"] }, + "glosses": { "en": ["lacking in liveliness or charm or surprise"] }, "examples": { "en": [ - { - "text": "her drab personality", - "source": "omw" - }, + { "text": "her drab personality", "source": "omw" }, { "text": "life was drab compared with the more exciting life style overseas", "source": "omw" }, - { - "text": "a series of dreary dinner parties", - "source": "omw" - } + { "text": "a series of dreary dinner parties", "source": "omw" } ], "fr": [ - { - "text": "Le temps était morne et pluvieux.", - "source": "cefr" - }, + { "text": "Le temps était morne et pluvieux.", "source": "cefr" }, { "text": "Le temps était maussade toute la journée.", "source": "cefr" }, - { - "text": "La pièce était sombre sans lumière.", - "source": "cefr" - } + { "text": "La pièce était sombre sans lumière.", "source": "cefr" } ], "es": [ - { - "text": "Todos somos iguales.", - "source": "cefr" - }, - { - "text": "Su trabajo se ha vuelto muy rutinario.", - "source": "cefr" - } + { "text": "Todos somos iguales.", "source": "cefr" }, + { "text": "Su trabajo se ha vuelto muy rutinario.", "source": "cefr" } ] }, "votes": { "en": { - "drab": { - "cefr_source": "B2" - }, - "dreary": { - "cefr_source": "B2" - } + "drab": { "cefr_source": "B2" }, + "dreary": { "cefr_source": "B2" } }, "fr": { - "morne": { - "cefr_source": "B2" - }, - "maussade": { - "cefr_source": "B2" - }, - "sombre": { - "cefr_source": "B1" - } + "morne": { "cefr_source": "B2" }, + "maussade": { "cefr_source": "B2" }, + "sombre": { "cefr_source": "B1" } }, "es": { - "igual": { - "cefr_source": "A2" - }, - "rutinario": { - "cefr_source": "B1" - } + "igual": { "cefr_source": "A2" }, + "rutinario": { "cefr_source": "B1" } } }, "_sample_bucket": "has_cefr_vote" @@ -357,75 +188,30 @@ "source_id": "ili:i85845", "pos": "noun", "translations": { - "en": [ - "natural depression", - "depression" - ], - "it": [ - "avvallamento" - ], - "es": [ - "depresión", - "depresión natural" - ], - "fr": [ - "dépression" - ] - }, - "glosses": { - "en": [ - "a sunken or depressed geological formation" - ] + "en": ["natural depression", "depression"], + "it": ["avvallamento"], + "es": ["depresión", "depresión natural"], + "fr": ["dépression"] }, + "glosses": { "en": ["a sunken or depressed geological formation"] }, "examples": { - "fr": [ - { - "text": "Elle souffre de dépression.", - "source": "cefr" - } - ], + "fr": [{ "text": "Elle souffre de dépression.", "source": "cefr" }], "es": [ - { - "text": "La depresión es una enfermedad grave.", - "source": "cefr" - } + { "text": "La depresión es una enfermedad grave.", "source": "cefr" } ] }, "votes": { - "en": { - "depression": { - "cefr_source": "B2" - } - }, - "fr": { - "dépression": { - "cefr_source": "B2" - } - }, - "es": { - "depresión": { - "cefr_source": "B1" - } - } + "en": { "depression": { "cefr_source": "B2" } }, + "fr": { "dépression": { "cefr_source": "B2" } }, + "es": { "depresión": { "cefr_source": "B1" } } }, "_sample_bucket": "has_cefr_vote" }, { "source_id": "ili:i27202", "pos": "verb", - "translations": { - "en": [ - "jump" - ], - "fr": [ - "sauter" - ] - }, - "glosses": { - "en": [ - "make a sudden physical attack on" - ] - }, + "translations": { "en": ["jump"], "fr": ["sauter"] }, + "glosses": { "en": ["make a sudden physical attack on"] }, "examples": { "en": [ { @@ -441,16 +227,8 @@ ] }, "votes": { - "en": { - "jump": { - "cefr_source": "A1" - } - }, - "fr": { - "sauter": { - "cefr_source": "A2" - } - } + "en": { "jump": { "cefr_source": "A1" } }, + "fr": { "sauter": { "cefr_source": "A2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -465,15 +243,8 @@ "butt against", "knock against" ], - "it": [ - "urtare" - ], - "es": [ - "chocar", - "colisionar", - "golpearse contra", - "topar" - ], + "it": ["urtare"], + "es": ["chocar", "colisionar", "golpearse contra", "topar"], "de": [ "anraunzen", "anfahren", @@ -488,68 +259,32 @@ ] }, "glosses": { - "en": [ - "collide violently with an obstacle" - ], - "de": [ - "heftig mit einem Hindernis zusammenstoßen" - ] + "en": ["collide violently with an obstacle"], + "de": ["heftig mit einem Hindernis zusammenstoßen"] }, "examples": { - "en": [ - { - "text": "I ran into the telephone pole", - "source": "omw" - } - ], + "en": [{ "text": "I ran into the telephone pole", "source": "omw" }], "it": [ - { - "text": "Ho urtato il tavolo con il gomito.", - "source": "cefr" - } + { "text": "Ho urtato il tavolo con il gomito.", "source": "cefr" } ], "de": [ - { - "text": "Der Bus fuhr an die Haltestelle an.", - "source": "cefr" - }, - { - "text": "Er hat mich ohne Grund angeschrien.", - "source": "cefr" - } + { "text": "Der Bus fuhr an die Haltestelle an.", "source": "cefr" }, + { "text": "Er hat mich ohne Grund angeschrien.", "source": "cefr" } ], "es": [ - { - "text": "El coche chocó contra un árbol.", - "source": "cefr" - }, - { - "text": "Me topé con un viejo amigo en la calle.", - "source": "cefr" - } + { "text": "El coche chocó contra un árbol.", "source": "cefr" }, + { "text": "Me topé con un viejo amigo en la calle.", "source": "cefr" } ] }, "votes": { - "it": { - "urtare": { - "cefr_source": "B1" - } - }, + "it": { "urtare": { "cefr_source": "B1" } }, "de": { - "anfahren": { - "cefr_source": "B1" - }, - "anschreien": { - "cefr_source": "B1" - } + "anfahren": { "cefr_source": "B1" }, + "anschreien": { "cefr_source": "B1" } }, "es": { - "chocar": { - "cefr_source": "A2" - }, - "topar": { - "cefr_source": "B1" - } + "chocar": { "cefr_source": "A2" }, + "topar": { "cefr_source": "B1" } } }, "_sample_bucket": "has_cefr_vote" @@ -557,42 +292,19 @@ { "source_id": "ili:i27676", "pos": "verb", - "translations": { - "en": [ - "fumble" - ] - }, - "glosses": { - "en": [ - "handle clumsily" - ] - }, + "translations": { "en": ["fumble"] }, + "glosses": { "en": ["handle clumsily"] }, "examples": {}, - "votes": { - "en": { - "fumble": { - "cefr_source": "B2" - } - } - }, + "votes": { "en": { "fumble": { "cefr_source": "B2" } } }, "_sample_bucket": "has_cefr_vote" }, { "source_id": "ili:i30768", "pos": "verb", "translations": { - "en": [ - "attract", - "appeal" - ], - "it": [ - "allettare", - "attirare", - "attrarre" - ], - "es": [ - "atraer" - ], + "en": ["attract", "appeal"], + "it": ["allettare", "attirare", "attrarre"], + "es": ["atraer"], "de": [ "anziehen", "etwas überziehen", @@ -604,98 +316,51 @@ "ankleiden", "Kleidung anlegen" ], - "fr": [ - "allécher", - "attirer" - ] + "fr": ["allécher", "attirer"] }, "glosses": { - "en": [ - "be attractive to" - ], + "en": ["be attractive to"], "de": [ "ein Kleidungsstück in der dafür vorgesehenen Weise auf den Körper bringen" ] }, "examples": { "en": [ - { - "text": "The idea of a vacation appeals to me", - "source": "omw" - }, + { "text": "The idea of a vacation appeals to me", "source": "omw" }, { "text": "The beautiful garden attracted many people", "source": "omw" } ], - "de": [ - { - "text": "Sie zog sich das Kleid an.", - "source": "omw" - } - ], + "de": [{ "text": "Sie zog sich das Kleid an.", "source": "omw" }], "it": [ - { - "text": "Il nuovo negozio attira molti clienti.", - "source": "cefr" - }, - { - "text": "Il magnete attrae il metallo.", - "source": "cefr" - } + { "text": "Il nuovo negozio attira molti clienti.", "source": "cefr" }, + { "text": "Il magnete attrae il metallo.", "source": "cefr" } ], "fr": [ { "text": "La promesse d'un salaire élevé a alléché de nombreux candidats.", "source": "cefr" }, - { - "text": "Cette publicité attire l'attention.", - "source": "cefr" - } + { "text": "Cette publicité attire l'attention.", "source": "cefr" } ], - "es": [ - { - "text": "El imán atrae el metal.", - "source": "cefr" - } - ] + "es": [{ "text": "El imán atrae el metal.", "source": "cefr" }] }, "votes": { - "en": { - "attract": { - "cefr_source": "B1" - } - }, + "en": { "attract": { "cefr_source": "B1" } }, "it": { - "attirare": { - "cefr_source": "B2" - }, - "attrarre": { - "cefr_source": "B1" - } + "attirare": { "cefr_source": "B2" }, + "attrarre": { "cefr_source": "B1" } }, "de": { - "anziehen": { - "cefr_source": "A2" - }, - "bekleiden": { - "cefr_source": "B2" - } + "anziehen": { "cefr_source": "A2" }, + "bekleiden": { "cefr_source": "B2" } }, "fr": { - "allécher": { - "cefr_source": "C1" - }, - "attirer": { - "cefr_source": "B1" - } + "allécher": { "cefr_source": "C1" }, + "attirer": { "cefr_source": "B1" } }, - "es": { - "atraer": { - "cefr_source": "B2" - } - } + "es": { "atraer": { "cefr_source": "B2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -703,23 +368,11 @@ "source_id": "ili:i112909", "pos": "noun", "translations": { - "en": [ - "regulation" - ], - "es": [ - "reglamento" - ], - "fr": [ - "réglementation", - "gouvernement", - "tenue" - ] - }, - "glosses": { - "en": [ - "the state of being controlled or governed" - ] + "en": ["regulation"], + "es": ["reglamento"], + "fr": ["réglementation", "gouvernement", "tenue"] }, + "glosses": { "en": ["the state of being controlled or governed"] }, "examples": { "fr": [ { @@ -735,35 +388,16 @@ "source": "cefr" } ], - "es": [ - { - "text": "Debemos seguir el reglamento.", - "source": "cefr" - } - ] + "es": [{ "text": "Debemos seguir el reglamento.", "source": "cefr" }] }, "votes": { - "en": { - "regulation": { - "cefr_source": "B2" - } - }, + "en": { "regulation": { "cefr_source": "B2" } }, "fr": { - "réglementation": { - "cefr_source": "B2" - }, - "gouvernement": { - "cefr_source": "B1" - }, - "tenue": { - "cefr_source": "B1" - } + "réglementation": { "cefr_source": "B2" }, + "gouvernement": { "cefr_source": "B1" }, + "tenue": { "cefr_source": "B1" } }, - "es": { - "reglamento": { - "cefr_source": "B2" - } - } + "es": { "reglamento": { "cefr_source": "B2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -778,12 +412,8 @@ "ladybird", "ladybird beetle" ], - "it": [ - "coccinella" - ], - "fr": [ - "coccinelle" - ] + "it": ["coccinella"], + "fr": ["coccinelle"] }, "glosses": { "en": [ @@ -792,23 +422,12 @@ }, "examples": { "fr": [ - { - "text": "Une coccinelle s'est posée sur ma main.", - "source": "cefr" - } + { "text": "Une coccinelle s'est posée sur ma main.", "source": "cefr" } ] }, "votes": { - "en": { - "ladybug": { - "cefr_source": "A2" - } - }, - "fr": { - "coccinelle": { - "cefr_source": "A2" - } - } + "en": { "ladybug": { "cefr_source": "A2" } }, + "fr": { "coccinelle": { "cefr_source": "A2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -816,56 +435,32 @@ "source_id": "ili:i15517", "pos": "adjective", "translations": { - "en": [ - "judicial" - ], - "it": [ - "giudiziale", - "giudiziario" - ], - "es": [ - "judicial" - ], + "en": ["judicial"], + "it": ["giudiziale", "giudiziario"], + "es": ["judicial"], "de": [ "durch einen Richter", "durch ein Gericht", "durch den Richter", "richterlich" ], - "fr": [ - "judiciaire" - ] + "fr": ["judiciaire"] }, "glosses": { - "en": [ - "belonging or appropriate to the office of a judge" - ], - "de": [ - "zum Amt eines Richters gehörend oder diesem zugehörig" - ] + "en": ["belonging or appropriate to the office of a judge"], + "de": ["zum Amt eines Richters gehörend oder diesem zugehörig"] }, "examples": { - "en": [ - { - "text": "judicial robes", - "source": "omw" - } - ], + "en": [{ "text": "judicial robes", "source": "omw" }], "it": [ - { - "text": "Hanno avviato un'azione giudiziale.", - "source": "cefr" - }, + { "text": "Hanno avviato un'azione giudiziale.", "source": "cefr" }, { "text": "Il sistema giudiziario italiano è complesso.", "source": "cefr" } ], "de": [ - { - "text": "Es bedarf einer richterlichen Anordnung.", - "source": "cefr" - } + { "text": "Es bedarf einer richterlichen Anordnung.", "source": "cefr" } ], "fr": [ { @@ -873,104 +468,37 @@ "source": "cefr" } ], - "es": [ - { - "text": "El proceso judicial fue largo.", - "source": "cefr" - } - ] + "es": [{ "text": "El proceso judicial fue largo.", "source": "cefr" }] }, "votes": { - "en": { - "judicial": { - "cefr_source": "C1" - } - }, + "en": { "judicial": { "cefr_source": "C1" } }, "it": { - "giudiziale": { - "cefr_source": "C1" - }, - "giudiziario": { - "cefr_source": "C1" - } + "giudiziale": { "cefr_source": "C1" }, + "giudiziario": { "cefr_source": "C1" } }, - "de": { - "richterlich": { - "cefr_source": "C1" - } - }, - "fr": { - "judiciaire": { - "cefr_source": "B2" - } - }, - "es": { - "judicial": { - "cefr_source": "C1" - } - } + "de": { "richterlich": { "cefr_source": "C1" } }, + "fr": { "judiciaire": { "cefr_source": "B2" } }, + "es": { "judicial": { "cefr_source": "C1" } } }, "_sample_bucket": "has_cefr_vote" }, { "source_id": "ili:i11095", "pos": "adjective", - "translations": { - "en": [ - "poor" - ], - "es": [ - "pobre" - ], - "fr": [ - "pauvre" - ] - }, - "glosses": { - "en": [ - "characterized by or indicating poverty" - ] - }, + "translations": { "en": ["poor"], "es": ["pobre"], "fr": ["pauvre"] }, + "glosses": { "en": ["characterized by or indicating poverty"] }, "examples": { "en": [ - { - "text": "the country had a poor economy", - "source": "omw" - }, - { - "text": "they lived in the poor section of town", - "source": "omw" - } + { "text": "the country had a poor economy", "source": "omw" }, + { "text": "they lived in the poor section of town", "source": "omw" } ], - "fr": [ - { - "text": "Il est très pauvre.", - "source": "cefr" - } - ], - "es": [ - { - "text": "Es un hombre muy pobre.", - "source": "cefr" - } - ] + "fr": [{ "text": "Il est très pauvre.", "source": "cefr" }], + "es": [{ "text": "Es un hombre muy pobre.", "source": "cefr" }] }, "votes": { - "en": { - "poor": { - "cefr_source": "A2" - } - }, - "fr": { - "pauvre": { - "cefr_source": "A1" - } - }, - "es": { - "pobre": { - "cefr_source": "A1" - } - } + "en": { "poor": { "cefr_source": "A2" } }, + "fr": { "pauvre": { "cefr_source": "A1" } }, + "es": { "pobre": { "cefr_source": "A1" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -988,10 +516,7 @@ "tawdriness", "glitz" ], - "it": [ - "pacchianeria", - "vistosità" - ], + "it": ["pacchianeria", "vistosità"], "es": [ "astracanada", "chabacanería", @@ -1001,22 +526,12 @@ "ordinariez", "zafiedad" ], - "de": [ - "Aufdringlichkeit", - "Zudringlichkeit", - "Penetranz" - ], - "fr": [ - "culot" - ] + "de": ["Aufdringlichkeit", "Zudringlichkeit", "Penetranz"], + "fr": ["culot"] }, "glosses": { - "en": [ - "tasteless showiness" - ], - "de": [ - "geschmacklose Aufdringlichkeit" - ] + "en": ["tasteless showiness"], + "de": ["geschmacklose Aufdringlichkeit"] }, "examples": { "fr": [ @@ -1028,18 +543,10 @@ }, "votes": { "en": { - "loudness": { - "cefr_source": "B2" - }, - "glitz": { - "cefr_source": "B2" - } + "loudness": { "cefr_source": "B2" }, + "glitz": { "cefr_source": "B2" } }, - "fr": { - "culot": { - "cefr_source": "B2" - } - } + "fr": { "culot": { "cefr_source": "B2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -1047,52 +554,19 @@ "source_id": "ili:i22613", "pos": "verb", "translations": { - "en": [ - "scavenge", - "clean" - ], - "es": [ - "limpiar" - ], - "fr": [ - "nettoyer" - ] - }, - "glosses": { - "en": [ - "remove unwanted substances from" - ] + "en": ["scavenge", "clean"], + "es": ["limpiar"], + "fr": ["nettoyer"] }, + "glosses": { "en": ["remove unwanted substances from"] }, "examples": { - "fr": [ - { - "text": "Je dois nettoyer ma chambre.", - "source": "cefr" - } - ], - "es": [ - { - "text": "Necesito limpiar mi habitación.", - "source": "cefr" - } - ] + "fr": [{ "text": "Je dois nettoyer ma chambre.", "source": "cefr" }], + "es": [{ "text": "Necesito limpiar mi habitación.", "source": "cefr" }] }, "votes": { - "en": { - "scavenge": { - "cefr_source": "B2" - } - }, - "fr": { - "nettoyer": { - "cefr_source": "A1" - } - }, - "es": { - "limpiar": { - "cefr_source": "A1" - } - } + "en": { "scavenge": { "cefr_source": "B2" } }, + "fr": { "nettoyer": { "cefr_source": "A1" } }, + "es": { "limpiar": { "cefr_source": "A1" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -1100,35 +574,15 @@ "source_id": "ili:i4857", "pos": "adjective", "translations": { - "en": [ - "enthusiastic" - ], - "it": [ - "caloroso", - "entusiastico", - "fervido", - "entusiasta" - ], - "fr": [ - "courageux", - "enthousiaste" - ] - }, - "glosses": { - "en": [ - "having or showing great excitement and interest" - ] + "en": ["enthusiastic"], + "it": ["caloroso", "entusiastico", "fervido", "entusiasta"], + "fr": ["courageux", "enthousiaste"] }, + "glosses": { "en": ["having or showing great excitement and interest"] }, "examples": { "en": [ - { - "text": "enthusiastic crowds filled the streets", - "source": "omw" - }, - { - "text": "an enthusiastic response", - "source": "omw" - }, + { "text": "enthusiastic crowds filled the streets", "source": "omw" }, + { "text": "an enthusiastic response", "source": "omw" }, { "text": "was enthusiastic about taking ballet lessons", "source": "omw" @@ -1143,16 +597,10 @@ "text": "Ha espresso un fervido desiderio di pace.", "source": "cefr" }, - { - "text": "Era molto entusiasta del nuovo progetto.", - "source": "cefr" - } + { "text": "Era molto entusiasta del nuovo progetto.", "source": "cefr" } ], "fr": [ - { - "text": "C'est une personne très courageuse.", - "source": "cefr" - }, + { "text": "C'est une personne très courageuse.", "source": "cefr" }, { "text": "Elle est très enthousiaste à l'idée de ce voyage.", "source": "cefr" @@ -1160,29 +608,15 @@ ] }, "votes": { - "en": { - "enthusiastic": { - "cefr_source": "B1" - } - }, + "en": { "enthusiastic": { "cefr_source": "B1" } }, "it": { - "caloroso": { - "cefr_source": "B1" - }, - "fervido": { - "cefr_source": "C1" - }, - "entusiasta": { - "cefr_source": "B1" - } + "caloroso": { "cefr_source": "B1" }, + "fervido": { "cefr_source": "C1" }, + "entusiasta": { "cefr_source": "B1" } }, "fr": { - "courageux": { - "cefr_source": "A2" - }, - "enthousiaste": { - "cefr_source": "B1" - } + "courageux": { "cefr_source": "A2" }, + "enthousiaste": { "cefr_source": "B1" } } }, "_sample_bucket": "has_cefr_vote" @@ -1191,13 +625,8 @@ "source_id": "ili:i104521", "pos": "noun", "translations": { - "en": [ - "veronica", - "speedwell" - ], - "it": [ - "veronica" - ], + "en": ["veronica", "speedwell"], + "it": ["veronica"], "de": [ "Allerweltsheil", "Grundheil", @@ -1206,18 +635,11 @@ "Köhlerkraut", "Schlangenkraut" ], - "fr": [ - "veronica", - "véronique" - ] + "fr": ["veronica", "véronique"] }, "glosses": { - "en": [ - "any plant of the genus Veronica" - ], - "de": [ - "jede Pflanze der Gattung Veronica" - ] + "en": ["any plant of the genus Veronica"], + "de": ["jede Pflanze der Gattung Veronica"] }, "examples": { "de": [ @@ -1227,56 +649,21 @@ } ] }, - "votes": { - "de": { - "Ehrenpreis": { - "cefr_source": "C1" - } - } - }, + "votes": { "de": { "Ehrenpreis": { "cefr_source": "C1" } } }, "_sample_bucket": "has_cefr_vote" }, { "source_id": "ili:i958", "pos": "adjective", - "translations": { - "en": [ - "gracious" - ], - "es": [ - "amable" - ] - }, - "glosses": { - "en": [ - "disposed to bestow favors" - ] - }, + "translations": { "en": ["gracious"], "es": ["amable"] }, + "glosses": { "en": ["disposed to bestow favors"] }, "examples": { - "en": [ - { - "text": "thanks to the gracious gods", - "source": "omw" - } - ], - "es": [ - { - "text": "Siempre es muy amable con todos.", - "source": "cefr" - } - ] + "en": [{ "text": "thanks to the gracious gods", "source": "omw" }], + "es": [{ "text": "Siempre es muy amable con todos.", "source": "cefr" }] }, "votes": { - "en": { - "gracious": { - "cefr_source": "B2" - } - }, - "es": { - "amable": { - "cefr_source": "A2" - } - } + "en": { "gracious": { "cefr_source": "B2" } }, + "es": { "amable": { "cefr_source": "A2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -1284,23 +671,11 @@ "source_id": "ili:i109447", "pos": "noun", "translations": { - "en": [ - "declension" - ], - "it": [ - "declinazione" - ], - "es": [ - "declinación" - ], - "de": [ - "Deklination", - "Ortsmissweisung", - "Missweisung" - ], - "fr": [ - "déclinaison" - ] + "en": ["declension"], + "it": ["declinazione"], + "es": ["declinación"], + "de": ["Deklination", "Ortsmissweisung", "Missweisung"], + "fr": ["déclinaison"] }, "glosses": { "en": [ @@ -1318,23 +693,12 @@ } ], "fr": [ - { - "text": "En latin, les noms ont des déclinaisons.", - "source": "cefr" - } + { "text": "En latin, les noms ont des déclinaisons.", "source": "cefr" } ] }, "votes": { - "it": { - "declinazione": { - "cefr_source": "B2" - } - }, - "fr": { - "déclinaison": { - "cefr_source": "C1" - } - } + "it": { "declinazione": { "cefr_source": "B2" } }, + "fr": { "déclinaison": { "cefr_source": "C1" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -1342,29 +706,14 @@ "source_id": "ili:i18812", "pos": "adverb", "translations": { - "en": [ - "fairly", - "fair", - "evenhandedly" - ], - "es": [ - "con justicia", - "imparcialmente", - "justamente" - ] + "en": ["fairly", "fair", "evenhandedly"], + "es": ["con justicia", "imparcialmente", "justamente"] }, "glosses": { - "en": [ - "without favoring one party, in a fair evenhanded manner" - ] + "en": ["without favoring one party, in a fair evenhanded manner"] }, "examples": { - "en": [ - { - "text": "deal fairly with one another", - "source": "omw" - } - ], + "en": [{ "text": "deal fairly with one another", "source": "omw" }], "es": [ { "text": "Llegó justamente a tiempo para la reunión.", @@ -1373,16 +722,8 @@ ] }, "votes": { - "en": { - "fairly": { - "cefr_source": "B1" - } - }, - "es": { - "justamente": { - "cefr_source": "B2" - } - } + "en": { "fairly": { "cefr_source": "B1" } }, + "es": { "justamente": { "cefr_source": "B2" } } }, "_sample_bucket": "has_cefr_vote" }, @@ -1390,23 +731,11 @@ "source_id": "ili:i44747", "pos": "noun", "translations": { - "en": [ - "Centrocercus", - "genus Centrocercus" - ], - "es": [ - "Centrocercus", - "género Centrocercus" - ], - "fr": [ - "centrocercus" - ] - }, - "glosses": { - "en": [ - "sage grouse" - ] + "en": ["Centrocercus", "genus Centrocercus"], + "es": ["Centrocercus", "género Centrocercus"], + "fr": ["centrocercus"] }, + "glosses": { "en": ["sage grouse"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1414,16 +743,8 @@ { "source_id": "ili:i20736", "pos": "adverb", - "translations": { - "en": [ - "insinuatingly" - ] - }, - "glosses": { - "en": [ - "in an insinuating manner" - ] - }, + "translations": { "en": ["insinuatingly"] }, + "glosses": { "en": ["in an insinuating manner"] }, "examples": { "en": [ { @@ -1438,16 +759,8 @@ { "source_id": "ili:i25017", "pos": "verb", - "translations": { - "en": [ - "superordinate" - ] - }, - "glosses": { - "en": [ - "place in a superior order or rank" - ] - }, + "translations": { "en": ["superordinate"] }, + "glosses": { "en": ["place in a superior order or rank"] }, "examples": { "en": [ { @@ -1463,9 +776,7 @@ "source_id": "ili:i46616", "pos": "noun", "translations": { - "en": [ - "sand cat" - ], + "en": ["sand cat"], "fr": [ "chat de marguerite", "chat du désert", @@ -1473,11 +784,7 @@ "chat des sables" ] }, - "glosses": { - "en": [ - "a desert wildcat" - ] - }, + "glosses": { "en": ["a desert wildcat"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1485,15 +792,9 @@ { "source_id": "ili:i83491", "pos": "noun", - "translations": { - "en": [ - "Bangor" - ] - }, + "translations": { "en": ["Bangor"] }, "glosses": { - "en": [ - "a university town in northwestern Wales on the Menai Strait" - ] + "en": ["a university town in northwestern Wales on the Menai Strait"] }, "examples": {}, "votes": {}, @@ -1503,19 +804,11 @@ "source_id": "ili:i72819", "pos": "noun", "translations": { - "en": [ - "Missouri" - ], - "fr": [ - "Saint Peters", - "Joplin", - "Missouri" - ] + "en": ["Missouri"], + "fr": ["Saint Peters", "Joplin", "Missouri"] }, "glosses": { - "en": [ - "a dialect of the Chiwere language spoken by the Missouri" - ] + "en": ["a dialect of the Chiwere language spoken by the Missouri"] }, "examples": {}, "votes": {}, @@ -1525,18 +818,9 @@ "source_id": "ili:i99797", "pos": "noun", "translations": { - "en": [ - "prickly poppy", - "argemone", - "white thistle", - "devil's fig" - ], - "es": [ - "argemone" - ], - "fr": [ - "argemone" - ] + "en": ["prickly poppy", "argemone", "white thistle", "devil's fig"], + "es": ["argemone"], + "fr": ["argemone"] }, "glosses": { "en": [ @@ -1551,26 +835,12 @@ "source_id": "ili:i90317", "pos": "noun", "translations": { - "en": [ - "great-uncle", - "granduncle" - ], - "it": [ - "protio", - "prozio" - ], - "es": [ - "tío abuelo" - ], - "fr": [ - "grand-oncle" - ] - }, - "glosses": { - "en": [ - "an uncle of your father or mother" - ] + "en": ["great-uncle", "granduncle"], + "it": ["protio", "prozio"], + "es": ["tío abuelo"], + "fr": ["grand-oncle"] }, + "glosses": { "en": ["an uncle of your father or mother"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1579,19 +849,10 @@ "source_id": "ili:i53881", "pos": "noun", "translations": { - "en": [ - "flour bin" - ], - "es": [ - "frasco de harina", - "tarro de harina" - ] - }, - "glosses": { - "en": [ - "a bin for holding flour" - ] + "en": ["flour bin"], + "es": ["frasco de harina", "tarro de harina"] }, + "glosses": { "en": ["a bin for holding flour"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1599,19 +860,8 @@ { "source_id": "ili:i58210", "pos": "noun", - "translations": { - "en": [ - "road map" - ], - "fr": [ - "carte routière" - ] - }, - "glosses": { - "en": [ - "a map showing roads (for automobile travel)" - ] - }, + "translations": { "en": ["road map"], "fr": ["carte routière"] }, + "glosses": { "en": ["a map showing roads (for automobile travel)"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1620,15 +870,10 @@ "source_id": "ili:i82638", "pos": "noun", "translations": { - "en": [ - "South American country", - "South American nation" - ] + "en": ["South American country", "South American nation"] }, "glosses": { - "en": [ - "any one of the countries occupying the South American continent" - ] + "en": ["any one of the countries occupying the South American continent"] }, "examples": {}, "votes": {}, @@ -1638,17 +883,9 @@ "source_id": "ili:i71111", "pos": "noun", "translations": { - "en": [ - "weekly" - ], - "it": [ - "ebdomadario", - "eddomadario", - "settimanale" - ], - "fr": [ - "hebdomadaire" - ] + "en": ["weekly"], + "it": ["ebdomadario", "eddomadario", "settimanale"], + "fr": ["hebdomadaire"] }, "glosses": { "en": [ @@ -1662,47 +899,17 @@ { "source_id": "ili:i10131", "pos": "adjective", - "translations": { - "en": [ - "embattled" - ], - "it": [ - "GAP!", - "in difficoltà" - ] - }, - "glosses": { - "en": [ - "prepared for battle" - ] - }, - "examples": { - "en": [ - { - "text": "an embattled city", - "source": "omw" - } - ] - }, + "translations": { "en": ["embattled"], "it": ["GAP!", "in difficoltà"] }, + "glosses": { "en": ["prepared for battle"] }, + "examples": { "en": [{ "text": "an embattled city", "source": "omw" }] }, "votes": {}, "_sample_bucket": "no_cefr_vote" }, { "source_id": "ili:i108195", "pos": "noun", - "translations": { - "en": [ - "mass unit" - ], - "es": [ - "unidad de masa" - ] - }, - "glosses": { - "en": [ - "a unit of measurement for mass" - ] - }, + "translations": { "en": ["mass unit"], "es": ["unidad de masa"] }, + "glosses": { "en": ["a unit of measurement for mass"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1710,11 +917,7 @@ { "source_id": "ili:i82225", "pos": "noun", - "translations": { - "en": [ - "Wrangell-St. Elias National Park" - ] - }, + "translations": { "en": ["Wrangell-St. Elias National Park"] }, "glosses": { "en": [ "the largest national park of the United States; located in Alaska" @@ -1728,20 +931,10 @@ "source_id": "ili:i47159", "pos": "noun", "translations": { - "en": [ - "Fenusa", - "genus-Fenusa" - ], - "es": [ - "Fenusa", - "género Fenusa" - ] - }, - "glosses": { - "en": [ - "birch leaf miner" - ] + "en": ["Fenusa", "genus-Fenusa"], + "es": ["Fenusa", "género Fenusa"] }, + "glosses": { "en": ["birch leaf miner"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1749,16 +942,8 @@ { "source_id": "ili:i106504", "pos": "noun", - "translations": { - "en": [ - "entail" - ] - }, - "glosses": { - "en": [ - "land received by fee tail" - ] - }, + "translations": { "en": ["entail"] }, + "glosses": { "en": ["land received by fee tail"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1767,19 +952,10 @@ "source_id": "ili:i46047", "pos": "noun", "translations": { - "en": [ - "Polynesian tattler", - "Heteroscelus incanus" - ], - "fr": [ - "heteroscelus incanus" - ] - }, - "glosses": { - "en": [ - "tattler of Pacific coastal regions" - ] + "en": ["Polynesian tattler", "Heteroscelus incanus"], + "fr": ["heteroscelus incanus"] }, + "glosses": { "en": ["tattler of Pacific coastal regions"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_cefr_vote" @@ -1787,11 +963,7 @@ { "source_id": "ili:i71598", "pos": "noun", - "translations": { - "en": [ - "market letter" - ] - }, + "translations": { "en": ["market letter"] }, "glosses": { "en": [ "a newsletter written by an analyst of the stock market and sold to subscribers" @@ -1805,29 +977,11 @@ "source_id": "ili:i115719", "pos": "noun", "translations": { - "en": [ - "monosaccharide", - "monosaccharose", - "simple sugar" - ], - "it": [ - "manosio", - "monosaccaride", - "monosio", - "monoso" - ], - "es": [ - "monosacárido" - ], - "de": [ - "Monosaccharid", - "Einfachzucker" - ], - "fr": [ - "ose", - "Ose", - "monosaccharide" - ] + "en": ["monosaccharide", "monosaccharose", "simple sugar"], + "it": ["manosio", "monosaccaride", "monosio", "monoso"], + "es": ["monosacárido"], + "de": ["Monosaccharid", "Einfachzucker"], + "fr": ["ose", "Ose", "monosaccharide"] }, "glosses": { "en": [ @@ -1845,11 +999,7 @@ "source_id": "ili:i74228", "pos": "noun", "translations": { - "en": [ - "negotiation", - "dialogue", - "talks" - ], + "en": ["negotiation", "dialogue", "talks"], "it": [ "contrattazione", "deal", @@ -1858,27 +1008,13 @@ "negoziazione", "trattativa" ], - "es": [ - "gestión", - "negociación", - "tramitación" - ], - "de": [ - "Besprechung", - "Verhandlung" - ], - "fr": [ - "dialogue", - "négociation" - ] + "es": ["gestión", "negociación", "tramitación"], + "de": ["Besprechung", "Verhandlung"], + "fr": ["dialogue", "négociation"] }, "glosses": { - "en": [ - "a discussion intended to produce an agreement" - ], - "de": [ - "Diskussion zur Ausarbeitung eines Abkommens" - ] + "en": ["a discussion intended to produce an agreement"], + "de": ["Diskussion zur Ausarbeitung eines Abkommens"] }, "examples": { "en": [ @@ -1886,24 +1022,15 @@ "text": "the buyout negotiation lasted several days", "source": "omw" }, - { - "text": "they disagreed but kept an open dialogue", - "source": "omw" - }, - { - "text": "talks between Israelis and Palestinians", - "source": "omw" - } + { "text": "they disagreed but kept an open dialogue", "source": "omw" }, + { "text": "talks between Israelis and Palestinians", "source": "omw" } ], "it": [ { "text": "La contrattazione collettiva è importante per i lavoratori.", "source": "cefr" }, - { - "text": "Abbiamo chiuso un buon deal.", - "source": "cefr" - }, + { "text": "Abbiamo chiuso un buon deal.", "source": "cefr" }, { "text": "È importante mantenere un dialogo aperto.", "source": "cefr" @@ -1916,10 +1043,7 @@ "text": "Le negoziazioni per il nuovo contratto sono state lunghe e complesse.", "source": "cefr" }, - { - "text": "Le trattative sono in corso.", - "source": "cefr" - } + { "text": "Le trattative sono in corso.", "source": "cefr" } ], "de": [ { @@ -1942,14 +1066,8 @@ } ], "es": [ - { - "text": "La gestión del proyecto fue excelente.", - "source": "cefr" - }, - { - "text": "Las negociaciones fueron difíciles.", - "source": "cefr" - }, + { "text": "La gestión del proyecto fue excelente.", "source": "cefr" }, + { "text": "Las negociaciones fueron difíciles.", "source": "cefr" }, { "text": "La tramitación de los documentos puede llevar tiempo.", "source": "cefr" @@ -1958,59 +1076,29 @@ }, "votes": { "en": { - "negotiation": { - "cefr_source": "B2" - }, - "dialogue": { - "cefr_source": "B2" - } + "negotiation": { "cefr_source": "B2" }, + "dialogue": { "cefr_source": "B2" } }, "it": { - "contrattazione": { - "cefr_source": "B2" - }, - "deal": { - "cefr_source": "B1" - }, - "dialogo": { - "cefr_source": "B1" - }, - "negoziato": { - "cefr_source": "B2" - }, - "negoziazione": { - "cefr_source": "B2" - }, - "trattativa": { - "cefr_source": "B2" - } + "contrattazione": { "cefr_source": "B2" }, + "deal": { "cefr_source": "B1" }, + "dialogo": { "cefr_source": "B1" }, + "negoziato": { "cefr_source": "B2" }, + "negoziazione": { "cefr_source": "B2" }, + "trattativa": { "cefr_source": "B2" } }, "de": { - "Besprechung": { - "cefr_source": "B1" - }, - "Verhandlung": { - "cefr_source": "B2" - } + "Besprechung": { "cefr_source": "B1" }, + "Verhandlung": { "cefr_source": "B2" } }, "fr": { - "dialogue": { - "cefr_source": "B1" - }, - "négociation": { - "cefr_source": "B2" - } + "dialogue": { "cefr_source": "B1" }, + "négociation": { "cefr_source": "B2" } }, "es": { - "gestión": { - "cefr_source": "B2" - }, - "negociación": { - "cefr_source": "B2" - }, - "tramitación": { - "cefr_source": "B2" - } + "gestión": { "cefr_source": "B2" }, + "negociación": { "cefr_source": "B2" }, + "tramitación": { "cefr_source": "B2" } } }, "_sample_bucket": "has_glosses_and_examples" @@ -2019,13 +1107,8 @@ "source_id": "ili:i408", "pos": "adjective", "translations": { - "en": [ - "aground" - ], - "es": [ - "encallado", - "varado" - ], + "en": ["aground"], + "es": ["encallado", "varado"], "de": [ "aufgrund", "dank", @@ -2037,48 +1120,28 @@ ] }, "glosses": { - "en": [ - "stuck in a place where a ship can no longer float" - ], + "en": ["stuck in a place where a ship can no longer float"], "de": [ "an einer Stelle feststecken, an der ein Schiff nicht mehr schwimmen kann" ] }, "examples": { "en": [ - { - "text": "a ship aground offshore", - "source": "omw" - }, + { "text": "a ship aground offshore", "source": "omw" }, { "text": "a boat aground on the beach waiting for the tide to lift it", "source": "omw" } ], - "es": [ - { - "text": "El barco quedó varado en la arena.", - "source": "cefr" - } - ] - }, - "votes": { - "es": { - "varado": { - "cefr_source": "B2" - } - } + "es": [{ "text": "El barco quedó varado en la arena.", "source": "cefr" }] }, + "votes": { "es": { "varado": { "cefr_source": "B2" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i41575", "pos": "noun", - "translations": { - "en": [ - "walkout" - ] - }, + "translations": { "en": ["walkout"] }, "glosses": { "en": [ "the act of walking out (of a meeting or organization) as a sign of protest" @@ -2092,31 +1155,14 @@ } ] }, - "votes": { - "en": { - "walkout": { - "cefr_source": "B2" - } - } - }, + "votes": { "en": { "walkout": { "cefr_source": "B2" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i67480", "pos": "noun", - "translations": { - "en": [ - "tasting" - ], - "fr": [ - "dégustation" - ] - }, - "glosses": { - "en": [ - "a small amount (especially of food or wine)" - ] - }, + "translations": { "en": ["tasting"], "fr": ["dégustation"] }, + "glosses": { "en": ["a small amount (especially of food or wine)"] }, "examples": { "fr": [ { @@ -2126,40 +1172,19 @@ ] }, "votes": { - "en": { - "tasting": { - "cefr_source": "B1" - } - }, - "fr": { - "dégustation": { - "cefr_source": "B1" - } - } + "en": { "tasting": { "cefr_source": "B1" } }, + "fr": { "dégustation": { "cefr_source": "B1" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i11256", "pos": "adjective", - "translations": { - "en": [ - "hobnailed" - ] - }, + "translations": { "en": ["hobnailed"] }, "glosses": { - "en": [ - "marked by the wearing of heavy boots studded with hobnails" - ] - }, - "examples": { - "en": [ - { - "text": "hobnailed laborers", - "source": "omw" - } - ] + "en": ["marked by the wearing of heavy boots studded with hobnails"] }, + "examples": { "en": [{ "text": "hobnailed laborers", "source": "omw" }] }, "votes": {}, "_sample_bucket": "has_glosses_and_examples" }, @@ -2167,145 +1192,74 @@ "source_id": "ili:i86151", "pos": "noun", "translations": { - "en": [ - "sediment", - "deposit" - ], - "it": [ - "deposito", - "posatura", - "sedimento" - ], - "es": [ - "depósito", - "sedimento" - ], + "en": ["sediment", "deposit"], + "it": ["deposito", "posatura", "sedimento"], + "es": ["depósito", "sedimento"], "de": [ "Ablagerung", "Sedimentation", "Sedimentierung", "Sedimentbildung" ], - "fr": [ - "sédiment", - "dépôt" - ] + "fr": ["sédiment", "dépôt"] }, "glosses": { - "en": [ - "matter that has been deposited by some natural process" - ], - "de": [ - "Materie, die durch einen natürlichen Prozess abgelagert wurde" - ] + "en": ["matter that has been deposited by some natural process"], + "de": ["Materie, die durch einen natürlichen Prozess abgelagert wurde"] }, "examples": { "it": [ - { - "text": "Ho lasciato i bagagli al deposito.", - "source": "cefr" - }, + { "text": "Ho lasciato i bagagli al deposito.", "source": "cefr" }, { "text": "C'era un sedimento sul fondo della bottiglia.", "source": "cefr" } ], "de": [ - { - "text": "Es gab Ablagerungen in den Rohren.", - "source": "cefr" - } + { "text": "Es gab Ablagerungen in den Rohren.", "source": "cefr" } ], "fr": [ { "text": "Le sédiment au fond du lac est très fin.", "source": "cefr" }, - { - "text": "J'ai fait un dépôt à la banque.", - "source": "cefr" - } + { "text": "J'ai fait un dépôt à la banque.", "source": "cefr" } ], - "es": [ - { - "text": "Hice un depósito en el banco.", - "source": "cefr" - } - ] + "es": [{ "text": "Hice un depósito en el banco.", "source": "cefr" }] }, "votes": { "en": { - "sediment": { - "cefr_source": "C1" - }, - "deposit": { - "cefr_source": "B1" - } + "sediment": { "cefr_source": "C1" }, + "deposit": { "cefr_source": "B1" } }, "it": { - "deposito": { - "cefr_source": "B1" - }, - "sedimento": { - "cefr_source": "B2" - } - }, - "de": { - "Ablagerung": { - "cefr_source": "B2" - } + "deposito": { "cefr_source": "B1" }, + "sedimento": { "cefr_source": "B2" } }, + "de": { "Ablagerung": { "cefr_source": "B2" } }, "fr": { - "sédiment": { - "cefr_source": "B2" - }, - "dépôt": { - "cefr_source": "B1" - } + "sédiment": { "cefr_source": "B2" }, + "dépôt": { "cefr_source": "B1" } }, - "es": { - "depósito": { - "cefr_source": "B1" - } - } + "es": { "depósito": { "cefr_source": "B1" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i45550", "pos": "noun", - "translations": { - "en": [ - "conch" - ], - "fr": [ - "conque" - ] - }, + "translations": { "en": ["conch"], "fr": ["conque"] }, "glosses": { "en": [ "any of various edible tropical marine gastropods of the genus Strombus having a brightly-colored spiral shell with large outer lip" ] }, "examples": { - "fr": [ - { - "text": "On entend la mer dans une conque.", - "source": "cefr" - } - ] + "fr": [{ "text": "On entend la mer dans une conque.", "source": "cefr" }] }, "votes": { - "en": { - "conch": { - "cefr_source": "B1" - } - }, - "fr": { - "conque": { - "cefr_source": "B2" - } - } + "en": { "conch": { "cefr_source": "B1" } }, + "fr": { "conque": { "cefr_source": "B2" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2313,15 +1267,9 @@ "source_id": "ili:i117521", "pos": "noun", "translations": { - "en": [ - "moratorium" - ], - "it": [ - "moratoria" - ], - "fr": [ - "moratoire" - ] + "en": ["moratorium"], + "it": ["moratoria"], + "fr": ["moratoire"] }, "glosses": { "en": [ @@ -2343,21 +1291,9 @@ ] }, "votes": { - "en": { - "moratorium": { - "cefr_source": "C1" - } - }, - "it": { - "moratoria": { - "cefr_source": "C1" - } - }, - "fr": { - "moratoire": { - "cefr_source": "C1" - } - } + "en": { "moratorium": { "cefr_source": "C1" } }, + "it": { "moratoria": { "cefr_source": "C1" } }, + "fr": { "moratoire": { "cefr_source": "C1" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2365,20 +1301,10 @@ "source_id": "ili:i31764", "pos": "verb", "translations": { - "en": [ - "return" - ], - "fr": [ - "rendre", - "retourner", - "revenir" - ] - }, - "glosses": { - "en": [ - "return to a previous position; in mathematics" - ] + "en": ["return"], + "fr": ["rendre", "retourner", "revenir"] }, + "glosses": { "en": ["return to a previous position; in mathematics"] }, "examples": { "en": [ { @@ -2395,23 +1321,14 @@ "text": "Je dois retourner ce livre à la bibliothèque.", "source": "cefr" }, - { - "text": "Je dois revenir demain.", - "source": "cefr" - } + { "text": "Je dois revenir demain.", "source": "cefr" } ] }, "votes": { "fr": { - "rendre": { - "cefr_source": "A2" - }, - "retourner": { - "cefr_source": "A2" - }, - "revenir": { - "cefr_source": "A1" - } + "rendre": { "cefr_source": "A2" }, + "retourner": { "cefr_source": "A2" }, + "revenir": { "cefr_source": "A1" } } }, "_sample_bucket": "has_glosses_and_examples" @@ -2420,17 +1337,9 @@ "source_id": "ili:i48149", "pos": "noun", "translations": { - "en": [ - "post horse", - "post-horse", - "poster" - ], - "it": [ - "cavallo di posta" - ], - "fr": [ - "affiche" - ] + "en": ["post horse", "post-horse", "poster"], + "it": ["cavallo di posta"], + "fr": ["affiche"] }, "glosses": { "en": [ @@ -2439,23 +1348,12 @@ }, "examples": { "fr": [ - { - "text": "L'affiche du concert est très colorée.", - "source": "cefr" - } + { "text": "L'affiche du concert est très colorée.", "source": "cefr" } ] }, "votes": { - "en": { - "poster": { - "cefr_source": "A2" - } - }, - "fr": { - "affiche": { - "cefr_source": "A2" - } - } + "en": { "poster": { "cefr_source": "A2" } }, + "fr": { "affiche": { "cefr_source": "A2" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2463,47 +1361,20 @@ "source_id": "ili:i51126", "pos": "noun", "translations": { - "en": [ - "brickwork" - ], - "it": [ - "GAP!", - "muratura in mattoni" - ], - "es": [ - "aparejo", - "calicanto", - "enladrillado", - "mampostería" - ], - "fr": [ - "appareil" - ] - }, - "glosses": { - "en": [ - "masonry done with bricks and mortar" - ] + "en": ["brickwork"], + "it": ["GAP!", "muratura in mattoni"], + "es": ["aparejo", "calicanto", "enladrillado", "mampostería"], + "fr": ["appareil"] }, + "glosses": { "en": ["masonry done with bricks and mortar"] }, "examples": { "fr": [ - { - "text": "J'ai acheté un nouvel appareil photo.", - "source": "cefr" - } + { "text": "J'ai acheté un nouvel appareil photo.", "source": "cefr" } ] }, "votes": { - "en": { - "brickwork": { - "cefr_source": "B2" - } - }, - "fr": { - "appareil": { - "cefr_source": "B1" - } - } + "en": { "brickwork": { "cefr_source": "B2" } }, + "fr": { "appareil": { "cefr_source": "B1" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2511,41 +1382,26 @@ "source_id": "ili:i17542", "pos": "adjective", "translations": { - "en": [ - "interdisciplinary" - ], - "it": [ - "interdisciplinare", - "multidisciplinare" - ], + "en": ["interdisciplinary"], + "it": ["interdisciplinare", "multidisciplinare"], "de": [ "multidisziplinär", "fachübergreifend", "interdisziplinär", "fächerübergreifend" ], - "fr": [ - "interdisciplinaire" - ] + "fr": ["interdisciplinaire"] }, "glosses": { "en": [ "drawing from or characterized by participation of two or more fields of study" ], - "de": [ - "die Zusammenarbeit mehrerer Disziplinen betreffend\">" - ] + "de": ["die Zusammenarbeit mehrerer Disziplinen betreffend\">"] }, "examples": { "en": [ - { - "text": "interdisciplinary studies", - "source": "omw" - }, - { - "text": "an interdisciplinary conference", - "source": "omw" - } + { "text": "interdisciplinary studies", "source": "omw" }, + { "text": "an interdisciplinary conference", "source": "omw" } ], "it": [ { @@ -2567,26 +1423,10 @@ ] }, "votes": { - "en": { - "interdisciplinary": { - "cefr_source": "C1" - } - }, - "it": { - "interdisciplinare": { - "cefr_source": "C1" - } - }, - "de": { - "interdisziplinär": { - "cefr_source": "C1" - } - }, - "fr": { - "interdisciplinaire": { - "cefr_source": "C1" - } - } + "en": { "interdisciplinary": { "cefr_source": "C1" } }, + "it": { "interdisciplinare": { "cefr_source": "C1" } }, + "de": { "interdisziplinär": { "cefr_source": "C1" } }, + "fr": { "interdisciplinaire": { "cefr_source": "C1" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2594,15 +1434,9 @@ "source_id": "ili:i69459", "pos": "noun", "translations": { - "en": [ - "new edition" - ], - "it": [ - "riedizione" - ], - "fr": [ - "new edition" - ] + "en": ["new edition"], + "it": ["riedizione"], + "fr": ["new edition"] }, "glosses": { "en": [ @@ -2617,34 +1451,19 @@ } ] }, - "votes": { - "it": { - "riedizione": { - "cefr_source": "C1" - } - } - }, + "votes": { "it": { "riedizione": { "cefr_source": "C1" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i75841", "pos": "noun", "translations": { - "en": [ - "stampede" - ], - "de": [ - "Stampede", - "Herdenpanik" - ], - "fr": [ - "débandade" - ] + "en": ["stampede"], + "de": ["Stampede", "Herdenpanik"], + "fr": ["débandade"] }, "glosses": { - "en": [ - "a wild headlong rush of frightened animals (horses or cattle)" - ], + "en": ["a wild headlong rush of frightened animals (horses or cattle)"], "de": [ "eine wilde, kopfüber laufende Flucht von verängstigten Tieren (Pferden oder Rindern)" ] @@ -2658,16 +1477,8 @@ ] }, "votes": { - "en": { - "stampede": { - "cefr_source": "B2" - } - }, - "fr": { - "débandade": { - "cefr_source": "C1" - } - } + "en": { "stampede": { "cefr_source": "B2" } }, + "fr": { "débandade": { "cefr_source": "C1" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2675,22 +1486,11 @@ "source_id": "ili:i67108", "pos": "noun", "translations": { - "en": [ - "stocktaking", - "stock-taking" - ], - "it": [ - "inventario" - ], - "es": [ - "balance" - ] - }, - "glosses": { - "en": [ - "reappraisal of a situation or position or outlook" - ] + "en": ["stocktaking", "stock-taking"], + "it": ["inventario"], + "es": ["balance"] }, + "glosses": { "en": ["reappraisal of a situation or position or outlook"] }, "examples": { "it": [ { @@ -2706,16 +1506,8 @@ ] }, "votes": { - "it": { - "inventario": { - "cefr_source": "B2" - } - }, - "es": { - "balance": { - "cefr_source": "B1" - } - } + "it": { "inventario": { "cefr_source": "B2" } }, + "es": { "balance": { "cefr_source": "B1" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -2733,9 +1525,7 @@ "whacky", "zany" ], - "es": [ - "tonto" - ], + "es": ["tonto"], "de": [ "albern", "naiv", @@ -2749,164 +1539,69 @@ "infantil", "puerilistisch" ], - "fr": [ - "déraisonnable", - "fou", - "drôle", - "aberrant" - ] - }, - "glosses": { - "en": [ - "ludicrous, foolish" - ], - "de": [ - "lächerlich, töricht" - ] + "fr": ["déraisonnable", "fou", "drôle", "aberrant"] }, + "glosses": { "en": ["ludicrous, foolish"], "de": ["lächerlich, töricht"] }, "examples": { "en": [ { "text": "gave me a cockamamie reason for not going", "source": "omw" }, - { - "text": "wore a goofy hat", - "source": "omw" - }, - { - "text": "a silly idea", - "source": "omw" - }, - { - "text": "some wacky plan for selling more books", - "source": "omw" - } + { "text": "wore a goofy hat", "source": "omw" }, + { "text": "a silly idea", "source": "omw" }, + { "text": "some wacky plan for selling more books", "source": "omw" } ], "de": [ - { - "text": "Hör auf, so albern zu sein!", - "source": "cefr" - }, - { - "text": "Sie ist manchmal etwas naiv.", - "source": "cefr" - }, - { - "text": "Die Früchte sind noch unreif.", - "source": "cefr" - }, - { - "text": "Sie hat eine sehr kindliche Freude.", - "source": "cefr" - }, - { - "text": "Sein Verhalten war ziemlich kindisch.", - "source": "cefr" - } + { "text": "Hör auf, so albern zu sein!", "source": "cefr" }, + { "text": "Sie ist manchmal etwas naiv.", "source": "cefr" }, + { "text": "Die Früchte sind noch unreif.", "source": "cefr" }, + { "text": "Sie hat eine sehr kindliche Freude.", "source": "cefr" }, + { "text": "Sein Verhalten war ziemlich kindisch.", "source": "cefr" } ], "fr": [ - { - "text": "Ses exigences sont déraisonnables.", - "source": "cefr" - }, - { - "text": "C'est une idée folle.", - "source": "cefr" - }, - { - "text": "C'est une histoire drôle.", - "source": "cefr" - }, + { "text": "Ses exigences sont déraisonnables.", "source": "cefr" }, + { "text": "C'est une idée folle.", "source": "cefr" }, + { "text": "C'est une histoire drôle.", "source": "cefr" }, { "text": "Son comportement était aberrant et choquant.", "source": "cefr" } ], - "es": [ - { - "text": "No seas tonto, eso no es verdad.", - "source": "cefr" - } - ] + "es": [{ "text": "No seas tonto, eso no es verdad.", "source": "cefr" }] }, "votes": { "en": { - "goofy": { - "cefr_source": "B1" - }, - "sappy": { - "cefr_source": "B2" - }, - "silly": { - "cefr_source": "A2" - }, - "wacky": { - "cefr_source": "B2" - }, - "zany": { - "cefr_source": "B2" - } + "goofy": { "cefr_source": "B1" }, + "sappy": { "cefr_source": "B2" }, + "silly": { "cefr_source": "A2" }, + "wacky": { "cefr_source": "B2" }, + "zany": { "cefr_source": "B2" } }, "de": { - "albern": { - "cefr_source": "B1" - }, - "naiv": { - "cefr_source": "B1" - }, - "unreif": { - "cefr_source": "B1" - }, - "kindlich": { - "cefr_source": "B1" - }, - "kindisch": { - "cefr_source": "B1" - } + "albern": { "cefr_source": "B1" }, + "naiv": { "cefr_source": "B1" }, + "unreif": { "cefr_source": "B1" }, + "kindlich": { "cefr_source": "B1" }, + "kindisch": { "cefr_source": "B1" } }, "fr": { - "déraisonnable": { - "cefr_source": "B2" - }, - "fou": { - "cefr_source": "B1" - }, - "drôle": { - "cefr_source": "A2" - }, - "aberrant": { - "cefr_source": "C1" - } + "déraisonnable": { "cefr_source": "B2" }, + "fou": { "cefr_source": "B1" }, + "drôle": { "cefr_source": "A2" }, + "aberrant": { "cefr_source": "C1" } }, - "es": { - "tonto": { - "cefr_source": "A2" - } - } + "es": { "tonto": { "cefr_source": "A2" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i1291", "pos": "adjective", - "translations": { - "en": [ - "unifacial" - ] - }, - "glosses": { - "en": [ - "having but one principal or specialized surface" - ] - }, + "translations": { "en": ["unifacial"] }, + "glosses": { "en": ["having but one principal or specialized surface"] }, "examples": { - "en": [ - { - "text": "a primitive unifacial flint tool", - "source": "omw" - } - ] + "en": [{ "text": "a primitive unifacial flint tool", "source": "omw" }] }, "votes": {}, "_sample_bucket": "has_glosses_and_examples" @@ -2915,26 +1610,11 @@ "source_id": "ili:i73668", "pos": "noun", "translations": { - "en": [ - "cantata", - "oratorio" - ], - "it": [ - "cantata", - "oratorio" - ], - "es": [ - "oratorio" - ], - "de": [ - "Andachtsraum", - "Oratorium", - "Gebetsraum" - ], - "fr": [ - "oratorio", - "cantate" - ] + "en": ["cantata", "oratorio"], + "it": ["cantata", "oratorio"], + "es": ["oratorio"], + "de": ["Andachtsraum", "Oratorium", "Gebetsraum"], + "fr": ["oratorio", "cantate"] }, "glosses": { "en": [ @@ -2965,91 +1645,39 @@ ] }, "votes": { - "it": { - "oratorio": { - "cefr_source": "B1" - } - }, - "de": { - "Oratorium": { - "cefr_source": "C1" - } - }, - "es": { - "oratorio": { - "cefr_source": "C1" - } - } + "it": { "oratorio": { "cefr_source": "B1" } }, + "de": { "Oratorium": { "cefr_source": "C1" } }, + "es": { "oratorio": { "cefr_source": "C1" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i39774", "pos": "noun", - "translations": { - "en": [ - "respiration" - ], - "es": [ - "respiración" - ] - }, - "glosses": { - "en": [ - "a single complete act of breathing in and out" - ] - }, + "translations": { "en": ["respiration"], "es": ["respiración"] }, + "glosses": { "en": ["a single complete act of breathing in and out"] }, "examples": { - "en": [ - { - "text": "thirty respirations per minute", - "source": "omw" - } - ], + "en": [{ "text": "thirty respirations per minute", "source": "omw" }], "es": [ - { - "text": "Su respiración era lenta y profunda.", - "source": "cefr" - } + { "text": "Su respiración era lenta y profunda.", "source": "cefr" } ] }, "votes": { - "en": { - "respiration": { - "cefr_source": "B2" - } - }, - "es": { - "respiración": { - "cefr_source": "B1" - } - } + "en": { "respiration": { "cefr_source": "B2" } }, + "es": { "respiración": { "cefr_source": "B1" } } }, "_sample_bucket": "has_glosses_and_examples" }, { "source_id": "ili:i28838", "pos": "verb", - "translations": { - "en": [ - "unplug", - "disconnect" - ], - "fr": [ - "débrancher" - ] - }, + "translations": { "en": ["unplug", "disconnect"], "fr": ["débrancher"] }, "glosses": { - "en": [ - "pull the plug of (electrical appliances) and render inoperable" - ] + "en": ["pull the plug of (electrical appliances) and render inoperable"] }, "examples": { "en": [ - { - "text": "unplug the hair dryer after using it", - "source": "omw" - } + { "text": "unplug the hair dryer after using it", "source": "omw" } ], "fr": [ { @@ -3059,16 +1687,8 @@ ] }, "votes": { - "en": { - "unplug": { - "cefr_source": "A2" - } - }, - "fr": { - "débrancher": { - "cefr_source": "A2" - } - } + "en": { "unplug": { "cefr_source": "A2" } }, + "fr": { "débrancher": { "cefr_source": "A2" } } }, "_sample_bucket": "has_glosses_and_examples" }, @@ -3076,20 +1696,10 @@ "source_id": "ili:i85884", "pos": "noun", "translations": { - "en": [ - "North Sea" - ], - "es": [ - "Mar del Norte" - ], - "de": [ - "Nordsee", - "Deutsches Meer" - ], - "fr": [ - "mer du Nord", - "Mer du Nord" - ] + "en": ["North Sea"], + "es": ["Mar del Norte"], + "de": ["Nordsee", "Deutsches Meer"], + "fr": ["mer du Nord", "Mer du Nord"] }, "glosses": { "en": [ @@ -3101,31 +1711,18 @@ }, "examples": { "de": [ - { - "text": "Wir fahren im Sommer an die Nordsee.", - "source": "cefr" - } + { "text": "Wir fahren im Sommer an die Nordsee.", "source": "cefr" } ] }, - "votes": { - "de": { - "Nordsee": { - "cefr_source": "A2" - } - } - }, + "votes": { "de": { "Nordsee": { "cefr_source": "A2" } } }, "_sample_bucket": "no_glosses_no_examples" }, { "source_id": "ili:i57058", "pos": "noun", "translations": { - "en": [ - "patriarchal cross" - ], - "es": [ - "cruz patriarcal" - ], + "en": ["patriarchal cross"], + "es": ["cruz patriarcal"], "de": [ "Erzbischofskreuz", "Spanisches Kreuz", @@ -3135,12 +1732,8 @@ ] }, "glosses": { - "en": [ - "a cross with two crossbars" - ], - "de": [ - "ein Kreuz mit zwei Querbalken" - ] + "en": ["a cross with two crossbars"], + "de": ["ein Kreuz mit zwei Querbalken"] }, "examples": {}, "votes": {}, @@ -3150,19 +1743,10 @@ "source_id": "ili:i14067", "pos": "adjective", "translations": { - "en": [ - "maximizing", - "maximising" - ], - "fr": [ - "maximaliste" - ] - }, - "glosses": { - "en": [ - "making as great as possible" - ] + "en": ["maximizing", "maximising"], + "fr": ["maximaliste"] }, + "glosses": { "en": ["making as great as possible"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3171,27 +1755,14 @@ "source_id": "ili:i57206", "pos": "noun", "translations": { - "en": [ - "photocathode" - ], - "es": [ - "fotocátodo" - ], - "de": [ - "Photokathode", - "Fotokathode" - ], - "fr": [ - "photocathode" - ] + "en": ["photocathode"], + "es": ["fotocátodo"], + "de": ["Photokathode", "Fotokathode"], + "fr": ["photocathode"] }, "glosses": { - "en": [ - "a cathode that emits electrons when illuminated" - ], - "de": [ - "eine Kathode, die bei Beleuchtung Elektronen abgibt" - ] + "en": ["a cathode that emits electrons when illuminated"], + "de": ["eine Kathode, die bei Beleuchtung Elektronen abgibt"] }, "examples": {}, "votes": {}, @@ -3201,25 +1772,11 @@ "source_id": "ili:i97025", "pos": "noun", "translations": { - "en": [ - "Stockton", - "Frank Stockton", - "Francis Richard Stockton" - ], - "es": [ - "Francis Richard Stockton", - "Frank Stockton", - "Stockton" - ], - "fr": [ - "Stockton" - ] - }, - "glosses": { - "en": [ - "United States writer (1834-1902)" - ] + "en": ["Stockton", "Frank Stockton", "Francis Richard Stockton"], + "es": ["Francis Richard Stockton", "Frank Stockton", "Stockton"], + "fr": ["Stockton"] }, + "glosses": { "en": ["United States writer (1834-1902)"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3227,11 +1784,7 @@ { "source_id": "ili:i101248", "pos": "noun", - "translations": { - "en": [ - "obeche" - ] - }, + "translations": { "en": ["obeche"] }, "glosses": { "en": [ "the wood of an African obeche tree; used especially for veneering" @@ -3245,13 +1798,8 @@ "source_id": "ili:i94985", "pos": "noun", "translations": { - "en": [ - "Eames", - "Charles Eames" - ], - "es": [ - "Charles Eames" - ] + "en": ["Eames", "Charles Eames"], + "es": ["Charles Eames"] }, "glosses": { "en": [ @@ -3266,20 +1814,10 @@ "source_id": "ili:i16699", "pos": "adjective", "translations": { - "en": [ - "mensural", - "measured", - "mensurable" - ], - "es": [ - "mensural" - ] - }, - "glosses": { - "en": [ - "having notes of fixed rhythmic value" - ] + "en": ["mensural", "measured", "mensurable"], + "es": ["mensural"] }, + "glosses": { "en": ["having notes of fixed rhythmic value"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3288,13 +1826,8 @@ "source_id": "ili:i99999", "pos": "noun", "translations": { - "en": [ - "China aster", - "Callistephus chinensis" - ], - "fr": [ - "callistephus chinensis" - ] + "en": ["China aster", "Callistephus chinensis"], + "fr": ["callistephus chinensis"] }, "glosses": { "en": [ @@ -3308,19 +1841,8 @@ { "source_id": "ili:i75135", "pos": "noun", - "translations": { - "en": [ - "kiss of death" - ], - "fr": [ - "baiser de la mort" - ] - }, - "glosses": { - "en": [ - "something that is ruinous" - ] - }, + "translations": { "en": ["kiss of death"], "fr": ["baiser de la mort"] }, + "glosses": { "en": ["something that is ruinous"] }, "examples": { "en": [ { @@ -3335,11 +1857,7 @@ { "source_id": "ili:i36428", "pos": "noun", - "translations": { - "en": [ - "dark adaptation" - ] - }, + "translations": { "en": ["dark adaptation"] }, "glosses": { "en": [ "the process of adjusting the eyes to low levels of illumination; cones adapt first; rods continue to adapt for up to four hours" @@ -3353,16 +1871,10 @@ "source_id": "ili:i103092", "pos": "noun", "translations": { - "en": [ - "saw palmetto", - "scrub palmetto", - "Serenoa repens" - ] + "en": ["saw palmetto", "scrub palmetto", "Serenoa repens"] }, "glosses": { - "en": [ - "small hardy clump-forming spiny palm of southern United States" - ] + "en": ["small hardy clump-forming spiny palm of southern United States"] }, "examples": {}, "votes": {}, @@ -3371,16 +1883,8 @@ { "source_id": "ili:i14834", "pos": "adjective", - "translations": { - "en": [ - "zoic" - ] - }, - "glosses": { - "en": [ - "pertaining to animals or animal life or action" - ] - }, + "translations": { "en": ["zoic"] }, + "glosses": { "en": ["pertaining to animals or animal life or action"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3388,19 +1892,8 @@ { "source_id": "ili:i25953", "pos": "verb", - "translations": { - "en": [ - "blog" - ], - "es": [ - "blogear" - ] - }, - "glosses": { - "en": [ - "read, write, or edit a shared on-line journal" - ] - }, + "translations": { "en": ["blog"], "es": ["blogear"] }, + "glosses": { "en": ["read, write, or edit a shared on-line journal"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3408,27 +1901,9 @@ { "source_id": "ili:i24441", "pos": "verb", - "translations": { - "en": [ - "ream" - ], - "es": [ - "taladrar" - ] - }, - "glosses": { - "en": [ - "enlarge with a reamer" - ] - }, - "examples": { - "en": [ - { - "text": "ream a hole", - "source": "omw" - } - ] - }, + "translations": { "en": ["ream"], "es": ["taladrar"] }, + "glosses": { "en": ["enlarge with a reamer"] }, + "examples": { "en": [{ "text": "ream a hole", "source": "omw" }] }, "votes": {}, "_sample_bucket": "no_glosses_no_examples" }, @@ -3436,19 +1911,10 @@ "source_id": "ili:i60874", "pos": "noun", "translations": { - "en": [ - "virtual memory", - "virtual storage" - ], - "it": [ - "memoria virtuale" - ], - "es": [ - "memoria virtual" - ], - "fr": [ - "mémoire virtuelle" - ] + "en": ["virtual memory", "virtual storage"], + "it": ["memoria virtuale"], + "es": ["memoria virtual"], + "fr": ["mémoire virtuelle"] }, "glosses": { "en": [ @@ -3463,14 +1929,8 @@ "source_id": "ili:i105979", "pos": "noun", "translations": { - "en": [ - "Dryopteris", - "genus Dryopteris" - ], - "fr": [ - "Dryopteris", - "dryopteris" - ] + "en": ["Dryopteris", "genus Dryopteris"], + "fr": ["Dryopteris", "dryopteris"] }, "glosses": { "en": [ @@ -3485,19 +1945,10 @@ "source_id": "ili:i44411", "pos": "noun", "translations": { - "en": [ - "blue racer", - "Coluber constrictor flaviventris" - ], - "fr": [ - "coluber constrictor" - ] - }, - "glosses": { - "en": [ - "bluish-green blacksnake found from Ohio to Texas" - ] + "en": ["blue racer", "Coluber constrictor flaviventris"], + "fr": ["coluber constrictor"] }, + "glosses": { "en": ["bluish-green blacksnake found from Ohio to Texas"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3506,18 +1957,11 @@ "source_id": "ili:i14592", "pos": "adjective", "translations": { - "en": [ - "anagrammatic", - "anagrammatical" - ], - "it": [ - "anagrammatico" - ] + "en": ["anagrammatic", "anagrammatical"], + "it": ["anagrammatico"] }, "glosses": { - "en": [ - "related to anagrams or containing or making an anagram" - ] + "en": ["related to anagrams or containing or making an anagram"] }, "examples": {}, "votes": {}, @@ -3527,19 +1971,10 @@ "source_id": "ili:i5174", "pos": "adjective", "translations": { - "en": [ - "protrusile", - "protrusible" - ], - "fr": [ - "protrusible" - ] - }, - "glosses": { - "en": [ - "capable of being thrust forward, as the tongue" - ] + "en": ["protrusile", "protrusible"], + "fr": ["protrusible"] }, + "glosses": { "en": ["capable of being thrust forward, as the tongue"] }, "examples": {}, "votes": {}, "_sample_bucket": "no_glosses_no_examples" @@ -3547,17 +1982,8 @@ { "source_id": "ili:i99278", "pos": "noun", - "translations": { - "en": [ - "pink calla", - "Zantedeschia rehmanii" - ] - }, - "glosses": { - "en": [ - "calla having a rose-colored spathe" - ] - }, + "translations": { "en": ["pink calla", "Zantedeschia rehmanii"] }, + "glosses": { "en": ["calla having a rose-colored spathe"] }, "examples": {}, "votes": {}, "_sample_bucket": "pos_spread" @@ -3566,16 +1992,9 @@ "source_id": "ili:i97983", "pos": "noun", "translations": { - "en": [ - "phosphorescence" - ], - "it": [ - "fosforescenza", - "fotoluminescenza" - ], - "fr": [ - "phosphorescence" - ] + "en": ["phosphorescence"], + "it": ["fosforescenza", "fotoluminescenza"], + "fr": ["phosphorescence"] }, "glosses": { "en": [ @@ -3589,16 +2008,9 @@ { "source_id": "ili:i54194", "pos": "noun", - "translations": { - "en": [ - "garrison cap", - "overseas cap" - ] - }, + "translations": { "en": ["garrison cap", "overseas cap"] }, "glosses": { - "en": [ - "a wedge-shaped wool or cotton cap; worn as part of a uniform" - ] + "en": ["a wedge-shaped wool or cotton cap; worn as part of a uniform"] }, "examples": {}, "votes": {}, @@ -3607,20 +2019,8 @@ { "source_id": "ili:i102972", "pos": "noun", - "translations": { - "en": [ - "Tipuana", - "genus Tipuana" - ], - "fr": [ - "tipuana" - ] - }, - "glosses": { - "en": [ - "one species: South American tree: tipu tree" - ] - }, + "translations": { "en": ["Tipuana", "genus Tipuana"], "fr": ["tipuana"] }, + "glosses": { "en": ["one species: South American tree: tipu tree"] }, "examples": {}, "votes": {}, "_sample_bucket": "pos_spread" @@ -3628,38 +2028,18 @@ { "source_id": "ili:i55386", "pos": "noun", - "translations": { - "en": [ - "king" - ], - "fr": [ - "roi" - ] - }, + "translations": { "en": ["king"], "fr": ["roi"] }, "glosses": { "en": [ "a checker that has been moved to the opponent's first row where it is promoted to a piece that is free to move either forward or backward" ] }, "examples": { - "fr": [ - { - "text": "Le roi a visité la ville.", - "source": "cefr" - } - ] + "fr": [{ "text": "Le roi a visité la ville.", "source": "cefr" }] }, "votes": { - "en": { - "king": { - "cefr_source": "A2" - } - }, - "fr": { - "roi": { - "cefr_source": "B1" - } - } + "en": { "king": { "cefr_source": "A2" } }, + "fr": { "roi": { "cefr_source": "B1" } } }, "_sample_bucket": "pos_spread" }, @@ -3667,47 +2047,19 @@ "source_id": "ili:i26482", "pos": "verb", "translations": { - "en": [ - "articulate", - "enunciate", - "vocalize", - "vocalise" - ], - "it": [ - "articolare", - "enunciare", - "enunziare", - "scandire" - ], - "es": [ - "articular" - ], - "de": [ - "ausdrücken", - "artikulieren" - ], - "fr": [ - "articuler", - "exprimer", - "énoncer", - "formuler", - "vocaliser" - ] + "en": ["articulate", "enunciate", "vocalize", "vocalise"], + "it": ["articolare", "enunciare", "enunziare", "scandire"], + "es": ["articular"], + "de": ["ausdrücken", "artikulieren"], + "fr": ["articuler", "exprimer", "énoncer", "formuler", "vocaliser"] }, "glosses": { - "en": [ - "express or state clearly" - ], - "de": [ - "klar ausdrücken oder erklären" - ] + "en": ["express or state clearly"], + "de": ["klar ausdrücken oder erklären"] }, "examples": { "it": [ - { - "text": "È importante articolare bene le parole.", - "source": "cefr" - } + { "text": "È importante articolare bene le parole.", "source": "cefr" } ], "de": [ { @@ -3745,105 +2097,44 @@ ] }, "votes": { - "en": { - "articulate": { - "cefr_source": "B2" - } - }, - "it": { - "articolare": { - "cefr_source": "B2" - } - }, + "en": { "articulate": { "cefr_source": "B2" } }, + "it": { "articolare": { "cefr_source": "B2" } }, "de": { - "ausdrücken": { - "cefr_source": "B1" - }, - "artikulieren": { - "cefr_source": "B2" - } + "ausdrücken": { "cefr_source": "B1" }, + "artikulieren": { "cefr_source": "B2" } }, "fr": { - "articuler": { - "cefr_source": "B1" - }, - "exprimer": { - "cefr_source": "B1" - }, - "énoncer": { - "cefr_source": "B2" - }, - "formuler": { - "cefr_source": "B2" - } + "articuler": { "cefr_source": "B1" }, + "exprimer": { "cefr_source": "B1" }, + "énoncer": { "cefr_source": "B2" }, + "formuler": { "cefr_source": "B2" } }, - "es": { - "articular": { - "cefr_source": "B2" - } - } + "es": { "articular": { "cefr_source": "B2" } } }, "_sample_bucket": "pos_spread" }, { "source_id": "ili:i22492", "pos": "verb", - "translations": { - "en": [ - "spike" - ] - }, - "glosses": { - "en": [ - "manifest a sharp increase" - ] - }, - "examples": { - "en": [ - { - "text": "the voltage spiked", - "source": "omw" - } - ] - }, + "translations": { "en": ["spike"] }, + "glosses": { "en": ["manifest a sharp increase"] }, + "examples": { "en": [{ "text": "the voltage spiked", "source": "omw" }] }, "votes": {}, "_sample_bucket": "pos_spread" }, { "source_id": "ili:i26383", "pos": "verb", - "translations": { - "en": [ - "redefine" - ], - "fr": [ - "redéfinir" - ] - }, - "glosses": { - "en": [ - "give a new or different definition of (a word)" - ] - }, + "translations": { "en": ["redefine"], "fr": ["redéfinir"] }, + "glosses": { "en": ["give a new or different definition of (a word)"] }, "examples": { "fr": [ - { - "text": "Il est temps de redéfinir nos objectifs.", - "source": "cefr" - } + { "text": "Il est temps de redéfinir nos objectifs.", "source": "cefr" } ] }, "votes": { - "en": { - "redefine": { - "cefr_source": "B2" - } - }, - "fr": { - "redéfinir": { - "cefr_source": "B2" - } - } + "en": { "redefine": { "cefr_source": "B2" } }, + "fr": { "redéfinir": { "cefr_source": "B2" } } }, "_sample_bucket": "pos_spread" }, @@ -3851,15 +2142,8 @@ "source_id": "ili:i22943", "pos": "verb", "translations": { - "en": [ - "slake", - "abate", - "slack" - ], - "es": [ - "aflojar", - "reducir" - ], + "en": ["slake", "abate", "slack"], + "es": ["aflojar", "reducir"], "fr": [ "descendre", "cesser", @@ -3870,47 +2154,25 @@ "supprimer" ] }, - "glosses": { - "en": [ - "make less active or intense" - ] - }, + "glosses": { "en": ["make less active or intense"] }, "examples": { "fr": [ { "text": "Nous allons descendre au rez-de-chaussée.", "source": "cefr" }, - { - "text": "La pluie a cessé de tomber.", - "source": "cefr" - }, - { - "text": "Nous devons réduire nos dépenses.", - "source": "cefr" - }, - { - "text": "Il faut ralentir avant le virage.", - "source": "cefr" - }, + { "text": "La pluie a cessé de tomber.", "source": "cefr" }, + { "text": "Nous devons réduire nos dépenses.", "source": "cefr" }, + { "text": "Il faut ralentir avant le virage.", "source": "cefr" }, { "text": "Ces mesures visent à amoindrir l'impact de la crise.", "source": "cefr" }, - { - "text": "Les prix ont commencé à diminuer.", - "source": "cefr" - }, - { - "text": "Il faut supprimer les fichiers inutiles.", - "source": "cefr" - } + { "text": "Les prix ont commencé à diminuer.", "source": "cefr" }, + { "text": "Il faut supprimer les fichiers inutiles.", "source": "cefr" } ], "es": [ - { - "text": "Tienes que aflojar el nudo.", - "source": "cefr" - }, + { "text": "Tienes que aflojar el nudo.", "source": "cefr" }, { "text": "Necesitamos reducir el consumo de energía.", "source": "cefr" @@ -3918,41 +2180,19 @@ ] }, "votes": { - "en": { - "abate": { - "cefr_source": "C1" - } - }, + "en": { "abate": { "cefr_source": "C1" } }, "fr": { - "descendre": { - "cefr_source": "A2" - }, - "cesser": { - "cefr_source": "B1" - }, - "réduire": { - "cefr_source": "B1" - }, - "ralentir": { - "cefr_source": "B1" - }, - "amoindrir": { - "cefr_source": "C1" - }, - "diminuer": { - "cefr_source": "B1" - }, - "supprimer": { - "cefr_source": "B2" - } + "descendre": { "cefr_source": "A2" }, + "cesser": { "cefr_source": "B1" }, + "réduire": { "cefr_source": "B1" }, + "ralentir": { "cefr_source": "B1" }, + "amoindrir": { "cefr_source": "C1" }, + "diminuer": { "cefr_source": "B1" }, + "supprimer": { "cefr_source": "B2" } }, "es": { - "aflojar": { - "cefr_source": "B1" - }, - "reducir": { - "cefr_source": "B1" - } + "aflojar": { "cefr_source": "B1" }, + "reducir": { "cefr_source": "B1" } } }, "_sample_bucket": "pos_spread" @@ -3960,50 +2200,22 @@ { "source_id": "ili:i31348", "pos": "verb", - "translations": { - "en": [ - "romp" - ] - }, - "glosses": { - "en": [ - "run easily and fairly fast" - ] - }, + "translations": { "en": ["romp"] }, + "glosses": { "en": ["run easily and fairly fast"] }, "examples": {}, - "votes": { - "en": { - "romp": { - "cefr_source": "B2" - } - } - }, + "votes": { "en": { "romp": { "cefr_source": "B2" } } }, "_sample_bucket": "pos_spread" }, { "source_id": "ili:i10413", "pos": "adjective", "translations": { - "en": [ - "imprudent" - ], - "it": [ - "imprudente", - "incauto" - ], - "es": [ - "imprudente", - "insensato" - ], - "fr": [ - "imprudent" - ] - }, - "glosses": { - "en": [ - "not prudent or wise" - ] + "en": ["imprudent"], + "it": ["imprudente", "incauto"], + "es": ["imprudente", "insensato"], + "fr": ["imprudent"] }, + "glosses": { "en": ["not prudent or wise"] }, "examples": { "en": [ { @@ -4032,30 +2244,15 @@ "text": "Fue una decisión imprudente conducir tan rápido.", "source": "cefr" }, - { - "text": "Fue una decisión insensata.", - "source": "cefr" - } + { "text": "Fue una decisión insensata.", "source": "cefr" } ] }, "votes": { - "it": { - "imprudente": { - "cefr_source": "B2" - } - }, - "fr": { - "imprudent": { - "cefr_source": "B2" - } - }, + "it": { "imprudente": { "cefr_source": "B2" } }, + "fr": { "imprudent": { "cefr_source": "B2" } }, "es": { - "imprudente": { - "cefr_source": "B2" - }, - "insensato": { - "cefr_source": "B2" - } + "imprudente": { "cefr_source": "B2" }, + "insensato": { "cefr_source": "B2" } } }, "_sample_bucket": "pos_spread" @@ -4064,36 +2261,13 @@ "source_id": "ili:i8645", "pos": "adjective", "translations": { - "en": [ - "metaphysical" - ], - "es": [ - "metafísico" - ], - "fr": [ - "métaphysique" - ] - }, - "glosses": { - "en": [ - "without material form or substance" - ] - }, - "examples": { - "en": [ - { - "text": "metaphysical forces", - "source": "omw" - } - ] - }, - "votes": { - "en": { - "metaphysical": { - "cefr_source": "C1" - } - } + "en": ["metaphysical"], + "es": ["metafísico"], + "fr": ["métaphysique"] }, + "glosses": { "en": ["without material form or substance"] }, + "examples": { "en": [{ "text": "metaphysical forces", "source": "omw" }] }, + "votes": { "en": { "metaphysical": { "cefr_source": "C1" } } }, "_sample_bucket": "pos_spread" }, { @@ -4107,13 +2281,8 @@ "essential", "of the essence" ], - "it": [ - "essenziale" - ], - "es": [ - "crucial", - "esencial" - ], + "it": ["essenziale"], + "es": ["crucial", "esencial"], "de": [ "bedeutsam", "wesentlich", @@ -4124,52 +2293,26 @@ "aussagekräftig", "signifikant" ], - "fr": [ - "essentiel" - ] + "fr": ["essentiel"] }, "glosses": { - "en": [ - "of the greatest importance" - ], - "de": [ - "von allergrößter Bedeutung" - ] + "en": ["of the greatest importance"], + "de": ["von allergrößter Bedeutung"] }, "examples": { "en": [ - { - "text": "the all-important subject of disarmament", - "source": "omw" - }, - { - "text": "crucial information", - "source": "omw" - }, - { - "text": "in chess cool nerves are of the essence", - "source": "omw" - } - ], - "it": [ - { - "text": "L'acqua è essenziale per la vita.", - "source": "cefr" - } + { "text": "the all-important subject of disarmament", "source": "omw" }, + { "text": "crucial information", "source": "omw" }, + { "text": "in chess cool nerves are of the essence", "source": "omw" } ], + "it": [{ "text": "L'acqua è essenziale per la vita.", "source": "cefr" }], "de": [ { "text": "Das war ein bedeutsamer Moment in der Geschichte.", "source": "cefr" }, - { - "text": "Das ist ein wesentlicher Unterschied.", - "source": "cefr" - }, - { - "text": "Das ist eine wichtige Information.", - "source": "cefr" - }, + { "text": "Das ist ein wesentlicher Unterschied.", "source": "cefr" }, + { "text": "Das ist eine wichtige Information.", "source": "cefr" }, { "text": "Er formulierte seine Gedanken sehr prägnant.", "source": "cefr" @@ -4178,10 +2321,7 @@ "text": "Die Studie lieferte aussagekräftige Ergebnisse.", "source": "cefr" }, - { - "text": "Es gab eine signifikante Veränderung.", - "source": "cefr" - } + { "text": "Es gab eine signifikante Veränderung.", "source": "cefr" } ], "fr": [ { @@ -4190,62 +2330,28 @@ } ], "es": [ - { - "text": "Es crucial que lleguemos a tiempo.", - "source": "cefr" - }, - { - "text": "El agua es esencial para la vida.", - "source": "cefr" - } + { "text": "Es crucial que lleguemos a tiempo.", "source": "cefr" }, + { "text": "El agua es esencial para la vida.", "source": "cefr" } ] }, "votes": { "en": { - "crucial": { - "cefr_source": "B2" - }, - "essential": { - "cefr_source": "B1" - } - }, - "it": { - "essenziale": { - "cefr_source": "B1" - } + "crucial": { "cefr_source": "B2" }, + "essential": { "cefr_source": "B1" } }, + "it": { "essenziale": { "cefr_source": "B1" } }, "de": { - "bedeutsam": { - "cefr_source": "B2" - }, - "wesentlich": { - "cefr_source": "B1" - }, - "wichtig": { - "cefr_source": "A1" - }, - "prägnant": { - "cefr_source": "B2" - }, - "aussagekräftig": { - "cefr_source": "B2" - }, - "signifikant": { - "cefr_source": "C1" - } - }, - "fr": { - "essentiel": { - "cefr_source": "B1" - } + "bedeutsam": { "cefr_source": "B2" }, + "wesentlich": { "cefr_source": "B1" }, + "wichtig": { "cefr_source": "A1" }, + "prägnant": { "cefr_source": "B2" }, + "aussagekräftig": { "cefr_source": "B2" }, + "signifikant": { "cefr_source": "C1" } }, + "fr": { "essentiel": { "cefr_source": "B1" } }, "es": { - "crucial": { - "cefr_source": "B2" - }, - "esencial": { - "cefr_source": "B1" - } + "crucial": { "cefr_source": "B2" }, + "esencial": { "cefr_source": "B1" } } }, "_sample_bucket": "pos_spread" @@ -4253,24 +2359,9 @@ { "source_id": "ili:i13690", "pos": "adjective", - "translations": { - "en": [ - "round-arm" - ] - }, - "glosses": { - "en": [ - "with the arm swung round at shoulder height" - ] - }, - "examples": { - "en": [ - { - "text": "round-arm bowling", - "source": "omw" - } - ] - }, + "translations": { "en": ["round-arm"] }, + "glosses": { "en": ["with the arm swung round at shoulder height"] }, + "examples": { "en": [{ "text": "round-arm bowling", "source": "omw" }] }, "votes": {}, "_sample_bucket": "pos_spread" }, @@ -4278,134 +2369,53 @@ "source_id": "ili:i16993", "pos": "adjective", "translations": { - "en": [ - "Monacan", - "Monegasque" - ], - "it": [ - "monegasco" - ], - "fr": [ - "monégasque" - ] + "en": ["Monacan", "Monegasque"], + "it": ["monegasco"], + "fr": ["monégasque"] }, "glosses": { - "en": [ - "of or relating to or characteristic of Monaco or its people" - ] + "en": ["of or relating to or characteristic of Monaco or its people"] }, "examples": { - "fr": [ - { - "text": "Il est de nationalité monégasque.", - "source": "cefr" - } - ] - }, - "votes": { - "fr": { - "monégasque": { - "cefr_source": "B1" - } - } + "fr": [{ "text": "Il est de nationalité monégasque.", "source": "cefr" }] }, + "votes": { "fr": { "monégasque": { "cefr_source": "B1" } } }, "_sample_bucket": "pos_spread" }, { "source_id": "ili:i18824", "pos": "adverb", "translations": { - "en": [ - "here", - "hither" - ], - "it": [ - "qua", - "qui" - ], - "fr": [ - "ici", - "çà", - "par ici" - ] - }, - "glosses": { - "en": [ - "to this place (especially toward the speaker)" - ] + "en": ["here", "hither"], + "it": ["qua", "qui"], + "fr": ["ici", "çà", "par ici"] }, + "glosses": { "en": ["to this place (especially toward the speaker)"] }, "examples": { - "en": [ - { - "text": "come here, please", - "source": "omw" - } - ], + "en": [{ "text": "come here, please", "source": "omw" }], "it": [ - { - "text": "Vieni qua, per favore.", - "source": "cefr" - }, - { - "text": "Vieni qui!", - "source": "cefr" - } + { "text": "Vieni qua, per favore.", "source": "cefr" }, + { "text": "Vieni qui!", "source": "cefr" } ], - "fr": [ - { - "text": "Venez ici !", - "source": "cefr" - } - ] + "fr": [{ "text": "Venez ici !", "source": "cefr" }] }, "votes": { "en": { - "here": { - "cefr_source": "A1" - }, - "hither": { - "cefr_source": "C2" - } + "here": { "cefr_source": "A1" }, + "hither": { "cefr_source": "C2" } }, - "it": { - "qua": { - "cefr_source": "A1" - }, - "qui": { - "cefr_source": "A1" - } - }, - "fr": { - "ici": { - "cefr_source": "A1" - } - } + "it": { "qua": { "cefr_source": "A1" }, "qui": { "cefr_source": "A1" } }, + "fr": { "ici": { "cefr_source": "A1" } } }, "_sample_bucket": "pos_spread" }, { "source_id": "ili:i19641", "pos": "adverb", - "translations": { - "en": [ - "head-on" - ], - "es": [ - "de frente" - ] - }, - "glosses": { - "en": [ - "with the front foremost" - ] - }, + "translations": { "en": ["head-on"], "es": ["de frente"] }, + "glosses": { "en": ["with the front foremost"] }, "examples": { - "en": [ - { - "text": "the cars collided head-on", - "source": "omw" - } - ] + "en": [{ "text": "the cars collided head-on", "source": "omw" }] }, "votes": {}, "_sample_bucket": "pos_spread" @@ -4413,16 +2423,8 @@ { "source_id": "ili:i21417", "pos": "adverb", - "translations": { - "en": [ - "sweepingly" - ] - }, - "glosses": { - "en": [ - "in a sweeping manner" - ] - }, + "translations": { "en": ["sweepingly"] }, + "glosses": { "en": ["in a sweeping manner"] }, "examples": { "en": [ { @@ -4438,28 +2440,14 @@ "source_id": "ili:i20131", "pos": "adverb", "translations": { - "en": [ - "gallantly", - "chivalrously" - ], - "it": [ - "galantemente" - ], - "fr": [ - "chevaleresquement" - ] - }, - "glosses": { - "en": [ - "in a gallant manner" - ] + "en": ["gallantly", "chivalrously"], + "it": ["galantemente"], + "fr": ["chevaleresquement"] }, + "glosses": { "en": ["in a gallant manner"] }, "examples": { "en": [ - { - "text": "he gallantly offered to take her home", - "source": "omw" - } + { "text": "he gallantly offered to take her home", "source": "omw" } ] }, "votes": {}, @@ -4468,16 +2456,8 @@ { "source_id": "ili:i20516", "pos": "adverb", - "translations": { - "en": [ - "fractiously" - ] - }, - "glosses": { - "en": [ - "in a fractious manner" - ] - }, + "translations": { "en": ["fractiously"] }, + "glosses": { "en": ["in a fractious manner"] }, "examples": { "en": [ { @@ -4489,4 +2469,4 @@ "votes": {}, "_sample_bucket": "pos_spread" } -] \ No newline at end of file +] diff --git a/data-pipeline/tsconfig.json b/data-pipeline/tsconfig.json index 83c3053..7752b6c 100644 --- a/data-pipeline/tsconfig.json +++ b/data-pipeline/tsconfig.json @@ -5,8 +5,8 @@ "moduleResolution": "NodeNext", "outDir": "dist", "rootDir": ".", - "types": ["node"], + "types": ["node"] }, "references": [{ "path": "../packages/shared" }], - "include": ["./**/*"], + "include": ["./**/*"] } diff --git a/documentation/data-pipeline.md b/documentation/data-pipeline.md index 56285b9..4d1bbc7 100644 --- a/documentation/data-pipeline.md +++ b/documentation/data-pipeline.md @@ -55,13 +55,13 @@ See **Setup** for download instructions. Per-language JSON files in `sources/cefr/` provide the initial CEFR level annotations. These files do not cover the full vocabulary extracted from OMW — coverage varies by language. Gaps and disagreements are handled by the enrich stage. -| Language | File | -|---|---| -| English | `sources/cefr/en.json` | -| Italian | `sources/cefr/it.json` | -| Spanish | `sources/cefr/es.json` | -| German | `sources/cefr/de.json` | -| French | `sources/cefr/fr.json` | +| Language | File | +| -------- | ---------------------- | +| English | `sources/cefr/en.json` | +| Italian | `sources/cefr/it.json` | +| Spanish | `sources/cefr/es.json` | +| German | `sources/cefr/de.json` | +| French | `sources/cefr/fr.json` | These files are committed to git. For per-language coverage detail see `COVERAGE.md`. @@ -102,13 +102,13 @@ See `LLM-SETUP.md`. The pipeline runs in five stages. Each stage is independent and can be re-run without affecting the others. -| Stage | What it does | -|---|---| -| 1. Extract | Reads OMW SQLite database, outputs normalized JSON per language | +| Stage | What it does | +| ----------- | -------------------------------------------------------------------- | +| 1. Extract | Reads OMW SQLite database, outputs normalized JSON per language | | 2. Annotate | Merges CEFR source files into extracted data, adds source file votes | -| 3. Enrich | Runs local LLMs in two rounds — generation then voting | -| 4. Merge | Resolves votes, derives difficulty, splits into final and flagged | -| 5. Compare | Generates COVERAGE.md with detailed quality report | +| 3. Enrich | Runs local LLMs in two rounds — generation then voting | +| 4. Merge | Resolves votes, derives difficulty, splits into final and flagged | +| 5. Compare | Generates COVERAGE.md with detailed quality report | ### 1. Extract @@ -137,11 +137,11 @@ Each record in the output looks like this: "fr": ["comptable"] }, "glosses": { - "en": ["(usually followed by 'to') having the necessary means or skill or know-how or authority to do something"] + "en": [ + "(usually followed by 'to') having the necessary means or skill or know-how or authority to do something" + ] }, - "examples": { - "en": ["able to swim", "she was able to program her computer"] - } + "examples": { "en": ["able to swim", "she was able to program her computer"] } } ``` @@ -158,6 +158,7 @@ Words appearing in the CEFR source file multiple times with different CEFR level **Input:** `stage-1-extract/output/omw.json` + `stage-2-annotate/sources/cefr/{lang}.json` **Output:** + - `stage-2-annotate/output/{lang}.json` — one per language - `stage-2-annotate/output/conflicts.json` — cross-language conflicts for review @@ -177,20 +178,14 @@ Each record in the output extends the OMW record with a `votes` field and any ad "es": ["capaz"], "fr": ["comptable"] }, - "glosses": { - "en": ["having the necessary means or skill to do something"] - }, + "glosses": { "en": ["having the necessary means or skill to do something"] }, "examples": { "en": [ { "text": "able to swim", "source": "omw" }, { "text": "She was able to finish the task.", "source": "cefr" } ] }, - "votes": { - "en": { - "able": { "cefr_source": "B1" } - } - } + "votes": { "en": { "able": { "cefr_source": "B1" } } } } ``` @@ -297,9 +292,7 @@ Each record in the votes file looks like this: } }, "examples": { - "en": [ - { "text": "the dog barked at the stranger", "source": "omw" } - ], + "en": [{ "text": "the dog barked at the stranger", "source": "omw" }], "fr": { "candidates": [ { "text": "le chien a aboyé", "source": "model_1" }, @@ -311,8 +304,14 @@ Each record in the votes file looks like this: "descriptions": { "en": { "candidates": [ - { "text": "a common household pet known for loyalty", "source": "model_1" }, - { "text": "a domesticated animal and loyal companion", "source": "model_2" } + { + "text": "a common household pet known for loyalty", + "source": "model_1" + }, + { + "text": "a domesticated animal and loyal companion", + "source": "model_2" + } ], "votes": { "model_1": 2, "model_2": 1 } } @@ -334,14 +333,15 @@ Reads the votes file per language and resolves the final value for every field. **Difficulty mapping:** -| CEFR | Difficulty | -|---|---| -| A1, A2 | easy | +| CEFR | Difficulty | +| ------ | ------------ | +| A1, A2 | easy | | B1, B2 | intermediate | -| C1, C2 | hard | +| C1, C2 | hard | **Input:** `stage-3-enrich/output/votes/{lang}_votes.json` **Output:** + - `stage-4-merge/output/final/{lang}.json` — fully resolved, ready for seeding - `stage-4-merge/output/flagged/{lang}.json` — CEFR majority not reached, needs manual review before seeding @@ -360,21 +360,15 @@ Each record in `final/{lang}.json` looks like this: { "text": "dog", "cefr_level": "A1", "difficulty": "easy" }, { "text": "canine", "cefr_level": "B2", "difficulty": "intermediate" } ], - "it": [ - { "text": "cane", "cefr_level": "A1", "difficulty": "easy" } - ] + "it": [{ "text": "cane", "cefr_level": "A1", "difficulty": "easy" }] }, "glosses": { "en": { "text": "a domesticated carnivorous mammal", "source": "omw" }, "fr": { "text": "un mammifère carnivore domestiqué", "source": "model_1" } }, "examples": { - "en": [ - { "text": "the dog barked at the stranger", "source": "omw" } - ], - "fr": [ - { "text": "le chien a aboyé", "source": "model_1" } - ] + "en": [{ "text": "the dog barked at the stranger", "source": "omw" }], + "fr": [{ "text": "le chien a aboyé", "source": "model_1" }] }, "descriptions": { "en": { @@ -400,6 +394,7 @@ output quality per language. Run this after merge to verify output before seeding the database. **Input:** + - `stage-4-merge/output/final/{lang}.json` - `stage-4-merge/output/flagged/{lang}.json` @@ -436,12 +431,12 @@ pnpm --filter @lila/pipeline compare These values are defined in `packages/shared/src/constants.ts` and enforced by database check constraints. The pipeline filters out any entries that violate them. -| Constant | Values | -|---|---| -| Languages | `en`, `it`, `de`, `es`, `fr` | +| Constant | Values | +| --------------- | ------------------------------------- | +| Languages | `en`, `it`, `de`, `es`, `fr` | | Parts of speech | `noun`, `verb`, `adjective`, `adverb` | -| CEFR levels | `A1`, `A2`, `B1`, `B2`, `C1`, `C2` | -| Difficulty | `easy`, `intermediate`, `hard` | +| CEFR levels | `A1`, `A2`, `B1`, `B2`, `C1`, `C2` | +| Difficulty | `easy`, `intermediate`, `hard` | Adding a new value to any of these requires a constants update and a database migration before re-running the pipeline. See **Adding a new language** for the full steps — the same process applies for new parts of speech. diff --git a/documentation/deployment.md b/documentation/deployment.md index de1d3a0..66d97e8 100644 --- a/documentation/deployment.md +++ b/documentation/deployment.md @@ -243,13 +243,13 @@ Automated build and deploy via Forgejo Actions. On every push to `main`, the pip ### Secrets (stored in Forgejo repo settings → Actions → Secrets) -| Secret | Value | -|---|---| -| REGISTRY_USER | Forgejo username | -| REGISTRY_PASSWORD | Forgejo password | -| SSH_PRIVATE_KEY | Contents of `~/.ssh/ci-runner` on the VPS | -| SSH_HOST | VPS IP address | -| SSH_USER | `lila` | +| Secret | Value | +| ----------------- | ----------------------------------------- | +| REGISTRY_USER | Forgejo username | +| REGISTRY_PASSWORD | Forgejo password | +| SSH_PRIVATE_KEY | Contents of `~/.ssh/ci-runner` on the VPS | +| SSH_HOST | VPS IP address | +| SSH_USER | `lila` | ### Runner Configuration diff --git a/documentation/llm-setup.md b/documentation/llm-setup.md index 6cc1f91..23a2ba8 100644 --- a/documentation/llm-setup.md +++ b/documentation/llm-setup.md @@ -9,12 +9,12 @@ and production scripts. ## Hardware (dev machine) -| Component | Spec | -|---|---| -| CPU | Intel Core i7-6500U (2 cores / 4 threads @ 3.10 GHz) | -| RAM | 8 GB | -| GPU | NVIDIA GeForce GTX 950M — 4 GB VRAM (Maxwell, CUDA compute 5.0) | -| OS | Debian GNU/Linux 13 (trixie) x86_64 | +| Component | Spec | +| --------- | --------------------------------------------------------------- | +| CPU | Intel Core i7-6500U (2 cores / 4 threads @ 3.10 GHz) | +| RAM | 8 GB | +| GPU | NVIDIA GeForce GTX 950M — 4 GB VRAM (Maxwell, CUDA compute 5.0) | +| OS | Debian GNU/Linux 13 (trixie) x86_64 | **Local inference verdict:** viable for small/quantized models, not for production runs. See the [Local inference](#local-inference-llamacpp) section @@ -28,12 +28,12 @@ The enrich script uses a single, swappable provider config. All providers except Anthropic expose an OpenAI-compatible API, so the same client code works across all of them — only `baseURL`, `apiKey`, and `model` change. -| Provider | Use case | Cost | Rate limits | -|---|---|---|---| -| llama.cpp (local) | Quality testing, overnight dev runs | Free (electricity) | None | -| OpenRouter (free tier) | Quality comparison, multi-model evaluation | Free | 50 req/day, 20 req/min | -| OpenRouter (paid) | Production runs if local quality insufficient | Pay-per-token | None | -| Anthropic API | Quality baseline / reference | Pay-per-token | Standard | +| Provider | Use case | Cost | Rate limits | +| ---------------------- | --------------------------------------------- | ------------------ | ---------------------- | +| llama.cpp (local) | Quality testing, overnight dev runs | Free (electricity) | None | +| OpenRouter (free tier) | Quality comparison, multi-model evaluation | Free | 50 req/day, 20 req/min | +| OpenRouter (paid) | Production runs if local quality insufficient | Pay-per-token | None | +| Anthropic API | Quality baseline / reference | Pay-per-token | Standard | --- @@ -58,12 +58,12 @@ in hybrid mode, slower than full-GPU but much faster than pure CPU. Practical estimates for this hardware (~3.5 GB VRAM usable after drivers): -| Model size | Q4 VRAM | Mode | Est. speed | -|---|---|---|---| -| 3B | ~2.0 GB | Full GPU | ~15–20 tok/s | -| 4B | ~2.5 GB | Full GPU | ~12–18 tok/s | -| 7B | ~4.5 GB | Hybrid (~26/32 layers on GPU) | ~8–12 tok/s | -| 13B+ | ~8 GB+ | CPU-heavy hybrid | too slow | +| Model size | Q4 VRAM | Mode | Est. speed | +| ---------- | ------- | ----------------------------- | ------------ | +| 3B | ~2.0 GB | Full GPU | ~15–20 tok/s | +| 4B | ~2.5 GB | Full GPU | ~12–18 tok/s | +| 7B | ~4.5 GB | Hybrid (~26/32 layers on GPU) | ~8–12 tok/s | +| 13B+ | ~8 GB+ | CPU-heavy hybrid | too slow | ### Recommended local models @@ -71,6 +71,7 @@ Two candidates worth testing, covering different points on the size/quality tradeoff: **Gemma 4 E4B Instruct (Q4 / UD-Q4_K_XL)** + - GGUF file: `gemma-4-E4B-it-UD-Q4_K_XL.gguf` (~2.5 GB) - Source: https://huggingface.co/unsloth/gemma-4-E4B-it-GGUF - Runs fully on GPU. Brand new (April 2025), built for edge hardware, 140+ @@ -78,6 +79,7 @@ tradeoff: to test. **Qwen2.5 7B Instruct (Q4_K_M)** + - GGUF file: `Qwen2.5-7B-Instruct-Q4_K_M.gguf` (~4.5 GB) - Source: https://huggingface.co/Qwen/Qwen2.5-7B-Instruct-GGUF - Runs in hybrid mode (~26 of 32 layers on GPU, rest on CPU), ~8–12 tok/s. @@ -107,6 +109,7 @@ wget -O models/qwen2.5-3b-instruct-q4_k_m.gguf \ ### Starting the server **Gemma 4 E4B** (full GPU): + ```bash ./build/bin/llama-server \ --model models/gemma-4-e4b-it-ud-q4_k_xl.gguf \ @@ -117,6 +120,7 @@ wget -O models/qwen2.5-3b-instruct-q4_k_m.gguf \ ``` **Qwen2.5 7B** (hybrid — tune `--n-gpu-layers` to fit your VRAM): + ```bash ./build/bin/llama-server \ --model models/qwen2.5-7b-instruct-q4_k_m.gguf \ @@ -163,15 +167,16 @@ object changes. Ranked by expected multilingual generation quality for en/it/de/fr/es: -| Model ID | Params | Notes | -|---|---|---| -| `qwen/qwen3-coder:free` | 480B MoE (35B active) | Best free option. Strong multilingual despite "coder" label. Use as quality ceiling. | -| `qwen/qwen3-next-80b-a3b-instruct:free` | 80B MoE (3B active) | Smaller Qwen, useful comparison point. | -| `nvidia/nemotron-3-super-120b-a12b:free` | 120B MoE (12B active) | 262K context, supports structured output. | -| `google/gemma-4-31b-it:free` | 31B | 140+ language support, good European language coverage. | -| `zhipuai/glm-4.5-air:free` | MoE | Multilingual-focused. | +| Model ID | Params | Notes | +| ---------------------------------------- | --------------------- | ------------------------------------------------------------------------------------ | +| `qwen/qwen3-coder:free` | 480B MoE (35B active) | Best free option. Strong multilingual despite "coder" label. Use as quality ceiling. | +| `qwen/qwen3-next-80b-a3b-instruct:free` | 80B MoE (3B active) | Smaller Qwen, useful comparison point. | +| `nvidia/nemotron-3-super-120b-a12b:free` | 120B MoE (12B active) | 262K context, supports structured output. | +| `google/gemma-4-31b-it:free` | 31B | 140+ language support, good European language coverage. | +| `zhipuai/glm-4.5-air:free` | MoE | Multilingual-focused. | **Skip for this pipeline:** + - Llama models — weaker European language generation than Qwen/Gemma - Mistral free tier — requests may be used for model training @@ -194,7 +199,7 @@ change this object and re-run. // config.ts export type ProviderConfig = { - name: string; // used for output folder naming + name: string; // used for output folder naming baseURL: string; apiKey: string; model: string; @@ -205,8 +210,8 @@ export type ProviderConfig = { export const LOCAL_QWEN3B: ProviderConfig = { name: "local-qwen2.5-3b", baseURL: "http://127.0.0.1:8080/v1", - apiKey: "none", // llama.cpp ignores this - model: "qwen2.5-3b", // llama.cpp ignores model name, uses loaded model + apiKey: "none", // llama.cpp ignores this + model: "qwen2.5-3b", // llama.cpp ignores model name, uses loaded model maxTokens: 512, }; @@ -231,7 +236,7 @@ export const OR_GEMMA4_31B: ProviderConfig = { // Anthropic (reference baseline — different adapter required) export const ANTHROPIC_SONNET: ProviderConfig = { name: "anthropic-sonnet", - baseURL: "https://api.anthropic.com/v1", // adapter handles format difference + baseURL: "https://api.anthropic.com/v1", // adapter handles format difference apiKey: process.env.ANTHROPIC_API_KEY!, model: "claude-sonnet-4-6", maxTokens: 512, @@ -239,6 +244,7 @@ export const ANTHROPIC_SONNET: ProviderConfig = { ``` Output from each run lands in: + ``` stage-3-enrich/test/output/{provider.name}/results.json stage-3-enrich/test/output/{provider.name}/metrics.json @@ -252,21 +258,21 @@ The evaluate script compares all `metrics.json` files side by side. The test script measures the following per provider run: -| Metric | What it measures | -|---|---| -| **JSON parse rate** | % of responses that are valid, schema-compliant JSON. Critical — a failed parse is a wasted call. Target: >97% | -| **Field coverage** | % of records where all required fields are present (cefr votes for all translations, descriptions for all languages, glosses/examples for fr/es) | -| **CEFR agreement** | For records that have a `cefr_source` vote, % where the model agrees. Measures calibration. | -| **Language correctness** | Manual spot-check only — automated detection not reliable enough | -| **Tokens/second** | Local only. Indicates overnight run feasibility | +| Metric | What it measures | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| **JSON parse rate** | % of responses that are valid, schema-compliant JSON. Critical — a failed parse is a wasted call. Target: >97% | +| **Field coverage** | % of records where all required fields are present (cefr votes for all translations, descriptions for all languages, glosses/examples for fr/es) | +| **CEFR agreement** | For records that have a `cefr_source` vote, % where the model agrees. Measures calibration. | +| **Language correctness** | Manual spot-check only — automated detection not reliable enough | +| **Tokens/second** | Local only. Indicates overnight run feasibility | ### Decision thresholds -| Metric | Threshold | Action if below | -|---|---|---| -| JSON parse rate | < 97% | Do not use this model for production | -| Field coverage | < 95% | Prompt needs revision before production | -| CEFR agreement | < 70% | Model lacks vocabulary knowledge for this task | +| Metric | Threshold | Action if below | +| --------------- | --------- | ---------------------------------------------- | +| JSON parse rate | < 97% | Do not use this model for production | +| Field coverage | < 95% | Prompt needs revision before production | +| CEFR agreement | < 70% | Model lacks vocabulary knowledge for this task | --- diff --git a/documentation/notes.md b/documentation/notes.md index 8a8d414..4391d87 100644 --- a/documentation/notes.md +++ b/documentation/notes.md @@ -1,6 +1,5 @@ # notes - ## prompt ive attached the readme of my project. this is my current task: @@ -46,7 +45,7 @@ laptop: verify if docker containers run on startup (they shouldnt) ### vps setup - monitoring and logging (eg via chrootkit or rkhunter, logwatch/monit => mails daily with summary) -<<<<<<< HEAD + <<<<<<< HEAD - ~~keep the vps clean (e.g. old docker images/containers)~~ ✅ CI/CD pipeline runs `docker image prune -f` after deploy ### ~~cd/ci pipeline~~ ✅ RESOLVED @@ -55,9 +54,9 @@ Forgejo Actions with runner on VPS, Forgejo built-in container registry. See `de ### ~~postgres backups~~ ✅ RESOLVED -Daily pg_dump cron job, 7-day retention, dev laptop auto-sync via rsync. See `deployment.md`. -======= ->>>>>>> dev +# Daily pg_dump cron job, 7-day retention, dev laptop auto-sync via rsync. See `deployment.md`. + +> > > > > > > dev ### try now option diff --git a/documentation/roasts/gameService.md b/documentation/roasts/gameService.md index de8f968..0db3559 100644 --- a/documentation/roasts/gameService.md +++ b/documentation/roasts/gameService.md @@ -61,10 +61,12 @@ export const evaluateAnswer = async ( store: GameSessionStore, ): Promise<AnswerResult> => { const session = await store.get(submission.sessionId); - if (!session) throw new NotFoundError(`Game session not found: ${submission.sessionId}`); + if (!session) + throw new NotFoundError(`Game session not found: ${submission.sessionId}`); const correctOptionId = session.answers.get(submission.questionId); - if (correctOptionId === undefined) throw new NotFoundError(`Question not found: ${submission.questionId}`); + if (correctOptionId === undefined) + throw new NotFoundError(`Question not found: ${submission.questionId}`); // delete answered question; delete session when all questions are answered session.answers.delete(submission.questionId); @@ -84,10 +86,14 @@ export const evaluateAnswer = async ( ```ts // ✅ option B — TTL in InMemoryGameSessionStore export class InMemoryGameSessionStore implements GameSessionStore { - private sessions = new Map<string, { data: GameSessionData; expiresAt: number }>(); + private sessions = new Map< + string, + { data: GameSessionData; expiresAt: number } + >(); private readonly ttlMs: number; - constructor(ttlMs = 30 * 60 * 1000) { // 30 minutes default + constructor(ttlMs = 30 * 60 * 1000) { + // 30 minutes default this.ttlMs = ttlMs; } @@ -115,15 +121,13 @@ export class InMemoryGameSessionStore implements GameSessionStore { --- - - **Problem** `GameRequest.rounds` is typed as `string` in `@lila/shared`, forcing the service to cast it every time: ```ts // ❌ why is a round count a string? -Number(request.rounds) +Number(request.rounds); ``` **Fix — fix the schema in `@lila/shared`** @@ -204,7 +208,10 @@ it("correct answer appears exactly once in options even if distractor matches", // simulate getDistractors returning the correct answer as one of the distractors mockGetDistractors.mockResolvedValueOnce(["cane", "wrong2", "wrong3"]); - const session = await createGameSession(validRequest, new InMemoryGameSessionStore()); + const session = await createGameSession( + validRequest, + new InMemoryGameSessionStore(), + ); const question = session.questions[0]!; const optionTexts = question.options.map((o) => o.text); @@ -285,16 +292,14 @@ his `sessionId`. ```ts // GameSessionStore.ts -export type GameSessionData = { - answers: Map<string, number>; - userId: string; -}; +export type GameSessionData = { answers: Map<string, number>; userId: string }; // evaluateAnswer const session = await store.get(submission.sessionId); if (!session) throw new NotFoundError(`Game session not found`); -if (session.userId !== requestingUserId) throw new NotFoundError(`Game session not found`); +if (session.userId !== requestingUserId) + throw new NotFoundError(`Game session not found`); // ^^^ same error — don't confirm the session exists to the wrong user ``` @@ -326,8 +331,9 @@ if (terms.length === 0) { it("throws when getGameTerms returns no terms", async () => { mockGetGameTerms.mockResolvedValue([]); - await expect(createGameSession(validRequest, new InMemoryGameSessionStore())) - .rejects.toThrow("No terms found"); + await expect( + createGameSession(validRequest, new InMemoryGameSessionStore()), + ).rejects.toThrow("No terms found"); }); ``` @@ -349,8 +355,9 @@ it("throws when getGameTerms returns no terms", async () => { it("propagates getDistractors failure", async () => { mockGetDistractors.mockRejectedValue(new Error("db timeout")); - await expect(createGameSession(validRequest, new InMemoryGameSessionStore())) - .rejects.toThrow("db timeout"); + await expect( + createGameSession(validRequest, new InMemoryGameSessionStore()), + ).rejects.toThrow("db timeout"); }); ``` diff --git a/documentation/spec.md b/documentation/spec.md index b16fbc0..29938da 100644 --- a/documentation/spec.md +++ b/documentation/spec.md @@ -51,9 +51,9 @@ This is the full vision. The current implementation already covers most of it; r ### What is CUT from the MVP -| Feature | Why cut | -| ------------------------------- | -------------------------------------- | -| User stats / profiles | Needs auth | +| Feature | Why cut | +| --------------------- | ---------- | +| User stats / profiles | Needs auth | These are not deleted from the plan — they are deferred. The architecture is already designed to support them. See Section 11 (Post-MVP Ladder). @@ -63,22 +63,22 @@ These are not deleted from the plan — they are deferred. The architecture is a The monorepo structure and tooling are already set up. This is the full stack. -| Layer | Technology | Status | -| ------------ | ------------------------------ | ----------- | -| Monorepo | pnpm workspaces | ✅ | -| Frontend | React 18, Vite, TypeScript | ✅ | -| Routing | TanStack Router | ✅ | -| Server state | TanStack Query | ✅ | -| Client state | Zustand | ✅ | -| Styling | Tailwind CSS + shadcn/ui | ✅ | -| Backend | Node.js, Express, TypeScript | ✅ | -| Database | PostgreSQL + Drizzle ORM | ✅ | -| Validation | Zod (shared schemas) | ✅ | -| Testing | Vitest, supertest | ✅ | -| Auth | Better Auth (Google + GitHub) | ✅ | -| Deployment | Docker Compose, Caddy, Hetzner | ✅ | -| CI/CD | Forgejo Actions | ✅ | -| Realtime | WebSockets (`ws` library) | ✅ | +| Layer | Technology | Status | +| ------------ | ------------------------------ | ------------------------------------------------------ | +| Monorepo | pnpm workspaces | ✅ | +| Frontend | React 18, Vite, TypeScript | ✅ | +| Routing | TanStack Router | ✅ | +| Server state | TanStack Query | ✅ | +| Client state | Zustand | ✅ | +| Styling | Tailwind CSS + shadcn/ui | ✅ | +| Backend | Node.js, Express, TypeScript | ✅ | +| Database | PostgreSQL + Drizzle ORM | ✅ | +| Validation | Zod (shared schemas) | ✅ | +| Testing | Vitest, supertest | ✅ | +| Auth | Better Auth (Google + GitHub) | ✅ | +| Deployment | Docker Compose, Caddy, Hetzner | ✅ | +| CI/CD | Forgejo Actions | ✅ | +| Realtime | WebSockets (`ws` library) | ✅ | | Cache | Valkey | ⚠️ optional (used locally; production/state hardening) | --- @@ -288,26 +288,27 @@ After completing a task: share the code, ask what to refactor and why. The LLM s ## 11. Post-MVP Ladder <<<<<<< HEAD -| Phase | What it adds | Status | +| Phase | What it adds | Status | | ----------------- | ------------------------------------------------------------------------------- | ------ | -| Auth | Better Auth (Google + GitHub), embedded in Express API, user rows in DB | ✅ | -| Deployment | Docker Compose, Caddy, Forgejo, CI/CD, Hetzner VPS | ✅ | -| Hardening (partial) | CI/CD pipeline, DB backups | ✅ | -| User Stats | Games played, score history, profile page | ❌ | -| Multiplayer Lobby | Room creation, join by code, WebSocket connection | ❌ | -| Multiplayer Game | Simultaneous answers, server timer, live scores, winner screen | ❌ | -| Hardening (rest) | Rate limiting, error boundaries, monitoring, accessibility | ❌ | +| Auth | Better Auth (Google + GitHub), embedded in Express API, user rows in DB | ✅ | +| Deployment | Docker Compose, Caddy, Forgejo, CI/CD, Hetzner VPS | ✅ | +| Hardening (partial) | CI/CD pipeline, DB backups | ✅ | +| User Stats | Games played, score history, profile page | ❌ | +| Multiplayer Lobby | Room creation, join by code, WebSocket connection | ❌ | +| Multiplayer Game | Simultaneous answers, server timer, live scores, winner screen | ❌ | +| Hardening (rest) | Rate limiting, error boundaries, monitoring, accessibility | ❌ | ======= -| Phase | What it adds | Status | +| Phase | What it adds | Status | | ------------------- | ----------------------------------------------------------------------- | ------ | -| Auth | Better Auth (Google + GitHub), embedded in Express API, user rows in DB | ✅ | -| Deployment | Docker Compose, Caddy, Forgejo, CI/CD, Hetzner VPS | ✅ | -| Hardening (partial) | CI/CD pipeline, DB backups | ✅ | -| User Stats | Games played, score history, profile page | ❌ | -| Multiplayer Lobby | Room creation, join by code, WebSocket connection | ✅ | -| Multiplayer Game | Simultaneous answers, server timer, live scores, winner screen | ✅ | -| Hardening (rest) | Rate limiting, error boundaries, monitoring, accessibility | ❌ | ->>>>>>> dev +| Auth | Better Auth (Google + GitHub), embedded in Express API, user rows in DB | ✅ | +| Deployment | Docker Compose, Caddy, Forgejo, CI/CD, Hetzner VPS | ✅ | +| Hardening (partial) | CI/CD pipeline, DB backups | ✅ | +| User Stats | Games played, score history, profile page | ❌ | +| Multiplayer Lobby | Room creation, join by code, WebSocket connection | ✅ | +| Multiplayer Game | Simultaneous answers, server timer, live scores, winner screen | ✅ | +| Hardening (rest) | Rate limiting, error boundaries, monitoring, accessibility | ❌ | + +> > > > > > > dev ### Future Data Model Extensions (deferred, additive) diff --git a/documentation/tickets/blueprint.md b/documentation/tickets/blueprint.md index 8a3c065..c5fdf8a 100644 --- a/documentation/tickets/blueprint.md +++ b/documentation/tickets/blueprint.md @@ -1,6 +1,6 @@ # Ticket Blueprint -Two formats depending on task type. Choose based on whether a meaningful +Two formats depending on task type. Choose based on whether a meaningful decision between options was made. --- diff --git a/documentation/tickets/t00001.md b/documentation/tickets/t00001.md index 4fffaec..f7f1a09 100644 --- a/documentation/tickets/t00001.md +++ b/documentation/tickets/t00001.md @@ -87,9 +87,7 @@ pass init <your-key-id> Replace the entire file contents with: ```json -{ - "credsStore": "pass" -} +{ "credsStore": "pass" } ``` ### 6. Re-login to registries diff --git a/documentation/tickets/t00002.md b/documentation/tickets/t00002.md index dc93605..4f7fbb5 100644 --- a/documentation/tickets/t00002.md +++ b/documentation/tickets/t00002.md @@ -136,7 +136,7 @@ Rejected because: coercion is for untrusted or uncontrolled inputs (form fields, 6. In `apps/web/src/components/game/GameSetup.tsx`: - Update `SettingGroup` props to accept `string | number`: - + ```ts type SettingGroupProps = { options: readonly (string | number)[]; diff --git a/packages/db/drizzle/meta/0007_snapshot.json b/packages/db/drizzle/meta/0007_snapshot.json index e5ee0b5..051e87a 100644 --- a/packages/db/drizzle/meta/0007_snapshot.json +++ b/packages/db/drizzle/meta/0007_snapshot.json @@ -110,12 +110,8 @@ "name": "account_user_id_user_id_fk", "tableFrom": "account", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -149,12 +145,8 @@ "name": "deck_terms_deck_id_decks_id_fk", "tableFrom": "deck_terms", "tableTo": "decks", - "columnsFrom": [ - "deck_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["deck_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -162,12 +154,8 @@ "name": "deck_terms_term_id_terms_id_fk", "tableFrom": "deck_terms", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -175,10 +163,7 @@ "compositePrimaryKeys": { "deck_terms_deck_id_term_id_pk": { "name": "deck_terms_deck_id_term_id_pk", - "columns": [ - "deck_id", - "term_id" - ] + "columns": ["deck_id", "term_id"] } }, "uniqueConstraints": {}, @@ -265,10 +250,7 @@ "unique_deck_name": { "name": "unique_deck_name", "nullsNotDistinct": false, - "columns": [ - "name", - "source_language" - ] + "columns": ["name", "source_language"] } }, "policies": {}, @@ -336,12 +318,8 @@ "name": "lobbies_host_user_id_user_id_fk", "tableFrom": "lobbies", "tableTo": "user", - "columnsFrom": [ - "host_user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["host_user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -351,9 +329,7 @@ "lobbies_code_unique": { "name": "lobbies_code_unique", "nullsNotDistinct": false, - "columns": [ - "code" - ] + "columns": ["code"] } }, "policies": {}, @@ -402,12 +378,8 @@ "name": "lobby_players_lobby_id_lobbies_id_fk", "tableFrom": "lobby_players", "tableTo": "lobbies", - "columnsFrom": [ - "lobby_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["lobby_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -415,12 +387,8 @@ "name": "lobby_players_user_id_user_id_fk", "tableFrom": "lobby_players", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -428,10 +396,7 @@ "compositePrimaryKeys": { "lobby_players_lobby_id_user_id_pk": { "name": "lobby_players_lobby_id_user_id_pk", - "columns": [ - "lobby_id", - "user_id" - ] + "columns": ["lobby_id", "user_id"] } }, "uniqueConstraints": {}, @@ -515,12 +480,8 @@ "name": "session_user_id_user_id_fk", "tableFrom": "session", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -530,9 +491,7 @@ "session_token_unique": { "name": "session_token_unique", "nullsNotDistinct": false, - "columns": [ - "token" - ] + "columns": ["token"] } }, "policies": {}, @@ -588,12 +547,8 @@ "name": "term_glosses_term_id_terms_id_fk", "tableFrom": "term_glosses", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -603,10 +558,7 @@ "unique_term_gloss": { "name": "unique_term_gloss", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code" - ] + "columns": ["term_id", "language_code"] } }, "policies": {}, @@ -641,12 +593,8 @@ "name": "term_topics_term_id_terms_id_fk", "tableFrom": "term_topics", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -654,12 +602,8 @@ "name": "term_topics_topic_id_topics_id_fk", "tableFrom": "term_topics", "tableTo": "topics", - "columnsFrom": [ - "topic_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["topic_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -667,10 +611,7 @@ "compositePrimaryKeys": { "term_topics_term_id_topic_id_pk": { "name": "term_topics_term_id_topic_id_pk", - "columns": [ - "term_id", - "topic_id" - ] + "columns": ["term_id", "topic_id"] } }, "uniqueConstraints": {}, @@ -744,10 +685,7 @@ "unique_source_id": { "name": "unique_source_id", "nullsNotDistinct": false, - "columns": [ - "source", - "source_id" - ] + "columns": ["source", "source_id"] } }, "policies": {}, @@ -803,9 +741,7 @@ "topics_slug_unique": { "name": "topics_slug_unique", "nullsNotDistinct": false, - "columns": [ - "slug" - ] + "columns": ["slug"] } }, "policies": {}, @@ -901,12 +837,8 @@ "name": "translations_term_id_terms_id_fk", "tableFrom": "translations", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -916,11 +848,7 @@ "unique_translations": { "name": "unique_translations", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -997,9 +925,7 @@ "user_email_unique": { "name": "user_email_unique", "nullsNotDistinct": false, - "columns": [ - "email" - ] + "columns": ["email"] } }, "policies": {}, @@ -1080,9 +1006,5 @@ "roles": {}, "policies": {}, "views": {}, - "_meta": { - "columns": {}, - "schemas": {}, - "tables": {} - } -} \ No newline at end of file + "_meta": { "columns": {}, "schemas": {}, "tables": {} } +} diff --git a/packages/db/drizzle/meta/0008_snapshot.json b/packages/db/drizzle/meta/0008_snapshot.json index aab8d46..ebeb2b1 100644 --- a/packages/db/drizzle/meta/0008_snapshot.json +++ b/packages/db/drizzle/meta/0008_snapshot.json @@ -110,12 +110,8 @@ "name": "account_user_id_user_id_fk", "tableFrom": "account", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -149,12 +145,8 @@ "name": "deck_terms_deck_id_decks_id_fk", "tableFrom": "deck_terms", "tableTo": "decks", - "columnsFrom": [ - "deck_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["deck_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -162,12 +154,8 @@ "name": "deck_terms_term_id_terms_id_fk", "tableFrom": "deck_terms", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -175,10 +163,7 @@ "compositePrimaryKeys": { "deck_terms_deck_id_term_id_pk": { "name": "deck_terms_deck_id_term_id_pk", - "columns": [ - "deck_id", - "term_id" - ] + "columns": ["deck_id", "term_id"] } }, "uniqueConstraints": {}, @@ -265,10 +250,7 @@ "unique_deck_name": { "name": "unique_deck_name", "nullsNotDistinct": false, - "columns": [ - "name", - "source_language" - ] + "columns": ["name", "source_language"] } }, "policies": {}, @@ -336,12 +318,8 @@ "name": "lobbies_host_user_id_user_id_fk", "tableFrom": "lobbies", "tableTo": "user", - "columnsFrom": [ - "host_user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["host_user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -351,9 +329,7 @@ "lobbies_code_unique": { "name": "lobbies_code_unique", "nullsNotDistinct": false, - "columns": [ - "code" - ] + "columns": ["code"] } }, "policies": {}, @@ -402,12 +378,8 @@ "name": "lobby_players_lobby_id_lobbies_id_fk", "tableFrom": "lobby_players", "tableTo": "lobbies", - "columnsFrom": [ - "lobby_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["lobby_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -415,12 +387,8 @@ "name": "lobby_players_user_id_user_id_fk", "tableFrom": "lobby_players", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -428,10 +396,7 @@ "compositePrimaryKeys": { "lobby_players_lobby_id_user_id_pk": { "name": "lobby_players_lobby_id_user_id_pk", - "columns": [ - "lobby_id", - "user_id" - ] + "columns": ["lobby_id", "user_id"] } }, "uniqueConstraints": {}, @@ -515,12 +480,8 @@ "name": "session_user_id_user_id_fk", "tableFrom": "session", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -530,9 +491,7 @@ "session_token_unique": { "name": "session_token_unique", "nullsNotDistinct": false, - "columns": [ - "token" - ] + "columns": ["token"] } }, "policies": {}, @@ -604,12 +563,8 @@ "name": "term_examples_term_id_terms_id_fk", "tableFrom": "term_examples", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -619,11 +574,7 @@ "unique_term_example": { "name": "unique_term_example", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -684,12 +635,8 @@ "name": "term_glosses_term_id_terms_id_fk", "tableFrom": "term_glosses", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -699,10 +646,7 @@ "unique_term_gloss": { "name": "unique_term_gloss", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code" - ] + "columns": ["term_id", "language_code"] } }, "policies": {}, @@ -737,12 +681,8 @@ "name": "term_topics_term_id_terms_id_fk", "tableFrom": "term_topics", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -750,12 +690,8 @@ "name": "term_topics_topic_id_topics_id_fk", "tableFrom": "term_topics", "tableTo": "topics", - "columnsFrom": [ - "topic_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["topic_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -763,10 +699,7 @@ "compositePrimaryKeys": { "term_topics_term_id_topic_id_pk": { "name": "term_topics_term_id_topic_id_pk", - "columns": [ - "term_id", - "topic_id" - ] + "columns": ["term_id", "topic_id"] } }, "uniqueConstraints": {}, @@ -840,10 +773,7 @@ "unique_source_id": { "name": "unique_source_id", "nullsNotDistinct": false, - "columns": [ - "source", - "source_id" - ] + "columns": ["source", "source_id"] } }, "policies": {}, @@ -899,9 +829,7 @@ "topics_slug_unique": { "name": "topics_slug_unique", "nullsNotDistinct": false, - "columns": [ - "slug" - ] + "columns": ["slug"] } }, "policies": {}, @@ -997,12 +925,8 @@ "name": "translations_term_id_terms_id_fk", "tableFrom": "translations", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -1012,11 +936,7 @@ "unique_translations": { "name": "unique_translations", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -1093,9 +1013,7 @@ "user_email_unique": { "name": "user_email_unique", "nullsNotDistinct": false, - "columns": [ - "email" - ] + "columns": ["email"] } }, "policies": {}, @@ -1176,9 +1094,5 @@ "roles": {}, "policies": {}, "views": {}, - "_meta": { - "columns": {}, - "schemas": {}, - "tables": {} - } -} \ No newline at end of file + "_meta": { "columns": {}, "schemas": {}, "tables": {} } +} diff --git a/packages/db/drizzle/meta/0009_snapshot.json b/packages/db/drizzle/meta/0009_snapshot.json index 8274112..6082664 100644 --- a/packages/db/drizzle/meta/0009_snapshot.json +++ b/packages/db/drizzle/meta/0009_snapshot.json @@ -110,12 +110,8 @@ "name": "account_user_id_user_id_fk", "tableFrom": "account", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -149,12 +145,8 @@ "name": "deck_terms_deck_id_decks_id_fk", "tableFrom": "deck_terms", "tableTo": "decks", - "columnsFrom": [ - "deck_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["deck_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -162,12 +154,8 @@ "name": "deck_terms_term_id_terms_id_fk", "tableFrom": "deck_terms", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -175,10 +163,7 @@ "compositePrimaryKeys": { "deck_terms_deck_id_term_id_pk": { "name": "deck_terms_deck_id_term_id_pk", - "columns": [ - "deck_id", - "term_id" - ] + "columns": ["deck_id", "term_id"] } }, "uniqueConstraints": {}, @@ -265,10 +250,7 @@ "unique_deck_name": { "name": "unique_deck_name", "nullsNotDistinct": false, - "columns": [ - "name", - "source_language" - ] + "columns": ["name", "source_language"] } }, "policies": {}, @@ -355,12 +337,8 @@ "name": "lobbies_host_user_id_user_id_fk", "tableFrom": "lobbies", "tableTo": "user", - "columnsFrom": [ - "host_user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["host_user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -370,9 +348,7 @@ "lobbies_code_unique": { "name": "lobbies_code_unique", "nullsNotDistinct": false, - "columns": [ - "code" - ] + "columns": ["code"] } }, "policies": {}, @@ -421,12 +397,8 @@ "name": "lobby_players_lobby_id_lobbies_id_fk", "tableFrom": "lobby_players", "tableTo": "lobbies", - "columnsFrom": [ - "lobby_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["lobby_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -434,12 +406,8 @@ "name": "lobby_players_user_id_user_id_fk", "tableFrom": "lobby_players", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -447,10 +415,7 @@ "compositePrimaryKeys": { "lobby_players_lobby_id_user_id_pk": { "name": "lobby_players_lobby_id_user_id_pk", - "columns": [ - "lobby_id", - "user_id" - ] + "columns": ["lobby_id", "user_id"] } }, "uniqueConstraints": {}, @@ -534,12 +499,8 @@ "name": "session_user_id_user_id_fk", "tableFrom": "session", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -549,9 +510,7 @@ "session_token_unique": { "name": "session_token_unique", "nullsNotDistinct": false, - "columns": [ - "token" - ] + "columns": ["token"] } }, "policies": {}, @@ -623,12 +582,8 @@ "name": "term_examples_term_id_terms_id_fk", "tableFrom": "term_examples", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -638,11 +593,7 @@ "unique_term_example": { "name": "unique_term_example", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -703,12 +654,8 @@ "name": "term_glosses_term_id_terms_id_fk", "tableFrom": "term_glosses", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -718,10 +665,7 @@ "unique_term_gloss": { "name": "unique_term_gloss", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code" - ] + "columns": ["term_id", "language_code"] } }, "policies": {}, @@ -756,12 +700,8 @@ "name": "term_topics_term_id_terms_id_fk", "tableFrom": "term_topics", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -769,12 +709,8 @@ "name": "term_topics_topic_id_topics_id_fk", "tableFrom": "term_topics", "tableTo": "topics", - "columnsFrom": [ - "topic_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["topic_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -782,10 +718,7 @@ "compositePrimaryKeys": { "term_topics_term_id_topic_id_pk": { "name": "term_topics_term_id_topic_id_pk", - "columns": [ - "term_id", - "topic_id" - ] + "columns": ["term_id", "topic_id"] } }, "uniqueConstraints": {}, @@ -859,10 +792,7 @@ "unique_source_id": { "name": "unique_source_id", "nullsNotDistinct": false, - "columns": [ - "source", - "source_id" - ] + "columns": ["source", "source_id"] } }, "policies": {}, @@ -918,9 +848,7 @@ "topics_slug_unique": { "name": "topics_slug_unique", "nullsNotDistinct": false, - "columns": [ - "slug" - ] + "columns": ["slug"] } }, "policies": {}, @@ -1016,12 +944,8 @@ "name": "translations_term_id_terms_id_fk", "tableFrom": "translations", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -1031,11 +955,7 @@ "unique_translations": { "name": "unique_translations", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -1112,9 +1032,7 @@ "user_email_unique": { "name": "user_email_unique", "nullsNotDistinct": false, - "columns": [ - "email" - ] + "columns": ["email"] } }, "policies": {}, @@ -1195,9 +1113,5 @@ "roles": {}, "policies": {}, "views": {}, - "_meta": { - "columns": {}, - "schemas": {}, - "tables": {} - } -} \ No newline at end of file + "_meta": { "columns": {}, "schemas": {}, "tables": {} } +} diff --git a/packages/db/drizzle/meta/0010_snapshot.json b/packages/db/drizzle/meta/0010_snapshot.json index 720a585..0f0603f 100644 --- a/packages/db/drizzle/meta/0010_snapshot.json +++ b/packages/db/drizzle/meta/0010_snapshot.json @@ -110,12 +110,8 @@ "name": "account_user_id_user_id_fk", "tableFrom": "account", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -149,12 +145,8 @@ "name": "deck_terms_deck_id_decks_id_fk", "tableFrom": "deck_terms", "tableTo": "decks", - "columnsFrom": [ - "deck_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["deck_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -162,12 +154,8 @@ "name": "deck_terms_term_id_terms_id_fk", "tableFrom": "deck_terms", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -175,10 +163,7 @@ "compositePrimaryKeys": { "deck_terms_deck_id_term_id_pk": { "name": "deck_terms_deck_id_term_id_pk", - "columns": [ - "deck_id", - "term_id" - ] + "columns": ["deck_id", "term_id"] } }, "uniqueConstraints": {}, @@ -265,10 +250,7 @@ "unique_deck_name": { "name": "unique_deck_name", "nullsNotDistinct": false, - "columns": [ - "name", - "source_language" - ] + "columns": ["name", "source_language"] } }, "policies": {}, @@ -336,12 +318,8 @@ "name": "lobbies_host_user_id_user_id_fk", "tableFrom": "lobbies", "tableTo": "user", - "columnsFrom": [ - "host_user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["host_user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -351,9 +329,7 @@ "lobbies_code_unique": { "name": "lobbies_code_unique", "nullsNotDistinct": false, - "columns": [ - "code" - ] + "columns": ["code"] } }, "policies": {}, @@ -402,12 +378,8 @@ "name": "lobby_players_lobby_id_lobbies_id_fk", "tableFrom": "lobby_players", "tableTo": "lobbies", - "columnsFrom": [ - "lobby_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["lobby_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -415,12 +387,8 @@ "name": "lobby_players_user_id_user_id_fk", "tableFrom": "lobby_players", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -428,10 +396,7 @@ "compositePrimaryKeys": { "lobby_players_lobby_id_user_id_pk": { "name": "lobby_players_lobby_id_user_id_pk", - "columns": [ - "lobby_id", - "user_id" - ] + "columns": ["lobby_id", "user_id"] } }, "uniqueConstraints": {}, @@ -515,12 +480,8 @@ "name": "session_user_id_user_id_fk", "tableFrom": "session", "tableTo": "user", - "columnsFrom": [ - "user_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["user_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -530,9 +491,7 @@ "session_token_unique": { "name": "session_token_unique", "nullsNotDistinct": false, - "columns": [ - "token" - ] + "columns": ["token"] } }, "policies": {}, @@ -604,12 +563,8 @@ "name": "term_examples_term_id_terms_id_fk", "tableFrom": "term_examples", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -619,11 +574,7 @@ "unique_term_example": { "name": "unique_term_example", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -684,12 +635,8 @@ "name": "term_glosses_term_id_terms_id_fk", "tableFrom": "term_glosses", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -699,10 +646,7 @@ "unique_term_gloss": { "name": "unique_term_gloss", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code" - ] + "columns": ["term_id", "language_code"] } }, "policies": {}, @@ -737,12 +681,8 @@ "name": "term_topics_term_id_terms_id_fk", "tableFrom": "term_topics", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" }, @@ -750,12 +690,8 @@ "name": "term_topics_topic_id_topics_id_fk", "tableFrom": "term_topics", "tableTo": "topics", - "columnsFrom": [ - "topic_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["topic_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -763,10 +699,7 @@ "compositePrimaryKeys": { "term_topics_term_id_topic_id_pk": { "name": "term_topics_term_id_topic_id_pk", - "columns": [ - "term_id", - "topic_id" - ] + "columns": ["term_id", "topic_id"] } }, "uniqueConstraints": {}, @@ -840,10 +773,7 @@ "unique_source_id": { "name": "unique_source_id", "nullsNotDistinct": false, - "columns": [ - "source", - "source_id" - ] + "columns": ["source", "source_id"] } }, "policies": {}, @@ -899,9 +829,7 @@ "topics_slug_unique": { "name": "topics_slug_unique", "nullsNotDistinct": false, - "columns": [ - "slug" - ] + "columns": ["slug"] } }, "policies": {}, @@ -997,12 +925,8 @@ "name": "translations_term_id_terms_id_fk", "tableFrom": "translations", "tableTo": "terms", - "columnsFrom": [ - "term_id" - ], - "columnsTo": [ - "id" - ], + "columnsFrom": ["term_id"], + "columnsTo": ["id"], "onDelete": "cascade", "onUpdate": "no action" } @@ -1012,11 +936,7 @@ "unique_translations": { "name": "unique_translations", "nullsNotDistinct": false, - "columns": [ - "term_id", - "language_code", - "text" - ] + "columns": ["term_id", "language_code", "text"] } }, "policies": {}, @@ -1093,9 +1013,7 @@ "user_email_unique": { "name": "user_email_unique", "nullsNotDistinct": false, - "columns": [ - "email" - ] + "columns": ["email"] } }, "policies": {}, @@ -1176,9 +1094,5 @@ "roles": {}, "policies": {}, "views": {}, - "_meta": { - "columns": {}, - "schemas": {}, - "tables": {} - } -} \ No newline at end of file + "_meta": { "columns": {}, "schemas": {}, "tables": {} } +} diff --git a/packages/db/drizzle/meta/_journal.json b/packages/db/drizzle/meta/_journal.json index 512887d..65dc2f0 100644 --- a/packages/db/drizzle/meta/_journal.json +++ b/packages/db/drizzle/meta/_journal.json @@ -80,4 +80,4 @@ "breakpoints": true } ] -} \ No newline at end of file +} diff --git a/packages/db/tsconfig.json b/packages/db/tsconfig.json index 1c40fbd..af1fba6 100644 --- a/packages/db/tsconfig.json +++ b/packages/db/tsconfig.json @@ -5,11 +5,11 @@ "moduleResolution": "NodeNext", "outDir": "./dist", "resolveJsonModule": true, - "types": ["vitest/globals"], + "types": ["vitest/globals"] }, "include": [ "src", "vitest.config.ts", - "../../data-pipeline/archive/packages-db-src-old-seeding-scripts/data", - ], + "../../data-pipeline/archive/packages-db-src-old-seeding-scripts/data" + ] } diff --git a/tsconfig.json b/tsconfig.json index 8b0de56..9e79e86 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -4,7 +4,7 @@ { "path": "./packages/db" }, { "path": "./apps/web" }, { "path": "./apps/api" }, - { "path": "./data-pipeline" }, + { "path": "./data-pipeline" } ], - "files": [], + "files": [] } From a4a4bfff574f53239ab697858093174d091ac3dd Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 13:48:50 +0200 Subject: [PATCH 08/19] refactor: dependency injection for GameSessionStore via composition root --- apps/api/src/app.ts | 8 ++- apps/api/src/controllers/gameController.ts | 59 ++++++++--------- apps/api/src/routes/apiRouter.ts | 17 +++-- apps/api/src/routes/gameRouter.ts | 18 ++++-- apps/api/src/services/gameService.test.ts | 74 ++++++++++++++-------- apps/api/src/services/gameService.ts | 10 +-- 6 files changed, 107 insertions(+), 79 deletions(-) diff --git a/apps/api/src/app.ts b/apps/api/src/app.ts index 635a92a..47c51e6 100644 --- a/apps/api/src/app.ts +++ b/apps/api/src/app.ts @@ -4,7 +4,8 @@ import { toNodeHandler } from "better-auth/node"; import cors from "cors"; import helmet from "helmet"; import { auth } from "./lib/auth.js"; -import { apiRouter } from "./routes/apiRouter.js"; +import { createApiRouter } from "./routes/apiRouter.js"; +import { InMemoryGameSessionStore } from "./gameSessionStore/index.js"; import { errorHandler } from "./middleware/errorHandler.js"; import { authLimiter } from "./middleware/rateLimiters.js"; @@ -23,7 +24,10 @@ export function createApp() { app.use("/api/auth", authLimiter); app.all("/api/auth/*splat", toNodeHandler(auth)); app.use(express.json()); - app.use("/api/v1", apiRouter); + + const store = new InMemoryGameSessionStore(); + app.use("/api/v1", createApiRouter(store)); + app.use(errorHandler); return app; diff --git a/apps/api/src/controllers/gameController.ts b/apps/api/src/controllers/gameController.ts index fa43369..5ab8e75 100644 --- a/apps/api/src/controllers/gameController.ts +++ b/apps/api/src/controllers/gameController.ts @@ -2,41 +2,32 @@ import type { Request, Response, NextFunction } from "express"; import { GameRequestSchema, AnswerSubmissionSchema } from "@lila/shared"; import { createGameSession, evaluateAnswer } from "../services/gameService.js"; import { ValidationError } from "../errors/AppError.js"; +import type { GameSessionStore } from "../gameSessionStore/index.js"; -export const createGame = async ( - req: Request, - res: Response, - next: NextFunction, -) => { - try { - const gameSettings = GameRequestSchema.safeParse(req.body); - - if (!gameSettings.success) { - throw new ValidationError(gameSettings.error.message); +export const createGameController = (store: GameSessionStore) => ({ + createGame: async (req: Request, res: Response, next: NextFunction) => { + try { + const gameSettings = GameRequestSchema.safeParse(req.body); + if (!gameSettings.success) { + throw new ValidationError(gameSettings.error.message); + } + const gameQuestions = await createGameSession(gameSettings.data, store); + res.json({ success: true, data: gameQuestions }); + } catch (error) { + next(error); } + }, - const gameQuestions = await createGameSession(gameSettings.data); - res.json({ success: true, data: gameQuestions }); - } catch (error) { - next(error); - } -}; - -export const submitAnswer = async ( - req: Request, - res: Response, - next: NextFunction, -) => { - try { - const submission = AnswerSubmissionSchema.safeParse(req.body); - - if (!submission.success) { - throw new ValidationError(submission.error.message); + submitAnswer: async (req: Request, res: Response, next: NextFunction) => { + try { + const submission = AnswerSubmissionSchema.safeParse(req.body); + if (!submission.success) { + throw new ValidationError(submission.error.message); + } + const result = await evaluateAnswer(submission.data, store); + res.json({ success: true, data: result }); + } catch (error) { + next(error); } - - const result = await evaluateAnswer(submission.data); - res.json({ success: true, data: result }); - } catch (error) { - next(error); - } -}; + }, +}); diff --git a/apps/api/src/routes/apiRouter.ts b/apps/api/src/routes/apiRouter.ts index f5ebd01..a0ea8d7 100644 --- a/apps/api/src/routes/apiRouter.ts +++ b/apps/api/src/routes/apiRouter.ts @@ -1,11 +1,16 @@ import express from "express"; -import { Router } from "express"; +import type { Router } from "express"; import { healthRouter } from "./healthRouter.js"; -import { gameRouter } from "./gameRouter.js"; +import { createGameRouter } from "./gameRouter.js"; import { lobbyRouter } from "./lobbyRouter.js"; +import type { GameSessionStore } from "../gameSessionStore/index.js"; -export const apiRouter: Router = express.Router(); +export const createApiRouter = (store: GameSessionStore): Router => { + const router = express.Router(); -apiRouter.use("/health", healthRouter); -apiRouter.use("/game", gameRouter); -apiRouter.use("/lobbies", lobbyRouter); + router.use("/health", healthRouter); + router.use("/game", createGameRouter(store)); + router.use("/lobbies", lobbyRouter); + + return router; +}; diff --git a/apps/api/src/routes/gameRouter.ts b/apps/api/src/routes/gameRouter.ts index 850a146..08aeb26 100644 --- a/apps/api/src/routes/gameRouter.ts +++ b/apps/api/src/routes/gameRouter.ts @@ -1,13 +1,19 @@ import express from "express"; import type { Router } from "express"; -import { createGame, submitAnswer } from "../controllers/gameController.js"; +import { createGameController } from "../controllers/gameController.js"; import { requireAuth } from "../middleware/authMiddleware.js"; import { gameLimiter } from "../middleware/rateLimiters.js"; +import type { GameSessionStore } from "../gameSessionStore/index.js"; -export const gameRouter: Router = express.Router(); +export const createGameRouter = (store: GameSessionStore): Router => { + const router = express.Router(); + const controller = createGameController(store); -gameRouter.use(requireAuth); -gameRouter.use(gameLimiter); + router.use(requireAuth); + router.use(gameLimiter); -gameRouter.post("/start", createGame); -gameRouter.post("/answer", submitAnswer); + router.post("/start", controller.createGame); + router.post("/answer", controller.submitAnswer); + + return router; +}; diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index 2c7daf8..9299b06 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -5,6 +5,7 @@ vi.mock("@lila/db", () => ({ getGameTerms: vi.fn(), getDistractors: vi.fn() })); import { getGameTerms, getDistractors } from "@lila/db"; import { createGameSession, evaluateAnswer } from "./gameService.js"; +import { InMemoryGameSessionStore } from "../gameSessionStore/index.js"; const mockGetGameTerms = vi.mocked(getGameTerms); const mockGetDistractors = vi.mocked(getDistractors); @@ -35,15 +36,22 @@ beforeEach(() => { }); describe("createGameSession", () => { + + let store: InMemoryGameSessionStore; + + beforeEach(() => { + store = new InMemoryGameSessionStore(); + }); + it("returns a session with the correct number of questions", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); expect(session.sessionId).toBeDefined(); expect(session.questions).toHaveLength(3); }); it("each question has exactly 4 options", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); for (const question of session.questions) { expect(question.options).toHaveLength(4); @@ -51,14 +59,14 @@ describe("createGameSession", () => { }); it("each question has a unique questionId", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); const ids = session.questions.map((q) => q.questionId); expect(new Set(ids).size).toBe(ids.length); }); it("options have sequential optionIds 0-3", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); for (const question of session.questions) { const optionIds = question.options.map((o) => o.optionId); @@ -67,7 +75,7 @@ describe("createGameSession", () => { }); it("the correct answer is always among the options", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); for (let i = 0; i < session.questions.length; i++) { const question = session.questions[i]!; @@ -79,7 +87,7 @@ describe("createGameSession", () => { }); it("distractors are never the correct answer", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); for (let i = 0; i < session.questions.length; i++) { const question = session.questions[i]!; @@ -95,7 +103,7 @@ describe("createGameSession", () => { }); it("sets the prompt from the source text", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); expect(session.questions[0]!.prompt).toBe("dog"); expect(session.questions[1]!.prompt).toBe("cat"); @@ -103,14 +111,14 @@ describe("createGameSession", () => { }); it("passes gloss through (null or string)", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); expect(session.questions[0]!.gloss).toBeNull(); expect(session.questions[2]!.gloss).toBe("a building for living in"); }); it("calls getGameTerms with the correct arguments", async () => { - await createGameSession(validRequest); + await createGameSession(validRequest, store); expect(mockGetGameTerms).toHaveBeenCalledWith( "en", @@ -122,7 +130,7 @@ describe("createGameSession", () => { }); it("calls getDistractors once per question", async () => { - await createGameSession(validRequest); + await createGameSession(validRequest, store); expect(mockGetDistractors).toHaveBeenCalledTimes(3); }); @@ -130,24 +138,35 @@ describe("createGameSession", () => { it("propagates unexpected errors from getGameTerms", async () => { mockGetGameTerms.mockRejectedValue(new Error("connection refused")); - await expect(createGameSession(validRequest)).rejects.toThrow( + await expect(createGameSession(validRequest, store)).rejects.toThrow( "connection refused", ); }); }); describe("evaluateAnswer", () => { + + let store: InMemoryGameSessionStore; + + beforeEach(() => { + store = new InMemoryGameSessionStore(); + }); + + it("returns isCorrect: true when the correct option is selected", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); const question = session.questions[0]!; const correctText = fakeTerms[0]!.targetText; const correctOption = question.options.find((o) => o.text === correctText)!; - const result = await evaluateAnswer({ - sessionId: session.sessionId, - questionId: question.questionId, - selectedOptionId: correctOption.optionId, - }); + const result = await evaluateAnswer( + { + sessionId: session.sessionId, + questionId: question.questionId, + selectedOptionId: correctOption.optionId, + }, + store, + ); expect(result.isCorrect).toBe(true); expect(result.correctOptionId).toBe(correctOption.optionId); @@ -155,17 +174,20 @@ describe("evaluateAnswer", () => { }); it("returns isCorrect: false when a wrong option is selected", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); const question = session.questions[0]!; const correctText = fakeTerms[0]!.targetText; const correctOption = question.options.find((o) => o.text === correctText)!; const wrongOption = question.options.find((o) => o.text !== correctText)!; - const result = await evaluateAnswer({ - sessionId: session.sessionId, - questionId: question.questionId, - selectedOptionId: wrongOption.optionId, - }); + const result = await evaluateAnswer( + { + sessionId: session.sessionId, + questionId: question.questionId, + selectedOptionId: wrongOption.optionId, + }, + store, + ); expect(result.isCorrect).toBe(false); expect(result.correctOptionId).toBe(correctOption.optionId); @@ -179,13 +201,13 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }; - await expect(evaluateAnswer(submission)).rejects.toThrow( + await expect(evaluateAnswer(submission, store)).rejects.toThrow( "Game session not found", ); }); it("throws NotFoundError for a non-existent question", async () => { - const session = await createGameSession(validRequest); + const session = await createGameSession(validRequest, store); const submission: AnswerSubmission = { sessionId: session.sessionId, @@ -193,7 +215,7 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }; - await expect(evaluateAnswer(submission)).rejects.toThrow( + await expect(evaluateAnswer(submission, store)).rejects.toThrow( "Question not found", ); }); diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index 64f90f6..4611bec 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -8,14 +8,13 @@ import type { AnswerSubmission, AnswerResult, } from "@lila/shared"; -import { InMemoryGameSessionStore } from "../gameSessionStore/index.js"; +import type { GameSessionStore } from "../gameSessionStore/index.js"; import { NotFoundError } from "../errors/AppError.js"; import { shuffleArray } from "../lib/utils.js"; -const gameSessionStore = new InMemoryGameSessionStore(); - export const createGameSession = async ( request: GameRequest, + store: GameSessionStore, ): Promise<GameSession> => { const terms = await getGameTerms( request.source_language, @@ -60,15 +59,16 @@ export const createGameSession = async ( ); const sessionId = randomUUID(); - await gameSessionStore.create(sessionId, { answers: answerKey }); + await store.create(sessionId, { answers: answerKey }); return { sessionId, questions }; }; export const evaluateAnswer = async ( submission: AnswerSubmission, + store: GameSessionStore, ): Promise<AnswerResult> => { - const session = await gameSessionStore.get(submission.sessionId); + const session = await store.get(submission.sessionId); if (!session) { throw new NotFoundError(`Game session not found: ${submission.sessionId}`); From 54705943fa86bed2a8cf3c5d45562dfb521c4bd9 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 13:50:56 +0200 Subject: [PATCH 09/19] adding ticket for refactor: dependency injection for GameSessionStore via composition root --- documentation/tickets/t00004.md | 110 ++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 documentation/tickets/t00004.md diff --git a/documentation/tickets/t00004.md b/documentation/tickets/t00004.md new file mode 100644 index 0000000..f7d5fea --- /dev/null +++ b/documentation/tickets/t00004.md @@ -0,0 +1,110 @@ +# ADR: Dependency injection for GameSessionStore via composition root + +## Status + +Accepted + +## Date + +2026-04-28 + +## Context + +`gameService.ts` had a module-level singleton: + +```ts +const gameSessionStore = new InMemoryGameSessionStore(); +``` + +This made the store invisible to anything outside the file. The `GameSessionStore` interface existed to make the store swappable — but the singleton made that impossible without editing the service itself. Tests shared the same instance across every test run, creating the potential for ghost sessions leaking between tests. The controller also briefly owned the singleton during an intermediate step, which violated the principle that controllers should only handle HTTP concerns. + +## Decision + +Adopt a composition root pattern. The store is created once in `createApp()` and passed down through factory functions: `createApiRouter(store)` → `createGameRouter(store)` → `createGameController(store)` → service calls. Neither the controller nor the service knows which implementation they're working with — they both see `GameSessionStore`. + +## Options considered + +### Option A — Composition root ✅ + +Convert routers and controllers to factory functions. Create the store in `createApp()` and pass it down. The store is created once, at the top, and injected through the call chain. + +Chosen because: clean separation of concerns, no layer below `createApp()` needs to know the concrete implementation, swapping to `ValKeyGameSessionStore` is a one-line change in `app.ts`, and tests get fresh isolated store instances. + +### Option B — Keep singleton in controller + +Leave the store as a module-level singleton in `gameController.ts`. Controllers own the store lifetime. + +Rejected because: controllers should only handle HTTP concerns. Owning infrastructure lifetime is not an HTTP concern. + +### Option C — DI framework (tsyringe, inversify) + +Use a proper dependency injection container. + +Rejected because: overkill for the current scale. The composition root pattern achieves the same result with zero dependencies and no magic. + +## Consequences + +- Swapping `InMemoryGameSessionStore` for `ValKeyGameSessionStore` requires editing one line in `app.ts` +- Tests create fresh `InMemoryGameSessionStore` instances per test — no shared state, no ghost sessions +- Routers and controllers are now factory functions instead of module-level singletons — slightly more verbose but explicitly testable +- `gameController.test.ts` uses `createApp()` which owns the store — controller tests remain integration-style and unaffected +- All layers below `createApp()` depend only on the `GameSessionStore` interface, never the concrete implementation + +## Affected files + +- `apps/api/src/app.ts` — creates the store, passes to `createApiRouter` +- `apps/api/src/routes/apiRouter.ts` — converted to `createApiRouter(store)` factory +- `apps/api/src/routes/gameRouter.ts` — converted to `createGameRouter(store)` factory +- `apps/api/src/controllers/gameController.ts` — converted to `createGameController(store)` factory +- `apps/api/src/services/gameService.ts` — `store` parameter added to both functions, singleton removed +- `apps/api/src/services/gameService.test.ts` — fresh store per describe block via `beforeEach` + +## References + +- [Composition root pattern](https://blog.ploeh.dk/2011/07/28/CompositionRoot/) + +--- + +## Setup guide / implementation notes + +1. `gameService.ts` — remove module-level singleton, add `store: GameSessionStore` parameter to `createGameSession` and `evaluateAnswer` + +2. `gameController.ts` — convert exported functions to a factory: + + ```ts + export const createGameController = (store: GameSessionStore) => ({ + createGame: async (req, res, next) => { ... }, + submitAnswer: async (req, res, next) => { ... }, + }); + ``` + +3. `gameRouter.ts` — convert to factory: + + ```ts + export const createGameRouter = (store: GameSessionStore): Router => { + const router = express.Router(); + const controller = createGameController(store); + router.post("/start", controller.createGame); + router.post("/answer", controller.submitAnswer); + return router; + }; + ``` + +4. `apiRouter.ts` — convert to factory: + + ```ts + export const createApiRouter = (store: GameSessionStore): Router => { + const router = express.Router(); + router.use("/game", createGameRouter(store)); + return router; + }; + ``` + +5. `app.ts` — create the store at the composition root: + + ```ts + const store = new InMemoryGameSessionStore(); + app.use("/api/v1", createApiRouter(store)); + ``` + +6. `gameService.test.ts` — add `let store: InMemoryGameSessionStore` to each `describe` block, reset in `beforeEach`, pass to every service call From fdeb769640648fea9274f325d5a500e7225f9217 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 14:03:15 +0200 Subject: [PATCH 10/19] feat: add TTL to GameSessionStore, replay protection and session cleanup to evaluateAnswer --- .../src/gameSessionStore/GameSessionStore.ts | 6 +- .../InMemoryGameSessionStore.test.ts | 45 +++++++++ .../InMemoryGameSessionStore.ts | 22 ++++- apps/api/src/services/gameService.test.ts | 51 ++++++++++ apps/api/src/services/gameService.ts | 8 +- documentation/tickets/t00005.md | 93 +++++++++++++++++++ 6 files changed, 218 insertions(+), 7 deletions(-) create mode 100644 apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts create mode 100644 documentation/tickets/t00005.md diff --git a/apps/api/src/gameSessionStore/GameSessionStore.ts b/apps/api/src/gameSessionStore/GameSessionStore.ts index 766f26c..55a8bb8 100644 --- a/apps/api/src/gameSessionStore/GameSessionStore.ts +++ b/apps/api/src/gameSessionStore/GameSessionStore.ts @@ -1,7 +1,11 @@ export type GameSessionData = { answers: Map<string, number> }; export interface GameSessionStore { - create(sessionId: string, data: GameSessionData): Promise<void>; + create( + sessionId: string, + data: GameSessionData, + ttlMs: number, + ): Promise<void>; get(sessionId: string): Promise<GameSessionData | null>; delete(sessionId: string): Promise<void>; } diff --git a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts new file mode 100644 index 0000000..9d8f355 --- /dev/null +++ b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts @@ -0,0 +1,45 @@ +import { describe, it, expect, beforeEach } from "vitest"; +import { InMemoryGameSessionStore } from "./InMemoryGameSessionStore.js"; + +describe("InMemoryGameSessionStore", () => { + let store: InMemoryGameSessionStore; + + beforeEach(() => { + store = new InMemoryGameSessionStore(); + }); + + it("returns null for a non-existent session", async () => { + const result = await store.get("00000000-0000-0000-0000-000000000000"); + expect(result).toBeNull(); + }); + + it("returns session data after creation", async () => { + const data = { answers: new Map([["q1", 2]]) }; + await store.create("session-1", data, 60_000); + const result = await store.get("session-1"); + expect(result).toEqual(data); + }); + + it("returns null after the session is deleted", async () => { + const data = { answers: new Map([["q1", 2]]) }; + await store.create("session-1", data, 60_000); + await store.delete("session-1"); + const result = await store.get("session-1"); + expect(result).toBeNull(); + }); + + it("returns null after TTL expires", async () => { + const data = { answers: new Map([["q1", 2]]) }; + await store.create("session-1", data, 1); + await new Promise((resolve) => setTimeout(resolve, 10)); + const result = await store.get("session-1"); + expect(result).toBeNull(); + }); + + it("returns session data before TTL expires", async () => { + const data = { answers: new Map([["q1", 2]]) }; + await store.create("session-1", data, 60_000); + const result = await store.get("session-1"); + expect(result).not.toBeNull(); + }); +}); diff --git a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts index f29ca59..8ec2265 100644 --- a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts +++ b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts @@ -1,15 +1,27 @@ import type { GameSessionStore, GameSessionData } from "./GameSessionStore.js"; -export class InMemoryGameSessionStore implements GameSessionStore { - private sessions = new Map<string, GameSessionData>(); +type SessionEntry = { data: GameSessionData; expiresAt: number }; - create(sessionId: string, data: GameSessionData): Promise<void> { - this.sessions.set(sessionId, data); +export class InMemoryGameSessionStore implements GameSessionStore { + private sessions = new Map<string, SessionEntry>(); + + create( + sessionId: string, + data: GameSessionData, + ttlMs: number, + ): Promise<void> { + this.sessions.set(sessionId, { data, expiresAt: Date.now() + ttlMs }); return Promise.resolve(); } get(sessionId: string): Promise<GameSessionData | null> { - return Promise.resolve(this.sessions.get(sessionId) ?? null); + const entry = this.sessions.get(sessionId); + if (!entry) return Promise.resolve(null); + if (Date.now() > entry.expiresAt) { + this.sessions.delete(sessionId); + return Promise.resolve(null); + } + return Promise.resolve(entry.data); } delete(sessionId: string): Promise<void> { diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index 9299b06..48dfbcf 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -219,4 +219,55 @@ describe("evaluateAnswer", () => { "Question not found", ); }); + + it("throws NotFoundError when the same question is submitted twice", async () => { + const session = await createGameSession(validRequest, store); + const question = session.questions[0]!; + + await evaluateAnswer( + { + sessionId: session.sessionId, + questionId: question.questionId, + selectedOptionId: 0, + }, + store, + ); + + await expect( + evaluateAnswer( + { + sessionId: session.sessionId, + questionId: question.questionId, + selectedOptionId: 0, + }, + store, + ), + ).rejects.toThrow("Question not found"); + }); + + it("deletes the session after the last question is answered", async () => { + const session = await createGameSession(validRequest, store); + + for (const question of session.questions) { + await evaluateAnswer( + { + sessionId: session.sessionId, + questionId: question.questionId, + selectedOptionId: 0, + }, + store, + ); + } + + await expect( + evaluateAnswer( + { + sessionId: session.sessionId, + questionId: session.questions[0]!.questionId, + selectedOptionId: 0, + }, + store, + ), + ).rejects.toThrow("Game session not found"); + }); }); diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index 4611bec..4c6458f 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -59,7 +59,7 @@ export const createGameSession = async ( ); const sessionId = randomUUID(); - await store.create(sessionId, { answers: answerKey }); + await store.create(sessionId, { answers: answerKey }, 30 * 60 * 1000); return { sessionId, questions }; }; @@ -80,6 +80,12 @@ export const evaluateAnswer = async ( throw new NotFoundError(`Question not found: ${submission.questionId}`); } + session.answers.delete(submission.questionId); + + if (session.answers.size === 0) { + await store.delete(submission.sessionId); + } + return { questionId: submission.questionId, isCorrect: submission.selectedOptionId === correctOptionId, diff --git a/documentation/tickets/t00005.md b/documentation/tickets/t00005.md new file mode 100644 index 0000000..baf5e2b --- /dev/null +++ b/documentation/tickets/t00005.md @@ -0,0 +1,93 @@ +# ADR: Session lifecycle — TTL and replay protection + +## Status + +Accepted + +## Date + +2026-04-28 + +## Context + +`InMemoryGameSessionStore` had no TTL and no cleanup mechanism. Every session created stayed in memory until the process restarted. Additionally, `evaluateAnswer` never removed a question from the answer key after evaluating it, meaning the same question could be submitted multiple times and receive a valid result each time — a potential exploit in multiplayer and a correctness bug in singleplayer. + +## Decision + +Add a `ttlMs` parameter to `GameSessionStore.create()` so both the in-memory and future Valkey implementations handle expiry consistently. Delete questions from the answer key after evaluation. Delete the session when the last question is answered. + +## Options considered + +### Option A — Delete on last answer only + +Simple. Covers replay protection and normal session completion. Abandoned sessions (player starts game, never finishes) still leak memory. + +### Option B — Delete on last answer + TTL on the interface ✅ + +Delete on answer covers normal flow. TTL covers abandoned sessions. TTL on the interface means `ValKeyGameSessionStore` can use Redis-native `EXPIRE` without any interface changes during migration. + +Chosen because it closes the memory leak entirely and makes the Valkey migration a zero-interface-change operation. + +### Option C — TTL hardcoded inside InMemoryGameSessionStore only + +Simpler short-term. But the interface wouldn't carry the TTL parameter, so `ValKeyGameSessionStore` would need a different mechanism — inconsistency between implementations. + +## Consequences + +- Sessions expire after 30 minutes of inactivity regardless of completion state +- Submitting the same question twice throws `NotFoundError` on the second attempt +- Sessions are deleted automatically when the last question is answered +- `GameSessionStore.create()` now requires a `ttlMs` argument — any future implementation must honour it +- `ValKeyGameSessionStore` can implement TTL via Redis `EXPIRE` with no interface changes +- `InMemoryGameSessionStore` stores `{ data, expiresAt }` entries instead of raw `GameSessionData` — expiry is checked lazily on `get()` + +## Affected files + +- `apps/api/src/gameSessionStore/GameSessionStore.ts` — `ttlMs` added to `create` +- `apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts` — TTL implementation +- `apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts` — new test file +- `apps/api/src/services/gameService.ts` — passes TTL to `store.create`, deletes question after evaluation, deletes session when empty +- `apps/api/src/services/gameService.test.ts` — replay protection and session cleanup tests added + +## References + +- [Redis EXPIRE command](https://redis.io/commands/expire/) + +--- + +## Setup guide / implementation notes + +1. `GameSessionStore.ts` — add `ttlMs` to `create`: + + ```ts + create(sessionId: string, data: GameSessionData, ttlMs: number): Promise<void>; + ``` + +2. `InMemoryGameSessionStore.ts` — wrap stored data with expiry: + + ```ts + type SessionEntry = { data: GameSessionData; expiresAt: number }; + ``` + + Check expiry on `get()`, delete expired entries lazily. + +3. `gameService.ts` — pass TTL when creating session: + + ```ts + await store.create(sessionId, { answers: answerKey }, 30 * 60 * 1000); + ``` + + After evaluating an answer: + + ```ts + session.answers.delete(submission.questionId); + if (session.answers.size === 0) { + await store.delete(submission.sessionId); + } + ``` + +4. When implementing `ValKeyGameSessionStore`, pass `ttlMs` to Redis `EXPIRE`: + + ```ts + await valkey.set(sessionId, serialize(data), "EX", Math.ceil(ttlMs / 1000)); + ``` From 1e30f04e81967ce70c139d7af3b42dbfbadb766f Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 14:39:13 +0200 Subject: [PATCH 11/19] feat: add ownership check to evaluateAnswer, AuthenticatedRequest type --- apps/api/src/controllers/gameController.ts | 27 +++- .../src/gameSessionStore/GameSessionStore.ts | 2 +- .../InMemoryGameSessionStore.test.ts | 8 +- apps/api/src/routes/gameRouter.ts | 6 +- apps/api/src/services/gameService.test.ts | 49 +++---- apps/api/src/services/gameService.ts | 6 +- apps/api/src/types/express.d.ts | 5 +- documentation/tickets/t00006.md | 125 ++++++++++++++++++ 8 files changed, 189 insertions(+), 39 deletions(-) create mode 100644 documentation/tickets/t00006.md diff --git a/apps/api/src/controllers/gameController.ts b/apps/api/src/controllers/gameController.ts index 5ab8e75..72a9414 100644 --- a/apps/api/src/controllers/gameController.ts +++ b/apps/api/src/controllers/gameController.ts @@ -1,30 +1,47 @@ -import type { Request, Response, NextFunction } from "express"; +import type { Response, NextFunction } from "express"; +import type { AuthenticatedRequest } from "../types/express.js"; import { GameRequestSchema, AnswerSubmissionSchema } from "@lila/shared"; import { createGameSession, evaluateAnswer } from "../services/gameService.js"; import { ValidationError } from "../errors/AppError.js"; import type { GameSessionStore } from "../gameSessionStore/index.js"; export const createGameController = (store: GameSessionStore) => ({ - createGame: async (req: Request, res: Response, next: NextFunction) => { + createGame: async ( + req: AuthenticatedRequest, + res: Response, + next: NextFunction, + ) => { try { const gameSettings = GameRequestSchema.safeParse(req.body); if (!gameSettings.success) { throw new ValidationError(gameSettings.error.message); } - const gameQuestions = await createGameSession(gameSettings.data, store); + const gameQuestions = await createGameSession( + gameSettings.data, + store, + req.session.user.id, + ); res.json({ success: true, data: gameQuestions }); } catch (error) { next(error); } }, - submitAnswer: async (req: Request, res: Response, next: NextFunction) => { + submitAnswer: async ( + req: AuthenticatedRequest, + res: Response, + next: NextFunction, + ) => { try { const submission = AnswerSubmissionSchema.safeParse(req.body); if (!submission.success) { throw new ValidationError(submission.error.message); } - const result = await evaluateAnswer(submission.data, store); + const result = await evaluateAnswer( + submission.data, + store, + req.session.user.id, + ); res.json({ success: true, data: result }); } catch (error) { next(error); diff --git a/apps/api/src/gameSessionStore/GameSessionStore.ts b/apps/api/src/gameSessionStore/GameSessionStore.ts index 55a8bb8..75d42cb 100644 --- a/apps/api/src/gameSessionStore/GameSessionStore.ts +++ b/apps/api/src/gameSessionStore/GameSessionStore.ts @@ -1,4 +1,4 @@ -export type GameSessionData = { answers: Map<string, number> }; +export type GameSessionData = { answers: Map<string, number>; userId: string }; export interface GameSessionStore { create( diff --git a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts index 9d8f355..918d8ed 100644 --- a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts +++ b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts @@ -14,14 +14,14 @@ describe("InMemoryGameSessionStore", () => { }); it("returns session data after creation", async () => { - const data = { answers: new Map([["q1", 2]]) }; + const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; await store.create("session-1", data, 60_000); const result = await store.get("session-1"); expect(result).toEqual(data); }); it("returns null after the session is deleted", async () => { - const data = { answers: new Map([["q1", 2]]) }; + const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; await store.create("session-1", data, 60_000); await store.delete("session-1"); const result = await store.get("session-1"); @@ -29,7 +29,7 @@ describe("InMemoryGameSessionStore", () => { }); it("returns null after TTL expires", async () => { - const data = { answers: new Map([["q1", 2]]) }; + const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; await store.create("session-1", data, 1); await new Promise((resolve) => setTimeout(resolve, 10)); const result = await store.get("session-1"); @@ -37,7 +37,7 @@ describe("InMemoryGameSessionStore", () => { }); it("returns session data before TTL expires", async () => { - const data = { answers: new Map([["q1", 2]]) }; + const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; await store.create("session-1", data, 60_000); const result = await store.get("session-1"); expect(result).not.toBeNull(); diff --git a/apps/api/src/routes/gameRouter.ts b/apps/api/src/routes/gameRouter.ts index 08aeb26..9e29a5d 100644 --- a/apps/api/src/routes/gameRouter.ts +++ b/apps/api/src/routes/gameRouter.ts @@ -12,8 +12,8 @@ export const createGameRouter = (store: GameSessionStore): Router => { router.use(requireAuth); router.use(gameLimiter); - router.post("/start", controller.createGame); - router.post("/answer", controller.submitAnswer); - + router.post("/start", controller.createGame as express.RequestHandler); + router.post("/answer", controller.submitAnswer as express.RequestHandler); + return router; }; diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index 48dfbcf..65d21d7 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -36,7 +36,6 @@ beforeEach(() => { }); describe("createGameSession", () => { - let store: InMemoryGameSessionStore; beforeEach(() => { @@ -44,14 +43,14 @@ describe("createGameSession", () => { }); it("returns a session with the correct number of questions", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); expect(session.sessionId).toBeDefined(); expect(session.questions).toHaveLength(3); }); it("each question has exactly 4 options", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); for (const question of session.questions) { expect(question.options).toHaveLength(4); @@ -59,14 +58,14 @@ describe("createGameSession", () => { }); it("each question has a unique questionId", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); const ids = session.questions.map((q) => q.questionId); expect(new Set(ids).size).toBe(ids.length); }); it("options have sequential optionIds 0-3", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); for (const question of session.questions) { const optionIds = question.options.map((o) => o.optionId); @@ -75,7 +74,7 @@ describe("createGameSession", () => { }); it("the correct answer is always among the options", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); for (let i = 0; i < session.questions.length; i++) { const question = session.questions[i]!; @@ -87,7 +86,7 @@ describe("createGameSession", () => { }); it("distractors are never the correct answer", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); for (let i = 0; i < session.questions.length; i++) { const question = session.questions[i]!; @@ -103,7 +102,7 @@ describe("createGameSession", () => { }); it("sets the prompt from the source text", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); expect(session.questions[0]!.prompt).toBe("dog"); expect(session.questions[1]!.prompt).toBe("cat"); @@ -111,14 +110,14 @@ describe("createGameSession", () => { }); it("passes gloss through (null or string)", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); expect(session.questions[0]!.gloss).toBeNull(); expect(session.questions[2]!.gloss).toBe("a building for living in"); }); it("calls getGameTerms with the correct arguments", async () => { - await createGameSession(validRequest, store); + await createGameSession(validRequest, store, "user-1"); expect(mockGetGameTerms).toHaveBeenCalledWith( "en", @@ -130,7 +129,7 @@ describe("createGameSession", () => { }); it("calls getDistractors once per question", async () => { - await createGameSession(validRequest, store); + await createGameSession(validRequest, store, "user-1"); expect(mockGetDistractors).toHaveBeenCalledTimes(3); }); @@ -138,23 +137,21 @@ describe("createGameSession", () => { it("propagates unexpected errors from getGameTerms", async () => { mockGetGameTerms.mockRejectedValue(new Error("connection refused")); - await expect(createGameSession(validRequest, store)).rejects.toThrow( - "connection refused", - ); + await expect( + createGameSession(validRequest, store, "user-1"), + ).rejects.toThrow("connection refused"); }); }); describe("evaluateAnswer", () => { - let store: InMemoryGameSessionStore; beforeEach(() => { store = new InMemoryGameSessionStore(); }); - it("returns isCorrect: true when the correct option is selected", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); const question = session.questions[0]!; const correctText = fakeTerms[0]!.targetText; const correctOption = question.options.find((o) => o.text === correctText)!; @@ -166,6 +163,7 @@ describe("evaluateAnswer", () => { selectedOptionId: correctOption.optionId, }, store, + "user-1", ); expect(result.isCorrect).toBe(true); @@ -174,7 +172,7 @@ describe("evaluateAnswer", () => { }); it("returns isCorrect: false when a wrong option is selected", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); const question = session.questions[0]!; const correctText = fakeTerms[0]!.targetText; const correctOption = question.options.find((o) => o.text === correctText)!; @@ -187,6 +185,7 @@ describe("evaluateAnswer", () => { selectedOptionId: wrongOption.optionId, }, store, + "user-1", ); expect(result.isCorrect).toBe(false); @@ -201,13 +200,13 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }; - await expect(evaluateAnswer(submission, store)).rejects.toThrow( + await expect(evaluateAnswer(submission, store, "user-1")).rejects.toThrow( "Game session not found", ); }); it("throws NotFoundError for a non-existent question", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); const submission: AnswerSubmission = { sessionId: session.sessionId, @@ -215,13 +214,13 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }; - await expect(evaluateAnswer(submission, store)).rejects.toThrow( + await expect(evaluateAnswer(submission, store, "user-1")).rejects.toThrow( "Question not found", ); }); it("throws NotFoundError when the same question is submitted twice", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); const question = session.questions[0]!; await evaluateAnswer( @@ -231,6 +230,7 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }, store, + "user-1", ); await expect( @@ -241,12 +241,13 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }, store, + "user-1", ), ).rejects.toThrow("Question not found"); }); it("deletes the session after the last question is answered", async () => { - const session = await createGameSession(validRequest, store); + const session = await createGameSession(validRequest, store, "user-1"); for (const question of session.questions) { await evaluateAnswer( @@ -256,6 +257,7 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }, store, + "user-1", ); } @@ -267,6 +269,7 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }, store, + "user-1", ), ).rejects.toThrow("Game session not found"); }); diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index 4c6458f..b892986 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -15,6 +15,7 @@ import { shuffleArray } from "../lib/utils.js"; export const createGameSession = async ( request: GameRequest, store: GameSessionStore, + userId: string, ): Promise<GameSession> => { const terms = await getGameTerms( request.source_language, @@ -59,7 +60,7 @@ export const createGameSession = async ( ); const sessionId = randomUUID(); - await store.create(sessionId, { answers: answerKey }, 30 * 60 * 1000); + await store.create(sessionId, { answers: answerKey, userId }, 30 * 60 * 1000); return { sessionId, questions }; }; @@ -67,10 +68,11 @@ export const createGameSession = async ( export const evaluateAnswer = async ( submission: AnswerSubmission, store: GameSessionStore, + userId: string, ): Promise<AnswerResult> => { const session = await store.get(submission.sessionId); - if (!session) { + if (!session || session.userId !== userId) { throw new NotFoundError(`Game session not found: ${submission.sessionId}`); } diff --git a/apps/api/src/types/express.d.ts b/apps/api/src/types/express.d.ts index 2fe1ac8..da7633a 100644 --- a/apps/api/src/types/express.d.ts +++ b/apps/api/src/types/express.d.ts @@ -1,3 +1,4 @@ +import type { Request } from "express"; import type { Session, User } from "better-auth"; declare global { @@ -14,4 +15,6 @@ declare module "ws" { } } -export {}; +export type AuthenticatedRequest = Request & { + session: { session: Session; user: User }; +}; diff --git a/documentation/tickets/t00006.md b/documentation/tickets/t00006.md new file mode 100644 index 0000000..8e777f0 --- /dev/null +++ b/documentation/tickets/t00006.md @@ -0,0 +1,125 @@ +# ADR: Session ownership check and AuthenticatedRequest type + +## Status + +Accepted + +## Date + +2026-04-28 + +## Context + +`evaluateAnswer` accepted any `sessionId` without verifying it belonged to the requesting user. The only protection was the unguessability of a UUID — security through obscurity. If a user intercepted or guessed another user's `sessionId`, they could submit answers on their behalf. + +Additionally, protected controller handlers typed their `req` parameter as `Request`, making `session` optional even though `requireAuth` middleware guarantees it is present. This required non-null assertions (`req.session!`) in business logic — a type assertion that could cause a runtime crash if middleware ordering ever changed. + +## Decision + +Store `userId` in `GameSessionData`. Pass `userId` from the controller into both `createGameSession` and `evaluateAnswer`. Assert ownership on evaluation — if the session's `userId` doesn't match the requesting user's ID, throw `NotFoundError`. Introduce `AuthenticatedRequest` to eliminate non-null assertions in protected handlers. + +## Options considered + +### Option A — AuthenticatedRequest type ✅ + +Define `AuthenticatedRequest = Request & { session: { session: Session; user: User } }` in `types/express.d.ts`. Use it in protected controller handlers instead of `Request`. Requires a single `as express.RequestHandler` cast at route registration due to Express's type limitations. + +Chosen because: eliminates dangerous non-null assertions in business logic. The cast at route registration is a necessary cast caused by a third-party library limitation, not uncertain logic. + +### Option B — Non-null assertion (`req.session!`) + +Keep `Request` on all handlers. Assert `req.session!` at every usage. + +Rejected because: non-null assertions in business logic are dangerous — if middleware ordering ever changes, the assertion silently passes and crashes at runtime. + +--- + +### Option C — NotFoundError (404) on ownership failure ✅ + +When a session exists but belongs to a different user, throw `NotFoundError` with the same message as a missing session. + +Chosen because: session IDs are opaque secrets. Returning 403 would confirm to the caller that the session ID is valid and belongs to someone else — information they shouldn't have. This pattern is used by GitHub, AWS, and most security-conscious APIs. + +### Option D — ForbiddenError (403) on ownership failure + +Explicit error that distinguishes "not found" from "not allowed". + +Rejected because: for user-owned resources identified by opaque IDs, confirming existence to an unauthorised caller is an information leak. 404 is the industry standard for this case. + +## Consequences + +- Alice cannot submit answers for Bob's session — ownership is verified at the service layer +- `req.session.user.id` is accessible without non-null assertions in protected handlers +- `GameSessionData` now carries `userId` — any future `GameSessionStore` implementation must store and return it +- Route registration requires `as express.RequestHandler` cast for protected handlers — one cast per route, in wiring code only +- `ValKeyGameSessionStore` must serialise and deserialise `userId` alongside `answers` + +## Affected files + +- `apps/api/src/types/express.d.ts` — `AuthenticatedRequest` type added +- `apps/api/src/gameSessionStore/GameSessionStore.ts` — `userId` added to `GameSessionData` +- `apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts` — updated data fixtures +- `apps/api/src/services/gameService.ts` — `userId` parameter added to both functions, ownership assertion in `evaluateAnswer` +- `apps/api/src/services/gameService.test.ts` — updated all calls, ownership test added +- `apps/api/src/controllers/gameController.ts` — extracts `userId` from `req.session.user.id`, passes to service calls +- `apps/api/src/routes/gameRouter.ts` — `as express.RequestHandler` cast at route registration + +## References + +- [OWASP: Insecure Direct Object Reference](https://owasp.org/www-community/attacks/Insecure_Direct_Object_Reference) +- [HTTP 403 vs 404 for authorization failures](https://stackoverflow.com/questions/3297048/403-forbidden-vs-401-unauthorized-http-responses) + +--- + +## Setup guide / implementation notes + +1. `types/express.d.ts` — add: + + ```ts + export type AuthenticatedRequest = Request & { + session: { session: Session; user: User }; + }; + ``` + +2. `GameSessionStore.ts` — add `userId` to `GameSessionData`: + + ```ts + export type GameSessionData = { answers: Map<string, number>; userId: string }; + ``` + +3. `gameService.ts` — add `userId` to both function signatures: + + ```ts + export const createGameSession = async ( + request: GameRequest, + store: GameSessionStore, + userId: string, + ): Promise<GameSession> + ``` + + Store it on create: + + ```ts + await store.create(sessionId, { answers: answerKey, userId }, 30 * 60 * 1000); + ``` + + Assert on evaluate: + + ```ts + if (!session || session.userId !== userId) { + throw new NotFoundError(`Game session not found: ${submission.sessionId}`); + } + ``` + +4. `gameController.ts` — extract from authenticated request: + + ```ts + req.session.user.id + ``` + +5. `gameRouter.ts` — cast at registration: + + ```ts + router.post("/start", controller.createGame as express.RequestHandler); + router.post("/answer", controller.submitAnswer as express.RequestHandler); + ``` From 3d16ab0fffbc9004259263e2251a254483fef3f5 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 15:08:06 +0200 Subject: [PATCH 12/19] feat: guard against empty terms in createGameSession --- .../src/controllers/gameController.test.ts | 9 ++++ apps/api/src/services/gameService.test.ts | 8 ++++ apps/api/src/services/gameService.ts | 4 ++ documentation/tickets/t00007.md | 41 +++++++++++++++++++ 4 files changed, 62 insertions(+) create mode 100644 documentation/tickets/t00007.md diff --git a/apps/api/src/controllers/gameController.test.ts b/apps/api/src/controllers/gameController.test.ts index cfbe065..d8115bd 100644 --- a/apps/api/src/controllers/gameController.test.ts +++ b/apps/api/src/controllers/gameController.test.ts @@ -110,6 +110,15 @@ describe("POST /api/v1/game/start", () => { expect(res.status).toBe(400); expect(body.success).toBe(false); }); + + it("returns 404 when no terms are found for the given filters", async () => { + mockGetGameTerms.mockResolvedValue([]); + + const res = await request(app).post("/api/v1/game/start").send(validBody); + const body = res.body as ErrorResponse; + expect(res.status).toBe(404); + expect(body.success).toBe(false); + }); }); describe("POST /api/v1/game/answer", () => { diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index 65d21d7..e922bd4 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -273,4 +273,12 @@ describe("evaluateAnswer", () => { ), ).rejects.toThrow("Game session not found"); }); + + it("throws NotFoundError when getGameTerms returns no terms", async () => { + mockGetGameTerms.mockResolvedValue([]); + + await expect( + createGameSession(validRequest, store, "user-1"), + ).rejects.toThrow("No terms found"); + }); }); diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index b892986..ddb2d4d 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -25,6 +25,10 @@ export const createGameSession = async ( request.rounds, ); + if (terms.length === 0) { + throw new NotFoundError("No terms found for the given filters"); + } + const answerKey = new Map<string, number>(); const questions: GameQuestion[] = await Promise.all( diff --git a/documentation/tickets/t00007.md b/documentation/tickets/t00007.md new file mode 100644 index 0000000..5469049 --- /dev/null +++ b/documentation/tickets/t00007.md @@ -0,0 +1,41 @@ +# feat: guard against empty terms in createGameSession + +## Problem + +If `getGameTerms` returned an empty array — no vocabulary data matched the requested language, difficulty, and part of speech combination — `createGameSession` would create a session with zero questions and return it. The frontend would receive an empty `questions` array, attempt to render the first question, find nothing, and crash with no useful error message shown to the user. + +## Options considered + +### Option A — `NotFoundError` (404) ✅ + +Throw when `terms.length === 0` before any session is created. The combination of filters yielded no data — that's a "not found" situation. + +Chosen because: the request is technically valid (all filter values are recognised), but the combination has no matching data. 404 is the correct semantic response. + +### Option B — `ValidationError` (400) + +Treat empty results as a bad request. + +Rejected because: the client sent valid input. The problem is missing data, not invalid input. 400 would be misleading. + +## Solution + +Added a guard in `createGameSession` immediately after `getGameTerms`: + +```ts +if (terms.length === 0) { + throw new NotFoundError("No terms found for the given filters"); +} +``` + +The error propagates through the controller's `try/catch` to the error handler, which returns a clean 404 response. No session is created. + +## Files changed + +- `apps/api/src/services/gameService.ts` — empty terms guard added +- `apps/api/src/services/gameService.test.ts` — pinning test added +- `apps/api/src/controllers/gameController.test.ts` — pinning test added at HTTP layer + +## Commit + +`feat: guard against empty terms in createGameSession` From a02f3b139df0b0f60b520fc34d3addd23d37df42 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 15:17:31 +0200 Subject: [PATCH 13/19] fix: deduplicate distractors, replace tautological test, add distractor failure test --- apps/api/src/services/gameService.test.ts | 34 +++++++++----- apps/api/src/services/gameService.ts | 7 ++- documentation/tickets/t00008.md | 54 +++++++++++++++++++++++ 3 files changed, 81 insertions(+), 14 deletions(-) create mode 100644 documentation/tickets/t00008.md diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index e922bd4..d5b56de 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -85,20 +85,22 @@ describe("createGameSession", () => { } }); - it("distractors are never the correct answer", async () => { + it("correct answer appears exactly once even if getDistractors returns a duplicate", async () => { + mockGetDistractors.mockResolvedValueOnce([ + "cane", + "wrong2", + "wrong3", + "wrong4", + "wrong5", + "wrong6", + ]); + const session = await createGameSession(validRequest, store, "user-1"); + const question = session.questions[0]!; + const optionTexts = question.options.map((o) => o.text); - for (let i = 0; i < session.questions.length; i++) { - const question = session.questions[i]!; - const correctText = fakeTerms[i]!.targetText; - const distractorTexts = question.options - .map((o) => o.text) - .filter((t) => t !== correctText); - - for (const text of distractorTexts) { - expect(text).not.toBe(correctText); - } - } + expect(optionTexts.filter((t) => t === "cane")).toHaveLength(1); + expect(question.options).toHaveLength(4); }); it("sets the prompt from the source text", async () => { @@ -141,6 +143,14 @@ describe("createGameSession", () => { createGameSession(validRequest, store, "user-1"), ).rejects.toThrow("connection refused"); }); + + it("propagates getDistractors failure", async () => { + mockGetDistractors.mockRejectedValue(new Error("db timeout")); + + await expect( + createGameSession(validRequest, store, "user-1"), + ).rejects.toThrow("db timeout"); + }); }); describe("evaluateAnswer", () => { diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index ddb2d4d..a64b4e7 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -39,10 +39,13 @@ export const createGameSession = async ( request.target_language, request.pos, request.difficulty, - 3, + 6, ); - const optionTexts = [term.targetText, ...distractorTexts]; + const uniqueDistractors = distractorTexts.filter( + (t) => t !== term.targetText, + ); + const optionTexts = [term.targetText, ...uniqueDistractors.slice(0, 3)]; const shuffledTexts = shuffleArray(optionTexts); const correctOptionId = shuffledTexts.indexOf(term.targetText); diff --git a/documentation/tickets/t00008.md b/documentation/tickets/t00008.md new file mode 100644 index 0000000..b171abc --- /dev/null +++ b/documentation/tickets/t00008.md @@ -0,0 +1,54 @@ +# fix: deduplicate distractors, replace tautological test + +## Problem + +Two issues in `createGameSession` and its test suite: + +1. If `getDistractors` returned the correct answer as one of the distractors, `createGameSession` would include it in the options array without filtering it out. `indexOf` would then find the first occurrence, which might not be the one intended as the correct answer — producing a question where the correct answer appears twice and the stored `correctOptionId` is wrong. + +2. The test `"distractors are never the correct answer"` was tautological — it filtered the correct answer out of the options array, then asserted the remaining items were not the correct answer. It was testing that `Array.filter()` works. It could never fail. + +## Options considered + +### Option A — Filter duplicates after fetching, request extra distractors as buffer ✅ + +Filter out any distractor that matches the correct answer after fetching. Request 6 distractors instead of 3 to ensure enough remain after deduplication. Take the first 3 valid ones with `slice(0, 3)`. + +Chosen because: deduplication at the service layer is the right place — `getDistractors` shouldn't need to know what the correct answer is. Requesting extra provides a buffer against collisions. + +### Option B — Fix `getDistractors` to never return the correct answer + +Add a NOT filter in the database query. + +Not chosen for this ticket — the database query is in `@lila/db` and is a separate concern. The service layer should be defensive regardless of what the model layer returns. + +## Solution + +- Filter distractors against the correct answer before building options: + + ```ts + const uniqueDistractors = distractorTexts.filter((t) => t !== term.targetText); + const optionTexts = [term.targetText, ...uniqueDistractors.slice(0, 3)]; + ``` + +- Request 6 distractors instead of 3 to account for potential duplicates +- Replaced tautological test with a test that actually exercises the duplicate case: + + ```ts + it("correct answer appears exactly once even if getDistractors returns a duplicate", ...) + ``` + +- Added distractor failure propagation test: + + ```ts + it("propagates getDistractors failure", ...) + ``` + +## Files changed + +- `apps/api/src/services/gameService.ts` — deduplication logic, distractor count increased to 6 +- `apps/api/src/services/gameService.test.ts` — tautological test replaced, failure test added + +## Commit + +`fix: deduplicate distractors, replace tautological test, add distractor failure test` From a02d3b3335a42f276fde7e87fffd133f60ebff8f Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 15:44:29 +0200 Subject: [PATCH 14/19] fix: deduplicate distractors against each other, guard thin distractor pool --- .../InMemoryGameSessionStore.test.ts | 17 + apps/api/src/services/gameService.test.ts | 42 +- apps/api/src/services/gameService.ts | 13 +- documentation/roasts/gameService.md | 366 ------------------ 4 files changed, 68 insertions(+), 370 deletions(-) diff --git a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts index 918d8ed..fae0365 100644 --- a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts +++ b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts @@ -42,4 +42,21 @@ describe("InMemoryGameSessionStore", () => { const result = await store.get("session-1"); expect(result).not.toBeNull(); }); + + it("update persists modified session data", async () => { + const data = { + answers: new Map([ + ["q1", 2], + ["q2", 1], + ]), + userId: "user-1", + }; + await store.create("session-1", data, 60_000); + + const updated = { answers: new Map([["q2", 1]]), userId: "user-1" }; + await store.update("session-1", updated); + + const result = await store.get("session-1"); + expect(result).toEqual(updated); + }); }); diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index d5b56de..98cad3b 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -32,7 +32,14 @@ const fakeTerms = [ beforeEach(() => { vi.clearAllMocks(); mockGetGameTerms.mockResolvedValue(fakeTerms); - mockGetDistractors.mockResolvedValue(["wrong1", "wrong2", "wrong3"]); + mockGetDistractors.mockResolvedValue([ + "wrong1", + "wrong2", + "wrong3", + "wrong4", + "wrong5", + "wrong6", + ]); }); describe("createGameSession", () => { @@ -151,6 +158,39 @@ describe("createGameSession", () => { createGameSession(validRequest, store, "user-1"), ).rejects.toThrow("db timeout"); }); + + it("throws when fewer than 3 unique distractors remain after deduplication", async () => { + mockGetDistractors.mockResolvedValueOnce([ + "cane", + "cane", + "cane", + "cane", + "cane", + "cane", + ]); + + await expect( + createGameSession(validRequest, store, "user-1"), + ).rejects.toThrow("Not enough unique distractors"); + }); + + it("duplicate distractors are deduplicated against each other", async () => { + mockGetDistractors.mockResolvedValueOnce([ + "wrong1", + "wrong1", + "wrong1", + "wrong2", + "wrong3", + "wrong4", + ]); + + const session = await createGameSession(validRequest, store, "user-1"); + const question = session.questions[0]!; + const optionTexts = question.options.map((o) => o.text); + + expect(new Set(optionTexts).size).toBe(4); + expect(question.options).toHaveLength(4); + }); }); describe("evaluateAnswer", () => { diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index a64b4e7..309fa1a 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -42,9 +42,16 @@ export const createGameSession = async ( 6, ); - const uniqueDistractors = distractorTexts.filter( - (t) => t !== term.targetText, - ); + const uniqueDistractors = [ + ...new Set(distractorTexts.filter((t) => t !== term.targetText)), + ]; + + if (uniqueDistractors.length < 3) { + throw new Error( + `Not enough unique distractors for term: ${term.targetText}`, + ); + } + const optionTexts = [term.targetText, ...uniqueDistractors.slice(0, 3)]; const shuffledTexts = shuffleArray(optionTexts); const correctOptionId = shuffledTexts.indexOf(term.targetText); diff --git a/documentation/roasts/gameService.md b/documentation/roasts/gameService.md index 0db3559..e69de29 100644 --- a/documentation/roasts/gameService.md +++ b/documentation/roasts/gameService.md @@ -1,366 +0,0 @@ -# `gameService.ts` — Code Review & Fixes - ---- - -## 1. Hardcoded singleton kills the abstraction - -**Problem** - -A `GameSessionStore` interface exists, an `InMemoryGameSessionStore` implements it, and then the concrete class is immediately hardcoded as a module-level singleton. The interface is decorative — nothing can inject an alternative implementation without editing this file. - -```ts -// ❌ current — store is unreachable from outside -const gameSessionStore = new InMemoryGameSessionStore(); - -export const createGameSession = async (request: GameRequest) => { ... }; -export const evaluateAnswer = async (submission: AnswerSubmission) => { ... }; -``` - -**Fix — inject the store** - -Accept the store as a parameter (or use a factory). The simplest approach that requires no framework: - -```ts -// ✅ inject the store -export const createGameSession = async ( - request: GameRequest, - store: GameSessionStore, -): Promise<GameSession> => { ... }; - -export const evaluateAnswer = async ( - submission: AnswerSubmission, - store: GameSessionStore, -): Promise<AnswerResult> => { ... }; -``` - -The call site (controller) owns the store instance and passes it in. Tests can pass a fresh `InMemoryGameSessionStore` per test — no mocking required, no shared state. - -```ts -// gameController.ts -const store = new InMemoryGameSessionStore(); - -// later, swap for ValKeyGameSessionStore with one line change -``` - ---- - -## 2. Sessions are never deleted — memory leak - -**Problem** - -`GameSessionStore.delete()` is defined and implemented but never called. Every session ever created stays in the Map until the process restarts. Under real traffic this is a slow memory leak; under a spike it's a fast one. - -**Fix — delete after answer, or add a TTL** - -The simplest fix: delete the session once the last question is answered. If partial completion is needed, add a TTL on creation instead. - -```ts -// ✅ option A — delete on answer -export const evaluateAnswer = async ( - submission: AnswerSubmission, - store: GameSessionStore, -): Promise<AnswerResult> => { - const session = await store.get(submission.sessionId); - if (!session) - throw new NotFoundError(`Game session not found: ${submission.sessionId}`); - - const correctOptionId = session.answers.get(submission.questionId); - if (correctOptionId === undefined) - throw new NotFoundError(`Question not found: ${submission.questionId}`); - - // delete answered question; delete session when all questions are answered - session.answers.delete(submission.questionId); - if (session.answers.size === 0) { - await store.delete(submission.sessionId); - } - - return { - questionId: submission.questionId, - isCorrect: submission.selectedOptionId === correctOptionId, - correctOptionId, - selectedOptionId: submission.selectedOptionId, - }; -}; -``` - -```ts -// ✅ option B — TTL in InMemoryGameSessionStore -export class InMemoryGameSessionStore implements GameSessionStore { - private sessions = new Map< - string, - { data: GameSessionData; expiresAt: number } - >(); - private readonly ttlMs: number; - - constructor(ttlMs = 30 * 60 * 1000) { - // 30 minutes default - this.ttlMs = ttlMs; - } - - create(sessionId: string, data: GameSessionData): Promise<void> { - this.sessions.set(sessionId, { data, expiresAt: Date.now() + this.ttlMs }); - return Promise.resolve(); - } - - get(sessionId: string): Promise<GameSessionData | null> { - const entry = this.sessions.get(sessionId); - if (!entry) return Promise.resolve(null); - if (Date.now() > entry.expiresAt) { - this.sessions.delete(sessionId); - return Promise.resolve(null); - } - return Promise.resolve(entry.data); - } - - delete(sessionId: string): Promise<void> { - this.sessions.delete(sessionId); - return Promise.resolve(); - } -} -``` - ---- - -**Problem** - -`GameRequest.rounds` is typed as `string` in `@lila/shared`, forcing the service to cast it every time: - -```ts -// ❌ why is a round count a string? -Number(request.rounds); -``` - -**Fix — fix the schema in `@lila/shared`** - -```ts -// ✅ in packages/shared -export const GameRequestSchema = z.object({ - source_language: z.string(), - target_language: z.string(), - pos: z.string(), - difficulty: z.string(), - rounds: z.coerce.number().int().min(1).max(50), // coerce handles form inputs, validates range -}); - -export type GameRequest = z.infer<typeof GameRequestSchema>; -``` - -The `z.coerce.number()` handles the case where the value arrives as a string from a query param or form — Zod does the conversion at the boundary so the rest of the system never sees a string. - ---- - -**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. - -```ts -// ❌ these are terms, not answers yet -const correctAnswers = await getGameTerms(...); -``` - -**Fix** - -```ts -// ✅ -const terms = await getGameTerms(...); - -// and inside the map: -terms.map(async (term) => { - const distractorTexts = await getDistractors( - term.termId, - term.targetText, - ... - ); - ... - const correctOptionId = shuffledTexts.indexOf(term.targetText); - ... -}); -``` - ---- - -## 6. Tautological test: `"distractors are never the correct answer"` - -**Problem** - -The test filters the correct answer out of the options array, then asserts the remaining items are not the correct answer. It is testing that `Array.filter` works. - -```ts -// ❌ this cannot fail -it("distractors are never the correct answer", async () => { - const distractorTexts = question.options - .map((o) => o.text) - .filter((t) => t !== correctText); // removes correct answer... - - for (const text of distractorTexts) { - expect(text).not.toBe(correctText); // ...then checks they're not the correct answer - } -}); -``` - -**What to actually test** - -The real concern is that `getDistractors` doesn't return the target word. Test that the service handles it correctly if it does: - -```ts -// ✅ test that the correct answer appears exactly once even if a distractor collides -it("correct answer appears exactly once in options even if distractor matches", async () => { - // simulate getDistractors returning the correct answer as one of the distractors - mockGetDistractors.mockResolvedValueOnce(["cane", "wrong2", "wrong3"]); - - const session = await createGameSession( - validRequest, - new InMemoryGameSessionStore(), - ); - const question = session.questions[0]!; - const optionTexts = question.options.map((o) => o.text); - - // "cane" should only appear once regardless of the duplicate from getDistractors - expect(optionTexts.filter((t) => t === "cane")).toHaveLength(1); - expect(question.options).toHaveLength(4); -}); -``` - -> **Note:** the current implementation doesn't actually handle this case — a duplicate distractor would produce a 4-option list where the correct answer appears twice and one distractor slot is wasted. Worth fixing in `createGameSession` alongside the test. - ---- - -## 7. Store not reset between tests - -**Problem** - -`beforeEach` calls `vi.clearAllMocks()` which resets mock functions, but the `gameSessionStore` module-level singleton is never cleared. Ghost sessions from earlier tests persist for the entire test run. - -It doesn't bite today because each session gets a unique UUID and tests don't share IDs — but it's one non-UUID lookup away from a very confusing afternoon. - -**Fix — a consequence of fixing issue #1** - -Once the store is injected rather than module-level, each test creates its own instance: - -```ts -// ✅ no shared state, no ghost sessions -describe("evaluateAnswer", () => { - it("returns isCorrect: true for correct option", async () => { - const store = new InMemoryGameSessionStore(); - const session = await createGameSession(validRequest, store); - ... - const result = await evaluateAnswer({ ... }, store); - ... - }); -}); -``` - -No `beforeEach` cleanup needed — the store simply doesn't outlive the test that created it. - ---- - -## 8. No answer replay protection - -**Problem** - -`evaluateAnswer` can be called multiple times with the same `questionId`. The -service will evaluate it every time. In multiplayer this could be abused to -farm points or desync state. - -**Fix — delete the question from the answer key after first evaluation** - -```ts -// ✅ inside evaluateAnswer, after retrieving correctOptionId -session.answers.delete(submission.questionId); - -if (submission.selectedOptionId !== correctOptionId) { - // already removed — can't retry -} -``` - -Once the question key is deleted, a second submission hits the -`correctOptionId === undefined` branch and throws `NotFoundError`. One shot -per question. - ---- - -## 9. No ownership check in `evaluateAnswer` - -**Problem** - -The service accepts any `sessionId` without verifying it belongs to the -requesting user. If auth middleware doesn't tie sessions to users at a higher -layer, Alice can submit answers for Bob's session by guessing or intercepting -his `sessionId`. - -**Fix — store `userId` alongside the session and assert it on retrieval** - -```ts -// GameSessionStore.ts -export type GameSessionData = { answers: Map<string, number>; userId: string }; - -// evaluateAnswer -const session = await store.get(submission.sessionId); - -if (!session) throw new NotFoundError(`Game session not found`); -if (session.userId !== requestingUserId) - throw new NotFoundError(`Game session not found`); -// ^^^ same error — don't confirm the session exists to the wrong user -``` - -Pass `requestingUserId` in from the controller, where it's already available -via auth middleware. - ---- - -## 10. No test for empty `getGameTerms` result - -**Problem** - -If the database returns zero terms (no words match the difficulty/language/pos -filter), `createGameSession` happily returns a session with an empty -`questions` array. The frontend receives it, tries to render question 1, and -crashes. The user sees nothing useful. - -**Fix — guard in the service and add a test** - -```ts -// ✅ inside createGameSession, after fetching terms -if (terms.length === 0) { - throw new AppError("No terms found for the given filters", 404); -} -``` - -```ts -// ✅ test -it("throws when getGameTerms returns no terms", async () => { - mockGetGameTerms.mockResolvedValue([]); - - await expect( - createGameSession(validRequest, new InMemoryGameSessionStore()), - ).rejects.toThrow("No terms found"); -}); -``` - ---- - -## 11. No test for `getDistractors` rejection - -**Problem** - -`createGameSession` uses `Promise.all` over the terms array. If -`getDistractors` rejects for any single term, the entire `Promise.all` rejects -— no session is created, no partial recovery, the user gets a 500 with -"connection refused" leaking through. - -**Fix — test the failure path and consider a fallback** - -```ts -// ✅ test -it("propagates getDistractors failure", async () => { - mockGetDistractors.mockRejectedValue(new Error("db timeout")); - - await expect( - createGameSession(validRequest, new InMemoryGameSessionStore()), - ).rejects.toThrow("db timeout"); -}); -``` - -For resilience, consider catching per-term distractor failures and falling back -to random terms from the already-fetched set rather than collapsing the whole -session. From c081e632cfcf01f69e44aef98f03a66d4210d409 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 15:47:53 +0200 Subject: [PATCH 15/19] fix: explicit store update in evaluateAnswer, remove mutation through reference --- apps/api/src/gameSessionStore/GameSessionStore.ts | 3 ++- .../src/gameSessionStore/InMemoryGameSessionStore.ts | 7 +++++++ apps/api/src/services/gameService.ts | 10 ++++++++-- 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/apps/api/src/gameSessionStore/GameSessionStore.ts b/apps/api/src/gameSessionStore/GameSessionStore.ts index 75d42cb..14e27b0 100644 --- a/apps/api/src/gameSessionStore/GameSessionStore.ts +++ b/apps/api/src/gameSessionStore/GameSessionStore.ts @@ -7,5 +7,6 @@ export interface GameSessionStore { ttlMs: number, ): Promise<void>; get(sessionId: string): Promise<GameSessionData | null>; + update(sessionId: string, data: GameSessionData): Promise<void>; delete(sessionId: string): Promise<void>; -} +} \ No newline at end of file diff --git a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts index 8ec2265..71e4b4c 100644 --- a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts +++ b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.ts @@ -24,6 +24,13 @@ export class InMemoryGameSessionStore implements GameSessionStore { return Promise.resolve(entry.data); } + update(sessionId: string, data: GameSessionData): Promise<void> { + const entry = this.sessions.get(sessionId); + if (!entry) return Promise.resolve(); + this.sessions.set(sessionId, { data, expiresAt: entry.expiresAt }); + return Promise.resolve(); + } + delete(sessionId: string): Promise<void> { this.sessions.delete(sessionId); return Promise.resolve(); diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index 309fa1a..573f7a8 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -96,10 +96,16 @@ export const evaluateAnswer = async ( throw new NotFoundError(`Question not found: ${submission.questionId}`); } - session.answers.delete(submission.questionId); + const updatedAnswers = new Map(session.answers); + updatedAnswers.delete(submission.questionId); - if (session.answers.size === 0) { + if (updatedAnswers.size === 0) { await store.delete(submission.sessionId); + } else { + await store.update(submission.sessionId, { + answers: updatedAnswers, + userId: session.userId, + }); } return { From 6eaf282651532be7b96ef9b388360c59a5d9608f Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 15:51:57 +0200 Subject: [PATCH 16/19] fix: sanitise Zod validation error messages in game controller --- apps/api/src/controllers/gameController.test.ts | 11 +++++++++++ apps/api/src/controllers/gameController.ts | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/apps/api/src/controllers/gameController.test.ts b/apps/api/src/controllers/gameController.test.ts index d8115bd..d47f8b9 100644 --- a/apps/api/src/controllers/gameController.test.ts +++ b/apps/api/src/controllers/gameController.test.ts @@ -119,6 +119,17 @@ describe("POST /api/v1/game/start", () => { expect(res.status).toBe(404); expect(body.success).toBe(false); }); + + it("returns a sanitised error message when the body is invalid", async () => { + const res = await request(app) + .post("/api/v1/game/start") + .send({ ...validBody, difficulty: "impossible" }); + const body = res.body as ErrorResponse; + expect(res.status).toBe(400); + expect(body.error).toBe("Invalid game settings"); + expect(body.error).not.toContain("Invalid literal value"); + expect(body.error).not.toContain("Invalid enum value"); + }); }); describe("POST /api/v1/game/answer", () => { diff --git a/apps/api/src/controllers/gameController.ts b/apps/api/src/controllers/gameController.ts index 72a9414..2a0416e 100644 --- a/apps/api/src/controllers/gameController.ts +++ b/apps/api/src/controllers/gameController.ts @@ -14,7 +14,7 @@ export const createGameController = (store: GameSessionStore) => ({ try { const gameSettings = GameRequestSchema.safeParse(req.body); if (!gameSettings.success) { - throw new ValidationError(gameSettings.error.message); + throw new ValidationError("Invalid game settings"); } const gameQuestions = await createGameSession( gameSettings.data, @@ -35,7 +35,7 @@ export const createGameController = (store: GameSessionStore) => ({ try { const submission = AnswerSubmissionSchema.safeParse(req.body); if (!submission.success) { - throw new ValidationError(submission.error.message); + throw new ValidationError("Invalid answer submission"); } const result = await evaluateAnswer( submission.data, From 648c5d29793dd3b1527cb97d67f7473913350d81 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 16:07:19 +0200 Subject: [PATCH 17/19] fix: improve error semantics, clarify answer key type --- .../src/controllers/gameController.test.ts | 12 +++---- apps/api/src/errors/AppError.ts | 6 ++++ .../src/gameSessionStore/GameSessionStore.ts | 7 +++-- .../InMemoryGameSessionStore.test.ts | 31 +++++++++++++------ apps/api/src/services/gameService.test.ts | 16 +++++----- apps/api/src/services/gameService.ts | 24 ++++++++------ 6 files changed, 62 insertions(+), 34 deletions(-) diff --git a/apps/api/src/controllers/gameController.test.ts b/apps/api/src/controllers/gameController.test.ts index d47f8b9..168d2d1 100644 --- a/apps/api/src/controllers/gameController.test.ts +++ b/apps/api/src/controllers/gameController.test.ts @@ -111,12 +111,12 @@ describe("POST /api/v1/game/start", () => { expect(body.success).toBe(false); }); - it("returns 404 when no terms are found for the given filters", async () => { + it("returns 422 when no terms are found for the given filters", async () => { mockGetGameTerms.mockResolvedValue([]); const res = await request(app).post("/api/v1/game/start").send(validBody); const body = res.body as ErrorResponse; - expect(res.status).toBe(404); + expect(res.status).toBe(422); expect(body.success).toBe(false); }); @@ -178,7 +178,7 @@ describe("POST /api/v1/game/answer", () => { expect(body.error).toContain("Game session not found"); }); - it("returns 404 when the question does not exist in the session", async () => { + it("returns 409 when the question does not exist in the session", async () => { const startRes = await request(app) .post("/api/v1/game/start") .send(validBody); @@ -193,11 +193,11 @@ describe("POST /api/v1/game/answer", () => { selectedOptionId: 0, }); const body = res.body as ErrorResponse; - expect(res.status).toBe(404); + expect(res.status).toBe(409); expect(body.success).toBe(false); - expect(body.error).toContain("Question not found"); + expect(body.error).toContain("Question already answered"); }); - + it("returns 400 when a field has an invalid value", async () => { const res = await request(app) .post("/api/v1/game/start") diff --git a/apps/api/src/errors/AppError.ts b/apps/api/src/errors/AppError.ts index 4677d9f..7805f3e 100644 --- a/apps/api/src/errors/AppError.ts +++ b/apps/api/src/errors/AppError.ts @@ -25,3 +25,9 @@ export class ConflictError extends AppError { super(message, 409); } } + +export class UnprocessableEntityError extends AppError { + constructor(message: string) { + super(message, 422); + } +} \ No newline at end of file diff --git a/apps/api/src/gameSessionStore/GameSessionStore.ts b/apps/api/src/gameSessionStore/GameSessionStore.ts index 14e27b0..3e6c5d2 100644 --- a/apps/api/src/gameSessionStore/GameSessionStore.ts +++ b/apps/api/src/gameSessionStore/GameSessionStore.ts @@ -1,4 +1,7 @@ -export type GameSessionData = { answers: Map<string, number>; userId: string }; +export type GameSessionData = { + answers: Map<string, { correctOptionId: number }>; + userId: string; +}; export interface GameSessionStore { create( @@ -9,4 +12,4 @@ export interface GameSessionStore { get(sessionId: string): Promise<GameSessionData | null>; update(sessionId: string, data: GameSessionData): Promise<void>; delete(sessionId: string): Promise<void>; -} \ No newline at end of file +} diff --git a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts index fae0365..d08be1f 100644 --- a/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts +++ b/apps/api/src/gameSessionStore/InMemoryGameSessionStore.test.ts @@ -14,14 +14,20 @@ describe("InMemoryGameSessionStore", () => { }); it("returns session data after creation", async () => { - const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; + const data = { + answers: new Map([["q1", { correctOptionId: 2 }]]), + userId: "user-1", + }; await store.create("session-1", data, 60_000); const result = await store.get("session-1"); expect(result).toEqual(data); }); it("returns null after the session is deleted", async () => { - const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; + const data = { + answers: new Map([["q1", { correctOptionId: 2 }]]), + userId: "user-1", + }; await store.create("session-1", data, 60_000); await store.delete("session-1"); const result = await store.get("session-1"); @@ -29,7 +35,10 @@ describe("InMemoryGameSessionStore", () => { }); it("returns null after TTL expires", async () => { - const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; + const data = { + answers: new Map([["q1", { correctOptionId: 2 }]]), + userId: "user-1", + }; await store.create("session-1", data, 1); await new Promise((resolve) => setTimeout(resolve, 10)); const result = await store.get("session-1"); @@ -37,7 +46,10 @@ describe("InMemoryGameSessionStore", () => { }); it("returns session data before TTL expires", async () => { - const data = { answers: new Map([["q1", 2]]), userId: "user-1" }; + const data = { + answers: new Map([["q1", { correctOptionId: 2 }]]), + userId: "user-1", + }; await store.create("session-1", data, 60_000); const result = await store.get("session-1"); expect(result).not.toBeNull(); @@ -45,15 +57,16 @@ describe("InMemoryGameSessionStore", () => { it("update persists modified session data", async () => { const data = { - answers: new Map([ - ["q1", 2], - ["q2", 1], - ]), + answers: new Map([["q1", { correctOptionId: 2 }]]), userId: "user-1", }; + await store.create("session-1", data, 60_000); - const updated = { answers: new Map([["q2", 1]]), userId: "user-1" }; + const updated = { + answers: new Map([["q2", { correctOptionId: 1 }]]), + userId: "user-1", + }; await store.update("session-1", updated); const result = await store.get("session-1"); diff --git a/apps/api/src/services/gameService.test.ts b/apps/api/src/services/gameService.test.ts index 98cad3b..76fa3a2 100644 --- a/apps/api/src/services/gameService.test.ts +++ b/apps/api/src/services/gameService.test.ts @@ -255,7 +255,7 @@ describe("evaluateAnswer", () => { ); }); - it("throws NotFoundError for a non-existent question", async () => { + it("throws ConflictError for a non-existent question", async () => { const session = await createGameSession(validRequest, store, "user-1"); const submission: AnswerSubmission = { @@ -264,12 +264,12 @@ describe("evaluateAnswer", () => { selectedOptionId: 0, }; - await expect(evaluateAnswer(submission, store, "user-1")).rejects.toThrow( - "Question not found", - ); + await expect( + evaluateAnswer(submission, store, "user-1"), + ).rejects.toMatchObject({ statusCode: 409 }); }); - it("throws NotFoundError when the same question is submitted twice", async () => { + it("throws ConflictError when the same question is submitted twice", async () => { const session = await createGameSession(validRequest, store, "user-1"); const question = session.questions[0]!; @@ -293,7 +293,7 @@ describe("evaluateAnswer", () => { store, "user-1", ), - ).rejects.toThrow("Question not found"); + ).rejects.toMatchObject({ statusCode: 409 }); }); it("deletes the session after the last question is answered", async () => { @@ -324,11 +324,11 @@ describe("evaluateAnswer", () => { ).rejects.toThrow("Game session not found"); }); - it("throws NotFoundError when getGameTerms returns no terms", async () => { + it("throws UnprocessableEntityError when getGameTerms returns no terms", async () => { mockGetGameTerms.mockResolvedValue([]); await expect( createGameSession(validRequest, store, "user-1"), - ).rejects.toThrow("No terms found"); + ).rejects.toMatchObject({ statusCode: 422 }); }); }); diff --git a/apps/api/src/services/gameService.ts b/apps/api/src/services/gameService.ts index 573f7a8..ad34c72 100644 --- a/apps/api/src/services/gameService.ts +++ b/apps/api/src/services/gameService.ts @@ -9,7 +9,11 @@ import type { AnswerResult, } from "@lila/shared"; import type { GameSessionStore } from "../gameSessionStore/index.js"; -import { NotFoundError } from "../errors/AppError.js"; +import { + NotFoundError, + ConflictError, + UnprocessableEntityError, +} from "../errors/AppError.js"; import { shuffleArray } from "../lib/utils.js"; export const createGameSession = async ( @@ -26,10 +30,10 @@ export const createGameSession = async ( ); if (terms.length === 0) { - throw new NotFoundError("No terms found for the given filters"); + throw new UnprocessableEntityError("No terms found for the given filters"); } - const answerKey = new Map<string, number>(); + const answerKey = new Map<string, { correctOptionId: number }>(); const questions: GameQuestion[] = await Promise.all( terms.map(async (term) => { @@ -62,7 +66,7 @@ export const createGameSession = async ( })); const questionId = randomUUID(); - answerKey.set(questionId, correctOptionId); + answerKey.set(questionId, { correctOptionId }); return { questionId, @@ -90,10 +94,12 @@ export const evaluateAnswer = async ( throw new NotFoundError(`Game session not found: ${submission.sessionId}`); } - const correctOptionId = session.answers.get(submission.questionId); + const answer = session.answers.get(submission.questionId); - if (correctOptionId === undefined) { - throw new NotFoundError(`Question not found: ${submission.questionId}`); + if (answer === undefined) { + throw new ConflictError( + `Question already answered: ${submission.questionId}`, + ); } const updatedAnswers = new Map(session.answers); @@ -110,8 +116,8 @@ export const evaluateAnswer = async ( return { questionId: submission.questionId, - isCorrect: submission.selectedOptionId === correctOptionId, - correctOptionId, + isCorrect: submission.selectedOptionId === answer.correctOptionId, + correctOptionId: answer.correctOptionId, selectedOptionId: submission.selectedOptionId, }; }; From 98c59f33c598c4aaf2d9246b684f8ad90e5a45f9 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 16:39:36 +0200 Subject: [PATCH 18/19] formatting + adding issues --- README.md | 8 ++++---- documentation/backlog.md | 6 ++++++ 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e212a55..66a5195 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Live at [lilastudy.com](https://lilastudy.com). ## Repository Structure -``` +```tree lila/ ├── apps/ │ ├── api/ — Express backend @@ -50,7 +50,7 @@ lila/ Requests flow through a strict layered architecture: -``` +```text HTTP Request → Router → Controller → Service → Model → Database ``` @@ -71,7 +71,7 @@ Vocabulary data is sourced from WordNet and the Open Multilingual Wordnet (OMW). ## API -``` +```text POST /api/v1/game/start — start a quiz session (auth required) POST /api/v1/game/answer — submit an answer (auth required) GET /api/v1/health — health check (public) @@ -90,7 +90,7 @@ Rooms are created via REST, then managed over WebSockets. Messages are typed via ## Infrastructure -``` +```tree Internet → Caddy (HTTPS) ├── lilastudy.com → web (nginx, static files) ├── api.lilastudy.com → api (Express) diff --git a/documentation/backlog.md b/documentation/backlog.md index d0cb202..3d5e5da 100644 --- a/documentation/backlog.md +++ b/documentation/backlog.md @@ -23,6 +23,12 @@ Things that are actively in progress or should be picked up immediately. Mostly Clearly planned work, not yet started. No hard ordering — sequence based on what unblocks real users first. +- **Batch distractor queries to eliminate N+1** `[debt]` + createGameSession calls getDistractors once per term in parallel — 3 queries for 3 rounds, 10 for 10. Each query does ORDER BY RANDOM() which can't use an index and gets slower as the translations table grows. Fix: add a getDistractorsForTerms(termIds[], ...) function to @lila/db that batches all distractor fetches into a single query and returns results grouped by term. The service distributes the results per question. Prerequisite: none. Blocked by: nothing, but coordinate with any ongoing @lila/db changes. + +- **Atomic session creation** `[debt]` + createGameSession reads from Postgres (getGameTerms, getDistractors) then writes to the session store (in-memory/Valkey). A crash between the two leaves the terms consumed with no session created — the user gets an error and retries, no data is corrupted, but the work is wasted. A true transaction boundary isn't achievable across two different systems (Postgres + Valkey have no shared coordinator). Options when revisiting: store sessions in Postgres instead of Valkey (full transactionality, higher latency), or accept the current behaviour and add retry logic on the client. Revisit after Valkey is in production and actual failure rates are observable. + - **Guest / try-now flow** `[feature]` Allow users to play a quiz without signing in so they can see what the app offers before creating an account. Make auth middleware optional on game routes, add a "Try without account" button on the landing/login page. From fd9667c1fd3a57dcbec57cdf8dc248d18a8c3cf9 Mon Sep 17 00:00:00 2001 From: lila <beiweitemderbeste@protonmail.com> Date: Tue, 28 Apr 2026 17:26:01 +0200 Subject: [PATCH 19/19] updating documentation --- documentation/backlog.md | 9 +- documentation/roasts/gameService.md | 348 ++++++++++++++++++++++++++++ 2 files changed, 351 insertions(+), 6 deletions(-) diff --git a/documentation/backlog.md b/documentation/backlog.md index 3d5e5da..6a91e2d 100644 --- a/documentation/backlog.md +++ b/documentation/backlog.md @@ -8,15 +8,9 @@ Labels: `[feature]` `[infra]` `[security]` `[ux]` `[debt]` Things that are actively in progress or should be picked up immediately. Mostly operational risk and the remaining phase 7 hardening work. -- **Google OAuth publishing** `[infra]` - Only test users can currently log in via Google. Publish the OAuth consent screen so any Google user can sign in — requires branding verification in Google Cloud Console. - - **Hetzner domain migration check** `[infra]` Verify whether the lilastudy.com domain needs to be migrated following a Hetzner DNS change. Check Hetzner dashboard for any pending migration notice. -- **Conditionally register OAuth providers** `[debt]` - Better Auth logs warnings when social providers are registered without credentials (`Social provider google is missing clientId or clientSecret`). Instead of registering all providers unconditionally, only add a provider to the config when its credentials are present in the environment. Keeps local dev clean for contributors who don't have OAuth apps set up. - --- ## next @@ -69,6 +63,9 @@ Clearly planned work, not yet started. No hard ordering — sequence based on wh - **Tighten CSP to remove unsafe-inline** `[security]` Current script-src uses 'unsafe-inline' to accommodate framework-injected inline scripts (likely TanStack Router hydration). Tightening this would require nonce-based CSP, which needs server-rendered HTML or a Caddy layer that injects per-request nonces. Not urgent — pragmatic CSP with 'unsafe-inline' is mainstream for SPAs at this scale. Revisit if the app handles more sensitive data or grows a meaningful user base +- **Publish Google OAuth consent screen** `[infra]` + App is currently in testing mode, which caps OAuth sign-ins at 100 users. Before hitting that limit, publish the consent screen in Google Cloud Console. Basic scopes (email, profile, openid) require no Google review — just fill in branding fields (app name, logo, support email, privacy policy URL) and click publish. Trigger: do this before reaching 80 users. + --- ## later diff --git a/documentation/roasts/gameService.md b/documentation/roasts/gameService.md index e69de29..73283de 100644 --- a/documentation/roasts/gameService.md +++ b/documentation/roasts/gameService.md @@ -0,0 +1,348 @@ +# 🔥 GameService Roast: `apps/api/src/services/gameService.ts` + +> *"It works on my machine" is not a scalability strategy.* + +**Project:** lila — Vocabulary Trainer +**File Roasted:** `gameService.ts` +**Date:** $(date) +**Roaster:** Qwen3.6 + +--- + +## 📋 Executive Summary + +| Metric | Score | Notes | +| ------------- | -------- | ---------------------------------------------------- | +| Code Quality | 8/10 | Clean layering, good types, consistent style | +| Correctness | 6/10 | Race condition + N+1 query are critical | +| Test Coverage | 7/10 | Good happy-path tests, missing concurrency tests | +| Scalability | 5/10 | Will choke at ~100 concurrent users without fixes | +| **Overall** | **7/10** | Solid foundation, but fix the footguns before launch | + +--- + +## 🚨 Critical Issues (Fix Before Production) + +### 1. Race Condition: Lost Update in `evaluateAnswer` + +**Location:** `gameService.ts:45-58` + `InMemoryGameSessionStore.ts:update()` + +// Current flow (VULNERABLE): +const session = await store.get(submission.sessionId); // READ +const updatedAnswers = new Map(session.answers); // MODIFY (local copy) +updatedAnswers.delete(submission.questionId); +await store.update(submission.sessionId, { answers: updatedAnswers }); // WRITE + +The Attack: + + Client submits answer A and answer B for the same question (network retry, bug, or malice) + Both requests read the same session.answers Map (question still present) + Both delete the question from their local copy + Both write back → second write overwrites first + Result: One answer is silently lost, session state desyncs + +Why Tests Missed It: Vitest runs tests synchronously. Race conditions require deliberate concurrency testing. +Fix Options: + +// Option A: Add atomic operation to store interface +interface GameSessionStore { + deleteAnswer(sessionId: string, questionId: string): Promise<boolean>; +} + +// Option B: Use Valkey Lua script for atomic read-modify-write +// Option C: Optimistic locking with version numbers + +Priority: 🔴 CRITICAL — Data integrity issue +2. N+1 Query: Database Performance Bomb +Location: gameService.ts:24-26 + termModel.ts:getDistractors() + +// For each of N terms, we call getDistractors(): +const questions: GameQuestion[] = await Promise.all( + terms.map(async (term) => { + const distractorTexts = await getDistractors(term.termId, ...); // 🚩 N queries! + }) +); + +Impact Analysis: +Rounds + +DB Queries + +At 50 concurrent users +3 + +1 + 3 = 4 + +200 queries/min +10 + +1 + 10 = 11 + +550 queries/min +20 + +1 + 20 = 21 + +1,050 queries/min +Each getDistractors() runs: + +SELECT text FROM terms +JOIN translations ON ... +WHERE pos = $1 AND difficulty = $2 AND term_id != $3 AND text != $4 +ORDER BY RANDOM() LIMIT 6 + +Fix: Batch Fetch Distractors + +// Fetch all distractors in ONE query +const allDistractors = await db + .select({ termId: terms.id, text: translations.text }) + .from(terms) + .innerJoin(translations, /* ... */) + .where(and( + eq(terms.pos, pos), + eq(translations.difficulty, difficulty), + inArray(terms.id, termIds), // Batch! + )) + .limit(DISTRACTOR_FETCH_COUNT * termIds.length); + +// Group by termId in JS, then slice to 3 unique distractors per term +const distractorsByTerm = groupByTermId(allDistractors); + +Priority: 🔴 CRITICAL — Performance/scalability issue + +3. Error Handling Inconsistency +Location: gameService.ts:33-36 + +if (uniqueDistractors.length < 3) { + throw new Error(`Not enough unique distractors for term: ${term.targetText}`); // 🚩 +} + +Problem: Raw Error bypasses your errorHandler middleware: + + No HTTP status mapping (defaults to 500) + No structured logging + Inconsistent API responses + +Fix: +import { UnprocessableEntityError } from "../errors/AppError.js"; + +if (uniqueDistractors.length < 3) { + logger.warn({ termId: term.termId, uniqueCount: uniqueDistractors.length }, + "insufficient_distractors"); + throw new UnprocessableEntityError( + `Not enough unique distractors for term: ${term.targetText}` + ); +} +Priority: 🟡 HIGH — Observability & UX issue +⚠️ High-Severity Smells +4. Code Duplication: Singleplayer vs Multiplayer +Compare: gameService.ts vs multiplayerGameService.ts +// gameService.ts +const optionTexts = [term.targetText, ...uniqueDistractors.slice(0, 3)]; +const shuffledTexts = shuffleArray(optionTexts); +const correctOptionId = shuffledTexts.indexOf(term.targetText); + +// multiplayerGameService.ts (lines 35-45) +const optionTexts = [correctAnswer.targetText, ...distractorTexts]; +const shuffledTexts = shuffle(optionTexts); // Different function, same logic! +const correctOptionId = shuffledTexts.indexOf(correctAnswer.targetText); + +Risks: + + Fix shuffle bias in one place, forget the other + Add new option type (e.g., etymology hint), update one service only + Harder to test core game logic in isolation + +Fix: Extract pure function to @lila/shared or new @lila/game-logic: + +// packages/shared/src/game-logic.ts +export const buildQuestionOptions = ( + correctAnswer: string, + distractors: string[], + optionCount: number = 4 +): { options: AnswerOption[]; correctOptionId: number } => { + const uniqueDistractors = [...new Set(distractors.filter(d => d !== correctAnswer))]; + const optionTexts = [correctAnswer, ...uniqueDistractors.slice(0, optionCount - 1)]; + const shuffled = shuffleSecure(optionTexts); + const correctOptionId = shuffled.indexOf(correctAnswer); + + return { + options: shuffled.map((text, idx) => ({ optionId: idx, text })), + correctOptionId + }; +}; + +Priority: 🟡 HIGH — Maintainability issue +5. Shuffle Bias: Math.random() Trap +Location: utils.ts:shuffleArray() + multiplayerGameService.ts:shuffle() + +export const shuffleArray = <T>(array: T[]): T[] => { + for (let i = result.length - 1; i > 0; i--) { + const j = Math.floor(Math.random() * (i + 1)); // 🚩 Modulo bias + non-crypto RNG + // ... + } +}; + +The Math: + + Math.random() has ~53 bits of entropy (fine for vocab) + Math.floor(rand * n) has modulo bias when n isn't a power of 2 + For n=4: bias is ~0.01% (tiny, but non-zero) + +When It Matters: + + Competitive leaderboards ("option 0 is correct 26% of the time") + Achievement systems based on answer patterns + Security-sensitive features (not applicable here, but principle matters) + +Fix (if needed): +import { randomBytes } from "crypto"; + +const shuffleSecure = <T>(array: T[]): T[] => { + const result = [...array]; + for (let i = result.length - 1; i > 0; i--) { + // Use crypto.getRandomValues for better randomness + const rand = randomBytes(4).readUInt32LE(0); + const j = rand % (i + 1); + [result[i], result[j]] = [result[j], result[i]]; + } + return result; +}; + +Priority: 🟢 LOW — Document tradeoff and move on for now + +6. Test Coverage Gaps +File: gameService.test.ts +✅ Well Tested: + + Happy path: session creation, answer evaluation + Edge cases: duplicate distractors, empty results, invalid inputs + Error propagation from DB layer + +❌ Missing Tests: + +// 1. Concurrency test (race condition) +it("rejects duplicate answers for same question under concurrent load", async () => { + const session = await createGameSession(validRequest, store, "user-1"); + const question = session.questions[0]!; + + // Submit two answers simultaneously + const [result1, result2] = await Promise.allSettled([ + evaluateAnswer({ sessionId, questionId, selectedOptionId: 0 }, store, "user-1"), + evaluateAnswer({ sessionId, questionId, selectedOptionId: 1 }, store, "user-1"), + ]); + + // Exactly one should succeed, one should throw ConflictError + expect([result1, result2].filter(r => r.status === "fulfilled")).toHaveLength(1); +}); + +// 2. TTL expiration test +it("deletes session after TTL expires", async () => { + vi.useFakeTimers(); + const session = await createGameSession(validRequest, store, "user-1"); + + vi.advanceTimersByTime(31 * 60 * 1000); // 31 minutes + + await expect(store.get(session.sessionId)).resolves.toBeNull(); +}); + +// 3. Distractor fallback strategy test +it("uses fallback when <3 unique distractors available", async () => { + mockGetDistractors.mockResolvedValue(["same", "same", "same", "same"]); + // Should either: (a) fetch from broader pool, or (b) reduce rounds gracefully +}); + +Priority: 🟡 HIGH — Prevents regression on critical fixes +🧼 Code Quality Nitpicks +7. Magic Numbers + +// gameService.ts:52 +await store.create(sessionId, {...}, 30 * 60 * 1000); // What is this? + +// termModel.ts:65 +.limit(count); // count=6, but why? + +// shared/schemas/game.ts:15 +optionId: z.number().int().min(0).max(3), // Why 4 options? + +Fix: Centralize in @lila/shared/constants.ts: + +export const GAME_SESSION_TTL_MS = 30 * 60 * 1000; +export const DISTRACTOR_FETCH_COUNT = 6; +export const GAME_OPTION_COUNT = 4; +export const MIN_UNIQUE_DISTRACTORS = 3; + +8. Mutable Reference Leakage +Location: InMemoryGameSessionStore.ts:get() + +get(sessionId: string): Promise<GameSessionData | null> { + return Promise.resolve(entry.data); // 🚩 Returns mutable reference to internal state +} + +Risk: Any code that does session.answers.delete(...) mutates the store's internal Map directly. +Fix: + +// Option A: Deep clone (simple, works for this data shape) +return Promise.resolve(structuredClone(entry.data)); + +// Option B: Return readonly view (TypeScript-only protection) +return Promise.resolve(entry.data as Readonly<GameSessionData>); + +// Option C: Use immutable data structures (overkill for now) + +9. Zero Observability +Problem: No logging, no metrics. You're flying blind in production. +Minimal Fix (5 minutes): + + + +// apps/api/src/lib/logger.ts +import pino from "pino"; +export const logger = pino({ + level: process.env.LOG_LEVEL || "info", + transport: process.env.NODE_ENV === "production" + ? { target: "pino-pretty" } + : undefined +}); + +// In gameService.ts: +import { logger } from "../lib/logger.js"; + +logger.info( + { userId, sourceLang, targetLang, termCount: terms.length }, + "game_session_created" +); + +logger.debug( + { sessionId, questionId, isCorrect, responseTimeMs }, + "answer_evaluated" +); + +Bonus: Export a Prometheus histogram for game_service_duration_seconds. + +10. ORDER BY RANDOM() Time Bomb +Location: termModel.ts:getGameTerms() + getDistractors() + +.orderBy(sql`RANDOM()`) // 🚩 Fine for 10k rows, slow for 1M + +The Comment Admits It: + +// TODO(post-mvp): ORDER BY RANDOM() sorts the entire filtered result set... + +Reality Check: "Post-MVP" never comes without a ticket. +Fix Options: + +-- Option A: Pre-computed random_seed column (updated nightly) +WHERE ... AND random_seed >= random() +ORDER BY random_seed +LIMIT $1 + +-- Option B: TABLESAMPLE for approximate sampling (Postgres 9.5+) +FROM terms TABLESAMPLE SYSTEM(10) +WHERE ... +LIMIT $1 + +-- Option C: Random offset (simple, but still scans) +OFFSET floor(random() * (SELECT count(*) FROM terms WHERE ...)) + +Action: Add a ticket to documentation/tickets/t00009.md now. \ No newline at end of file