feat: Removed IDV Status details call

openedx · Sep 11, 2024 · b917d40 · b917d40
1 parent c6ed509
commit b917d40
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 84 deletions.
diff --git a/src/users/VerifiedName.jsx b/src/users/VerifiedName.jsx
@@ -10,13 +10,68 @@ import {
 import PageLoading from '../components/common/PageLoading';
 import Table from '../components/Table';
 import { formatDate } from '../utils';
-import { getVerifiedNameHistory, getVerificationAttemptDetailsById } from './data/api';
+import { getVerifiedNameHistory } from './data/api';
+
+const verifiedNameColumns = [
+  {
+    Header: 'Verified Name',
+    accessor: 'verifiedName',
+  },
+  {
+    Header: 'Status',
+    accessor: 'status',
+  },
+  {
+    Header: 'Verification Type',
+    accessor: 'verificationType',
+  },
+  {
+    Header: 'History',
+    accessor: 'history',
+  },
+];
+
+const verifiedNameHistoryColumns = [
+  {
+    Header: 'Verified Name',
+    accessor: 'verifiedName',
+  },
+  {
+    Header: 'Profile Name',
+    accessor: 'profileName',
+  },
+  {
+    Header: 'Status',
+    accessor: 'status',
+  },
+  {
+    Header: 'IDV Attempt ID',
+    accessor: 'idvAttemptId',
+  },
+  {
+    Header: 'Proctoring Attempt ID',
+    accessor: 'proctoringAttemptId',
+  },
+  {
+    Header: 'Created At',
+    accessor: 'createdAt',
+  },
+];
+
+// Human readable formatter for the status. Possible status list on:
+// https://github.com/edx/edx-solutions-edx-platform/blob/0ebc69f86548a44b7947decfe308032028721907/lms/djangoapps/verify_student/models.py#L104
+const idvStatusFormat = status => {
+  // Capitalize first letter
+  const properStatus = `${status.at(0).toUpperCase()}${status?.slice(1)}`;
+
+  // Replace underscores with spaces
+  return properStatus.replace('_', ' ');
+};
 
 export default function VerifiedName({ username }) {
   const [verifiedNameData, setVerifiedNameData] = useState(null);
   const [verifiedNameHistoryData, setVerifiedNameHistoryData] = useState([]);
   const [isModalOpen, setIsModalOpen] = useState(false);
-  const [verificationAttemptDetails, setVerificationAttemptDetails] = useState({});
 
   useEffect(() => {
     let isMounted = true;
@@ -45,10 +100,9 @@ export default function VerifiedName({ username }) {
           trigger="hover"
           overlay={(
             <Popover id={`${result.verificationAttemptId}-details-tooltip`} aria-hidden="true">
-              <Popover.Title as="h5">{verificationAttemptDetails[result.verificationAttemptId].status}</Popover.Title>
-              <Popover.Content data-testid="verificationAttemptTooltip">
-                {verificationAttemptDetails[result.verificationAttemptId].message}
-              </Popover.Content>
+              <Popover.Title data-testid="verificationAttemptTooltipTitle">
+                {result.verificationAttemptStatus ? idvStatusFormat(result.verificationAttemptStatus) : 'Missing data'}
+              </Popover.Title>
             </Popover>
           )}
         >
@@ -60,71 +114,14 @@ export default function VerifiedName({ username }) {
       proctoringAttemptId: result.proctoredExamAttemptId,
       createdAt: formatDate(result.created),
     }),
-  ), [verifiedNameHistoryData, verificationAttemptDetails]);
+  ), [verifiedNameHistoryData]);
 
   // Modal to display verified name history
   const openVerifiedNameModal = async (data) => {
-    for (let idx = 0; idx < data.length; idx++) {
-      const historyItem = data[idx];
-      if (historyItem.verificationAttemptId && !(historyItem.verificationAttemptId in verificationAttemptDetails)) {
-        // eslint-disable-next-line no-await-in-loop
-        await getVerificationAttemptDetailsById(historyItem.verificationAttemptId).then((response) => {
-          const camelCaseDetailsData = camelCaseObject(response);
-          verificationAttemptDetails[historyItem.verificationAttemptId] = camelCaseDetailsData;
-          setVerificationAttemptDetails(verificationAttemptDetails);
-        });
-      }
-    }
     setVerifiedNameHistoryData(data);
     setIsModalOpen(true);
   };
 
