18789341118

Committed 24 Oct 2025 06:57PM UTC coverage: 78.178% (+15.5%) from 62.703%

Build # 18789341118

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #888 from CBIIT/3.4.0

3.4.0 Release

Run Details

4977 of 5488 branches covered (90.69%)

Branch coverage included in aggregate %.

8210 of 9264 new or added lines in 257 files covered. (88.62%)

6307 existing lines in 120 files now uncovered.

30203 of 39512 relevant lines covered (76.44%)

213.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.47

/src/content/dataSubmissions/QualityControl.tsx

import { useLazyQuery, useQuery } from "@apollo/client";
import { Box, Button, Stack, styled, TableCell } from "@mui/material";
import { isEqual } from "lodash";
import { useSnackbar } from "notistack";
import React, {
  FC,
  MutableRefObject,
  useCallback,
  useEffect,
  useMemo,
  useRef,
  useState,
} from "react";

import { TOOLTIP_TEXT } from "@/config/DashboardTooltips";

import { useSubmissionContext } from "../../components/Contexts/SubmissionContext";
import { ExportValidationButton } from "../../components/DataSubmissions/ExportValidationButton";
import QualityControlFilters from "../../components/DataSubmissions/QualityControlFilters";
import DoubleLabelSwitch from "../../components/DoubleLabelSwitch";
import ErrorDetailsDialog, { ErrorDetailsIssue } from "../../components/ErrorDetailsDialog/v2";
import GenericTable, { Column } from "../../components/GenericTable";
import NodeComparison from "../../components/NodeComparison";
import PVRequestButton from "../../components/PVRequestButton";
import StyledTooltip from "../../components/StyledFormComponents/StyledTooltip";
import TruncatedText from "../../components/TruncatedText";
import { ValidationErrorCodes } from "../../config/ValidationErrors";
import {
  AGGREGATED_SUBMISSION_QC_RESULTS,
  SUBMISSION_QC_RESULTS,
  AggregatedSubmissionQCResultsInput,
  AggregatedSubmissionQCResultsResp,
  SubmissionQCResultsInput,
  SubmissionQCResultsResp,
  GET_PENDING_PVS,
  GetPendingPVsInput,
  GetPendingPVsResponse,
} from "../../graphql";
import { FormatDate, Logger, titleCase } from "../../utils";

import QCResultsContext from "./Contexts/QCResultsContext";

type FilterForm = {
  issueType: string;
  /**
   * The node type to filter by.
   *
   * @default "All"
   */
  nodeType: string;
  batchID: number | "All";
  severity: QCResult["severity"] | "All";
};

const StyledErrorDetailsButton = styled(Button)({
  display: "inline",
  color: "#0B6CB1",
  fontFamily: "'Nunito', 'Rubik', sans-serif",
  fontSize: "16px",
  fontStyle: "normal",
  fontWeight: 600,
  lineHeight: "19px",
  padding: 0,
  textDecorationLine: "underline",
  textTransform: "none",
  marginLeft: "auto",
  paddingLeft: "8px",
  "&:hover": {
    background: "transparent",
    textDecorationLine: "underline",
  },
});

const StyledNodeType = styled(Box)({
  display: "flex",
  alignItems: "center",
  textTransform: "capitalize",
});

const StyledSeverity = styled(Box)({
  display: "flex",
  alignItems: "center",
});

const StyledBreakAll = styled(Box)({
  wordBreak: "break-all",
});

const StyledIssuesTextWrapper = styled(Box)({
  whiteSpace: "nowrap",
  wordBreak: "break-word",
});

const StyledDateTooltip = styled(StyledTooltip)(() => ({
  cursor: "pointer",
}));

const StyledPvButtonWrapper = styled(Box)({
  marginLeft: "89px",
});

const StyledOthersText = styled("span")({
  display: "inline",
  textDecoration: "underline",
  cursor: "pointer",
  color: "#0B6CB1",
  whiteSpace: "nowrap",
  fontSize: "14px",
  fontStyle: "normal",
  fontWeight: 600,
  lineHeight: "19px",
});

