Upgrade Express to version 5

Author: juffalow

package.json

@@ -10,7 +10,7 @@
     "url": "https://juffalow.com"
   },
   "devDependencies": {
-    "@types/express": "^4.17.21",
+    "@types/express": "^5.0.0",
     "@types/jest": "^29.5.12",
     "@types/jsonwebtoken": "^9.0.6",
     "@types/multer": "^1.4.12",
@@ -39,7 +39,7 @@
     "aws-xray-sdk": "^3.10.2",
     "cls-hooked": "^4.2.2",
     "deepmerge": "^4.3.1",
-    "express": "^4.19.2",
+    "express": "^5.0.1",
     "fluent-ffmpeg": "^2.1.3",
     "image-size": "^1.1.1",
     "joi": "^17.13.3",

src/app.ts

@@ -21,9 +21,9 @@ app.use(express.urlencoded({ extended: true }));
 app.use(cors);
 app.use(logRequest);
 
-app.use(services.Trace.openSegment(config.serviceName) as any);
+app.use(services.Trace.openSegment(config.serviceName));
 app.use(`${config.routePrefix}`, routes);
-app.use(services.Trace.closeSegment() as any);
+app.use(services.Trace.closeSegment());
 
 app.use(errorHandler);
 

src/middlewares/logRequest.ts

@@ -2,12 +2,9 @@ import type { Request, Response, NextFunction } from 'express';
 import logger from '../logger';
 
 export default function logRequest(req: Request, res: Response, next: NextFunction): void {
-  if (req.method === 'OPTIONS') {
-    next();
-    return;
+  if (req.method !== 'OPTIONS') {
+    logger.debug(`${req.method} ${req.path}`, { body: req.body, query: req.query });
   }
 
-  logger.debug(`${req.method} ${req.path}`, { body: req.body, query: req.query });
-
   next();
 }

src/middlewares/optionalAuth.ts

@@ -1,12 +1,8 @@
 import type { Request, Response, NextFunction } from 'express';
 import services from '../services';
 
-export default async function auth(req: Request, res: Response, next: NextFunction): Promise<unknown> {
-  if (req.method === 'OPTIONS') {
-    return next();
-  }
-
-  if ('authorization' in req.headers) {
+export default async function auth(req: Request, res: Response, next: NextFunction): Promise<void> {
+  if (req.method !== 'OPTIONS' && 'authorization' in req.headers) {
     const token = req.headers.authorization.replace('Bearer ', '');
 
     try {
@@ -16,7 +12,7 @@ export default async function auth(req: Request, res: Response, next: NextFuncti
 
       req['user'] = services.Token.getUserData(data);
     } catch (err) {
-      return res.status(401).json({ error: 'Unauthorized!' });
+      res.status(401).json({ error: 'Unauthorized!' });
     }
   }
 

src/middlewares/requireAdmin.ts

@@ -1,22 +1,22 @@
 import type { Request, Response, NextFunction } from 'express';
 import tokenService from '../services/token';
 
-export default async function requireAdmin(req: Request, res: Response, next: NextFunction): Promise<unknown> {
+export default async function requireAdmin(req: Request, res: Response, next: NextFunction): Promise<void> {
   if ('authorization' in req.headers === false) {
-    return res.status(401).json({ error: 'Unauthorized!' });
-  }
-
-  const token = req.headers.authorization.replace('Bearer ', '');
+    res.status(401).json({ error: 'Unauthorized!' });
+  } else {
+    const token = req.headers.authorization.replace('Bearer ', '');
 
-  try {
-    const jwt = tokenService.JWT;
-    const data = jwt.verify(token);
+    try {
+      const jwt = tokenService.JWT;
+      const data = jwt.verify(token);
 
-    if ('role' in data === false || 'service' in data === false) {
-      throw new Error('Token does not contain mandatory fields!');
+      if ('role' in data === false || 'service' in data === false) {
+        throw new Error('Token does not contain mandatory fields!');
+      }
+    } catch (err) {
+      res.status(401).json({ error: 'Unauthorized!' });
     }
-  } catch (err) {
-    return res.status(401).json({ error: 'Unauthorized!' });
   }
 
   next();

src/middlewares/requireAuth.ts

@@ -1,21 +1,21 @@
 import type { Request, Response, NextFunction } from 'express';
 import services from '../services';
 
-export default async function requireAuth(req: Request, res: Response, next: NextFunction): Promise<unknown> {
+export default async function requireAuth(req: Request, res: Response, next: NextFunction): Promise<void> {
   if ('authorization' in req.headers === false) {
-    return res.status(401).json({ error: 'Unauthorized!' });
-  }
-
-  const token = req.headers.authorization.replace('Bearer ', '');
+    res.status(401).json({ error: 'Unauthorized!' });
+  } else {
+    const token = req.headers.authorization.replace('Bearer ', '');
 
-  try {
-    const payload = services.Token.verify(token);
-  
-    const data = payload instanceof Promise ? await payload : payload;
+    try {
+      const payload = services.Token.verify(token);
+    
+      const data = payload instanceof Promise ? await payload : payload;
 
-    req['user'] = services.Token.getUserData(data);
-  } catch (err) {
-    return res.status(401).json({ error: 'Unauthorized!' });
+      req['user'] = services.Token.getUserData(data);
+    } catch (err) {
+      res.status(401).json({ error: 'Unauthorized!' });
+    }
   }
 
   next();

src/routes/upload.ts

@@ -26,7 +26,7 @@ const router = express.Router();
  */
 const multerPromise = (req: express.Request, res: express.Response) => {
   return new Promise<void>((resolve, reject) => {
-    upload(req, res, (err) => {
+    upload(req as any, res as any, (err) => {
       if(!err) {
         resolve();
       }
@@ -64,7 +64,7 @@ router.post('/', optionalAuth, uploadMiddleware, validateRequest(postSchema), as
       }
     });
 
-     next();
+    next();
   } catch (err) {
     next(err);
   }

src/services/trace/AWSXRay.ts

@@ -1,26 +1,32 @@
 import XRay from 'aws-xray-sdk';
 import http from 'http';
 import https from 'https';
-import type { Request, Response, NextFunction } from 'express';
+import type {
+  Request,
+  Response,
+  NextFunction,
+  RequestHandler,
+  ErrorRequestHandler,
+} from 'express';
 
 class AWSXRay implements Services.Trace {
   constructor (plugins: string) {
     this.setPlugins(plugins);
   }
 
-  public openSegment(defaultName: string) {
+  public openSegment(defaultName: string): RequestHandler[] {
     const traceMiddleware = (req: Request, res: Response, next: NextFunction) => {
       const traceId = this.getTraceId();
 
-      res.setHeader('x-request-id', traceId);
+      res.setHeader('X-Request-Id', traceId);
 
       next();
     };
 
     return [ XRay.express.openSegment(defaultName), traceMiddleware ];
   }
 
-  public closeSegment() {
+  public closeSegment(): ErrorRequestHandler {
     return XRay.express.closeSegment();
   }
 

src/services/trace/CLSHooked.ts

@@ -1,28 +1,34 @@
 import cls from 'cls-hooked';
 import { v7 as uuidv7 } from 'uuid';
-import type { Request, Response, NextFunction } from 'express';
+import type {
+  Request,
+  Response,
+  NextFunction,
+  RequestHandler,
+  ErrorRequestHandler,
+} from 'express';
 
 const NAMESPACE = 'aws-upload-service';
 
 class CLSHooked implements Services.Trace {
-  public openSegment() {
+  public openSegment(): RequestHandler {
     const namespace = this.getNamespace();
 
     return (req: Request, res: Response, next: NextFunction) => {
       const traceId = req.headers['x-request-id'] as string || req.query.traceId as string || uuidv7();
 
       namespace.run(() => {
         namespace.set('traceId', traceId);
-        res.setHeader('x-request-id', traceId);
+        res.setHeader('X-Request-Id', traceId);
 
         next();
       });
     }
   }
 
-  public closeSegment() {
-    return (req: Request, res: Response, next: NextFunction) => {
-      next();
+  public closeSegment(): ErrorRequestHandler {
+    return (error: Error, req: Request, res: Response, next: NextFunction) => {
+      next(error);
     }
   }
 

src/types/services.d.ts

@@ -52,9 +52,9 @@ declare namespace Services {
   }
 
   interface Trace {
-    openSegment(defaultName: string): unknown;
+    openSegment(defaultName: string): import ('express').RequestHandler | import ('express').RequestHandler[];
 
-    closeSegment(): unknown;
+    closeSegment(): import ('express').ErrorRequestHandler;
 
     createSegment(name: string, rootId?: string | null, parentId?: string | null): unknown;