Merge pull request #1128 from rocket-admin/backend_additional_users_in_company_info

Enhance user retrieval and membership information in company use case

Author: Artuomka

backend/src/entities/company-info/use-cases/get-all-users-in-company.use.case.ts

@@ -30,24 +30,42 @@ export class GetAllUsersInCompanyUseCase
         HttpStatus.NOT_FOUND,
       );
     }
+    const foundUsers = foundCompany.users;
 
-    const foundUsers: SimpleFoundUserInCompanyInfoDs[] = foundCompany.users
-      .map((user) => {
-        const simpleUserInfoDs = buildSimpleUserInfoDs(user);
-        return { ...simpleUserInfoDs, has_groups: false };
-      })
-      .filter((user) => user !== null);
+    const responseObjects: Array<SimpleFoundUserInCompanyInfoDs> = [];
 
     const queue = new PQueue({ concurrency: 3 });
-
     await Promise.all(
       foundUsers.map(async (user) => {
         await queue.add(async () => {
-          const userGroupsCount = await this._dbContext.groupRepository.countAllUserGroups(user.id);
-          user.has_groups = userGroupsCount > 0;
+          if (!user) {
+            return;
+          }
+          const usersConnectionsWithGroups = await this._dbContext.connectionRepository.findAllUserNonTestsConnections(
+            user.id,
+          );
+          const userInfo = buildSimpleUserInfoDs(user);
+          const userRO: SimpleFoundUserInCompanyInfoDs = {
+            ...userInfo,
+            user_membership: usersConnectionsWithGroups.map((connection) => {
+              return {
+                id: connection.id,
+                title: connection.title,
+                database: connection.database,
+                groups: connection.groups.map((group) => {
+                  return {
+                    id: group.id,
+                    title: group.title,
+                  };
+                }),
+              };
+            }),
+            has_groups: usersConnectionsWithGroups.length > 0,
+          };
+          responseObjects.push(userRO);
         });
       }),
     );
-    return foundUsers;
+    return responseObjects;
   }
 }

backend/src/entities/user/dto/found-user.dto.ts

@@ -74,7 +74,32 @@ export class SimpleFoundUserInfoDs {
   externalRegistrationProvider: ExternalRegistrationProviderEnum;
 }
 
+export class UserGroupMembershipDto {
+  @ApiProperty()
+  id: string;
+
+  @ApiProperty()
+  title: string;
+}
+
+export class UserConnectionMembershipDto {
+  @ApiProperty()
+  id: string;
+
+  @ApiProperty()
+  title: string;
+
+  @ApiProperty()
+  database: string;
+
+  @ApiProperty({ type: UserConnectionMembershipDto, isArray: true })
+  groups: Array<UserGroupMembershipDto>;
+}
+
 export class SimpleFoundUserInCompanyInfoDs extends SimpleFoundUserInfoDs {
   @ApiProperty()
   has_groups: boolean;
+
+  @ApiProperty({ type: UserConnectionMembershipDto, isArray: true })
+  user_membership: Array<UserConnectionMembershipDto>;
 }

backend/src/entities/user/utils/build-created-user.ds.ts

@@ -1,6 +1,6 @@
-import { UserEntity } from '../user.entity.js';
 import { CreatedUserDs } from '../application/data-structures/created-user.ds.js';
 import { SimpleFoundUserInfoDs } from '../dto/found-user.dto.js';
+import { UserEntity } from '../user.entity.js';
 
 export function buildCreatedUserDs(user: UserEntity): CreatedUserDs {
   return {
@@ -26,4 +26,4 @@ export function buildSimpleUserInfoDs(user: UserEntity): SimpleFoundUserInfoDs {
     role: user.role,
     externalRegistrationProvider: user.externalRegistrationProvider,
   };
-}
+}

backend/test/ava-tests/saas-tests/company-info-e2e.test.ts

@@ -595,6 +595,33 @@ test.serial(`${currentTest} should return users in company`, async (t) => {
   t.is(usersInCompany.status, 200);
   const usersInCompanyRO = JSON.parse(usersInCompany.text);
   t.is(usersInCompanyRO.length, 2);
+
+  usersInCompanyRO.forEach((user) => {
+    t.true('id' in user);
+    t.true('isActive' in user);
+    t.true('email' in user);
+    t.true('createdAt' in user);
+    t.true('suspended' in user);
+    t.true('name' in user);
+    t.true('is_2fa_enabled' in user);
+    t.true('role' in user);
+    t.true('externalRegistrationProvider' in user);
+    t.true('user_membership' in user);
+    t.true('has_groups' in user);
+
+    t.true(Array.isArray(user.user_membership));
+    user.user_membership.forEach((user_membership) => {
+      t.true('id' in user_membership);
+      t.true('title' in user_membership);
+      t.true('database' in user_membership);
+      t.true(Array.isArray(user_membership.groups));
+      user_membership.groups.forEach((group) => {
+        t.true('id' in group);
+        t.true('title' in group);
+        t.is(Object.keys(group).length, 2);
+      });
+    });
+  });
 });
 
 currentTest = `PUT company/users/roles/:companyId`;