aboutsummaryrefslogtreecommitdiffhomepage
path: root/shared/core-utils/plugins/hooks.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 /shared/core-utils/plugins/hooks.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 'shared/core-utils/plugins/hooks.ts')
-rw-r--r--shared/core-utils/plugins/hooks.ts61
1 files changed, 0 insertions, 61 deletions
diff --git a/shared/core-utils/plugins/hooks.ts b/shared/core-utils/plugins/hooks.ts
deleted file mode 100644
index 96bcc945e..000000000
--- a/shared/core-utils/plugins/hooks.ts
+++ /dev/null
@@ -1,61 +0,0 @@
1import { RegisteredExternalAuthConfig } from '@shared/models'
2import { HookType } from '../../models/plugins/hook-type.enum'
3import { isCatchable, isPromise } from '../common/promises'
4
5function getHookType (hookName: string) {
6 if (hookName.startsWith('filter:')) return HookType.FILTER
7 if (hookName.startsWith('action:')) return HookType.ACTION
8
9 return HookType.STATIC
10}
11
12async function internalRunHook <T> (options: {
13 handler: Function
14 hookType: HookType
15 result: T
16 params: any
17 onError: (err: Error) => void
18}) {
19 const { handler, hookType, result, params, onError } = options
20
21 try {
22 if (hookType === HookType.FILTER) {
23 const p = handler(result, params)
24
25 const newResult = isPromise(p)
26 ? await p
27 : p
28
29 return newResult
30 }
31
32 // Action/static hooks do not have result value
33 const p = handler(params)
34
35 if (hookType === HookType.STATIC) {
36 if (isPromise(p)) await p
37
38 return undefined
39 }
40
41 if (hookType === HookType.ACTION) {
42 if (isCatchable(p)) p.catch((err: any) => onError(err))
43
44 return undefined
45 }
46 } catch (err) {
47 onError(err)
48 }
49
50 return result
51}
52
53function getExternalAuthHref (apiUrl: string, auth: RegisteredExternalAuthConfig) {
54 return apiUrl + `/plugins/${auth.name}/${auth.version}/auth/${auth.authName}`
55}
56
57export {
58 getHookType,
59 internalRunHook,
60 getExternalAuthHref
61}