Skip to content

[PRMP-1357] Error handling for invalid files during add more files #1083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lillie-dae wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[PRMP-1357] Error handling for invalid files during add more files #1083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b696dc1
[PRMP-1357] Error handling for invalid files during add more files
lillie-dae Feb 12, 2026
93b8de4
code comment changes
lillie-dae Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 123 additions & 99 deletions .../blocks/_admin/reviewDetailsDocumentSelectStage/ReviewDetailsDocumentSelectStage.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { render, screen, waitFor } from '@testing-library/react';
// need to use happy-dom for this test file as jsdom doesn't support DOMMatrix and scrollIntoView
// @vitest-environment happy-dom
import { render, screen, waitFor, fireEvent, RenderResult } from '@testing-library/react';
import { describe, expect, it, vi, beforeEach } from 'vitest';
import userEvent from '@testing-library/user-event';
import ReviewDetailsDocumentSelectStage from './ReviewDetailsDocumentSelectStage';
Expand All @@ -10,6 +12,8 @@ import {
UploadDocument,
} from '../../../../types/pages/UploadDocumentsPage/types';
import { routeChildren } from '../../../../types/generic/routes';
import { getDocument } from 'pdfjs-dist';
import { PDF_PARSING_ERROR_TYPE } from '../../../../helpers/utils/fileUploadErrorMessages';

const mockNavigate = vi.fn();

Expand Down Expand Up @@ -49,7 +53,7 @@ vi.mock('react-router-dom', () => ({
}));

