feat: add contributors API (#166)

* feat: add contributors API

* feat: add total number

* test: add api cases

* test: add service cases

* docs: add comment

Co-authored-by: Ti Prow Robot <71242396+ti-community-prow-bot@users.noreply.github.com>

Author: 0xPoe

src/api/contributor/index.ts

@@ -0,0 +1,48 @@
+import { Request, Response } from "express";
+
+import { IContributorService } from "../../services/contributor";
+import { StatusCodes } from "http-status-codes";
+import { Response as Res } from "../../services/response";
+import { ContributorMessage } from "../../services/messages/ContributorMessage";
+
+/**
+ * List contributors.
+ * @param req
+ * @param res
+ * @param contributorService
+ */
+export async function listContributors(
+  req: Request,
+  res: Response,
+  contributorService: IContributorService
+) {
+  // Gather paginate query.
+  const { current, pageSize } = req.query;
+  let paginateQuery;
+
+  // Validate paginate query.
+  if (current !== undefined && pageSize !== undefined) {
+    const currentNum = Number(current);
+    const pageSizeNum = Number(pageSize);
+    if (!Number.isInteger(currentNum) || !Number.isInteger(pageSizeNum)) {
+      const response: Res<null> = {
+        data: null,
+        status: StatusCodes.BAD_REQUEST,
+        message: ContributorMessage.IllegalQueryParameters,
+      };
+
+      res.status(response.status);
+      res.json(response);
+      return;
+    }
+    paginateQuery = {
+      current: currentNum,
+      pageSize: pageSizeNum,
+    };
+  }
+
+  const response = await contributorService.listContributors(paginateQuery);
+
+  res.status(response.status);
+  res.json(response);
+}

src/db/entities/Pull.ts

@@ -0,0 +1,71 @@
+import { Entity, Index, PrimaryGeneratedColumn, Column } from "typeorm";
+
+@Entity({ name: "pulls" })
+export class Pull {
+  @PrimaryGeneratedColumn({ name: "id" })
+  id: number;
+
+  @Column({ default: null })
+  owner: string;
+
+  @Column({ default: null })
+  repo: string;
+
+  @Column({ name: "pull_number", default: null })
+  @Index()
+  pullNumber: number;
+
+  @Column({ type: "text" })
+  title: string;
+
+  @Column({ type: "text" })
+  body: string;
+
+  @Column({ default: null })
+  user: string;
+
+  @Column({ default: null })
+  association: string;
+
+  @Column({ default: null })
+  relation: string;
+
+  @Column({ type: "text" })
+  label: string;
+
+  @Column({ type: "varchar", length: 128 })
+  status: string;
+
+  // FIXME: maybe this means issue created time.
+  @Column({
+    name: "created_at",
+    type: "timestamp",
+    nullable: false,
+    default: () => "CURRENT_TIMESTAMP",
+  })
+  createdAt: string;
+
+  @Column({
+    name: "updated_at",
+    type: "timestamp",
+    nullable: true,
+    default: null,
+  })
+  updatedAt: string;
+
+  @Column({
+    name: "closed_at",
+    type: "timestamp",
+    nullable: true,
+    default: null,
+  })
+  closedAt: string;
+
+  @Column({
+    name: "merged_at",
+    type: "timestamp",
+    nullable: true,
+    default: null,
+  })
+  mergedAt: string;
+}

src/index.ts

@@ -11,6 +11,8 @@ import { getSig } from "./api/sig";
 import { listOwners } from "./api/pull";
 import { handlePullRequestEvents } from "./events/pull";
 import { Router } from "express";
+import { listContributors } from "./api/contributor";
+import ContributorService from "./services/contributor";
 
 const commands = require("probot-commands-pro");
 const bodyParser = require("body-parser");
@@ -90,6 +92,10 @@ export = (
       router.get("/sigs/:name", async (req, res) => {
         await getSig(req, res, Container.get(SigService));
       });
+
+      router.get("/contributors", async (req, res) => {
+        await listContributors(req, res, Container.get(ContributorService));
+      });
     })
     .catch((err) => {
       app.log.fatal("Connect to db failed", err);

src/queries/PaginateQuery.ts

@@ -0,0 +1,14 @@
+/**
+ * Paginate query.
+ */
+export interface PaginateQuery {
+  /**
+   * Current page.
+   * Start with 1.
+   */
+  current: number;
+  /**
+   * Size of each page.
+   */
+  pageSize: number;
+}

src/repositoies/contributor/index.ts

@@ -0,0 +1,35 @@
+import { EntityRepository } from "typeorm";
+import { Service } from "typedi";
+import { Repository } from "typeorm/repository/Repository";
+
+import { Pull } from "../../db/entities/Pull";
+
+@Service()
+@EntityRepository(Pull)
+export default class ContributorRepository extends Repository<Pull> {
+  /**
+   * List contributors.
+   */
+  public async listContributors(
+    skip?: number,
+    take?: number
+  ): Promise<string[]> {
+    return (
+      await this.createQueryBuilder()
+        .select("distinct user as githubName")
+        .skip(skip)
+        .take(take)
+        .getRawMany()
+    ).map((c) => {
+      return c.githubName;
+    });
+  }
+
+  public async getContributorsCount(): Promise<number> {
+    return (
+      await this.createQueryBuilder()
+        .select("count(distinct user) as total")
+        .getRawOne()
+    ).total;
+  }
+}

src/repositoies/sig-member/index.ts

@@ -12,7 +12,6 @@ export default class SigMemberRepository extends Repository<SigMember> {
   /**
    * List sig members.
    * @param sigId SIG id.
-   * @private
    */
   public async listSigMembers(
     sigId: number

src/services/contributor/index.ts

@@ -0,0 +1,68 @@
+import { Service } from "typedi";
+import { StatusCodes } from "http-status-codes";
+import { InjectRepository } from "typeorm-typedi-extensions";
+
+import { Response } from "../response";
+import { ContributorsDTO } from "../dtos/ContributorsDTO";
+import { PaginateQuery } from "../../queries/PaginateQuery";
+import ContributorRepository from "../../repositoies/contributor";
+import { ContributorMessage } from "../messages/ContributorMessage";
+
+export interface IContributorService {
+  /**
+   * List contributors.
+   * @param paginateQuery
+   */
+  listContributors(
+    paginateQuery?: PaginateQuery
+  ): Promise<Response<ContributorsDTO>>;
+}
+
+@Service()
+export default class ContributorService implements IContributorService {
+  constructor(
+    @InjectRepository()
+    private contributorRepository: ContributorRepository
+  ) {}
+
+  /**
+   * List contributors.
+   * @param paginateQuery
+   */
+  public async listContributors(
+    paginateQuery?: PaginateQuery
+  ): Promise<Response<ContributorsDTO>> {
+    if (paginateQuery === undefined) {
+      const contributors = (
+        await this.contributorRepository.listContributors()
+      ).map((c) => {
+        return { githubName: c };
+      });
+
+      const total = await this.contributorRepository.getContributorsCount();
+
+      return {
+        data: { contributors: contributors, total: total },
+        status: StatusCodes.OK,
+        message: ContributorMessage.ListContributorSuccess,
+      };
+    } else {
+      const { current, pageSize } = paginateQuery;
+      const skip = (current - 1) * pageSize;
+
+      const contributors = (
+        await this.contributorRepository.listContributors(skip, pageSize)
+      ).map((c) => {
+        return { githubName: c };
+      });
+
+      const total = await this.contributorRepository.getContributorsCount();
+
+      return {
+        data: { contributors: contributors, total: total },
+        status: StatusCodes.OK,
+        message: ContributorMessage.ListContributorSuccess,
+      };
+    }
+  }
+}

src/services/dtos/ContributorsDTO.ts

@@ -0,0 +1,8 @@
+export interface ContributorsDTO {
+  contributors: ContributorDTO[];
+  total: number;
+}
+
+interface ContributorDTO {
+  githubName: string;
+}

src/services/messages/ContributorMessage.ts

@@ -0,0 +1,4 @@
+export enum ContributorMessage {
+  ListContributorSuccess = "List contributors success.",
+  IllegalQueryParameters = "Illegal query parameters.",
+}