[PRMP-915] download report feature to support review report

app/cypress/e2e/0-ndr-core-tests/download_lloyd_george_summary.cy.js

@@ -33,7 +33,7 @@ describe('GP Workflow: Download Lloyd George summary report', () => {
 
                     cy.wait('@downloadReportFinished', { timeout: 20000 });
 
-                    cy.url().should('contain', Cypress.config('baseUrl') + `${routes.createReportComplete}?reportType=0`);
+                    cy.url().should('contain', Cypress.config('baseUrl') + `${routes.createReportComplete}?reportType=PATIENT`);
                 },
             );
         });

app/cypress/e2e/1-ndr-smoke-tests/gp_user_workflows/download_lloyd_george_summary_report_workflow.cy.js

@@ -33,7 +33,7 @@ describe('GP Workflow: Download Lloyd George summary report', () => {
 
                 cy.url().should(
                     'contain',
-                    Cypress.config('baseUrl') + `${routes.createReportComplete}?reportType=0`,
+                    Cypress.config('baseUrl') + `${routes.createReportComplete}?reportType=PATIENT`,
                 );
 
                 cy.getByTestId('logout-btn').click();

app/cypress/support/e2e.ts

@@ -122,7 +122,7 @@ Cypress.Commands.add('navigateToDownloadReportPage', () => {
     cy.getByTestId('download-report-btn').should('exist');
     cy.getByTestId('download-report-btn').click();
 
-    cy.url().should('contain', baseUrl + `${routes.createReport}?reportType=0`);
+    cy.url().should('contain', baseUrl + `${routes.createReport}?reportType=PATIENT`);
 });
 
 declare global {

app/src/components/blocks/_admin/reviewsPage/ReviewsPage.test.tsx

@@ -732,4 +732,18 @@ describe('ReviewsPage', () => {
             });
         });
     });
+
+    describe('Report Download Link', () => {
+        it('renders download report link with correct href', async () => {
+            renderComponent();
+
+            await waitFor(() => {
+                expect(screen.getByText('900 000 0001')).toBeInTheDocument();
+            });
+
+            const downloadLink = screen.getByText('Download a report on this data');
+            expect(downloadLink).toBeInTheDocument();
+            expect(downloadLink).toHaveAttribute('href', '/create-report?reportType=REVIEW');
+        });
+    });
 });

app/src/components/blocks/_admin/reviewsPage/ReviewsPage.tsx

@@ -19,6 +19,7 @@ import BackButton from '../../../generic/backButton/BackButton';
 import { Pagination } from '../../../generic/paginationV2/Pagination';
 import SpinnerButton from '../../../generic/spinnerButton/SpinnerButton';
 import SpinnerV2 from '../../../generic/spinnerV2/SpinnerV2';
+import { REPORT_TYPE } from '../../../../types/generic/reports';
 import { AxiosError } from 'axios';
 import { errorToParams } from '../../../../helpers/utils/errorToParams';
 
@@ -292,6 +293,13 @@ export const ReviewsPage = ({ setReviewData }: ReviewsPageProps): React.JSX.Elem
             </p>
 
             <Table.Panel heading="Documents to review" className="reviews-page" allowFullScreen>
+                <div className="nhsuk-u-text-align-right">
+                    <a
+                        href={`${routes.REPORT_DOWNLOAD}?reportType=${REPORT_TYPE.ODS_REVIEW_SUMMARY}`}
+                    >
+                        Download a report on this data
+                    </a>
+                </div>
                 {/* Search box */}
                 <form
                     id="search-form"

app/src/components/blocks/_downloadReport/downloadReportSelectStage/DownloadReportSelectStage.test.tsx

@@ -12,7 +12,6 @@ import { beforeEach, describe, expect, it, vi, MockedFunction, Mock } from 'vite
 const mockDownloadReport = downloadReport as MockedFunction<typeof downloadReport>;
 const mockUseConfig = vi.fn();
 
