feat: role based translations

.github/workflows/test-build.yml

@@ -496,6 +496,7 @@ jobs:
           FBS_EMAIL: FacilitiesBusinessSystem@stfc.ac.uk
           PROFILE_PAGE_LINK: http://localhost:9003/auth/ManageDetails.aspx
           EXTERNAL_AUTH_HOMEPAGE_URL: http://localhost:9003/auth/Menu.aspx
+          TRANSLATION_PATH: /config/locales/
         run: |
           REPO_DIR_NAME=$(basename $GITHUB_WORKSPACE)
 

apps/backend/i18next.ts

@@ -0,0 +1,20 @@
+import path from 'path';
+
+import i18next from 'i18next';
+import Backend from 'i18next-fs-backend';
+
+i18next.use(Backend).init({
+  initAsync: false,
+  lng: 'override',
+  fallbackLng: 'override',
+  backend: {
+    loadPath: path.resolve(
+      process.env.TRANSLATION_PATH || '',
+      '{{lng}}/translation.json'
+    ),
+  },
+});
+
+i18next.languages = ['override'];
+
+export default i18next;

apps/backend/package.json

@@ -69,6 +69,8 @@
     "graphql": "^16.13.2",
     "graphql-request": "^7.4.0",
     "graphql-tag": "^2.12.6",
+    "i18next": "^26.3.4",
+    "i18next-fs-backend": "^2.6.6",
     "jsonpath": "^1.2.1",
     "jsonwebtoken": "^9.0.1",
     "knex": "^3.1.0",
@@ -101,6 +103,7 @@
     "@types/email-templates": "^8.0.4",
     "@types/express": "^4.17.13",
     "@types/express-jwt": "^6.0.4",
+    "@types/i18n": "^0.13.12",
     "@types/jest": "^29.5.6",
     "@types/jsonpath": "^0.2.0",
     "@types/jsonwebtoken": "^9.0.2",

apps/backend/src/auth/UserAuthorization.ts

@@ -7,6 +7,7 @@ import { Tokens } from '../config/Tokens';
 import { FapDataSource } from '../datasources/FapDataSource';
 import { InternalReviewDataSource } from '../datasources/InternalReviewDataSource';
 import { ProposalDataSource } from '../datasources/ProposalDataSource';
+import { RoleDataSource } from '../datasources/RoleDataSource';
 import { UserDataSource } from '../datasources/UserDataSource';
 import { VisitDataSource } from '../datasources/VisitDataSource';
 import { Institution } from '../models/Institution';
@@ -36,6 +37,10 @@ export abstract class UserAuthorization {
     Tokens.AdminDataSource
   );
 
+  protected roleDataSource: RoleDataSource = container.resolve(
+    Tokens.RoleDataSource
+  );
+
   protected getUniqueId(user: ValidUserInfo) {
     return user.sub;
   }
@@ -197,6 +202,12 @@ export abstract class UserAuthorization {
     return readableUsers.includes(id);
   }
 
+  async getCurrentRoleTags(agent: UserWithRole | null) {
+    return agent?.currentRole?.id == null
+      ? []
+      : this.roleDataSource.getTagsByRoleId(agent.currentRole.id);
+  }
+
   abstract externalTokenLogin(
     token: string,
     redirectUri: string,

apps/backend/src/datasources/stfc/StfcUserDataSource.spec.ts

@@ -1,6 +1,7 @@
 import { StfcUserDataSource } from './StfcUserDataSource';
 import { Roles, createRole } from '../../models/Role';
 import { dummyUser } from '../mockups/UserDataSource';
+import RoleDataSource from '../postgres/RoleDataSource';
 import PostgresUserDataSource from '../postgres/UserDataSource';
 
 jest.mock('../postgres/UserDataSource.ts');
@@ -164,6 +165,12 @@ describe('Role tests', () => {
     );
     mockGetUserRoles.mockImplementation(() => Promise.resolve([]));
 
+    const mockGetTagsByRoleId = jest.spyOn(
+      RoleDataSource.prototype,
+      'getTagsByRoleId'
+    );
+    mockGetTagsByRoleId.mockImplementation(() => Promise.resolve([]));
+
     const mockEnsureDummyUserExists = jest.spyOn(
       StfcUserDataSource.prototype,
       'ensureDummyUserExists'
@@ -187,6 +194,7 @@ describe('Role tests', () => {
         title: 'User',
         description: '',
         isRootRole: true,
+        tags: [],
       })
     );
   });
