resolve remaining type-errors from PublicUser vs User apiKey differences

Author: clairep94

client/testData/testReduxStore.ts

@@ -54,7 +54,11 @@ const initialTestState: RootState = {
   user: {
     email: 'happydog@example.com',
     username: 'happydog',
-    preferences: {},
+    preferences: {
+      ...initialPrefState,
+      indentationAmount: 2,
+      isTabIndent: true
+    },
     apiKeys: [],
     verified: 'sent',
     id: '123456789',

server/controllers/user.controller/__testUtils__.ts

@@ -29,7 +29,7 @@ export const mockBaseUserSanitised: PublicUser = {
   email: 'test@example.com',
   username: 'tester',
   preferences: mockUserPreferences,
-  apiKeys: ([] as unknown) as Types.DocumentArray<ApiKeyDocument>,
+  apiKeys: [],
   verified: 'verified',
   id: 'abc123',
   totalSize: 42,
@@ -42,6 +42,7 @@ export const mockBaseUserSanitised: PublicUser = {
 export const mockBaseUserFull: Omit<User, 'createdAt'> = {
   ...mockBaseUserSanitised,
   name: 'test user',
+  apiKeys: ([] as unknown) as Types.DocumentArray<ApiKeyDocument>,
   tokens: [],
   password: 'abweorij',
   resetPasswordToken: '1i14ij23',
@@ -58,7 +59,7 @@ export const mockBaseUserFull: Omit<User, 'createdAt'> = {
 export function createMockUser(
   overrides: Partial<UserDocument> = {},
   unSanitised: boolean = false
-): PublicUser & Record<string, any> {
+): (PublicUser | UserDocument) & Record<string, any> {
   return {
     ...(unSanitised ? mockBaseUserFull : mockBaseUserSanitised),
     ...overrides

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

@@ -7,7 +7,11 @@ import { Types } from 'mongoose';
 
 import { User } from '../../../models/user';
 import { createApiKey, removeApiKey } from '../apiKey';
-import type { ApiKeyDocument, RemoveApiKeyRequestParams } from '../../../types';
+import type {
+  ApiKeyDocument,
+  RemoveApiKeyRequestParams,
+  UserDocument
+} from '../../../types';
 import { createMockUser } from '../__testUtils__';
 
 jest.mock('../../../models/user');
@@ -31,7 +35,7 @@ describe('user.controller > api key', () => {
 
   describe('createApiKey', () => {
     it("returns an error if user doesn't exist", async () => {
-      request.user = createMockUser({ id: '1234' });
+      request.user = createMockUser({ id: '1234' }, true);
 
       User.findById = jest.fn().mockResolvedValue(null);
 
@@ -48,7 +52,7 @@ describe('user.controller > api key', () => {
     });
 
     it('returns an error if label not provided', async () => {
-      request.user = createMockUser({ id: '1234' });
+      request.user = createMockUser({ id: '1234' }, true);
       request.body = {};
 
       const user = new User();
@@ -98,7 +102,7 @@ describe('user.controller > api key', () => {
 
   describe('removeApiKey', () => {
     it("returns an error if user doesn't exist", async () => {
-      request.user = createMockUser({ id: '1234' });
+      request.user = createMockUser({ id: '1234' }, true);
 
       User.findById = jest.fn().mockResolvedValue(null);
 
@@ -115,7 +119,7 @@ describe('user.controller > api key', () => {
     });
 
     it("returns an error if specified key doesn't exist", async () => {
-      request.user = createMockUser({ id: '1234' });
+      request.user = createMockUser({ id: '1234' }, true);
       request.params = { keyId: 'not-a-real-key' };
       const user = new User();
       user.apiKeys = ([] as unknown) as Types.DocumentArray<ApiKeyDocument>;
@@ -145,11 +149,14 @@ describe('user.controller > api key', () => {
       apiKeys.find = Array.prototype.find;
       apiKeys.pull = jest.fn();
 
-      const user = createMockUser({
-        id: '1234',
-        apiKeys,
-        save: jest.fn()
-      });
+      const user = createMockUser(
+        {
+          id: '1234',
+          apiKeys,
+          save: jest.fn()
+        },
+        true
+      ) as UserDocument;
 
       request.user = user;
       request.params = { keyId: 'id1' };

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

@@ -29,7 +29,7 @@ describe('user.controller > auth management > password management', () => {
   let response: MockResponse;
   let next: MockNext;
   let mockToken: string;
-  let mockUser: Partial<UserDocument>;
+  let mockUser: UserDocument;
   const fixedTime = 100000000;
 
   beforeEach(() => {
@@ -68,10 +68,13 @@ describe('user.controller > auth management > password management', () => {
     describe('if the user is found', () => {
       beforeEach(async () => {
         mockToken = 'mock-token';
-        mockUser = createMockUser({
-          email: 'test@example.com',
-          save: jest.fn().mockResolvedValue(null)
-        });
+        mockUser = createMockUser(
+          {
+            email: 'test@example.com',
+            save: jest.fn().mockResolvedValue(null)
+          },
+          false
+        ) as UserDocument;
 
         (generateToken as jest.Mock).mockResolvedValue(mockToken);
         User.findByEmail = jest.fn().mockResolvedValue(mockUser);
@@ -143,10 +146,13 @@ describe('user.controller > auth management > password management', () => {
     });
     it('returns unsuccessful for all other errors', async () => {
       mockToken = 'mock-token';
-      mockUser = createMockUser({
-        email: 'test@example.com',
-        save: jest.fn().mockResolvedValue(null)
-      });
+      mockUser = createMockUser(
+        {
+          email: 'test@example.com',
+          save: jest.fn().mockResolvedValue(null)
+        },
+        false
+      ) as UserDocument;
 
       (generateToken as jest.Mock).mockRejectedValue(
         new Error('network error')
@@ -298,7 +304,7 @@ describe('user.controller > auth management > password management', () => {
         resetPasswordToken: 'valid-token',
         resetPasswordExpires: fixedTime + 10000, // still valid
         save: jest.fn()
-      };
+      } as UserDocument;
 
       beforeEach(async () => {
         User.findOne = jest.fn().mockReturnValue({

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

@@ -60,13 +60,16 @@ describe('user.controller > auth management > updateSettings (email, username, p
     response = new MockResponse();
     next = jest.fn();
 
-    startingUser = createMockUser({
-      username: OLD_USERNAME,
-      email: OLD_EMAIL,
-      password: OLD_PASSWORD,
-      id: '123459',
-      comparePassword: jest.fn().mockResolvedValue(true)
-    });
+    startingUser = createMockUser(
+      {
+        username: OLD_USERNAME,
+        email: OLD_EMAIL,
+        password: OLD_PASSWORD,
+        id: '123459',
+        comparePassword: jest.fn().mockResolvedValue(true)
+      },
+      false
+    ) as UserDocument;
 
     testUser = { ...startingUser }; // copy to avoid mutation causing false-positive tests results