288f0919db
Currently, when a server query or mutation from the front-end fails, the error message defined server-side is displayed in a snackbar in the front-end. These error messages usually contain technical details that don't belong to the user interface, such as "ObjectMetadataCollection not found" or "invalid ENUM value for ...". **BE** In addition to the original error message that is still needed (for the request response, debugging, sentry monitoring etc.), we add a `displayedErrorMessage` that will be used in the snackbars. It's only relevant to add it for the messages that will reach the FE (ie. not in jobs or in rest api for instance) and if it can help the user sort out / fix things (ie. we do add displayedErrorMessage for "Cannot create multiple draft versions for the same workflow" or "Cannot delete [field], please update the label identifier field first", but not "Object metadata does not exist"), even if in practice in the FE users should not be able to perform an action that will not work (ie should not be able to save creation of multiple draft versions of the same workflows). **FE** To ease the usage we replaced enqueueSnackBar with enqueueErrorSnackBar and enqueueSuccessSnackBar with an api that only requires to pass on the error. If no displayedErrorMessage is specified then the default error message is `An error occured.`
61 lines
2.6 KiB
TypeScript
61 lines
2.6 KiB
TypeScript
import { t } from '@lingui/core/macro';
|
|
|
|
import {
|
|
ForbiddenError,
|
|
NotFoundError,
|
|
UserInputError,
|
|
} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
|
|
import {
|
|
PermissionsException,
|
|
PermissionsExceptionCode,
|
|
} from 'src/engine/metadata-modules/permissions/permissions.exception';
|
|
|
|
export const permissionGraphqlApiExceptionHandler = (
|
|
error: PermissionsException,
|
|
) => {
|
|
switch (error.code) {
|
|
case PermissionsExceptionCode.PERMISSION_DENIED:
|
|
throw new ForbiddenError(error.message, {
|
|
userFriendlyMessage: 'User does not have permission.',
|
|
});
|
|
case PermissionsExceptionCode.ROLE_LABEL_ALREADY_EXISTS:
|
|
throw new ForbiddenError(error.message, {
|
|
userFriendlyMessage: t`A role with this label already exists.`,
|
|
});
|
|
case PermissionsExceptionCode.CANNOT_UNASSIGN_LAST_ADMIN:
|
|
case PermissionsExceptionCode.CANNOT_UPDATE_SELF_ROLE:
|
|
case PermissionsExceptionCode.CANNOT_DELETE_LAST_ADMIN_USER:
|
|
case PermissionsExceptionCode.ROLE_NOT_EDITABLE:
|
|
case PermissionsExceptionCode.CANNOT_ADD_OBJECT_PERMISSION_ON_SYSTEM_OBJECT:
|
|
throw new ForbiddenError(error.message);
|
|
case PermissionsExceptionCode.INVALID_ARG:
|
|
case PermissionsExceptionCode.INVALID_SETTING:
|
|
case PermissionsExceptionCode.CANNOT_GIVE_WRITING_PERMISSION_ON_NON_READABLE_OBJECT:
|
|
case PermissionsExceptionCode.CANNOT_GIVE_WRITING_PERMISSION_WITHOUT_READING_PERMISSION:
|
|
throw new UserInputError(error.message);
|
|
case PermissionsExceptionCode.ROLE_NOT_FOUND:
|
|
case PermissionsExceptionCode.USER_WORKSPACE_NOT_FOUND:
|
|
case PermissionsExceptionCode.OBJECT_METADATA_NOT_FOUND:
|
|
throw new NotFoundError(error.message);
|
|
case PermissionsExceptionCode.DEFAULT_ROLE_NOT_FOUND:
|
|
case PermissionsExceptionCode.WORKSPACE_ID_ROLE_USER_WORKSPACE_MISMATCH:
|
|
case PermissionsExceptionCode.TOO_MANY_ADMIN_CANDIDATES:
|
|
case PermissionsExceptionCode.USER_WORKSPACE_ALREADY_HAS_ROLE:
|
|
case PermissionsExceptionCode.ADMIN_ROLE_NOT_FOUND:
|
|
case PermissionsExceptionCode.DEFAULT_ROLE_CANNOT_BE_DELETED:
|
|
case PermissionsExceptionCode.WORKSPACE_MEMBER_NOT_FOUND:
|
|
case PermissionsExceptionCode.UNKNOWN_OPERATION_NAME:
|
|
case PermissionsExceptionCode.UNKNOWN_REQUIRED_PERMISSION:
|
|
case PermissionsExceptionCode.NO_ROLE_FOUND_FOR_USER_WORKSPACE:
|
|
case PermissionsExceptionCode.NO_PERMISSIONS_FOUND_IN_DATASOURCE:
|
|
case PermissionsExceptionCode.METHOD_NOT_ALLOWED:
|
|
case PermissionsExceptionCode.RAW_SQL_NOT_ALLOWED:
|
|
throw error;
|
|
default: {
|
|
const _exhaustiveCheck: never = error.code;
|
|
|
|
throw error;
|
|
}
|
|
}
|
|
};
|