@@ -198,16 +206,25 @@ describe('Role tests', () => {
       userdataSource.getUserRoles(dummyUserNumber)
     ).resolves.toEqual(
       expect.arrayContaining([
-        createRole(1, Roles.USER, 'User', '', { note: '' }, true),
-        createRole(2, Roles.USER_OFFICER, 'User Officer', '', {}, true),
-        createRole(
-          3,
-          Roles.INSTRUMENT_SCIENTIST,
-          'Instrument Scientist',
-          '',
-          {},
-          true
-        ),
+        {
+          ...createRole(1, Roles.USER, 'User', '', { note: '' }, true),
+          tags: [],
+        },
+        {
+          ...createRole(2, Roles.USER_OFFICER, 'User Officer', '', {}, true),
+          tags: [],
+        },
+        {
+          ...createRole(
+            3,
+            Roles.INSTRUMENT_SCIENTIST,
+            'Instrument Scientist',
+            '',
+            {},
+            true
+          ),
+          tags: [],
+        },
       ])
     );
   });

apps/backend/src/datasources/stfc/StfcUserDataSource.ts

@@ -1,5 +1,6 @@
 import { logger } from '@user-office-software/duo-logger';
 
+import { createUOWSClient } from './UOWSClient';
 import { BasicPersonDetailsDTO } from '../../../generated/models/BasicPersonDetailsDTO';
 import { PermissionUserGroupDTO } from '../../../generated/models/PermissionUserGroupDTO';
 import { RoleDTO } from '../../../generated/models/RoleDTO';
@@ -12,11 +13,12 @@ import { UpdateUserByIdArgs } from '../../resolvers/mutations/UpdateUserMutation
 import { UsersArgs } from '../../resolvers/queries/UsersQuery';
 import { Cache } from '../../utils/Cache';
 import { PaginationSortDirection } from '../../utils/pagination';
+import RoleDataSource from '../postgres/RoleDataSource';
 import PostgresUserDataSource from '../postgres/UserDataSource';
 import { UserDataSource } from '../UserDataSource';
-import { createUOWSClient } from './UOWSClient';
 
 const postgresUserDataSource = new PostgresUserDataSource();
+const roleDataSource = new RoleDataSource();
 
 const UOWSClient = createUOWSClient();
 
@@ -454,6 +456,7 @@ export class StfcUserDataSource implements UserDataSource {
 
     return stfcRawRolesRequest!;
   }
