add test util to create mockUser for typesafety

Author: clairep94

server/controllers/user.controller/__testUtils__.ts

@@ -0,0 +1,66 @@
+import { Types } from 'mongoose';
+import { PublicUser, User, UserDocument, UserPreferences } from '../../types';
+import {
+  CookieConsentOptions,
+  ApiKeyDocument,
+  AppThemeOptions
+} from '../../types';
+
+/** Mock user preferences for testing. Matches mongoose defaults in User model */
+export const mockUserPreferences: UserPreferences = {
+  fontSize: 18,
+  lineNumbers: true,
+  indentationAmount: 2,
+  isTabIndent: false,
+  autosave: true,
+  linewrap: true,
+  lintWarning: false,
+  textOutput: false,
+  gridOutput: false,
+  theme: AppThemeOptions.LIGHT,
+  autorefresh: false,
+  language: 'en-GB',
+  autocloseBracketsQuotes: true,
+  autocompleteHinter: false
+};
+
+/** Mock sanitised user for testing */
+export const mockBaseUserSanitised: PublicUser = {
+  email: 'test@example.com',
+  username: 'tester',
+  preferences: mockUserPreferences,
+  apiKeys: ([] as unknown) as Types.DocumentArray<ApiKeyDocument>,
+  verified: 'verified',
+  id: 'abc123',
+  totalSize: 42,
+  cookieConsent: CookieConsentOptions.NONE,
+  google: 'user@gmail.com',
+  github: 'user123'
+};
+
+/** Mock full user for testing. createdAt is omitted to simplify jest timers where possible */
+export const mockBaseUserFull: Omit<User, 'createdAt'> = {
+  ...mockBaseUserSanitised,
+  name: 'test user',
+  tokens: [],
+  password: 'abweorij',
+  resetPasswordToken: '1i14ij23',
+  banned: false
+};
+
+/**
+ * Helper function to make mock user document / object for tests
+ *   - Does not attach any document methods
+ * @param unSanitised - use the entire user type, including sensitive fields
+ * @param overrides - any overrides on the default mocks --> for clearest tests, always define the properties expected to change
+ * @returns
+ */
+export function createMockUser(
+  overrides: Partial<UserDocument> = {},
+  unSanitised: boolean = false
+): PublicUser & Record<string, any> {
+  return {
+    ...(unSanitised ? mockBaseUserFull : mockBaseUserSanitised),
+    ...overrides
+  };
+}

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

@@ -7,13 +7,14 @@ import { Types } from 'mongoose';
 
 import { User } from '../../../models/user';
 import { createApiKey, removeApiKey } from '../apiKey';
