PeerTube/server/core/lib/peertube-socket.ts

132 lines
4.2 KiB
TypeScript
Raw Normal View History

2021-08-27 07:32:44 -05:00
import { Server as HTTPServer } from 'http'
import { Namespace, Server as SocketServer, Socket } from 'socket.io'
import { isIdValid } from '@server/helpers/custom-validators/misc.js'
import { Debounce } from '@server/helpers/debounce.js'
import { MVideo, MVideoImmutable } from '@server/types/models/index.js'
import { MRunner } from '@server/types/models/runners/index.js'
import { UserNotificationModelForApi } from '@server/types/models/user/index.js'
import { LiveVideoEventPayload, LiveVideoEventType } from '@peertube/peertube-models'
import { logger } from '../helpers/logger.js'
import { authenticateRunnerSocket, authenticateSocket } from '../middlewares/index.js'
2018-12-26 03:36:24 -06:00
class PeerTubeSocket {
private static instance: PeerTubeSocket
2021-08-27 07:32:44 -05:00
private userNotificationSockets: { [ userId: number ]: Socket[] } = {}
private liveVideosNamespace: Namespace
private readonly runnerSockets = new Set<Socket>()
2018-12-26 03:36:24 -06:00
private constructor () {}
2021-08-27 07:32:44 -05:00
init (server: HTTPServer) {
const io = new SocketServer(server)
2018-12-26 03:36:24 -06:00
io.of('/user-notifications')
.use(authenticateSocket)
.on('connection', socket => {
2021-03-03 08:22:38 -06:00
const userId = socket.handshake.auth.user.id
2018-12-26 03:36:24 -06:00
logger.debug('User %d connected to the notification system.', userId)
2018-12-26 03:36:24 -06:00
if (!this.userNotificationSockets[userId]) this.userNotificationSockets[userId] = []
this.userNotificationSockets[userId].push(socket)
2018-12-26 03:36:24 -06:00
socket.on('disconnect', () => {
logger.debug('User %d disconnected from SocketIO notifications.', userId)
this.userNotificationSockets[userId] = this.userNotificationSockets[userId].filter(s => s !== socket)
2018-12-26 03:36:24 -06:00
})
})
this.liveVideosNamespace = io.of('/live-videos')
.on('connection', socket => {
2024-02-22 03:12:04 -06:00
socket.on('subscribe', params => {
const videoId = params.videoId + ''
2020-11-04 08:31:32 -06:00
if (!isIdValid(videoId)) return
2021-04-12 10:00:21 -05:00
/* eslint-disable @typescript-eslint/no-floating-promises */
2020-11-04 08:31:32 -06:00
socket.join(videoId)
})
2024-02-22 03:12:04 -06:00
socket.on('unsubscribe', params => {
const videoId = params.videoId + ''
2020-11-04 08:31:32 -06:00
if (!isIdValid(videoId)) return
2021-04-12 10:00:21 -05:00
/* eslint-disable @typescript-eslint/no-floating-promises */
2020-11-04 08:31:32 -06:00
socket.leave(videoId)
})
})
io.of('/runners')
.use(authenticateRunnerSocket)
.on('connection', socket => {
const runner: MRunner = socket.handshake.auth.runner
logger.debug(`New runner "${runner.name}" connected to the notification system.`)
this.runnerSockets.add(socket)
socket.on('disconnect', () => {
logger.debug(`Runner "${runner.name}" disconnected from the notification system.`)
this.runnerSockets.delete(socket)
})
})
2018-12-26 03:36:24 -06:00
}
2019-08-15 04:53:26 -05:00
sendNotification (userId: number, notification: UserNotificationModelForApi) {
const sockets = this.userNotificationSockets[userId]
if (!sockets) return
2018-12-26 03:36:24 -06:00
logger.debug('Sending user notification to user %d.', userId)
const notificationMessage = notification.toFormattedJSON()
for (const socket of sockets) {
socket.emit('new-notification', notificationMessage)
}
2018-12-26 03:36:24 -06:00
}
sendVideoLiveNewState (video: MVideo) {
const data: LiveVideoEventPayload = { state: video.state }
const type: LiveVideoEventType = 'state-change'
2020-12-09 08:00:02 -06:00
logger.debug('Sending video live new state notification of %s.', video.url, { state: video.state })
this.liveVideosNamespace
2024-02-22 03:12:04 -06:00
.in(video.id + '')
2020-12-09 08:00:02 -06:00
.emit(type, data)
}
sendVideoViewsUpdate (video: MVideoImmutable, numViewers: number) {
const data: LiveVideoEventPayload = { viewers: numViewers }
2020-12-09 08:00:02 -06:00
const type: LiveVideoEventType = 'views-change'
logger.debug('Sending video live views update notification of %s.', video.url, { viewers: numViewers })
this.liveVideosNamespace
2024-02-22 03:12:04 -06:00
.in(video.id + '')
.emit(type, data)
}
@Debounce({ timeoutMS: 1000 })
sendAvailableJobsPingToRunners () {
logger.debug(`Sending available-jobs notification to ${this.runnerSockets.size} runner sockets`)
for (const runners of this.runnerSockets) {
runners.emit('available-jobs')
}
}
2018-12-26 03:36:24 -06:00
static get Instance () {
return this.instance || (this.instance = new this())
}
}
// ---------------------------------------------------------------------------
export {
PeerTubeSocket
}