feat(ActionMenu<Scan>): ds-437 add download report button

The button shall only be enabled when the scan is completed. Also touch showScansModal to use the helper 'canDownloadReport' to decide if the report can be downloaded. Relates to JIRA: DISCOVERY-437
quipucords · Nov 14, 2024 · 04965c7 · 04965c7
1 parent 00cdac8
commit 04965c7
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 10 deletions.
diff --git a/public/locales/en.json b/public/locales/en.json
@@ -173,6 +173,7 @@
     "label_satellite": "Satellite",
     "label_rhacs": "RHACS",
     "label_rescan": "Rescan",
+    "label_download": "Download",
     "label_scan": "Scan",
     "label_source": "Source",
     "label_source_other": "Sources",

diff --git a/src/components/actionMenu/actionMenu.tsx b/src/components/actionMenu/actionMenu.tsx
@@ -11,7 +11,7 @@ import { EllipsisVIcon } from '@patternfly/react-icons';
 
 interface ActionMenuProps<T = unknown> {
   item: T;
-  actions: { label: string; onClick: (item: T) => void }[];
+  actions: { label: string; onClick: (item: T) => void; disabled?: boolean }[];
 }
 
 const ActionMenu = <T,>({ item, actions }: ActionMenuProps<T>) => {
@@ -43,6 +43,7 @@ const ActionMenu = <T,>({ item, actions }: ActionMenuProps<T>) => {
             onClick={() => {
               a.onClick(item);
             }}
+            isDisabled={a.disabled}
           >
             {a.label}
           </DropdownItem>

diff --git a/src/helpers/helpers.ts b/src/helpers/helpers.ts
@@ -233,10 +233,7 @@ const getTitleImg = (isBrand = UI_BRAND) => ((isBrand && titleImgBrand) || title
  * @returns {boolean}
  */
 const canDownloadReport = (job?: scanJob | MostRecentScan) => {
-  if (job && job.status === 'completed' && job.report_id) {
-    return true;
-  }
-  return false;
+  return job?.status === 'completed' && job?.report_id !== undefined;
 };
 
 const helpers = {

diff --git a/src/types/types.ts b/src/types/types.ts
@@ -181,9 +181,9 @@ export type StatusDetails = {
   job_status_message: string;
 };
 
-// TODO: the object returned from the API representing scanJob and MostRecentScan are the same;
-// consider this in a future refactor. Also, MostRecentScan is a ScanJob, not a scan. Yeah, quipucords
-// is confusing...
+// TODO: Considerations for a future refactor: merge and/or rename scanJob and MostRecentScan.
+// Reason: the object returned from the api representing scanJob and MostRecentScan are the same;
+// also, in quipucords jargon, MostRecentScan is a ScanJob, not a Scan.
 export type MostRecentScan = {
   id: number;
   report_id: number;

diff --git a/src/views/scans/__tests__/showScansModal.test.tsx b/src/views/scans/__tests__/showScansModal.test.tsx
@@ -16,7 +16,7 @@ describe('ShowScansModal', () => {
         scanJobs={[
           {
             id: 12345,
-            status: 'DOLOR SIT',
+            status: 'completed',
             start_time: new Date('2024-09-06'),
             end_time: new Date('2024-09-06'),
             report_id: 67890

diff --git a/src/views/scans/showScansModal.tsx b/src/views/scans/showScansModal.tsx
@@ -131,7 +131,7 @@ const ShowScansModal: React.FC<ShowScansModalProps> = ({
                   <Td dataLabel="Scan Time">{helpers.formatDate(job.end_time || job.start_time)}</Td>
                   <Td dataLabel="Scan Result">{job.status}</Td>
                   <Td dataLabel="Download" isActionCell>
-                    {job.report_id && job.end_time && (
+                    {helpers.canDownloadReport(job) && (
                       <Button onClick={() => onDownload(job.report_id)} icon={<DownloadIcon />} variant="link">
                         Download
                       </Button>

diff --git a/src/views/scans/viewScansList.tsx b/src/views/scans/viewScansList.tsx
@@ -250,6 +250,15 @@ const ScansListView: React.FunctionComponent = () => {
                             setScanSelected(undefined);
                           });
                         }
+                      },
+                      {
+                        label: t('table.label', { context: 'download' }),
+                        disabled: !helpers.canDownloadReport(scan?.most_recent),
+                        onClick: () => {
+                          if (scan?.most_recent) {
+                            downloadReport(scan.most_recent.report_id);
+                          }
+                        }
                       }
                     ]}
                   />