refactor getUsers service method to return UserEntity and fix types

Author: eleanorreem

src/user/user.controller.ts

@@ -14,6 +14,7 @@ import { ApiBearerAuth, ApiBody, ApiOperation, ApiParam, ApiTags } from '@nestjs
 import { Request } from 'express';
 import { UserEntity } from 'src/entities/user.entity';
 import { SuperAdminAuthGuard } from 'src/partner-admin/super-admin-auth.guard';
+import { formatUserObject } from 'src/utils/serialize';
 import { FirebaseAuthGuard } from '../firebase/firebase-auth.guard';
 import { ControllerDecorator } from '../utils/controller.decorator';
 import { CreateUserDto } from './dtos/create-user.dto';
@@ -109,7 +110,8 @@ export class UserController {
     const { include, fields, limit, ...userQuery } = query.searchCriteria
       ? JSON.parse(query.searchCriteria)
       : { include: [], fields: [], limit: undefined };
-    return await this.userService.getUsers(userQuery, include, fields, limit);
+    const users = await this.userService.getUsers(userQuery, include || [], fields, limit);
+    return users.map((u) => formatUserObject(u));
   }
 
   // Use only if users have not been added to mailchimp due to e.g. an ongoing bug

src/user/user.service.spec.ts

@@ -515,22 +515,11 @@ describe('UserService', () => {
   // TODO - Extend getUser tests. At the moment, this is only used by super admins
   describe('getUsers', () => {
     it('getUsers', async () => {
-      const {
-        subscriptionUser,
-        therapySession,
-        partnerAdmin,
-        partnerAccess,
-        contactPermission,
-        serviceEmailsPermission,
-        courseUser,
-        eventLog,
-        ...userBase
-      } = mockUserEntity;
       jest
         .spyOn(repo, 'find')
         .mockImplementationOnce(async () => [{ ...mockUserEntity, email: '[email protected]' }]);
-      const users = await service.getUsers({ email: '[email protected]' }, {}, [], 10);
-      expect(users).toEqual([{ user: { ...userBase, email: '[email protected]' }, partnerAccesses: [] }]);
+      const users = await service.getUsers({ email: '[email protected]' }, [], [], 10);
+      expect(users).toEqual([{ ...mockUserEntity, email: '[email protected]' }]);
     });
   });
 });

src/user/user.service.ts

@@ -18,7 +18,7 @@ import { And, ILike, IsNull, Not, Raw, Repository } from 'typeorm';
 import { deleteCypressCrispProfiles } from '../api/crisp/crisp-api';
 import { AuthService } from '../auth/auth.service';
 import { PartnerAccessService, basePartnerAccess } from '../partner-access/partner-access.service';
-import { formatGetUsersObject, formatUserObject } from '../utils/serialize';
+import { formatUserObject } from '../utils/serialize';
 import { generateRandomString } from '../utils/utils';
 import { CreateUserDto } from './dtos/create-user.dto';
 import { GetUserDto } from './dtos/get-user.dto';
@@ -265,20 +265,12 @@ export class UserService {
       partnerAccess?: { userId: string; featureTherapy: boolean; active: boolean };
       partnerAdmin?: { partnerAdminId: string };
     },
-    relations: {
-      partner?: boolean;
-      partnerAccess?: boolean;
-      partnerAdmin?: boolean;
-      courseUser?: boolean;
-      subscriptionUser?: boolean;
-      therapySession?: boolean;
-      eventLog?: boolean;
-    },
+    relations: string[],
     fields: Array<string>,
     limit: number,
-  ): Promise<GetUserDto[] | undefined> {
+  ): Promise<UserEntity[] | undefined> {
     const users = await this.userRepository.find({
-      relations: relations,
+      relations,
       where: {
         ...(filters.email && { email: ILike(`%${filters.email}%`) }),
         ...(filters.partnerAccess && {
@@ -305,9 +297,7 @@ export class UserService {
       },
       ...(limit && { take: limit }),
     });
-
-    const usersDto = users.map((user) => formatGetUsersObject(user));
-    return usersDto;
+    return users;
   }
 
   // Static bulk upload function to be used in specific cases