feat(authz): implement error handling for role assignment with localized messages

Author: bra-i-am

src/authz-module/role-assignation-wizard/AssignRoleWizard.tsx

@@ -14,6 +14,7 @@ import { libraryRolesMetadata } from '../roles-permissions/library/constants';
 import { courseRolesMetadata } from '../roles-permissions/course/constants';
 import { useValidateUsers, useAssignTeamMembersRole } from '../data/hooks';
 import messages from './messages';
+import { formatRoleAssignmentError } from './utils';
 
 const allRolesMetadata = [...courseRolesMetadata, ...libraryRolesMetadata];
 
@@ -119,10 +120,8 @@ const AssignRoleWizard = ({ onClose, initialUsers = '', roles = allRolesMetadata
       });
 
       if (result.errors?.length > 0) {
-        const msg = result.errors
-          .map((e) => `${e.userIdentifier} (${e.scope}): ${e.error}`)
-          .join(', ');
-        showErrorToast(new Error(msg), handleSave);
+        const lines = result.errors.map((e) => formatRoleAssignmentError(intl, e));
+        showToast({ message: lines.join(' · '), type: 'error' });
       } else {
         showToast({
           message: intl.formatMessage(messages['wizard.save.success']),

src/authz-module/role-assignation-wizard/constants.ts

@@ -0,0 +1,5 @@
+export const ROLE_ASSIGNMENT_ERRORS = {
+  USER_ALREADY_HAS_ROLE: 'user_already_has_role',
+  USER_NOT_FOUND: 'user_not_found',
+  ROLE_ASSIGNMENT_ERROR: 'role_assignment_error',
+} as const;

src/authz-module/role-assignation-wizard/messages.ts

@@ -68,6 +68,26 @@ const messages = defineMessages({
     defaultMessage: 'Role assigned successfully.',
     description: 'Toast message shown when a role is successfully assigned',
   },
+  'wizard.save.error.user_already_has_role': {
+    id: 'wizard.save.error.user_already_has_role',
+    defaultMessage: '{userIdentifier} already has this role in {scope}',
+    description: 'Error shown in the toast when the user already holds the role in the selected scope',
+  },
+  'wizard.save.error.user_not_found': {
+    id: 'wizard.save.error.user_not_found',
+    defaultMessage: 'User "{userIdentifier}" was not found',
+    description: 'Error shown in the toast when the username or email does not match any account',
+  },
+  'wizard.save.error.role_assignment_error': {
+    id: 'wizard.save.error.role_assignment_error',
+    defaultMessage: 'Could not assign role to {userIdentifier} in {scope}',
+    description: 'Error shown in the toast when an unexpected error occurs during role assignment',
+  },
+  'wizard.save.error.default': {
+    id: 'wizard.save.error.default',
+    defaultMessage: '{userIdentifier} ({scope}): {error}',
+    description: 'Fallback error line shown in the toast for unknown role-assignment error codes',
+  },
 
   // DefineApplicationScopeStep — filter bar
   'wizard.step2.search.placeholder': {

src/authz-module/role-assignation-wizard/utils.ts

@@ -0,0 +1,23 @@
+import { IntlShape } from '@edx/frontend-platform/i18n';
+import { PutAssignTeamMembersRoleResponse } from '@src/authz-module/data/api';
+import { ROLE_ASSIGNMENT_ERRORS } from './constants';
+import messages from './messages';
+
+type RoleAssignmentError = PutAssignTeamMembersRoleResponse['errors'][number];
+
+export const formatRoleAssignmentError = (
+  intl: IntlShape,
+  e: RoleAssignmentError,
+): string => {
+  const params = { userIdentifier: e.userIdentifier, scope: e.scope };
+  if (e.error === ROLE_ASSIGNMENT_ERRORS.USER_ALREADY_HAS_ROLE) {
+    return intl.formatMessage(messages['wizard.save.error.user_already_has_role'], params);
+  }
+  if (e.error === ROLE_ASSIGNMENT_ERRORS.USER_NOT_FOUND) {
+    return intl.formatMessage(messages['wizard.save.error.user_not_found'], params);
+  }
+  if (e.error === ROLE_ASSIGNMENT_ERRORS.ROLE_ASSIGNMENT_ERROR) {
+    return intl.formatMessage(messages['wizard.save.error.role_assignment_error'], params);
+  }
+  return intl.formatMessage(messages['wizard.save.error.default'], { ...params, error: e.error });
+};