feat: add an ability to mark contributors as hidden gf-346

apps/backend/src/db/migrations/20240918171311_add_is_hidden_to_contributors_table.ts

@@ -0,0 +1,21 @@
+import { type Knex } from "knex";
+
+const TABLE_NAME = "contributors";
+
+const ColumnName = {
+	IS_HIDDEN: "is_hidden",
+} as const;
+
+function up(knex: Knex): Promise<void> {
+	return knex.schema.alterTable(TABLE_NAME, (table) => {
+		table.boolean(ColumnName.IS_HIDDEN).defaultTo(false).notNullable();
+	});
+}
+
+function down(knex: Knex): Promise<void> {
+	return knex.schema.alterTable(TABLE_NAME, (table) => {
+		table.dropColumn(ColumnName.IS_HIDDEN);
+	});
+}
+
+export { down, up };

apps/backend/src/modules/activity-logs/activity-log.repository.ts

@@ -47,10 +47,12 @@ class ActivityLogRepository implements Repository {
 	}: ActivityLogQueryParameters): Promise<{ items: ActivityLogEntity[] }> {
 		const query = this.activityLogModel
 			.query()
-			.withGraphFetched("[gitEmail.contributor, project, createdByUser]")
+			.withGraphFetched("[project, createdByUser]")
+			.withGraphJoined("gitEmail.contributor")
 			.modifyGraph("gitEmail.contributor", (builder) => {
-				builder.select("id", "name");
+				builder.select("id", "name", "isHidden");
 			})
+			.where("gitEmail:contributor.isHidden", false)
 			.whereBetween("activity_logs.date", [startDate, endDate])
 			.orderBy("date");
 

apps/backend/src/modules/activity-logs/activity-log.service.ts

@@ -133,11 +133,13 @@ class ActivityLogService implements Service {
 
 	public async findAll({
 		endDate,
+		hasHidden = false,
 		projectId,
 		startDate,
 	}: ActivityLogQueryParameters): Promise<ActivityLogGetAllAnalyticsResponseDto> {
 		const activityLogsEntities = await this.activityLogRepository.findAll({
 			endDate,
+			hasHidden,
 			projectId,
 			startDate,
 		});
@@ -148,7 +150,7 @@ class ActivityLogService implements Service {
 
 		const allContributors = await (projectId
 			? this.contributorService.findAllByProjectId(Number(projectId))
-			: this.contributorService.findAllWithoutPagination());
+			: this.contributorService.findAllWithoutPagination({ hasHidden }));
 
 		const dateRange = getDateRange(startDate, endDate);
 
@@ -184,8 +186,11 @@ class ActivityLogService implements Service {
 
 				return {
 					commitsNumber: commitsArray,
-					contributorId: contributorId ?? "",
-					contributorName: contributorName ?? "",
+					contributor: {
+						id: contributorId ?? "",
+						isHidden: false,
+						name: contributorName ?? "",
+					},
 				};
 			}),
 		};

apps/backend/src/modules/contributors/contributor.controller.ts

@@ -180,7 +180,10 @@ class ContributorController extends BaseController {
 		}
 
 		return {
-			payload: await this.contributorService.findAll(options.query),
+			payload: await this.contributorService.findAll({
+				...options.query,
+				hasHidden: true,
+			}),
 			status: HTTPCode.OK,
 		};
 	}

apps/backend/src/modules/contributors/contributor.entity.ts

