[refactor] move Static methods of controllers to services

[optimize] clean Empty fields of Query filters

Author: TechQuery

package.json

@@ -10,8 +10,8 @@
         "node": ">=22"
     },
     "dependencies": {
-        "@aws-sdk/client-s3": "^3.943.0",
-        "@aws-sdk/s3-request-presigner": "^3.943.0",
+        "@aws-sdk/client-s3": "^3.946.0",
+        "@aws-sdk/s3-request-presigner": "^3.946.0",
         "@koa/cors": "^5.0.0",
         "@koa/multer": "^4.0.0",
         "@koa/router": "^15.0.0",

pnpm-lock.yaml

@@ -43,7 +43,10 @@ export class ActivityLogController {
         @Param('id') id: number,
         @QueryParams() { operation, pageSize, pageIndex }: ActivityLogFilter
     ) {
-        return this.queryList({ operation, createdBy: { id } }, { pageSize, pageIndex });
+        return this.queryList(
+            { ...(operation && { operation }), createdBy: { id } },
+            { pageSize, pageIndex }
+        );
     }
 
     @Get('/:table/:id')
@@ -53,7 +56,10 @@ export class ActivityLogController {
         @Param('id') recordId: number,
         @QueryParams() { operation, pageSize, pageIndex }: ActivityLogFilter
     ) {
-        return this.queryList({ operation, tableName, recordId }, { pageSize, pageIndex });
+        return this.queryList(
+            { ...(operation && { operation }), tableName, recordId },
+            { pageSize, pageIndex }
+        );
     }
 
     async queryList(where: FindOptionsWhere<ActivityLog>, { pageSize, pageIndex }: BaseFilter) {

source/controller/ActivityLog.ts

@@ -26,15 +26,13 @@ import {
     Hackathon,
     User
 } from '../model';
-import { UserServiceWithLog } from '../service';
-import { HackathonController } from './Hackathon';
+import { awardAssignmentService, awardService, hackathonService } from '../service';
 
 const hackathonStore = dataSource.getRepository(Hackathon);
-const awardAssignmentService = new UserServiceWithLog(AwardAssignment);
 
 @JsonController('/hackathon/:name/award')
 export class AwardController {
-    service = new UserServiceWithLog(Award, ['name', 'description']);
+    service = awardService;
 
     @Post()
     @Authorized()
@@ -49,7 +47,7 @@ export class AwardController {
 
         if (!hackathon) throw new NotFoundError(`Hackathon ${name} is not found`);
 
-        await HackathonController.ensureAdmin(createdBy.id, name);
+        await hackathonService.ensureAdmin(createdBy.id, name);
 
         return this.service.createOne({ ...award, hackathon }, createdBy);
     }
@@ -70,7 +68,7 @@ export class AwardController {
         @Param('id') id: number,
         @Body() updateData: Award
     ) {
-        await HackathonController.ensureAdmin(updatedBy.id, name);
+        await hackathonService.ensureAdmin(updatedBy.id, name);
 
         return this.service.editOne(id, updateData, updatedBy);
     }
@@ -83,22 +81,26 @@ export class AwardController {
         @Param('name') name: string,
         @Param('id') id: number
     ) {
-        await HackathonController.ensureAdmin(deletedBy.id, name);
+        await hackathonService.ensureAdmin(deletedBy.id, name);
 
         await this.service.deleteOne(id, deletedBy);
     }
 
     @Get()
     @ResponseSchema(AwardListChunk)
     getList(@Param('name') name: string, @QueryParams() { ...filter }: BaseFilter) {
-        return this.service.getList(filter, { hackathon: { name } }, { relations: ['createdBy', 'updatedBy'] });
+        return this.service.getList(
+            filter,
+            { hackathon: { name } },
+            { relations: ['createdBy', 'updatedBy'] }
+        );
     }
 }
 
 @JsonController('/hackathon/:name/award/:aid/assignment')
 export class AwardAssignmentController {
     service = awardAssignmentService;
-    awardService = new UserServiceWithLog(Award);
+    awardService = awardService;
 
     @Post()
     @Authorized()
@@ -113,9 +115,12 @@ export class AwardAssignmentController {
         const award = await this.awardService.getOne(aid, ['hackathon']);
         if (!award) throw new NotFoundError(`Award "${aid}" is not found`);
 
-        await HackathonController.ensureAdmin(currentUser.id, name);
+        await hackathonService.ensureAdmin(currentUser.id, name);
 
-        return this.service.createOne({ ...assignment, hackathon: award.hackathon, award }, currentUser);
+        return this.service.createOne(
+            { ...assignment, hackathon: award.hackathon, award },
+            currentUser
+        );
     }
 
     @Put('/:id')
@@ -127,23 +132,15 @@ export class AwardAssignmentController {
         @Param('id') id: number,
         @Body() newData: AwardAssignment
     ) {
-        await HackathonController.ensureAdmin(currentUser.id, name);
+        await hackathonService.ensureAdmin(currentUser.id, name);
 
         return this.service.editOne(id, newData, currentUser);
     }
 
-    static getList(dimension: keyof AwardAssignment, id: number, pageSize: number, pageIndex: number) {
-        return awardAssignmentService.getList(
-            { pageSize, pageIndex },
-            { [dimension]: { id } },
-            { relations: ['createdBy', 'updatedBy', 'award', 'user', 'team'] }
-        );
-    }
-
     @Get()
     @ResponseSchema(AwardAssignmentListChunk)
     getList(@Param('aid') aid: number, @QueryParams() { pageSize, pageIndex }: BaseFilter) {
-        return AwardAssignmentController.getList('award', aid, pageSize, pageIndex);
+        return awardAssignmentService.getListByDimension('award', aid, pageSize, pageIndex);
     }
 }
 
@@ -152,6 +149,6 @@ export class TeamAwardAssignmentController {
     @Get()
     @ResponseSchema(AwardAssignmentListChunk)
     getList(@Param('id') id: number, @QueryParams() { pageSize, pageIndex }: BaseFilter) {
-        return AwardAssignmentController.getList('team', id, pageSize, pageIndex);
+        return awardAssignmentService.getListByDimension('team', id, pageSize, pageIndex);
     }
 }

source/controller/Award.ts

@@ -23,20 +23,14 @@ import {
     Hackathon,
     User
 } from '../model';
-import { UserServiceWithLog } from '../service';
+import { enrollmentService, hackathonService } from '../service';
 import { searchConditionOf } from '../utility';
-import { HackathonController } from './Hackathon';
 
 const hackathonStore = dataSource.getRepository(Hackathon);
 
 @JsonController('/hackathon/:name/enrollment')
 export class EnrollmentController {
-    service = new UserServiceWithLog(Enrollment, ['form']);
-
-    static isEnrolled = (userId: number, hackathonName: string) =>
-        dataSource
-            .getRepository(Enrollment)
-            .existsBy({ hackathon: { name: hackathonName }, createdBy: { id: userId } });
+    service = enrollmentService;
 
     @Get('/session')
     @Authorized()
@@ -48,11 +42,15 @@ export class EnrollmentController {
     @Put('/:id')
     @Authorized()
     @ResponseSchema(Enrollment)
-    async updateOne(@CurrentUser() updatedBy: User, @Param('id') id: number, @Body() { status }: Enrollment) {
+    async updateOne(
+        @CurrentUser() updatedBy: User,
+        @Param('id') id: number,
+        @Body() { status }: Enrollment
+    ) {
         const old = await this.service.getOne(id, ['hackathon']);
         if (!old) throw new NotFoundError();
 
-        await HackathonController.ensureAdmin(updatedBy.id, old.hackathon.name);
+        await hackathonService.ensureAdmin(updatedBy.id, old.hackathon.name);
 
         return this.service.editOne(id, { status }, updatedBy);
     }
@@ -61,28 +59,39 @@ export class EnrollmentController {
     @Authorized()
     @HttpCode(201)
     @ResponseSchema(Enrollment)
-    async createOne(@CurrentUser() createdBy: User, @Param('name') name: string, @Body() { form }: Enrollment) {
+    async createOne(
+        @CurrentUser() createdBy: User,
+        @Param('name') name: string,
+        @Body() { form }: Enrollment
+    ) {
         const hackathon = await hackathonStore.findOneBy({ name }),
             now = Date.now();
 
         if (!hackathon) throw new NotFoundError();
 
-        if (now < +new Date(hackathon.enrollmentStartedAt) || now > +new Date(hackathon.enrollmentEndedAt))
+        if (
+            now < +new Date(hackathon.enrollmentStartedAt) ||
+            now > +new Date(hackathon.enrollmentEndedAt)
+        )
             throw new ForbiddenError('Not in enrollment period');
 
         return this.service.createOne(
             {
                 hackathon,
                 form,
-                status: hackathon.autoApprove ? EnrollmentStatus.Approved : EnrollmentStatus.PendingApproval
+                status: hackathon.autoApprove
+                    ? EnrollmentStatus.Approved
+                    : EnrollmentStatus.PendingApproval
             },
             createdBy
         );
     }
 
     @Get()
     @ResponseSchema(EnrollmentListChunk)
-    getList(@QueryParams() { keywords, status, createdBy, updatedBy, ...filter }: EnrollmentFilter) {
+    getList(
+        @QueryParams() { keywords, status, createdBy, updatedBy, ...filter }: EnrollmentFilter
+    ) {
         const where = searchConditionOf<Enrollment>(['form'], keywords, {
             ...(status && { status }),
             ...(createdBy && { createdBy: { id: createdBy } }),

source/controller/Enrollment.ts

@@ -22,40 +22,16 @@ import {
     GitTemplate,
     GitTemplateListChunk,
     Hackathon,
-    HackathonBase,
     User
 } from '../model';
-import { UserServiceWithLog } from '../service';
+import { gitTemplateService, hackathonService } from '../service';
 import { searchConditionOf } from '../utility';
-import { HackathonController } from './Hackathon';
 
 const hackathonStore = dataSource.getRepository(Hackathon);
-const repositoryStore = new RepositoryModel();
 
 @JsonController('/hackathon/:name/git-template')
 export class GitTemplateController {
-    service = new UserServiceWithLog(GitTemplate, [
-        'name',
-        'full_name',
-        'html_url',
-        'default_branch',
-        'languages',
-        'topics',
-        'description',
-        'homepage'
-    ]);
-
-    static async getRepository(URI: string): Promise<Omit<GitTemplate, keyof HackathonBase>> {
-        const path = URI.replace(new RegExp(String.raw`^https://github.com/`), 'repos');
-        const repository = await repositoryStore.getOne(path, ['languages']);
-
-        const { name, full_name, html_url, default_branch } = repository,
-            { languages, topics, description, homepage } = repository;
-        return {
-            ...{ name, full_name, html_url, default_branch },
-            ...{ languages, topics, description, homepage }
-        };
-    }
+    service = gitTemplateService;
 
     @Post()
     @Authorized()
@@ -70,9 +46,9 @@ export class GitTemplateController {
 
         if (!hackathon) throw new NotFoundError();
 
-        await HackathonController.ensureAdmin(createdBy.id, name);
+        await hackathonService.ensureAdmin(createdBy.id, name);
 
-        const repository = await GitTemplateController.getRepository(html_url);
+        const repository = await gitTemplateService.getRepository(html_url);
 
         return this.service.createOne({ ...repository, hackathon }, createdBy);
     }
@@ -85,7 +61,7 @@ export class GitTemplateController {
         @Param('name') name: string,
         @Param('id') id: number
     ) {
-        await HackathonController.ensureAdmin(deletedBy.id, name);
+        await hackathonService.ensureAdmin(deletedBy.id, name);
 
         await this.service.deleteOne(id, deletedBy);
     }