diff options
author | Chocobozzz <me@florianbigard.com> | 2023-07-31 14:34:36 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-08-11 15:02:33 +0200 |
commit | 3a4992633ee62d5edfbb484d9c6bcb3cf158489d (patch) | |
tree | e4510b39bdac9c318fdb4b47018d08f15368b8f0 /server/middlewares/error.ts | |
parent | 04d1da5621d25d59bd5fa1543b725c497bf5d9a8 (diff) | |
download | PeerTube-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/error.ts')
-rw-r--r-- | server/middlewares/error.ts | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/server/middlewares/error.ts b/server/middlewares/error.ts deleted file mode 100644 index 94762e355..000000000 --- a/server/middlewares/error.ts +++ /dev/null | |||
@@ -1,63 +0,0 @@ | |||
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 | } | ||