describe('ReviewDetailsDocumentSelectStage', () => {
const testReviewSnoMed: DOCUMENT_TYPE = DOCUMENT_TYPE.LLOYD_GEORGE;
const testReviewSnomed: DOCUMENT_TYPE = DOCUMENT_TYPE.LLOYD_GEORGE;

let mockReviewData: ReviewDetails;
let mockDocuments: UploadDocument[];
Expand All @@ -60,7 +64,7 @@ describe('ReviewDetailsDocumentSelectStage', () => {

mockReviewData = new ReviewDetails(
'test-review-id',
testReviewSnoMed,
testReviewSnomed,
'2024-01-01T12:00:00Z',
'Test Uploader',
'2024-01-01T12:00:00Z',
Expand All @@ -74,39 +78,35 @@ describe('ReviewDetailsDocumentSelectStage', () => {
mockSetDocuments = vi.fn() as SetUploadDocuments;
});

const renderApp = (props?: {
reviewData?: ReviewDetails | null;
documents?: UploadDocument[];
setDocuments?: SetUploadDocuments;
}): RenderResult => {
const defaultProps = {
reviewData: mockReviewData,
documents: mockDocuments,
setDocuments: mockSetDocuments,
};

return render(<ReviewDetailsDocumentSelectStage {...defaultProps} {...props} />);
};

describe('Rendering', () => {
it('shows spinner when reviewData is null', () => {
render(
<ReviewDetailsDocumentSelectStage
reviewData={null}
documents={mockDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp({ reviewData: null });

expect(screen.getByTestId('mock-spinner')).toBeInTheDocument();
});

it('shows spinner when files is null', () => {
render(
<ReviewDetailsDocumentSelectStage
reviewData={{ ...mockReviewData, files: null } as any}
documents={mockDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp({ reviewData: { ...mockReviewData, files: null } as any });

expect(screen.getByTestId('mock-spinner')).toBeInTheDocument();
});

it('shows spinner when documents are not initialised', () => {
render(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={mockDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp();

expect(screen.getByTestId('mock-spinner')).toBeInTheDocument();
});
Expand All @@ -120,22 +120,14 @@ describe('ReviewDetailsDocumentSelectStage', () => {
file: new File(['test'], 'test.pdf', { type: 'application/pdf' }),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnoMed,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

const { rerender } = render(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={[]}
setDocuments={mockSetDocuments}
/>,
);

rerender(
render(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={testDocuments}
Expand All @@ -161,28 +153,14 @@ describe('ReviewDetailsDocumentSelectStage', () => {
}),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnoMed,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

const { rerender } = render(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={[]}
setDocuments={mockSetDocuments}
/>,
);

rerender(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={testDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp({ documents: testDocuments });

await waitFor(() => {
expect(screen.queryByTestId('mock-spinner')).not.toBeInTheDocument();
Expand All @@ -200,28 +178,14 @@ describe('ReviewDetailsDocumentSelectStage', () => {
file: new File(['test'], 'test.pdf', { type: 'application/pdf' }),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnoMed,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

const { rerender } = render(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={[]}
setDocuments={mockSetDocuments}
/>,
);

rerender(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={testDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp({ documents: testDocuments });

await waitFor(() => {
expect(screen.queryByTestId('mock-spinner')).not.toBeInTheDocument();
Expand All @@ -243,28 +207,14 @@ describe('ReviewDetailsDocumentSelectStage', () => {
file: new File(['test'], 'test.pdf', { type: 'application/pdf' }),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnoMed,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

const { rerender } = render(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={[]}
setDocuments={mockSetDocuments}
/>,
);

rerender(
<ReviewDetailsDocumentSelectStage
reviewData={mockReviewData}
documents={testDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp({ documents: testDocuments });

await waitFor(() => {
expect(screen.queryByTestId('mock-spinner')).not.toBeInTheDocument();
Expand All @@ -287,7 +237,7 @@ describe('ReviewDetailsDocumentSelectStage', () => {
const user = userEvent.setup();
const customReviewData = new ReviewDetails(
'custom-id',
testReviewSnoMed,
testReviewSnomed,
'2024-01-01T12:00:00Z',
'Test Uploader',
'2024-01-01T12:00:00Z',
Expand All @@ -303,28 +253,14 @@ describe('ReviewDetailsDocumentSelectStage', () => {
file: new File(['test'], 'test.pdf', { type: 'application/pdf' }),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnoMed,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

const { rerender } = render(
<ReviewDetailsDocumentSelectStage
reviewData={customReviewData}
documents={[]}
setDocuments={mockSetDocuments}
/>,
);

rerender(
<ReviewDetailsDocumentSelectStage
reviewData={customReviewData}
documents={testDocuments}
setDocuments={mockSetDocuments}
/>,
);
renderApp({ reviewData: customReviewData, documents: testDocuments });

await waitFor(() => {
expect(screen.queryByTestId('mock-spinner')).not.toBeInTheDocument();
Expand All @@ -338,4 +274,92 @@ describe('ReviewDetailsDocumentSelectStage', () => {
});
});
});

describe('Error handling', () => {
const errorCases = [
['password protected file', PDF_PARSING_ERROR_TYPE.PASSWORD_MISSING],
['invalid PDF structure', PDF_PARSING_ERROR_TYPE.INVALID_PDF_STRUCTURE],
['empty PDF', PDF_PARSING_ERROR_TYPE.EMPTY_PDF],
];

it.each(errorCases)(
'navigates to admin file errors page when user selects a %s',
async (_description, errorType) => {
const testDocuments: UploadDocument[] = [
{
id: 'test-id',
file: new File(['test'], 'test.pdf', { type: 'application/pdf' }),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

renderApp({ documents: testDocuments });

await waitFor(() => {
expect(screen.queryByTestId('mock-spinner')).not.toBeInTheDocument();
});

// Set up mock to throw error AFTER component is ready
vi.mocked(getDocument).mockImplementationOnce(() => {
throw new Error(errorType as string);
});

const errorFile = new File(['test'], 'error-file.pdf', { type: 'application/pdf' });
const dropzone = screen.getByTestId('dropzone');
fireEvent.drop(dropzone, {
dataTransfer: { files: [errorFile] },
});

await waitFor(() => {
expect(mockNavigate).toHaveBeenCalledWith(
routeChildren.ADMIN_REVIEW_FILE_ERRORS.replaceAll(
':reviewId',
'test-review-id.1',
),
);
});
},
);

it('navigates to admin file errors page when user selects a non-PDF file', async () => {
const testDocuments: UploadDocument[] = [
{
id: 'test-id',
file: new File(['test'], 'test.pdf', { type: 'application/pdf' }),
state: DOCUMENT_UPLOAD_STATE.SELECTED,
progress: 0,
docType: testReviewSnomed,
attempts: 0,
numPages: 1,
validated: false,
},
];

renderApp({ documents: testDocuments });

await waitFor(() => {
expect(screen.queryByTestId('mock-spinner')).not.toBeInTheDocument();
});

const nonPdfFile = new File(['test'], 'nonPdfFile.txt', { type: 'text/plain' });
const dropzone = screen.getByTestId('dropzone');
fireEvent.drop(dropzone, {
dataTransfer: { files: [nonPdfFile] },
});

await waitFor(() => {
expect(mockNavigate).toHaveBeenCalledWith(
routeChildren.ADMIN_REVIEW_FILE_ERRORS.replaceAll(
':reviewId',
'test-review-id.1',
),
);
});
});
});
});
10 changes: 10 additions & 0 deletions ...nents/blocks/_admin/reviewDetailsDocumentSelectStage/ReviewDetailsDocumentSelectStage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ const ReviewDetailsDocumentSelectStage = ({
),
);
};

const onError = (): void => {
navigate(
routeChildren.ADMIN_REVIEW_FILE_ERRORS.replaceAll(
':reviewId',
`${reviewData?.id}.${reviewData?.version}`,
),
);
};
if (!reviewData?.snomedCode) {
return <Spinner status={'Loading'} />;
}
Expand All @@ -67,6 +76,7 @@ const ReviewDetailsDocumentSelectStage = ({
filesErrorRef={filesErrorRef}
documentConfig={getConfigForDocType(reviewData.snomedCode)}
onSuccessOverride={onSuccess}
onErrorOverride={onError}
backLinkOverride={(): void => {
navigate(-1);
}}
Expand Down
Loading
Loading