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'
10 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
16 checkResolutionsInMasterPlaylist,
20 flushAndRunMultipleServers,
31 sendRTMPStreamInVideo,
33 setAccessTokensToServers,
34 setDefaultVideoChannel,
36 testFfmpegStreamError,
38 updateCustomSubConfig,
44 waitUntilLivePublished,
45 waitUntilLiveSegmentGeneration
46 } from '../../../../shared/extra-utils'
48 const expect = chai.expect
50 describe('Test live', function () {
51 let servers: ServerInfo[] = []
53 before(async function () {
56 servers = await flushAndRunMultipleServers(2)
58 // Get the access tokens
59 await setAccessTokensToServers(servers)
60 await setDefaultVideoChannel(servers)
62 await updateCustomSubConfig(servers[0].url, servers[0].accessToken, {
72 // Server 1 and server 2 follow each other
73 await doubleFollow(servers[0], servers[1])
76 describe('Live creation, update and delete', function () {
77 let liveVideoUUID: string
79 it('Should create a live with the appropriate parameters', async function () {
82 const attributes: LiveVideoCreate = {
86 description: 'super live description',
87 support: 'support field',
88 channelId: servers[0].videoChannel.id,
90 waitTranscoding: false,
91 name: 'my super live',
92 tags: [ 'tag1', 'tag2' ],
93 commentsEnabled: false,
94 downloadEnabled: false,
96 privacy: VideoPrivacy.PUBLIC,
97 previewfile: 'video_short1-preview.webm.jpg',
98 thumbnailfile: 'video_short1.webm.jpg'
101 const res = await createLive(servers[0].url, servers[0].accessToken, attributes)
102 liveVideoUUID = res.body.video.uuid
104 await waitJobs(servers)
106 for (const server of servers) {
107 const resVideo = await getVideo(server.url, liveVideoUUID)
108 const video: VideoDetails = resVideo.body
110 expect(video.category.id).to.equal(1)
111 expect(video.licence.id).to.equal(2)
112 expect(video.language.id).to.equal('fr')
113 expect(video.description).to.equal('super live description')
114 expect(video.support).to.equal('support field')
116 expect(video.channel.name).to.equal(servers[0].videoChannel.name)
117 expect(video.channel.host).to.equal(servers[0].videoChannel.host)
119 expect(video.nsfw).to.be.false
120 expect(video.waitTranscoding).to.be.false
121 expect(video.name).to.equal('my super live')
122 expect(video.tags).to.deep.equal([ 'tag1', 'tag2' ])
123 expect(video.commentsEnabled).to.be.false
124 expect(video.downloadEnabled).to.be.false
125 expect(video.privacy.id).to.equal(VideoPrivacy.PUBLIC)
127 await testImage(server.url, 'video_short1-preview.webm', video.previewPath)
128 await testImage(server.url, 'video_short1.webm', video.thumbnailPath)
130 const resLive = await getLive(server.url, server.accessToken, liveVideoUUID)
131 const live: LiveVideo = resLive.body
133 if (server.url === servers[0].url) {
134 expect(live.rtmpUrl).to.equal('rtmp://' + server.hostname + ':' + servers[0].rtmpPort + '/live')
135 expect(live.streamKey).to.not.be.empty
137 expect(live.rtmpUrl).to.be.null
138 expect(live.streamKey).to.be.null
141 expect(live.saveReplay).to.be.true
145 it('Should have a default preview and thumbnail', async function () {
148 const attributes: LiveVideoCreate = {
149 name: 'default live thumbnail',
150 channelId: servers[0].videoChannel.id,
151 privacy: VideoPrivacy.UNLISTED,
155 const res = await createLive(servers[0].url, servers[0].accessToken, attributes)
156 const videoId = res.body.video.uuid
158 await waitJobs(servers)
160 for (const server of servers) {
161 const resVideo = await getVideo(server.url, videoId)
162 const video: VideoDetails = resVideo.body
164 expect(video.privacy.id).to.equal(VideoPrivacy.UNLISTED)
165 expect(video.nsfw).to.be.true
167 await makeRawRequest(server.url + video.thumbnailPath, HttpStatusCode.OK_200)
168 await makeRawRequest(server.url + video.previewPath, HttpStatusCode.OK_200)
172 it('Should not have the live listed since nobody streams into', async function () {
173 for (const server of servers) {
174 const res = await getVideosList(server.url)
176 expect(res.body.total).to.equal(0)
177 expect(res.body.data).to.have.lengthOf(0)
181 it('Should not be able to update a live of another server', async function () {
182 await updateLive(servers[1].url, servers[1].accessToken, liveVideoUUID, { saveReplay: false }, HttpStatusCode.FORBIDDEN_403)
185 it('Should update the live', async function () {
188 await updateLive(servers[0].url, servers[0].accessToken, liveVideoUUID, { saveReplay: false })
189 await waitJobs(servers)
192 it('Have the live updated', async function () {
193 for (const server of servers) {
194 const res = await getLive(server.url, server.accessToken, liveVideoUUID)
195 const live: LiveVideo = res.body
197 if (server.url === servers[0].url) {
198 expect(live.rtmpUrl).to.equal('rtmp://' + server.hostname + ':' + servers[0].rtmpPort + '/live')
199 expect(live.streamKey).to.not.be.empty
201 expect(live.rtmpUrl).to.be.null
202 expect(live.streamKey).to.be.null
205 expect(live.saveReplay).to.be.false
209 it('Delete the live', async function () {
212 await removeVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
213 await waitJobs(servers)
216 it('Should have the live deleted', async function () {
217 for (const server of servers) {
218 await getVideo(server.url, liveVideoUUID, HttpStatusCode.NOT_FOUND_404)
219 await getLive(server.url, server.accessToken, liveVideoUUID, HttpStatusCode.NOT_FOUND_404)
224 describe('Stream checks', function () {
225 let liveVideo: LiveVideo & VideoDetails
229 rtmpUrl = 'rtmp://' + servers[0].hostname + ':' + servers[0].rtmpPort + ''
232 async function createLiveWrapper () {
233 const liveAttributes = {
235 channelId: servers[0].videoChannel.id,
236 privacy: VideoPrivacy.PUBLIC,
240 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
241 const uuid = res.body.video.uuid
243 const resLive = await getLive(servers[0].url, servers[0].accessToken, uuid)
244 const resVideo = await getVideo(servers[0].url, uuid)
246 return Object.assign(resVideo.body, resLive.body) as LiveVideo & VideoDetails
249 it('Should not allow a stream without the appropriate path', async function () {
252 liveVideo = await createLiveWrapper()
254 const command = sendRTMPStream(rtmpUrl + '/bad-live', liveVideo.streamKey)
255 await testFfmpegStreamError(command, true)
258 it('Should not allow a stream without the appropriate stream key', async function () {
261 const command = sendRTMPStream(rtmpUrl + '/live', 'bad-stream-key')
262 await testFfmpegStreamError(command, true)
265 it('Should succeed with the correct params', async function () {
268 const command = sendRTMPStream(rtmpUrl + '/live', liveVideo.streamKey)
269 await testFfmpegStreamError(command, false)
272 it('Should not allow a stream on a live that was blacklisted', async function () {
275 liveVideo = await createLiveWrapper()
277 await addVideoToBlacklist(servers[0].url, servers[0].accessToken, liveVideo.uuid)
279 const command = sendRTMPStream(rtmpUrl + '/live', liveVideo.streamKey)
280 await testFfmpegStreamError(command, true)
283 it('Should not allow a stream on a live that was deleted', async function () {
286 liveVideo = await createLiveWrapper()
288 await removeVideo(servers[0].url, servers[0].accessToken, liveVideo.uuid)
290 const command = sendRTMPStream(rtmpUrl + '/live', liveVideo.streamKey)
291 await testFfmpegStreamError(command, true)
295 describe('Live transcoding', function () {
296 let liveVideoId: string
298 async function createLiveWrapper (saveReplay: boolean) {
299 const liveAttributes = {
301 channelId: servers[0].videoChannel.id,
302 privacy: VideoPrivacy.PUBLIC,
306 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
307 return res.body.video.uuid
310 async function testVideoResolutions (liveVideoId: string, resolutions: number[]) {
311 for (const server of servers) {
312 const resList = await getVideosList(server.url)
313 const videos: Video[] = resList.body.data
315 expect(videos.find(v => v.uuid === liveVideoId)).to.exist
317 const resVideo = await getVideo(server.url, liveVideoId)
318 const video: VideoDetails = resVideo.body
320 expect(video.streamingPlaylists).to.have.lengthOf(1)
322 const hlsPlaylist = video.streamingPlaylists.find(s => s.type === VideoStreamingPlaylistType.HLS)
323 expect(hlsPlaylist).to.exist
325 // Only finite files are displayed
326 expect(hlsPlaylist.files).to.have.lengthOf(0)
328 await checkResolutionsInMasterPlaylist(hlsPlaylist.playlistUrl, resolutions)
330 for (let i = 0; i < resolutions.length; i++) {
332 const segmentName = `${i}-00000${segmentNum}.ts`
333 await waitUntilLiveSegmentGeneration(servers[0], video.uuid, i, segmentNum)
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 waitUntilLivePublished(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 waitUntilLivePublished(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 waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoId)
411 await waitJobs(servers)
413 await testVideoResolutions(liveVideoId, resolutions)
415 await stopFfmpeg(command)
416 await waitJobs(servers)
418 await waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoId)
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.state.id).to.equal(VideoState.PUBLISHED)
431 expect(video.duration).to.be.greaterThan(1)
432 expect(video.files).to.have.lengthOf(0)
434 const hlsPlaylist = video.streamingPlaylists.find(s => s.type === VideoStreamingPlaylistType.HLS)
435 await makeRawRequest(hlsPlaylist.playlistUrl, HttpStatusCode.OK_200)
436 await makeRawRequest(hlsPlaylist.segmentsSha256Url, HttpStatusCode.OK_200)
438 expect(hlsPlaylist.files).to.have.lengthOf(resolutions.length)
440 for (const resolution of resolutions) {
441 const file = hlsPlaylist.files.find(f => f.resolution.id === resolution)
443 expect(file).to.exist
444 expect(file.size).to.be.greaterThan(1)
446 if (resolution >= 720) {
447 expect(file.fps).to.be.approximately(60, 2)
449 expect(file.fps).to.be.approximately(30, 2)
452 const filename = `${video.uuid}-${resolution}-fragmented.mp4`
453 const segmentPath = buildServerDirectory(servers[0], join('streaming-playlists', 'hls', video.uuid, filename))
455 const probe = await ffprobePromise(segmentPath)
456 const videoStream = await getVideoStreamFromFile(segmentPath, probe)
458 expect(probe.format.bit_rate).to.be.below(bitrateLimits[videoStream.height])
460 await makeRawRequest(file.torrentUrl, HttpStatusCode.OK_200)
461 await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
466 it('Should correctly have cleaned up the live files', async function () {
469 await checkLiveCleanup(servers[0], liveVideoId, [ 240, 360, 720 ])
473 describe('Live views', function () {
474 let liveVideoId: string
475 let command: FfmpegCommand
477 async function countViews (expected: number) {
478 for (const server of servers) {
479 const res = await getVideo(server.url, liveVideoId)
480 const video: VideoDetails = res.body
482 expect(video.views).to.equal(expected)
486 before(async function () {
489 const liveAttributes = {
491 channelId: servers[0].videoChannel.id,
492 privacy: VideoPrivacy.PUBLIC
495 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
496 liveVideoId = res.body.video.uuid
498 command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId)
499 await waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoId)
500 await waitJobs(servers)
503 it('Should display no views for a live', async function () {
507 it('Should view a live twice and display 1 view', async function () {
510 await viewVideo(servers[0].url, liveVideoId)
511 await viewVideo(servers[0].url, liveVideoId)
515 await waitJobs(servers)
520 it('Should wait and display 0 views', async function () {
524 await waitJobs(servers)
529 it('Should view a live on a remote and on local and display 2 views', async function () {
532 await viewVideo(servers[0].url, liveVideoId)
533 await viewVideo(servers[1].url, liveVideoId)
534 await viewVideo(servers[1].url, liveVideoId)
537 await waitJobs(servers)
542 after(async function () {
543 await stopFfmpeg(command)
547 describe('Live socket messages', function () {
549 async function createLiveWrapper () {
550 const liveAttributes = {
552 channelId: servers[0].videoChannel.id,
553 privacy: VideoPrivacy.PUBLIC
556 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
557 return res.body.video.uuid
560 it('Should correctly send a message when the live starts and ends', async function () {
563 const localStateChanges: VideoState[] = []
564 const remoteStateChanges: VideoState[] = []
566 const liveVideoUUID = await createLiveWrapper()
567 await waitJobs(servers)
570 const videoId = await getVideoIdFromUUID(servers[0].url, liveVideoUUID)
572 const localSocket = getLiveNotificationSocket(servers[0].url)
573 localSocket.on('state-change', data => localStateChanges.push(data.state))
574 localSocket.emit('subscribe', { videoId })
578 const videoId = await getVideoIdFromUUID(servers[1].url, liveVideoUUID)
580 const remoteSocket = getLiveNotificationSocket(servers[1].url)
581 remoteSocket.on('state-change', data => remoteStateChanges.push(data.state))
582 remoteSocket.emit('subscribe', { videoId })
585 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
587 for (const server of servers) {
588 await waitUntilLivePublished(server.url, server.accessToken, liveVideoUUID)
591 await waitJobs(servers)
593 for (const stateChanges of [ localStateChanges, remoteStateChanges ]) {
594 expect(stateChanges).to.have.length.at.least(1)
595 expect(stateChanges[stateChanges.length - 1]).to.equal(VideoState.PUBLISHED)
598 await stopFfmpeg(command)
600 for (const server of servers) {
601 await waitUntilLiveEnded(server.url, server.accessToken, liveVideoUUID)
604 await waitJobs(servers)
606 for (const stateChanges of [ localStateChanges, remoteStateChanges ]) {
607 expect(stateChanges).to.have.length.at.least(2)
608 expect(stateChanges[stateChanges.length - 1]).to.equal(VideoState.LIVE_ENDED)
612 it('Should correctly send views change notification', async function () {
615 let localLastVideoViews = 0
616 let remoteLastVideoViews = 0
618 const liveVideoUUID = await createLiveWrapper()
619 await waitJobs(servers)
622 const videoId = await getVideoIdFromUUID(servers[0].url, liveVideoUUID)
624 const localSocket = getLiveNotificationSocket(servers[0].url)
625 localSocket.on('views-change', data => { localLastVideoViews = data.views })
626 localSocket.emit('subscribe', { videoId })
630 const videoId = await getVideoIdFromUUID(servers[1].url, liveVideoUUID)
632 const remoteSocket = getLiveNotificationSocket(servers[1].url)
633 remoteSocket.on('views-change', data => { remoteLastVideoViews = data.views })
634 remoteSocket.emit('subscribe', { videoId })
637 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
639 for (const server of servers) {
640 await waitUntilLivePublished(server.url, server.accessToken, liveVideoUUID)
643 await waitJobs(servers)
645 expect(localLastVideoViews).to.equal(0)
646 expect(remoteLastVideoViews).to.equal(0)
648 await viewVideo(servers[0].url, liveVideoUUID)
649 await viewVideo(servers[1].url, liveVideoUUID)
651 await waitJobs(servers)
653 await waitJobs(servers)
655 expect(localLastVideoViews).to.equal(2)
656 expect(remoteLastVideoViews).to.equal(2)
658 await stopFfmpeg(command)
661 it('Should not receive a notification after unsubscribe', async function () {
664 const stateChanges: VideoState[] = []
666 const liveVideoUUID = await createLiveWrapper()
667 await waitJobs(servers)
669 const videoId = await getVideoIdFromUUID(servers[0].url, liveVideoUUID)
671 const socket = getLiveNotificationSocket(servers[0].url)
672 socket.on('state-change', data => stateChanges.push(data.state))
673 socket.emit('subscribe', { videoId })
675 const command = await sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoUUID)
676 await waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoUUID)
677 await waitJobs(servers)
679 expect(stateChanges).to.have.lengthOf(1)
680 socket.emit('unsubscribe', { videoId })
682 await stopFfmpeg(command)
683 await waitJobs(servers)
685 expect(stateChanges).to.have.lengthOf(1)
689 describe('After a server restart', function () {
690 let liveVideoId: string
691 let liveVideoReplayId: string
693 async function createLiveWrapper (saveReplay: boolean) {
694 const liveAttributes = {
696 channelId: servers[0].videoChannel.id,
697 privacy: VideoPrivacy.PUBLIC,
701 const res = await createLive(servers[0].url, servers[0].accessToken, liveAttributes)
702 return res.body.video.uuid
705 before(async function () {
708 liveVideoId = await createLiveWrapper(false)
709 liveVideoReplayId = await createLiveWrapper(true)
712 sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoId),
713 sendRTMPStreamInVideo(servers[0].url, servers[0].accessToken, liveVideoReplayId)
717 waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoId),
718 waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoReplayId)
721 await waitUntilLiveSegmentGeneration(servers[0], liveVideoId, 0, 2)
722 await waitUntilLiveSegmentGeneration(servers[0], liveVideoReplayId, 0, 2)
724 await killallServers([ servers[0] ])
725 await reRunServer(servers[0])
730 it('Should cleanup lives', async function () {
733 await waitUntilLiveEnded(servers[0].url, servers[0].accessToken, liveVideoId)
736 it('Should save a live replay', async function () {
739 await waitUntilLivePublished(servers[0].url, servers[0].accessToken, liveVideoReplayId)
743 after(async function () {
744 await cleanupTests(servers)