server/middlewares/validators/shared/utils.ts

   1 import express from 'express'
   2 import { param, validationResult } from 'express-validator'
   3 import { isIdOrUUIDValid, toCompleteUUID } from '@server/helpers/custom-validators/misc'
   4 import { logger } from '../../../helpers/logger'
   5
   6 function areValidationErrors (
   7   req: express.Request,
   8   res: express.Response,
   9   options: {
  10     omitLog?: boolean
  11     omitBodyLog?: boolean
  12     tags?: string[]
  13   } = {}) {
  14   const { omitLog = false, omitBodyLog = false, tags = [] } = options
  15
  16   if (!omitLog) {
  17     logger.debug(
  18       'Checking %s - %s parameters',
  19       req.method, req.originalUrl,
  20       {
  21         body: omitBodyLog
  22           ? 'omitted'
  23           : req.body,
  24         params: req.params,
  25         query: req.query,
  26         files: req.files,
  27         tags
  28       }
  29     )
  30   }
  31
  32   const errors = validationResult(req)
  33
  34   if (!errors.isEmpty()) {
  35     logger.warn('Incorrect request parameters', { path: req.originalUrl, err: errors.mapped() })
  36
  37     res.fail({
  38       message: 'Incorrect request parameters: ' + Object.keys(errors.mapped()).join(', '),
  39       instance: req.originalUrl,
  40       data: {
  41         'invalid-params': errors.mapped()
  42       }
  43     })
  44
  45     return true
  46   }
  47
  48   return false
  49 }
  50
  51 function isValidVideoIdParam (paramName: string) {
  52   return param(paramName)
  53     .customSanitizer(toCompleteUUID)
  54     .custom(isIdOrUUIDValid).withMessage('Should have a valid video id (id, short UUID or UUID)')
  55 }
  56
  57 function isValidPlaylistIdParam (paramName: string) {
  58   return param(paramName)
  59     .customSanitizer(toCompleteUUID)
  60     .custom(isIdOrUUIDValid).withMessage('Should have a valid playlist id (id, short UUID or UUID)')
  61 }
  62
  63 // ---------------------------------------------------------------------------
  64
  65 export {
  66   areValidationErrors,
  67   isValidVideoIdParam,
  68   isValidPlaylistIdParam
  69 }