Merge branch 'develop' into haydnba/test-external-api-errors-not-prop…

…agated

package.json

@@ -30,13 +30,15 @@
   },
   "dependencies": {
     "@mailchimp/mailchimp_marketing": "^3.0.80",
+    "@nestjs/axios": "^3.0.2",
     "@nestjs/common": "^10.3.6",
     "@nestjs/config": "^3.2.2",
     "@nestjs/core": "^10.3.6",
     "@nestjs/platform-express": "^10.3.7",
     "@nestjs/swagger": "^7.3.1",
+    "@nestjs/terminus": "^10.2.3",
     "@nestjs/typeorm": "^10.0.2",
-    "axios": "^1.6.8",
+    "axios": "^1.7.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "date-fns": "^3.6.0",

src/app.module.ts

@@ -8,6 +8,7 @@ import { CourseUserModule } from './course-user/course-user.module';
 import { CourseModule } from './course/course.module';
 import { EventLoggerModule } from './event-logger/event-logger.module';
 import { FeatureModule } from './feature/feature.module';
+import { HealthModule } from './health/health.module';
 import { LoggerModule } from './logger/logger.module';
 import { PartnerAccessModule } from './partner-access/partner-access.module';
 import { PartnerAdminModule } from './partner-admin/partner-admin.module';
@@ -39,6 +40,7 @@ import { WebhooksModule } from './webhooks/webhooks.module';
     FeatureModule,
     PartnerFeatureModule,
     EventLoggerModule,
+    HealthModule,
   ],
 })
 export class AppModule {}

src/health/health.controller.spec.ts

