diff options
Diffstat (limited to 'packages/peertube-runner/shared/ipc')
6 files changed, 169 insertions, 0 deletions
diff --git a/packages/peertube-runner/shared/ipc/index.ts b/packages/peertube-runner/shared/ipc/index.ts new file mode 100644 index 000000000..ad4590281 --- /dev/null +++ b/packages/peertube-runner/shared/ipc/index.ts | |||
@@ -0,0 +1,2 @@ | |||
1 | export * from './ipc-client' | ||
2 | export * from './ipc-server' | ||
diff --git a/packages/peertube-runner/shared/ipc/ipc-client.ts b/packages/peertube-runner/shared/ipc/ipc-client.ts new file mode 100644 index 000000000..7f5951157 --- /dev/null +++ b/packages/peertube-runner/shared/ipc/ipc-client.ts | |||
@@ -0,0 +1,74 @@ | |||
1 | import CliTable3 from 'cli-table3' | ||
2 | import { ensureDir } from 'fs-extra' | ||
3 | import { Client as NetIPC } from 'net-ipc' | ||
4 | import { ConfigManager } from '../config-manager' | ||
5 | import { IPCReponse, IPCReponseData, IPCRequest } from './shared' | ||
6 | |||
7 | export class IPCClient { | ||
8 | private netIPC: NetIPC | ||
9 | |||
10 | async run () { | ||
11 | await ensureDir(ConfigManager.Instance.getSocketDirectory()) | ||
12 | |||
13 | const socketPath = ConfigManager.Instance.getSocketPath() | ||
14 | this.netIPC = new NetIPC({ path: socketPath }) | ||
15 | await this.netIPC.connect() | ||
16 | } | ||
17 | |||
18 | async askRegister (options: { | ||
19 | url: string | ||
20 | registrationToken: string | ||
21 | runnerName: string | ||
22 | runnerDescription?: string | ||
23 | }) { | ||
24 | const req: IPCRequest = { | ||
25 | type: 'register', | ||
26 | ...options | ||
27 | } | ||
28 | |||
29 | const { success, error } = await this.netIPC.request(req) as IPCReponse | ||
30 | |||
31 | if (success) console.log('PeerTube instance registered') | ||
32 | else console.error('Could not register PeerTube instance on runner server side', error) | ||
33 | } | ||
34 | |||
35 | async askUnregister (options: { | ||
36 | url: string | ||
37 | }) { | ||
38 | const req: IPCRequest = { | ||
39 | type: 'unregister', | ||
40 | ...options | ||
41 | } | ||
42 | |||
43 | const { success, error } = await this.netIPC.request(req) as IPCReponse | ||
44 | |||
45 | if (success) console.log('PeerTube instance unregistered') | ||
46 | else console.error('Could not unregister PeerTube instance on runner server side', error) | ||
47 | } | ||
48 | |||
49 | async askListRegistered () { | ||
50 | const req: IPCRequest = { | ||
51 | type: 'list-registered' | ||
52 | } | ||
53 | |||
54 | const { success, error, data } = await this.netIPC.request(req) as IPCReponse<IPCReponseData> | ||
55 | if (!success) { | ||
56 | console.error('Could not list registered PeerTube instances', error) | ||
57 | return | ||
58 | } | ||
59 | |||
60 | const table = new CliTable3({ | ||
61 | head: [ 'instance', 'runner name', 'runner description' ] | ||
62 | }) | ||
63 | |||
64 | for (const server of data.servers) { | ||
65 | table.push([ server.url, server.runnerName, server.runnerDescription ]) | ||
66 | } | ||
67 | |||
68 | console.log(table.toString()) | ||
69 | } | ||
70 | |||
71 | stop () { | ||
72 | this.netIPC.destroy() | ||
73 | } | ||
74 | } | ||
diff --git a/packages/peertube-runner/shared/ipc/ipc-server.ts b/packages/peertube-runner/shared/ipc/ipc-server.ts new file mode 100644 index 000000000..bc340198b --- /dev/null +++ b/packages/peertube-runner/shared/ipc/ipc-server.ts | |||
@@ -0,0 +1,61 @@ | |||
1 | import { ensureDir } from 'fs-extra' | ||
2 | import { Server as NetIPC } from 'net-ipc' | ||
3 | import { pick } from '@shared/core-utils' | ||
4 | import { RunnerServer } from '../../server' | ||
5 | import { ConfigManager } from '../config-manager' | ||
6 | import { logger } from '../logger' | ||
7 | import { IPCReponse, IPCReponseData, IPCRequest } from './shared' | ||
8 | |||
9 | export class IPCServer { | ||
10 | private netIPC: NetIPC | ||
11 | private runnerServer: RunnerServer | ||
12 | |||
13 | async run (runnerServer: RunnerServer) { | ||
14 | this.runnerServer = runnerServer | ||
15 | |||
16 | await ensureDir(ConfigManager.Instance.getSocketDirectory()) | ||
17 | |||
18 | const socketPath = ConfigManager.Instance.getSocketPath() | ||
19 | this.netIPC = new NetIPC({ path: socketPath }) | ||
20 | await this.netIPC.start() | ||
21 | |||
22 | logger.info(`IPC socket created on ${socketPath}`) | ||
23 | |||
24 | this.netIPC.on('request', async (req: IPCRequest, res) => { | ||
25 | try { | ||
26 | const data = await this.process(req) | ||
27 | |||
28 | this.sendReponse(res, { success: true, data }) | ||
29 | } catch (err) { | ||
30 | console.error('Cannot execute RPC call', err) | ||
31 | this.sendReponse(res, { success: false, error: err.message }) | ||
32 | } | ||
33 | }) | ||
34 | } | ||
35 | |||
36 | private async process (req: IPCRequest) { | ||
37 | switch (req.type) { | ||
38 | case 'register': | ||
39 | await this.runnerServer.registerRunner(pick(req, [ 'url', 'registrationToken', 'runnerName', 'runnerDescription' ])) | ||
40 | return undefined | ||
41 | |||
42 | case 'unregister': | ||
43 | await this.runnerServer.unregisterRunner({ url: req.url }) | ||
44 | return undefined | ||
45 | |||
46 | case 'list-registered': | ||
47 | return Promise.resolve(this.runnerServer.listRegistered()) | ||
48 | |||
49 | default: | ||
50 | throw new Error('Unknown RPC call ' + (req as any).type) | ||
51 | } | ||
52 | } | ||
53 | |||
54 | private sendReponse <T extends IPCReponseData> ( | ||
55 | response: (data: any) => Promise<void>, | ||
56 | body: IPCReponse<T> | ||
57 | ) { | ||
58 | response(body) | ||
59 | .catch(err => console.error('Cannot send response after IPC request', err)) | ||
60 | } | ||
61 | } | ||
diff --git a/packages/peertube-runner/shared/ipc/shared/index.ts b/packages/peertube-runner/shared/ipc/shared/index.ts new file mode 100644 index 000000000..deaaa152e --- /dev/null +++ b/packages/peertube-runner/shared/ipc/shared/index.ts | |||
@@ -0,0 +1,2 @@ | |||
1 | export * from './ipc-request.model' | ||
2 | export * from './ipc-response.model' | ||
diff --git a/packages/peertube-runner/shared/ipc/shared/ipc-request.model.ts b/packages/peertube-runner/shared/ipc/shared/ipc-request.model.ts new file mode 100644 index 000000000..0f733cdfe --- /dev/null +++ b/packages/peertube-runner/shared/ipc/shared/ipc-request.model.ts | |||
@@ -0,0 +1,15 @@ | |||
1 | export type IPCRequest = | ||
2 | IPCRequestRegister | | ||
3 | IPCRequestUnregister | | ||
4 | IPCRequestListRegistered | ||
5 | |||
6 | export type IPCRequestRegister = { | ||
7 | type: 'register' | ||
8 | url: string | ||
9 | registrationToken: string | ||
10 | runnerName: string | ||
11 | runnerDescription?: string | ||
12 | } | ||
13 | |||
14 | export type IPCRequestUnregister = { type: 'unregister', url: string } | ||
15 | export type IPCRequestListRegistered = { type: 'list-registered' } | ||
diff --git a/packages/peertube-runner/shared/ipc/shared/ipc-response.model.ts b/packages/peertube-runner/shared/ipc/shared/ipc-response.model.ts new file mode 100644 index 000000000..689d6e09a --- /dev/null +++ b/packages/peertube-runner/shared/ipc/shared/ipc-response.model.ts | |||
@@ -0,0 +1,15 @@ | |||
1 | export type IPCReponse <T extends IPCReponseData = undefined> = { | ||
2 | success: boolean | ||
3 | error?: string | ||
4 | data?: T | ||
5 | } | ||
6 | |||
7 | export type IPCReponseData = | ||
8 | // list registered | ||
9 | { | ||
10 | servers: { | ||
11 | runnerName: string | ||
12 | runnerDescription: string | ||
13 | url: string | ||
14 | }[] | ||
15 | } | ||