Merge pull request #583 from dzcode-io/fix/filterout-contributions-cr…

…eated-by-bots Fix: filtering out contributions created by bots
dzcode-io · Jan 1, 2024 · dc8530d · dc8530d
2 parents 4c4cea2 + 559cc0e
commit dc8530d
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 4 deletions.
diff --git a/api/src/contribution/controller.ts b/api/src/contribution/controller.ts
@@ -20,6 +20,7 @@ export class ContributionController {
   ): Promise<GetContributionsResponseDto> {
     const { contributions, filters } = await this.contributionRepository.find(
       (contribution) =>
+        !contribution.createdBy.username.includes("[bot]") &&
         (labels.length === 0 || labels.some((label) => contribution.labels.includes(label))) &&
         (languages.length === 0 ||
           languages.some((language) => contribution.languages.includes(language))) &&

diff --git a/api/src/contribution/repository.ts b/api/src/contribution/repository.ts
@@ -22,7 +22,7 @@ export class ContributionRepository {
 
     let contributions = (
       await Promise.all(
-        projects.reduce<Promise<Model<ContributionEntity, "project">[]>[]>(
+        projects.reduce<Promise<Model<ContributionEntity, "project" | "createdBy">[]>[]>(
           (pV, { repositories, name, slug }) => [
             ...pV,
             ...repositories
@@ -38,8 +38,7 @@ export class ContributionRepository {
                     owner,
                     repository,
                   });
-                  // @TODO-ZM: filter out the ones created by bots
-                  return issuesIncludingPRs.map<Model<ContributionEntity, "project">>(
+                  return issuesIncludingPRs.map<Model<ContributionEntity, "project" | "createdBy">>(
                     ({
                       number,
                       labels: gLabels,
@@ -49,6 +48,7 @@ export class ContributionRepository {
                       created_at, // eslint-disable-line camelcase
                       updated_at, // eslint-disable-line camelcase
                       comments,
+                      user,
                     }) => ({
                       id: `${number}`,
                       labels: gLabels.map(({ name }) => name),
@@ -64,6 +64,7 @@ export class ContributionRepository {
                       updatedAt: updated_at, // eslint-disable-line camelcase
                       commentsCount: comments,
                       /* eslint-enable camelcase */
+                      createdBy: this.githubService.githubUserToAccountEntity(user),
                     }),
                   );
                 } catch (error) {

diff --git a/api/src/contribution/types.ts b/api/src/contribution/types.ts
@@ -31,7 +31,7 @@ export class FilterDto {
 export class GetContributionsResponseDto extends GeneralResponseDto {
   @ValidateNested({ each: true })
   @Type(() => ContributionEntity)
-  contributions!: Model<ContributionEntity, "project">[];
+  contributions!: Model<ContributionEntity, "project" | "createdBy">[];
 
   @ValidateNested({ each: true })
   @Type(() => FilterDto)

diff --git a/packages/models/src/contribution/__snapshots__/index.spec.ts.snap b/packages/models/src/contribution/__snapshots__/index.spec.ts.snap
@@ -6,6 +6,13 @@ exports[`should match snapshot when providing all fields: output 1`] = `
 ContributionEntity {
   "commentsCount": 0,
   "createdAt": "2020-02-02T20:22:02.000Z",
+  "createdBy": AccountEntity {
+    "avatarUrl": "https://avatars.githubusercontent.com/u/20110076?v=4",
+    "id": "github/20110076",
+    "name": "Zakaria Mansouri",
+    "profileUrl": "/Account/github/20110076",
+    "username": "ZibanPirate",
+  },
   "id": "71",
   "labels": [
     "discussion",
@@ -32,6 +39,13 @@ exports[`should match snapshot when providing required fields only: output 1`] =
 ContributionEntity {
   "commentsCount": 0,
   "createdAt": "2020-02-02T20:22:02.000Z",
+  "createdBy": AccountEntity {
+    "avatarUrl": "https://avatars.githubusercontent.com/u/20110076?v=4",
+    "id": "github/20110076",
+    "name": "Zakaria Mansouri",
+    "profileUrl": "/Account/github/20110076",
+    "username": "ZibanPirate",
+  },
   "id": "71",
   "labels": [
     "discussion",

diff --git a/packages/models/src/contribution/index.spec.ts b/packages/models/src/contribution/index.spec.ts
@@ -18,6 +18,13 @@ runDTOTestCases(
     createdAt: "2020-02-02T20:22:02.000Z",
     updatedAt: "2020-02-02T20:22:02.000Z",
     url: "https://github.com/dzcode-io/leblad/issues/71",
+    createdBy: {
+      id: "github/20110076",
+      username: "ZibanPirate",
+      name: "Zakaria Mansouri",
+      profileUrl: "/Account/github/20110076",
+      avatarUrl: "https://avatars.githubusercontent.com/u/20110076?v=4",
+    },
   },
   {},
 );
diff --git a/packages/models/src/contribution/index.ts b/packages/models/src/contribution/index.ts
@@ -1,6 +1,7 @@
 import { Type } from "class-transformer";
 import { IsDateString, IsNumber, IsString, IsUrl, ValidateNested } from "class-validator";
 import { BaseEntity, Model } from "src/_base";
+import { AccountEntity } from "src/account";
 import { ProjectReferenceEntity } from "src/project-reference";
 
 export class ContributionEntity extends BaseEntity {
@@ -14,6 +15,10 @@ export class ContributionEntity extends BaseEntity {
   @Type(() => ProjectReferenceEntity)
   project!: Model<ProjectReferenceEntity>;
 
+  @ValidateNested()
+  @Type(() => AccountEntity)
+  createdBy!: Model<AccountEntity>;
+
   @IsString()
   type!: "issue" | "pullRequest";