Merge pull request #1346 from Northeastern-Electric-Racing/#1244-set-leads-endpoint

#1244: set teams lead

Author: RChandler234

src/backend/src/controllers/teams.controllers.ts

@@ -62,4 +62,16 @@ export default class TeamsController {
       next(error);
     }
   }
+
+  static async setTeamLeads(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { userIds } = req.body;
+      const { teamId } = req.params;
+      const submitter = await getCurrentUser(res);
+      const team = await TeamsService.setTeamLeads(submitter, teamId, userIds);
+      return res.status(200).json(team);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/routes/teams.routes.ts

@@ -15,6 +15,13 @@ teamsRouter.post(
   validateInputs,
   TeamsController.setTeamMembers
 );
+teamsRouter.post(
+  '/:teamId/set-leads',
+  body('userIds').isArray(),
+  intMinZero(body('userIds.*')),
+  validateInputs,
+  TeamsController.setTeamLeads
+);
 teamsRouter.post(
   '/:teamId/edit-description',
   body('newDescription').isString(),

src/backend/src/services/teams.services.ts

@@ -162,4 +162,53 @@ export default class TeamsService {
 
     return teamTransformer(updateTeam);
   }
+
+  /**
+   * Update the given teamId's team's leads
+   * @param submitter a user who's making this request
+   * @param teamId a id of team to be updated
+   * @param userIds a array of user Ids that replaces team's old leads
+   * @returns an updated team
+   * @throws if the team is not found, the submitter has no privilege, or any user from the given userIds does not exist
+   */
+  static async setTeamLeads(submitter: User, teamId: string, userIds: number[]): Promise<Team> {
+    const team = await prisma.team.findUnique({
+      where: { teamId },
+      ...teamQueryArgs
+    });
+
+    const newLeads = await getUsers(userIds);
+
+    if (!team) throw new NotFoundException('Team', teamId);
+
+    if (!isAdmin(submitter.role) && submitter.userId !== team.headId) {
+      throw new AccessDeniedException('You must be an admin or the head to update the lead!');
+    }
+
+    if (newLeads.map((lead) => lead.userId).includes(team.headId)) {
+      throw new HttpException(400, 'A lead cannot be the head of the team!');
+    }
+
+    if (team.members.map((member) => member.userId).some((memberId) => userIds.includes(memberId))) {
+      throw new HttpException(400, 'A lead cannot be a member of the team!');
+    }
+
+    const transformedLeads = newLeads.map((lead) => {
+      return {
+        userId: lead.userId
+      };
+    });
+
+    const updateTeam = await prisma.team.update({
+      where: { teamId },
+      data: {
+        leads: {
+          set: transformedLeads
+        }
+      },
+      ...teamQueryArgs
+    });
+
+    return teamTransformer(updateTeam);
+  }
 }

src/backend/tests/teams.test.ts

@@ -1,9 +1,18 @@
 import TeamsService from '../src/services/teams.services';
 import prisma from '../src/prisma/prisma';
 import * as teamsTransformer from '../src/transformers/teams.transformer';
-import { prismaTeam1, sharedTeam1, justiceLeague } from './test-data/teams.test-data';
+import { prismaTeam1, sharedTeam1, justiceLeague, primsaTeam2 } from './test-data/teams.test-data';
 import teamQueryArgs from '../src/prisma-query-args/teams.query-args';
-import { batman, flash, greenlantern, superman, theVisitor, wonderwoman } from './test-data/users.test-data';
+import {
+  alfred,
+  aquaman,
+  batman,
+  flash,
+  greenlantern,
+  superman,
+  theVisitor,
+  wonderwoman
+} from './test-data/users.test-data';
 import * as userUtils from '../src/utils/users.utils';
 import { AccessDeniedException, HttpException } from '../src/utils/errors.utils';
 import teamTransformer from '../src/transformers/teams.transformer';
@@ -208,4 +217,77 @@ describe('Teams', () => {
       expect(res).toStrictEqual(sharedTeam1);
     });
   });
