deps: Add @sentry/node version 6.18.2

.env.example

@@ -5,3 +5,5 @@ SERVER_PORT=3000
 CORS_ORIGINS=http://localhost:3000
 
 DATABASE_URI=
+
+SENTRY_DSN=

README.md

@@ -12,6 +12,7 @@ XCoins code review repository.
     - [Common](#common-config)
     - [Server](#server-config)
     - [Database](#database-config)
+    - [Sentry](#sentry-config)
   - [Start](#start)
   - [Docker](#docker)
 - [Directory Layout](#directory-layout)
@@ -88,6 +89,12 @@ cp .env.example .env
 |----------------|:------:|:-------:|:-----------------------------:|
 | `DATABASE_URI` | string |    -    | MongoDB connection string uri |
 
+#### Sentry Config
+
+| Name         |  Type  | Default |       Description        |
+|--------------|:------:|:-------:|:------------------------:|
+| `SENTRY_DSN` | string |    -    | Sentry project DSN value |
+
 ### Start
 
 Start the API.
@@ -239,6 +246,7 @@ This section includes the issues, changes & improvements I've made, with the tho
     > `express` doesn't catch async errors properly, so I added this utility to wrap the controllers before passing them
     > to the `Router` instance.
   - Added pagination to the endpoints that were listing records.
+  - Added `Sentry` to track issues in the production environment.
 
 <!-- Footnotes -->
 

package.json

@@ -28,6 +28,8 @@
     "lint:fix": "npm run lint -- --fix"
   },
   "dependencies": {
+    "@sentry/node": "6.18.2",
+    "@sentry/tracing": "6.18.2",
     "body-parser": "1.19.2",
     "celebrate": "15.0.1",
     "cors": "2.8.5",

src/config.ts

@@ -15,6 +15,8 @@ export const NODE_ENV = process.env.NODE_ENV = check("NODE_ENV", ENV.DEVELOPMENT
 
 export const SERVER_PORT = parseInt(check("SERVER_PORT", "3000"), 10);
 
+export const CORS_ORIGINS = check("CORS_ORIGINS", "http://localhost:3000").split(",");
+
 export const DATABASE_URI = check("DATABASE_URI");
 
-export const CORS_ORIGINS = check("CORS_ORIGINS", "http://localhost:3000").split(",");
+export const SENTRY_DSN = process.env.SENTRY_DSN;

src/database.ts

@@ -1,4 +1,5 @@
 import { DATABASE_URI } from "#src/config.js";
+import { Sentry } from "#src/lib/index.js";
 import mongoose from "mongoose";
 
 mongoose
@@ -7,6 +8,8 @@ mongoose
   .catch((error) => {
     console.log("❌ Failed to establish database connection!");
 
+    Sentry.captureException(error);
+
     console.error(error);
 
     process.exit(1);

src/lib/Sentry.ts

@@ -0,0 +1,18 @@
+import { SENTRY_DSN } from "#src/config.js";
+import * as Sentry from "@sentry/node";
+import * as Tracing from "@sentry/tracing";
+
+Sentry.init({
+  dsn: SENTRY_DSN,
+  integrations: [
+    // enable HTTP calls tracing
+    new Sentry.Integrations.Http({ tracing: true }),
+    // enable Express.js middleware tracing
+    new Tracing.Integrations.Express(),
+  ],
+  // We recommend adjusting this value in production, or using tracesSampler
+  // for finer control
+  tracesSampleRate: 1.0,
+});
+
+export { Sentry };

src/lib/index.ts

@@ -1 +1,2 @@
 export * from "./Joi.js";
+export * from "./Sentry.js";