Merge pull request #20 from topcoder-platform/topcoder-reports

Registrant country report for a challenge, to help with challenges that only allow submissions from a subset of countries

Author: jmgasper

sql/reports/topcoder/registrant-countries.sql

@@ -0,0 +1,21 @@
+SELECT DISTINCT
+  res."memberHandle" AS handle,
+  mem.email AS email,
+  COALESCE(home_code.name, home_id.name, mem."homeCountryCode") AS home_country,
+  COALESCE(comp_code.name, comp_id.name, mem."competitionCountryCode") AS competition_country
+FROM resources."Resource" AS res
+JOIN resources."ResourceRole" AS rr
+  ON rr.id = res."roleId"
+LEFT JOIN members."member" AS mem
+  ON mem."userId"::text = res."memberId"
+LEFT JOIN lookups."Country" AS home_code
+  ON UPPER(home_code."countryCode") = UPPER(mem."homeCountryCode")
+LEFT JOIN lookups."Country" AS home_id
+  ON UPPER(home_id.id) = UPPER(mem."homeCountryCode")
+LEFT JOIN lookups."Country" AS comp_code
+  ON UPPER(comp_code."countryCode") = UPPER(mem."competitionCountryCode")
+LEFT JOIN lookups."Country" AS comp_id
+  ON UPPER(comp_id.id) = UPPER(mem."competitionCountryCode")
+WHERE rr.name = 'Submitter'
+  AND res."challengeId" = $1::text
+ORDER BY res."memberHandle";

src/app-constants.ts

@@ -4,6 +4,7 @@ export const Scopes = {
   TopgearChallenge: "reports:topgear-challenge",
   TopgearCancelledChallenge: "reports:topgear-cancelled-challenge",
   AllReports: "reports:all",
+  TopcoderReports: "reports:topcoder",
   TopgearChallengeTechnology: "reports:topgear-challenge-technology",
   TopgearChallengeStatsByUser: "reports:topgear-challenge-stats-by-user",
   TopgearChallengeRegistrantDetails:
@@ -18,3 +19,7 @@ export const Scopes = {
     SubmissionLinks: "reports:challenge-submission-links",
   },
 };
+
+export const UserRoles = {
+  Admin: "Administrator",
+};

src/auth/guards/topcoder-reports.guard.ts

@@ -0,0 +1,59 @@
+import {
+  CanActivate,
+  ExecutionContext,
+  ForbiddenException,
+  Injectable,
+  UnauthorizedException,
+} from "@nestjs/common";
+
+import { Scopes, UserRoles } from "../../app-constants";
+
+@Injectable()
+export class TopcoderReportsGuard implements CanActivate {
+  private static readonly adminRoles = new Set(
+    Object.values(UserRoles).map((role) => role.toLowerCase()),
+  );
+
+  canActivate(context: ExecutionContext): boolean {
+    const request = context.switchToHttp().getRequest();
+    const authUser = request.authUser;
+
+    if (!authUser) {
+      throw new UnauthorizedException("You are not authenticated.");
+    }
+
+    if (authUser.isMachine) {
+      const scopes: string[] = authUser.scopes ?? [];
+      if (this.hasRequiredScope(scopes)) {
+        return true;
+      }
+
+      throw new ForbiddenException(
+        "You do not have the required permissions to access this resource.",
+      );
+    }
+
+    const roles: string[] = authUser.roles ?? [];
+    if (this.isAdmin(roles)) {
+      return true;
+    }
+
+    throw new ForbiddenException(
+      "You do not have the required permissions to access this resource.",
+    );
+  }
+
+  private hasRequiredScope(scopes: string[]): boolean {
+    const normalizedScopes = scopes.map((scope) => scope?.toLowerCase());
+    return (
+      normalizedScopes.includes(Scopes.TopcoderReports.toLowerCase()) ||
+      normalizedScopes.includes(Scopes.AllReports.toLowerCase())
+    );
+  }
+
+  private isAdmin(roles: string[]): boolean {
+    return roles.some((role) =>
+      TopcoderReportsGuard.adminRoles.has(role?.toLowerCase()),
+    );
+  }
+}

src/reports/topcoder/dto/registrant-countries.dto.ts

@@ -0,0 +1,11 @@
+import { Transform } from "class-transformer";
+import { IsNotEmpty, IsString } from "class-validator";
+
+export class RegistrantCountriesQueryDto {
+  @Transform(({ value }) =>
+    typeof value === "string" ? value.trim() : value,
+  )
+  @IsString()
+  @IsNotEmpty()
+  challengeId!: string;
+}

