feat(cb2-13920): node 20 upgrade (#89)

* feat: node 20 upgrade and triage unneccessary dependencies

* chore: install common package and utilise HttpStatus enum

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1 @@
+npm run security-checks && npm run audit && npm run lint:fix && npm run format

.husky/pre-push

@@ -0,0 +1 @@
+npm run test && npm run build && npm run test-i

.npm-version

@@ -1 +1 @@
-9.5.0
+10.8.1

.nvmrc

@@ -1 +1 @@
-18.*
+20.16

README.md

@@ -39,8 +39,9 @@ npm test
 
 Please refer to the the [docs](./docs/README.md) for the API specification and samples of postman requests.
 
-If the tests return a credentials error, check `~/.aws/credentials` has dummy values set up 
+If the tests return a credentials error, check `~/.aws/credentials` has dummy values set up
+
 ```
 AWS_ACCESS_KEY_ID=some_value
 AWS_SECRET_ACCESS_KEY=some_value
-```
+```

package.json

@@ -9,78 +9,65 @@
     "type": "git",
     "url": "git+https://github.com/dvsa/cvs-svc-app-logs.git"
   },
-  "dependencies": {
-    "@aws-sdk/client-cloudwatch-logs": "3.540.0",
-    "moment": "^2.29.4"
-  },
   "engines": {
-    "node": "18.*",
-    "npm": "9.*"
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "npm run security-checks && npm run audit && npm run lint:fix && npm run format",
-      "pre-push": "npm run test && npm run build && npm run test-i"
-    }
-  },
-  "devDependencies": {
-    "@commitlint/cli": "17.7.1",
-    "@commitlint/config-conventional": "17.7.0",
-    "@types/aws-lambda": "^8.10.119",
-    "@types/jasmine": "^4.3.5",
-    "@types/node": "^20.5.0",
-    "@types/sinon": "^10.0.16",
-    "@types/supertest": "^2.0.12",
-    "audit-filter": "^0.5.0",
-    "aws-lambda-test-utils": "^1.3.0",
-    "aws-sdk-client-mock": "4.0.0",
-    "esbuild": "0.23.1",
-    "husky": "8.0.3",
-    "jasmine": "^5.1.0",
-    "jasmine-spec-reporter": "^7.0.0",
-    "json-schema-to-typescript": "^13.0.2",
-    "npm-run-all": "^4.1.5",
-    "nyc": "^15.1.0",
-    "prettier": "3.0.1",
-    "rimraf": "^5.0.1",
-    "serverless": "^3.34.0",
-    "serverless-offline": "^12.0.4",
-    "serverless-webpack": "^5.13.0",
-    "sinon": "^15.2.0",
-    "sonar-scanner": "3.1.0",
-    "source-map-support": "^0.5.21",
-    "supertest": "^6.3.3",
-    "ts-loader": "^9.4.4",
-    "ts-node": "^10.9.1",
-    "tslint": "^5.20.1",
-    "tslint-config-airbnb": "^5.11.2",
-    "typemoq": "^2.1.0",
-    "typescript": "^5.1.6",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.4",
-    "yamljs": "^0.3.0"
+    "node": "20.*",
+    "npm": "10.*"
   },
   "scripts": {
-    "clean": "rimraf build artefacts",
+    "clean": "rimraf build artefacts logs",
     "compile": "rm -rf build && tsc",
     "lint": "tslint --project tslint.json",
     "format": "prettier --write .",
-    "build": "node_modules/typescript/bin/tsc --rootDir ./ --outDir .build --sourceMap false && npm run build:copy",
-    "build:copy": "find src -type f \\( -name \"*.yml\" -or -name \"*.json\" \\) | cpio -pdm .build && find specs -type f \\( -name \"*.yml\" -or -name \"*.json\" -or -name \"*.base64\" \\)  | cpio -pdm .build",
+    "build": "ZIP_NAME=build ts-node package.ts",
+    "build:copy": "echo 'not yet implemented'",
     "security-scan": "npm run security-checks",
     "security-checks": "git secrets --scan && git log -p | scanrepo",
-    "start": "npm run compile && sls offline start --noPrependStageInUrl",
+    "start": "npm run build && sls offline start --noPrependStageInUrl",
     "test": "nyc npm run test:compile",
     "test:compile": "npm run compile && jasmine",
     "test-i": "echo 'not yet implemented'",
     "test:integration": "npm run compile && jasmine build/spec/logs-service.spec.js",
     "compile-no-emit": "tsc --noEmit -p .",
     "lint:fix": "tslint --fix -p ./",
     "sonar-scanner": "sonar-scanner",
-    "audit": "npm audit --prod",
+    "audit": "npm audit --omit=dev",
     "package": "ts-node package.ts && cd ${ZIP_NAME:-'logs'}; zip -r ../${ZIP_NAME:-'logs'}.zip *",
-    "tools-setup": "echo 'Nothing to do'"
+    "tools-setup": "echo 'Nothing to do'",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@aws-sdk/client-cloudwatch-logs": "^3.645.0",
+    "@dvsa/cvs-microservice-common": "^1.2.4"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "19.4.1",
+    "@commitlint/config-conventional": "19.4.1",
+    "@types/aws-lambda": "^8.10.145",
+    "@types/jasmine": "^5.1.4",
+    "@types/node": "^20.16.5",
+    "@types/supertest": "^2.0.12",
+    "aws-lambda-test-utils": "^1.3.0",
+    "aws-sdk-client-mock": "^4.0.1",
+    "esbuild": "0.23.1",
+    "husky": "^9.1.5",
+    "jasmine": "^5.3.0",
+    "jasmine-spec-reporter": "^7.0.0",
+    "json-schema-to-typescript": "^15.0.2",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^17.0.0",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "serverless": "^3.39.0",
+    "serverless-offline": "^13.8.0",
+    "sonar-scanner": "3.1.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tslint": "^6.1.3",
+    "typemoq": "^2.1.0",
+    "typescript": "5.5.4",
+    "yamljs": "^0.3.0"
   },
   "nyc": {
     "require": [

serverless.yml

@@ -2,7 +2,7 @@ service: cvs-svc-app-logs
 
 provider:
   name: aws
-  runtime: nodejs18.x
+  runtime: nodejs20.x
   lambdaHashingVersion: "20201221"
   region: ${env:AWS_PROVIDER_REGION, 'local'}
 
@@ -11,16 +11,11 @@ package:
 
 functions:
   postLogs:
-    handler: src/functions/postLogs/framework/handler.handler
+    handler: build/handler.handler
     events:
       - http:
           path: "logs"
           method: post
 
-custom:
-  webpack:
-    webpackConfig: "webpack-sls-offline.config.js"
-
 plugins:
-  - serverless-webpack
   - serverless-offline

spec/helpers/integration-test-lifecycle.ts

@@ -8,7 +8,7 @@ export const startSlsOffline = (done: any) => {
   slsOfflineProcess.stdout?.pipe(process.stdout);
 
   console.log(
-    `Serverless: Offline started with PID : ${slsOfflineProcess.pid}`
+    `Serverless: Offline started with PID : ${slsOfflineProcess.pid}`,
   );
 
   slsOfflineProcess.stdout?.on("data", (data) => {

spec/helpers/reporter.ts

@@ -11,5 +11,5 @@ jasmine.getEnv().clearReporters();
 jasmine.getEnv().addReporter(
   new SpecReporter({
     customProcessors: [CustomProcessor],
-  })
+  }),
 );

src/common/application/utils/createResponse.ts

@@ -1,9 +1,10 @@
 import Response from "../api/Response";
+import { HttpStatus } from "@dvsa/cvs-microservice-common/api/http-status-codes";
 
 export default (
   body: {},
-  statusCode = 200,
-  reqHeaders: { [id: string]: string } = {}
+  statusCode = HttpStatus.OK,
+  reqHeaders: { [id: string]: string } = {},
 ): Response => {
   const accessControlAllowOriginHeader = {
     "Access-Control-Allow-Origin": "*", // Required for CORS support to work

src/functions/postLogs/application/Logger.ts

@@ -25,7 +25,7 @@ export default class Logger {
       await this.logDelegate(logEvents);
     } catch (e) {
       console.error(
-        "Error occurred while attempting to log events to logging system:"
+        "Error occurred while attempting to log events to logging system:",
       );
       console.error(e);
     }
@@ -42,7 +42,7 @@ export default class Logger {
   async log(message: string, logLevel: LogLevel, logData?: Bag): Promise<void> {
     const eventMessage = Object.assign(
       { message, logLevel, loggerName: this.loggerName },
-      logData
+      logData,
     );
 
     await this.logEvents([
@@ -60,7 +60,7 @@ export default class Logger {
         description,
         value,
         service: "logs-service",
-      })
+      }),
     );
   }
 }

src/functions/postLogs/application/__tests__/Logger.spec.ts

@@ -20,7 +20,7 @@ describe("Logger", () => {
       // ASSERT
       moqLogDelegate.verify(
         (x) => x(It.is<LogEvent[]>((evnts) => evnts.length === 3)),
-        Times.once()
+        Times.once(),
       );
     });
 
@@ -39,17 +39,17 @@ describe("Logger", () => {
       moqConsoleError.verify(
         (x) =>
           x("Error occurred while attempting to log events to logging system:"),
-        Times.once()
+        Times.once(),
       );
 
       moqConsoleError.verify(
         (x) =>
           x(
             It.is<Error>(
-              (e) => e.message === "example external logging system error"
-            )
+              (e) => e.message === "example external logging system error",
+            ),
           ),
-        Times.once()
+        Times.once(),
       );
     });
   });
@@ -70,10 +70,10 @@ describe("Logger", () => {
                 evnts[0].timestamp <= new Date().getTime() &&
                 /test log message/.test(evnts[0].message) &&
                 /info/.test(evnts[0].message) &&
-                /1234/.test(evnts[0].message)
-            )
+                /1234/.test(evnts[0].message),
+            ),
           ),
-        Times.once()
+        Times.once(),
       );
     });
 
@@ -90,10 +90,10 @@ describe("Logger", () => {
                 evnts.length === 1 &&
                 /test log message/.test(evnts[0].message) &&
                 !/info/.test(evnts[0].message) &&
-                /other/.test(evnts[0].message)
-            )
+                /other/.test(evnts[0].message),
+            ),
           ),
-        Times.once()
+        Times.once(),
       );
     });
   });