-  const verifiedNameColumns = useMemo(() => [
-    {
-      Header: 'Verified Name',
-      accessor: 'verifiedName',
-    },
-    {
-      Header: 'Status',
-      accessor: 'status',
-    },
-    {
-      Header: 'Verification Type',
-      accessor: 'verificationType',
-    },
-    {
-      Header: 'History',
-      accessor: 'history',
-    },
-  ], []);
-
-  const verifiedNameHistoryColumns = useMemo(() => [
-    {
-      Header: 'Verified Name',
-      accessor: 'verifiedName',
-    },
-    {
-      Header: 'Profile Name',
-      accessor: 'profileName',
-    },
-    {
-      Header: 'Status',
-      accessor: 'status',
-    },
-    {
-      Header: 'IDV Attempt ID',
-      accessor: 'idvAttemptId',
-    },
-    {
-      Header: 'Proctoring Attempt ID',
-      accessor: 'proctoringAttemptId',
-    },
-    {
-      Header: 'Created At',
-      accessor: 'createdAt',
-    },
-  ], []);
-
   const verifiedNameParsedData = useMemo(() => [{
     verifiedName: (
       verifiedNameData?.verifiedName || verifiedNameData?.error || 'Error while fetching data'

diff --git a/src/users/VerifiedName.test.jsx b/src/users/VerifiedName.test.jsx
@@ -35,13 +35,7 @@ describe('Verified Name', () => {
       history: verifiedNameHistory.results,
     };
 
-    const idVerificationAttemptDetails = {
-      status: 'denied',
-      message: '[{"generalReasons": ["Name mismatch"]}]',
-    };
-
     jest.spyOn(api, 'getVerifiedNameHistory').mockResolvedValueOnce(verifiedNameData);
-    jest.spyOn(api, 'getVerificationAttemptDetailsById').mockResolvedValueOnce(idVerificationAttemptDetails);
     render(<VerifiedNameWrapper {...props} />);
 
     const historyButton = await screen.findByText('Show');
@@ -63,16 +57,7 @@ describe('Verified Name', () => {
       verificationType: 'Proctoring',
       history: verifiedNameHistory.results,
     };
-    const idVerificationAttemptDetails = {
-      status: 'denied',
-      message: '[{"generalReasons": ["Name mismatch"]}]',
-    };
     jest.spyOn(api, 'getVerifiedNameHistory').mockResolvedValueOnce(verifiedNameData);
-    const getVerificationAPICallSpy = jest.spyOn(
-      api,
-      'getVerificationAttemptDetailsById',
-    ).mockResolvedValueOnce(idVerificationAttemptDetails);
-
     await act(async () => {
       render(<VerifiedNameWrapper {...props} />);
     });
@@ -82,15 +67,13 @@ describe('Verified Name', () => {
       fireEvent.click(historyButton);
     });
 
-    expect(getVerificationAPICallSpy).toHaveBeenCalledWith(
-      verifiedNameHistory.results[1].verification_attempt_id,
-    );
-
     const hoverLink = await screen.getByText(verifiedNameHistory.results[1].verification_attempt_id);
     await act(async () => {
       fireEvent.mouseOver(hoverLink);
     });
 
-    await screen.getByTestId('verificationAttemptTooltip');
+    await screen.getByTestId('verificationAttemptTooltipTitle');
+
+    expect(screen.getByText('Must retry')).toBeTruthy();
   });
 });
diff --git a/src/users/data/test/verifiedNameHistory.js b/src/users/data/test/verifiedNameHistory.js
@@ -5,6 +5,7 @@ const verifiedNameHistory = {
       verified_name: 'Jonathan Doe',
       profile_name: 'Jon Doe',
       verification_attempt_id: null,
+      verification_attempt_status: null,
       proctored_exam_attempt_id: 123,
       status: 'approved',
     },
@@ -13,6 +14,7 @@ const verifiedNameHistory = {
       verified_name: 'J Doe',
       profile_name: 'Jon Doe',
       verification_attempt_id: 456,
+      verification_attempt_status: 'must_retry',
       proctored_exam_attempt_id: null,
       status: 'denied',
     },