eslinting - backend

Author: Laoujin

backend/.eslintrc.js

@@ -38,6 +38,7 @@ module.exports = {
     "padded-blocks": [0],
     "object-curly-newline": ["error", { "ImportDeclaration": "never" }],
     "no-plusplus": [0],
+    "no-console": "warn",
     "arrow-parens": ["error", "as-needed"],
     "quotes": ["error", "single"],
     "@typescript-eslint/member-delimiter-style": ['error', {
@@ -57,7 +58,7 @@ module.exports = {
     "object-curly-newline": ["error", {
       "ObjectExpression": { "multiline": true, "minProperties": 4 },
       "ObjectPattern": { "multiline": true, "minProperties": 4 },
-      "ImportDeclaration": { "multiline": true, "minProperties": 5 },
+      "ImportDeclaration": { "multiline": true, "minProperties": 8 },
       "ExportDeclaration": { "multiline": true, "minProperties": 3 }
     }],
     "newline-per-chained-call": ["error", { "ignoreChainWithDepth": 3 }],

backend/package-lock.json

@@ -19,6 +19,7 @@
   "dependencies": {
     "@sendgrid/mail": "^6.4.0",
     "body-parser": "^1.19.0",
+    "bson": "^1.1.4",
     "cors": "^2.8.5",
     "deep-diff": "^1.0.2",
     "dotenv": "^16.0.3",

backend/package.json

@@ -4,16 +4,14 @@
 
 import {Response} from 'express';
 import fs from 'fs';
-import {getTemplates} from '../config'
+import {getTemplates} from '../config';
 
 
 jest.mock('fs');
 const mockedFs: jest.Mocked<typeof fs> = jest.mocked(fs);
 
 const req = {} as any;
-const res = {
-  send: (x: string[]) => Promise.resolve(x)
-} as unknown as Response;
+const res = {send: (x: string[]) => Promise.resolve(x)} as unknown as Response;
 
 
 describe('config controller :: getTemplates', () => {
@@ -38,13 +36,13 @@ describe('config controller :: getTemplates', () => {
 
   it.skip('returns all pug files in root folder /templates when ENABLE_ROOT_TEMPLATES', async () => {
 
-  })
+  });
 
-  it.skip("doesn't return other file types", async () => {
+  it.skip('doesnt return other file types', async () => {
 
-  })
+  });
 
   it.skip('strips off the .pug extension', async () => {
 
-  })
-})
+  });
+});

backend/src/controllers/tests/0-config-templates.test.ts

@@ -1,9 +1,9 @@
 // Exercises 0: Basic
 // Jest Mocks for google-auth-library
 
-import { verify } from '../user'
-import { OAuth2Client } from 'google-auth-library';
-import config, { IConfig } from './../../config';
+import {OAuth2Client} from 'google-auth-library';
+import {verify} from '../user';
+import config, {IConfig} from '../../config';
 
 let payload: any = null;
 
@@ -13,13 +13,13 @@ jest.mock('../../config', () => ({
     secret: 'string',
     domain: 'string',
     defaultRole: 'string',
-  }
+  },
 }));
 const mockedConfig: jest.Mocked<IConfig> = jest.mocked(config);
 
 jest.mock('google-auth-library', () => {
   class FakeOAuth2Client {
-    verifyIdToken() {
+    verifyIdToken() { // eslint-disable-line class-methods-use-this
       return {getPayload: () => payload};
     }
   }
@@ -28,7 +28,7 @@ jest.mock('google-auth-library', () => {
   return {
     __esModule: true,
     ...originalModule,
-    OAuth2Client: FakeOAuth2Client
+    OAuth2Client: FakeOAuth2Client,
   };
 });
 
@@ -45,15 +45,20 @@ describe('user controller :: verify', () => {
   beforeEach(() => {
     // mockedAuthClient.mockClear();
     // authClientMock.mockClear();
-  })
+  });
 
   it('returns "Invalid token" if it fails to get the payload', async () => {
     const result = await verify('token');
-    expect(result).toBe('Invalid token')
-  })
+    expect(result).toBe('Invalid token');
+  });
 
   it('checks the audience & domain corresponds to ../config', async () => {
-    payload = {email_verified: true, email: 'email', aud: 'id1', hd: 'itenium.be'}
+    payload = {
+      email_verified: true,
+      email: 'email',
+      aud: 'id1',
+      hd: 'itenium.be',
+    };
     jest.replaceProperty(config, 'security', {
       clientId: 'id1',
       secret: 'string',
@@ -62,18 +67,18 @@ describe('user controller :: verify', () => {
     });
     const result = await verify('token');
 
-    expect(result).toBeInstanceOf(Object)
-  })
+    expect(result).toBeInstanceOf(Object);
+  });
 
   it.skip('sets a default role if one has been set in config', () => {
 
-  })
+  });
 
   it.skip('automatically activates a user when a default role has been set in config', () => {
 
-  })
+  });
 
   it.skip('sets the audit property', () => {
 
-  })
-})
+  });
+});

backend/src/controllers/tests/0-user-verify.test.ts

@@ -2,13 +2,12 @@
 // Test an async (req, res) Express function
 // With manual Express mocks
 
