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/lib/plugins/yarn.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/lib/plugins/yarn.ts')
-rw-r--r-- | server/lib/plugins/yarn.ts | 73 |
1 files changed, 0 insertions, 73 deletions
diff --git a/server/lib/plugins/yarn.ts b/server/lib/plugins/yarn.ts deleted file mode 100644 index 9cf6ec9e9..000000000 --- a/server/lib/plugins/yarn.ts +++ /dev/null | |||
@@ -1,73 +0,0 @@ | |||
1 | import { outputJSON, pathExists } from 'fs-extra' | ||
2 | import { join } from 'path' | ||
3 | import { execShell } from '../../helpers/core-utils' | ||
4 | import { isNpmPluginNameValid, isPluginStableOrUnstableVersionValid } from '../../helpers/custom-validators/plugins' | ||
5 | import { logger } from '../../helpers/logger' | ||
6 | import { CONFIG } from '../../initializers/config' | ||
7 | import { getLatestPluginVersion } from './plugin-index' | ||
8 | |||
9 | async function installNpmPlugin (npmName: string, versionArg?: string) { | ||
10 | // Security check | ||
11 | checkNpmPluginNameOrThrow(npmName) | ||
12 | if (versionArg) checkPluginVersionOrThrow(versionArg) | ||
13 | |||
14 | const version = versionArg || await getLatestPluginVersion(npmName) | ||
15 | |||
16 | let toInstall = npmName | ||
17 | if (version) toInstall += `@${version}` | ||
18 | |||
19 | const { stdout } = await execYarn('add ' + toInstall) | ||
20 | |||
21 | logger.debug('Added a yarn package.', { yarnStdout: stdout }) | ||
22 | } | ||
23 | |||
24 | async function installNpmPluginFromDisk (path: string) { | ||
25 | await execYarn('add file:' + path) | ||
26 | } | ||
27 | |||
28 | async function removeNpmPlugin (name: string) { | ||
29 | checkNpmPluginNameOrThrow(name) | ||
30 | |||
31 | await execYarn('remove ' + name) | ||
32 | } | ||
33 | |||
34 | async function rebuildNativePlugins () { | ||
35 | await execYarn('install --pure-lockfile') | ||
36 | } | ||
37 | |||
38 | // ############################################################################ | ||
39 | |||
40 | export { | ||
41 | installNpmPlugin, | ||
42 | installNpmPluginFromDisk, | ||
43 | rebuildNativePlugins, | ||
44 | removeNpmPlugin | ||
45 | } | ||
46 | |||
47 | // ############################################################################ | ||
48 | |||
49 | async function execYarn (command: string) { | ||
50 | try { | ||
51 | const pluginDirectory = CONFIG.STORAGE.PLUGINS_DIR | ||
52 | const pluginPackageJSON = join(pluginDirectory, 'package.json') | ||
53 | |||
54 | // Create empty package.json file if needed | ||
55 | if (!await pathExists(pluginPackageJSON)) { | ||
56 | await outputJSON(pluginPackageJSON, {}) | ||
57 | } | ||
58 | |||
59 | return execShell(`yarn ${command}`, { cwd: pluginDirectory }) | ||
60 | } catch (result) { | ||
61 | logger.error('Cannot exec yarn.', { command, err: result.err, stderr: result.stderr }) | ||
62 | |||
63 | throw result.err | ||
64 | } | ||
65 | } | ||
66 | |||
67 | function checkNpmPluginNameOrThrow (name: string) { | ||
68 | if (!isNpmPluginNameValid(name)) throw new Error('Invalid NPM plugin name to install') | ||
69 | } | ||
70 | |||
71 | function checkPluginVersionOrThrow (name: string) { | ||
72 | if (!isPluginStableOrUnstableVersionValid(name)) throw new Error('Invalid NPM plugin version to install') | ||
73 | } | ||