feat: adds & updates service user profile related tests for error catching (#478)

* adds generic test for external api call error suppression under the  service users profiles spec

* adds dedicated mailchimp api call fails test for partner access service - requires some extra mocking and minor reorganisation

* adds dedicated crisp and mailchimp api call fail tests for create and update user

* make sure to await the calls on service user profile methods (probably was not an issue in production but under test the runs could complete before mocked methods were called)

* remove the awaits

Author: haydnba

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

@@ -3,6 +3,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { getRepositoryToken } from '@nestjs/typeorm';
 import { sub } from 'date-fns';
 import * as crispApi from 'src/api/crisp/crisp-api';
+import * as mailchimpApi from 'src/api/mailchimp/mailchimp-api';
 import { PartnerEntity } from 'src/entities/partner.entity';
 import { GetUserDto } from 'src/user/dtos/get-user.dto';
 import * as profileData from 'src/utils/serviceUserProfiles';
@@ -46,11 +47,12 @@ jest.mock('src/api/crisp/crisp-api', () => ({
   getCrispProfileData: jest.fn(),
   updateCrispProfileBase: jest.fn(),
   updateCrispProfile: jest.fn(),
-  updateServiceUserProfilesPartnerAccess: jest.fn(),
 }));
 
-jest.mock('src/utils/serviceUserProfiles', () => ({
-  updateServiceUserProfilesPartnerAccess: jest.fn(),
+jest.mock('src/api/mailchimp/mailchimp-api', () => ({
+  createMailchimpMergeField: jest.fn(),
+  createMailchimpProfile: jest.fn(),
+  updateMailchimpProfile: jest.fn(),
 }));
 
 describe('PartnerAccessService', () => {
@@ -143,6 +145,8 @@ describe('PartnerAccessService', () => {
       });
       // Mocks that the accesscode already exists
       jest.spyOn(repo, 'findOne').mockResolvedValueOnce(mockPartnerAccessEntity);
+      // Observer on the service user profiles method
+      jest.spyOn(profileData, 'updateServiceUserProfilesPartnerAccess');
 
       const partnerAccess = await service.assignPartnerAccess(mockUserEntity, '123456');
 
@@ -175,6 +179,23 @@ describe('PartnerAccessService', () => {
       });
     });
 
+    it('should assign partner access even if mailchimp profile api fails', async () => {
+      // Mocks that the accesscode already exists
+      jest.spyOn(repo, 'findOne').mockResolvedValueOnce(mockPartnerAccessEntity);
+
+      jest.spyOn(mailchimpApi, 'updateMailchimpProfile').mockImplementationOnce(async () => {
+        throw new Error('Test throw');
+      });
+
+      const partnerAccess = await service.assignPartnerAccess(mockUserEntity, '123456');
+
+      expect(partnerAccess).toEqual({
+        ...mockPartnerAccessEntity,
+        userId: mockUserEntity.id,
+        activatedAt: partnerAccess.activatedAt,
+      });
+    });
+
     it('should return an error when partner access code has already been used by another user account', async () => {
       jest.spyOn(repo, 'findOne').mockResolvedValueOnce({
         ...mockPartnerAccessEntity,

src/user/user.service.spec.ts

@@ -4,6 +4,7 @@ import { HttpException, HttpStatus } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import { getRepositoryToken } from '@nestjs/typeorm';
 import { createCrispProfile, updateCrispProfile } from 'src/api/crisp/crisp-api';
+import { createMailchimpProfile, updateMailchimpProfile } from 'src/api/mailchimp/mailchimp-api';
 import { PartnerAccessEntity } from 'src/entities/partner-access.entity';
 import { PartnerEntity } from 'src/entities/partner.entity';
 import { SubscriptionUserService } from 'src/subscription-user/subscription-user.service';
@@ -226,6 +227,30 @@ describe('UserService', () => {
         { ...partnerAccessData, therapySessions: [mockTherapySessionDto] },
       ]);
     });
+
+    it('should not fail on crisp api call errors', async () => {
+      const mocked = jest.mocked(createCrispProfile);
+      mocked.mockRejectedValue(new Error('Crisp API call failed'));
+
+      const user = await service.createUser(createUserDto);
+
+      expect(mocked).toHaveBeenCalled();
+      expect(user.user.email).toBe('[email protected]');
+
+      mocked.mockReset();
+    });
+
+    it('should not fail on mailchimp api call errors', async () => {
+      const mocked = jest.mocked(createMailchimpProfile);
+      mocked.mockRejectedValue(new Error('Mailchimp API call failed'));
+
+      const user = await service.createUser(createUserDto);
+
+      expect(mocked).toHaveBeenCalled();
+      expect(user.user.email).toBe('[email protected]');
+
+      mocked.mockReset();
+    });
   });
 
   describe('getUser', () => {
@@ -264,6 +289,32 @@ describe('UserService', () => {
       expect(repoSaveSpy).toHaveBeenCalledWith({ ...mockUserEntity, ...updateUserDto });
       expect(repoSaveSpy).toHaveBeenCalled();
     });
+
+    it('should not fail on crisp api call errors', async () => {
+      const mocked = jest.mocked(updateCrispProfile);
+      mocked.mockRejectedValue(new Error('Crisp API call failed'));
+
+      const user = await service.updateUser(updateUserDto, { user: mockUserEntity });
+
+      expect(mocked).toHaveBeenCalled();
+      expect(user.name).toBe('new name');
+      expect(user.email).toBe('[email protected]');
+
+      mocked.mockReset();
+    });
+
+    it('should not fail on mailchimp api call errors', async () => {
+      const mocked = jest.mocked(updateMailchimpProfile);
+      mocked.mockRejectedValue(new Error('Mailchimp API call failed'));
+
+      const user = await service.updateUser(updateUserDto, { user: mockUserEntity });
+
+      expect(mocked).toHaveBeenCalled();
+      expect(user.name).toBe('new name');
+      expect(user.email).toBe('[email protected]');
+
+      mocked.mockReset();
+    });
   });
 
   describe('deleteUserById', () => {

src/user/user.service.ts

@@ -91,7 +91,7 @@ export class UserService {
         this.logger.log(`Create user: created public user in db. User: ${email}`);
       }
 
-      createServiceUserProfiles(user, partner, partnerAccess);
+      await createServiceUserProfiles(user, partner, partnerAccess);
 
       const userDto = formatUserObject({
         ...user,

src/utils/serviceUserProfiles.spec.ts

@@ -129,7 +129,15 @@ describe('Service user profiles', () => {
         },
       });
     });
+
+    it('should not propagate external api call errors', async () => {
+      const mocked = jest.mocked(createCrispProfile);
+      mocked.mockRejectedValue(new Error('Crisp API call failed'));
+      await expect(createServiceUserProfiles(mockUserEntity)).resolves.not.toThrow();
+      mocked.mockReset();
+    });
   });
+
   describe('updateServiceUserProfilesUser', () => {
     it('should update crisp and mailchimp profile user data', async () => {
       await updateServiceUserProfilesUser(mockUserEntity, false, mockUserEntity.email);
@@ -209,6 +217,15 @@ describe('Service user profiles', () => {
         mockUserEntity.email,
       );
     });
+
+    it('should not propagate external api call errors', async () => {
+      const mocked = jest.mocked(updateMailchimpProfile);
+      mocked.mockRejectedValue(new Error('Mailchimp API call failed'));
+      await expect(
+        updateServiceUserProfilesUser(mockUserEntity, false, mockUserEntity.email),
+      ).resolves.not.toThrow();
+      mocked.mockReset();
+    });
   });
 
   describe('updateServiceUserProfilesPartnerAccess', () => {
@@ -286,6 +303,15 @@ describe('Service user profiles', () => {
         mockUserEntity.email,
       );
     });
+
+    it('should not propagate external api call errors', async () => {
+      const mocked = jest.mocked(updateCrispProfile);
+      mocked.mockRejectedValue(new Error('Crisp API call failed'));
+      await expect(
+        updateServiceUserProfilesPartnerAccess([mockPartnerAccessEntity], mockUserEntity.email),
+      ).resolves.not.toThrow();
+      mocked.mockReset();
+    });
   });
 
   describe('updateServiceUserProfilesTherapy', () => {
@@ -441,6 +467,18 @@ describe('Service user profiles', () => {
         mockUserEntity.email,
       );
     });
+
+    it('should not propagate external api call errors', async () => {
+      const mocked = jest.mocked(updateMailchimpProfile);
+      mocked.mockRejectedValue(new Error('Mailchimp API call failed'));
+      await expect(
+        updateServiceUserProfilesTherapy(
+          [mockPartnerAccessEntity, mockAltPartnerAccessEntity],
+          mockUserEntity.email,
+        ),
+      ).resolves.not.toThrow();
+      mocked.mockReset();
+    });
   });
 
   describe('updateServiceUserProfilesCourse', () => {
@@ -465,6 +503,15 @@ describe('Service user profiles', () => {
         mockUserEntity.email,
       );
     });
+
+    it('should not propagate external api call errors', async () => {
+      const mocked = jest.mocked(updateCrispProfile);
+      mocked.mockRejectedValue(new Error('Crisp API call failed'));
+      await expect(
+        updateServiceUserProfilesCourse(mockCourseUserEntity, mockUserEntity.email),
+      ).resolves.not.toThrow();
+      mocked.mockReset();
+    });
   });
 
   describe('createMailchimpCourseMergeField', () => {