src/reports/topcoder/topcoder-reports.controller.ts

@@ -1,8 +1,13 @@
-import { Controller, Get } from "@nestjs/common";
-import { ApiOperation, ApiTags } from "@nestjs/swagger";
+import { Controller, Get, Query, Res, UseGuards } from "@nestjs/common";
+import { ApiBearerAuth, ApiOperation, ApiTags } from "@nestjs/swagger";
+import { Response } from "express";
 import { TopcoderReportsService } from "./topcoder-reports.service";
+import { RegistrantCountriesQueryDto } from "./dto/registrant-countries.dto";
+import { TopcoderReportsGuard } from "../../auth/guards/topcoder-reports.guard";
 
 @ApiTags("Topcoder Reports")
+@ApiBearerAuth()
+@UseGuards(TopcoderReportsGuard)
 @Controller("/topcoder")
 export class TopcoderReportsController {
   constructor(private readonly reports: TopcoderReportsService) {}
@@ -13,6 +18,25 @@ export class TopcoderReportsController {
     return this.reports.getMemberCount();
   }
 
+  @Get("/registrant-countries")
+  @ApiOperation({
+    summary: "Countries of all registrants for the specified challenge",
+  })
+  async getRegistrantCountries(
+    @Query() query: RegistrantCountriesQueryDto,
+    @Res() res: Response,
+  ) {
+    const { challengeId } = query;
+    const csv = await this.reports.getRegistrantCountriesCsv(challengeId);
+    const filename =
+      challengeId.length > 0
+        ? `registrant-countries-${challengeId}.csv`
+        : "registrant-countries.csv";
+    res.setHeader("Content-Type", "text/csv");
+    res.setHeader("Content-Disposition", `attachment; filename="${filename}"`);
+    res.send(csv);
+  }
+
   @Get("/total-copilots")
   @ApiOperation({ summary: "Total number of Copilots" })
   getTotalCopilots() {

src/reports/topcoder/topcoder-reports.module.ts

@@ -1,10 +1,11 @@
 import { Module } from "@nestjs/common";
-import { TopcoderReportsController } from "./topcoder-reports.controller";
 import { TopcoderReportsService } from "./topcoder-reports.service";
 import { SqlLoaderService } from "../../common/sql-loader.service";
+import { TopcoderReportsController } from "./topcoder-reports.controller";
+import { TopcoderReportsGuard } from "../../auth/guards/topcoder-reports.guard";
 
 @Module({
   controllers: [TopcoderReportsController],
-  providers: [TopcoderReportsService, SqlLoaderService],
+  providers: [TopcoderReportsService, SqlLoaderService, TopcoderReportsGuard],
 })
 export class TopcoderReportsModule {}

src/reports/topcoder/topcoder-reports.service.ts

@@ -2,6 +2,13 @@ import { Injectable } from "@nestjs/common";
 import { DbService } from "../../db/db.service";
 import { SqlLoaderService } from "../../common/sql-loader.service";
 
+type RegistrantCountriesRow = {
+  handle: string | null;
+  email: string | null;
+  home_country: string | null;
+  competition_country: string | null;
+};
+
 @Injectable()
 export class TopcoderReportsService {
   constructor(
@@ -387,4 +394,49 @@ export class TopcoderReportsService {
       ),
     }));
   }
+
+  async getRegistrantCountriesCsv(challengeId: string) {
+    const query = this.sql.load("reports/topcoder/registrant-countries.sql");
+    const rows = await this.db.query<RegistrantCountriesRow>(query, [
+      challengeId,
+    ]);
+    return this.rowsToCsv(rows);
+  }
+
+  private rowsToCsv(rows: RegistrantCountriesRow[]) {
+    const header = [
+      "Handle",
+      "Email",
+      "Home country",
+      "Competition country",
+    ];
+
+    const lines = [
+      header.map((value) => this.toCsvCell(value)).join(","),
+      ...rows.map((row) =>
+        [
+          row.handle,
+          row.email,
+          row.home_country,
+          row.competition_country,
+        ]
+          .map((value) => this.toCsvCell(value))
+          .join(","),
+      ),
+    ];
+
+    return lines.join("\n");
+  }
+
+  private toCsvCell(value: string | null | undefined) {
+    if (value === null || value === undefined) {
+      return "";
+    }
+    const text = String(value);
+    if (!/[",\r\n]/.test(text)) {
+      return text;
+    }
+    const escaped = text.replace(/"/g, '""');
+    return `"${escaped}"`;
+  }
 }