Architecting tests and mocking seed data. Refactor, rename 'Set' APIs to 'Match'

Author: aureateAnatidae

backend/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Backend HTTP server
+
+Much of the structure of this project is inspired by [this set of recommendations](https://github.com/zhanymkanov/fastapi-best-practices) on structuring a backend project, despite this project not using FastAPI.

backend/package.json

@@ -1,31 +1,33 @@
 {
-  "name": "backend",
-  "type": "module",
-  "scripts": {
-    "dev": "tsx watch src/index.ts",
-    "build": "tsc",
-    "start": "node dist/index.js",
-    "test": "vitest",
-    "check": "biome check src/",
-    "lint": "biome lint src/"
-  },
-  "dependencies": {
-    "@hono/node-server": "^1.19.6",
-    "@hono/standard-validator": "^0.2.0",
-    "@hono/zod-validator": "^0.7.5",
-    "better-sqlite3": "^12.4.6",
-    "hono": "^4.10.6",
-    "hono-openapi": "^1.1.1",
-    "knex": "^3.1.0",
-    "pino": "^10.1.0",
-    "zod": "^4.1.13"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "^2.3.7",
-    "@types/node": "^20.11.17",
-    "tsx": "^4.7.1",
-    "typescript": "^5.8.3",
-    "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^4.0.14"
-  }
-}
+    "name": "backend",
+    "type": "module",
+    "scripts": {
+        "dev": "tsx watch src/index.ts",
+        "build": "tsc",
+        "start": "node dist/index.js",
+        "test": "vitest",
+        "test:unit": "vitest unit",
+        "check": "biome check src/",
+        "lint": "biome lint src/"
+    },
+    "dependencies": {
+        "@hono/node-server": "^1.19.6",
+        "@hono/standard-validator": "^0.2.0",
+        "@hono/zod-validator": "^0.7.5",
+        "better-sqlite3": "^12.4.6",
+        "hono": "^4.10.6",
+        "hono-openapi": "^1.1.1",
+        "knex": "^3.1.0",
+        "pino": "^10.1.0",
+        "zod": "^4.1.13"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^2.3.7",
+        "@faker-js/faker": "^10.1.0",
+        "@types/node": "^20.11.17",
+        "tsx": "^4.7.1",
+        "typescript": "^5.8.3",
+        "vite-tsconfig-paths": "^5.1.4",
+        "vitest": "^4.0.14"
+    }
+}

backend/pnpm-lock.yaml

@@ -0,0 +1,23 @@
+import { seed as SSBUCharacters_seed } from "@seeds/SSBUCharacters";
+import pino from "pino";
+
+const log = pino();
+
+// Seek more customizable API where list of seeds can be provided to the seedsource
+export class SeedSource {
+    getSeeds() {
+        return Promise.resolve(["SSBUCharacters"]);
+    }
+
+    getSeed(seed) {
+        log.info(`Seeding ${seed}`);
+        switch (seed) {
+            case "SSBUCharacters":
+                return {
+                    async seed(knex) {
+                        await SSBUCharacters_seed(knex);
+                    },
+                };
+        }
+    }
+}

backend/src/db/SeedSource.ts

@@ -1,12 +1,19 @@
 import { knexDb } from "@db/knexfile";
-import { SetCharacterTable, SetResultTable, SetTable, SSBUCharTable } from "@v1/set/models";
+import {
+    MatchCharacterTable,
+    MatchPlayerTable,
+    MatchTable,
+    SSBUCharTable,
+} from "@v1/match/models";
+import { MatchWinnerView } from "@v1/match/views";
 import type { Knex } from "knex";
 
 import pino from "pino";
 
 const log = pino();
 
-const tables = [SetTable, SetResultTable, SetCharacterTable, SSBUCharTable];
+const tables = [MatchTable, MatchPlayerTable, MatchCharacterTable, SSBUCharTable];
+const views = [MatchWinnerView];
 
 async function create_table_if_notexists(
     db: Knex = knexDb,
@@ -19,7 +26,9 @@ async function create_table_if_notexists(
         await db.schema.createTable(tableName, callback);
         log.info(`${tableName} table successfully initialized.`);
     } else {
-        log.info(`Database already contains ${tableName} table. Skipping initialization.`);
+        log.info(
+            `Database already contains ${tableName} table. Skipping initialization.`,
+        );
     }
 }
 
