Merge pull request #80 from waldemarnt/update-deps

waldemarnt · web-flow · commit 1e119785dcb1 · 2021-12-29T17:15:45.000+10:00
Update all dependencies from chapter 1 to 9
diff --git a/.github/workflows/full-workflow.yml b/.github/workflows/full-workflow.yml
@@ -21,11 +21,11 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
 
     services:
       mongodb:
-        image: mongo:4.2
+        image: mongo:5.0
         ports:
           - 27017
         options: >-
diff --git a/jest.config.js b/jest.config.js
@@ -10,5 +10,5 @@ module.exports = {
   moduleNameMapper: {
     '@src/(.*)': '<rootDir>/src/$1',
     '@test/(.*)': '<rootDir>/test/$1',
-  },
+  }
 };
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "style:fix": "prettier --write src/**/*.ts' test/**/*.ts"
   },
   "engines": {
-    "node": "14"
+    "node": "16"
   },
   "repository": {
     "type": "git",
@@ -35,53 +35,51 @@
   },
   "homepage": "https://github.com/waldemarnt/node-typescript-api#readme",
   "dependencies": {
-    "@overnightjs/core": "^1.7.4",
-    "axios": "^0.21.1",
-    "bcrypt": "^5.0.0",
-    "body-parser": "^1.19.0",
-    "config": "^3.3.1",
+    "@overnightjs/core": "^1.7.6",
+    "@types/express": "^4.17.13",
+    "axios": "^0.24.0",
+    "bcrypt": "^5.0.1",
+    "body-parser": "^1.19.1",
+    "config": "^3.3.6",
     "cors": "^2.8.5",
-    "express": "^4.17.1",
-    "express-openapi-validator": "^3.16.1",
-    "express-pino-logger": "^5.0.0",
-    "express-rate-limit": "^5.1.3",
-    "http-status-codes": "^1.4.0",
+    "express": "^4.17.2",
+    "express-openapi-validator": "^4.13.5",
+    "express-pino-logger": "^7.0.0",
+    "express-rate-limit": "^6.0.1",
+    "http-status-codes": "^2.2.0",
     "jsonwebtoken": "^8.5.1",
-    "lodash": "^4.17.19",
+    "lodash": "^4.17.21",
     "module-alias": "^2.2.2",
-    "moment": "^2.27.0",
-    "mongoose": "^5.9.18",
+    "moment": "^2.29.1",
+    "mongoose": "^6.1.4",
     "node-cache": "^5.1.2",
-    "pino": "^6.3.2",
-    "swagger-ui-express": "^4.1.4"
+    "pino": "^7.6.2",
+    "swagger-ui-express": "^4.3.0"
   },
   "devDependencies": {
-    "@types/bcrypt": "^3.0.0",
-    "@types/config": "^0.0.36",
-    "@types/cors": "^2.8.7",
-    "@types/express": "^4.17.6",
-    "@types/express-pino-logger": "^4.0.2",
-    "@types/express-rate-limit": "^5.0.0",
-    "@types/jest": "^25.2.2",
-    "@types/jsonwebtoken": "^8.5.0",
-    "@types/lodash": "^4.14.155",
-    "@types/module-alias": "^2.0.0",
-    "@types/multer": "^1.4.3",
-    "@types/node": "14",
-    "@types/pino": "^6.3.0",
-    "@types/supertest": "^2.0.9",
-    "@types/swagger-ui-express": "^4.1.2",
-    "@typescript-eslint/eslint-plugin": "^2.29.0",
-    "@typescript-eslint/parser": "^2.29.0",
-    "dotenv-cli": "^3.2.0",
-    "eslint": "^6.8.0",
-    "jest": "^26.6.3",
-    "nock": "^12.0.3",
-    "pino-pretty": "^4.0.0",
-    "prettier": "^2.0.5",
-    "supertest": "^4.0.2",
-    "ts-jest": "^26.4.4",
-    "ts-node-dev": "^1.0.0-pre.61",
-    "typescript": "^4.1.3"
+    "@types/bcrypt": "^5.0.0",
+    "@types/config": "^0.0.40",
+    "@types/cors": "^2.8.12",
+    "@types/express-pino-logger": "^4.0.3",
+    "@types/jest": "^27.0.3",
+    "@types/jsonwebtoken": "^8.5.6",
+    "@types/lodash": "^4.14.178",
+    "@types/module-alias": "^2.0.1",
+    "@types/node": "16",
+    "@types/supertest": "^2.0.11",
+    "@types/swagger-ui-express": "^4.1.3",
+    "@typescript-eslint/eslint-plugin": "^5.8.1",
+    "@typescript-eslint/parser": "^5.8.1",
+    "dotenv-cli": "^4.1.1",
+    "eslint": "^8.5.0",
+    "is-typedarray": "^1.0.0",
+    "jest": "^27.4.5",
+    "nock": "^13.2.1",
+    "pino-pretty": "^7.3.0",
+    "prettier": "^2.5.1",
+    "supertest": "^6.1.6",
+    "ts-jest": "^27.1.2",
+    "ts-node-dev": "^1.1.8",
+    "typescript": "^4.5.4"
   }
 }