-
 const mockedUseNavigate = vi.fn();
 vi.mock('react-router-dom', async () => {
     const actual = await vi.importActual('react-router-dom');
@@ -46,7 +45,7 @@ describe('DownloadReportSelectStage', () => {
             const report = getReportByType(REPORT_TYPE.ODS_PATIENT_SUMMARY);
             render(<DownloadReportSelectStage report={report!} />);
 
-            expect(screen.getByTestId('return-to-home-button')).toBeInTheDocument();
+            expect(screen.getByTestId('go-back-button')).toBeInTheDocument();
             const title = screen.getByTestId('title');
             expect(title).toBeInTheDocument();
             expect(title.innerHTML).toContain(report!.title);
@@ -56,7 +55,7 @@ describe('DownloadReportSelectStage', () => {
                 ).toBeInTheDocument();
             });
             expect(screen.queryByTestId('error-notification-banner')).not.toBeInTheDocument();
-            expect(screen.getByText('Go to home')).toBeInTheDocument();
+            expect(screen.getByText('Go back')).toBeInTheDocument();
         });
 
         it('should render error notification when download fails', async () => {
@@ -107,33 +106,16 @@ describe('DownloadReportSelectStage', () => {
         });
     });
 
-    it('should navigate to home when clicking go to home link', async () => {
+    it('should navigate to back when clicking go back link', async () => {
         const report = getReportByType(REPORT_TYPE.ODS_PATIENT_SUMMARY);
         render(<DownloadReportSelectStage report={report!} />);
-
-        await userEvent.click(screen.getByText('Go to home'));
-        await waitFor(() => {
-            expect(mockedUseNavigate).toHaveBeenCalledWith(routes.HOME);
-        });
-    });
-
-    it ('should navigate to admin hub, upload version 3 enabled', async () => {
-        mockUseConfig.mockReturnValue({
-            featureFlags: { uploadDocumentIteration3Enabled: true },
-        });
-
-        const report = getReportByType(REPORT_TYPE.ODS_PATIENT_SUMMARY);
-        render(<DownloadReportSelectStage report={report!} />);
-
         let backLink: Element;
-        backLink = screen.getByTestId('return-to-home-button');
-
+        backLink = screen.getByTestId('go-back-button');
         expect(backLink).toHaveTextContent('Go back');
 
         await userEvent.click(backLink);
-
         await waitFor(() => {
-            expect(mockedUseNavigate).toHaveBeenCalledWith(routes.ADMIN_ROUTE);
-        })
+            expect(mockedUseNavigate).toHaveBeenCalledWith(-1);
+        });
     });
 });

app/src/components/blocks/_downloadReport/downloadReportSelectStage/DownloadReportSelectStage.tsx

@@ -1,17 +1,17 @@
 import { useNavigate } from 'react-router-dom';
 import { FileTypeData, ReportData } from '../../../../types/generic/reports';
 import { routeChildren, routes } from '../../../../types/generic/routes';
-import { BackLink, Button } from 'nhsuk-react-components';
+import { Button } from 'nhsuk-react-components';
 import downloadReport from '../../../../helpers/requests/downloadReport';
 import useBaseAPIUrl from '../../../../helpers/hooks/useBaseAPIUrl';
 import useBaseAPIHeaders from '../../../../helpers/hooks/useBaseAPIHeaders';
-import useConfig from '../../../../helpers/hooks/useConfig';
 import { AxiosError } from 'axios';
 import { isMock } from '../../../../helpers/utils/isLocal';
 import { JSX, ReactNode, useRef } from 'react';
 import NotificationBanner from '../../../layout/notificationBanner/NotificationBanner';
 import SpinnerButton from '../../../generic/spinnerButton/SpinnerButton';
 import React from 'react';