@@ -32,9 +41,21 @@ export async function init_tables(db: Knex = knexDb) {
     await trx.commit();
 }
 
+export async function init_views(db: Knex = knexDb) {
+    const trx = await db.transaction();
+    for (const _view of views) {
+        const view = _view(db);
+        await trx.schema.createViewOrReplace(view.view_name, view.initialize);
+        log.info(`${view.view_name} view successfully initialized.`);
+    }
+    await trx.commit();
+}
+
 export async function teardown(db: Knex = knexDb) {
     if (process.env.NODE_ENV === "production") {
-        log.error("`teardown` was called on a production database -- no action will be performed");
+        log.error(
+            "`teardown` was called on a production database -- no action will be performed",
+        );
         return;
     }
     const trx = await db.transaction();

backend/src/db/init_tables.ts

@@ -1,3 +1,4 @@
+import { SeedSource } from "@db/SeedSource";
 import knex, { type Knex } from "knex";
 
 // TODO: https://knexjs.org/guide/#log
@@ -7,7 +8,7 @@ export const config = {
         filename: "./bot_data.db",
     },
     seeds: {
-        director: "./seeds/"
+        seedSource: new SeedSource(),
     },
     useNullAsDefault: true,
 };

backend/src/db/knexfile.ts

@@ -1,21 +1,18 @@
-import { init_tables, teardown } from "@db/init_tables";
+import { init_tables, init_views, teardown } from "@db/init_tables";
 import { serve } from "@hono/node-server";
-import set_router from "@v1/set/router";
+import match_router from "@v1/match/router";
 import user_router from "@v1/user/router";
 import { Hono } from "hono";
+import { trimTrailingSlash } from "hono/trailing-slash";
 import { openAPIRouteHandler } from "hono-openapi";
-import {
-  trimTrailingSlash,
-} from 'hono/trailing-slash'
-
 
 const app = new Hono();
 
 await teardown();
 await init_tables();
+await init_views();
 
-
-app.use(trimTrailingSlash())
+app.use(trimTrailingSlash());
 
 app.get("/", (c) => {
     return c.text("Hello Hono!");

backend/src/index.ts

@@ -0,0 +1,29 @@
+import { seed as SSBUCharacters_seed } from "@seeds/SSBUCharacters";
+import { seed as FakeMatches_seed } from "@v1/match/tests/mock.models";
+import pino from "pino";
+
+const log = pino();
+
+export class MockSeedSource {
+    getSeeds() {
+        return Promise.resolve(["SSBUCharacters", "FakeMatches"]);
+    }
+
+    getSeed(seed) {
+        log.info(`Seeding ${seed}`);
+        switch (seed) {
+            case "SSBUCharacters":
+                return {
+                    async seed(knex) {
+                        await SSBUCharacters_seed(knex);
+                    },
+                };
+            case "FakeMatches":
+                return {
+                    async seed(knex) {
+                        await FakeMatches_seed(knex);
+                    },
+                };
+        }
+    }
+}

backend/src/tests/MockSeedSource.ts

@@ -0,0 +1,18 @@
+// General utilities for generating mock data
+import { faker } from "@faker-js/faker";
+import { ssbu_character_names } from "@seeds/SSBUCharacters";
+
+export const snowflake = () =>
+    faker.string.numeric({
+        length: 18,
+    });
+
+export const randint = (max) => {
+    return Math.floor(Math.random() * max);
+};
+
+export const rand_character_array: Array<(typeof ssbu_character_names)[number]> = () =>
+    Array.from(
+        { length: 1 + randint(4) },
+        () => ssbu_character_names[randint(ssbu_character_names.length)],
+    );

backend/src/tests/mock.ts

@@ -1,12 +1,13 @@
+import { MockSeedSource } from "@tests/MockSeedSource";
 import knex, { type Knex } from "knex";
 
-export const test_config = {
+export const test_config: Knex.Config = {
     client: "better-sqlite3",
     connection: {
         filename: ":memory:",
     },
     seeds: {
-        director: "./seeds/"
+        seedSource: new MockSeedSource(),
     },
     useNullAsDefault: true,
 };