server/controller/user: update tests to have stronger typing for request and response

Author: clairep94

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

@@ -2,18 +2,19 @@ import { last } from 'lodash';
 import { Request as MockRequest } from 'jest-express/lib/request';
 import { Response as MockResponse } from 'jest-express/lib/response';
 import { NextFunction as MockNext } from 'jest-express/lib/next';
+import { Request, Response } from 'express';
 import { Types } from 'mongoose';
 
 import { User } from '../../../models/user';
 import { createApiKey, removeApiKey } from '../apiKey';
-import type { ApiKeyDocument } from '../../../types';
+import type { ApiKeyDocument, RemoveApiKeyRequestParams } from '../../../types';
 import { createMockUser } from '../__testUtils__';
 
 jest.mock('../../../models/user');
 
 describe('user.controller > api key', () => {
-  let request: any;
-  let response: any;
+  let request: MockRequest;
+  let response: MockResponse;
   let next: MockNext;
 
   beforeEach(() => {
@@ -34,7 +35,11 @@ describe('user.controller > api key', () => {
 
       User.findById = jest.fn().mockResolvedValue(null);
 
-      await createApiKey(request, response, next);
+      await createApiKey(
+        (request as unknown) as Request,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(response.status).toHaveBeenCalledWith(404);
       expect(response.json).toHaveBeenCalledWith({
@@ -49,7 +54,11 @@ describe('user.controller > api key', () => {
       const user = new User();
       User.findById = jest.fn().mockResolvedValue(user);
 
-      await createApiKey(request, response, next);
+      await createApiKey(
+        (request as unknown) as Request,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(response.status).toHaveBeenCalledWith(400);
       expect(response.json).toHaveBeenCalledWith({
@@ -67,7 +76,11 @@ describe('user.controller > api key', () => {
       User.findById = jest.fn().mockResolvedValue(user);
       user.save = jest.fn();
 
-      await createApiKey(request, response, next);
+      await createApiKey(
+        (request as unknown) as Request,
+        (response as unknown) as Response,
+        next
+      );
 
       const lastKey = last(user.apiKeys);
 
@@ -89,7 +102,11 @@ describe('user.controller > api key', () => {
 
       User.findById = jest.fn().mockResolvedValue(null);
 
-      await removeApiKey(request, response, next);
+      await removeApiKey(
+        (request as unknown) as Request<RemoveApiKeyRequestParams>,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(response.status).toHaveBeenCalledWith(404);
       expect(response.json).toHaveBeenCalledWith({
@@ -105,7 +122,11 @@ describe('user.controller > api key', () => {
 
       User.findById = jest.fn().mockResolvedValue(user);
 
-      await removeApiKey(request, response, next);
+      await removeApiKey(
+        (request as unknown) as Request<RemoveApiKeyRequestParams>,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(response.status).toHaveBeenCalledWith(404);
       expect(response.json).toHaveBeenCalledWith({
@@ -135,7 +156,11 @@ describe('user.controller > api key', () => {
 
       User.findById = jest.fn().mockResolvedValue(user);
 
-      await removeApiKey(request, response, next);
+      await removeApiKey(
+        (request as unknown) as Request<RemoveApiKeyRequestParams>,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(user.apiKeys.pull).toHaveBeenCalledWith({ _id: 'id1' });
       expect(user.save).toHaveBeenCalled();

server/controllers/user.controller/__tests__/authManagement/3rdPartyManagement.test.ts

@@ -1,6 +1,7 @@
 import { Request as MockRequest } from 'jest-express/lib/request';
 import { Response as MockResponse } from 'jest-express/lib/response';
 import { NextFunction as MockNext } from 'jest-express/lib/next';
+import { Request, Response } from 'express';
 import { unlinkGithub, unlinkGoogle } from '../../authManagement';
 import { saveUser } from '../../helpers';
 import { createMockUser } from '../../__testUtils__';
@@ -12,8 +13,8 @@ jest.mock('../../helpers', () => ({
 jest.mock('../../../../utils/mail');
 
 describe('user.controller > auth management > 3rd party auth', () => {
-  let request: any;
-  let response: any;
+  let request: MockRequest;
+  let response: MockResponse;
   let next: MockNext;
 
   beforeEach(() => {
@@ -31,7 +32,11 @@ describe('user.controller > auth management > 3rd party auth', () => {
   describe('unlinkGithub', () => {
     describe('and when there is no user in the request', () => {
       beforeEach(async () => {
-        await unlinkGithub(request, response, next);
+        await unlinkGithub(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('does not call saveUser', () => {
         expect(saveUser).not.toHaveBeenCalled();
@@ -52,7 +57,11 @@ describe('user.controller > auth management > 3rd party auth', () => {
 
       beforeEach(async () => {
         request.user = user;
-        await unlinkGithub(request, response, next);
+        await unlinkGithub(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('removes the users github property', () => {
         expect(user.github).toBeUndefined();
@@ -69,7 +78,11 @@ describe('user.controller > auth management > 3rd party auth', () => {
   describe('unlinkGoogle', () => {
     describe('and when there is no user in the request', () => {
       beforeEach(async () => {
-        await unlinkGoogle(request, response, next);
+        await unlinkGoogle(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('does not call saveUser', () => {
         expect(saveUser).not.toHaveBeenCalled();
@@ -90,7 +103,11 @@ describe('user.controller > auth management > 3rd party auth', () => {
 
       beforeEach(async () => {
         request.user = user;
-        await unlinkGoogle(request, response, next);
+        await unlinkGoogle(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('removes the users google property', () => {
         expect(user.google).toBeUndefined();

server/controllers/user.controller/__tests__/authManagement/passwordManagement.test.ts

@@ -1,6 +1,7 @@
 import { Request as MockRequest } from 'jest-express/lib/request';
 import { Response as MockResponse } from 'jest-express/lib/response';
 import { NextFunction as MockNext } from 'jest-express/lib/next';
+import { Request, Response } from 'express';
 import { User } from '../../../../models/user';
 import {
   resetPasswordInitiate,
@@ -11,7 +12,10 @@ import { generateToken } from '../../helpers';
 import { createMockUser } from '../../__testUtils__';
 
 import { mailerService } from '../../../../utils/mail';
-import { UserDocument } from '../../../../types';
+import {
+  ResetOrUpdatePasswordRequestParams,
+  UserDocument
+} from '../../../../types';
 
 jest.mock('../../../../models/user');
 jest.mock('../../../../utils/mail');
@@ -21,8 +25,8 @@ jest.mock('../../helpers', () => ({
 }));
 
 describe('user.controller > auth management > password management', () => {
-  let request: any;
-  let response: any;
+  let request: MockRequest;
+  let response: MockResponse;
   let next: MockNext;
   let mockToken: string;
   let mockUser: Partial<UserDocument>;
@@ -52,7 +56,11 @@ describe('user.controller > auth management > password management', () => {
     it('calls User.findByEmail with the correct email', async () => {
       User.findByEmail = jest.fn().mockResolvedValue({});
       request.body = { email: '[email protected]' };
-      await resetPasswordInitiate(request, response, next);
+      await resetPasswordInitiate(
+        (request as unknown) as Request,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(User.findByEmail).toHaveBeenCalledWith('[email protected]');
     });
@@ -71,7 +79,11 @@ describe('user.controller > auth management > password management', () => {
         request.body = { email: '[email protected]' };
         request.headers.host = 'localhost:3000';
 
-        await resetPasswordInitiate(request, response, next);
+        await resetPasswordInitiate(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('sets a resetPasswordToken with an expiry of 1h to the user', () => {
         expect(mockUser.resetPasswordToken).toBe(mockToken);
@@ -107,12 +119,20 @@ describe('user.controller > auth management > password management', () => {
         request.headers.host = 'localhost:3000';
       });
       it('does not send the reset password email', async () => {
-        await resetPasswordInitiate(request, response, next);
+        await resetPasswordInitiate(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
 
         expect(mailerService.send).not.toHaveBeenCalledWith();
       });
       it('returns a success message that does not indicate if the user exists, for security purposes', async () => {
-        await resetPasswordInitiate(request, response, next);
+        await resetPasswordInitiate(
+          (request as unknown) as Request,
+          (response as unknown) as Response,
+          next
+        );
 
         expect(response.json).toHaveBeenCalledWith({
           success: true,
@@ -136,7 +156,11 @@ describe('user.controller > auth management > password management', () => {
       request.body = { email: '[email protected]' };
       request.headers.host = 'localhost:3000';
 
-      await resetPasswordInitiate(request, response, next);
+      await resetPasswordInitiate(
+        (request as unknown) as Request,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(response.json).toHaveBeenCalledWith({
         success: false
@@ -155,7 +179,11 @@ describe('user.controller > auth management > password management', () => {
 
       request.params = { token: 'some-token' };
 
-      await validateResetPasswordToken(request, response, next);
+      await validateResetPasswordToken(
+        (request as unknown) as Request<ResetOrUpdatePasswordRequestParams>,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(User.findOne).toHaveBeenCalledWith({
         resetPasswordToken: 'some-token',
@@ -171,7 +199,11 @@ describe('user.controller > auth management > password management', () => {
 
         request.params = { token: 'invalid-token' };
 
-        await validateResetPasswordToken(request, response, next);
+        await validateResetPasswordToken(
+          (request as unknown) as Request<ResetOrUpdatePasswordRequestParams>,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('returns a 401', () => {
         expect(response.status).toHaveBeenCalledWith(401);
@@ -198,7 +230,11 @@ describe('user.controller > auth management > password management', () => {
 
         request.params = { token: 'valid-token' };
 
-        await validateResetPasswordToken(request, response, next);
+        await validateResetPasswordToken(
+          (request as unknown) as Request<ResetOrUpdatePasswordRequestParams>,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('returns a success response', () => {
         expect(response.json).toHaveBeenCalledWith({ success: true });
@@ -217,7 +253,11 @@ describe('user.controller > auth management > password management', () => {
 
       request.params = { token: 'some-token' };
 
-      await updatePassword(request, response, next);
+      await updatePassword(
+        (request as unknown) as Request<ResetOrUpdatePasswordRequestParams>,
+        (response as unknown) as Response,
+        next
+      );
 
       expect(User.findOne).toHaveBeenCalledWith({
         resetPasswordToken: 'some-token',
@@ -233,7 +273,11 @@ describe('user.controller > auth management > password management', () => {
 
         request.params = { token: 'invalid-token' };
 
-        await updatePassword(request, response, next);
+        await updatePassword(
+          (request as unknown) as Request<ResetOrUpdatePasswordRequestParams>,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('returns a 401', () => {
         expect(response.status).toHaveBeenCalledWith(401);
@@ -272,7 +316,11 @@ describe('user.controller > auth management > password management', () => {
           cb(null);
         });
 
-        await updatePassword(request, response, next);
+        await updatePassword(
+          (request as unknown) as Request<ResetOrUpdatePasswordRequestParams>,
+          (response as unknown) as Response,
+          next
+        );
       });
       it('calls user.save with the updated password and removes the reset password token', () => {
         expect(mockUser.password).toBe('newpassword');