merged upstream PR thedevs-network#728

Author: jaysnm

.nvmrc

@@ -0,0 +1 @@
+12

package-lock.json

@@ -68,6 +68,7 @@
     "passport-localapikey-update": "^0.6.0",
     "pg": "^8.8.0",
     "pg-query-stream": "^4.2.4",
+    "prom-client": "14.2.0",
     "qrcode.react": "^3.1.0",
     "query-string": "^7.1.1",
     "re2": "^1.17.8",

package.json

@@ -3,8 +3,8 @@ import { Handler } from "express";
 import passport from "passport";
 import bcrypt from "bcryptjs";
 import nanoid from "nanoid";
-import { v4 as uuid } from "uuid";
 import axios from "axios";
+import { randomUUID } from "crypto";
 
 import { CustomError } from "../utils";
 import * as utils from "../utils";
@@ -193,7 +193,7 @@ export const resetPasswordRequest: Handler = async (req, res) => {
   const [user] = await query.user.update(
     { email: req.body.email },
     {
-      reset_password_token: uuid(),
+      reset_password_token: randomUUID(),
       reset_password_expires: addMinutes(new Date(), 30).toISOString()
     }
   );
@@ -251,7 +251,7 @@ export const changeEmailRequest: Handler = async (req, res) => {
     { id: req.user.id },
     {
       change_email_address: email,
-      change_email_token: uuid(),
+      change_email_token: randomUUID(),
       change_email_expires: addMinutes(new Date(), 30).toISOString()
     }
   );

server/handlers/auth.ts

@@ -0,0 +1,20 @@
+import { Handler, NextFunction, Request, Response } from "express";
+import { Counter } from "prom-client";
+import { register } from "../routes/metrics";
+
+const linkCounter = new Counter({
+  name: 'link_counter',
+  help: 'Number of links created',
+  registers: [register]
+})
+
+export const linkCounterMiddleware: Handler = (
+  _req: Request, res: Response, next: NextFunction,
+) => {
+  res.on("close", () => {
+    if ([200, 201].includes(res.statusCode)) {
+      linkCounter.inc(1);
+    }
+  })
+  next();
+}

server/metrics/link-counter.middleware.ts

@@ -0,0 +1,28 @@
+import { Handler, Request, Response } from "express";
+import { Histogram, } from "prom-client";
+import { register } from "../routes/metrics";
+
+const responseDurationHistogram: Histogram = new Histogram({
+  name: 'response_duration',
+  help: 'response_duration',
+  labelNames: ["method", "path", "status"],
+  registers: [register]
+});
+
+export const responseDurationMiddleware: Handler = (
+  req: Request, res: Response, next
+) => {
+  const { method, originalUrl } = req;
+
+  const endTimer = responseDurationHistogram.startTimer({
+    method,
+    path: originalUrl
+  })
+  
+  res.on("close", () => {
+    const { statusCode } = res;
+    endTimer({ status: statusCode });
+  });
+
+  next();
+};

server/metrics/response-duration.middleware.ts

@@ -1,8 +1,8 @@
-import { v4 as uuid } from "uuid";
 import { addMinutes } from "date-fns";
 
 import redisCLient, * as redis from "../redis";
 import knex from "../knex";
+import { randomUUID } from "crypto";
 
 export const find = async (match: Partial<User>) => {
   if (match.email || match.apikey) {
@@ -35,7 +35,7 @@ export const add = async (params: Add, user?: User) => {
   const data = {
     email: params.email,
     password: params.password,
-    verification_token: uuid(),
+    verification_token: randomUUID(),
     verification_expires: addMinutes(new Date(), 60).toISOString(),
     verified: process.env.MAIL_HOST ? false : true
   };

server/queries/user.ts

@@ -10,6 +10,7 @@ const client = new Redis({
 });
 
 export default client;
+export const redisHealthStatus = [ "connect", "ready" ];
 
 export const key = {
   link: (address: string, domain_id?: number, user_id?: number) =>

server/redis.ts

@@ -1,7 +1,16 @@
 import { Router } from "express";
+import client, { redisHealthStatus } from "../redis";
 
 const router = Router();
-
-router.get("/", (_, res) => res.send("OK"));
+router.get("/", (_, res) => {
+    const redisStatus = client.status;
+    const status = redisHealthStatus.includes(redisStatus) ? 200 : 500;
+    res
+    .status(status)
+    .json({
+        api: "OK",
+        redis: client.status,
+    });
+});
 
 export default router;

server/routes/health.ts

@@ -7,6 +7,7 @@ import * as helpers from "../handlers/helpers";
 import * as link from "../handlers/links";
 import * as auth from "../handlers/auth";
 import env from "../env";
+import { linkCounterMiddleware } from "../metrics/link-counter.middleware";
 
 const router = Router();
 
@@ -27,6 +28,7 @@ router.post(
   asyncHandler(auth.cooldown),
   validators.createLink,
   asyncHandler(helpers.verify),
+  asyncHandler(linkCounterMiddleware),
   asyncHandler(link.create)
 );
 

server/routes/links.ts

@@ -0,0 +1,21 @@
+import asyncHandler from "express-async-handler";
+import client from 'prom-client'
+import { Router } from "express";
+
+const router = Router();
+
+export const register = new client.Registry();
+
+client.collectDefaultMetrics({
+  register,
+});
+
+router.get(
+  "/",
+  asyncHandler(async (_, res) => {
+    res.set("Content-Type", register.contentType);
+    return res.send(await register.metrics());
+  })
+);
+
+export default router;

server/routes/metrics.ts

@@ -1,17 +1,19 @@
 import { Router } from "express";
 
+import auth from "./auth";
 import domains from "./domains";
 import health from "./health";
 import links from "./links";
+import metrics from "./metrics";
 import user from "./users";
-import auth from "./auth";
 
 const router = Router();
 
+router.use("/auth", auth);
 router.use("/domains", domains);
 router.use("/health", health);
 router.use("/links", links);
+router.use("/metrics", metrics);
 router.use("/users", user);
-router.use("/auth", auth);
 
 export default router;

server/routes/routes.ts

@@ -16,6 +16,7 @@ import { stream } from "./config/winston";
 
 import "./cron";
 import "./passport";
+import { responseDurationMiddleware } from "./metrics/response-duration.middleware";
 
 const port = env.PORT;
 const app = nextApp({ dir: "./client", dev: env.isDev });
@@ -37,6 +38,7 @@ app.prepare().then(async () => {
   server.use(passport.initialize());
   server.use(express.static("static"));
   server.use(helpers.ip);
+  server.use(responseDurationMiddleware)
 
   server.use(asyncHandler(links.redirectCustomDomain));