All files / components/RosterStudent RosterStudentTable.jsx

100% Statements 82/82
100% Branches 30/30
100% Functions 20/20
100% Lines 80/80

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341                            4x 4x                     470x 470x 470x 470x 470x 470x   470x   470x 470x   470x   470x 152x     470x 3x 3x     470x         470x                       470x 1x     470x 1x     470x 1x 1x     470x 1x 1x     470x           470x 1x 1x     470x 1x           470x           470x 1x 1x     470x 1x     470x                                                     737x                 536x                       485x       470x 737x     42x   6x   6x   6x   6x   6x   6x   6x   6x   12x   12x   6x 6x   42x             470x       737x 737x 18x         719x 29x               690x 19x         671x 18x         653x 81x           572x                       470x   470x 370x 370x         470x                                                                                         1880x                                                            
import React from "react";
import OurTable, { ButtonColumn } from "main/components/OurTable";
import { Tooltip, OverlayTrigger, Form } from "react-bootstrap";
import OurPagination from "main/components/Common/OurPagination";
 
import { useBackendMutation } from "main/utils/useBackend";
import { cellToAxiosParamsDelete } from "main/utils/rosterStudentUtils";
import { useSectionLabels } from "main/utils/sectionsUtils";
import { hasRole } from "main/utils/currentUser";
import Modal from "react-bootstrap/Modal";
import RosterStudentForm from "main/components/RosterStudent/RosterStudentForm";
import { toast } from "react-toastify";
import RosterStudentDeleteModal from "main/components/RosterStudent/RosterStudentDeleteModal";
 
const PAGE_SIZE_OPTIONS = [10, 25, 50, 100];
const DEFAULT_PAGE_SIZE = 100;
 