-import { Request, Response } from 'express';
-import { ConfacRequest } from '../../models/technical';
-import { IAudit } from '../../models/common';
-import { IClient } from '../../models/clients'
-import { Jwt } from '../../models/technical'
-import { saveClient } from '../clients';
-import { SocketServerMock } from 'socket.io-mock-ts';
+import {Request, Response} from 'express';
+import {SocketServerMock} from 'socket.io-mock-ts'; // eslint-disable-line import/no-extraneous-dependencies
+import {ConfacRequest, Jwt} from '../../models/technical';
+import {IAudit} from '../../models/common';
+import {IClient} from '../../models/clients';
+import {saveClient} from '../clients';
 
 const fakeUser: Jwt = {
   data: {
@@ -21,21 +20,17 @@ const fakeUser: Jwt = {
   },
   iat: 0,
   exp: 0,
-}
+};
 
 const fakeClient: Partial<IClient> = {
   // _id: new ObjectID('xxx'),
   active: true,
   name: '',
   audit: {} as IAudit,
-}
+};
 
 
-const fakeDb = {
-  collection: (colName: string) => ({
-    insertOne: (client: any) => Promise.resolve({ops: [client]})
-  })
-}
+const fakeDb = {collection: (colName: string) => ({insertOne: (client: any) => Promise.resolve({ops: [client]})})};
 
 
 describe('clients controller :: saveClient creation', () => {
@@ -47,22 +42,19 @@ describe('clients controller :: saveClient creation', () => {
       io: new SocketServerMock() as any,
     } as ConfacRequest;
 
-    const res = {
-      send: (c: IClient) => Promise.resolve(c)
-    } as unknown as Response;
-
+    const res = {send: (c: IClient) => Promise.resolve(c)} as unknown as Response;
     const result = await saveClient(req, res);
     const createdClient = result as unknown as IClient;
 
     expect(createdClient.slug).toBe('company-x');
-  })
+  });
 
 
 
   it.skip('sets the client.audit', () => {
     // TODO: Production is burning, implement this later!!
-  })
-})
+  });
+});
 
 
 
@@ -71,10 +63,10 @@ describe('clients controller :: saveClient creation', () => {
 describe.skip('clients controller :: saveClient updating', () => {
   it('should update client.audit', () => {
 
-  })
+  });
 
   it('should insert full audit of the changes', () => {
     // TODO: Maybe this whole mongodb thing is a bit too much for our fakeDb...?
     // TODO: Or could test just the saveAudit function.
-  })
-})
+  });
+});

backend/src/controllers/tests/1-clients.test.ts

@@ -1,29 +1,29 @@
+/* eslint-disable object-curly-newline */
 // Exercises 2:
 // In memory mongodb testing
 // https://github.com/nodkz/mongodb-memory-server
 // https://github.com/shelfio/jest-mongodb (not used here)
 
-import { Request, Response } from 'express';
-import { Db, MongoClient } from 'mongodb';
-import { ConfacRequest } from '../../models/technical';
-import { IAudit } from '../../models/common';
-import { Jwt } from '../../models/technical'
-import { saveConsultant } from '../consultants';
-import { IConsultant } from '../../models/consultants';
-// import { MongoMemoryServer } from 'mongodb-memory-server';
-import { SocketServerMock } from 'socket.io-mock-ts';
+import {Request, Response} from 'express';
+import {Db, MongoClient} from 'mongodb';
+// import {MongoMemoryServer} from 'mongodb-memory-server';
+import {SocketServerMock} from 'socket.io-mock-ts';// eslint-disable-line import/no-extraneous-dependencies
+import {IAudit} from '../../models/common';
+import {Jwt, ConfacRequest} from '../../models/technical';
+import {saveConsultant} from '../consultants';
+import {IConsultant} from '../../models/consultants';
 
 const fakeUser: Jwt = {
-  data: { _id: '_id', email: 'string', firstName: 'first', name: 'name', alias: 'alias', active: true },
+  data: {_id: '_id', email: 'string', firstName: 'first', name: 'name', alias: 'alias', active: true},
   iat: 0, exp: 0,
-}
+};
 
 const fakeConsultant: Partial<IConsultant> = {
   _id: undefined,
   firstName: '',
   name: '',
   audit: {} as IAudit,
-}
+};
 
 const createFakeRequestAndResponse = (db: Db, consultant: Partial<IConsultant> | null = null) => {
   const req = {
@@ -34,11 +34,11 @@ const createFakeRequestAndResponse = (db: Db, consultant: Partial<IConsultant> |
   } as ConfacRequest;
 
   const res = {
-    send: (c: IConsultant) => Promise.resolve(c)
+    send: (c: IConsultant) => Promise.resolve(c),
   } as unknown as Response;
 
   return {req, res};
-}
+};
 
 describe('consultants controller :: saveConsultant', () => {
   // let mongoServer: MongoMemoryServer;
@@ -61,7 +61,7 @@ describe('consultants controller :: saveConsultant', () => {
   beforeEach(async () => {
     // Clean the db for each run?
     // await db.collection('consultants').deleteMany({});
-  })
+  });
 
   describe('creating a consultant', () => {
     // it('sets the consultant.slug', async () => {
@@ -91,21 +91,21 @@ describe('consultants controller :: saveConsultant', () => {
     it.skip('checks that the db record has expected name and firstName', async () => {
 
     });
-  })
+  });
 
   describe.skip('updating a consultant', () => {
     it('updates a consultant when it has an _id', () => {
 
-    })
+    });
 
     it('saves an audit record', () => {
 
-    })
+    });
   });
 
   // afterAll(async () => {
   //   await connection.close();
   //   await mongoServer.stop();
   //   // await mongoServer.cleanup();
   // });
-})
+});