feat: show errors in EditRole form

This commit is contained in:
kasia.oczkowska
2025-03-06 12:27:04 +00:00
parent 0b7e29160e
commit 4d1e2346c0
2 changed files with 114 additions and 41 deletions

View File

@@ -257,6 +257,7 @@
"deleteRoleButton.successfullyDeleted": "The role has been deleted.", "deleteRoleButton.successfullyDeleted": "The role has been deleted.",
"deleteRoleButton.generalError": "Failed while deleting!", "deleteRoleButton.generalError": "Failed while deleting!",
"editRolePage.title": "Edit role", "editRolePage.title": "Edit role",
"editRolePage.permissionsError": "Permissions are invalid.",
"createRolePage.title": "Create role", "createRolePage.title": "Create role",
"roleForm.name": "Name", "roleForm.name": "Name",
"roleForm.description": "Description", "roleForm.description": "Description",

View File

@@ -5,6 +5,10 @@ import useEnqueueSnackbar from 'hooks/useEnqueueSnackbar';
import * as React from 'react'; import * as React from 'react';
import { useNavigate, useParams } from 'react-router-dom'; import { useNavigate, useParams } from 'react-router-dom';
import { merge } from 'lodash'; import { merge } from 'lodash';
import Alert from '@mui/material/Alert';
import AlertTitle from '@mui/material/AlertTitle';
import { yupResolver } from '@hookform/resolvers/yup';
import * as yup from 'yup';
import Container from 'components/Container'; import Container from 'components/Container';
import Form from 'components/Form'; import Form from 'components/Form';
@@ -22,6 +26,40 @@ import useAdminUpdateRole from 'hooks/useAdminUpdateRole';
import useRole from 'hooks/useRole.ee'; import useRole from 'hooks/useRole.ee';
import usePermissionCatalog from 'hooks/usePermissionCatalog.ee'; import usePermissionCatalog from 'hooks/usePermissionCatalog.ee';
const getValidationSchema = (formatMessage) => {
const getMandatoryFieldMessage = (fieldTranslationId) =>
formatMessage('roleForm.mandatoryInput', {
inputName: formatMessage(fieldTranslationId),
});
return yup.object().shape({
name: yup
.string()
.trim()
.required(getMandatoryFieldMessage('roleForm.name')),
description: yup.string().trim(),
});
};
const getPermissionsErrorMessage = (error) => {
const errors = error?.response?.data?.errors;
if (errors) {
const permissionsErrors = Object.keys(errors)
.filter((key) => key.startsWith('permissions'))
.reduce((obj, key) => {
obj[key] = errors[key];
return obj;
}, {});
if (Object.keys(permissionsErrors).length > 0) {
return JSON.stringify(permissionsErrors, null, 2);
}
}
return null;
};
export default function EditRole() { export default function EditRole() {
const formatMessage = useFormatMessage(); const formatMessage = useFormatMessage();
const navigate = useNavigate(); const navigate = useNavigate();
@@ -34,9 +72,11 @@ export default function EditRole() {
const role = roleData?.data; const role = roleData?.data;
const permissionCatalog = permissionCatalogData?.data; const permissionCatalog = permissionCatalogData?.data;
const enqueueSnackbar = useEnqueueSnackbar(); const enqueueSnackbar = useEnqueueSnackbar();
const [permissionError, setPermissionError] = React.useState(null);
const handleRoleUpdate = async (roleData) => { const handleRoleUpdate = async (roleData) => {
try { try {
setPermissionError(null);
const newPermissions = getPermissions(roleData.computedPermissions); const newPermissions = getPermissions(roleData.computedPermissions);
await updateRole({ await updateRole({
name: roleData.name, name: roleData.name,
@@ -53,7 +93,13 @@ export default function EditRole() {
navigate(URLS.ROLES); navigate(URLS.ROLES);
} catch (error) { } catch (error) {
throw new Error('Failed while updating!'); const permissionError = getPermissionsErrorMessage(error);
if (permissionError) {
setPermissionError(permissionError);
}
const errors = error?.response?.data?.errors;
throw errors || error;
} }
}; };
@@ -82,17 +128,25 @@ export default function EditRole() {
</Grid> </Grid>
<Grid item xs={12} justifyContent="flex-end" sx={{ pt: 5 }}> <Grid item xs={12} justifyContent="flex-end" sx={{ pt: 5 }}>
<Form defaultValues={defaultValues} onSubmit={handleRoleUpdate}> <Form
noValidate
defaultValues={defaultValues}
onSubmit={handleRoleUpdate}
resolver={yupResolver(getValidationSchema(formatMessage))}
automaticValidation={false}
render={({ formState: { errors } }) => (
<Stack direction="column" gap={2}> <Stack direction="column" gap={2}>
<TextField <TextField
disabled={ disabled={
role?.isAdmin || isRoleLoading || isPermissionCatalogLoading role?.isAdmin || isRoleLoading || isPermissionCatalogLoading
} }
required={true} required
name="name" name="name"
label={formatMessage('roleForm.name')} label={formatMessage('roleForm.name')}
data-test="name-input" data-test="name-input"
fullWidth fullWidth
error={!!errors?.name}
helperText={errors?.name?.message}
/> />
<TextField <TextField
disabled={ disabled={
@@ -102,6 +156,8 @@ export default function EditRole() {
label={formatMessage('roleForm.description')} label={formatMessage('roleForm.description')}
data-test="description-input" data-test="description-input"
fullWidth fullWidth
error={!!errors?.description}
helperText={errors?.description?.message}
/> />
<PermissionCatalogField <PermissionCatalogField
name="computedPermissions" name="computedPermissions"
@@ -109,6 +165,21 @@ export default function EditRole() {
syncIsCreator syncIsCreator
loading={isRoleLoading} loading={isRoleLoading}
/> />
{permissionError && (
<Alert severity="error" data-test="edit-role-error-alert">
<AlertTitle>
{formatMessage('editRolePage.permissionsError')}
</AlertTitle>
<pre>
<code>{permissionError}</code>
</pre>
</Alert>
)}
{errors?.root?.general && !permissionError && (
<Alert severity="error" data-test="edit-role-error-alert">
{errors?.root?.general?.message}
</Alert>
)}
<LoadingButton <LoadingButton
type="submit" type="submit"
variant="contained" variant="contained"
@@ -121,7 +192,8 @@ export default function EditRole() {
{formatMessage('editRole.submit')} {formatMessage('editRole.submit')}
</LoadingButton> </LoadingButton>
</Stack> </Stack>
</Form> )}
/>
</Grid> </Grid>
</Grid> </Grid>
</Container> </Container>