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.

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

feat: duplicate regular board #1281

Merged
merged 23 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
36f754a
feat: add duplicate board endpoint and base method
jpvsalvador Mar 20, 2023
7d5334c
fix: invalidate boards query
jpvsalvador Mar 20, 2023
e2cb822
fix: create boardUsers and board separately
jpvsalvador Mar 21, 2023
a2d51d7
feat: add duplicate board title dialog
jpvsalvador Mar 21, 2023
b9407e0
refactor: add a description to the dialog
jpvsalvador Mar 21, 2023
bd983ef
Merge branch 'main' into 1250-feature-duplicate-regular-board
jpvsalvador Mar 21, 2023
35f260e
Merge branch 'main' into 1250-feature-duplicate-regular-board
jpvsalvador Mar 21, 2023
cb38f0e
fix: import errors
jpvsalvador Mar 21, 2023
80fd37a
fix: import errors
jpvsalvador Mar 21, 2023
0f4fd55
fix: boardUsers folder capital letter on imports
jpvsalvador Mar 21, 2023
60b5729
fix: update board controller tests
jpvsalvador Mar 21, 2023
4f3dee3
feat: show success message when duplicating boards
jpvsalvador Mar 21, 2023
fbbbb13
fix: update duplicated board timestamps
jpvsalvador Mar 21, 2023
45f90b1
feat: add tooltip to duplicate board button
jpvsalvador Mar 21, 2023
75434aa
fix: validate if board was found
jpvsalvador Mar 21, 2023
807b9ee
test: add backend tests
jpvsalvador Mar 22, 2023
7e26e7c
test: add frontend tests
jpvsalvador Mar 22, 2023
6b71ff8
Merge branch 'main' into 1250-feature-duplicate-regular-board
jpvsalvador Mar 22, 2023
bee5681
fix: get board team only after validation
jpvsalvador Mar 22, 2023
fce80c4
fix: boardusers folder import
jpvsalvador Mar 22, 2023
235da77
fix: pr suggestions
jpvsalvador Mar 23, 2023
d06715e
fix: invalidate boards query
jpvsalvador Mar 23, 2023
bc4b6e9
refactor: remove async
nunocaseiro Mar 23, 2023
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ import faker from '@faker-js/faker';
import { GetUserServiceInterface } from 'src/modules/users/interfaces/services/get.user.service.interface';
import { BoardFactory } from 'src/libs/test-utils/mocks/factories/board-factory.mock';
import { UserFactory } from 'src/libs/test-utils/mocks/factories/user-factory';
import { DuplicateBoardDto } from './duplicate-board.use-case';

describe('DuplicateBoardUseCase', () => {
let duplicateBoardMock: UseCase<{ boardId: string; userId: string; boardTitle: string }, Board>;
let duplicateBoardMock: UseCase<DuplicateBoardDto, Board>;
let getUserServiceMock: DeepMocked<GetUserServiceInterface>;
let getBoardServiceMock: DeepMocked<GetBoardServiceInterface>;
let boardRepositoryMock: DeepMocked<BoardRepositoryInterface>;
Expand Down Expand Up @@ -45,9 +46,9 @@ describe('DuplicateBoardUseCase', () => {
]
}).compile();

duplicateBoardMock = module.get<
UseCase<{ boardId: string; userId: string; boardTitle: string }, Board>
>(Boards.TYPES.applications.DuplicateBoardUseCase);
duplicateBoardMock = module.get<UseCase<DuplicateBoardDto, Board>>(
Boards.TYPES.applications.DuplicateBoardUseCase
);

getUserServiceMock = module.get(Users.TYPES.services.GetUserService);
getBoardServiceMock = module.get(Boards.TYPES.services.GetBoardService);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,22 @@ import Card from 'src/modules/cards/entities/card.schema';
import Column from 'src/modules/columns/entities/column.schema';
import { GetUserServiceInterface } from 'src/modules/users/interfaces/services/get.user.service.interface';
import * as Users from 'src/modules/users/interfaces/types';
import { Inject, Injectable, NotFoundException } from '@nestjs/common';
import { BadRequestException, Inject, Injectable } from '@nestjs/common';
import Board from '../entities/board.schema';
import { GetBoardServiceInterface } from '../interfaces/services/get.board.service.interface';
import { TYPES } from '../interfaces/types';
import { BoardRepositoryInterface } from '../repositories/board.repository.interface';
import { BOARD_NOT_FOUND, USER_NOT_FOUND } from 'src/libs/exceptions/messages';
import User from 'src/modules/users/entities/user.schema';
import Team from 'src/modules/teams/entities/team.schema';
import BoardUserDto from 'src/modules/boardUsers/dto/board.user.dto';
import { UserNotFoundException } from 'src/libs/exceptions/userNotFoundException';
import { BoardNotFoundException } from 'src/libs/exceptions/boardNotFoundException';
import { INSERT_FAILED } from 'src/libs/exceptions/messages';

export type DuplicateBoardDto = { boardId: string; userId: string; boardTitle: string };

@Injectable()
export class DuplicateBoardUseCase
implements UseCase<{ boardId: string; userId: string; boardTitle: string }, Board>
{
export class DuplicateBoardUseCase implements UseCase<DuplicateBoardDto, Board> {
constructor(
@Inject(TYPES.services.GetBoardService)
private getBoardService: GetBoardServiceInterface,
Expand All @@ -34,7 +36,7 @@ export class DuplicateBoardUseCase
const currentUser = await this.getUserService.getById(userId);

if (!currentUser) {
throw new NotFoundException(USER_NOT_FOUND);
throw new UserNotFoundException();
}
const { _id, firstName, lastName, email, strategy } = currentUser;

Expand All @@ -47,7 +49,7 @@ export class DuplicateBoardUseCase
});

if (!board) {
throw new NotFoundException(BOARD_NOT_FOUND);
throw new BoardNotFoundException();
}

const boardTeam = board.team as Team;
Expand Down Expand Up @@ -118,6 +120,8 @@ export class DuplicateBoardUseCase
dividedBoards: []
});

