Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: filtering out contributions created by bots #583

Merged
merged 2 commits into from
Jan 1, 2024
Merged

Fix: filtering out contributions created by bots #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55ea2f5
Fix filtering out contributions created by bots
ZibanPirate Jan 1, 2024
559cc0e
Add createdBy field to ContributionEntity
ZibanPirate Jan 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/src/contribution/controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))) &&
Expand Down
7 changes: 4 additions & 3 deletions api/src/contribution/repository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
Expand All @@ -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),
Expand All @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion api/src/contribution/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
14 changes: 14 additions & 0 deletions packages/models/src/contribution/__snapshots__/index.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
7 changes: 7 additions & 0 deletions packages/models/src/contribution/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
},
{},
);
5 changes: 5 additions & 0 deletions packages/models/src/contribution/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 {
Expand All @@ -14,6 +15,10 @@ export class ContributionEntity extends BaseEntity {
@Type(() => ProjectReferenceEntity)
project!: Model<ProjectReferenceEntity>;

@ValidateNested()
@Type(() => AccountEntity)
createdBy!: Model<AccountEntity>;

@IsString()
type!: "issue" | "pullRequest";

Expand Down