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 /support/doc/development/tests.md | |
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 'support/doc/development/tests.md')
-rw-r--r-- | support/doc/development/tests.md | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/support/doc/development/tests.md b/support/doc/development/tests.md index 1c2589c8a..2e4c6ff6a 100644 --- a/support/doc/development/tests.md +++ b/support/doc/development/tests.md | |||
@@ -8,7 +8,7 @@ Prepare PostgreSQL user so PeerTube can delete/create the test databases: | |||
8 | sudo -u postgres createuser you_username --createdb --superuser | 8 | sudo -u postgres createuser you_username --createdb --superuser |
9 | ``` | 9 | ``` |
10 | 10 | ||
11 | Prepare databases: | 11 | Prepare the databases: |
12 | 12 | ||
13 | ```bash | 13 | ```bash |
14 | npm run clean:server:test | 14 | npm run clean:server:test |
@@ -45,22 +45,19 @@ sudo apt-get install parallel libimage-exiftool-perl | |||
45 | 45 | ||
46 | ### Test | 46 | ### Test |
47 | 47 | ||
48 | To run all test suites: | 48 | To run all test suites (can be long!): |
49 | 49 | ||
50 | ```bash | 50 | ```bash |
51 | npm run test # See scripts/test.sh to run a particular suite | 51 | npm run test # See scripts/test.sh to run a particular suite |
52 | ``` | 52 | ``` |
53 | 53 | ||
54 | Most of tests can be run using: | 54 | To run a specific test: |
55 | 55 | ||
56 | ```bash | 56 | ```bash |
57 | TS_NODE_TRANSPILE_ONLY=true npm run mocha -- --timeout 30000 --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/videos/video-transcoder.ts | 57 | npm run mocha -- --exit --bail packages/tests/src/your-test.ts |
58 | ``` | ||
59 | |||
60 | `server/tests/api/activitypub` tests will need different options: | ||
61 | 58 | ||
62 | ``` | 59 | # For example |
63 | TS_NODE_FILES=true mocha -- --timeout 30000 --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/activitypub/security.ts | 60 | npm run mocha -- --exit --bail packages/tests/src/api/videos/single-server.ts |
64 | ``` | 61 | ``` |
65 | 62 | ||
66 | ### Configuration | 63 | ### Configuration |