+
+  describe('setTeamLeads', () => {
+    test('setTeamLeads submitter is not the head or admin', async () => {
+      vi.spyOn(prisma.team, 'findUnique').mockResolvedValue(prismaTeam1);
+      vi.spyOn(prisma.user, 'findMany').mockResolvedValue([theVisitor]);
+      vi.spyOn(prisma.team, 'findMany').mockResolvedValue([prismaTeam1, primsaTeam2, justiceLeague]);
+
+      const callSetTeamLeads = async () =>
+        await TeamsService.setTeamLeads(wonderwoman, prismaTeam1.teamId, [theVisitor.userId]);
+
+      const expectedException = new HttpException(
+        400,
+        'Access Denied: You must be an admin or the head to update the lead!'
+      );
+
+      await expect(callSetTeamLeads).rejects.toThrow(expectedException);
+    });
+
+    test('setTeamLeads lead is a member', async () => {
+      vi.spyOn(prisma.team, 'findUnique').mockResolvedValue(prismaTeam1);
+      vi.spyOn(prisma.user, 'findMany').mockResolvedValue([aquaman]);
+      vi.spyOn(prisma.team, 'findMany').mockResolvedValue([prismaTeam1, primsaTeam2, justiceLeague]);
+
+      const callSetTeamLeads = async () => await TeamsService.setTeamLeads(flash, sharedTeam1.teamId, [aquaman.userId]);
+
+      const expectedException = new HttpException(400, 'A lead cannot be a member of the team!');
+
+      await expect(callSetTeamLeads).rejects.toThrow(expectedException);
+    });
+
+    test('setTeamLeads lead is a head', async () => {
+      vi.spyOn(prisma.team, 'findUnique').mockResolvedValue(justiceLeague);
+      vi.spyOn(userUtils, 'getUsers').mockResolvedValue([batman]);
+      vi.spyOn(prisma.team, 'findMany').mockResolvedValue([prismaTeam1, primsaTeam2, justiceLeague]);
+
+      const callSetTeamLeads = async () => await TeamsService.setTeamLeads(alfred, justiceLeague.teamId, [batman.userId]);
+
+      const expectedException = new HttpException(400, 'A lead cannot be the head of the team!');
+
+      await expect(callSetTeamLeads).rejects.toThrow(expectedException);
+    });
+
+    test('setTeamLeads works', async () => {
+      vi.spyOn(prisma.team, 'findUnique').mockResolvedValue(prismaTeam1);
+      vi.spyOn(prisma.team, 'update').mockResolvedValue(prismaTeam1);
+      vi.spyOn(userUtils, 'getUsers').mockResolvedValue([greenlantern, theVisitor]);
+      vi.spyOn(prisma.team, 'findMany').mockResolvedValue([prismaTeam1, primsaTeam2, justiceLeague]);
+
+      const teamId = 'id1';
+      const userIds = [
+        {
+          userId: 5
+        },
+        {
+          userId: 7
+        }
+      ];
+      const res = await TeamsService.setTeamLeads(flash, sharedTeam1.teamId, [5, 7]);
+
+      expect(prisma.team.findUnique).toHaveBeenCalledTimes(1);
+      expect(prisma.team.update).toHaveBeenCalledTimes(1);
+      expect(prisma.team.update).toHaveBeenCalledWith({
+        where: { teamId },
+        data: {
+          leads: {
+            set: userIds
+          }
+        },
+        ...teamQueryArgs
+      });
+      expect(res).toStrictEqual(sharedTeam1);
+    });
+  });
 });

src/frontend/src/apis/teams.api.ts

@@ -36,3 +36,9 @@ export const setTeamHead = (id: string, userId: number) => {
     userId
   });
 };
+
+export const setTeamLeads = (id: string, userIds: number[]) => {
+  return axios.post<Team>(apiUrls.teamsSetLeads(id), {
+    userIds
+  });
+};

src/frontend/src/hooks/teams.hooks.ts

@@ -5,7 +5,14 @@
 
 import { useQuery, useQueryClient, useMutation } from 'react-query';
 import { Team } from 'shared';