export default function RosterStudentTable({
  students,
  totalStudents,
  currentUser,
  courseId,
  testIdPrefix = "RosterStudentTable",
  canEditStudents,
  translateSections = false,
}) {
  const [showEditModal, setShowEditModal] = React.useState(false);
  const [editStudent, setEditStudent] = React.useState(null);
  const [showDeleteModal, setShowDeleteModal] = React.useState(false);
  const [deleteStudent, setDeleteStudent] = React.useState(null);
  const [pageSize, setPageSize] = React.useState(DEFAULT_PAGE_SIZE);
  const [currentPage, setCurrentPage] = React.useState(1);
 
  const translateSection = useSectionLabels(courseId, translateSections);
 
  const studentCount = totalStudents ?? students.length;
  const isFiltered = studentCount !== students.length;
 
  const totalPages = Math.max(1, Math.ceil(students.length / pageSize));
 
  React.useEffect(() => {
    setCurrentPage((prevPage) => Math.min(prevPage, totalPages));
  }, [totalPages]);
 
  const handlePageSizeChange = (event) => {
    setPageSize(Number(event.target.value));
    setCurrentPage(1);
  };
 
  const paginatedStudents = students.slice(
    (currentPage - 1) * pageSize,
    currentPage * pageSize,
  );
 
  const cellToAxiosParamsEdit = (formData) => ({
    url: `/api/rosterstudents/update`,
    method: "PUT",
    params: {
      studentId: formData.studentId,
      firstName: formData.firstName,
      lastName: formData.lastName,
      section: formData.section,
      id: formData.id,
    },
  });
 
  const hideEditModal = () => {
    setShowEditModal(false);
  };
 
  const hideDeleteModal = () => {
    setShowDeleteModal(false);
  };
 
  const onEditSuccess = () => {
    toast("Student updated successfully.");
    hideEditModal();
  };
 
  const onDeleteSuccess = () => {
    toast("Student deleted successfully.");
    hideDeleteModal();
  };
 
  const deleteMutation = useBackendMutation(
    cellToAxiosParamsDelete,
    { onSuccess: onDeleteSuccess },
    [`/api/rosterstudents/course/${courseId}`],
  );
 
  const deleteCallback = async (cell) => {
    setShowDeleteModal(true);
    setDeleteStudent(cell.row.original.id);
  };
 
  const submitDeleteForm = (data) => {
    deleteMutation.mutate({
      id: deleteStudent,
      ...data,
    });
  };
 
  const editMutation = useBackendMutation(
    cellToAxiosParamsEdit,
    { onSuccess: onEditSuccess },
    [`/api/rosterstudents/course/${courseId}`],
  );
 
  const editCallback = (cell) => {
    setEditStudent(cell.row.original);
    setShowEditModal(true);
  };
 
  const submitEditForm = (data) => {
    editMutation.mutate(data);
  };
 
  const columns = [
    {
      header: "id",
      accessorKey: "id",
      id: "id",
    },
 
    {
      header: "Student Id",
      accessorKey: "studentId",
    },
 
    {
      header: "First Name",
      accessorKey: "firstName",
    },
    {
      header: "Last Name",
      accessorKey: "lastName",
    },
    {
      header: "Email",
      accessorKey: "email",
    },
    {
      header: "Section",
      accessorKey: "section",
      cell: ({ cell }) => translateSection(cell.row.original.section),
    },
    {
      header: "GitHub Login",
      accessorKey: "githubLogin",
    },
    {
      id: "teams",
      header: () => (
        <OverlayTrigger
          placement="right"
          overlay={
            <Tooltip id={`tooltip-teams-header`}>
              A list of teams that the student is a member of.
            </Tooltip>
          }
        >
          <span>Teams</span>
        </OverlayTrigger>
      ),
      accessorFn: (row) =>
        Array.isArray(row.teams) ? row.teams.join(", ") : "",
    },
  ];
 
  const renderTooltip = (orgStatus) =>
    function TooltipWrapper(props) {
      let set_message;
 
      switch (orgStatus) {
        case "PENDING":
          set_message =
            "Student cannot join the course until it has been completely set up.";
          break;
        case "JOINCOURSE":
          set_message =
            "Student has been prompted to join, but hasn't yet clicked the 'Join Course' button to generate an invite to the organization.";
          break;
        case "INVITED":
          set_message =
            "Student has generated an invite, but has not yet accepted or declined the invitation.";
          break;
        case "OWNER":
          set_message =
            "Student is an owner of the GitHub organization associated with this course.";
          break;
        case "MEMBER":
          set_message =
            "Student is a member of the GitHub organization associated with this course.";
          break;
        default:
          set_message = "Tooltip for illegal status that will never occur";
          break;
      }
      return (
        <Tooltip id={`${orgStatus.toLowerCase()}-tooltip`} {...props}>
          {set_message}
        </Tooltip>
      );
    };
 
  columns.push({
    header: "Status",
    accessorKey: "orgStatus",
    cell: ({ cell }) => {
      const status = cell.row.original.orgStatus;
      if (status === "PENDING") {
        return (
          <OverlayTrigger placement="right" overlay={renderTooltip("PENDING")}>
            <span className="text-danger">Pending</span>
          </OverlayTrigger>
        );
      } else if (status === "JOINCOURSE") {
        return (
          <OverlayTrigger
            placement="right"
            overlay={renderTooltip("JOINCOURSE")}
          >
            <span className="text-primary">Join Course</span>
          </OverlayTrigger>
        );
      } else if (status === "INVITED") {
        return (
          <OverlayTrigger placement="right" overlay={renderTooltip("INVITED")}>
            <span className="text-primary">Invited</span>
          </OverlayTrigger>
        );
      } else if (status === "OWNER") {
        return (
          <OverlayTrigger placement="right" overlay={renderTooltip("OWNER")}>
            <span style={{ color: "purple" }}>Owner</span>
          </OverlayTrigger>
        );
      } else if (status === "MEMBER") {
        return (
          <OverlayTrigger placement="right" overlay={renderTooltip("MEMBER")}>
            <span className="text-success">Member</span>
          </OverlayTrigger>
        );
      }
      return (
        <OverlayTrigger
          placement="right"
          overlay={renderTooltip(cell.row.original.orgStatus)}
        >
          <span>{status}</span>
        </OverlayTrigger>
      );
    },
  });
 
  const canEditRoster =
    canEditStudents ?? hasRole(currentUser, "ROLE_INSTRUCTOR");
 
  if (canEditRoster) {
    columns.push(ButtonColumn("Edit", "primary", editCallback, testIdPrefix));
    columns.push(
      ButtonColumn("Delete", "danger", deleteCallback, testIdPrefix),
    );
  }
 
  return (
    <>
      <Modal show={showEditModal} onHide={hideEditModal}>
        <Modal.Header closeButton>
          <Modal.Title>Edit Student</Modal.Title>
        </Modal.Header>
        <Modal.Body
          className={"pb-3"}
          data-testid={`${testIdPrefix}-modal-body`}
        >
          <RosterStudentForm
            initialContents={editStudent}
            submitAction={submitEditForm}
            buttonLabel={"Update"}
            cancelDisabled={true}
            courseId={courseId}
            translateSections={translateSections}
          />
        </Modal.Body>
      </Modal>
      <RosterStudentDeleteModal
        showModal={showDeleteModal}
        toggleShowModal={setShowDeleteModal}
        onSubmitAction={submitDeleteForm}
      />
      <div className="d-flex justify-content-between align-items-center mb-2">
        <h4 className="mb-0" data-testid={`${testIdPrefix}-count-heading`}>
          Students ({studentCount} total)
          {isFiltered && ` (${students.length} shown)`}
        </h4>
        <div className="d-flex align-items-center">
          <Form.Label
            htmlFor={`${testIdPrefix}-pageSizeSelect`}
            className="me-2 mb-0"
          >
            Page Size:
          </Form.Label>
          <Form.Select
            id={`${testIdPrefix}-pageSizeSelect`}
            data-testid={`${testIdPrefix}-pageSizeSelect`}
            style={{ width: "auto" }}
            value={pageSize}
            onChange={handlePageSizeChange}
          >
            {PAGE_SIZE_OPTIONS.map((size) => (
              <option key={size} value={size}>
                {size}
              </option>
            ))}
          </Form.Select>
        </div>
      </div>
      <OurTable
        data={paginatedStudents}
        columns={columns}
        testid={testIdPrefix}
      />
      {totalPages > 1 && (
        <div className="d-flex justify-content-center mb-2">
          <OurPagination
            currentActivePage={currentPage}
            updateActivePage={setCurrentPage}
            totalPages={totalPages}
            testId={`${testIdPrefix}-pagination`}
          />
        </div>
      )}
      <div
        style={{ display: "none" }}
        data-testid={`${testIdPrefix}-courseId`}
        data-course-id={`${courseId}`}
      />
    </>
  );
}