server/middlewares/error.ts

   1 import express from 'express'
   2 import { ProblemDocument, ProblemDocumentExtension } from 'http-problem-details'
   3 import { logger } from '@server/helpers/logger'
   4 import { HttpStatusCode } from '@shared/models'
   5
   6 function apiFailMiddleware (req: express.Request, res: express.Response, next: express.NextFunction) {
   7   res.fail = options => {
   8     const { status = HttpStatusCode.BAD_REQUEST_400, message, title, type, data, instance, tags } = options
   9
  10     const extension = new ProblemDocumentExtension({
  11       ...data,
  12
  13       docs: res.locals.docUrl,
  14       code: type,
  15
  16       // For <= 3.2 compatibility
  17       error: message
  18     })
  19
  20     res.status(status)
  21
  22     if (!res.headersSent) {
  23       res.setHeader('Content-Type', 'application/problem+json')
  24     }
  25
  26     const json = new ProblemDocument({
  27       status,
  28       title,
  29       instance,
  30
  31       detail: message,
  32
  33       type: type
  34         ? `https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/${type}`
  35         : undefined
  36     }, extension)
  37
  38     logger.debug('Bad HTTP request.', { json, tags })
  39
  40     res.json(json)
  41   }
  42
  43   if (next) next()
  44 }
  45
  46 function handleStaticError (err: any, req: express.Request, res: express.Response, next: express.NextFunction) {
  47   const message = err.message || ''
  48
  49   if (message.includes('ENOENT')) {
  50     return res.fail({
  51       status: err.status || HttpStatusCode.INTERNAL_SERVER_ERROR_500,
  52       message: err.message,
  53       type: err.name
  54     })
  55   }
  56
  57   return next(err)
  58 }
  59
  60 export {
  61   apiFailMiddleware,
  62   handleStaticError
  63 }