@@ -5,46 +5,53 @@ import { type ContributorGetAllItemResponseDto } from "./libs/types/types.js";
 class ContributorEntity implements Entity {
 	private gitEmails: { email: string; id: number }[];
 	private id: null | number;
+	private isHidden: boolean;
 	private lastActivityDate: null | string;
 	private name: string;
 	private projects: { id: number; name: string }[];
 
 	private constructor({
 		gitEmails,
 		id,
+		isHidden,
 		lastActivityDate,
 		name,
 		projects,
 	}: {
 		gitEmails: { email: string; id: number }[];
 		id: null | number;
+		isHidden: boolean;
 		lastActivityDate: null | string;
 		name: string;
 		projects: { id: number; name: string }[];
 	}) {
+		this.gitEmails = gitEmails;
 		this.id = id;
-		this.name = name;
+		this.isHidden = isHidden;
 		this.lastActivityDate = lastActivityDate;
-		this.gitEmails = gitEmails;
+		this.name = name;
 		this.projects = projects;
 	}
 
 	public static initialize({
 		gitEmails,
 		id,
+		isHidden,
 		lastActivityDate,
 		name,
 		projects,
 	}: {
 		gitEmails: { email: string; id: number }[];
 		id: number;
+		isHidden: boolean;
 		lastActivityDate: null | string;
 		name: string;
 		projects: { id: number; name: string }[];
 	}): ContributorEntity {
 		return new ContributorEntity({
 			gitEmails,
 			id,
+			isHidden,
 			lastActivityDate,
 			name,
 			projects,
@@ -53,16 +60,19 @@ class ContributorEntity implements Entity {
 
 	public static initializeNew({
 		gitEmails = [],
+		isHidden = false,
 		name,
 		projects = [],
 	}: {
 		gitEmails?: { email: string; id: number }[];
+		isHidden?: boolean;
 		name: string;
 		projects?: { id: number; name: string }[];
 	}): ContributorEntity {
 		return new ContributorEntity({
 			gitEmails,
 			id: null,
+			isHidden,
 			lastActivityDate: null,
 			name,
 			projects,
@@ -71,12 +81,14 @@ class ContributorEntity implements Entity {
 
 	public toNewObject(): {
 		gitEmails: { email: string; id: number }[];
+		isHidden: boolean;
 		lastActivityDate: null | string;
 		name: string;
 		projects: { id: number; name: string }[];
 	} {
 		return {
 			gitEmails: this.gitEmails,
+			isHidden: this.isHidden,
 			lastActivityDate: this.lastActivityDate,
 			name: this.name,
 			projects: this.projects,
@@ -87,6 +99,7 @@ class ContributorEntity implements Entity {
 		return {
 			gitEmails: this.gitEmails,
 			id: this.id as number,
+			isHidden: this.isHidden,
 			lastActivityDate: this.lastActivityDate,
 			name: this.name,
 			projects: this.projects,

apps/backend/src/modules/contributors/contributor.model.ts

@@ -10,8 +10,13 @@ import { type ProjectModel } from "../projects/project.model.js";
 
 class ContributorModel extends AbstractModel {
 	public gitEmails!: GitEmailModel[];
+
+	public isHidden!: boolean;
+
 	public lastActivityDate!: null | string;
+
 	public name!: string;
+
 	public projects!: ProjectModel[];
 
 	public static override get relationMappings(): RelationMappings {

apps/backend/src/modules/contributors/contributor.repository.ts

@@ -56,12 +56,13 @@ class ContributorRepository implements Repository {
 	}
 
 	public async findAll({
+		hasHidden = false,
 		page,
 		pageSize,
-	}: PaginationQueryParameters): Promise<
+	}: { hasHidden?: boolean } & PaginationQueryParameters): Promise<
 		PaginationResponseDto<ContributorEntity>
 	> {
-		const { results, total } = await this.contributorModel
+		const query = this.contributorModel
 			.query()
 			.orderBy("createdAt", SortType.DESCENDING)
 			.page(page, pageSize)
@@ -77,6 +78,12 @@ class ContributorRepository implements Repository {
 			.groupBy("contributors.id")
 			.withGraphFetched("gitEmails");
 
+		if (!hasHidden) {
+			query.where("contributors.isHidden", false);
+		}
+
+		const { results, total } = await query;
+
 		return {
 			items: results.map((contributor) => {
 				return ContributorEntity.initialize(contributor);
@@ -105,6 +112,7 @@ class ContributorRepository implements Repository {
 			.leftJoin("activity_logs", "git_emails.id", "activity_logs.git_email_id")
 			.leftJoin("projects", "activity_logs.project_id", "projects.id")
 			.where("projects.id", projectId)
+			.andWhere("contributors.isHidden", false)
 			.groupBy("contributors.id")
 			.withGraphFetched("gitEmails");
 
@@ -115,10 +123,14 @@ class ContributorRepository implements Repository {
 		};
 	}
 
-	public async findAllWithoutPagination(): Promise<{
+	public async findAllWithoutPagination({
+		hasHidden = true,
+	}: {
+		hasHidden?: boolean;
+	}): Promise<{
 		items: ContributorEntity[];
 	}> {
-		const results = await this.contributorModel
+		const query = this.contributorModel
 			.query()
 			.select("contributors.*")
 			.select(
@@ -132,6 +144,12 @@ class ContributorRepository implements Repository {
 			.groupBy("contributors.id")
 			.withGraphFetched("gitEmails");
 
+		if (!hasHidden) {
+			query.where("contributors.isHidden", false);
+		}
+
+		const results = await query;
+
 		return {
 			items: results.map((contributor) => {
 				return ContributorEntity.initialize(contributor);
@@ -210,7 +228,10 @@ class ContributorRepository implements Repository {
 	): Promise<ContributorEntity | null> {
 		const contributor = await this.contributorModel
 			.query()
-			.patchAndFetchById(contributorId, { name: data.name });
+			.patchAndFetchById(contributorId, {
+				isHidden: data.isHidden,
+				name: data.name,
+			});
 
 		return ContributorEntity.initialize(contributor);
 	}

apps/backend/src/modules/contributors/contributor.service.ts

@@ -60,12 +60,17 @@ class ContributorService implements Service {
 		return item.toObject();
 	}
 
-	public async findAll(
-		parameters: PaginationQueryParameters,
-	): Promise<ContributorGetAllResponseDto> {
+	public async findAll({
+		hasHidden = true,
+		page,
+		pageSize,
+	}: {
+		hasHidden?: boolean;
+	} & PaginationQueryParameters): Promise<ContributorGetAllResponseDto> {
 		const contributors = await this.contributorRepository.findAll({
-			page: parameters.page - PAGE_INDEX_OFFSET,
-			pageSize: parameters.pageSize,
+			hasHidden,
+			page: page - PAGE_INDEX_OFFSET,
+			pageSize,
 		});
 
 		return {
@@ -106,9 +111,13 @@ class ContributorService implements Service {
 		};
 	}
 
-	public async findAllWithoutPagination(): Promise<ContributorGetAllResponseDto> {
+	public async findAllWithoutPagination({
+		hasHidden = true,
+	}: {
+		hasHidden?: boolean;
+	}): Promise<ContributorGetAllResponseDto> {
 		const contributors =
-			await this.contributorRepository.findAllWithoutPagination();
+			await this.contributorRepository.findAllWithoutPagination({ hasHidden });
 
 		return {
 			items: contributors.items.map((item) => {

apps/frontend/src/libs/components/checkbox/checkbox.tsx

@@ -12,12 +12,14 @@ import styles from "./styles.module.css";
 type Properties<T extends FieldValues> = {
 	control: Control<T, null>;
 	errors: FieldErrors<T>;
+	id?: string;
 	name: FieldPath<T>;
 };
 
 const Checkbox = <T extends FieldValues>({
 	control,
 	errors,
+	id,
 	name,
 }: Properties<T>): JSX.Element => {
 	const { field } = useFormController({ control, name });
@@ -30,6 +32,7 @@ const Checkbox = <T extends FieldValues>({
 			<input
 				className={styles["checkbox"]}
 				defaultChecked={field.value}
+				id={id}
 				name={name}
 				onChange={field.onChange}
 				type="checkbox"

apps/frontend/src/libs/components/icon/libs/maps/icon-name-to-svg.map.ts

@@ -3,6 +3,7 @@ import { type FC } from "react";
 import Access from "~/assets/images/icons/access.svg?react";
 import Analytics from "~/assets/images/icons/analytics.svg?react";
 import Calendar from "~/assets/images/icons/calendar.svg?react";
+import Check from "~/assets/images/icons/check.svg?react";
 import Clipboard from "~/assets/images/icons/clipboard.svg?react";
 import Contributors from "~/assets/images/icons/contributors.svg?react";
 import Cross from "~/assets/images/icons/cross.svg?react";
@@ -27,6 +28,7 @@ const iconNameToSvg: Record<IconName, FC<React.SVGProps<SVGSVGElement>>> = {
 	access: Access,
 	analytics: Analytics,
 	calendar: Calendar,
+	check: Check,
 	clipboard: Clipboard,
 	contributors: Contributors,
 	cross: Cross,

apps/frontend/src/libs/types/icon-name.type.ts

@@ -2,6 +2,7 @@ type IconName =
 	| "access"
 	| "analytics"
 	| "calendar"
+	| "check"
 	| "clipboard"
 	| "contributors"
 	| "cross"

apps/frontend/src/pages/analytics/libs/helpers/get-analytics-rows/get-analytics-rows.helper.ts

@@ -7,8 +7,8 @@ const getAnalyticsRows = (
 ): AnalyticsRow[] => {
 	return activityLogs.map((log) => ({
 		commitsNumber: log.commitsNumber,
-		contributorId: log.contributorId,
-		contributorName: log.contributorName,
+		contributorId: log.contributor.id,
+		contributorName: log.contributor.name,
 	}));
 };