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/controllers/api/runners/manage-runners.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/controllers/api/runners/manage-runners.ts')
-rw-r--r-- | server/controllers/api/runners/manage-runners.ts | 112 |
1 files changed, 0 insertions, 112 deletions
diff --git a/server/controllers/api/runners/manage-runners.ts b/server/controllers/api/runners/manage-runners.ts deleted file mode 100644 index be7ebc0b3..000000000 --- a/server/controllers/api/runners/manage-runners.ts +++ /dev/null | |||
@@ -1,112 +0,0 @@ | |||
1 | import express from 'express' | ||
2 | import { logger, loggerTagsFactory } from '@server/helpers/logger' | ||
3 | import { generateRunnerToken } from '@server/helpers/token-generator' | ||
4 | import { | ||
5 | apiRateLimiter, | ||
6 | asyncMiddleware, | ||
7 | authenticate, | ||
8 | ensureUserHasRight, | ||
9 | paginationValidator, | ||
10 | runnersSortValidator, | ||
11 | setDefaultPagination, | ||
12 | setDefaultSort | ||
13 | } from '@server/middlewares' | ||
14 | import { deleteRunnerValidator, getRunnerFromTokenValidator, registerRunnerValidator } from '@server/middlewares/validators/runners' | ||
15 | import { RunnerModel } from '@server/models/runner/runner' | ||
16 | import { HttpStatusCode, ListRunnersQuery, RegisterRunnerBody, UserRight } from '@shared/models' | ||
17 | |||
18 | const lTags = loggerTagsFactory('api', 'runner') | ||
19 | |||
20 | const manageRunnersRouter = express.Router() | ||
21 | |||
22 | manageRunnersRouter.post('/register', | ||
23 | apiRateLimiter, | ||
24 | asyncMiddleware(registerRunnerValidator), | ||
25 | asyncMiddleware(registerRunner) | ||
26 | ) | ||
27 | manageRunnersRouter.post('/unregister', | ||
28 | apiRateLimiter, | ||
29 | asyncMiddleware(getRunnerFromTokenValidator), | ||
30 | asyncMiddleware(unregisterRunner) | ||
31 | ) | ||
32 | |||
33 | manageRunnersRouter.delete('/:runnerId', | ||
34 | apiRateLimiter, | ||
35 | authenticate, | ||
36 | ensureUserHasRight(UserRight.MANAGE_RUNNERS), | ||
37 | asyncMiddleware(deleteRunnerValidator), | ||
38 | asyncMiddleware(deleteRunner) | ||
39 | ) | ||
40 | |||
41 | manageRunnersRouter.get('/', | ||
42 | apiRateLimiter, | ||
43 | authenticate, | ||
44 | ensureUserHasRight(UserRight.MANAGE_RUNNERS), | ||
45 | paginationValidator, | ||
46 | runnersSortValidator, | ||
47 | setDefaultSort, | ||
48 | setDefaultPagination, | ||
49 | asyncMiddleware(listRunners) | ||
50 | ) | ||
51 | |||
52 | // --------------------------------------------------------------------------- | ||
53 | |||
54 | export { | ||
55 | manageRunnersRouter | ||
56 | } | ||
57 | |||
58 | // --------------------------------------------------------------------------- | ||
59 | |||
60 | async function registerRunner (req: express.Request, res: express.Response) { | ||
61 | const body: RegisterRunnerBody = req.body | ||
62 | |||
63 | const runnerToken = generateRunnerToken() | ||
64 | |||
65 | const runner = new RunnerModel({ | ||
66 | runnerToken, | ||
67 | name: body.name, | ||
68 | description: body.description, | ||
69 | lastContact: new Date(), | ||
70 | ip: req.ip, | ||
71 | runnerRegistrationTokenId: res.locals.runnerRegistrationToken.id | ||
72 | }) | ||
73 | |||
74 | await runner.save() | ||
75 | |||
76 | logger.info('Registered new runner %s', runner.name, { ...lTags(runner.name) }) | ||
77 | |||
78 | return res.json({ id: runner.id, runnerToken }) | ||
79 | } | ||
80 | async function unregisterRunner (req: express.Request, res: express.Response) { | ||
81 | const runner = res.locals.runner | ||
82 | await runner.destroy() | ||
83 | |||
84 | logger.info('Unregistered runner %s', runner.name, { ...lTags(runner.name) }) | ||
85 | |||
86 | return res.sendStatus(HttpStatusCode.NO_CONTENT_204) | ||
87 | } | ||
88 | |||
89 | async function deleteRunner (req: express.Request, res: express.Response) { | ||
90 | const runner = res.locals.runner | ||
91 | |||
92 | await runner.destroy() | ||
93 | |||
94 | logger.info('Deleted runner %s', runner.name, { ...lTags(runner.name) }) | ||
95 | |||
96 | return res.sendStatus(HttpStatusCode.NO_CONTENT_204) | ||
97 | } | ||
98 | |||
99 | async function listRunners (req: express.Request, res: express.Response) { | ||
100 | const query: ListRunnersQuery = req.query | ||
101 | |||
102 | const resultList = await RunnerModel.listForApi({ | ||
103 | start: query.start, | ||
104 | count: query.count, | ||
105 | sort: query.sort | ||
106 | }) | ||
107 | |||
108 | return res.json({ | ||
109 | total: resultList.total, | ||
110 | data: resultList.data.map(d => d.toFormattedJSON()) | ||
111 | }) | ||
112 | } | ||