@@ -0,0 +1,21 @@
+import { HttpModule } from '@nestjs/axios';
+import { TerminusModule } from '@nestjs/terminus';
+import { Test, TestingModule } from '@nestjs/testing';
+import { HealthController } from './health.controller';
+
+describe('HealthController', () => {
+  let controller: HealthController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      imports: [TerminusModule, HttpModule],
+      controllers: [HealthController],
+    }).compile();
+
+    controller = module.get<HealthController>(HealthController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

src/health/health.controller.ts

@@ -0,0 +1,35 @@
+import { Controller, Get } from '@nestjs/common';
+import {
+  HealthCheck,
+  HealthCheckService,
+  HttpHealthIndicator,
+  TypeOrmHealthIndicator,
+} from '@nestjs/terminus';
+import { frontendAppUrl } from 'src/utils/constants';
+
+@Controller('ping')
+export class HealthController {
+  constructor(
+    private readonly health: HealthCheckService,
+    private readonly http: HttpHealthIndicator,
+    private readonly db: TypeOrmHealthIndicator,
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  ping() {
+    return 'ok';
+  }
+
+  @Get('/frontend')
+  @HealthCheck()
+  checkFrontend() {
+    return this.health.check([() => this.http.pingCheck('frontend', frontendAppUrl)]);
+  }
+
+  @Get('/database')
+  @HealthCheck()
+  checkDatabase() {
+    return this.health.check([() => this.db.pingCheck('database')]);
+  }
+}

src/health/health.module.ts

@@ -0,0 +1,10 @@
+import { HttpModule } from '@nestjs/axios';
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+import { HealthController } from './health.controller';
+
+@Module({
+  imports: [TerminusModule, HttpModule],
+  controllers: [HealthController],
+})
+export class HealthModule {}

src/main.ts

@@ -13,6 +13,9 @@ async function bootstrap() {
 
   app.setGlobalPrefix('api');
 
+  // Starts listening for shutdown hooks
+  app.enableShutdownHooks();
+
   const options = new DocumentBuilder()
     .setTitle('Bloom backend API')
     .setDescription('Bloom backend API')

src/partner-access/partner-access.service.spec.ts

@@ -62,6 +62,8 @@ describe('PartnerAccessService', () => {
   let mockPartnerAccessRepository: DeepMocked<Repository<PartnerAccessEntity>>;
 
   beforeEach(async () => {
+    jest.clearAllMocks();
+
     mockPartnerRepository = createMock<Repository<PartnerEntity>>(mockPartnerRepositoryMethods);
     mockPartnerAccessRepository = createMock<Repository<PartnerAccessEntity>>(
       mockPartnerAccessRepositoryMethods,
@@ -138,7 +140,7 @@ describe('PartnerAccessService', () => {
         return {
           ...mockPartnerAccessEntity,
           id: 'pa1',
-          userId: mockGetUserDto.user.id,
+          userId: mockUserEntity.id,
         };
       });
       // Mocks that the accesscode already exists
@@ -150,13 +152,12 @@ describe('PartnerAccessService', () => {
 
       expect(partnerAccess).toEqual({
         ...mockPartnerAccessEntity,
-        id: 'pa1',
         userId: mockUserEntity.id,
         activatedAt: partnerAccess.activatedAt,
       });
 
       expect(profileData.updateServiceUserProfilesPartnerAccess).toHaveBeenCalledWith(
-        [partnerAccess],
+        [mockPartnerAccessEntity],
         mockUserEntity.email,
       );
     });

src/partner-access/partner-access.service.ts

@@ -187,9 +187,12 @@ export class PartnerAccessService {
     assignedPartnerAccess.partner = partnerAccess.partner;
 
     try {
-      const partnerAccesses = await this.partnerAccessRepository.findBy({
-        userId: user.id,
-        active: true,
+      const partnerAccesses = await this.partnerAccessRepository.find({
+        where: {
+          userId: user.id,
+          active: true,
+        },
+        relations: { partner: true },
       });
       await updateServiceUserProfilesPartnerAccess(partnerAccesses, user.email);
     } catch (error) {

src/utils/constants.ts

@@ -53,17 +53,26 @@ export enum COMMUNICATION_SERVICE {
   MAILCHIMP = 'MAILCHIMP',
 }
 
+export enum ENVIRONMENTS {
+  DEVELOPMENT = 'development',
+  STAGING = 'staging',
+  PRODUCTION = 'production',
+  TEST = 'test',
+}
+
 const getEnv = (env: string, envName: string): string => {
   try {
-    if (!env) throw `Unable to get environemt variable ${envName}`;
+    if (!env) throw `Unable to get environment variable ${envName}`;
 
     return env;
   } catch (error) {
-    console.log(error);
+    if (nodeEnv !== ENVIRONMENTS.TEST) console.log(error);
   }
 };
 
-export const isProduction = getEnv(process.env.NODE_ENV, 'NODE_ENV') === 'production';
+export const nodeEnv = getEnv(process.env.NODE_ENV, 'NODE_ENV');
+export const isProduction = nodeEnv === ENVIRONMENTS.PRODUCTION;
+export const frontendAppUrl = getEnv(process.env.FRONTEND_APP_URL, 'FRONTEND_APP_URL');
 
 export const rollbarEnv = getEnv(process.env.ROLLBAR_ENV, 'ROLLBAR_ENV');
 export const rollbarToken = getEnv(process.env.ROLLBAR_TOKEN, 'ROLLBAR_TOKEN');

src/utils/serviceUserProfiles.ts

@@ -208,6 +208,11 @@ export const serializePartnersString = (partnerAccesses: PartnerAccessEntity[])
   return partnerAccesses?.map((pa) => pa.partner.name.toLowerCase()).join('; ') || '';
 };
 
+const serializeCrispPartnerSegments = (partners: PartnerEntity[]) => {
+  if (!partners.length) return ['public'];
+  return partners.map((p) => p.name.toLowerCase());
+};
+
 const serializeUserData = (user: UserEntity) => {
   const { name, signUpLanguage, contactPermission, serviceEmailsPermission } = user;
 
@@ -356,8 +361,3 @@ const serializeCourseData = (courseUser: CourseUserEntity) => {
 
   return { crispSchema, mailchimpSchema };
 };
-
-const serializeCrispPartnerSegments = (partners: PartnerEntity[]) => {
-  if (!partners.length) return ['public'];
-  return partners.map((p) => p.name.toLowerCase());
-};

test/utils/mockedServices.ts

@@ -35,7 +35,6 @@ import {
   mockTherapySessionEntity,
   mockUserEntity,
   mockUserRecord,
-  partnerAccessArray,
 } from './mockData';
 import { createQueryBuilderMock } from './mockUtils';
 
@@ -209,11 +208,8 @@ export const mockPartnerAccessRepositoryMethods: PartialFuncReturn<
   findBy: async (arg) => {
     return [{ ...mockPartnerAccessEntity, ...(arg ? { ...arg } : {}) }] as PartnerAccessEntity[];
   },
-  find: async (arg) => {
-    return [
-      ...partnerAccessArray,
-      { ...mockPartnerAccessEntity, ...(arg ? { ...arg } : {}) },
-    ] as PartnerAccessEntity[];
+  find: async () => {
+    return [{ ...mockPartnerAccessEntity }] as PartnerAccessEntity[];
   },
   save: async (arg) => arg as PartnerAccessEntity,
 };