adds stats to the main page (#35)

adds stats to the main page

Author: VictoriqueMoe

src/DTO/PublicStatsDto.ts

@@ -0,0 +1,35 @@
+import { Name, Nullable, Property } from "@tsed/schema";
+
+class RecordFormat {
+    @Property()
+    @Name("Practised")
+    public practised: number;
+
+    @Property()
+    @Name("Blind")
+    public blind: number;
+}
+
+class BooleanResponse {
+    @Property()
+    @Name("No")
+    public no: number;
+
+    @Property()
+    @Name("Yes")
+    public yes: number;
+}
+
+export class PublicStatsDto {
+    @Property()
+    @Nullable(RecordFormat)
+    public recordFormat: RecordFormat | null = null;
+
+    @Property()
+    @Nullable(BooleanResponse)
+    public isAuthor: BooleanResponse | null = null;
+
+    @Property()
+    @Nullable(BooleanResponse)
+    public distributable: BooleanResponse | null = null;
+}

src/DTO/AdminDto.ts src/DTO/ejs/AdminDto.tssrc/DTO/AdminDto.ts renamed to src/DTO/ejs/AdminDto.ts

@@ -1,7 +1,7 @@
 import { IndexDto } from "./IndexDto.js";
-import { SubmissionRoundModel } from "../model/db/SubmissionRound.model";
-import { SubmissionModel } from "../model/db/Submission.model.js";
-import { WadValidationService } from "../services/WadValidationService.js";
+import { SubmissionRoundModel } from "../../model/db/SubmissionRound.model.js";
+import { SubmissionModel } from "../../model/db/Submission.model.js";
+import { WadValidationService } from "../../services/WadValidationService.js";
 
 export class AdminDto extends IndexDto {
     public constructor(
@@ -30,6 +30,6 @@ export class AdminDto extends IndexDto {
         if (!this.currentActiveRound) {
             return [];
         }
-        return this.currentActiveRound.submissions.filter(submission => submission.isSubmissionValidAndVerified());
+        return this.currentActiveRound.validAndVerifiedSubmissions;
     }
 }

src/DTO/IndexDto.ts src/DTO/ejs/IndexDto.tssrc/DTO/IndexDto.ts renamed to src/DTO/ejs/IndexDto.ts

@@ -1,8 +1,8 @@
-import { SubmissionRoundModel } from "../model/db/SubmissionRound.model.js";
-import DOOM_ENGINE from "../model/constants/DoomEngine.js";
-import GZDOOM_ACTIONS from "../model/constants/GZDoomActions.js";
-import { ObjectUtils } from "../utils/Utils.js";
-import { WadValidationService } from "../services/WadValidationService.js";
+import { SubmissionRoundModel } from "../../model/db/SubmissionRound.model.js";
+import DOOM_ENGINE from "../../model/constants/DoomEngine.js";
+import GZDOOM_ACTIONS from "../../model/constants/GZDoomActions.js";
+import { ObjectUtils } from "../../utils/Utils.js";
+import { WadValidationService } from "../../services/WadValidationService.js";
 
 export class IndexDto {
     private readonly months = [

src/DTO/ejs/StatsDto.ts

@@ -0,0 +1,52 @@
+import { SubmissionRoundModel } from "../../model/db/SubmissionRound.model.js";
+import { AutoInjectable, Inject } from "@tsed/di";
+import { SubmissionRoundService } from "../../services/SubmissionRoundService.js";
+
+@AutoInjectable()
+export class StatsDto {
+    public readonly mostSubmittedWad: string;
+    public readonly mostSubmittedWadPercentage: number;
+
+    public constructor(
+        private activeRound: SubmissionRoundModel | null = null,
+        private previousRounds: SubmissionRoundModel[],
+        @Inject() private submissionRoundService?: SubmissionRoundService,
+    ) {}
+
+    private async getMostSubmittedWadPercentageRounded(): Promise<number | null> {
+        if (!this.activeRound) {
+            return null;
+        }
+        const validSubmissions = this.activeRound.validAndVerifiedSubmissions;
+        const totalSubmissions = validSubmissions.length;
+        const mostSubmittedWad = await this.getMostSubmittedWad();
+
+        if (totalSubmissions > 0 && mostSubmittedWad) {
+            const mostSubmittedWadCount = validSubmissions.filter(
+                submission => submission.wadName === mostSubmittedWad,
+            ).length;
+            return Math.round((mostSubmittedWadCount / totalSubmissions) * 100 * 100) / 100;
+        }
+        return 0;
+    }
+
+    private getMostSubmittedWad(): Promise<string | null> {
+        return this.submissionRoundService!.getMostSubmittedWadName();
+    }
+
+    private get hasActiveRound(): boolean {
+        return this.activeRound !== null;
+    }
+
+    public async merge(obj: Record<string, unknown>): Promise<void> {
+        if (this.hasActiveRound) {
+            const mostSubmittedWad = (await this.getMostSubmittedWad())!;
+            const mostSubmittedWadPercentage = (await this.getMostSubmittedWadPercentageRounded())!;
+
+            obj["stats"] = {
+                mostSubmittedWad,
+                mostSubmittedWadPercentage,
+            };
+        }
+    }
+}

src/controllers/rest/impl/StatsController.ts

@@ -0,0 +1,22 @@
+import { Controller, Inject } from "@tsed/di";
+import { BaseRestController } from "../BaseRestController.js";
+import { StatsService } from "../../../services/StatsService.js";
+import { Get, Returns } from "@tsed/schema";
+import { StatusCodes } from "http-status-codes";
+import { BadRequest } from "@tsed/exceptions";
+import { PathParams } from "@tsed/platform-params";
+import { PublicStatsDto } from "../../../DTO/PublicStatsDto.js";
+
+@Controller("/stats")
+export class StatsController extends BaseRestController {
+    public constructor(@Inject() private readonly statsService: StatsService) {
+        super();
+    }
+
+    @Get("/:roundId")
+    @Returns(StatusCodes.OK, PublicStatsDto)
+    @Returns(StatusCodes.BAD_REQUEST, BadRequest)
+    public getStats(@PathParams("roundId") roundId: number): Promise<PublicStatsDto> {
+        return this.statsService.getStats(roundId);
+    }
+}

src/controllers/rest/impl/SubmissionController.ts

@@ -143,14 +143,6 @@ export class SubmissionController extends BaseRestController {
         return wad.content;
     }
 
-    @Get("/:roundId/validAndVerifiedSubmissions")
-    @Authorize("login")
-    @(Returns(StatusCodes.OK, Array).Of(SubmissionModel))
-    @Returns(StatusCodes.BAD_REQUEST, BadRequest)
-    public getValidAndVerifiedSubmissions(@PathParams("roundId") roundId: number): Promise<SubmissionModel[]> {
-        return this.submissionService.getAllEntries(roundId, true);
-    }
-
     private async getWad(
         roundId: number,
         entryId: number,

src/controllers/rest/index.ts

@@ -3,6 +3,7 @@
  */
 export * from "./BaseRestController.js";
 export * from "./impl/security/PassportCtrl.js";
+export * from "./impl/StatsController.js";
 export * from "./impl/SubmissionController.js";
 export * from "./impl/SubmissionRoundController.js";
 export * from "./impl/SubmissionRoundResultController.js";

src/controllers/secureViews/AdminHome.ts

@@ -5,8 +5,9 @@ import { SubmissionRoundResultService } from "../../services/SubmissionRoundResu
 import { Authorize } from "@tsed/passport";
 import { Req } from "@tsed/common";
 import { CustomUserInfoModel } from "../../model/auth/CustomUserInfoModel.js";
-import { AdminDto } from "../../DTO/AdminDto.js";
+import { AdminDto } from "../../DTO/ejs/AdminDto.js";
 import { WadValidationService } from "../../services/WadValidationService.js";
+import { StatsDto } from "../../DTO/ejs/StatsDto.js";
 
 @Controller("/")
 export class AdminHome {
@@ -27,11 +28,14 @@ export class AdminHome {
         const currentActiveRound = await this.submissionRoundService.getCurrentActiveSubmissionRound(false);
         const previousRounds = await this.submissionRoundResultService.getAllSubmissionRoundResults();
         const user = req.user as CustomUserInfoModel;
-        const mostSubmittedWad = await this.submissionRoundService.getMostSubmittedWadName();
-        return {
+        const stats = new StatsDto(currentActiveRound, previousRounds);
+        const resp: Record<string, unknown> = {
             indexModel: new AdminDto(currentActiveRound, previousRounds, this.wadValidationService),
             user,
-            mostSubmittedWad,
         };
+
+        await stats.merge(resp);
+
+        return resp;
     }
 }

src/controllers/views/HomeView.ts

@@ -5,7 +5,7 @@ import { SubmissionConfirmationService } from "../../services/SubmissionConfirma
 import { QueryParams, Req, Res } from "@tsed/common";
 import { NotFound } from "@tsed/exceptions";
 import { SubmissionRoundResultService } from "../../services/SubmissionRoundResultService.js";
-import { IndexDto } from "../../DTO/IndexDto.js";
+import { IndexDto } from "../../DTO/ejs/IndexDto.js";
 import type { UUID } from "crypto";
 import { WadValidationService } from "../../services/WadValidationService.js";
 import { CaptchaManager } from "../../manager/CaptchaManager.js";

src/model/db/SubmissionRound.model.ts

@@ -50,4 +50,8 @@ export class SubmissionRoundModel extends AbstractModel {
     private sanitiseString(): void {
         this.name = xss(this.name);
     }
+
+    public get validAndVerifiedSubmissions(): SubmissionModel[] {
+        return this.submissions.filter(submission => submission.isSubmissionValidAndVerified());
+    }
 }