feat: Season table and season query function w/ tests. Refactor test seeding and use the word 'factory' over 'mock' when referring to overridable test object generators.

Author: aureateAnatidae

apps/backend/.swcrc

@@ -9,7 +9,6 @@
         },
         "baseUrl": "src",
         "paths": {
-            "@seeds/*": ["../seeds/*"],
             "@test/*": ["test/*"],
             "@db/*": ["db/*"],
             "@v1/*": ["v1/*"]

apps/backend/seeds/SSBUCharacters.ts

@@ -5,7 +5,7 @@ import type { Knex } from "knex";
 const log = getLogger(["grindcord", "db"]);
 
 // Seek more customizable API where list of seeds can be provided to the seedsource
-export class SeedSource {
+export class BaseSeedSource {
     getSeeds() {
         return Promise.resolve(["SSBUCharacters"]);
     }

apps/backend/src/db/SeedSource.ts apps/backend/src/db/BaseSeedSource.tsapps/backend/src/db/SeedSource.ts renamed to apps/backend/src/db/BaseSeedSource.ts

@@ -7,11 +7,19 @@ import {
     SSBUCharTable,
 } from "@v1/match/models";
 import { MatchReportView, MatchWinnerView } from "@v1/match/views";
+import { SeasonTable } from "@v1/season/models";
+import { Season } from "@v1/season/schemas";
 import type { Knex } from "knex";
 
 const log = getLogger(["grindcord", "db"]);
 
-const tables = [MatchTable, MatchPlayerTable, MatchCharacterTable, SSBUCharTable];
+const tables = [
+    MatchTable,
+    MatchPlayerTable,
+    MatchCharacterTable,
+    SSBUCharTable,
+    SeasonTable,
+];
 const views = [MatchWinnerView, MatchReportView];
 
 async function create_table_if_notexists(
@@ -31,18 +39,19 @@ async function create_table_if_notexists(
     }
 }
 
-export async function init_tables(db: Knex = knexDb) {
+export async function init_tables(db: Knex = knexDb): Promise<void> {
     const trx = await db.transaction();
     for (const table of tables) {
         await create_table_if_notexists(trx, table.table_name, table.initialize);
     }
+    await trx.seed.run();
     await trx.commit();
 }
 
-export async function run_seed(
+export async function seed_db(
     seedSource: Knex.SeedSource<unknown>,
     db: Knex = knexDb,
-) {
+): Promise<void> {
     await db.seed.run({ seedSource });
 }
 

apps/backend/src/db/init_tables.ts

@@ -1,11 +1,15 @@
 import knex, { type Knex } from "knex";
+import { BaseSeedSource } from "./BaseSeedSource";
 
 // TODO: https://knexjs.org/guide/#log
 export const config: Knex.Config<Knex.Sqlite3ConnectionConfig> = {
     client: "better-sqlite3",
     connection: {
         filename: "./bot_data.db",
     },
+    seeds: {
+        seedSource: new BaseSeedSource(),
+    },
     useNullAsDefault: true,
 };
 

apps/backend/src/db/knexfile.ts

@@ -1,5 +1,5 @@
+import { SeedSource as SSBUCharacterSeedSource } from "@db/BaseSeedSource";
 import { init_tables, init_views, run_seed, teardown } from "@db/init_tables";
-import { SeedSource as SSBUCharacterSeedSource } from "@db/SeedSource";
 import { serve } from "@hono/node-server";
 import { honoLogger } from "@logtape/hono";
 import { configure, getConsoleSink } from "@logtape/logtape";
@@ -34,6 +34,7 @@ app.get("/", (c) => {
 });
 
 app.route("/match", match_router);
+app.route("/user", user_router);
 
 app.get(
     "/openapi.json",

apps/backend/src/db/schemas.ts

@@ -1,4 +1,4 @@
-// General utilities for generating mock data
+// General utilities for generating test data
 
 import { ssbu_character_names } from "@db/seeds/SSBUCharacters";
 import { faker } from "@faker-js/faker";

apps/backend/src/db/test/unit.test.ts

@@ -1,10 +1,14 @@
+import { BaseSeedSource } from "@db/BaseSeedSource";
 import knex, { type Knex } from "knex";
 
 export const test_config: Knex.Config = {
     client: "better-sqlite3",
     connection: {
         filename: ":memory:",
     },
+    seeds: {
+        seedSource: new BaseSeedSource(),
+    },
     useNullAsDefault: true,
 };