added /Milestones/dzcode endpoint

Author: ZibanPirate

api/src/app/endpoints.ts

@@ -3,6 +3,7 @@ import { LanguageEntity } from "@dzcode.io/models/dist/language";
 import { GetContributionsResponseDto } from "../contribution/types";
 import { GetContributorsResponseDto } from "../contributor/types";
 import { GetUserResponseDto } from "../github-user/types";
+import { GetMilestonesResponseDto } from "../milestone/types";
 import { GetTeamResponseDto } from "../team/types";
 import { Article, Document, Project } from "./types/legacy";
 
@@ -49,4 +50,7 @@ export interface Endpoints {
   "api:Team": {
     response: GetTeamResponseDto;
   };
+  "api:MileStones/dzcode": {
+    response: GetMilestonesResponseDto;
+  };
 }

api/src/app/index.ts

@@ -12,6 +12,7 @@ import { ContributorController } from "../contributor/controller";
 import { GithubController } from "../github/controller";
 import { GithubUserController } from "../github-user/controller";
 import { LoggerService } from "../logger/service";
+import { MilestoneController } from "../milestone/controller";
 import { TeamController } from "../team/controller";
 import { DocsMiddleware } from "./middlewares/docs";
 import { ErrorMiddleware } from "./middlewares/error";
@@ -44,6 +45,7 @@ export const routingControllersOptions: RoutingControllersOptions = {
     GithubUserController,
     TeamController,
     GithubController,
+    MilestoneController,
   ],
   middlewares: [
     SentryRequestHandlerMiddleware,

api/src/app/types/legacy.ts

@@ -63,3 +63,17 @@ export interface GithubIssue {
     html_url: "https://github.com/ZibanPirate/l2t/pull/9";
   };
 }
+
+export interface GithubMilestone {
+  html_url: string;
+  number: number;
+  title: string;
+  description: string;
+  state: "closed" | "open";
+  open_issues: number;
+  closed_issues: number;
+  created_at: string;
+  updated_at: string;
+  closed_at: string | null;
+  due_on: string | null;
+}

api/src/github/service.ts

@@ -1,13 +1,14 @@
 import { Service } from "typedi";
 
-import { GithubIssue, GithubUser } from "../app/types/legacy";
+import { GithubIssue, GithubMilestone, GithubUser } from "../app/types/legacy";
 import { ConfigService } from "../config/service";
 import { FetchService } from "../fetch/service";
 import {
   GeneralGithubQuery,
   GetUserInput,
   GitHubListRepositoryIssuesInput,
   GitHubListRepositoryLanguagesInput,
+  GitHubListRepositoryMilestonesInput,
   GitHubRateLimitApiResponse,
   GitHubUserApiResponse,
   ListContributorsResponse,
@@ -108,6 +109,20 @@ export class GithubService {
     };
   };
 
+  public listRepositoryMilestones = async ({
+    owner,
+    repo,
+  }: GitHubListRepositoryMilestonesInput): Promise<GithubMilestone[]> => {
+    const milestones = await this.fetchService.get<GithubMilestone[]>(
+      `${this.apiURL}/repos/${owner}/${repo}/milestones`,
+      {
+        headers: this.githubToken ? { Authorization: `Token ${this.githubToken}` } : {},
+        params: { state: "all", per_page: 100 }, // eslint-disable-line camelcase
+      },
+    );
+    return milestones;
+  };
+
   private githubToken = this.configService.env().GITHUB_TOKEN;
   private apiURL = "https://api.github.com";
 }

api/src/github/types.ts

@@ -61,6 +61,8 @@ export interface GitHubListRepositoryIssuesInput {
 
 export type GitHubListRepositoryLanguagesInput = GitHubListRepositoryIssuesInput;
 
+export type GitHubListRepositoryMilestonesInput = GitHubListRepositoryIssuesInput;
+
 export interface GitHubRateLimitApiResponse {
   resources: {
     core: {

api/src/milestone/controller.ts

@@ -0,0 +1,39 @@
+import { Controller, Get } from "routing-controllers";
+import { OpenAPI, ResponseSchema } from "routing-controllers-openapi";
+import { Service } from "typedi";
+
+import { GithubService } from "../github/service";
+import { GetMilestonesResponseDto } from "./types";
+
+@Service()
+@Controller("/Milestones")
+export class MilestoneController {
+  constructor(private readonly githubService: GithubService) {}
+
+  @Get("/dzcode")
+  @OpenAPI({
+    summary: "Return a list of milestones for all dzcode.io repo",
+  })
+  @ResponseSchema(GetMilestonesResponseDto)
+  public async getMilestones(): Promise<GetMilestonesResponseDto> {
+    const githubMilestones = await this.githubService.listRepositoryMilestones({
+      owner: "dzcode-io",
+      repo: "dzcode.io",
+    });
+    return {
+      // @TODO-ZM: sort milestones based on: status:closed by closedAt,and status:open: dueAt, createdAt
+      milestones: githubMilestones.map((githubMilestone) => ({
+        id: `${githubMilestone.number}`,
+        title: githubMilestone.title,
+        description: githubMilestone.description,
+        url: githubMilestone.html_url,
+        status: githubMilestone.state,
+        closedIssuesCount: githubMilestone.closed_issues,
+        openIssuesCount: githubMilestone.open_issues,
+        createdAt: githubMilestone.created_at,
+        closedAt: githubMilestone.closed_at || undefined,
+        dueAt: githubMilestone.due_on || undefined,
+      })),
+    };
+  }
+}

api/src/milestone/types.ts

@@ -0,0 +1,12 @@
+import { Model } from "@dzcode.io/models/dist/_base";
+import { MilestoneEntity } from "@dzcode.io/models/dist/milestone";
+import { Type } from "class-transformer";
+import { ValidateNested } from "class-validator";
+
+import { GeneralResponseDto } from "../app/types";
+
+export class GetMilestonesResponseDto extends GeneralResponseDto {
+  @ValidateNested({ each: true })
+  @Type(() => MilestoneEntity)
+  milestones!: Model<MilestoneEntity>[];
+}