1 import { ensureDir, readdir, remove } from 'fs-extra'
2 import { join } from 'path'
3 import { io, Socket } from 'socket.io-client'
4 import { pick } from '@shared/core-utils'
5 import { PeerTubeProblemDocument, ServerErrorCode } from '@shared/models'
6 import { PeerTubeServer as PeerTubeServerCommand } from '@shared/server-commands'
7 import { ConfigManager } from '../shared'
8 import { IPCServer } from '../shared/ipc'
9 import { logger } from '../shared/logger'
10 import { JobWithToken, processJob } from './process'
12 type PeerTubeServer = PeerTubeServerCommand & {
15 runnerDescription?: string
18 export class RunnerServer {
19 private static instance: RunnerServer
21 private servers: PeerTubeServer[] = []
22 private processingJobs: { job: JobWithToken, server: PeerTubeServer }[] = []
24 private checkingAvailableJobs = false
26 private readonly sockets = new Map<PeerTubeServer, Socket>()
28 private constructor () {}
31 logger.info('Running PeerTube runner in server mode')
33 await ConfigManager.Instance.load()
35 for (const registered of ConfigManager.Instance.getConfig().registeredInstances) {
36 const serverCommand = new PeerTubeServerCommand({ url: registered.url })
38 this.loadServer(Object.assign(serverCommand, registered))
40 logger.info(`Loading registered instance ${registered.url}`)
44 const ipcServer = new IPCServer()
46 await ipcServer.run(this)
48 console.error('Cannot start local socket for IPC communication', err)
53 for (const code of [ 'SIGINT', 'SIGUSR1', 'SIGUSR2', 'uncaughtException' ]) {
54 process.on(code, async () => {
60 await ensureDir(ConfigManager.Instance.getTranscodingDirectory())
61 await this.cleanupTMP()
63 logger.info(`Using ${ConfigManager.Instance.getTranscodingDirectory()} for transcoding directory`)
65 await this.checkAvailableJobs()
68 // ---------------------------------------------------------------------------
70 async registerRunner (options: {
72 registrationToken: string
74 runnerDescription?: string
76 const { url, registrationToken, runnerName, runnerDescription } = options
78 logger.info(`Registering runner ${runnerName} on ${url}...`)
80 const serverCommand = new PeerTubeServerCommand({ url })
81 const { runnerToken } = await serverCommand.runners.register({ name: runnerName, description: runnerDescription, registrationToken })
83 const server: PeerTubeServer = Object.assign(serverCommand, {
89 this.loadServer(server)
90 await this.saveRegisteredInstancesInConf()
92 logger.info(`Registered runner ${runnerName} on ${url}`)
94 await this.checkAvailableJobs()
97 private loadServer (server: PeerTubeServer) {
98 this.servers.push(server)
100 const url = server.url + '/runners'
101 const socket = io(url, {
103 runnerToken: server.runnerToken
105 transports: [ 'websocket' ]
108 socket.on('connect_error', err => logger.warn({ err }, `Cannot connect to ${url} socket`))
109 socket.on('connect', () => logger.info(`Connected to ${url} socket`))
110 socket.on('available-jobs', () => this.checkAvailableJobs())
112 this.sockets.set(server, socket)
115 async unregisterRunner (options: {
118 const { url } = options
120 const server = this.servers.find(s => s.url === url)
122 logger.error(`Unknown server ${url} to unregister`)
126 logger.info(`Unregistering runner ${server.runnerName} on ${url}...`)
129 await server.runners.unregister({ runnerToken: server.runnerToken })
131 logger.error({ err }, `Cannot unregister runner ${server.runnerName} on ${url}`)
134 this.unloadServer(server)
135 await this.saveRegisteredInstancesInConf()
137 logger.info(`Unregistered runner ${server.runnerName} on ${server.url}`)
140 private unloadServer (server: PeerTubeServer) {
141 this.servers = this.servers.filter(s => s !== server)
143 const socket = this.sockets.get(server)
146 this.sockets.delete(server)
151 servers: this.servers.map(s => {
154 runnerName: s.runnerName,
155 runnerDescription: s.runnerDescription
161 // ---------------------------------------------------------------------------
163 private async checkAvailableJobs () {
164 if (this.checkingAvailableJobs) return
166 logger.info('Checking available jobs')
168 this.checkingAvailableJobs = true
170 for (const server of this.servers) {
172 const job = await this.requestJob(server)
175 await this.tryToExecuteJobAsync(server, job)
177 if ((err.res?.body as PeerTubeProblemDocument)?.code === ServerErrorCode.UNKNOWN_RUNNER_TOKEN) {
178 logger.error({ err }, `Unregistering ${server.url} as the runner token ${server.runnerToken} is invalid`)
180 await this.unregisterRunner({ url: server.url })
184 logger.error({ err }, `Cannot request/accept job on ${server.url} for runner ${server.runnerName}`)
188 this.checkingAvailableJobs = false
191 private async requestJob (server: PeerTubeServer) {
192 logger.debug(`Requesting jobs on ${server.url} for runner ${server.runnerName}`)
194 const { availableJobs } = await server.runnerJobs.request({ runnerToken: server.runnerToken })
196 if (availableJobs.length === 0) {
197 logger.debug(`No job available on ${server.url} for runner ${server.runnerName}`)
201 return availableJobs[0]
204 private async tryToExecuteJobAsync (server: PeerTubeServer, jobToAccept: { uuid: string }) {
205 if (this.processingJobs.length >= ConfigManager.Instance.getConfig().jobs.concurrency) return
207 const { job } = await server.runnerJobs.accept({ runnerToken: server.runnerToken, jobUUID: jobToAccept.uuid })
209 const processingJob = { job, server }
210 this.processingJobs.push(processingJob)
212 processJob({ server, job, runnerToken: server.runnerToken })
214 logger.error({ err }, 'Cannot process job')
216 server.runnerJobs.error({ jobToken: job.jobToken, jobUUID: job.uuid, runnerToken: server.runnerToken, message: err.message })
217 .catch(err2 => logger.error({ err: err2 }, 'Cannot abort job after error'))
220 this.processingJobs = this.processingJobs.filter(p => p !== processingJob)
222 return this.checkAvailableJobs()
226 // ---------------------------------------------------------------------------
228 private saveRegisteredInstancesInConf () {
229 const data = this.servers.map(s => {
230 return pick(s, [ 'url', 'runnerToken', 'runnerName', 'runnerDescription' ])
233 return ConfigManager.Instance.setRegisteredInstances(data)
236 // ---------------------------------------------------------------------------
238 private async cleanupTMP () {
239 const files = await readdir(ConfigManager.Instance.getTranscodingDirectory())
241 for (const file of files) {
242 await remove(join(ConfigManager.Instance.getTranscodingDirectory(), file))
246 private async onExit () {
248 for (const { server, job } of this.processingJobs) {
249 await server.runnerJobs.abort({
250 jobToken: job.jobToken,
252 reason: 'Runner stopped',
253 runnerToken: server.runnerToken
257 await this.cleanupTMP()
266 static get Instance () {
267 return this.instance || (this.instance = new this())