if (!newBoard) throw new BadRequestException(INSERT_FAILED);

await this.createBoardUserService.saveBoardUsers(users, newBoard._id);

return newBoard;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { GetBoardApplicationInterface } from '../interfaces/applications/get.boa
import { DeleteBoardApplicationInterface } from '../interfaces/applications/delete.board.application.interface';
import { UseCase } from 'src/libs/interfaces/use-case.interface';
import Board from '../entities/board.schema';
import { DuplicateBoardDto } from '../applications/duplicate-board.use-case';

describe('BoardsController', () => {
let controller: BoardsController;
Expand All @@ -28,8 +29,7 @@ describe('BoardsController', () => {
},
{
provide: Boards.TYPES.applications.DuplicateBoardUseCase,
useValue:
createMock<UseCase<{ boardId: string; userId: string; boardTitle: string }, Board>>()
useValue: createMock<UseCase<DuplicateBoardDto, Board>>()
},
{
provide: Boards.TYPES.applications.GetBoardApplication,
Expand Down
8 changes: 1 addition & 7 deletions backend/src/modules/boards/controller/boards.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { PaginationParams } from 'src/libs/dto/param/pagination.params';
import { BaseParamWSocket } from 'src/libs/dto/param/socket.param';
import { BoardPhases } from 'src/libs/enum/board.phases';
import { TeamRoles } from 'src/libs/enum/team.roles';
import { INSERT_FAILED } from 'src/libs/exceptions/messages';
import { BoardUserGuard } from 'src/libs/guards/boardRoles.guard';
import JwtAuthenticationGuard from 'src/libs/guards/jwtAuth.guard';
import RequestWithUser from 'src/libs/interfaces/requestWithUser.interface';
Expand All @@ -18,7 +17,6 @@ import { BoardResponse } from 'src/modules/boards/swagger/board.swagger';
import { BoardRoles } from 'src/modules/communication/dto/types';
import SocketGateway from 'src/modules/socket/gateway/socket.gateway';
import {
BadRequestException,
Body,
Controller,
Delete,
Expand Down Expand Up @@ -133,15 +131,11 @@ export default class BoardsController {
@Param() { boardId }: BaseParam,
@Body() { boardTitle }: { boardTitle: string }
) {
const board = await this.duplicateBoardUseCase.execute({
return this.duplicateBoardUseCase.execute({
nunocaseiro marked this conversation as resolved.
Show resolved Hide resolved
boardId,
userId: request.user._id,
boardTitle
});

if (!board) throw new BadRequestException(INSERT_FAILED);

return board;
}

@ApiOperation({ summary: 'Get Boards to show on dashboard' })
Expand Down
33 changes: 5 additions & 28 deletions frontend/src/components/Boards/MyBoards/index.tsx
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
import React, { useEffect, useMemo, useRef } from 'react';
import { useInfiniteQuery } from '@tanstack/react-query';
import { useRecoilState, useRecoilValue, useSetRecoilState } from 'recoil';
import { useRecoilState, useRecoilValue } from 'recoil';

import { getBoardsRequest } from '@/api/boardService';
import EmptyBoards from '@/components/Dashboard/RecentRetros/partials/EmptyBoards';
import { toastState } from '@/store/toast/atom/toast.atom';
import BoardType from '@/types/board/board';
import { Team } from '@/types/team/team';
import { ToastStateEnum } from '@/utils/enums/toast-types';
import isEmpty from '@/utils/isEmpty';
import { useRouter } from 'next/router';
import { teamsListState } from '@/store/team/atom/team.atom';
import { filterTeamBoardsState } from '@/store/board/atoms/board.atom';
import useBoard from '@/hooks/useBoard';
import FilterBoards from '../Filters/FilterBoards';
import ListBoardsByTeam from './ListBoardsByTeam';
import ListBoards from './ListBoards';
Expand All @@ -27,34 +24,14 @@ export interface OptionType {
label: string;
}

const MyBoards = React.memo<MyBoardsProps>(({ userId, isSuperAdmin }) => {
const setToastState = useSetRecoilState(toastState);
const MyBoards = ({ userId, isSuperAdmin }: MyBoardsProps) => {
const [filterState, setFilterState] = useRecoilState(filterTeamBoardsState);
const scrollRef = useRef<HTMLDivElement>(null);
const router = useRouter();
const routerTeam = router.query.team as string;
const userTeamsList = useRecoilValue(teamsListState);

const fetchBoards = useInfiniteQuery(
['boards'],
({ pageParam = 0 }) => getBoardsRequest(pageParam),
{
enabled: true,
refetchOnWindowFocus: false,
getNextPageParam: (lastPage) => {
const { hasNextPage, page } = lastPage;
if (hasNextPage) return page + 1;
return undefined;
},
onError: () => {
setToastState({
open: true,
content: 'Error getting the boards',
type: ToastStateEnum.ERROR,
});
},
},
);
const { fetchBoards } = useBoard({ autoFetchBoards: true });

const { data, isLoading } = fetchBoards;

Expand Down Expand Up @@ -129,6 +106,6 @@ const MyBoards = React.memo<MyBoardsProps>(({ userId, isSuperAdmin }) => {
)}
</>
);
});
};

export default MyBoards;
6 changes: 3 additions & 3 deletions frontend/src/components/CardBoard/CardBody/CardEnd.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ const CardEnd: React.FC<CardEndProps> = React.memo(

const {
deleteBoard,
duplicateBoard: { mutate: duplicate },
} = useBoard({ autoFetchBoard: false });
duplicateBoard: { mutate: duplicateMutation },
} = useBoard();

const boardTypeCaption = useMemo(() => {
if (isSubBoard && !isDashboard) return 'Responsible';
Expand Down Expand Up @@ -83,7 +83,7 @@ const CardEnd: React.FC<CardEndProps> = React.memo(
};

const handleDuplicateBoard = (boardTitle: string) => {
duplicate({ boardId: board._id, boardTitle });
duplicateMutation({ boardId: board._id, boardTitle });
};

if (isDashboard) {
Expand Down
72 changes: 43 additions & 29 deletions frontend/src/hooks/useBoard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,31 @@ import {
deleteBoardRequest,
duplicateBoardRequest,
getBoardRequest,
getBoardsRequest,
updateBoardPhaseRequest,
updateBoardRequest,
} from '@/api/boardService';
import { handleNewBoardUser } from '@/helper/board/transformBoard';
import { newBoardState } from '@/store/board/atoms/board.atom';
import { operationsQueueAtom } from '@/store/operations/atom/operations-queue.atom';
import BoardType, { PhaseChangeEventType } from '@/types/board/board';
import BoardType, { InfiniteBoards, PhaseChangeEventType } from '@/types/board/board';
import { BoardUser } from '@/types/board/board.user';
import UseBoardType from '@/types/board/useBoard';
import { BoardPhases } from '@/utils/enums/board.phases';
import { ToastStateEnum } from '@/utils/enums/toast-types';
import { InfiniteData, useMutation, useQuery } from '@tanstack/react-query';
import { InfiniteData, useInfiniteQuery, useMutation, useQuery } from '@tanstack/react-query';

import useBoardUtils from './useBoardUtils';

interface AutoFetchProps {
autoFetchBoard: boolean;
autoFetchBoard?: boolean;
autoFetchBoards?: boolean;
}

const useBoard = ({ autoFetchBoard = false }: AutoFetchProps): UseBoardType => {
const useBoard = ({
autoFetchBoard = false,
autoFetchBoards = false,
}: AutoFetchProps = {}): UseBoardType => {
const { boardId, queryClient, setToastState } = useBoardUtils();

const setNewBoard = useSetRecoilState(newBoardState);
Expand Down Expand Up @@ -68,6 +73,27 @@ const useBoard = ({ autoFetchBoard = false }: AutoFetchProps): UseBoardType => {
},
});

const fetchBoards = useInfiniteQuery(
['boards'],
({ pageParam = 0 }) => getBoardsRequest(pageParam),
{
enabled: autoFetchBoards,
refetchOnWindowFocus: false,
getNextPageParam: (lastPage) => {
const { hasNextPage, page } = lastPage;
if (hasNextPage) return page + 1;
return undefined;
},
onError: () => {
setToastState({
open: true,
content: 'Error getting the boards',
type: ToastStateEnum.ERROR,
});
},
},
);

const createBoard = useMutation(createBoardRequest, {
onSuccess: (data) => setNewBoard(data._id),
onError: () => {
Expand All @@ -80,7 +106,7 @@ const useBoard = ({ autoFetchBoard = false }: AutoFetchProps): UseBoardType => {
});

const duplicateBoard = useMutation(duplicateBoardRequest, {
onSuccess: () => {
onSuccess: async () => {
queryClient.invalidateQueries(['boards']);
jpvsalvador marked this conversation as resolved.
Show resolved Hide resolved

setToastState({
Expand All @@ -100,30 +126,17 @@ const useBoard = ({ autoFetchBoard = false }: AutoFetchProps): UseBoardType => {

const deleteBoard = useMutation(deleteBoardRequest, {
onSuccess: (data, variables) => {
queryClient.setQueryData(
['boards'],
(
oldData:
| InfiniteData<{
boards: BoardType[];
hasNextPage: boolean;
page: number;
}>
| undefined,
) => {
if (!oldData) return { pages: [], pageParams: [] };

return {
...oldData,
pages: oldData.pages.map((page) => ({
...page,
boards: page.boards.filter((board) => board._id !== variables.id),
})),
};
},
);

queryClient.invalidateQueries(['boards']);
queryClient.setQueryData(['boards'], (oldData: InfiniteData<InfiniteBoards> | undefined) => {
if (!oldData) return { pages: [], pageParams: [] };

return {
...oldData,
pages: oldData.pages.map((page) => ({
...page,
boards: page.boards.filter((board) => board._id !== variables.id),
})),
};
});

setToastState({
open: true,
Expand Down Expand Up @@ -215,6 +228,7 @@ const useBoard = ({ autoFetchBoard = false }: AutoFetchProps): UseBoardType => {
deleteBoard,
updateBoard,
fetchBoard,
fetchBoards,
setQueryDataAddBoardUser,
updateBoardPhase,
updateBoardPhaseMutation,
Expand Down
6 changes: 6 additions & 0 deletions frontend/src/types/board/board.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,9 @@ export type PhaseChangeEventType = {
columns: ColumnType[];
submitedAt: Date;
};

export interface InfiniteBoards {
boards: BoardType[];
hasNextPage: boolean;
page: number;
}
5 changes: 4 additions & 1 deletion frontend/src/types/board/useBoard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ import BoardType, {
CreateBoardDto,
DuplicateBoardType,
GetBoardResponse,
InfiniteBoards,
PhaseChangeEventType,
UpdateBoardType,
} from '@/types/board/board';
import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
import { UseInfiniteQueryResult, UseMutationResult, UseQueryResult } from '@tanstack/react-query';

import { BoardUser } from './board.user';
import UpdateBoardPhaseDto from './updateBoardPhase.dto';
Expand All @@ -27,6 +28,8 @@ export default interface UseBoardType {
>;
fetchBoard: UseQueryResult<GetBoardResponse | null, unknown>;

fetchBoards: UseInfiniteQueryResult<InfiniteBoards, unknown>;

setQueryDataAddBoardUser: (data: BoardUser) => void;

updateBoardPhase: (data: PhaseChangeEventType) => void;
Expand Down