aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/middlewares/validators/shared/utils.ts
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-07-31 14:34:36 +0200
committerChocobozzz <me@florianbigard.com>2023-08-11 15:02:33 +0200
commit3a4992633ee62d5edfbb484d9c6bcb3cf158489d (patch)
treee4510b39bdac9c318fdb4b47018d08f15368b8f0 /server/middlewares/validators/shared/utils.ts
parent04d1da5621d25d59bd5fa1543b725c497bf5d9a8 (diff)
downloadPeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.gz
PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.zst
PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.zip
Migrate server to ESM
Sorry for the very big commit that may lead to git log issues and merge conflicts, but it's a major step forward: * Server can be faster at startup because imports() are async and we can easily lazy import big modules * Angular doesn't seem to support ES import (with .js extension), so we had to correctly organize peertube into a monorepo: * Use yarn workspace feature * Use typescript reference projects for dependencies * Shared projects have been moved into "packages", each one is now a node module (with a dedicated package.json/tsconfig.json) * server/tools have been moved into apps/ and is now a dedicated app bundled and published on NPM so users don't have to build peertube cli tools manually * server/tests have been moved into packages/ so we don't compile them every time we want to run the server * Use isolatedModule option: * Had to move from const enum to const (https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums) * Had to explictely specify "type" imports when used in decorators * Prefer tsx (that uses esbuild under the hood) instead of ts-node to load typescript files (tests with mocha or scripts): * To reduce test complexity as esbuild doesn't support decorator metadata, we only test server files that do not import server models * We still build tests files into js files for a faster CI * Remove unmaintained peertube CLI import script * Removed some barrels to speed up execution (less imports)
Diffstat (limited to 'server/middlewares/validators/shared/utils.ts')
-rw-r--r--server/middlewares/validators/shared/utils.ts69
1 files changed, 0 insertions, 69 deletions
diff --git a/server/middlewares/validators/shared/utils.ts b/server/middlewares/validators/shared/utils.ts
deleted file mode 100644
index f39128fdd..000000000
--- a/server/middlewares/validators/shared/utils.ts
+++ /dev/null
@@ -1,69 +0,0 @@
1import express from 'express'
2import { param, validationResult } from 'express-validator'
3import { isIdOrUUIDValid, toCompleteUUID } from '@server/helpers/custom-validators/misc'
4import { logger } from '../../../helpers/logger'
5
6function 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
51function 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
57function 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
65export {
66 areValidationErrors,
67 isValidVideoIdParam,
68 isValidPlaylistIdParam
69}