1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
3 import * as chai from 'chai'
4 import { XMLParser, XMLValidator } from 'fast-xml-parser'
5 import { HttpStatusCode, VideoPrivacy } from '@shared/models'
15 setAccessTokensToServers,
16 setDefaultChannelAvatar,
19 } from '@shared/server-commands'
21 chai.use(require('chai-xml'))
22 chai.use(require('chai-json-schema'))
23 chai.config.includeStack = true
25 const expect = chai.expect
27 describe('Test syndication feeds', () => {
28 let servers: PeerTubeServer[] = []
29 let serverHLSOnly: PeerTubeServer
31 let userAccessToken: string
32 let rootAccountId: number
33 let rootChannelId: number
35 let userAccountId: number
36 let userChannelId: number
37 let userFeedToken: string
41 before(async function () {
45 servers = await createMultipleServers(2)
46 serverHLSOnly = await createSingleServer(3, {
49 webtorrent: { enabled: false },
50 hls: { enabled: true }
54 await setAccessTokensToServers([ ...servers, serverHLSOnly ])
55 await setDefaultChannelAvatar(servers[0])
56 await doubleFollow(servers[0], servers[1])
58 await servers[0].config.enableLive({ allowReplay: false, transcoding: false })
61 const user = await servers[0].users.getMyInfo()
62 rootAccountId = user.account.id
63 rootChannelId = user.videoChannels[0].id
67 userAccessToken = await servers[0].users.generateUserAndToken('john')
69 const user = await servers[0].users.getMyInfo({ token: userAccessToken })
70 userAccountId = user.account.id
71 userChannelId = user.videoChannels[0].id
73 const token = await servers[0].users.getMyScopedTokens({ token: userAccessToken })
74 userFeedToken = token.feedToken
78 await servers[0].videos.upload({ token: userAccessToken, attributes: { name: 'user video' } })
83 name: 'my super name for server 1',
84 description: 'my super description for server 1',
85 fixture: 'video_short.webm'
87 const { id } = await servers[0].videos.upload({ attributes })
89 await servers[0].comments.createThread({ videoId: id, text: 'super comment 1' })
90 await servers[0].comments.createThread({ videoId: id, text: 'super comment 2' })
94 const attributes = { name: 'unlisted video', privacy: VideoPrivacy.UNLISTED }
95 const { id } = await servers[0].videos.upload({ attributes })
97 await servers[0].comments.createThread({ videoId: id, text: 'comment on unlisted video' })
100 await serverHLSOnly.videos.upload({ attributes: { name: 'hls only video' } })
102 await waitJobs([ ...servers, serverHLSOnly ])
104 await servers[0].plugins.install({ path: PluginsCommand.getPluginTestPath('-podcast-custom-tags') })
107 describe('All feed', function () {
109 it('Should be well formed XML (covers RSS 2.0 and ATOM 1.0 endpoints)', async function () {
110 for (const feed of [ 'video-comments' as 'video-comments', 'videos' as 'videos' ]) {
111 const rss = await servers[0].feed.getXML({ feed, ignoreCache: true })
112 expect(rss).xml.to.be.valid()
114 const atom = await servers[0].feed.getXML({ feed, format: 'atom', ignoreCache: true })
115 expect(atom).xml.to.be.valid()
119 it('Should be well formed XML (covers Podcast endpoint)', async function () {
120 const podcast = await servers[0].feed.getPodcastXML({ ignoreCache: true, channelId: rootChannelId })
121 expect(podcast).xml.to.be.valid()
124 it('Should be well formed JSON (covers JSON feed 1.0 endpoint)', async function () {
125 for (const feed of [ 'video-comments' as 'video-comments', 'videos' as 'videos' ]) {
126 const jsonText = await servers[0].feed.getJSON({ feed, ignoreCache: true })
127 expect(JSON.parse(jsonText)).to.be.jsonSchema({ type: 'object' })
131 it('Should serve the endpoint with a classic request', async function () {
132 await makeGetRequest({
134 path: '/feeds/videos.xml',
135 accept: 'application/xml',
136 expectedStatus: HttpStatusCode.OK_200
140 it('Should serve the endpoint as a cached request', async function () {
141 const res = await makeGetRequest({
143 path: '/feeds/videos.xml',
144 accept: 'application/xml',
145 expectedStatus: HttpStatusCode.OK_200
148 expect(res.headers['x-api-cache-cached']).to.equal('true')
151 it('Should not serve the endpoint as a cached request', async function () {
152 const res = await makeGetRequest({
154 path: '/feeds/videos.xml?v=186',
155 accept: 'application/xml',
156 expectedStatus: HttpStatusCode.OK_200
159 expect(res.headers['x-api-cache-cached']).to.not.exist
162 it('Should refuse to serve the endpoint without accept header', async function () {
163 await makeGetRequest({ url: servers[0].url, path: '/feeds/videos.xml', expectedStatus: HttpStatusCode.NOT_ACCEPTABLE_406 })
167 describe('Videos feed', function () {
169 describe('Podcast feed', function () {
171 it('Should contain a valid podcast:alternateEnclosure', async function () {
172 // Since podcast feeds should only work on the server they originate on,
173 // only test the first server where the videos reside
174 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
175 expect(XMLValidator.validate(rss)).to.be.true
177 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
178 const xmlDoc = parser.parse(rss)
180 const itemGuid = xmlDoc.rss.channel.item.guid
181 expect(itemGuid).to.exist
182 expect(itemGuid['@_isPermaLink']).to.equal(true)
184 const enclosure = xmlDoc.rss.channel.item.enclosure
185 expect(enclosure).to.exist
186 const alternateEnclosure = xmlDoc.rss.channel.item['podcast:alternateEnclosure']
187 expect(alternateEnclosure).to.exist
189 expect(alternateEnclosure['@_type']).to.equal('video/webm')
190 expect(alternateEnclosure['@_length']).to.equal(218910)
191 expect(alternateEnclosure['@_lang']).to.equal('zh')
192 expect(alternateEnclosure['@_title']).to.equal('720p')
193 expect(alternateEnclosure['@_default']).to.equal(true)
195 expect(alternateEnclosure['podcast:source'][0]['@_uri']).to.contain('-720.webm')
196 expect(alternateEnclosure['podcast:source'][0]['@_uri']).to.equal(enclosure['@_url'])
197 expect(alternateEnclosure['podcast:source'][1]['@_uri']).to.contain('-720.torrent')
198 expect(alternateEnclosure['podcast:source'][1]['@_contentType']).to.equal('application/x-bittorrent')
199 expect(alternateEnclosure['podcast:source'][2]['@_uri']).to.contain('magnet:?')
202 it('Should contain a valid podcast:alternateEnclosure with HLS only', async function () {
203 const rss = await serverHLSOnly.feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
204 expect(XMLValidator.validate(rss)).to.be.true
206 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
207 const xmlDoc = parser.parse(rss)
209 const itemGuid = xmlDoc.rss.channel.item.guid
210 expect(itemGuid).to.exist
211 expect(itemGuid['@_isPermaLink']).to.equal(true)
213 const enclosure = xmlDoc.rss.channel.item.enclosure
214 const alternateEnclosure = xmlDoc.rss.channel.item['podcast:alternateEnclosure']
215 expect(alternateEnclosure).to.exist
217 expect(alternateEnclosure['@_type']).to.equal('application/x-mpegURL')
218 expect(alternateEnclosure['@_lang']).to.equal('zh')
219 expect(alternateEnclosure['@_title']).to.equal('HLS')
220 expect(alternateEnclosure['@_default']).to.equal(true)
222 expect(alternateEnclosure['podcast:source']['@_uri']).to.contain('-master.m3u8')
223 expect(alternateEnclosure['podcast:source']['@_uri']).to.equal(enclosure['@_url'])
226 it('Should contain a valid podcast:socialInteract', async function () {
227 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
228 expect(XMLValidator.validate(rss)).to.be.true
230 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
231 const xmlDoc = parser.parse(rss)
233 const item = xmlDoc.rss.channel.item
234 const socialInteract = item['podcast:socialInteract']
235 expect(socialInteract).to.exist
236 expect(socialInteract['@_protocol']).to.equal('activitypub')
237 expect(socialInteract['@_uri']).to.exist
238 expect(socialInteract['@_accountUrl']).to.exist
241 it('Should contain a valid support custom tags for plugins', async function () {
242 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: userChannelId })
243 expect(XMLValidator.validate(rss)).to.be.true
245 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
246 const xmlDoc = parser.parse(rss)
248 const fooTag = xmlDoc.rss.channel.fooTag
249 expect(fooTag).to.exist
250 expect(fooTag['@_bar']).to.equal('baz')
251 expect(fooTag['#text']).to.equal(42)
253 const bizzBuzzItem = xmlDoc.rss.channel['biz:buzzItem']
254 expect(bizzBuzzItem).to.exist
256 let nestedTag = bizzBuzzItem.nestedTag
257 expect(nestedTag).to.exist
258 expect(nestedTag).to.equal('example nested tag')
260 const item = xmlDoc.rss.channel.item
261 const fizzTag = item.fizzTag
262 expect(fizzTag).to.exist
263 expect(fizzTag['@_bar']).to.equal('baz')
264 expect(fizzTag['#text']).to.equal(21)
266 const bizzBuzz = item['biz:buzz']
267 expect(bizzBuzz).to.exist
269 nestedTag = bizzBuzz.nestedTag
270 expect(nestedTag).to.exist
271 expect(nestedTag).to.equal('example nested tag')
274 it('Should contain a valid podcast:liveItem for live streams', async function () {
277 const { uuid } = await servers[0].live.create({
280 privacy: VideoPrivacy.PUBLIC,
281 channelId: rootChannelId,
287 const ffmpeg = await servers[0].live.sendRTMPStreamInVideo({ videoId: liveId, copyCodecs: true, fixtureName: 'video_short.mp4' })
288 await servers[0].live.waitUntilPublished({ videoId: liveId })
290 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
291 expect(XMLValidator.validate(rss)).to.be.true
293 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
294 const xmlDoc = parser.parse(rss)
295 const liveItem = xmlDoc.rss.channel['podcast:liveItem']
296 expect(liveItem.title).to.equal('live-0')
297 expect(liveItem.guid['@_isPermaLink']).to.equal(false)
298 expect(liveItem.guid['#text']).to.contain(`${uuid}_`)
299 expect(liveItem['@_status']).to.equal('live')
301 const enclosure = liveItem.enclosure
302 const alternateEnclosure = liveItem['podcast:alternateEnclosure']
303 expect(alternateEnclosure).to.exist
304 expect(alternateEnclosure['@_type']).to.equal('application/x-mpegURL')
305 expect(alternateEnclosure['@_title']).to.equal('HLS live stream')
306 expect(alternateEnclosure['@_default']).to.equal(true)
308 expect(alternateEnclosure['podcast:source']['@_uri']).to.contain('/master.m3u8')
309 expect(alternateEnclosure['podcast:source']['@_uri']).to.equal(enclosure['@_url'])
311 await stopFfmpeg(ffmpeg)
313 await servers[0].live.waitUntilEnded({ videoId: liveId })
315 await waitJobs(servers)
319 describe('JSON feed', function () {
321 it('Should contain a valid \'attachments\' object', async function () {
322 for (const server of servers) {
323 const json = await server.feed.getJSON({ feed: 'videos', ignoreCache: true })
324 const jsonObj = JSON.parse(json)
325 expect(jsonObj.items.length).to.be.equal(2)
326 expect(jsonObj.items[0].attachments).to.exist
327 expect(jsonObj.items[0].attachments.length).to.be.eq(1)
328 expect(jsonObj.items[0].attachments[0].mime_type).to.be.eq('application/x-bittorrent')
329 expect(jsonObj.items[0].attachments[0].size_in_bytes).to.be.eq(218910)
330 expect(jsonObj.items[0].attachments[0].url).to.contain('720.torrent')
334 it('Should filter by account', async function () {
336 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { accountId: rootAccountId }, ignoreCache: true })
337 const jsonObj = JSON.parse(json)
338 expect(jsonObj.items.length).to.be.equal(1)
339 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
340 expect(jsonObj.items[0].author.name).to.equal('Main root channel')
344 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { accountId: userAccountId }, ignoreCache: true })
345 const jsonObj = JSON.parse(json)
346 expect(jsonObj.items.length).to.be.equal(1)
347 expect(jsonObj.items[0].title).to.equal('user video')
348 expect(jsonObj.items[0].author.name).to.equal('Main john channel')
351 for (const server of servers) {
353 const json = await server.feed.getJSON({ feed: 'videos', query: { accountName: 'root@' + servers[0].host }, ignoreCache: true })
354 const jsonObj = JSON.parse(json)
355 expect(jsonObj.items.length).to.be.equal(1)
356 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
360 const json = await server.feed.getJSON({ feed: 'videos', query: { accountName: 'john@' + servers[0].host }, ignoreCache: true })
361 const jsonObj = JSON.parse(json)
362 expect(jsonObj.items.length).to.be.equal(1)
363 expect(jsonObj.items[0].title).to.equal('user video')
368 it('Should filter by video channel', async function () {
370 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: rootChannelId }, ignoreCache: true })
371 const jsonObj = JSON.parse(json)
372 expect(jsonObj.items.length).to.be.equal(1)
373 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
374 expect(jsonObj.items[0].author.name).to.equal('Main root channel')
378 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: userChannelId }, ignoreCache: true })
379 const jsonObj = JSON.parse(json)
380 expect(jsonObj.items.length).to.be.equal(1)
381 expect(jsonObj.items[0].title).to.equal('user video')
382 expect(jsonObj.items[0].author.name).to.equal('Main john channel')
385 for (const server of servers) {
387 const query = { videoChannelName: 'root_channel@' + servers[0].host }
388 const json = await server.feed.getJSON({ feed: 'videos', query, ignoreCache: true })
389 const jsonObj = JSON.parse(json)
390 expect(jsonObj.items.length).to.be.equal(1)
391 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
395 const query = { videoChannelName: 'john_channel@' + servers[0].host }
396 const json = await server.feed.getJSON({ feed: 'videos', query, ignoreCache: true })
397 const jsonObj = JSON.parse(json)
398 expect(jsonObj.items.length).to.be.equal(1)
399 expect(jsonObj.items[0].title).to.equal('user video')
404 it('Should correctly have videos feed with HLS only', async function () {
407 const json = await serverHLSOnly.feed.getJSON({ feed: 'videos', ignoreCache: true })
408 const jsonObj = JSON.parse(json)
409 expect(jsonObj.items.length).to.be.equal(1)
410 expect(jsonObj.items[0].attachments).to.exist
411 expect(jsonObj.items[0].attachments.length).to.be.eq(4)
413 for (let i = 0; i < 4; i++) {
414 expect(jsonObj.items[0].attachments[i].mime_type).to.be.eq('application/x-bittorrent')
415 expect(jsonObj.items[0].attachments[i].size_in_bytes).to.be.greaterThan(0)
416 expect(jsonObj.items[0].attachments[i].url).to.exist
420 it('Should not display waiting live videos', async function () {
421 const { uuid } = await servers[0].live.create({
424 privacy: VideoPrivacy.PUBLIC,
425 channelId: rootChannelId
430 const json = await servers[0].feed.getJSON({ feed: 'videos', ignoreCache: true })
432 const jsonObj = JSON.parse(json)
433 expect(jsonObj.items.length).to.be.equal(2)
434 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
435 expect(jsonObj.items[1].title).to.equal('user video')
438 it('Should display published live videos', async function () {
441 const ffmpeg = await servers[0].live.sendRTMPStreamInVideo({ videoId: liveId, copyCodecs: true, fixtureName: 'video_short.mp4' })
442 await servers[0].live.waitUntilPublished({ videoId: liveId })
444 const json = await servers[0].feed.getJSON({ feed: 'videos', ignoreCache: true })
446 const jsonObj = JSON.parse(json)
447 expect(jsonObj.items.length).to.be.equal(3)
448 expect(jsonObj.items[0].title).to.equal('live')
449 expect(jsonObj.items[1].title).to.equal('my super name for server 1')
450 expect(jsonObj.items[2].title).to.equal('user video')
452 await stopFfmpeg(ffmpeg)
455 it('Should have the channel avatar as feed icon', async function () {
456 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: rootChannelId }, ignoreCache: true })
458 const jsonObj = JSON.parse(json)
459 const imageUrl = jsonObj.icon
460 expect(imageUrl).to.include('/lazy-static/avatars/')
461 await makeRawRequest({ url: imageUrl, expectedStatus: HttpStatusCode.OK_200 })
466 describe('Video comments feed', function () {
468 it('Should contain valid comments (covers JSON feed 1.0 endpoint) and not from unlisted videos', async function () {
469 for (const server of servers) {
470 const json = await server.feed.getJSON({ feed: 'video-comments', ignoreCache: true })
472 const jsonObj = JSON.parse(json)
473 expect(jsonObj.items.length).to.be.equal(2)
474 expect(jsonObj.items[0].content_html).to.contain('<p>super comment 2</p>')
475 expect(jsonObj.items[1].content_html).to.contain('<p>super comment 1</p>')
479 it('Should not list comments from muted accounts or instances', async function () {
482 const remoteHandle = 'root@' + servers[0].host
484 await servers[1].blocklist.addToServerBlocklist({ account: remoteHandle })
487 const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
488 const jsonObj = JSON.parse(json)
489 expect(jsonObj.items.length).to.be.equal(0)
492 await servers[1].blocklist.removeFromServerBlocklist({ account: remoteHandle })
495 const videoUUID = (await servers[1].videos.quickUpload({ name: 'server 2' })).uuid
496 await waitJobs(servers)
497 await servers[0].comments.createThread({ videoId: videoUUID, text: 'super comment' })
498 await waitJobs(servers)
500 const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
501 const jsonObj = JSON.parse(json)
502 expect(jsonObj.items.length).to.be.equal(3)
505 await servers[1].blocklist.addToMyBlocklist({ account: remoteHandle })
508 const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
509 const jsonObj = JSON.parse(json)
510 expect(jsonObj.items.length).to.be.equal(2)
515 describe('Video feed from my subscriptions', function () {
516 let feeduserAccountId: number
517 let feeduserFeedToken: string
519 it('Should list no videos for a user with no videos and no subscriptions', async function () {
520 const attr = { username: 'feeduser', password: 'password' }
521 await servers[0].users.create({ username: attr.username, password: attr.password })
522 const feeduserAccessToken = await servers[0].login.getAccessToken(attr)
525 const user = await servers[0].users.getMyInfo({ token: feeduserAccessToken })
526 feeduserAccountId = user.account.id
530 const token = await servers[0].users.getMyScopedTokens({ token: feeduserAccessToken })
531 feeduserFeedToken = token.feedToken
535 const body = await servers[0].videos.listMySubscriptionVideos({ token: feeduserAccessToken })
536 expect(body.total).to.equal(0)
538 const query = { accountId: feeduserAccountId, token: feeduserFeedToken }
539 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
540 const jsonObj = JSON.parse(json)
541 expect(jsonObj.items.length).to.be.equal(0) // no subscription, it should not list the instance's videos but list 0 videos
545 it('Should fail with an invalid token', async function () {
546 const query = { accountId: feeduserAccountId, token: 'toto' }
547 await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
550 it('Should fail with a token of another user', async function () {
551 const query = { accountId: feeduserAccountId, token: userFeedToken }
552 await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
555 it('Should list no videos for a user with videos but no subscriptions', async function () {
556 const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
557 expect(body.total).to.equal(0)
559 const query = { accountId: userAccountId, token: userFeedToken }
560 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
561 const jsonObj = JSON.parse(json)
562 expect(jsonObj.items.length).to.be.equal(0) // no subscription, it should not list the instance's videos but list 0 videos
565 it('Should list self videos for a user with a subscription to themselves', async function () {
568 await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'john_channel@' + servers[0].host })
569 await waitJobs(servers)
572 const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
573 expect(body.total).to.equal(1)
574 expect(body.data[0].name).to.equal('user video')
576 const query = { accountId: userAccountId, token: userFeedToken }
577 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
578 const jsonObj = JSON.parse(json)
579 expect(jsonObj.items.length).to.be.equal(1) // subscribed to self, it should not list the instance's videos but list john's
583 it('Should list videos of a user\'s subscription', async function () {
586 await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'root_channel@' + servers[0].host })
587 await waitJobs(servers)
590 const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
591 expect(body.total).to.equal(2, 'there should be 2 videos part of the subscription')
593 const query = { accountId: userAccountId, token: userFeedToken }
594 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
595 const jsonObj = JSON.parse(json)
596 expect(jsonObj.items.length).to.be.equal(2) // subscribed to root, it should not list the instance's videos but list root/john's
600 it('Should renew the token, and so have an invalid old token', async function () {
601 await servers[0].users.renewMyScopedTokens({ token: userAccessToken })
603 const query = { accountId: userAccountId, token: userFeedToken }
604 await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
607 it('Should succeed with the new token', async function () {
608 const token = await servers[0].users.getMyScopedTokens({ token: userAccessToken })
609 userFeedToken = token.feedToken
611 const query = { accountId: userAccountId, token: userFeedToken }
612 await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
617 after(async function () {
618 await servers[0].plugins.uninstall({ npmName: 'peertube-plugin-test-podcast-custom-tags' })
620 await cleanupTests([ ...servers, serverHLSOnly ])