-import { getAllTeams, getSingleTeam, setTeamMembers, setTeamDescription, setTeamHead } from '../apis/teams.api';
+import {
+  getAllTeams,
+  getSingleTeam,
+  setTeamMembers,
+  setTeamDescription,
+  setTeamHead,
+  setTeamLeads
+} from '../apis/teams.api';
 
 export const useAllTeams = () => {
   return useQuery<Team[], Error>(['teams'], async () => {
@@ -67,3 +74,19 @@ export const useEditTeamDescription = (teamId: string) => {
     }
   );
 };
+
+export const useSetTeamLeads = (teamId: string) => {
+  const queryClient = useQueryClient();
+  return useMutation<Team, Error, any>(
+    ['teams', 'edit'],
+    async (userIds: number[]) => {
+      const { data } = await setTeamLeads(teamId, userIds);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['teams']);
+      }
+    }
+  );
+};

src/frontend/src/pages/TeamsPage/TeamMembersPageBlock.tsx

@@ -5,10 +5,9 @@
 
 import { Autocomplete, Box, Grid, IconButton, TextField, Typography } from '@mui/material';
 import { useState } from 'react';
-import { useAuth } from '../../hooks/auth.hooks';
-import { useAllUsers } from '../../hooks/users.hooks';
-import { useSetTeamHead, useSetTeamMembers } from '../../hooks/teams.hooks';
-import { isAdmin, isHead, Team, User } from 'shared';
+import { useAllUsers, useCurrentUser } from '../../hooks/users.hooks';
+import { useSetTeamHead, useSetTeamLeads, useSetTeamMembers } from '../../hooks/teams.hooks';
+import { isAdmin, isHead, isLeadership, Team, User } from 'shared';
 import { fullNamePipe } from '../../utils/pipes';
 import { Cancel, Edit, Save } from '@mui/icons-material';
 import LoadingIndicator from '../../components/LoadingIndicator';