+import BackButton from '../../../generic/backButton/BackButton';
 
 type Props = {
     report: ReportData;
@@ -20,7 +20,6 @@ type Props = {
 const DownloadReportSelectStage = (props: Props): JSX.Element => {
     const baseUrl = useBaseAPIUrl();
     const baseHeaders = useBaseAPIHeaders();
-    const config = useConfig();
     const navigate = useNavigate();
     const [downloading, setDownloading] = React.useState(false);
     const [downloadError, setDownloadError] = React.useState<ReactNode>(null);
@@ -30,7 +29,6 @@ const DownloadReportSelectStage = (props: Props): JSX.Element => {
         navigate(`${routeChildren.REPORT_DOWNLOAD_COMPLETE}?reportType=${props.report.reportType}`);
     };
 
-    const uploadV3Enabled: boolean = !!config.featureFlags.uploadDocumentIteration3Enabled;
     const noDataContent = (): JSX.Element => {
         return (
             <>
@@ -88,7 +86,12 @@ const DownloadReportSelectStage = (props: Props): JSX.Element => {
         setDownloading(true);
 
         try {
-            await downloadReport({ report: props.report, fileType, baseUrl, baseHeaders });
+            await downloadReport({
+                report: props.report,
+                fileType,
+                baseUrl,
+                baseHeaders,
+            });
             handleSuccess();
         } catch (e) {
             const error = e as AxiosError;
@@ -129,17 +132,7 @@ const DownloadReportSelectStage = (props: Props): JSX.Element => {
 
     return (
         <>
-            <BackLink
-                data-testid="return-to-home-button"
-                asElement="a"
-                href='#'
-                onClick={(): void => {
-                    uploadV3Enabled ? navigate(routes.ADMIN_ROUTE) : navigate(routes.HOME);
-                }}
-                className="mb-5"
-            >
-                {uploadV3Enabled ? 'Go back' : 'Go to home'}
-            </BackLink>
+            <BackButton dataTestid="go-back-button"></BackButton>
             {downloadError && (
                 <NotificationBanner
                     title="Important"

app/src/components/blocks/_downloadReport/downloadReportSelectStage/ReportDescriptions/ReviewSummaryDescription.tsx

@@ -0,0 +1,15 @@
+const ReviewSummaryDescription = (): React.JSX.Element => {
+    return (
+        <>
+            <p>This report contains:</p>
+            <ul className="ml-3">
+                <li>
+                    the details of pending document records stored within this service for your
+                    organisation
+                </li>
+            </ul>
+        </>
+    );
+};
+
+export default ReviewSummaryDescription;

app/src/helpers/requests/downloadReport.test.ts

@@ -1,8 +1,8 @@
 import axios, { AxiosError } from 'axios';
 import downloadReport from './downloadReport';
-import { ReportData } from '../../types/generic/reports';
+import { REPORT_TYPE, ReportData } from '../../types/generic/reports';
 import { AuthHeaders } from '../../types/blocks/authHeaders';
-import { describe, expect, it, vi, Mocked, beforeEach, afterEach, Mock } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, Mock, Mocked, vi } from 'vitest';
 import { Procedure } from '@vitest/spy';
 
 vi.mock('axios');
@@ -12,6 +12,7 @@ const mockedAxios = axios as Mocked<typeof axios>;
 describe('downloadReport', () => {
     const report = {
         endpoint: '/download',
+        reportType: REPORT_TYPE.ODS_REVIEW_SUMMARY,
     } as ReportData;
 
     let clickSpy: Mock<Procedure>;
@@ -55,7 +56,7 @@ describe('downloadReport', () => {
 
         expect(getSpy).toHaveBeenCalledWith(args.baseUrl + report.endpoint, {
             headers: args.baseHeaders,
-            params: { outputFileFormat: args.fileType, odsReportType: 'PATIENT' },
+            params: { outputFileFormat: args.fileType, odsReportType: 'REVIEW' },
         });
 
         expect(mockAnchor.setAttribute).toHaveBeenCalledWith('download', '');
@@ -90,7 +91,7 @@ describe('downloadReport', () => {
         expect(errorCode).toBe(404);
         expect(getSpy).toHaveBeenCalledWith(args.baseUrl + report.endpoint, {
             headers: args.baseHeaders,
-            params: { outputFileFormat: args.fileType, odsReportType: 'PATIENT' },
+            params: { outputFileFormat: args.fileType, odsReportType: 'REVIEW' },
         });
     });
 });

app/src/helpers/requests/downloadReport.ts

@@ -12,7 +12,6 @@ type Args = {
 type DownloadReportResponseData = {
     data: { url: string };
 };
-
 const downloadReport = async ({ report, fileType, baseUrl, baseHeaders }: Args): Promise<void> => {
     const gatewayUrl = baseUrl + report.endpoint;
 
@@ -23,7 +22,7 @@ const downloadReport = async ({ report, fileType, baseUrl, baseHeaders }: Args):
             },
             params: {
                 outputFileFormat: fileType,
-                odsReportType: 'PATIENT',
+                odsReportType: report.reportType,
             },
         });
 

app/src/pages/adminPage/AdminPage.test.tsx

@@ -55,7 +55,7 @@ describe('AdminPage', (): void => {
         it('renders the Download a report card with correct href', (): void => {
             render(<AdminPage />);
             const reportLink = screen.getByTestId('download-report-btn');
-            expect(reportLink).toHaveAttribute('href', '/create-report?reportType=0');
+            expect(reportLink).toHaveAttribute('href', '/create-report?reportType=PATIENT');
         });
 
         it('renders the Download a report card description', (): void => {

app/src/pages/homePage/HomePage.tsx

@@ -93,7 +93,8 @@ const HomePage = (): React.JSX.Element => {
                                     <Card.Link
                                         data-testid="download-report-btn"
                                         href="#"
-                                        onClick={(): void => {
+                                        onClick={(e): void => {
+                                            e.preventDefault()
                                             navigate(
                                                 `${routes.REPORT_DOWNLOAD}?reportType=${REPORT_TYPE.ODS_PATIENT_SUMMARY}`,
                                             );

app/src/types/generic/reports.ts

@@ -1,8 +1,10 @@
 import LloydGeorgeSummaryDescription from '../../components/blocks/_downloadReport/downloadReportSelectStage/ReportDescriptions/LloydGeorgeSummaryDescription';
 import { endpoints } from './endpoints';
+import ReviewSummaryDescription from '../../components/blocks/_downloadReport/downloadReportSelectStage/ReportDescriptions/ReviewSummaryDescription';
 
 export enum REPORT_TYPE {
-    ODS_PATIENT_SUMMARY = '0',
+    ODS_PATIENT_SUMMARY = 'PATIENT',
+    ODS_REVIEW_SUMMARY = 'REVIEW',
 }
 
 export type FileTypeData = {
@@ -34,4 +36,11 @@ export const reports: ReportData[] = [
         reportType: REPORT_TYPE.ODS_PATIENT_SUMMARY,
         endpoint: endpoints.ODS_REPORT,
     },
+    {
+        title: 'Documents review summary report',
+        description: ReviewSummaryDescription,
+        fileTypes: [{ extension: 'csv', label: 'a CSV' }],
+        reportType: REPORT_TYPE.ODS_REVIEW_SUMMARY,
+        endpoint: endpoints.ODS_REPORT,
+    },
 ];

lambdas/services/ods_report_service.py

@@ -64,7 +64,7 @@ def get_documents_for_review(
         if output_file_type != FileType.CSV:
             raise OdsReportException(400, LambdaError.UnsupportedFileType)
 
-        query_filter = self.document_upload_review_service.build_review_query_filter()
+        query_filter = self.document_upload_review_service.build_review_dynamo_filter()
 
         results = self.document_upload_review_service.fetch_documents_from_table(
             search_key="Custodian",

lambdas/tests/unit/services/test_ods_report_service.py

@@ -421,7 +421,7 @@ def test_get_documents_for_review(
 
     mocker.patch.object(
         ods_report_service.document_upload_review_service,
-        "build_review_query_filter",
+        "build_review_dynamo_filter",
         return_value=expected_query_filter,
     )