-import type { ApiKeyDocument, RemoveApiKeyRequestParams } from '../../../types';
+import type { ApiKeyDocument } from '../../../types';
+import { createMockUser } from '../__testUtils__';
 
 jest.mock('../../../models/user');
 
 describe('user.controller > api key', () => {
-  let request: MockRequest & { user?: { id: string } };
-  let response: MockResponse;
+  let request: any;
+  let response: any;
   let next: MockNext;
 
   beforeEach(() => {
@@ -30,15 +31,11 @@ describe('user.controller > api key', () => {
 
   describe('createApiKey', () => {
     it("returns an error if user doesn't exist", async () => {
-      request.user = { id: '1234' };
+      request.user = createMockUser({ id: '1234' });
 
       User.findById = jest.fn().mockResolvedValue(null);
 
-      await createApiKey(
-        (request as unknown) as Request,
-        (response as unknown) as Response,
-        (next as unknown) as NextFunction
-      );
+      await createApiKey(request, response, next);
 
       expect(response.status).toHaveBeenCalledWith(404);
       expect(response.json).toHaveBeenCalledWith({
@@ -47,17 +44,13 @@ describe('user.controller > api key', () => {
     });
 
     it('returns an error if label not provided', async () => {
-      request.user = { id: '1234' };
+      request.user = createMockUser({ id: '1234' });
       request.body = {};
 
       const user = new User();
       User.findById = jest.fn().mockResolvedValue(user);
 
-      await createApiKey(
-        (request as unknown) as Request,
-        (response as unknown) as Response,
-        (next as unknown) as NextFunction
-      );
+      await createApiKey(request, response, next);
 
       expect(response.status).toHaveBeenCalledWith(400);
       expect(response.json).toHaveBeenCalledWith({
@@ -66,20 +59,16 @@ describe('user.controller > api key', () => {
     });
 
     it('returns generated API key to the user', async () => {
+      request.user = createMockUser({ id: '1234' });
       request.setBody({ label: 'my key' });
-      request.user = { id: '1234' };
 
       const user = new User();
       user.apiKeys = ([] as unknown) as Types.DocumentArray<ApiKeyDocument>;
 
       User.findById = jest.fn().mockResolvedValue(user);
       user.save = jest.fn();
 
-      await createApiKey(
-        (request as unknown) as Request,
-        (response as unknown) as Response,
-        (next as unknown) as NextFunction
-      );
+      await createApiKey(request, response, next);
 
       const lastKey = last(user.apiKeys);
 
@@ -97,15 +86,11 @@ describe('user.controller > api key', () => {
 
   describe('removeApiKey', () => {
     it("returns an error if user doesn't exist", async () => {
-      request.user = { id: '1234' };
+      request.user = createMockUser({ id: '1234' });
 
       User.findById = jest.fn().mockResolvedValue(null);
 
-      await removeApiKey(
-        (request as unknown) as Request<RemoveApiKeyRequestParams>,
-        (response as unknown) as Response,
-        (next as unknown) as NextFunction
-      );
+      await removeApiKey(request, response, next);
 
       expect(response.status).toHaveBeenCalledWith(404);
       expect(response.json).toHaveBeenCalledWith({
@@ -114,18 +99,14 @@ describe('user.controller > api key', () => {
     });
 
     it("returns an error if specified key doesn't exist", async () => {
-      request.user = { id: '1234' };
+      request.user = createMockUser({ id: '1234' });
       request.params = { keyId: 'not-a-real-key' };
       const user = new User();
       user.apiKeys = ([] as unknown) as Types.DocumentArray<ApiKeyDocument>;
 
       User.findById = jest.fn().mockResolvedValue(user);
 
-      await removeApiKey(
-        (request as unknown) as Request<RemoveApiKeyRequestParams>,
-        (response as unknown) as Response,
-        (next as unknown) as NextFunction
-      );
+      await removeApiKey(request, response, next);
 
       expect(response.status).toHaveBeenCalledWith(404);
       expect(response.json).toHaveBeenCalledWith({
@@ -144,21 +125,18 @@ describe('user.controller > api key', () => {
       apiKeys.find = Array.prototype.find;
       apiKeys.pull = jest.fn();
 
-      const user = {
+      const user = createMockUser({
+        id: '1234',
         apiKeys,
         save: jest.fn()
-      };
+      });
 
-      request.user = { id: '1234' };
+      request.user = user;
       request.params = { keyId: 'id1' };
 
       User.findById = jest.fn().mockResolvedValue(user);
 
-      await removeApiKey(
-        (request as unknown) as Request<RemoveApiKeyRequestParams>,
-        (response as unknown) as Response,
-        (next as unknown) as NextFunction
-      );
+      await removeApiKey(request, response, next);
 
       expect(user.apiKeys.pull).toHaveBeenCalledWith({ _id: 'id1' });
       expect(user.save).toHaveBeenCalled();

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

@@ -11,6 +11,7 @@ import {
   unlinkGoogle
 } from '../authManagement';
 import { saveUser, generateToken, userResponse } from '../helpers';
+import { createMockUser } from '../__testUtils__';
 
 import { mailerService } from '../../../utils/mail';
 import { UserDocument } from '../../../types';
@@ -68,11 +69,11 @@ describe('user.controller > auth management', () => {
     describe('if the user is found', () => {
       beforeEach(() => {
         mockToken = 'mock-token';
-        saveMock = jest.fn().mockResolvedValue({});
-        mockUser = {
+        saveMock = jest.fn().mockResolvedValue(null);
+        mockUser = createMockUser({
           email: 'test@example.com',
           save: saveMock
-        };
+        });
 
         (generateToken as jest.Mock).mockResolvedValue(mockToken);
         User.findByEmail = jest.fn().mockResolvedValue(mockUser);
@@ -113,10 +114,10 @@ describe('user.controller > auth management', () => {
       beforeEach(() => {
         mockToken = 'mock-token';
         saveMock = jest.fn().mockResolvedValue({});
-        mockUser = {
+        mockUser = createMockUser({
           email: 'test@example.com',
           save: saveMock
-        };
+        });
 
         (generateToken as jest.Mock).mockResolvedValue(mockToken);
         User.findByEmail = jest.fn().mockResolvedValue(null);
@@ -142,10 +143,10 @@ describe('user.controller > auth management', () => {
     it('returns unsuccessful for all other errors', async () => {
       mockToken = 'mock-token';
       saveMock = jest.fn().mockResolvedValue({});
-      mockUser = {
+      mockUser = createMockUser({
         email: 'test@example.com',
         save: saveMock
-      };
+      });
 
       (generateToken as jest.Mock).mockRejectedValue(
         new Error('network error')
@@ -202,11 +203,12 @@ describe('user.controller > auth management', () => {
 
     describe('and when there is a user with valid token', () => {
       beforeEach(async () => {
-        const fakeUser = {
+        const fakeUser = createMockUser({
           email: 'test@example.com',
           resetPasswordToken: 'valid-token',
           resetPasswordExpires: fixedTime + 10000 // still valid
-        };
+        });
+
         User.findOne = jest.fn().mockReturnValue({
           exec: jest.fn().mockResolvedValue(fakeUser)
         });
@@ -257,13 +259,14 @@ describe('user.controller > auth management', () => {
     });
 
     describe('and when there is a user with valid token', () => {
-      const fakeUser = {
+      const fakeUser = createMockUser({
         email: 'test@example.com',
         password: 'oldpassword',
         resetPasswordToken: 'valid-token',
         resetPasswordExpires: fixedTime + 10000, // still valid
         save: jest.fn()
-      };
+      });
+
       beforeEach(async () => {
         User.findOne = jest.fn().mockReturnValue({
           exec: jest.fn().mockResolvedValue(fakeUser)
@@ -320,11 +323,11 @@ describe('user.controller > auth management', () => {
 
     // the below tests match the current logic, but logic can be improved
     describe('if the user is found', () => {
-      const startingUser = {
+      const startingUser = createMockUser({
         username: 'oldusername',
         email: 'old@email.com',
         id: 'valid-id'
-      };
+      });
 
       beforeEach(() => {
         User.findById = jest.fn().mockResolvedValue(startingUser);
@@ -399,13 +402,10 @@ describe('user.controller > auth management', () => {
       });
     });
     describe('and when there is a user in the request', () => {
-      const user = {
-        github: { id: '123', username: 'testuser' },
-        tokens: [
-          { kind: 'github', accessToken: 'abc' },
-          { kind: 'google', accessToken: 'xyz' }
-        ]
-      };
+      const user = createMockUser({
+        github: 'testuser',
+        tokens: [{ kind: 'github' }, { kind: 'google' }]
+      });
 
       beforeEach(async () => {
         request.user = user;
@@ -415,7 +415,7 @@ describe('user.controller > auth management', () => {
         expect(user.github).toBeUndefined();
       });
       it('filters out the github token', () => {
-        expect(user.tokens).toEqual([{ kind: 'google', accessToken: 'xyz' }]);
+        expect(user.tokens).toEqual([{ kind: 'google' }]);
       });
       it('does calls saveUser', () => {
         expect(saveUser).toHaveBeenCalledWith(response, user);
@@ -440,13 +440,10 @@ describe('user.controller > auth management', () => {
       });
     });
     describe('and when there is a user in the request', () => {
-      const user = {
-        google: { id: '123', username: 'testuser' },
-        tokens: [
-          { kind: 'github', accessToken: 'abc' },
-          { kind: 'google', accessToken: 'xyz' }
-        ]
-      };
+      const user = createMockUser({
+        google: 'testuser',
+        tokens: [{ kind: 'github' }, { kind: 'google' }]
+      });
 
       beforeEach(async () => {
         request.user = user;
@@ -456,7 +453,7 @@ describe('user.controller > auth management', () => {
         expect(user.google).toBeUndefined();
       });
       it('filters out the google token', () => {
-        expect(user.tokens).toEqual([{ kind: 'github', accessToken: 'abc' }]);
+        expect(user.tokens).toEqual([{ kind: 'github' }]);
       });
       it('does calls saveUser', () => {
         expect(saveUser).toHaveBeenCalledWith(response, user);