Merge pull request #58 from cham11ng/say-no-to-any

cham11ng · web-flow · commit a6bc97f5ad16 · 2022-06-30T18:56:40.000+05:45
Say No to any, refactor codebase
diff --git a/README.md b/README.md
@@ -5,15 +5,14 @@
   </a>
 </p>
 
-Starter for Node.js Express API in Typescript.
+Starter for Node.js Express API in Typescript with jsonwebtoken, joi, Knex, Objection.js and many other popular tools.
 
 ## Requirements
 
 - [Node.js](https://yarnpkg.com/en/docs/install)
 - [Yarn](https://yarnpkg.com/en/docs/install)
 - [NPM](https://docs.npmjs.com/getting-started/installing-node)
 - [Docker](https://docs.docker.com/install/)
-- [Docker Compose](https://docs.docker.com/compose/install/)
 
 ## Getting Started
 
@@ -42,11 +41,9 @@ $ yarn load:fake <FactoryName> <Number>
 Start the application.
 
 ```bash
-$ yarn build
+$ yarn build # For production
 
-$ yarn start # For production
-
-$ yarn start:dev # For development
+$ yarn start # For development
 ```
 
 <p align="center">
@@ -64,23 +61,23 @@ $ cp .env.docker .env
 Install dependencies and run the application locally.
 
 ```bash
-$ docker-compose up -d postgres
+$ docker compose up -d postgres
 
-$ docker-compose up -d api
+$ docker compose up -d api
 
-$ docker-compose exec api sh yarn migrate # Make sure server is started checking logs before running this command
+$ docker compose exec api sh yarn migrate # Make sure server is started checking logs before running this command
 ```
 
 View logs of the container.
 
 ```bash
-$ docker-compose logs -f
+$ docker compose logs -f
 ```
 
 To stop the services.
 
 ```bash
-$ docker-compose stop api postgres
+$ docker compose stop api postgres
 ```
 
 ## Generating Migrations and Seeds
diff --git a/api.rest b/api.rest
@@ -2,6 +2,11 @@ GET {{host}} HTTP/1.1
 
 ###
 
+GET {{host}}/users HTTP/1.1
+Authorization: {{accessToken}}
+
+###
+
 POST {{host}}/login HTTP/1.1
 Content-Type: application/json
 
@@ -15,4 +20,7 @@ Content-Type: application/json
 POST {{host}}/refresh HTTP/1.1
 Authorization: {{refreshToken}}
 
-###
+###
+
+POST {{host}}/logout HTTP/1.1
+Authorization: {{refreshToken}}
diff --git a/package.json b/package.json
@@ -53,7 +53,6 @@
   ],
   "dependencies": {
     "bcrypt": "^5.0.1",
-    "bookshelf-case-converter-plugin": "^2.0.0",
     "cors": "^2.8.5",
     "date-fns": "^2.11.1",
     "dotenv": "^16.0.1",
diff --git a/scripts/fake-loader.ts b/scripts/fake-loader.ts
@@ -1,6 +1,7 @@
 import chalk from 'chalk';
 
 import * as fake from '../src/utils/fake';
+import { bindModel } from '../src/config/db';
 import factories, { FactoryType } from '../src/database/factories';
 
 const { info } = console;
@@ -18,10 +19,12 @@ function print<T>(data: T): void {
 
     const factoryCallback = factories[table as FactoryType].run;
 
+    bindModel();
+
     print(await fake.generate(factoryCallback, total));
 
     process.exit(0);
-  } catch (err: any) {
+  } catch (err) {
     info(chalk`{red ${err.message}}`);
 
     process.exit(1);
diff --git a/src/app.ts b/src/app.ts
@@ -1,19 +1,18 @@
 import cors from 'cors';
 import helmet from 'helmet';
 import express from 'express';
-import { Model } from 'objection';
 
 import routes from './routes';
-import knex from './config/knex';
+import { bindModel } from './config/db';
 import logHandler from './middlewares/logHandler';
 import notFoundHandler from './middlewares/notFoundHandler';
 import transactionHandler from './middlewares/transactionHandler';
 import genericErrorHandler from './middlewares/genericErrorHandler';
 
-Model.knex(knex);
-
 const app: express.Application = express();
 
+bindModel();
+
 app.use(cors());
 app.use(helmet());
 app.use(transactionHandler);
diff --git a/src/config/db.ts b/src/config/db.ts
@@ -0,0 +1,17 @@
+import Knex from 'knex';
+import { Model, knexSnakeCaseMappers } from 'objection';
+
+import config from './config';
+
+const dbConfig = config.db;
+
+const knex = Knex({ ...dbConfig, ...knexSnakeCaseMappers() });
+
+/**
+ * Bind model with Knex.
+ */
+export function bindModel() {
+  Model.knex(knex);
+}
+
+export default knex;
diff --git a/src/config/knex.ts b/src/config/knex.ts
diff --git a/src/middlewares/authenticate.ts b/src/middlewares/authenticate.ts
@@ -1,19 +1,16 @@
+import { JsonWebTokenError } from 'jsonwebtoken';
 import { Request, Response, NextFunction } from 'express';
 
 import * as jwt from '../utils/jwt';
 import logger from '../utils/logger';
 import config from '../config/config';
-import ErrorType from './../resources/enums/ErrorType';
+import { JWTErrorType } from './../resources/enums/ErrorType';
 import BadRequestError from '../exceptions/BadRequestError';
 import UnauthorizedError from '../exceptions/UnauthorizedError';
+import { tokenErrorMessageMap } from '../resources/constants/maps';
 
 const { errors } = config;
 
-const tokenErrorMessageMap: any = {
-  [ErrorType.INVALID]: errors.invalidToken,
-  [ErrorType.EXPIRED]: errors.accessTokenExpired
-};
-
 /**
  * A middleware to authenticate the authorization token i.e. access token.
  *
@@ -48,17 +45,21 @@ async function authenticate(
     );
 
     next();
-  } catch (err: any) {
-    const tokenErrorMessage = tokenErrorMessageMap[err.name];
-    logger.log('error', 'JWT: Authentication failed - %s', err.message);
+  } catch (err) {
+    if (err instanceof JsonWebTokenError) {
+      const tokenErrorMessage = tokenErrorMessageMap[err.name as JWTErrorType];
+      logger.log('error', 'JWT: Authentication failed - %s', err.message);
+
+      if (tokenErrorMessage) {
+        logger.log('error', 'JWT: Token error - %s', tokenErrorMessage);
 
-    if (tokenErrorMessage) {
-      logger.log('error', 'JWT: Token error - %s', tokenErrorMessage);
+        next(new UnauthorizedError(tokenErrorMessage));
 
-      next(new UnauthorizedError(tokenErrorMessage));
-    } else {
-      next(err);
+        return;
+      }
     }
+
+    next(err);
   }
 }
 
diff --git a/src/middlewares/validateRefreshToken.ts b/src/middlewares/validateRefreshToken.ts
@@ -3,17 +3,13 @@ import { Request, Response, NextFunction } from 'express';
 import * as jwt from '../utils/jwt';
 import logger from '../utils/logger';
 import config from '../config/config';
-import ErrorType from './../resources/enums/ErrorType';
 import BadRequestError from '../exceptions/BadRequestError';
+import { JWTErrorType } from '../resources/enums/ErrorType';
 import UnauthorizedError from '../exceptions/UnauthorizedError';
+import { tokenErrorMessageMap } from '../resources/constants/maps';
 
 const { errors } = config;
 
-const tokenErrorMessageMap: any = {
-  [ErrorType.INVALID]: errors.invalidToken,
-  [ErrorType.EXPIRED]: errors.refreshTokenExpired
-};
-
 /**
  * A middleware to validateRefershToken the authorization token i.e. refresh token.
  *
@@ -49,7 +45,7 @@ async function validateRefreshToken(
 
     next();
   } catch (err: any) {
-    const tokenErrorMessage = tokenErrorMessageMap[err.name];
+    const tokenErrorMessage = tokenErrorMessageMap[err.name as JWTErrorType];
     logger.log('error', 'JWT: Authentication failed - %s', err.message);
 
     if (tokenErrorMessage) {
diff --git a/src/resources/constants/maps.ts b/src/resources/constants/maps.ts
@@ -0,0 +1,9 @@
+import config from '../../config/config';
+import { JWTErrorType } from '../enums/ErrorType';
+
+const { errors } = config;
+
+export const tokenErrorMessageMap = {
+  [JWTErrorType.INVALID]: errors.invalidToken,
+  [JWTErrorType.EXPIRED]: errors.refreshTokenExpired
+};
diff --git a/src/resources/enums/ErrorType.ts b/src/resources/enums/ErrorType.ts
@@ -1,10 +1,7 @@
 /**
- * List of ErrorType.
+ * List of JWTErrorType.
  */
-enum ErrorType {
+export enum JWTErrorType {
   INVALID = 'JsonWebTokenError',
-  EXPIRED = 'TokenExpiredError',
-  NO_ROWS_UPDATED_ERROR = 'No Rows Updated'
+  EXPIRED = 'TokenExpiredError'
 }
-
-export default ErrorType;
diff --git a/src/services/sessionService.ts b/src/services/sessionService.ts
@@ -1,7 +1,6 @@
 import logger from '../utils/logger';
 import config from '../config/config';
 import UserSession from '../models/UserSession';
-import ErrorType from '../resources/enums/ErrorType';
 import ForbiddenError from '../exceptions/ForbiddenError';
 import UserSessionDetail from '../domain/entities/UserSessionDetail';
 import UserSessionPayload from '../domain/requests/UserSessionPayload';
@@ -33,22 +32,21 @@ export async function create(
  * @returns {Promise<UserSessionDetail>}
  */
 export async function remove(token: string): Promise<UserSessionDetail> {
-  try {
-    logger.log('info', 'User Session: Deactivating token - %s', token);
-
-    const [session] = await UserSession.query()
-      .update({ isActive: false })
-      .where('token', token)
-      .where('isActive', true)
-      .returning('*');
-    logger.log('debug', 'User Session: Deactivated session -', session);
-
-    return session;
-  } catch (err: any) {
-    if (err.message === ErrorType.NO_ROWS_UPDATED_ERROR) {
-      throw new ForbiddenError(errors.sessionNotMaintained);
-    }
-
-    throw err;
+  logger.log('info', 'User Session: Deactivating token - %s', token);
+
+  const session = await UserSession.query().findOne({
+    token,
+    isActive: true
+  });
+
+  if (!session) {
+    throw new ForbiddenError(errors.sessionNotMaintained);
   }
+
+  const updatedSession = await session
+    .$query()
+    .updateAndFetch({ isActive: false });
+  logger.log('debug', 'User Session: Deactivated session -', updatedSession);
+
+  return updatedSession;
 }
diff --git a/src/services/userService.ts b/src/services/userService.ts
@@ -1,7 +1,6 @@
 import User from '../models/User';
 import logger from '../utils/logger';
 import * as bcrypt from '../utils/bcrypt';
-import * as object from '../utils/object';
 import transform from '../utils/transform';
 import Role from '../resources/enums/Role';
 import UserDetail from '../domain/entities/UserDetail';
@@ -45,5 +44,5 @@ export async function insert(params: UserPayload): Promise<UserDetail> {
 
   logger.log('debug', 'Inserted user successfully:', user);
 
-  return object.camelize(user);
+  return user;
 }
diff --git a/src/utils/mail.ts b/src/utils/mail.ts
@@ -26,8 +26,12 @@ export async function send(mailOptions: MailOptions): Promise<any> {
     const info = await transporter.sendMail(mailOptions);
 
     return info;
-  } catch (err: any) {
-    logger.log('error', 'Mail: Failed to send email - %s', err.message);
+  } catch (err) {
+    logger.log(
+      'error',
+      'Mail: Failed to send email - %s',
+      err instanceof Error ? err.message : err
+    );
   }
 }
 
diff --git a/src/utils/object.ts b/src/utils/object.ts
diff --git a/test/api/auth.spec.ts b/test/api/auth.spec.ts
diff --git a/test/helper.ts b/test/helper.ts
diff --git a/test/unit/object.spec.ts b/test/unit/object.spec.ts
diff --git a/yarn.lock b/yarn.lock