+
   async getUserRoles(id: number): Promise<Role[]> {
     const cachedRoles = this.uopRolesCache.get(String(id));
     if (cachedRoles) {
@@ -477,6 +480,8 @@ export class StfcUserDataSource implements UserDataSource {
       return [];
     }
 
+    userRole.tags = await roleDataSource.getTagsByRoleId(userRole.id);
+
     if (!stfcRoles || stfcRoles.length == 0) {
       return [userRole];
     }
@@ -490,6 +495,12 @@ export class StfcUserDataSource implements UserDataSource {
 
     const uniqueRoles: Role[] = [...new Set(combinedUserRoles)];
 
+    for (let i = 0; i < uniqueRoles.length; i++) {
+      uniqueRoles[i].tags = await roleDataSource.getTagsByRoleId(
+        uniqueRoles[i].id
+      );
+    }
+
     uniqueRoles.sort((a, b) => a.id - b.id);
 
     const userRoles = [userRole, ...uniqueRoles];

apps/backend/src/middlewares/factory/xlsx.ts

@@ -1,6 +1,7 @@
 import express from 'express';
 import { container } from 'tsyringe';
 
+import i18next from '../../../i18next';
 import { UserAuthorization } from '../../auth/UserAuthorization';
 import { Tokens } from '../../config/Tokens';
 import callFactoryService, {
@@ -165,13 +166,26 @@ router.get(`/${XLSXType.CALL_FAP}/:call_id`, async (req, res, next) => {
 });
 
 router.get(`/${XLSXType.TECHNIQUE}/:proposal_pks`, async (req, res, next) => {
+  const userAuthorization = container.resolve<UserAuthorization>(
+    Tokens.UserAuthorization
+  );
+
+  const userWithRole = {
+    ...res.locals.agent,
+  };
+
+  const roleTags = await userAuthorization.getCurrentRoleTags(userWithRole);
+  const translationForFirstRoleTag = !roleTags.length
+    ? ''
+    : roleTags[0].name + '.';
+
   const techniqueProposalDataColumns = [
     'Proposal ID',
     'Title',
     'Principal Investigator',
     'PI Email',
     'Date Submitted',
-    'Technique',
+    i18next.t(`${translationForFirstRoleTag}Technique`),
     'Instrument',
     'Status',
   ];
@@ -181,19 +195,11 @@ router.get(`/${XLSXType.TECHNIQUE}/:proposal_pks`, async (req, res, next) => {
       throw new Error('Not authorized');
     }
 
-    const userWithRole = {
-      ...res.locals.agent,
-    };
-
     const proposalPks: number[] = req.params.proposal_pks
       .split(',')
       .map((n: string) => parseInt(n))
       .filter((id: number) => !isNaN(id));
 
-    const userAuthorization = container.resolve<UserAuthorization>(
-      Tokens.UserAuthorization
-    );
-
     if (
       !userAuthorization.isUserOfficer(userWithRole) &&
       !userAuthorization.isInstrumentScientist(userWithRole)

apps/backend/src/models/Role.ts

@@ -1,3 +1,5 @@
+import { Tag } from './Tag';
+
 export enum Roles {
   USER = 'user',
   USER_OFFICER = 'user_officer',
@@ -23,6 +25,7 @@ type RoleBase = {
   title: string;
   description: string;
   isRootRole: boolean;
+  tags?: Tag[];
 };
 
 export type Role =

apps/frontend/src/components/common/proposalFilters/TechniqueFilter.tsx

@@ -5,10 +5,11 @@ import InputLabel from '@mui/material/InputLabel';
 import ListSubheader from '@mui/material/ListSubheader';
 import MenuItem from '@mui/material/MenuItem';
 import Select from '@mui/material/Select';
-import React, { Dispatch } from 'react';
+import React, { useContext, Dispatch } from 'react';
 import { useTranslation } from 'react-i18next';
 import { useSearchParams } from 'react-router-dom';
 
+import { UserContext } from 'context/UserContextProvider';
 import { TechniqueMinimalFragment, TechniqueFilterInput } from 'generated/sdk';
 
 export enum TechniqueFilterEnum {
@@ -35,18 +36,24 @@ const TechniqueFilter = ({
   shouldShowMultiple,
   showMultiTechniqueProposals,
 }: TechniqueFilterProps) => {
+  const { roles, currentRoleId } = useContext(UserContext);
   const [, setSearchParams] = useSearchParams();
   const { t } = useTranslation();
 
   if (techniques === undefined) {
     return null;
   }
 
+  const currentRoleTags = roles.find((r) => currentRoleId === r.id)!.tags;
+  const currentRoleFirstTagName = currentRoleTags?.length
+    ? currentRoleTags[0].name
+    : '';
+
   return (
     <>
       <FormControl fullWidth>
         <InputLabel id="technique-select-label" shrink>
-          {t('Technique')}
+          {t(`${currentRoleFirstTagName}.Technique`)}
         </InputLabel>
         {isLoading ? (
           <Box sx={{ minHeight: '32px', marginTop: '16px' }}>Loading...</Box>