@@ -27,22 +26,26 @@ const userToAutocompleteOption = (user: User): { label: string; id: string } =>
 };
 
 const TeamMembersPageBlock: React.FC<TeamMembersPageBlockProps> = ({ team }) => {
-  const auth = useAuth();
+  const user = useCurrentUser();
   const [isEditingMembers, setIsEditingMembers] = useState(false);
   const [isEditingHead, setIsEditingHead] = useState(false);
+  const [isEditingLeads, setIsEditingLeads] = useState(false);
   const [members, setMembers] = useState(team.members.map(userToAutocompleteOption));
   const [head, setHead] = useState(userToAutocompleteOption(team.head));
+  const [leads, setLeads] = useState(team.leads.map(userToAutocompleteOption));
 
   const { isLoading: allUsersIsLoading, isError: allUsersIsError, error: allUsersError, data: users } = useAllUsers();
   const { isLoading: setTeamMembersIsLoading, mutateAsync: setTeamMembersMutateAsync } = useSetTeamMembers(team.teamId);
   const { isLoading: setTeamHeadIsLoading, mutateAsync: setTeamHeadMutateAsync } = useSetTeamHead(team.teamId);
+  const { isLoading: setTeamLeadsIsLoading, mutateAsync: setTeamLeadsMutateAsync } = useSetTeamLeads(team.teamId);
 
   const toast = useToast();
 
   if (allUsersIsError) return <ErrorPage message={allUsersError?.message} />;
-  if (allUsersIsLoading || setTeamMembersIsLoading || setTeamHeadIsLoading || !users) return <LoadingIndicator />;
+  if (allUsersIsLoading || setTeamMembersIsLoading || setTeamHeadIsLoading || setTeamLeadsIsLoading || !users)
+    return <LoadingIndicator />;
 
-  const hasPerms = auth.user && (isAdmin(auth.user.role) || auth.user.userId === team.head.userId);
+  const hasPerms = isAdmin(user.role) || user.userId === team.head.userId;
 
   const memberOptions = users
     .filter((user) => user.userId !== team.head.userId && !team.leads.map((lead) => lead.userId).includes(user.userId))
@@ -54,6 +57,11 @@ const TeamMembersPageBlock: React.FC<TeamMembersPageBlockProps> = ({ team }) =>
     .sort((a, b) => (a.firstName > b.firstName ? 1 : -1))
     .map(userToAutocompleteOption);
 
+  const leadOptions = users
+    .filter((user) => memberOptions.some((option) => parseInt(option.id) === user.userId) && isLeadership(user.role))
+    .sort((a, b) => (a.firstName > b.firstName ? 1 : -1))
+    .map(userToAutocompleteOption);
+
   const submitHead = async () => {
     try {
       await setTeamHeadMutateAsync(parseInt(head.id));
@@ -72,6 +80,15 @@ const TeamMembersPageBlock: React.FC<TeamMembersPageBlockProps> = ({ team }) =>
     }
   };
 
+  const submitLeads = async () => {
+    try {
+      await setTeamLeadsMutateAsync(leads.map((lead) => parseInt(lead.id)));
+      setIsEditingLeads(false);
+    } catch (error) {
+      error instanceof Error && toast.error(error.message);
+    }
+  };
+
   const EditingHeadView = () => (
     <Grid container spacing={1}>
       <Grid item>
@@ -132,6 +149,37 @@ const TeamMembersPageBlock: React.FC<TeamMembersPageBlockProps> = ({ team }) =>
     </Box>
   );
 
+  const EditingLeadsView = () => (
+    <Box>
+      <Typography sx={{ fontWeight: 'bold' }} display="inline">
+        Leads:
+      </Typography>
+      <Grid container direction={'row'}>
+        <Grid item xs={9} md={10} lg={11}>
+          <Autocomplete
+            isOptionEqualToValue={(option, value) => option.id === value.id}
+            filterSelectedOptions
+            multiple
+            id="tags-standard"
+            options={leadOptions}
+            value={leads}
+            onChange={(_event, newValue) => setLeads(newValue)}
+            getOptionLabel={(option) => option.label}
+            renderInput={(params) => <TextField {...params} variant="standard" placeholder="Select A Lead" />}
+          />
+        </Grid>
+        <Grid container xs={3} md={2} lg={1}>
+          <Grid item>
+            <IconButton children={<Save />} onClick={submitLeads} />
+          </Grid>
+          <Grid item>
+            <IconButton children={<Cancel />} onClick={() => setIsEditingLeads(false)} />
+          </Grid>
+        </Grid>
+      </Grid>
+    </Box>
+  );
+
   const NonEditingHeadView = () => (
     <Grid container>
       <Grid item>
@@ -144,7 +192,14 @@ const TeamMembersPageBlock: React.FC<TeamMembersPageBlockProps> = ({ team }) =>
   );
 
   const NonEditingLeadsView = () => (
-    <DetailDisplay label="Leads" content={team.leads.map((lead) => fullNamePipe(lead)).join(', ')} />
+    <Grid container>
+      <Grid item xs={11} lg="auto">
+        <DetailDisplay label="Leads" content={team.leads.map((lead) => fullNamePipe(lead)).join(', ')} />
+      </Grid>
+      <Grid item xs={1} mt={-1}>
+        {hasPerms && <IconButton children={<Edit />} onClick={() => setIsEditingLeads(true)} />}
+      </Grid>
+    </Grid>
   );
 
   const NonEditingMembersView = () => (
@@ -161,7 +216,7 @@ const TeamMembersPageBlock: React.FC<TeamMembersPageBlockProps> = ({ team }) =>
   return (
     <PageBlock title={'People'}>
       {isEditingHead ? <EditingHeadView /> : <NonEditingHeadView />}
-      <NonEditingLeadsView />
+      {isEditingLeads ? <EditingLeadsView /> : <NonEditingLeadsView />}
       {isEditingMembers ? <EditingMembersView /> : <NonEditingMembersView />}
     </PageBlock>
   );

src/frontend/src/utils/urls.ts

@@ -72,6 +72,7 @@ const teamsById = (id: string) => `${teams()}/${id}`;
 const teamsSetMembers = (id: string) => `${teamsById(id)}/set-members`;
 const teamsSetHead = (id: string) => `${teamsById(id)}/set-head`;
 const teamsSetDescription = (id: string) => `${teamsById(id)}/edit-description`;
+const teamsSetLeads = (id: string) => `${teamsById(id)}/set-leads`;
 
 /**************** Description Bullet Endpoints ****************/
 const descriptionBullets = () => `${API_URL}/description-bullets`;
@@ -156,6 +157,7 @@ export const apiUrls = {
   teamsSetMembers,
   teamsSetHead,
   teamsSetDescription,
+  teamsSetLeads,
 
   descriptionBulletsCheck,