refactor: move to solvro config

Author: Rei-x

.commitlintrc.js

@@ -0,0 +1,3 @@
+export default {
+  extends: ["@solvro/config/commitlint"],
+};

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directories:
+      - "/"
+      - "/frontend"
+      - "/backend"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-name: "@solvro/config"

.github/workflows/ci_backend.yaml .github/workflows/backend_ci.yaml.github/workflows/ci_backend.yaml renamed to .github/workflows/backend_ci.yaml

@@ -1,4 +1,4 @@
-name: CI Backend
+name: Backend - CI
 
 on:
   push:
@@ -18,39 +18,34 @@ jobs:
         working-directory: backend
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: npm
 
       - name: Install deps
         run: npm ci
 
+      - name: Set up AdonisJS environment
+        run: |
+          cp .env.development .env
+          node ace generate:key
+
       - name: Lint
         run: npm run lint
         if: always()
 
+      - name: Format
+        run: npm run format:check
+        if: always()
+
       - name: Type check
         run: npm run typecheck
         if: always()
 
       - name: Run Test Build
         run: npm run build
-        env:
-          NODE_ENV: production
-          PORT: 3333
-          HOST: 0.0.0.0
-          LOG_LEVEL: debug
-          APP_KEY: really-hard-secret-key-to-guess
-          SESSION_DRIVER: cookie
-          DB_HOST: localhost
-          DB_PORT: 5432
-          DB_USER: postgres
-          DB_DATABASE: postgres
-          DB_PASSWORD: postgres
-          USOS_CONSUMER_KEY: test
-          USOS_CONSUMER_SECRET: test
         if: always()

.github/workflows/ci.yaml .github/workflows/frontend_ci.yaml.github/workflows/ci.yaml renamed to .github/workflows/frontend_ci.yaml

@@ -1,4 +1,4 @@
-name: CI
+name: Frontend - CI
 
 on:
   push:
@@ -18,10 +18,10 @@ jobs:
         working-directory: frontend
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: npm

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit "$1"

.lintstagedrc.json

@@ -15,13 +15,12 @@
 | and then imports the "bin/console.ts" file.
 |
 */
-
 /**
  * Register hook to process TypeScript files using ts-node
  */
-import 'ts-node-maintained/register/esm'
+import "ts-node-maintained/register/esm";
 
 /**
  * Import ace console entrypoint
  */
-await import('./bin/console.js')
+await import("./bin/console.js");

backend/ace.js

@@ -1,4 +1,4 @@
-import { defineConfig } from '@adonisjs/core/app'
+import { defineConfig } from "@adonisjs/core/app";
 
 export default defineConfig({
   /*
@@ -11,9 +11,9 @@ export default defineConfig({
   |
   */
   commands: [
-    () => import('@adonisjs/core/commands'),
-    () => import('@adonisjs/lucid/commands'),
-    () => import('adonisjs-scheduler/commands'),
+    () => import("@adonisjs/core/commands"),
+    () => import("@adonisjs/lucid/commands"),
+    () => import("adonisjs-scheduler/commands"),
   ],
 
   /*
@@ -26,20 +26,20 @@ export default defineConfig({
   |
   */
   providers: [
-    () => import('@adonisjs/core/providers/app_provider'),
-    () => import('@adonisjs/core/providers/hash_provider'),
+    () => import("@adonisjs/core/providers/app_provider"),
+    () => import("@adonisjs/core/providers/hash_provider"),
     {
-      file: () => import('@adonisjs/core/providers/repl_provider'),
-      environment: ['repl', 'test'],
+      file: () => import("@adonisjs/core/providers/repl_provider"),
+      environment: ["repl", "test"],
     },
-    () => import('@adonisjs/core/providers/vinejs_provider'),
-    () => import('@adonisjs/cors/cors_provider'),
-    () => import('@adonisjs/lucid/database_provider'),
-    () => import('@adonisjs/session/session_provider'),
-    () => import('@adonisjs/auth/auth_provider'),
+    () => import("@adonisjs/core/providers/vinejs_provider"),
+    () => import("@adonisjs/cors/cors_provider"),
+    () => import("@adonisjs/lucid/database_provider"),
+    () => import("@adonisjs/session/session_provider"),
+    () => import("@adonisjs/auth/auth_provider"),
     {
-      file: () => import('adonisjs-scheduler/scheduler_provider'),
-      environment: ['console'],
+      file: () => import("adonisjs-scheduler/scheduler_provider"),
+      environment: ["console"],
     },
   ],
 
@@ -51,7 +51,7 @@ export default defineConfig({
   | List of modules to import before starting the application.
   |
   */
-  preloads: [() => import('#start/routes'), () => import('#start/kernel')],
+  preloads: [() => import("#start/routes"), () => import("#start/kernel")],
 
   /*
   |--------------------------------------------------------------------------
@@ -65,16 +65,16 @@ export default defineConfig({
   tests: {
     suites: [
       {
-        files: ['tests/unit/**/*.spec(.ts|.js)'],
-        name: 'unit',
+        files: ["tests/unit/**/*.spec(.ts|.js)"],
+        name: "unit",
         timeout: 2000,
       },
       {
-        files: ['tests/functional/**/*.spec(.ts|.js)'],
-        name: 'functional',
+        files: ["tests/functional/**/*.spec(.ts|.js)"],
+        name: "functional",
         timeout: 30000,
       },
     ],
     forceExit: false,
   },
-})
+});

backend/adonisrc.ts