const StyledHeaderCell = styled(TableCell)({
  fontWeight: 700,
  fontSize: "14px",
  lineHeight: "16px",
  color: "#fff !important",
  padding: "22px 4px",
  verticalAlign: "top",
  "&.MuiTableCell-root:first-of-type": {
    paddingTop: "22px",
    paddingRight: "4px",
    paddingBottom: "22px",
    color: "#fff !important",
  },
  "& .MuiSvgIcon-root, & .MuiButtonBase-root": {
    color: "#fff !important",
  },
});

const StyledTableCell = styled(TableCell)({
  fontSize: "14px",
  color: "#083A50 !important",
  "&.MuiTableCell-root": {
    padding: "14px 4px 12px",
    overflowWrap: "anywhere",
    whiteSpace: "nowrap",
  },
  "&:last-of-type": {
    paddingRight: "4px",
  },
});

type RowData = QCResult | AggregatedQCResult;

const aggregatedColumns: Column<AggregatedQCResult>[] = [
  {
    label: "Issue Type",
    renderValue: (data) => <TruncatedText text={data.title} maxCharacters={50} />,
    field: "title",
  },
  {
    label: "Severity",
    renderValue: (data) => (
      <StyledSeverity color={data?.severity === "Error" ? "#B54717" : "#8D5809"}>
        {data?.severity}
      </StyledSeverity>
    ),
    field: "severity",
  },
  {
    label: "Record Count",
    renderValue: (data) =>
      Intl.NumberFormat("en-US", { maximumFractionDigits: 0 }).format(data.count || 0),
    field: "count",
    default: true,
  },
  {
    label: "Expand",
    renderValue: (data) => (
      <QCResultsContext.Consumer>
        {({ handleExpandClick }) => (
          <StyledErrorDetailsButton
            onClick={() => handleExpandClick?.(data)}
            variant="text"
            disableRipple
            disableTouchRipple
            disableFocusRipple
          >
            Expand
          </StyledErrorDetailsButton>
        )}
      </QCResultsContext.Consumer>
    ),
    fieldKey: "expand",
    sortDisabled: true,
    sx: {
      width: "104px",
      textAlign: "center",
    },
  },
];

const expandedColumns: Column<QCResult>[] = [
  {
    label: "Batch ID",
    renderValue: (data) => <StyledBreakAll>{data?.displayID}</StyledBreakAll>,
    field: "displayID",
    default: true,
    sx: {
      width: "110px",
    },
  },
  {
    label: "Node Type",
    renderValue: (data) => (
      <StyledNodeType>
        <TruncatedText text={data?.type} maxCharacters={12} disableInteractiveTooltip={false} />
      </StyledNodeType>
    ),
    field: "type",
  },
  {
    label: "Submitted Identifier",
    renderValue: (data) => (
      <TruncatedText
        text={data?.submittedID}
        maxCharacters={15}
        disableInteractiveTooltip={false}
      />
    ),
    field: "submittedID",
  },
  {
    label: "Severity",
    renderValue: (data) => (
      <StyledSeverity color={data?.severity === "Error" ? "#B54717" : "#8D5809"}>
        {data?.severity}
      </StyledSeverity>
    ),
    field: "severity",
    sx: {
      width: "87px",
    },
  },
  {
    label: "Validated Date",
    renderValue: (data) =>
      data.validatedDate ? (
        <StyledDateTooltip
          title={FormatDate(data.validatedDate, "M/D/YYYY h:mm A")}
          placement="top"
        >
          <span>{FormatDate(data.validatedDate, "M/D/YYYY")}</span>
        </StyledDateTooltip>
      ) : (
        ""
      ),
    field: "validatedDate",
    sx: {
      width: "132px",
    },
  },
  {
    label: "Issue Count",
    renderValue: (data) =>
      Intl.NumberFormat("en-US", { maximumFractionDigits: 0 }).format(data.issueCount || 0),
    field: "issueCount",
    sx: {
      width: "110px",
    },
  },
  {
    label: "Issue(s)",
    renderValue: (data) =>
      (data?.errors?.length > 0 || data?.warnings?.length > 0) && (
        <QCResultsContext.Consumer>
          {({ handleOpenErrorDialog }) => (
            <Stack direction="row" justifyContent="space-between">
              <StyledIssuesTextWrapper>
                <TruncatedText
                  text={data.errors?.[0]?.title || data.warnings?.[0]?.title}
                  maxCharacters={30}
                  wrapperSx={{ display: "inline" }}
                  labelSx={{ display: "inline" }}
                  disableInteractiveTooltip={false}
                />
                {data.issueCount > 1 ? (
                  <>
                    {" and "}
                    <StyledTooltip
                      title={TOOLTIP_TEXT.QUALITY_CONTROL.TABLE.CLICK_TO_VIEW_ALL_ISSUES}
                      placement="top"
                      disableInteractive
                      arrow
                    >
                      <StyledOthersText
                        onClick={() => handleOpenErrorDialog?.(data)}
                        data-testid="others-text"
                      >
                        other {data.issueCount - 1}
                      </StyledOthersText>
                    </StyledTooltip>
                  </>
                ) : null}
              </StyledIssuesTextWrapper>

              <StyledErrorDetailsButton
                onClick={() => handleOpenErrorDialog?.(data)}
                variant="text"
                disableRipple
                disableTouchRipple
                disableFocusRipple
              >
                See details.
              </StyledErrorDetailsButton>
            </Stack>
          )}
        </QCResultsContext.Consumer>
      ),
    sortDisabled: true,
  },
];

