feat: add util for preferredname checks

apps/e2e/cypress/e2e/generalFaps.cy.ts

@@ -237,17 +237,10 @@ context('General facility access panel tests', () => {
       cy.get('[role="dialog"] table tbody tr')
         .first()
         .find('td.MuiTableCell-alignLeft')
-        .first()
-        .then((element) => {
-          selectedChairUserFirstName = element.text();
-        });
-
-      cy.get('[role="dialog"] table tbody tr')
-        .first()
-        .find('td.MuiTableCell-alignLeft')
-        .eq(1)
-        .then((element) => {
-          selectedChairUserLastName = element.text();
+        .then((cells) => {
+          const preferredName = cells.eq(2).text().trim();
+          selectedChairUserFirstName = preferredName || cells.eq(0).text();
+          selectedChairUserLastName = cells.eq(1).text();
         });
 
       cy.get('[aria-label="Select user"]').first().click();
@@ -278,17 +271,10 @@ context('General facility access panel tests', () => {
       cy.get('[role="dialog"] table tbody tr')
         .first()
         .find('td.MuiTableCell-alignLeft')
-        .first()
-        .then((element) => {
-          selectedSecretaryUserFirstName = element.text();
-        });
-
-      cy.get('[role="dialog"] table tbody tr')
-        .first()
-        .find('td.MuiTableCell-alignLeft')
-        .eq(1)
-        .then((element) => {
-          selectedSecretaryUserLastName = element.text();
+        .then((cells) => {
+          const preferredName = cells.eq(2).text().trim();
+          selectedSecretaryUserFirstName = preferredName || cells.eq(0).text();
+          selectedSecretaryUserLastName = cells.eq(1).text();
         });
 
       cy.get('[aria-label="Select user"]').first().click();
@@ -321,17 +307,10 @@ context('General facility access panel tests', () => {
       cy.get('[role="dialog"] table tbody tr')
         .first()
         .find('td.MuiTableCell-alignLeft')
-        .first()
-        .then((element) => {
-          selectedSecretaryUserFirstName = element.text();
-        });
-
-      cy.get('[role="dialog"] table tbody tr')
-        .first()
-        .find('td.MuiTableCell-alignLeft')
-        .eq(1)
-        .then((element) => {
-          selectedSecretaryUserLastName = element.text();
+        .then((cells) => {
+          const preferredName = cells.eq(2).text().trim();
+          selectedSecretaryUserFirstName = preferredName || cells.eq(0).text();
+          selectedSecretaryUserLastName = cells.eq(1).text();
         });
 
       cy.get('[aria-label="Select user"]').first().click();

apps/e2e/cypress/e2e/instruments.cy.ts

@@ -536,7 +536,7 @@ context('Instrument tests', () => {
 
       cy.get('[data-cy="user-list"] input').should(
         'have.value',
-        `${scientist1.firstName} ${scientist1.lastName}`
+        `${scientist1.preferredName} ${scientist1.lastName}`
       );
 
       cy.get('[data-cy="user-list"]').click();
@@ -545,16 +545,22 @@ context('Instrument tests', () => {
         'have.length',
         numberOfScientistsAndManagerAssignedToCreatedInstrument
       );
+      const reassignDisplayName = featureFlags
+        .getEnabledFeatures()
+        .get(FeatureId.USER_SEARCH_FILTER)
+        ? scientist2.preferredName
+        : scientist2.firstName;
+
       cy.get('[title="user-list-options"]')
-        .contains(scientist2.firstName)
+        .contains(reassignDisplayName)
         .click();
 
       cy.get('[data-cy="re-assign-submit"]').click();
       cy.get('[data-cy="confirm-ok"]').click();
 
       cy.notification({
         variant: 'success',
-        text: `Assigned to ${scientist2.firstName} ${scientist2.lastName}`,
+        text: `Assigned to ${reassignDisplayName} ${scientist2.lastName}`,
       });
 
       cy.closeModal();
@@ -962,10 +968,12 @@ context('Instrument tests', () => {
         instrumentId: createdInstrumentId,
         questionaryId: initialDBData.technicalReview.questionaryId,
       });
-      let updatedContact = `${scientist2.firstName} ${scientist2.lastName} (${scientist2.email})`;
-      if (featureFlags.getEnabledFeatures().get(FeatureId.USER_SEARCH_FILTER)) {
-        updatedContact = `${scientist2.firstName.slice(0, 3)} ${scientist2.lastName} (${scientist2.email})`;
-      }
+      const contactDisplayName = featureFlags
+        .getEnabledFeatures()
+        .get(FeatureId.USER_SEARCH_FILTER)
+        ? scientist2.preferredName
+        : scientist2.firstName;
+      const updatedContact = `${contactDisplayName} ${scientist2.lastName} (${scientist2.email})`;
       cy.login('officer', initialDBData.roles.userOfficer);
       cy.visit('/');
 
@@ -1009,7 +1017,7 @@ context('Instrument tests', () => {
       cy.get('[data-cy="confirm-ok"]').click();
 
       cy.get('[aria-label="Detail panel visibility toggle"]').eq(0).click();
-      cy.contains(`${scientist2.firstName} ${scientist2.lastName}`).should(
+      cy.contains(`${contactDisplayName} ${scientist2.lastName}`).should(
         'be.visible'
       );
 
@@ -1026,7 +1034,7 @@ context('Instrument tests', () => {
 
       cy.get('[role="dialog"]').contains('Technical review').click();
 
-      cy.contains(`${scientist2.firstName} ${scientist2.lastName}`).should(
+      cy.contains(`${contactDisplayName} ${scientist2.lastName}`).should(
         'not.exist'
       );
     });

apps/e2e/cypress/e2e/internalReviews.cy.ts

@@ -160,7 +160,7 @@ context('Internal Review tests', () => {
     }
 
     cy.get('[data-cy="internal-reviewer-options"]')
-      .contains(scientist2.firstName)
+      .contains(scientist2.preferredName)
       .click();
 
     cy.setTinyMceContent('internal_review_comment', comment);
@@ -170,7 +170,9 @@ context('Internal Review tests', () => {
     cy.notification({ variant: 'success', text: 'success' });
 
     cy.get('[data-cy="internal-reviews-table"]').contains(title);
-    cy.get('[data-cy="internal-reviews-table"]').contains(scientist2.firstName);
+    cy.get('[data-cy="internal-reviews-table"]').contains(
+      scientist2.preferredName
+    );
   });
 
   it('User Officer should be able to update an internal review', () => {
@@ -227,15 +229,17 @@ context('Internal Review tests', () => {
       .click();
 
     cy.get('[data-cy="internal-reviewer-options"]')
-      .contains(scientist2.firstName)
+      .contains(scientist2.preferredName)
       .click();
 
     cy.get('[data-cy="create-modal"]').find('[data-cy="submit"]').click();
 
     cy.notification({ variant: 'success', text: 'success' });
 
     cy.get('[data-cy="internal-reviews-table"]').contains(newTitle);
-    cy.get('[data-cy="internal-reviews-table"]').contains(scientist2.firstName);
+    cy.get('[data-cy="internal-reviews-table"]').contains(
+      scientist2.preferredName
+    );
   });
 
   it('User Officer should be able to delete internal review', () => {

apps/e2e/cypress/support/initialDBData.ts

@@ -253,6 +253,7 @@ export default {
     user1: {
       id: 1,
       firstName: 'Carl',
+      preferredName: 'Carl',
       lastName: 'Carlsson',
       email: 'Javon4@hotmail.com',
       password: 'Test1234!',
@@ -261,6 +262,7 @@ export default {
       id: 4,
       firstName: 'Benjamin',
       lastName: 'Beckley',
+      preferredName: 'Ben',
       email: 'ben@inbox.com',
       password: 'Test1234!',
     },

apps/frontend/src/components/eventLog/EventLogList.tsx

@@ -8,6 +8,7 @@ import { EventLog } from 'generated/sdk';
 import { useFormattedDateTime } from 'hooks/admin/useFormattedDateTime';
 import { useEventLogsData } from 'hooks/eventLog/useEventLogsData';
 import { tableIcons } from 'utils/materialIcons';
+import { getPreferredName } from 'utils/user';
 
 type EventLogListProps = {
   /** Id of the changed object that we want to list event logs for. */
@@ -25,7 +26,7 @@ const columns: Column<EventLog>[] = [
     title: 'Changed by',
     render: (rowData: EventLog): string =>
       rowData.changedBy
-        ? `${rowData.changedBy.firstname} ${rowData.changedBy.lastname}`
+        ? `${getPreferredName(rowData.changedBy)} ${rowData.changedBy.lastname}`
         : 'System',
   },
   {

apps/frontend/src/components/fap/Members/FapMembers.tsx

@@ -31,7 +31,7 @@ import { useRenewToken } from 'hooks/common/useRenewToken';
 import { FapMember, useFapReviewersData } from 'hooks/fap/useFapReviewersData';
 import { tableIcons } from 'utils/materialIcons';
 import useDataApiWithFeedback from 'utils/useDataApiWithFeedback';
-import { getFullUserName } from 'utils/user';
+import { getFullUserName, getPreferredName } from 'utils/user';
 import withConfirm, { WithConfirmType } from 'utils/withConfirm';
 
 type BasicUserDetailsWithRole = BasicUserDetails & { roleId: UserRole };
@@ -45,10 +45,7 @@ type FapMembersProps = {
 const columns = [
   {
     title: 'Name',
-    render: (rowData: FapMember) =>
-      rowData.user.preferredname
-        ? rowData.user.preferredname
-        : rowData.user.firstname,
+    render: (rowData: FapMember) => getPreferredName(rowData.user),
   },
   {
     title: 'Surname',

apps/frontend/src/components/fap/Proposals/AssignFapMemberToProposalModal.tsx

@@ -8,6 +8,7 @@ import React, { useEffect, useState } from 'react';
 import PeopleTable from 'components/user/PeopleTable';
 import { BasicUserDetails, Maybe, Role } from 'generated/sdk';
 import { useFapMembersData } from 'hooks/fap/useFapMembersData';
+import { getPreferredName } from 'utils/user';
 
 import { MultiRankAssignmentDialog } from './MultiRankAssignmentDialog';
 
@@ -31,8 +32,7 @@ const memberRole = (member: FapAssignedMember) => `${member.role?.title}`;
 const columns = [
   {
     title: 'Name',
-    render: (rowData: FapAssignedMember) =>
-      rowData.preferredname ? rowData.preferredname : rowData.firstname,
+    render: (rowData: FapAssignedMember) => getPreferredName(rowData),
   },
   { title: 'Surname', field: 'lastname' },
   { title: 'Proposal Count', field: 'proposalsCountByCall' },

apps/frontend/src/components/fap/Proposals/FapAssignedReviewersTable.tsx

@@ -22,6 +22,7 @@ import {
 } from 'hooks/fap/useFapProposalsData';
 import { tableIcons } from 'utils/materialIcons';
 import useDataApiWithFeedback from 'utils/useDataApiWithFeedback';
+import { getPreferredName } from 'utils/user';
 
 import RankInputModal from './RankInputModal';
 
@@ -107,11 +108,7 @@ const FapAssignedReviewersTable = ({
     {
       title: 'First name',
       render: (rowData: FapProposalAssignmentType) =>
-        rowData.user
-          ? rowData.user.preferredname
-            ? rowData.user.preferredname
-            : rowData.user.firstname
-          : '-',
+        rowData.user ? getPreferredName(rowData.user) : '-',
     },
     {
       title: 'Last name',

apps/frontend/src/components/fap/Proposals/MultiRankAssignmentDialog.tsx

@@ -18,6 +18,7 @@ import { useTheme } from '@mui/material/styles';
 import React, { ChangeEvent } from 'react';
 
 import { BasicUserDetails } from 'generated/sdk';
+import { getPreferredName } from 'utils/user';
 
 import { FapAssignedMember } from './AssignFapMemberToProposalModal';
 
@@ -94,7 +95,7 @@ export const MultiRankAssignmentDialog = ({
                   }}
                 >
                   <TableCell component="th" scope="row">
-                    {row.preferredname ? row.preferredname : row.firstname}
+                    {getPreferredName(row)}
                   </TableCell>
                   <TableCell align="left">{row.lastname}</TableCell>
                   <TableCell align="right">

apps/frontend/src/components/proposal/ProposalTableInstrumentScientist.tsx

@@ -63,7 +63,7 @@ import {
 } from 'utils/helperFunctions';
 import { tableIcons } from 'utils/materialIcons';
 import useDataApiWithFeedback from 'utils/useDataApiWithFeedback';
-import { getFullUserName } from 'utils/user';
+import { getFullUserName, getPreferredName } from 'utils/user';
 import withConfirm, { WithConfirmType } from 'utils/withConfirm';
 
 import ProposalAttachmentDownload from './ProposalAttachmentDownload';
@@ -110,21 +110,10 @@ let columns: Column<ProposalViewData>[] = [
     title: 'Principal Investigator',
     field: 'principalInvestigator',
     emptyValue: '-',
-    render: (proposalView) => {
-      if (
-        proposalView.principalInvestigator?.lastname &&
-        proposalView.principalInvestigator?.preferredname
-      ) {
-        return `${proposalView.principalInvestigator.lastname}, ${proposalView.principalInvestigator.preferredname}`;
-      } else if (
-        proposalView.principalInvestigator?.lastname &&
-        proposalView.principalInvestigator?.firstname
-      ) {
-        return `${proposalView.principalInvestigator.lastname}, ${proposalView.principalInvestigator.firstname}`;
-      }
-
-      return '';
-    },
+    render: (proposalView) =>
+      proposalView.principalInvestigator?.lastname
+        ? `${proposalView.principalInvestigator.lastname}, ${getPreferredName(proposalView.principalInvestigator)}`
+        : '',
   },
   {
     title: 'PI Email',

apps/frontend/src/components/proposal/ProposalTableOfficer.tsx

@@ -77,7 +77,7 @@ import {
 } from 'utils/helperFunctions';
 import { tableIcons } from 'utils/materialIcons';
 import useDataApiWithFeedback from 'utils/useDataApiWithFeedback';
-import { getFullUserName } from 'utils/user';
+import { getFullUserName, getPreferredName } from 'utils/user';
 import withConfirm, { WithConfirmType } from 'utils/withConfirm';
 
 import CallSelectModalOnProposalsClone from './CallSelectModalOnProposalClone';
@@ -129,21 +129,10 @@ let columns: Column<ProposalViewData>[] = [
     field: 'principalInvestigator',
     sorting: false,
     emptyValue: '-',
-    render: (proposalView) => {
-      if (
-        proposalView.principalInvestigator?.lastname &&
-        proposalView.principalInvestigator?.preferredname
-      ) {
-        return `${proposalView.principalInvestigator.lastname}, ${proposalView.principalInvestigator.preferredname}`;
-      } else if (
-        proposalView.principalInvestigator?.lastname &&
-        proposalView.principalInvestigator?.firstname
-      ) {
-        return `${proposalView.principalInvestigator.lastname}, ${proposalView.principalInvestigator.firstname}`;
-      }
-
-      return '';
-    },
+    render: (proposalView) =>
+      proposalView.principalInvestigator?.lastname
+        ? `${proposalView.principalInvestigator.lastname}, ${getPreferredName(proposalView.principalInvestigator)}`
+        : '',
   },
   {
     title: 'PI Email',

apps/frontend/src/components/techniqueProposal/TechniqueProposalTable.tsx

@@ -59,6 +59,7 @@ import {
 } from 'utils/helperFunctions';
 import { tableIcons } from 'utils/materialIcons';
 import useDataApiWithFeedback from 'utils/useDataApiWithFeedback';
+import { getPreferredName } from 'utils/user';
 import withConfirm, { WithConfirmType } from 'utils/withConfirm';
 
 import ProposalScientistComment from './ProposalScientistComment';
@@ -284,11 +285,7 @@ const TechniqueProposalTable = ({ confirm }: { confirm: WithConfirmType }) => {
       sorting: false,
       render: (proposalView: ProposalViewData) => {
         if (proposalView.principalInvestigator?.lastname) {
-          if (proposalView.principalInvestigator?.preferredname) {
-            return `${proposalView.principalInvestigator.lastname}, ${proposalView.principalInvestigator.preferredname}`;
-          } else if (proposalView.principalInvestigator?.firstname) {
-            return `${proposalView.principalInvestigator.lastname}, ${proposalView.principalInvestigator.firstname}`;
-          }
+          return `${proposalView.principalInvestigator.lastname}, ${getPreferredName(proposalView.principalInvestigator)}`;
         }
 
         return '';