@@ -1,45 +1,65 @@
-import { HttpContext } from '@adonisjs/core/http'
-import { createClient } from '../usos/usos_client.js'
-import User from '#models/user'
+import assert from "node:assert";
+
+import { HttpContext } from "@adonisjs/core/http";
+
+import User from "#models/user";
+
+import { createClient } from "../usos/usos_client.js";
 
 export default class AuthController {
   async store({ request, response, auth }: HttpContext) {
     /**
      * Step 1: Get credentials from the request body
      */
-    const { accessToken, accessSecret } = request.only(['accessToken', 'accessSecret'])
+    const { accessToken, accessSecret } = request.only([
+      "accessToken",
+      "accessSecret",
+    ]) as { accessToken: string; accessSecret: string };
     try {
       const usosClient = createClient({
         token: accessToken,
         secret: accessSecret,
-      })
-      const profile: any = await usosClient.get(
-        'users/user?fields=id|student_number|first_name|last_name'
-      )
-      let user = await User.findBy('usos_id', profile.id)
-      if (!user) {
+      });
+      const profile = await usosClient.get<{
+        id: string;
+        student_number: string;
+        first_name: string;
+        last_name: string;
+      }>("users/user?fields=id|student_number|first_name|last_name");
+      let user = await User.findBy("usos_id", profile.id);
+      if (user === null) {
         user = await User.create({
           usos_id: profile.id,
           studentNumber: profile.student_number,
           firstName: profile.first_name,
           lastName: profile.last_name,
-        })
+        });
       }
-      await auth.use('jwt').generate(user)
+
+      await auth.use("jwt").generate(user);
+
       return response.ok({
         ...user.serialize(),
-      })
+      });
     } catch (error) {
-      return response.unauthorized({ message: 'Login failed.', error: error.message })
+      assert(error instanceof Error);
+      return response.unauthorized({
+        message: "Login failed.",
+        error: error.message,
+      });
     }
   }
   async destroy({ response }: HttpContext) {
     try {
-      response.clearCookie('token')
+      response.clearCookie("token");
 
-      return response.ok({ message: 'Successfully logged out' })
+      return response.ok({ message: "Successfully logged out" });
     } catch (error) {
-      return response.internalServerError({ message: 'Logout failed', error: error.message })
+      assert(error instanceof Error);
+      return response.internalServerError({
+        message: "Logout failed",
+        error: error.message,
+      });
     }
   }
 }

backend/app/controllers/auth_controller.ts

@@ -1,68 +1,83 @@
-import Course from '#models/course'
-import { createCourseValidator } from '#validators/course'
-import type { HttpContext } from '@adonisjs/core/http'
+import assert from "node:assert";
+
+import type { HttpContext } from "@adonisjs/core/http";
+
+import Course from "#models/course";
+import { createCourseValidator } from "#validators/course";
 
 export default class CoursesController {
   /**
    * Display a list of courses in matching registration
    */
   async index({ params }: HttpContext) {
-    const registrationId = decodeURIComponent(params.registration_id)
+    assert(typeof params.registration_id === "string");
+
+    const registrationId = decodeURIComponent(params.registration_id);
     if (registrationId) {
-      return await Course.query().where('registrationId', registrationId).preload('groups')
+      return await Course.query()
+        .where("registrationId", registrationId)
+        .preload("groups");
     }
-    return []
+    return [];
   }
 
   /**
    * Handle form submission for the create action
    */
   async store({ request, params }: HttpContext) {
-    const registrationId = decodeURIComponent(params.registration_id)
-    const payload = await request.validateUsing(createCourseValidator)
-    const course = await Course.create({ ...payload, registrationId })
-    return { message: 'Course created.', course }
+    assert(typeof params.registration_id === "string");
+
+    const registrationId = decodeURIComponent(params.registration_id);
+    const payload = await request.validateUsing(createCourseValidator);
+    const course = await Course.create({ ...payload, registrationId });
+    return { message: "Course created.", course };
   }
 
   /**
    * Show individual record of course in matching registration
    */
   async show({ params }: HttpContext) {
-    const registrationId = decodeURIComponent(params.registration_id)
+    assert(typeof params.registration_id === "string");
+    const registrationId = decodeURIComponent(params.registration_id);
     if (registrationId) {
+      assert(typeof params.id === "string");
+
       return await Course.query()
-        .where('registrationId', registrationId)
-        .andWhere('id', params.id)
-        .preload('groups')
-        .firstOrFail()
+        .where("registrationId", registrationId)
+        .andWhere("id", params.id)
+        .preload("groups")
+        .firstOrFail();
     }
-    return {}
+    return {};
   }
 
   /**
    * Handle form submission for the edit action
    */
   async update({ params, request }: HttpContext) {
-    const registrationId = decodeURIComponent(params.registration_id)
-    const payload = await request.validateUsing(createCourseValidator)
+    assert(typeof params.registration_id === "string");
+    assert(typeof params.id === "string");
+
+    const registrationId = decodeURIComponent(params.registration_id);
+    const payload = await request.validateUsing(createCourseValidator);
 
     const course = await Course.query()
-      .where('registrationId', registrationId)
-      .andWhere('id', params.id)
-      .firstOrFail()
+      .where("registrationId", registrationId)
+      .andWhere("id", params.id)
+      .firstOrFail();
 
-    course.merge(payload)
-    await course.save()
+    course.merge(payload);
+    await course.save();
 
-    return { message: 'Course updated successfully.', course }
+    return { message: "Course updated successfully.", course };
   }
 
   /**
    * Delete record
    */
   async destroy({ params }: HttpContext) {
-    const course = await Course.findOrFail(params.id)
-    await course.delete()
-    return { message: 'Course successfully deleted.' }
+    const course = await Course.findOrFail(params.id);
+    await course.delete();
+    return { message: "Course successfully deleted." };
   }
 }