// CSV columns used for exporting table data
export const csvColumns = {
  "Batch ID": (d: QCResult) => d.displayID,
  "Node Type": (d: QCResult) => d.type,
  "Submitted Identifier": (d: QCResult) => d.submittedID,
  Severity: (d: QCResult) => d.severity,
  "Validated Date": (d: QCResult) => FormatDate(d?.validatedDate, "MM-DD-YYYY [at] hh:mm A", ""),
  Issues: (d: QCResult) => {
    const value = d.errors[0]?.description ?? d.warnings[0]?.description;

    // NOTE: The ErrorMessage descriptions contain non-standard double quotes
    // that don't render correctly in Excel. This replaces them with standard double quotes.
    return value.replaceAll(/[“”‟〞＂]/g, `"`);
  },
};

export const aggregatedCSVColumns = {
  "Issue Type": (d: AggregatedQCResult) => d.title,
  Severity: (d: AggregatedQCResult) => d.severity,
  Count: (d: AggregatedQCResult) => d.count,
};

const QualityControl: FC = () => {
  const { enqueueSnackbar } = useSnackbar();
  const { data: submissionData } = useSubmissionContext();
  const {
    _id: submissionId,
    status: submissionStatus,
    metadataValidationStatus,
    fileValidationStatus,
  } = submissionData?.getSubmission || {};

  const [loading, setLoading] = useState<boolean>(false);
  const [data, setData] = useState<RowData[]>([]);
  const [prevData, setPrevData] = useState<FetchListing<RowData>>(null);
  const [totalData, setTotalData] = useState(0);
  const [openErrorDialog, setOpenErrorDialog] = useState<boolean>(false);
  const [selectedRow, setSelectedRow] = useState<RowData | null>(null);
  const [isAggregated, setIsAggregated] = useState<boolean>(true);
  const [issueType, setIssueType] = useState<string | null>("All");
  const filtersRef: MutableRefObject<FilterForm> = useRef({
    issueType: "All",
    batchID: "All",
    nodeType: "All",
    severity: "All",
  });
  const tableRef = useRef<TableMethods>(null);

  const [submissionQCResults] = useLazyQuery<SubmissionQCResultsResp, SubmissionQCResultsInput>(
    SUBMISSION_QC_RESULTS,
    {
      context: { clientName: "backend" },
      fetchPolicy: "cache-and-network",
    }
  );

  const [aggregatedSubmissionQCResults] = useLazyQuery<
    AggregatedSubmissionQCResultsResp,
    AggregatedSubmissionQCResultsInput
  >(AGGREGATED_SUBMISSION_QC_RESULTS, {
    context: { clientName: "backend" },
    fetchPolicy: "cache-and-network",
  });

  const {
    data: pendingPVs,
    refetch: refetchPendingPVs,
    updateQuery: updatePendingPVs,
  } = useQuery<GetPendingPVsResponse, GetPendingPVsInput>(GET_PENDING_PVS, {
    variables: { submissionID: submissionId },
    context: { clientName: "backend" },
    fetchPolicy: "cache-and-network",
    notifyOnNetworkStatusChange: true,
    skip: !submissionId,
  });

  const handleFetchQCResults = async (fetchListing: FetchListing<QCResult>, force: boolean) => {
    const { first, offset, sortDirection, orderBy } = fetchListing || {};
    if (!force && data?.length > 0 && isEqual(fetchListing, prevData)) {
      return;
    }

    setPrevData(fetchListing);

    try {
      setLoading(true);

      const { data: d, error } = await submissionQCResults({
        variables: {
          id: submissionId,
          first,
          offset,
          sortDirection,
          orderBy,
          issueCode:
            !filtersRef.current.issueType || filtersRef.current.issueType === "All"
              ? undefined
              : filtersRef.current.issueType,
          nodeTypes:
            !filtersRef.current.nodeType || filtersRef.current.nodeType === "All"
              ? undefined
              : [filtersRef.current.nodeType],
          batchIDs:
            !filtersRef.current.batchID || filtersRef.current.batchID === "All"
              ? undefined
              : [filtersRef.current.batchID],
          severities: filtersRef.current.severity || "All",
        },
        context: { clientName: "backend" },
        fetchPolicy: "no-cache",
      });
      if (error || !d?.submissionQCResults) {
        throw new Error("Unable to retrieve submission quality control results.");
      }
      setData(d.submissionQCResults.results);
      setTotalData(d.submissionQCResults.total);
    } catch (err) {
      enqueueSnackbar(err?.toString(), { variant: "error" });
    } finally {
      setLoading(false);
    }
  };

  const handleFetchAggQCResults = async (
    fetchListing: FetchListing<AggregatedQCResult>,
    force: boolean
  ) => {
    const { first, offset, sortDirection, orderBy } = fetchListing || {};

    if (!force && data?.length > 0 && isEqual(fetchListing, prevData)) {
      return;
    }

    setPrevData(fetchListing);

    try {
      setLoading(true);

      const { data: d, error } = await aggregatedSubmissionQCResults({
        variables: {
          submissionID: submissionId,
          severity: filtersRef.current.severity?.toLowerCase() || "all",
          first,
          offset,
          sortDirection,
          orderBy,
        },
        context: { clientName: "backend" },
        fetchPolicy: "no-cache",
      });
      if (error || !d?.aggregatedSubmissionQCResults) {
        throw new Error("Unable to retrieve submission aggregated quality control results.");
      }
      setData(d.aggregatedSubmissionQCResults.results);
      setTotalData(d.aggregatedSubmissionQCResults.total);
    } catch (err) {
      Logger.error(`QualityControl: ${err?.toString()}`);
      enqueueSnackbar(err?.toString(), { variant: "error" });
    } finally {
      setLoading(false);
    }
  };

  const handleFetchData = (fetchListing: FetchListing<RowData>, force: boolean) => {
    if (!submissionId || !filtersRef.current) {
      return;
    }

    isAggregated
      ? handleFetchAggQCResults(fetchListing, force)
      : handleFetchQCResults(fetchListing, force);
  };

  const handleOpenErrorDialog = (data: QCResult) => {
    setOpenErrorDialog(true);
    setSelectedRow(data);
  };

  const Actions = useMemo<React.ReactNode>(
    () => (
      <Stack direction="row" alignItems="center" gap="8px" marginRight="37px">
        <ExportValidationButton
          submission={submissionData?.getSubmission}
          fields={isAggregated ? aggregatedCSVColumns : csvColumns}
          isAggregated={isAggregated}
          disabled={totalData <= 0}
        />
      </Stack>
    ),
    [submissionData?.getSubmission, totalData, isAggregated]
  );

  const handleOnFiltersChange = (data: FilterForm) => {
    filtersRef.current = data;
    tableRef.current?.setPage(0, true);
  };

  const onSwitchToggle = () => {
    setIsAggregated((prev) => {
      const newVal = !prev;
      // Reset to 'All' when in Aggregated view
      if (newVal === true) {
        setIssueType("All");
      }

      return newVal;
    });
  };

  const currentColumns = useMemo(
    () => (isAggregated ? aggregatedColumns : expandedColumns),
    [isAggregated]
  ) as Column<RowData>[];

  const handleExpandClick = (issue: AggregatedQCResult) => {
    if (!issue?.code) {
      Logger.error("QualityControl: Unable to expand invalid issue.");
      return;
    }

    setIssueType(issue?.code);
    setIsAggregated(false);
  };

  const providerValue = useMemo(
    () => ({
      handleOpenErrorDialog,
      handleExpandClick,
    }),
    [handleOpenErrorDialog, handleExpandClick]
  );

  const handleNewPVRequest = useCallback(
    (offendingProperty: string, offendingValue: string) => {
      updatePendingPVs((prev) => ({
        getPendingPVs: [
          ...(prev?.getPendingPVs || []),
          { id: `${Date.now()}`, offendingProperty, value: offendingValue },
        ],
      }));

      // NOTE: We refetch after small delay to allow cache to propagate
      setTimeout(refetchPendingPVs, 2000);
    },
    [updatePendingPVs, refetchPendingPVs]
  );

  const issueList = useMemo<ErrorDetailsIssue[]>(() => {
    if (!selectedRow || !("errors" in selectedRow) || !("warnings" in selectedRow)) {
      return [];
    }

    const allIssues: ErrorDetailsIssue[] = [];
    selectedRow.errors?.forEach((e) => {
      const issue: ErrorDetailsIssue = { severity: "error", message: e.description };

      if (e.code === ValidationErrorCodes.INVALID_PERMISSIBLE) {
        const isDisabled = pendingPVs?.getPendingPVs?.some(
          (pv) => pv.offendingProperty === e.offendingProperty && pv.value === e.offendingValue
        );

        issue.action = (
          <StyledPvButtonWrapper>
            <PVRequestButton
              onSubmit={handleNewPVRequest}
              offendingProperty={e.offendingProperty}
              offendingValue={e.offendingValue}
              nodeName={selectedRow.type}
              disabled={isDisabled}
            />
          </StyledPvButtonWrapper>
        );
      }

      allIssues.push(issue);
    });
    selectedRow.warnings?.forEach((w) => {
      const issue: ErrorDetailsIssue = { severity: "warning", message: w.description };

      if (w.code === ValidationErrorCodes.UPDATING_DATA && submissionStatus !== "Completed") {
        issue.action = (
          <NodeComparison
            nodeType={selectedRow.type}
            submissionID={submissionId}
            submittedID={selectedRow.submittedID}
          />
        );
      }

      allIssues.push(issue);
    });

    return allIssues;
  }, [selectedRow, submissionStatus, pendingPVs, handleNewPVRequest]);

  useEffect(() => {
    tableRef.current?.refresh();
  }, [metadataValidationStatus, fileValidationStatus]);

  return (
    <>
      <QualityControlFilters
        onChange={handleOnFiltersChange}
        issueType={issueType}
        isAggregated={isAggregated}
      />

      <QCResultsContext.Provider value={providerValue}>
        <GenericTable
          ref={tableRef}
          columns={currentColumns}
          data={data || []}
          total={totalData || 0}
          loading={loading}
          defaultRowsPerPage={20}
          defaultOrder="desc"
          position="both"
          CustomTableHeaderCell={StyledHeaderCell}
          CustomTableBodyCell={StyledTableCell}
          noContentText="No validation issues found. Either no validation has been conducted yet, or all issues have been resolved."
          setItemKey={(item, idx) => `${idx}_${"title" in item ? item?.title : item?.batchID}`}
          onFetchData={handleFetchData}
          AdditionalActions={{
            top: {
              before: (
                <DoubleLabelSwitch
                  leftLabel="Aggregated"
                  rightLabel="Expanded"
                  id="table-state-switch"
                  data-testid="table-view-switch"
                  checked={!isAggregated}
                  onChange={onSwitchToggle}
                  inputProps={{ "aria-label": "Aggregated or Expanded table view switch" }}
                />
              ),
              after: Actions,
            },
            bottom: {
              after: Actions,
            },
          }}
          containerProps={{ sx: { marginBottom: "8px" } }}
        />
      </QCResultsContext.Provider>
      {!isAggregated && (
        <ErrorDetailsDialog
          open={openErrorDialog}
          onClose={() => setOpenErrorDialog(false)}
          preHeader="Data Submission"
          header="Validation Issues"
          postHeader={`For ${titleCase((selectedRow as QCResult)?.type)}${
            (selectedRow as QCResult)?.type?.toLocaleLowerCase() !== "data file" ? " Node" : ""
          } ID ${(selectedRow as QCResult)?.submittedID}`}
          issues={issueList}
        />
      )}
    </>
  );
};

export default React.memo(QualityControl);

CBIIT / crdc-datahub-ui / 18789341118

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous