add remaining tests for helpers

Author: clairep94

server/controllers/user.controller/__tests__/helpers.test.ts

@@ -1,8 +1,12 @@
 /* eslint-disable no-unused-vars */
 import crypto from 'crypto';
 
-import { userResponse, generateToken } from '../helpers';
+import { Response as MockResponse } from 'jest-express/lib/response';
+import { Response } from 'express';
+import { userResponse, generateToken, userExists, saveUser } from '../helpers';
 import { createMockUser } from '../__testUtils__';
+import { User } from '../../../models/user';
+import { UserDocument } from '../../../types';
 
 jest.mock('../../../models/user');
 
@@ -15,20 +19,19 @@ const mockFullUser = createMockUser({
   banned: true
 });
 
+const {
+  name,
+  tokens,
+  password,
+  resetPasswordToken,
+  banned,
+  ...sanitised
+} = mockFullUser;
+
 describe('user.controller > helpers', () => {
   describe('userResponse', () => {
     it('returns a sanitized PublicUser object', () => {
       const result = userResponse(mockFullUser);
-
-      const {
-        name,
-        tokens,
-        password,
-        resetPasswordToken,
-        banned,
-        ...sanitised
-      } = mockFullUser;
-
       expect(result).toMatchObject(sanitised);
     });
   });
@@ -54,4 +57,49 @@ describe('user.controller > helpers', () => {
       spy.mockRestore();
     });
   });
+
+  describe('saveUser', () => {
+    it('returns a response with a sanitised user if user.save succeeds', async () => {
+      const userWithSuccessfulSave = {
+        ...mockFullUser,
+        save: jest.fn().mockResolvedValue(null)
+      };
+      const response = new MockResponse();
+      await saveUser(
+        (response as unknown) as Response,
+        (userWithSuccessfulSave as unknown) as UserDocument
+      );
+      expect(response.json).toHaveBeenCalledWith(sanitised);
+    });
+    it('returns a 500 Error if user.save fails', async () => {
+      const userWithUnsuccessfulSave = {
+        ...mockFullUser,
+        save: jest.fn().mockRejectedValue('async error')
+      };
+      const response = new MockResponse();
+      await saveUser(
+        (response as unknown) as Response,
+        (userWithUnsuccessfulSave as unknown) as UserDocument
+      );
+      expect(response.status).toHaveBeenCalledWith(500);
+      expect(response.json).toHaveBeenCalledWith({
+        error: 'async error'
+      });
+    });
+  });
+
+  describe('userExists', () => {
+    it('returns true when User.findByUsername returns non-nullish', async () => {
+      User.findByEmailOrUsername = jest
+        .fn()
+        .mockResolvedValue({ id: 'something' });
+      const exists = await userExists('someusername');
+      expect(exists).toBe(true);
+    });
+    it('returns false when User.findByUsername returns nullish', async () => {
+      User.findByEmailOrUsername = jest.fn().mockResolvedValue(null);
+      const exists = await userExists('someusername');
+      expect(exists).toBe(false);
+    });
+  });
 });

server/controllers/user.controller/authManagement.ts

@@ -1,5 +1,4 @@
 import { RequestHandler } from 'express';
-import * as core from 'express-serve-static-core';
 import { User } from '../../models/user';
 import { saveUser, generateToken, userResponse } from './helpers';
 import {

server/controllers/user.controller/helpers.ts

@@ -61,10 +61,8 @@ export async function saveUser(res: Response, user: UserDocument) {
 
 /**
  * Helper used in other controllers to check if user by username exists.
- * @param {string} username
- * @return {Promise<boolean>}
  */
-export async function userExists(username: string) {
+export async function userExists(username: string): Promise<boolean> {
   const user = await User.findByUsername(username);
   return user != null;
 }