feat: implement stfc dynamic roles (#1442)

mutambaraf · web-flow · commit f456a4a4294e · 2026-04-07T14:01:36.000+01:00
diff --git a/apps/backend/src/datasources/stfc/StfcUserDataSource.spec.ts b/apps/backend/src/datasources/stfc/StfcUserDataSource.spec.ts
@@ -1,5 +1,6 @@
 import { Role, Roles } from '../../models/Role';
 import { dummyUser } from '../mockups/UserDataSource';
+import PostgresUserDataSource from '../postgres/UserDataSource';
 import { StfcUserDataSource } from './StfcUserDataSource';
 
 jest.mock('../postgres/UserDataSource.ts');
@@ -157,6 +158,12 @@ describe('Role tests', () => {
       ])
     );
 
+    const mockGetUserRoles = jest.spyOn(
+      PostgresUserDataSource.prototype,
+      'getUserRoles'
+    );
+    mockGetUserRoles.mockImplementation(() => Promise.resolve([]));
+
     const mockEnsureDummyUserExists = jest.spyOn(
       StfcUserDataSource.prototype,
       'ensureDummyUserExists'
@@ -181,7 +188,7 @@ describe('Role tests', () => {
     );
   });
 
-  test('When getting roles for a user, STFC roles are translated into ESS roles', async () => {
+  test('When getting roles for a user, STFC roles are translated into UO system roles', async () => {
     const userdataSource = new StfcUserDataSource();
 
     return expect(
diff --git a/apps/backend/src/datasources/stfc/StfcUserDataSource.ts b/apps/backend/src/datasources/stfc/StfcUserDataSource.ts
@@ -25,7 +25,7 @@ type StfcRolesToEssRole = { [key: string]: Roles[] };
 /*
  * Must not contain user role, this is appended at the very last step.
  */
-const stfcRolesToEssRoleDefinitions: StfcRolesToEssRole = {
+const stfcRolesToSystemRoleDefinitions: StfcRolesToEssRole = {
   'User Officer': [Roles.USER_OFFICER, Roles.INSTRUMENT_SCIENTIST],
   'ISIS Instrument Scientist': [Roles.INSTRUMENT_SCIENTIST],
   'CLF Artemis FAP Secretary': [Roles.INSTRUMENT_SCIENTIST],
@@ -395,7 +395,40 @@ export class StfcUserDataSource implements UserDataSource {
   }
 
   async setUserRoles(id: number, roles: number[]): Promise<void> {
-    throw new Error('Method not implemented.');
+    try {
+      const roleDefinitions = await this.getRoles();
+      if (!roleDefinitions) {
+        throw new Error('Role definitions not set up in the system');
+      }
+      const userRole: Role | undefined = roleDefinitions.find(
+        (role) => role.shortCode == Roles.USER
+      );
+      const stfcRoles = await this.getRolesForUser(id);
+
+      const assignedRoleIds = new Set(
+        this.mapStfcRolesToSystemRoleDefinitions(
+          stfcRoles,
+          roleDefinitions
+        ).map((r) => r.id)
+      );
+      const newRolesToAssign = Array.from(new Set(roles)).filter(
+        (roleId) => !assignedRoleIds.has(roleId) && roleId !== userRole?.id
+      );
+
+      if (newRolesToAssign.length > 0) {
+        await postgresUserDataSource.setUserRoles(id, newRolesToAssign);
+        this.stfcRolesCache.remove(String(id));
+        this.uopRolesCache.remove(String(id));
+      }
+
+      return;
+    } catch (error) {
+      logger.logError('Error setting user roles in', {
+        error,
+        userId: id,
+      });
+      throw error;
+    }
   }
   async getRolesForUser(id: number): Promise<RoleDTO[]> {
     const cachedRoles = this.stfcRolesCache.get(String(id));
@@ -417,63 +450,68 @@ export class StfcUserDataSource implements UserDataSource {
 
     return stfcRawRolesRequest!;
   }
-
   async getUserRoles(id: number): Promise<Role[]> {
     const cachedRoles = this.uopRolesCache.get(String(id));
     if (cachedRoles) {
       return cachedRoles;
     }
 
-    const stfcRawRolesRequest = this.getRolesForUser(id);
+    const roleDefinitions = await this.getRoles();
+    if (!roleDefinitions) {
+      return [];
+    }
 
-    const stfcRolesRequest = stfcRawRolesRequest.then((stfcRoles) => {
-      return this.getRoles().then((roleDefinitions) => {
-        const userRole: Role | undefined = roleDefinitions.find(
-          (role) => role.shortCode == Roles.USER
-        );
-        if (!userRole) {
-          return [];
-        }
+    const [assignedSystemUserRoles, stfcRoles] = await Promise.all([
+      postgresUserDataSource.getUserRoles(id),
+      this.getRolesForUser(id),
+    ]);
 
-        if (!stfcRoles || stfcRoles.length == 0) {
-          return [userRole];
-        }
+    const userRole: Role | undefined = roleDefinitions.find(
+      (role) => role.shortCode == Roles.USER
+    );
+    if (!userRole) {
+      return [];
+    }
 
-        /*
-         * Convert the STFC roles to the Roles enums which refers to roles
-         * by short code. We will use the short code to filter relevant
-         * roles.
-         */
-        const userRolesAsEnum: Roles[] = stfcRoles
-          .flatMap((stfcRole) => stfcRolesToEssRoleDefinitions[stfcRole.name!])
-          .filter((r) => r !== undefined) as Roles[];
-
-        /*
-         * Filter relevant roles by short code.
-         */
-        const userRolesAsRole: Role[] = userRolesAsEnum
-          .map((r) => roleDefinitions.find((d) => d.shortCode === r))
-          .filter((r) => r !== undefined) as Role[];
-
-        /*
-         * We can't return non-unique roles.
-         */
-        const uniqueRoles: Role[] = [...new Set(userRolesAsRole)];
-
-        uniqueRoles.sort((a, b) => a.id - b.id);
-
-        /*
-         * Prepend the user role as it must be first.
-         */
-        const userRoles = [userRole, ...uniqueRoles];
-
-        return userRoles;
-      });
-    });
+    if (!stfcRoles || stfcRoles.length == 0) {
+      return [userRole];
+    }
+
+    const externalRoles = this.mapStfcRolesToSystemRoleDefinitions(
+      stfcRoles,
+      roleDefinitions
+    );
+
+    const combinedUserRoles = [...externalRoles, ...assignedSystemUserRoles];
+
+    const uniqueRoles: Role[] = [...new Set(combinedUserRoles)];
+
+    uniqueRoles.sort((a, b) => a.id - b.id);
+
+    const userRoles = [userRole, ...uniqueRoles];
+
+    this.uopRolesCache.put(String(id), Promise.resolve(userRoles));
+
+    return userRoles;
+  }
+
+  private mapStfcRolesToSystemRoleDefinitions(
+    stfcRoles: RoleDTO[] | undefined,
+    roleDefinitions: Role[]
+  ): Role[] {
+    if (!stfcRoles?.length) {
+      return [];
+    }
+
+    const userRolesAsEnum: Roles[] = stfcRoles
+      .flatMap((stfcRole) => stfcRolesToSystemRoleDefinitions[stfcRole.name!])
+      .filter((r) => r !== undefined) as Roles[];
 
-    this.uopRolesCache.put(String(id), stfcRolesRequest);
+    const mappedRoles: Role[] = userRolesAsEnum
+      .map((r) => roleDefinitions.find((d) => d.shortCode === r))
+      .filter((r) => r !== undefined) as Role[];
 
-    return stfcRolesRequest;
+    return mappedRoles;
   }
 
   async getRoles(): Promise<Role[]> {
diff --git a/apps/e2e/cypress/e2e/tag.cy.ts b/apps/e2e/cypress/e2e/tag.cy.ts
@@ -6,7 +6,12 @@ import initialDBData from '../support/initialDBData';
 
 const tagName = faker.word.words(2);
 const tagShortCode = faker.word.words(1);
-
+const dynamicRoleDetails = {
+  id: 11,
+  title: 'Dynamic Proposal Reader',
+  description: 'Role that can only see calls and proposals with specific tags',
+  shortCode: 'proposal_reader',
+};
 const scientist1 = initialDBData.users.user1;
 
 const instrument1 = {
@@ -19,10 +24,7 @@ const instrument1 = {
 context('Tag tests', () => {
   beforeEach(function () {
     cy.getAndStoreFeaturesEnabled().then(() => {
-      if (
-        !featureFlags.getEnabledFeatures().get(FeatureId.TAGS) ||
-        !featureFlags.getEnabledFeatures().get(FeatureId.OAUTH) // TODO implement method setUserRoles in StfcUserDataSource and remove this condition
-      ) {
+      if (!featureFlags.getEnabledFeatures().get(FeatureId.TAGS)) {
         this.skip();
       }
     });
@@ -181,17 +183,17 @@ context('Tag tests', () => {
 
       cy.get('[data-cy="create-new-entry"]').click();
 
-      cy.get('[data-cy="role-title-input"]').type('Dynamic Proposal Reader');
+      cy.get('[data-cy="role-title-input"]').type(dynamicRoleDetails.title);
       cy.get('[data-cy="role-description-input"]').type(
-        'Role that can only see calls and proposals with specific tags'
+        dynamicRoleDetails.description
       );
       cy.get('[data-cy="role-shortcode-select"]').click();
-      cy.get('[role="listbox"]').contains('proposal_reader').click();
+      cy.get('[role="listbox"]').contains(dynamicRoleDetails.shortCode).click();
       cy.get('[data-cy="submit-role-button"]').click();
 
       cy.updateUserRoles({
         id: initialDBData.users.user1.id,
-        roles: [11], // newly created role
+        roles: [dynamicRoleDetails.id], // newly created role
       });
 
       cy.login('user1');
@@ -204,13 +206,21 @@ context('Tag tests', () => {
 
       cy.login('officer');
       cy.visit('/admin/roles');
-      cy.get('[aria-label="Assign Tag"]').click();
+      cy.finishedLoading();
+
+      cy.contains('tr', dynamicRoleDetails.title)
+        .find('[aria-label="Assign Tags"]')
+        .click();
 
-      cy.get('[role="dialog"]').contains(tagName).click();
+      cy.get('[role="dialog"] input[placeholder="Select tags"]')
+        .should('be.visible')
+        .click()
+        .type(tagName);
 
-      cy.get('[role="dialog"] [data-cy="assign-selected-tags"]').click();
+      cy.get('[role="option"]').contains(tagName).should('be.visible').click();
 
-      cy.login('user1');
+      cy.get('[role="dialog"] [data-cy="assign-selected-tags"]').click();
+      cy.login('user1', dynamicRoleDetails.id);
       cy.visit('/Proposals');
 
       cy.contains(title).should('exist');
