Skip to content
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.

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

UIBULKED-553 Show error callouts only when job FAILED #631

Merged
merged 4 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions src/components/BulkEdit.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ import BulkEdit from './BulkEdit';
import { mockData, createDtWithFiles, createFile, flushPromises, dispatchEvt } from '../../test/jest/utils/fileUpload';
import { queryClient } from '../../test/jest/utils/queryClient';

jest.mock('../hooks/useErrorMessages', () => ({
useErrorMessages: jest.fn().mockReturnValue({ showErrorMessage: jest.fn() }),
}));

jest.mock('./BulkEditPane/BulkEditListResult', () => ({
BulkEditListResult: () => 'BulkEditListResult',
}));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import React, {
useMemo,
useState
} from 'react';
import { buildSearch, useShowCallout } from '@folio/stripes-acq-components';
import { buildSearch } from '@folio/stripes-acq-components';
import { FormattedMessage } from 'react-intl';
import { useHistory, useLocation } from 'react-router-dom';

Expand All @@ -24,12 +24,13 @@ import { useBulkPermissions, useLocationFilters, useSearchParams } from '../../.
import { useBulkOperationStart, useUpload } from '../../../../hooks/api';
import { getIsDisabledByPerm } from '../utils/getIsDisabledByPerm';
import { RootContext } from '../../../../context/RootContext';
import { useErrorMessages } from '../../../../hooks/useErrorMessages';

export const IdentifierTab = () => {
const history = useHistory();
const location = useLocation();
const showCallout = useShowCallout();
const permissions = useBulkPermissions();
const { showErrorMessage } = useErrorMessages();

const {
isFileUploaded,
Expand Down Expand Up @@ -146,7 +147,7 @@ export const IdentifierTab = () => {
});

if (errorMessage?.includes(ERRORS.TOKEN)) throw Error(ERRORS.TOKEN);
if (status === JOB_STATUSES.FAILED) throw Error();
if (status === JOB_STATUSES.FAILED) throw Error(errorMessage);

history.replace({
pathname: `/bulk-edit/${id}/preview`,
Expand All @@ -155,13 +156,8 @@ export const IdentifierTab = () => {
}

setIsFileUploaded(true);
} catch ({ message }) {
if (message === ERRORS.TOKEN) {
showCallout({
message: <FormattedMessage id="ui-bulk-edit.error.incorrectFormatted" values={{ fileName:fileToUpload.name }} />,
type: 'error',
});
}
} catch (error) {
showErrorMessage(error, { fileName: fileToUpload.name });
}
};

Expand Down
6 changes: 3 additions & 3 deletions src/components/shared/ProgressBar/ProgressBar.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,21 @@ export const ProgressBar = () => {
useEffect(() => {
const nextStep = getBulkOperationStep(bulkDetails);

// Show error message if any
showErrorMessage(bulkDetails);

if (nextStep) {
clearIntervalAndRedirect(`/bulk-edit/${id}/preview`, { step: nextStep, progress: null });
}

if (status === JOB_STATUSES.FAILED) {
showErrorMessage(bulkDetails);

clearIntervalAndRedirect('/bulk-edit', '');
}
}, [
status,
bulkDetails,
id,
clearIntervalAndRedirect,
showErrorMessage,
]);

return (
Expand Down
4 changes: 2 additions & 2 deletions src/hooks/useErrorMessages.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const useErrorMessages = () => {
});
};

const showErrorMessage = (res) => {
const showErrorMessage = (res, meta) => {
const message = res?.errorMessage;

// check if error message should be translated (if it's exist in translations)
Expand All @@ -31,7 +31,7 @@ export const useErrorMessages = () => {
} else if (message) {
// if error message contains token error, show a special message
if (message?.includes(ERRORS.TOKEN)) {
showError(intl.formatMessage({ id: 'ui-bulk-edit.error.incorrectFormatted' }, { fileName: initialFileName }));
showError(intl.formatMessage({ id: 'ui-bulk-edit.error.incorrectFormatted' }, { fileName: meta?.fileName || initialFileName }));
} else {
showError(message);
}
Expand Down
17 changes: 17 additions & 0 deletions src/hooks/useErrorMessages.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,21 @@ describe('useErrorMessages', () => {

expect(showCalloutMock).not.toHaveBeenCalled();
});

it('should use variables from meta object if provided', () => {
const { result } = renderHook(() => useErrorMessages());
const { showErrorMessage } = result.current;

formatMessageMock.mockImplementationOnce(({ id }, { fileName }) => {
return `${id}.${fileName}`;
});

showErrorMessage({ errorMessage: ERRORS.TOKEN }, { fileName: 'testFileName' });

expect(formatMessageMock).toHaveBeenCalledWith({ id: 'ui-bulk-edit.error.incorrectFormatted' }, { fileName: 'testFileName' });
expect(showCalloutMock).toHaveBeenCalledWith({
type: 'error',
message: 'ui-bulk-edit.error.incorrectFormatted.testFileName',
});
});
});
Loading