1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import * as chai from 'chai'
5 import { FfmpegCommand } from 'fluent-ffmpeg'
6 import { join } from 'path'
7 import { ffprobePromise, getVideoStreamFromFile } from '@server/helpers/ffprobe-utils'
8 import { getLiveNotificationSocket } from '@shared/extra-utils/socket/socket-io'
9 import { LiveVideo, LiveVideoCreate, Video, VideoDetails, VideoPrivacy, VideoState, VideoStreamingPlaylistType } from '@shared/models'
15 checkResolutionsInMasterPlaylist,
19 flushAndRunMultipleServers,
30 sendRTMPStreamInVideo,
32 setAccessTokensToServers,
33 setDefaultVideoChannel,
35 testFfmpegStreamError,
37 updateCustomSubConfig,
43 waitUntilLivePublished,
46 } from '../../../../shared/extra-utils'
47 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
49 const expect = chai.expect
51 describe('Test live', function () {
52 let servers: ServerInfo[] = []
54 before(async function () {
57 servers = await flushAndRunMultipleServers(2)
59 // Get the access tokens
60 await setAccessTokensToServers(servers)
61 await setDefaultVideoChannel(servers)
63 await updateCustomSubConfig(servers[0].url, servers[0].accessToken, {
73 // Server 1 and server 2 follow each other
74 await doubleFollow(servers[0], servers[1])
77 describe('Live creation, update and delete', function () {
78 let liveVideoUUID: string
80 it('Should create a live with the appropriate parameters', async function () {
83 const attributes: LiveVideoCreate = {
87 description: 'super live description',
88 support: 'support field',
89 channelId: servers[0].videoChannel.id,
91 waitTranscoding: false,
92 name: 'my super live',
93 tags: [ 'tag1', 'tag2' ],
94 commentsEnabled: false,
95 downloadEnabled: false,
97 privacy: VideoPrivacy.PUBLIC,
98 previewfile: 'video_short1-preview.webm.jpg',
99 thumbnailfile: 'video_short1.webm.jpg'
102 const res = await createLive(servers[0].url, servers[0].accessToken, attributes)
103 liveVideoUUID = res.body.video.uuid
105 await waitJobs(servers)
107 for (const server of servers) {
108 const resVideo = await getVideo(server.url, liveVideoUUID)
109 const video: VideoDetails = resVideo.body
111 expect(video.category.id).to.equal(1)
112 expect(video.licence.id).to.equal(2)
113 expect(video.language.id).to.equal('fr')
114 expect(video.description).to.equal('super live description')
115 expect(video.support).to.equal('support field')
117 expect(video.channel.name).to.equal(servers[0].videoChannel.name)
118 expect(video.channel.host).to.equal(servers[0].videoChannel.host)
120 expect(video.nsfw).to.be.false
121 expect(video.waitTranscoding).to.be.false
122 expect(video.name).to.equal('my super live')
123 expect(video.tags).to.deep.equal([ 'tag1', 'tag2' ])
124 expect(video.commentsEnabled).to.be.false
125 expect(video.downloadEnabled).to.be.false
126 expect(video.privacy.id).to.equal(VideoPrivacy.PUBLIC)
128 await testImage(server.url, 'video_short1-preview.webm', video.previewPath)
129 await testImage(server.url, 'video_short1.webm', video.thumbnailPath)
131 const resLive = await getLive(server.url, server.accessToken, liveVideoUUID)
132 const live: LiveVideo = resLive.body
134 if (server.url === servers[0].url) {
135 expect(live.rtmpUrl).to.equal('rtmp://' + server.hostname + ':' + servers[0].rtmpPort + '/live')
136 expect(live.streamKey).to.not.be.empty
138 expect(live.rtmpUrl).to.be.null
139 expect(live.streamKey).to.be.null
142 expect(live.saveReplay).to.be.true
146 it('Should have a default preview and thumbnail', async function () {
149 const attributes: LiveVideoCreate = {
150 name: 'default live thumbnail',
151 channelId: servers[0].videoChannel.id,
152 privacy: VideoPrivacy.UNLISTED,
156 const res = await createLive(servers[0].url, servers[0].accessToken, attributes)
157 const videoId = res.body.video.uuid
159 await waitJobs(servers)
161 for (const server of servers) {
162 const resVideo = await getVideo(server.url, videoId)
163 const video: VideoDetails = resVideo.body
165 expect(video.privacy.id).to.equal(VideoPrivacy.UNLISTED)
166 expect(video.nsfw).to.be.true
168 await makeRawRequest(server.url + video.thumbnailPath, HttpStatusCode.OK_200)
169 await makeRawRequest(server.url + video.previewPath, HttpStatusCode.OK_200)
173 it('Should not have the live listed since nobody streams into', async function () {
174 for (const server of servers) {
175 const res = await getVideosList(server.url)
177 expect(res.body.total).to.equal(0)
178 expect(res.body.data).to.have.lengthOf(0)
182 it('Should not be able to update a live of another server', async function () {
183 await updateLive(servers[1].url, servers[1].accessToken, liveVideoUUID, { saveReplay: false }, HttpStatusCode.FORBIDDEN_403)
186 it('Should update the live', async function () {
189 await updateLive(servers[0].url, servers[0].accessToken, liveVideoUUID, { saveReplay: false })
190 await waitJobs(servers)
193 it('Have the live updated', async function () {
194 for (const server of servers) {
195 const res = await getLive(server.url, server.accessToken, liveVideoUUID)
196 const live: LiveVideo = res.body
198 if (server.url === servers[0].url) {
199 expect(live.rtmpUrl).to.equal('rtmp://' + server.hostname + ':' + servers[0].rtmpPort + '/live')
200 expect(live.streamKey).to.not.be.empty
202 expect(live.rtmpUrl).to.be.null
203 expect(live.streamKey).to.be.null
206 expect(live.saveReplay).to.be.false
210 it('Delete the live', async function () {
213 await removeVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
214 await waitJobs(servers)
217 it('Should have the live deleted', async function () {
218 for (const server of servers) {
219 await getVideo(server.url, liveVideoUUID, HttpStatusCode.NOT_FOUND_404)
220 await getLive(server.url, server.accessToken, liveVideoUUID, HttpStatusCode.NOT_FOUND_404)
225 describe('Stream checks', function () {
226 let liveVideo: LiveVideo & VideoDetails
230 rtmpUrl = 'rtmp://' + servers[0].hostname + ':' + servers[0].rtmpPort + ''
233 async function createLiveWrapper () {
234 const liveAttributes = {
236 channelId: servers[0].videoChannel.id,
237 privacy: VideoPrivacy.PUBLIC,
241 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
242 const uuid = res.body.video.uuid
244 const resLive = await getLive(servers[0].url, servers[0].accessToken, uuid)
245 const resVideo = await getVideo(servers[0].url, uuid)
247 return Object.assign(resVideo.body, resLive.body) as LiveVideo & VideoDetails
250 it('Should not allow a stream without the appropriate path', async function () {
253 liveVideo = await createLiveWrapper()
255 const command = sendRTMPStream(rtmpUrl + '/bad-live', liveVideo.streamKey)
256 await testFfmpegStreamError(command, true)
259 it('Should not allow a stream without the appropriate stream key', async function () {
262 const command = sendRTMPStream(rtmpUrl + '/live', 'bad-stream-key')
263 await testFfmpegStreamError(command, true)
266 it('Should succeed with the correct params', async function () {
269 const command = sendRTMPStream(rtmpUrl + '/live', liveVideo.streamKey)
270 await testFfmpegStreamError(command, false)
273 it('Should not allow a stream on a live that was blacklisted', async function () {
276 liveVideo = await createLiveWrapper()
278 await addVideoToBlacklist(servers[0].url, servers[0].accessToken, liveVideo.uuid)
280 const command = sendRTMPStream(rtmpUrl + '/live', liveVideo.streamKey)
281 await testFfmpegStreamError(command, true)
284 it('Should not allow a stream on a live that was deleted', async function () {
287 liveVideo = await createLiveWrapper()
289 await removeVideo(servers[0].url, servers[0].accessToken, liveVideo.uuid)
291 const command = sendRTMPStream(rtmpUrl + '/live', liveVideo.streamKey)
292 await testFfmpegStreamError(command, true)
296 describe('Live transcoding', function () {
297 let liveVideoId: string
299 async function createLiveWrapper (saveReplay: boolean) {
300 const liveAttributes = {
302 channelId: servers[0].videoChannel.id,
303 privacy: VideoPrivacy.PUBLIC,
307 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
308 return res.body.video.uuid
311 async function testVideoResolutions (liveVideoId: string, resolutions: number[]) {
312 for (const server of servers) {
313 const resList = await getVideosList(server.url)
314 const videos: Video[] = resList.body.data
316 expect(videos.find(v => v.uuid === liveVideoId)).to.exist
318 const resVideo = await getVideo(server.url, liveVideoId)
319 const video: VideoDetails = resVideo.body
321 expect(video.streamingPlaylists).to.have.lengthOf(1)
323 const hlsPlaylist = video.streamingPlaylists.find(s => s.type === VideoStreamingPlaylistType.HLS)
324 expect(hlsPlaylist).to.exist
326 // Only finite files are displayed
327 expect(hlsPlaylist.files).to.have.lengthOf(0)
329 await checkResolutionsInMasterPlaylist(hlsPlaylist.playlistUrl, resolutions)
331 for (let i = 0; i < resolutions.length; i++) {
332 const segmentName = `${i}-000001.ts`
333 await waitUntilLog(servers[0], `${video.uuid}/${segmentName}`, 2, false)
335 const res = await getPlaylist(`${servers[0].url}/static/streaming-playlists/hls/${video.uuid}/${i}.m3u8`)
336 const subPlaylist = res.text
338 expect(subPlaylist).to.contain(segmentName)
340 const baseUrlAndPath = servers[0].url + '/static/streaming-playlists/hls'
341 await checkLiveSegmentHash(baseUrlAndPath, video.uuid, segmentName, hlsPlaylist)
346 function updateConf (resolutions: number[]) {
347 return updateCustomSubConfig(servers[0].url, servers[0].accessToken, {
355 '240p': resolutions.includes(240),
356 '360p': resolutions.includes(360),
357 '480p': resolutions.includes(480),
358 '720p': resolutions.includes(720),
359 '1080p': resolutions.includes(1080),
360 '2160p': resolutions.includes(2160)
367 before(async function () {
371 it('Should enable transcoding without additional resolutions', async function () {
374 liveVideoId = await createLiveWrapper(false)
376 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId)
377 await waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoId)
378 await waitJobs(servers)
380 await testVideoResolutions(liveVideoId, [ 720 ])
382 await stopFfmpeg(command)
385 it('Should enable transcoding with some resolutions', async function () {
388 const resolutions = [ 240, 480 ]
389 await updateConf(resolutions)
390 liveVideoId = await createLiveWrapper(false)
392 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId)
393 await waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoId)
394 await waitJobs(servers)
396 await testVideoResolutions(liveVideoId, resolutions)
398 await stopFfmpeg(command)
401 it('Should enable transcoding with some resolutions and correctly save them', async function () {
404 const resolutions = [ 240, 360, 720 ]
406 await updateConf(resolutions)
407 liveVideoId = await createLiveWrapper(true)
409 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId, 'video_short2.webm')
410 await waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoId)
411 await waitJobs(servers)
413 await testVideoResolutions(liveVideoId, resolutions)
415 await stopFfmpeg(command)
416 await waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoId)
418 await waitJobs(servers)
420 const bitrateLimits = {
421 720: 5000 * 1000, // 60FPS
426 for (const server of servers) {
427 const resVideo = await getVideo(server.url, liveVideoId)
428 const video: VideoDetails = resVideo.body
430 expect(video.duration).to.be.greaterThan(1)
431 expect(video.files).to.have.lengthOf(0)
433 const hlsPlaylist = video.streamingPlaylists.find(s => s.type === VideoStreamingPlaylistType.HLS)
434 await makeRawRequest(hlsPlaylist.playlistUrl, HttpStatusCode.OK_200)
435 await makeRawRequest(hlsPlaylist.segmentsSha256Url, HttpStatusCode.OK_200)
437 expect(hlsPlaylist.files).to.have.lengthOf(resolutions.length)
439 for (const resolution of resolutions) {
440 const file = hlsPlaylist.files.find(f => f.resolution.id === resolution)
442 expect(file).to.exist
443 expect(file.size).to.be.greaterThan(1)
445 if (resolution >= 720) {
446 expect(file.fps).to.be.approximately(60, 2)
448 expect(file.fps).to.be.approximately(30, 2)
451 const filename = `${video.uuid}-${resolution}-fragmented.mp4`
452 const segmentPath = buildServerDirectory(servers[0], join('streaming-playlists', 'hls', video.uuid, filename))
454 const probe = await ffprobePromise(segmentPath)
455 const videoStream = await getVideoStreamFromFile(segmentPath, probe)
457 expect(probe.format.bit_rate).to.be.below(bitrateLimits[videoStream.height])
459 await makeRawRequest(file.torrentUrl, HttpStatusCode.OK_200)
460 await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
465 it('Should correctly have cleaned up the live files', async function () {
468 await checkLiveCleanup(servers[0], liveVideoId, [ 240, 360, 720 ])
472 describe('Live views', function () {
473 let liveVideoId: string
474 let command: FfmpegCommand
476 async function countViews (expected: number) {
477 for (const server of servers) {
478 const res = await getVideo(server.url, liveVideoId)
479 const video: VideoDetails = res.body
481 expect(video.views).to.equal(expected)
485 before(async function () {
488 const liveAttributes = {
490 channelId: servers[0].videoChannel.id,
491 privacy: VideoPrivacy.PUBLIC
494 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
495 liveVideoId = res.body.video.uuid
497 command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId)
498 await waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoId)
499 await waitJobs(servers)
502 it('Should display no views for a live', async function () {
506 it('Should view a live twice and display 1 view', async function () {
509 await viewVideo(servers[0].url, liveVideoId)
510 await viewVideo(servers[0].url, liveVideoId)
514 await waitJobs(servers)
519 it('Should wait and display 0 views', async function () {
523 await waitJobs(servers)
528 it('Should view a live on a remote and on local and display 2 views', async function () {
531 await viewVideo(servers[0].url, liveVideoId)
532 await viewVideo(servers[1].url, liveVideoId)
533 await viewVideo(servers[1].url, liveVideoId)
536 await waitJobs(servers)
541 after(async function () {
542 await stopFfmpeg(command)
546 describe('Live socket messages', function () {
548 async function createLiveWrapper () {
549 const liveAttributes = {
551 channelId: servers[0].videoChannel.id,
552 privacy: VideoPrivacy.PUBLIC
555 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
556 return res.body.video.uuid
559 it('Should correctly send a message when the live starts and ends', async function () {
562 const localStateChanges: VideoState[] = []
563 const remoteStateChanges: VideoState[] = []
565 const liveVideoUUID = await createLiveWrapper()
566 await waitJobs(servers)
569 const videoId = await getVideoIdFromUUID(servers[0].url, liveVideoUUID)
571 const localSocket = getLiveNotificationSocket(servers[0].url)
572 localSocket.on('state-change', data => localStateChanges.push(data.state))
573 localSocket.emit('subscribe', { videoId })
577 const videoId = await getVideoIdFromUUID(servers[1].url, liveVideoUUID)
579 const remoteSocket = getLiveNotificationSocket(servers[1].url)
580 remoteSocket.on('state-change', data => remoteStateChanges.push(data.state))
581 remoteSocket.emit('subscribe', { videoId })
584 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
586 for (const server of servers) {
587 await waitUntilLiveStarts(server.url, server.accessToken, liveVideoUUID)
590 await waitJobs(servers)
592 for (const stateChanges of [ localStateChanges, remoteStateChanges ]) {
593 expect(stateChanges).to.have.length.at.least(1)
594 expect(stateChanges[stateChanges.length - 1]).to.equal(VideoState.PUBLISHED)
597 await stopFfmpeg(command)
599 for (const server of servers) {
600 await waitUntilLiveEnded(server.url, server.accessToken, liveVideoUUID)
603 await waitJobs(servers)
605 for (const stateChanges of [ localStateChanges, remoteStateChanges ]) {
606 expect(stateChanges).to.have.length.at.least(2)
607 expect(stateChanges[stateChanges.length - 1]).to.equal(VideoState.LIVE_ENDED)
611 it('Should not receive a notification after unsubscribe', async function () {
614 const stateChanges: VideoState[] = []
616 const liveVideoUUID = await createLiveWrapper()
617 await waitJobs(servers)
619 const videoId = await getVideoIdFromUUID(servers[0].url, liveVideoUUID)
621 const socket = getLiveNotificationSocket(servers[0].url)
622 socket.on('state-change', data => stateChanges.push(data.state))
623 socket.emit('subscribe', { videoId })
625 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
626 await waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoUUID)
627 await waitJobs(servers)
629 expect(stateChanges).to.have.lengthOf(1)
630 socket.emit('unsubscribe', { videoId })
632 await stopFfmpeg(command)
633 await waitJobs(servers)
635 expect(stateChanges).to.have.lengthOf(1)
639 describe('After a server restart', function () {
640 let liveVideoId: string
641 let liveVideoReplayId: string
643 async function createLiveWrapper (saveReplay: boolean) {
644 const liveAttributes = {
646 channelId: servers[0].videoChannel.id,
647 privacy: VideoPrivacy.PUBLIC,
651 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
652 return res.body.video.uuid
655 before(async function () {
658 liveVideoId = await createLiveWrapper(false)
659 liveVideoReplayId = await createLiveWrapper(true)
662 sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId),
663 sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoReplayId)
667 waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoId),
668 waitUntilLiveStarts(servers[0].url, servers[0].accessToken, liveVideoReplayId)
671 await killallServers([ servers[0] ])
672 await reRunServer(servers[0])
677 it('Should cleanup lives', async function () {
680 const res = await getVideo(servers[0].url, liveVideoId)
681 const video: VideoDetails = res.body
683 expect(video.state.id).to.equal(VideoState.LIVE_ENDED)
686 it('Should save a live replay', async function () {
689 await waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoReplayId)
693 after(async function () {
694 await cleanupTests(servers)