diff --git a/src/api-schema.json b/src/api-schema.json
@@ -61,6 +61,21 @@
                 }
               }
             }
+          },
+          "409": {
+            "description": "Conflict",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                },
+                "example": {
+                  "message": "Conflict",
+                  "code": "409",
+                  "error": "Conflict"
+                }
+              }
+            }
           }
         }
       }
diff --git a/src/clients/__test__/stormGlass.test.ts b/src/clients/__test__/stormGlass.test.ts
@@ -78,35 +78,42 @@ describe('StormGlass client', () => {
     const lat = -33.792726;
     const lng = 151.289824;
 
-    mockedRequest.get.mockRejectedValue({ message: 'Network Error' });
+    mockedRequest.get.mockRejectedValue('Network Error');
 
     MockedCacheUtil.get.mockReturnValue(undefined);
 
     const stormGlass = new StormGlass(mockedRequest, MockedCacheUtil);
 
     await expect(stormGlass.fetchPoints(lat, lng)).rejects.toThrow(
-      'Unexpected error when trying to communicate to StormGlass: Network Error'
+      'Unexpected error when trying to communicate to StormGlass: "Network Error"'
     );
   });
 
   it('should get an StormGlassResponseError when the StormGlass service responds with error', async () => {
     const lat = -33.792726;
     const lng = 151.289824;
 
-    mockedRequest.get.mockRejectedValue({
-      response: {
+    class FakeAxiosError extends Error {
+      constructor(public response: object) {
+        super();
+      }
+    }
+
+    mockedRequest.get.mockRejectedValue(
+      new FakeAxiosError({
         status: 429,
         data: { errors: ['Rate Limit reached'] },
-      },
-    });
-    /**
-     * Mock static function return
-     */
+      })
+    );
+
     MockedRequestClass.isRequestError.mockReturnValue(true);
 
-    MockedCacheUtil.get.mockReturnValue(undefined);
+    MockedRequestClass.extractErrorData.mockReturnValue({
+      status: 429,
+      data: { errors: ['Rate Limit reached'] },
+    });
 
-    const stormGlass = new StormGlass(mockedRequest, MockedCacheUtil);
+    const stormGlass = new StormGlass(mockedRequest);
 
     await expect(stormGlass.fetchPoints(lat, lng)).rejects.toThrow(
       'Unexpected error returned by the StormGlass service: Error: {"errors":["Rate Limit reached"]} Code: 429'
diff --git a/src/clients/stormGlass.ts b/src/clients/stormGlass.ts
@@ -116,17 +116,18 @@ export class StormGlass {
       );
       return this.normalizeResponse(response.data);
     } catch (err) {
-      /**
-       * This is handling the Axios errors specifically
-       */
-      if (HTTPUtil.Request.isRequestError(err)) {
+      //@Updated 2022 to support Error as unknown
+      //https://devblogs.microsoft.com/typescript/announcing-typescript-4-4/#use-unknown-catch-variables
+      if (err instanceof Error && HTTPUtil.Request.isRequestError(err)) {
+        const error = HTTPUtil.Request.extractErrorData(err);
         throw new StormGlassResponseError(
-          `Error: ${JSON.stringify(err.response.data)} Code: ${
-            err.response.status
-          }`
+          `Error: ${JSON.stringify(error.data)} Code: ${error.status}`
         );
       }
-      throw new ClientRequestError(err.message);
+      /**
+       * All the other errors will fallback to a generic client error
+       */
+      throw new ClientRequestError(JSON.stringify(err));
     }
   }
 
diff --git a/src/controllers/index.ts b/src/controllers/index.ts
@@ -5,10 +5,7 @@ import logger from '@src/logger';
 import ApiError, { APIError } from '@src/util/errors/api-error';
 
 export abstract class BaseController {
-  protected sendCreateUpdateErrorResponse(
-    res: Response,
-    error: mongoose.Error.ValidationError | Error
-  ): void {
+  protected sendCreateUpdateErrorResponse(res: Response, error: unknown): void {
     if (error instanceof mongoose.Error.ValidationError) {
       const clientErrors = this.handleClientErrors(error);
       res.status(clientErrors.code).send(
@@ -18,18 +15,21 @@ export abstract class BaseController {
         })
       );
     } else {
-      logger.error(error);
+      logger.error(JSON.stringify(error));
       res
         .status(500)
         .send(ApiError.format({ code: 500, message: 'Something went wrong!' }));
     }
   }
 
-  private handleClientErrors(
-    error: mongoose.Error.ValidationError
-  ): { code: number; error: string } {
+  private handleClientErrors(error: mongoose.Error.ValidationError): {
+    code: number;
+    error: string;
+  } {
     const duplicatedKindErrors = Object.values(error.errors).filter(
-      (err) => err.kind === CUSTOM_VALIDATION.DUPLICATED
+      (err) =>
+        err.name === 'ValidatorError' &&
+        err.kind === CUSTOM_VALIDATION.DUPLICATED
     );
     if (duplicatedKindErrors.length) {
       return { code: 409, error: error.message };
diff --git a/src/database.ts b/src/database.ts
@@ -1,13 +1,10 @@
 import config, { IConfig } from 'config';
-import mongoose, { Mongoose } from 'mongoose';
+import { connect as mongooseConnect, connection } from 'mongoose';
 
 const dbConfig: IConfig = config.get('App.database');
 
-export const connect = async (): Promise<Mongoose> =>
-  await mongoose.connect(dbConfig.get('mongoUrl'), {
-    useCreateIndex: true,
-    useNewUrlParser: true,
-    useUnifiedTopology: true,
-  });
+export const connect = async (): Promise<void> => {
+  await mongooseConnect(dbConfig.get('mongoUrl'));
+};
 
-export const close = (): Promise<void> => mongoose.connection.close();
+export const close = (): Promise<void> => connection.close();
diff --git a/src/middlewares/auth.ts b/src/middlewares/auth.ts
@@ -12,6 +12,10 @@ export function authMiddleware(
     req.context = { userId: claims.sub };
     next();
   } catch (err) {
-    res.status?.(401).send({ code: 401, error: err.message });
+    if (err instanceof Error) {
+      res.status?.(401).send({ code: 401, error: err.message });
+    } else {
+      res.status?.(401).send({ code: 401, error: 'Unknown auth error' });
+    }
   }
 }
diff --git a/src/models/user.ts b/src/models/user.ts
@@ -21,7 +21,6 @@ const schema = new mongoose.Schema(
     email: {
       type: String,
       required: true,
-      unique: [true, 'Email must be unique'],
     },
     password: { type: String, required: true },
   },
diff --git a/src/server.ts b/src/server.ts
@@ -6,7 +6,7 @@ import * as http from 'http';
 import expressPino from 'express-pino-logger';
 import cors from 'cors';
 import swaggerUi from 'swagger-ui-express';
-import { OpenApiValidator } from 'express-openapi-validator';
+import * as OpenApiValidator from 'express-openapi-validator';
 import { OpenAPIV3 } from 'express-openapi-validator/dist/framework/types';
 import { ForecastController } from './controllers/forecast';
 import * as database from '@src/database';
@@ -55,11 +55,13 @@ export class SetupServer extends Server {
 
   private async docsSetup(): Promise<void> {
     this.app.use('/docs', swaggerUi.serve, swaggerUi.setup(apiSchema));
-    await new OpenApiValidator({
-      apiSpec: apiSchema as OpenAPIV3.Document,
-      validateRequests: true, //we do it
-      validateResponses: true,
-    }).install(this.app);
+    this.app.use(
+      OpenApiValidator.middleware({
+        apiSpec: apiSchema as OpenAPIV3.Document,
+        validateRequests: true, //will be implemented in step2
+        validateResponses: true, //will be implemented in step2
+      })
+    );
   }
 
   private setupControllers(): void {
diff --git a/src/services/forecast.ts b/src/services/forecast.ts
@@ -40,7 +40,8 @@ export class Forecast {
         forecast: _.orderBy(t.forecast, [orderField], [orderBy]),
       }));
     } catch (error) {
-      throw new ForecastProcessingInternalError(error.message);
+      logger.error(error);
+      throw new ForecastProcessingInternalError((error as Error).message);
     }
   }
 
diff --git a/src/util/request.ts b/src/util/request.ts
@@ -12,7 +12,22 @@ export class Request {
     return this.request.get<T, Response<T>>(url, config);
   }
 
-  public static isRequestError(error: AxiosError): boolean {
-    return !!(error.response && error.response.status);
+  public static isRequestError(error: Error): boolean {
+    return !!(
+      (error as AxiosError).response && (error as AxiosError).response?.status
+    );
+  }
+
+  public static extractErrorData(
+    error: unknown
+  ): Pick<AxiosResponse, 'data' | 'status'> {
+    const axiosError = error as AxiosError;
+    if (axiosError.response && axiosError.response.status) {
+      return {
+        data: axiosError.response.data,
+        status: axiosError.response.status,
+      };
+    }
+    throw Error(`The error ${error} is not a Request Error`);
   }
 }
diff --git a/test/functional/beaches.test.ts b/test/functional/beaches.test.ts
@@ -74,7 +74,7 @@ describe('Beaches functional tests', () => {
       expect(response.status).toBe(500);
       expect(response.body).toEqual({
         code: 500,
-        error: 'Server Error',
+        error: 'Internal Server Error',
         message: 'Something went wrong!',
       });
     });
diff --git a/test/globals.d.ts b/test/globals.d.ts
@@ -1,6 +1,10 @@
-declare namespace NodeJS {
-  interface Global {
-    //https://stackoverflow.com/a/51114250
-    testRequest: import('supertest').SuperTest<import('supertest').Test>;
-  }
+/**
+ * @Update 2022 - This has logic has been update to support newer Node.js versions
+ * that don't have NodeJS as a global type
+ */
+declare global {
+  //eslint-disable-next-line no-var
+  var testRequest: import('supertest').SuperTest<import('supertest').Test>;
 }
+
+export {};
diff --git a/test/jest.config.js b/test/jest.config.js
@@ -6,5 +6,5 @@ module.exports = {...rootConfig, ...{
   rootDir: root,
   displayName: "end2end-tests",
   setupFilesAfterEnv: ["<rootDir>/test/jest-setup.ts"],
-  testMatch: ["<rootDir>/test/**/*.test.ts"],
+  testMatch: ["<rootDir>/test/**/*.test.ts"]
 }}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,21 @@`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`	`}`
	`64`	`+ },`
	`65`	`+ "409": {`
	`66`	`+ "description": "Conflict",`
	`67`	`+ "content": {`
	`68`	`+ "application/json": {`
	`69`	`+ "schema": {`
	`70`	`+ "$ref": "#/components/schemas/Error"`
	`71`	`+ },`
	`72`	`+ "example": {`
	`73`	`+ "message": "Conflict",`
	`74`	`+ "code": "409",`
	`75`	`+ "error": "Conflict"`
	`76`	`+ }`
	`77`	`+ }`
	`78`	`+ }`
`64`	`79`	`}`
`65`	`80`	`}`
`66`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,10 @@ export function authMiddleware(`
`12`	`12`	`req.context = { userId: claims.sub };`
`13`	`13`	`next();`
`14`	`14`	`} catch (err) {`
`15`		`- res.status?.(401).send({ code: 401, error: err.message });`
	`15`	`+ if (err instanceof Error) {`
	`16`	`+ res.status?.(401).send({ code: 401, error: err.message });`
	`17`	`+ } else {`
	`18`	`+ res.status?.(401).send({ code: 401, error: 'Unknown auth error' });`
	`19`	`+ }`
`16`	`20`	`}`
`17`	`21`	`}`