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 /packages/tests/src/shared/peertube-runner-process.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 'packages/tests/src/shared/peertube-runner-process.ts')
-rw-r--r-- | packages/tests/src/shared/peertube-runner-process.ts | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/packages/tests/src/shared/peertube-runner-process.ts b/packages/tests/src/shared/peertube-runner-process.ts new file mode 100644 index 000000000..3d1f299f2 --- /dev/null +++ b/packages/tests/src/shared/peertube-runner-process.ts | |||
@@ -0,0 +1,104 @@ | |||
1 | import { ChildProcess, fork, ForkOptions } from 'child_process' | ||
2 | import execa from 'execa' | ||
3 | import { join } from 'path' | ||
4 | import { root } from '@peertube/peertube-node-utils' | ||
5 | import { PeerTubeServer } from '@peertube/peertube-server-commands' | ||
6 | |||
7 | export class PeerTubeRunnerProcess { | ||
8 | private app?: ChildProcess | ||
9 | |||
10 | constructor (private readonly server: PeerTubeServer) { | ||
11 | |||
12 | } | ||
13 | |||
14 | runServer (options: { | ||
15 | hideLogs?: boolean // default true | ||
16 | } = {}) { | ||
17 | const { hideLogs = true } = options | ||
18 | |||
19 | return new Promise<void>((res, rej) => { | ||
20 | const args = [ 'server', '--verbose', ...this.buildIdArg() ] | ||
21 | |||
22 | const forkOptions: ForkOptions = { | ||
23 | detached: false, | ||
24 | silent: true, | ||
25 | execArgv: [] // Don't inject parent node options | ||
26 | } | ||
27 | |||
28 | this.app = fork(this.getRunnerPath(), args, forkOptions) | ||
29 | |||
30 | this.app.stdout.on('data', data => { | ||
31 | const str = data.toString() as string | ||
32 | |||
33 | if (!hideLogs) { | ||
34 | console.log(str) | ||
35 | } | ||
36 | }) | ||
37 | |||
38 | res() | ||
39 | }) | ||
40 | } | ||
41 | |||
42 | registerPeerTubeInstance (options: { | ||
43 | registrationToken: string | ||
44 | runnerName: string | ||
45 | runnerDescription?: string | ||
46 | }) { | ||
47 | const { registrationToken, runnerName, runnerDescription } = options | ||
48 | |||
49 | const args = [ | ||
50 | 'register', | ||
51 | '--url', this.server.url, | ||
52 | '--registration-token', registrationToken, | ||
53 | '--runner-name', runnerName, | ||
54 | ...this.buildIdArg() | ||
55 | ] | ||
56 | |||
57 | if (runnerDescription) { | ||
58 | args.push('--runner-description') | ||
59 | args.push(runnerDescription) | ||
60 | } | ||
61 | |||
62 | return this.runCommand(this.getRunnerPath(), args) | ||
63 | } | ||
64 | |||
65 | unregisterPeerTubeInstance (options: { | ||
66 | runnerName: string | ||
67 | }) { | ||
68 | const { runnerName } = options | ||
69 | |||
70 | const args = [ 'unregister', '--url', this.server.url, '--runner-name', runnerName, ...this.buildIdArg() ] | ||
71 | return this.runCommand(this.getRunnerPath(), args) | ||
72 | } | ||
73 | |||
74 | async listRegisteredPeerTubeInstances () { | ||
75 | const args = [ 'list-registered', ...this.buildIdArg() ] | ||
76 | const { stdout } = await this.runCommand(this.getRunnerPath(), args) | ||
77 | |||
78 | return stdout | ||
79 | } | ||
80 | |||
81 | kill () { | ||
82 | if (!this.app) return | ||
83 | |||
84 | process.kill(this.app.pid) | ||
85 | |||
86 | this.app = null | ||
87 | } | ||
88 | |||
89 | getId () { | ||
90 | return 'test-' + this.server.internalServerNumber | ||
91 | } | ||
92 | |||
93 | private getRunnerPath () { | ||
94 | return join(root(), 'apps', 'peertube-runner', 'dist', 'peertube-runner.js') | ||
95 | } | ||
96 | |||
97 | private buildIdArg () { | ||
98 | return [ '--id', this.getId() ] | ||
99 | } | ||
100 | |||
101 | private runCommand (path: string, args: string[]) { | ||
102 | return execa.node(path, args, { env: { ...process.env, NODE_OPTIONS: '' } }) | ||
103 | } | ||
104 | } | ||