aboutsummaryrefslogtreecommitdiffhomepage
path: root/shared/server-commands/server/jobs-command.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/server-commands/server/jobs-command.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/server-commands/server/jobs-command.ts')
-rw-r--r--shared/server-commands/server/jobs-command.ts84
1 files changed, 0 insertions, 84 deletions
diff --git a/shared/server-commands/server/jobs-command.ts b/shared/server-commands/server/jobs-command.ts
deleted file mode 100644
index b8790ea00..000000000
--- a/shared/server-commands/server/jobs-command.ts
+++ /dev/null
@@ -1,84 +0,0 @@
1import { pick } from '@shared/core-utils'
2import { HttpStatusCode, Job, JobState, JobType, ResultList } from '@shared/models'
3import { AbstractCommand, OverrideCommandOptions } from '../shared'
4
5export class JobsCommand extends AbstractCommand {
6
7 async getLatest (options: OverrideCommandOptions & {
8 jobType: JobType
9 }) {
10 const { data } = await this.list({ ...options, start: 0, count: 1, sort: '-createdAt' })
11
12 if (data.length === 0) return undefined
13
14 return data[0]
15 }
16
17 pauseJobQueue (options: OverrideCommandOptions = {}) {
18 const path = '/api/v1/jobs/pause'
19
20 return this.postBodyRequest({
21 ...options,
22
23 path,
24 implicitToken: true,
25 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
26 })
27 }
28
29 resumeJobQueue (options: OverrideCommandOptions = {}) {
30 const path = '/api/v1/jobs/resume'
31
32 return this.postBodyRequest({
33 ...options,
34
35 path,
36 implicitToken: true,
37 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
38 })
39 }
40
41 list (options: OverrideCommandOptions & {
42 state?: JobState
43 jobType?: JobType
44 start?: number
45 count?: number
46 sort?: string
47 } = {}) {
48 const path = this.buildJobsUrl(options.state)
49
50 const query = pick(options, [ 'start', 'count', 'sort', 'jobType' ])
51
52 return this.getRequestBody<ResultList<Job>>({
53 ...options,
54
55 path,
56 query,
57 implicitToken: true,
58 defaultExpectedStatus: HttpStatusCode.OK_200
59 })
60 }
61
62 listFailed (options: OverrideCommandOptions & {
63 jobType?: JobType
64 }) {
65 const path = this.buildJobsUrl('failed')
66
67 return this.getRequestBody<ResultList<Job>>({
68 ...options,
69
70 path,
71 query: { start: 0, count: 50 },
72 implicitToken: true,
73 defaultExpectedStatus: HttpStatusCode.OK_200
74 })
75 }
76
77 private buildJobsUrl (state?: JobState) {
78 let path = '/api/v1/jobs'
79
80 if (state) path += '/' + state
81
82 return path
83 }
84}