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 enclosure = xmlDoc.rss.channel.item.enclosure
181 expect(enclosure).to.exist
182 const alternateEnclosure = xmlDoc.rss.channel.item['podcast:alternateEnclosure']
183 expect(alternateEnclosure).to.exist
185 expect(alternateEnclosure['@_type']).to.equal('video/webm')
186 expect(alternateEnclosure['@_length']).to.equal(218910)
187 expect(alternateEnclosure['@_lang']).to.equal('zh')
188 expect(alternateEnclosure['@_title']).to.equal('720p')
189 expect(alternateEnclosure['@_default']).to.equal(true)
191 expect(alternateEnclosure['podcast:source'][0]['@_uri']).to.contain('-720.webm')
192 expect(alternateEnclosure['podcast:source'][0]['@_uri']).to.equal(enclosure['@_url'])
193 expect(alternateEnclosure['podcast:source'][1]['@_uri']).to.contain('-720.torrent')
194 expect(alternateEnclosure['podcast:source'][1]['@_contentType']).to.equal('application/x-bittorrent')
195 expect(alternateEnclosure['podcast:source'][2]['@_uri']).to.contain('magnet:?')
198 it('Should contain a valid podcast:alternateEnclosure with HLS only', async function () {
199 const rss = await serverHLSOnly.feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
200 expect(XMLValidator.validate(rss)).to.be.true
202 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
203 const xmlDoc = parser.parse(rss)
205 const enclosure = xmlDoc.rss.channel.item.enclosure
206 const alternateEnclosure = xmlDoc.rss.channel.item['podcast:alternateEnclosure']
207 expect(alternateEnclosure).to.exist
209 expect(alternateEnclosure['@_type']).to.equal('application/x-mpegURL')
210 expect(alternateEnclosure['@_lang']).to.equal('zh')
211 expect(alternateEnclosure['@_title']).to.equal('HLS')
212 expect(alternateEnclosure['@_default']).to.equal(true)
214 expect(alternateEnclosure['podcast:source']['@_uri']).to.contain('-master.m3u8')
215 expect(alternateEnclosure['podcast:source']['@_uri']).to.equal(enclosure['@_url'])
218 it('Should contain a valid podcast:socialInteract', async function () {
219 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
220 expect(XMLValidator.validate(rss)).to.be.true
222 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
223 const xmlDoc = parser.parse(rss)
225 const item = xmlDoc.rss.channel.item
226 const socialInteract = item['podcast:socialInteract']
227 expect(socialInteract).to.exist
228 expect(socialInteract['@_protocol']).to.equal('activitypub')
229 expect(socialInteract['@_uri']).to.exist
230 expect(socialInteract['@_accountUrl']).to.exist
233 it('Should contain a valid support custom tags for plugins', async function () {
234 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: userChannelId })
235 expect(XMLValidator.validate(rss)).to.be.true
237 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
238 const xmlDoc = parser.parse(rss)
240 const fooTag = xmlDoc.rss.channel.fooTag
241 expect(fooTag).to.exist
242 expect(fooTag['@_bar']).to.equal('baz')
243 expect(fooTag['#text']).to.equal(42)
245 const bizzBuzzItem = xmlDoc.rss.channel['biz:buzzItem']
246 expect(bizzBuzzItem).to.exist
248 let nestedTag = bizzBuzzItem.nestedTag
249 expect(nestedTag).to.exist
250 expect(nestedTag).to.equal('example nested tag')
252 const item = xmlDoc.rss.channel.item
253 const fizzTag = item.fizzTag
254 expect(fizzTag).to.exist
255 expect(fizzTag['@_bar']).to.equal('baz')
256 expect(fizzTag['#text']).to.equal(21)
258 const bizzBuzz = item['biz:buzz']
259 expect(bizzBuzz).to.exist
261 nestedTag = bizzBuzz.nestedTag
262 expect(nestedTag).to.exist
263 expect(nestedTag).to.equal('example nested tag')
266 it('Should contain a valid podcast:liveItem for live streams', async function () {
269 const { uuid } = await servers[0].live.create({
272 privacy: VideoPrivacy.PUBLIC,
273 channelId: rootChannelId,
279 const ffmpeg = await servers[0].live.sendRTMPStreamInVideo({ videoId: liveId, copyCodecs: true, fixtureName: 'video_short.mp4' })
280 await servers[0].live.waitUntilPublished({ videoId: liveId })
282 const rss = await servers[0].feed.getPodcastXML({ ignoreCache: false, channelId: rootChannelId })
283 expect(XMLValidator.validate(rss)).to.be.true
285 const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
286 const xmlDoc = parser.parse(rss)
287 const liveItem = xmlDoc.rss.channel['podcast:liveItem']
288 expect(liveItem.title).to.equal('live-0')
289 expect(liveItem['@_status']).to.equal('live')
291 const enclosure = liveItem.enclosure
292 const alternateEnclosure = liveItem['podcast:alternateEnclosure']
293 expect(alternateEnclosure).to.exist
294 expect(alternateEnclosure['@_type']).to.equal('application/x-mpegURL')
295 expect(alternateEnclosure['@_title']).to.equal('HLS live stream')
296 expect(alternateEnclosure['@_default']).to.equal(true)
298 expect(alternateEnclosure['podcast:source']['@_uri']).to.contain('/master.m3u8')
299 expect(alternateEnclosure['podcast:source']['@_uri']).to.equal(enclosure['@_url'])
301 await stopFfmpeg(ffmpeg)
303 await servers[0].live.waitUntilEnded({ videoId: liveId })
305 await waitJobs(servers)
309 describe('JSON feed', function () {
311 it('Should contain a valid \'attachments\' object', async function () {
312 for (const server of servers) {
313 const json = await server.feed.getJSON({ feed: 'videos', ignoreCache: true })
314 const jsonObj = JSON.parse(json)
315 expect(jsonObj.items.length).to.be.equal(2)
316 expect(jsonObj.items[0].attachments).to.exist
317 expect(jsonObj.items[0].attachments.length).to.be.eq(1)
318 expect(jsonObj.items[0].attachments[0].mime_type).to.be.eq('application/x-bittorrent')
319 expect(jsonObj.items[0].attachments[0].size_in_bytes).to.be.eq(218910)
320 expect(jsonObj.items[0].attachments[0].url).to.contain('720.torrent')
324 it('Should filter by account', async function () {
326 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { accountId: rootAccountId }, ignoreCache: true })
327 const jsonObj = JSON.parse(json)
328 expect(jsonObj.items.length).to.be.equal(1)
329 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
330 expect(jsonObj.items[0].author.name).to.equal('Main root channel')
334 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { accountId: userAccountId }, ignoreCache: true })
335 const jsonObj = JSON.parse(json)
336 expect(jsonObj.items.length).to.be.equal(1)
337 expect(jsonObj.items[0].title).to.equal('user video')
338 expect(jsonObj.items[0].author.name).to.equal('Main john channel')
341 for (const server of servers) {
343 const json = await server.feed.getJSON({ feed: 'videos', query: { accountName: 'root@' + servers[0].host }, ignoreCache: true })
344 const jsonObj = JSON.parse(json)
345 expect(jsonObj.items.length).to.be.equal(1)
346 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
350 const json = await server.feed.getJSON({ feed: 'videos', query: { accountName: 'john@' + servers[0].host }, ignoreCache: true })
351 const jsonObj = JSON.parse(json)
352 expect(jsonObj.items.length).to.be.equal(1)
353 expect(jsonObj.items[0].title).to.equal('user video')
358 it('Should filter by video channel', async function () {
360 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: rootChannelId }, 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('my super name for server 1')
364 expect(jsonObj.items[0].author.name).to.equal('Main root channel')
368 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: userChannelId }, ignoreCache: true })
369 const jsonObj = JSON.parse(json)
370 expect(jsonObj.items.length).to.be.equal(1)
371 expect(jsonObj.items[0].title).to.equal('user video')
372 expect(jsonObj.items[0].author.name).to.equal('Main john channel')
375 for (const server of servers) {
377 const query = { videoChannelName: 'root_channel@' + servers[0].host }
378 const json = await server.feed.getJSON({ feed: 'videos', query, 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('my super name for server 1')
385 const query = { videoChannelName: 'john_channel@' + servers[0].host }
386 const json = await server.feed.getJSON({ feed: 'videos', query, ignoreCache: true })
387 const jsonObj = JSON.parse(json)
388 expect(jsonObj.items.length).to.be.equal(1)
389 expect(jsonObj.items[0].title).to.equal('user video')
394 it('Should correctly have videos feed with HLS only', async function () {
397 const json = await serverHLSOnly.feed.getJSON({ feed: 'videos', ignoreCache: true })
398 const jsonObj = JSON.parse(json)
399 expect(jsonObj.items.length).to.be.equal(1)
400 expect(jsonObj.items[0].attachments).to.exist
401 expect(jsonObj.items[0].attachments.length).to.be.eq(4)
403 for (let i = 0; i < 4; i++) {
404 expect(jsonObj.items[0].attachments[i].mime_type).to.be.eq('application/x-bittorrent')
405 expect(jsonObj.items[0].attachments[i].size_in_bytes).to.be.greaterThan(0)
406 expect(jsonObj.items[0].attachments[i].url).to.exist
410 it('Should not display waiting live videos', async function () {
411 const { uuid } = await servers[0].live.create({
414 privacy: VideoPrivacy.PUBLIC,
415 channelId: rootChannelId
420 const json = await servers[0].feed.getJSON({ feed: 'videos', ignoreCache: true })
422 const jsonObj = JSON.parse(json)
423 expect(jsonObj.items.length).to.be.equal(2)
424 expect(jsonObj.items[0].title).to.equal('my super name for server 1')
425 expect(jsonObj.items[1].title).to.equal('user video')
428 it('Should display published live videos', async function () {
431 const ffmpeg = await servers[0].live.sendRTMPStreamInVideo({ videoId: liveId, copyCodecs: true, fixtureName: 'video_short.mp4' })
432 await servers[0].live.waitUntilPublished({ videoId: liveId })
434 const json = await servers[0].feed.getJSON({ feed: 'videos', ignoreCache: true })
436 const jsonObj = JSON.parse(json)
437 expect(jsonObj.items.length).to.be.equal(3)
438 expect(jsonObj.items[0].title).to.equal('live')
439 expect(jsonObj.items[1].title).to.equal('my super name for server 1')
440 expect(jsonObj.items[2].title).to.equal('user video')
442 await stopFfmpeg(ffmpeg)
445 it('Should have the channel avatar as feed icon', async function () {
446 const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: rootChannelId }, ignoreCache: true })
448 const jsonObj = JSON.parse(json)
449 const imageUrl = jsonObj.icon
450 expect(imageUrl).to.include('/lazy-static/avatars/')
451 await makeRawRequest({ url: imageUrl, expectedStatus: HttpStatusCode.OK_200 })
456 describe('Video comments feed', function () {
458 it('Should contain valid comments (covers JSON feed 1.0 endpoint) and not from unlisted videos', async function () {
459 for (const server of servers) {
460 const json = await server.feed.getJSON({ feed: 'video-comments', ignoreCache: true })
462 const jsonObj = JSON.parse(json)
463 expect(jsonObj.items.length).to.be.equal(2)
464 expect(jsonObj.items[0].content_html).to.contain('<p>super comment 2</p>')
465 expect(jsonObj.items[1].content_html).to.contain('<p>super comment 1</p>')
469 it('Should not list comments from muted accounts or instances', async function () {
472 const remoteHandle = 'root@' + servers[0].host
474 await servers[1].blocklist.addToServerBlocklist({ account: remoteHandle })
477 const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
478 const jsonObj = JSON.parse(json)
479 expect(jsonObj.items.length).to.be.equal(0)
482 await servers[1].blocklist.removeFromServerBlocklist({ account: remoteHandle })
485 const videoUUID = (await servers[1].videos.quickUpload({ name: 'server 2' })).uuid
486 await waitJobs(servers)
487 await servers[0].comments.createThread({ videoId: videoUUID, text: 'super comment' })
488 await waitJobs(servers)
490 const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
491 const jsonObj = JSON.parse(json)
492 expect(jsonObj.items.length).to.be.equal(3)
495 await servers[1].blocklist.addToMyBlocklist({ account: remoteHandle })
498 const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
499 const jsonObj = JSON.parse(json)
500 expect(jsonObj.items.length).to.be.equal(2)
505 describe('Video feed from my subscriptions', function () {
506 let feeduserAccountId: number
507 let feeduserFeedToken: string
509 it('Should list no videos for a user with no videos and no subscriptions', async function () {
510 const attr = { username: 'feeduser', password: 'password' }
511 await servers[0].users.create({ username: attr.username, password: attr.password })
512 const feeduserAccessToken = await servers[0].login.getAccessToken(attr)
515 const user = await servers[0].users.getMyInfo({ token: feeduserAccessToken })
516 feeduserAccountId = user.account.id
520 const token = await servers[0].users.getMyScopedTokens({ token: feeduserAccessToken })
521 feeduserFeedToken = token.feedToken
525 const body = await servers[0].videos.listMySubscriptionVideos({ token: feeduserAccessToken })
526 expect(body.total).to.equal(0)
528 const query = { accountId: feeduserAccountId, token: feeduserFeedToken }
529 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
530 const jsonObj = JSON.parse(json)
531 expect(jsonObj.items.length).to.be.equal(0) // no subscription, it should not list the instance's videos but list 0 videos
535 it('Should fail with an invalid token', async function () {
536 const query = { accountId: feeduserAccountId, token: 'toto' }
537 await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
540 it('Should fail with a token of another user', async function () {
541 const query = { accountId: feeduserAccountId, token: userFeedToken }
542 await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
545 it('Should list no videos for a user with videos but no subscriptions', async function () {
546 const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
547 expect(body.total).to.equal(0)
549 const query = { accountId: userAccountId, token: userFeedToken }
550 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
551 const jsonObj = JSON.parse(json)
552 expect(jsonObj.items.length).to.be.equal(0) // no subscription, it should not list the instance's videos but list 0 videos
555 it('Should list self videos for a user with a subscription to themselves', async function () {
558 await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'john_channel@' + servers[0].host })
559 await waitJobs(servers)
562 const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
563 expect(body.total).to.equal(1)
564 expect(body.data[0].name).to.equal('user video')
566 const query = { accountId: userAccountId, token: userFeedToken }
567 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
568 const jsonObj = JSON.parse(json)
569 expect(jsonObj.items.length).to.be.equal(1) // subscribed to self, it should not list the instance's videos but list john's
573 it('Should list videos of a user\'s subscription', async function () {
576 await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'root_channel@' + servers[0].host })
577 await waitJobs(servers)
580 const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
581 expect(body.total).to.equal(2, 'there should be 2 videos part of the subscription')
583 const query = { accountId: userAccountId, token: userFeedToken }
584 const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
585 const jsonObj = JSON.parse(json)
586 expect(jsonObj.items.length).to.be.equal(2) // subscribed to root, it should not list the instance's videos but list root/john's
590 it('Should renew the token, and so have an invalid old token', async function () {
591 await servers[0].users.renewMyScopedTokens({ token: userAccessToken })
593 const query = { accountId: userAccountId, token: userFeedToken }
594 await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
597 it('Should succeed with the new token', async function () {
598 const token = await servers[0].users.getMyScopedTokens({ token: userAccessToken })
599 userFeedToken = token.feedToken
601 const query = { accountId: userAccountId, token: userFeedToken }
602 await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
607 after(async function () {
608 await servers[0].plugins.uninstall({ npmName: 'peertube-plugin-test-podcast-custom-tags' })
610 await cleanupTests([ ...servers, serverHLSOnly ])