fix: potentially more fixes! (#52)

* fix: incorrect coersion for query fields

* chore: remove useless console log in test

* feat: gracefully clean up sigint

* feat: update lockfiles

* fix: block until minio is recreated

* fix: remove properties out of expected tests

* refactor: types in constants and comment some code

* chore: rename e2e tests to api

* feat: set up eslint

* fix: remove lint from ci

* fix: all eslint errors

* fix: combine tests, add warning lint

* chore: prettier

* feat: add autofix ci

* [autofix.ci] apply automated fixes

* chore: bump checkout version

* fix: attempt fix of eslint ci?

* fix: again?

* fix: again again?

* fix: final fix?

* feat: add servicehoursexportmodel

* [autofix.ci] apply automated fixes

* fix: revert replaced error message

* refactor: validation of middleware function name in API routes

* [autofix.ci] apply automated fixes

* feat: improve verify attendance

* [autofix.ci] apply automated fixes

* chore: remove legacy userwithprofilepicture

* fix: mapping for update profile picture

* [autofix.ci] apply automated fixes

* fix: delete profile picture from localstorage only on successful api call

* [autofix.ci] apply automated fixes

* fix: timeout during postgres client install

* feat: add interface for all exports models to follow

* [autofix.ci] apply automated fixes

* fix: remove console log

* feat: update tests

* [autofix.ci] apply automated fixes

* fix: attempt to get sonar to ignore error

* refactor: parseErrorMessage -> parseServerError

* fix: rename file

* feat: add docs to remap asset url

* feat: more descriptive client errors

* [autofix.ci] apply automated fixes

* fix: reformat err handling

* fix: remove console log

* [autofix.ci] apply automated fixes

* fix: fail silently without causing crash on app update

* fix: weird failed condition for profile page

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: SebassNoob

.github/workflows/autofix.yml

@@ -0,0 +1,34 @@
+name: autofix.ci  # needed to securely identify the workflow
+
+on:
+  pull_request:
+  push:
+    branches: 
+      - '**'
+permissions:
+  contents: read
+
+jobs:
+  autofix:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: 1.1.3
+
+      - name: Install dependencies (backend)
+        run: cd interapp-backend && bun install
+
+      - name: Format code (backend)
+        run: cd interapp-backend && bun run prettier
+
+      - name: Install dependencies (frontend)
+        run: cd interapp-frontend && bun install
+
+      - name: Format code (frontend)
+        run: cd interapp-frontend && bun run prettier
+
+      - uses: autofix-ci/action@d3e591514b99d0fca6779455ff8338516663f7cc

.github/workflows/pipeline.yml

@@ -8,11 +8,12 @@ on:
 
 jobs:
   test-backend:
+    name: Test backend
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Build test environment
         run: docker compose -f docker-compose.test.yml build --no-cache
@@ -27,18 +28,23 @@ jobs:
 
       - name: Install dependencies
         run: cd interapp-backend && bun install
-      - name: Test with bun
+
+      - name: Lint code
+        run: cd interapp-backend && bun run lint
+      
+      - name: Run unit and api tests
         run: cd interapp-backend && bun run test
 
       - name: Tear down test environment
         run: docker compose -f docker-compose.test.yml down
 
   build-application:
+    name: Build application
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup prod environment
         run: docker compose -f docker-compose.prod.yml up -d --build

interapp-backend/api/models/auth.ts

@@ -4,6 +4,7 @@ import { HTTPErrors } from '@utils/errors';
 import { SignJWT, jwtVerify, JWTPayload, JWTVerifyResult } from 'jose';
 
 import redisClient from '@utils/init_redis';
+import minioClient from '@utils/init_minio';
 
 export interface UserJWT {
   user_id: number;
@@ -12,6 +13,8 @@ export interface UserJWT {
 
 type JWTtype = 'access' | 'refresh';
 
+const MINIO_BUCKETNAME = process.env.MINIO_BUCKETNAME as string;
+
 export class AuthModel {
   private static readonly accessSecret = new TextEncoder().encode(
     process.env.JWT_ACCESS_SECRET as string,
@@ -79,6 +82,7 @@ export class AuthModel {
         'user.email',
         'user.verified',
         'user.service_hours',
+        'user.profile_picture',
       ])
       .from(User, 'user')
       .leftJoinAndSelect('user.user_permissions', 'user_permissions')
@@ -109,6 +113,9 @@ export class AuthModel {
       email: user.email,
       verified: user.verified,
       service_hours: user.service_hours,
+      profile_picture: user.profile_picture
+        ? await minioClient.presignedGetObject(MINIO_BUCKETNAME, user.profile_picture)
+        : null,
       permissions: user.user_permissions.map((perm) => perm.permission_id),
     };
 

interapp-backend/api/models/exports.ts …api/models/exports/exports_attendance.tsinterapp-backend/api/models/exports.ts renamed to interapp-backend/api/models/exports/exports_attendance.ts interapp-backend/api/models/exports.ts renamed to interapp-backend/api/models/exports/exports_attendance.ts

@@ -1,48 +1,20 @@
-import appDataSource from '@utils/init_datasource';
-import { ServiceSession, AttendanceStatus } from '@db/entities';
-import xlsx, { WorkSheet } from 'node-xlsx';
+import {
+  AttendanceExportsResult,
+  AttendanceExportsXLSX,
+  AttendanceQueryExportsConditions,
+  ExportsModelImpl,
+  staticImplements,
+} from './types';
+import { BaseExportsModel } from './exports_base';
+import { ServiceSession, type AttendanceStatus } from '@db/entities';
 import { HTTPErrors } from '@utils/errors';
+import { WorkSheet } from 'node-xlsx';
+import appDataSource from '@utils/init_datasource';
 
-type ExportsResult = {
-  service_session_id: number;
-  start_time: string;
-  end_time: string;
-  service: {
-    name: string;
-    service_id: number;
-  };
-  service_session_users: {
-    service_session_id: number;
-    username: string;
-    ad_hoc: boolean;
-    attended: AttendanceStatus;
-    is_ic: boolean;
-  }[];
-};
-
-type ExportsXLSX = [['username', ...string[]], ...[string, ...(AttendanceStatus | null)[]][]];
-
-type QueryExportsConditions = {
-  id: number;
-} & (
-  | {
-      start_date: string; // ISO strings, we have already validated this
-      end_date: string;
-    }
-  | {
-      start_date?: never;
-      end_date?: never;
-    }
-);
-
-export class ExportsModel {
-  private static getSheetOptions = (ret: ExportsXLSX) => ({
-    '!cols': [{ wch: 24 }, ...Array(ret.length).fill({ wch: 16 })],
-  });
-  private static constructXLSX = (...data: Parameters<typeof xlsx.build>[0]) => xlsx.build(data);
-
-  public static async queryExports({ id, start_date, end_date }: QueryExportsConditions) {
-    let res: ExportsResult[];
+@staticImplements<ExportsModelImpl>()
+export class AttendanceExportsModel extends BaseExportsModel {
+  public static async queryExports({ id, start_date, end_date }: AttendanceQueryExportsConditions) {
+    let res: AttendanceExportsResult[];
     if (start_date === undefined || end_date === undefined) {
       res = await appDataSource.manager
         .createQueryBuilder()
@@ -82,16 +54,16 @@ export class ExportsModel {
     return res;
   }
 
-  public static async formatXLSX(conds: QueryExportsConditions) {
+  public static async formatXLSX(conds: AttendanceQueryExportsConditions) {
     const ret = await this.queryExports(conds);
 
     if (ret.length === 0) throw HTTPErrors.RESOURCE_NOT_FOUND;
 
     // create headers
     // start_time is in ascending order
-    const headers: ExportsXLSX[0] = (['username'] as ExportsXLSX[0]).concat(
+    const headers = (['username'] as AttendanceExportsXLSX[0]).concat(
       ret.map(({ start_time }) => start_time),
-    ) as ExportsXLSX[0];
+    ) as AttendanceExportsXLSX[0];
 
     // output needs to be in the form:
     // [username, [attendance status]]
@@ -118,15 +90,13 @@ export class ExportsModel {
       });
     });
 
-    const body: ExportsXLSX[1][] = Object.entries(usernameMap).map(([username, attendance]) => [
-      username,
-      ...attendance,
-    ]);
+    const body: AttendanceExportsXLSX[1][] = Object.entries(usernameMap).map(
+      ([username, attendance]) => [username, ...attendance],
+    );
 
-    const out: ExportsXLSX = [headers, ...body];
+    const out: AttendanceExportsXLSX = [headers, ...body];
 
     const sheetOptions = this.getSheetOptions(out);
-    console.log(sheetOptions);
 
     return { name: ret[0].service.name, data: out, options: sheetOptions };
   }

interapp-backend/api/models/exports/exports_base.ts

@@ -0,0 +1,8 @@
+import xlsx from 'node-xlsx';
+
+export class BaseExportsModel {
+  protected static getSheetOptions = <T extends unknown[]>(ret: T) => ({
+    '!cols': [{ wch: 24 }, ...Array(ret.length).fill({ wch: 16 })],
+  });
+  protected static constructXLSX = (...data: Parameters<typeof xlsx.build>[0]) => xlsx.build(data);
+}

interapp-backend/api/models/exports/exports_service_hours.ts

@@ -0,0 +1,15 @@
+import {
+  AttendanceExportsResult,
+  AttendanceExportsXLSX,
+  AttendanceQueryExportsConditions,
+  ExportsModelImpl,
+  staticImplements,
+} from './types';
+import { BaseExportsModel } from './exports_base';
+import { ServiceSession, type AttendanceStatus } from '@db/entities';
+import { HTTPErrors } from '@utils/errors';
+import { WorkSheet } from 'node-xlsx';
+import appDataSource from '@utils/init_datasource';
+
+// @staticImplements<ExportsModelImpl>()
+export class ServiceHoursExportsModel extends BaseExportsModel {}

interapp-backend/api/models/exports/index.ts

@@ -0,0 +1,2 @@
+export { AttendanceExportsModel } from './exports_attendance';
+export { ServiceHoursExportsModel } from './exports_service_hours';

interapp-backend/api/models/exports/types.ts

@@ -0,0 +1,50 @@
+import { AttendanceStatus } from '@db/entities';
+
+export interface ExportsModelImpl {
+  queryExports(conds: unknown): Promise<unknown[]>;
+  formatXLSX(conds: unknown): Promise<unknown>;
+  packXLSX(ids: number[], start_date?: string, end_date?: string): Promise<Buffer>;
+}
+
+// class decorator that asserts that a class implements an interface statically
+// https://stackoverflow.com/a/43674389
+export function staticImplements<T>() {
+  return <U extends T>(constructor: U) => {
+    constructor; // NOSONAR
+  };
+}
+
+export type AttendanceExportsResult = {
+  service_session_id: number;
+  start_time: string;
+  end_time: string;
+  service: {
+    name: string;
+    service_id: number;
+  };
+  service_session_users: {
+    service_session_id: number;
+    username: string;
+    ad_hoc: boolean;
+    attended: AttendanceStatus;
+    is_ic: boolean;
+  }[];
+};
+
+export type AttendanceExportsXLSX = [
+  ['username', ...string[]],
+  ...[string, ...(AttendanceStatus | null)[]][],
+];
+
+export type AttendanceQueryExportsConditions = {
+  id: number;
+} & (
+  | {
+      start_date: string; // ISO strings, we have already validated this
+      end_date: string;
+    }
+  | {
+      start_date?: never;
+      end_date?: never;
+    }
+);

interapp-backend/api/models/service.ts

@@ -347,21 +347,54 @@ export class ServiceModel {
     }));
   }
   public static async verifyAttendance(hash: string, username: string) {
-    const service_session_id = await redisClient.hGet('service_session', hash);
-    if (!service_session_id) {
+    const id = await redisClient.hGet('service_session', hash);
+    if (!id) {
       throw HTTPErrors.INVALID_HASH;
     }
-    const service_session_user = await this.getServiceSessionUser(
-      parseInt(service_session_id),
-      username,
-    );
+    const service_session_id = parseInt(id);
+
+    const service_session_user = await this.getServiceSessionUser(service_session_id, username);
 
     if (service_session_user.attended === AttendanceStatus.Attended) {
       throw HTTPErrors.ALREADY_ATTENDED;
     }
     service_session_user.attended = AttendanceStatus.Attended;
     await this.updateServiceSessionUser(service_session_user);
-    return service_session_user;
+
+    // get some metadata and return it to the user
+
+    type _Return = {
+      start_time: string;
+      end_time: string;
+      service_hours: number;
+      name: string;
+      ad_hoc: boolean;
+    };
+    const res = await appDataSource.manager
+      .createQueryBuilder()
+      .select([
+        'service_session.start_time',
+        'service_session.end_time',
+        'service_session.service_hours',
+        'service.name',
+      ])
+      .from(ServiceSession, 'service_session')
+      .leftJoin('service_session.service', 'service')
+      .where('service_session_id = :id', { id: service_session_id })
+      .getOne();
+
+    // literally impossible for this to be null
+    if (!res) {
+      throw HTTPErrors.RESOURCE_NOT_FOUND;
+    }
+
+    return {
+      start_time: res.start_time,
+      end_time: res.end_time,
+      service_hours: res.service_hours,
+      name: res.service.name,
+      ad_hoc: service_session_user.ad_hoc,
+    } as _Return;
   }
   public static async getAdHocServiceSessions() {
     const res = await appDataSource.manager