/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import * as chai from 'chai'
-import 'mocha'
+import { XMLParser, XMLValidator } from 'fast-xml-parser'
+import { HttpStatusCode, VideoPrivacy } from '@shared/models'
import {
cleanupTests,
- createUser,
+ createMultipleServers,
+ createSingleServer,
doubleFollow,
- flushAndRunMultipleServers,
- getJSONfeed,
- getMyUserInformation,
- getXMLfeed,
- ServerInfo,
+ makeGetRequest,
+ makeRawRequest,
+ PeerTubeServer,
setAccessTokensToServers,
- uploadVideo,
- userLogin
-} from '../../../shared/extra-utils'
-import * as libxmljs from 'libxmljs'
-import { addVideoCommentThread } from '../../../shared/extra-utils/videos/video-comments'
-import { waitJobs } from '../../../shared/extra-utils/server/jobs'
-import { User } from '../../../shared/models/users'
+ setDefaultChannelAvatar,
+ stopFfmpeg,
+ waitJobs
+} from '@shared/server-commands'
chai.use(require('chai-xml'))
chai.use(require('chai-json-schema'))
chai.config.includeStack = true
+
const expect = chai.expect
describe('Test syndication feeds', () => {
- let servers: ServerInfo[] = []
+ let servers: PeerTubeServer[] = []
+ let serverHLSOnly: PeerTubeServer
let userAccessToken: string
let rootAccountId: number
let rootChannelId: number
let userAccountId: number
let userChannelId: number
+ let userFeedToken: string
+ let liveId: string
before(async function () {
this.timeout(120000)
// Run servers
- servers = await flushAndRunMultipleServers(2)
+ servers = await createMultipleServers(2)
+ serverHLSOnly = await createSingleServer(3, {
+ transcoding: {
+ enabled: true,
+ webtorrent: { enabled: false },
+ hls: { enabled: true }
+ }
+ })
- await setAccessTokensToServers(servers)
+ await setAccessTokensToServers([ ...servers, serverHLSOnly ])
+ await setDefaultChannelAvatar(servers[0])
await doubleFollow(servers[0], servers[1])
+ await servers[0].config.enableLive({ allowReplay: false, transcoding: false })
+
{
- const res = await getMyUserInformation(servers[0].url, servers[0].accessToken)
- const user: User = res.body
+ const user = await servers[0].users.getMyInfo()
rootAccountId = user.account.id
rootChannelId = user.videoChannels[0].id
}
{
- const attr = { username: 'john', password: 'password' }
- await createUser({ url: servers[0].url, accessToken: servers[0].accessToken, username: attr.username, password: attr.password })
- userAccessToken = await userLogin(servers[0], attr)
+ userAccessToken = await servers[0].users.generateUserAndToken('john')
- const res = await getMyUserInformation(servers[0].url, userAccessToken)
- const user: User = res.body
+ const user = await servers[0].users.getMyInfo({ token: userAccessToken })
userAccountId = user.account.id
userChannelId = user.videoChannels[0].id
+
+ const token = await servers[0].users.getMyScopedTokens({ token: userAccessToken })
+ userFeedToken = token.feedToken
}
{
- await uploadVideo(servers[0].url, userAccessToken, { name: 'user video' })
+ await servers[0].videos.upload({ token: userAccessToken, attributes: { name: 'user video' } })
}
{
- const videoAttributes = {
+ const attributes = {
name: 'my super name for server 1',
description: 'my super description for server 1',
fixture: 'video_short.webm'
}
- const res = await uploadVideo(servers[0].url, servers[0].accessToken, videoAttributes)
- const videoId = res.body.video.id
+ const { id } = await servers[0].videos.upload({ attributes })
- await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoId, 'super comment 1')
- await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoId, 'super comment 2')
+ await servers[0].comments.createThread({ videoId: id, text: 'super comment 1' })
+ await servers[0].comments.createThread({ videoId: id, text: 'super comment 2' })
+ }
+
+ {
+ const attributes = { name: 'unlisted video', privacy: VideoPrivacy.UNLISTED }
+ const { id } = await servers[0].videos.upload({ attributes })
+
+ await servers[0].comments.createThread({ videoId: id, text: 'comment on unlisted video' })
}
await waitJobs(servers)
it('Should be well formed XML (covers RSS 2.0 and ATOM 1.0 endpoints)', async function () {
for (const feed of [ 'video-comments' as 'video-comments', 'videos' as 'videos' ]) {
- const rss = await getXMLfeed(servers[0].url, feed)
- expect(rss.text).xml.to.be.valid()
+ const rss = await servers[0].feed.getXML({ feed, ignoreCache: true })
+ expect(rss).xml.to.be.valid()
- const atom = await getXMLfeed(servers[0].url, feed, 'atom')
- expect(atom.text).xml.to.be.valid()
+ const atom = await servers[0].feed.getXML({ feed, format: 'atom', ignoreCache: true })
+ expect(atom).xml.to.be.valid()
}
})
it('Should be well formed JSON (covers JSON feed 1.0 endpoint)', async function () {
for (const feed of [ 'video-comments' as 'video-comments', 'videos' as 'videos' ]) {
- const json = await getJSONfeed(servers[0].url, feed)
- expect(JSON.parse(json.text)).to.be.jsonSchema({ type: 'object' })
+ const jsonText = await servers[0].feed.getJSON({ feed, ignoreCache: true })
+ expect(JSON.parse(jsonText)).to.be.jsonSchema({ type: 'object' })
}
})
+
+ it('Should serve the endpoint with a classic request', async function () {
+ await makeGetRequest({
+ url: servers[0].url,
+ path: '/feeds/videos.xml',
+ accept: 'application/xml',
+ expectedStatus: HttpStatusCode.OK_200
+ })
+ })
+
+ it('Should serve the endpoint as a cached request', async function () {
+ const res = await makeGetRequest({
+ url: servers[0].url,
+ path: '/feeds/videos.xml',
+ accept: 'application/xml',
+ expectedStatus: HttpStatusCode.OK_200
+ })
+
+ expect(res.headers['x-api-cache-cached']).to.equal('true')
+ })
+
+ it('Should not serve the endpoint as a cached request', async function () {
+ const res = await makeGetRequest({
+ url: servers[0].url,
+ path: '/feeds/videos.xml?v=186',
+ accept: 'application/xml',
+ expectedStatus: HttpStatusCode.OK_200
+ })
+
+ expect(res.headers['x-api-cache-cached']).to.not.exist
+ })
+
+ it('Should refuse to serve the endpoint without accept header', async function () {
+ await makeGetRequest({ url: servers[0].url, path: '/feeds/videos.xml', expectedStatus: HttpStatusCode.NOT_ACCEPTABLE_406 })
+ })
})
describe('Videos feed', function () {
+
it('Should contain a valid enclosure (covers RSS 2.0 endpoint)', async function () {
for (const server of servers) {
- const rss = await getXMLfeed(server.url, 'videos')
- const xmlDoc = libxmljs.parseXmlString(rss.text)
- const xmlEnclosure = xmlDoc.get('/rss/channel/item/enclosure')
- expect(xmlEnclosure).to.exist
- expect(xmlEnclosure.attr('type').value()).to.be.equal('application/x-bittorrent')
- expect(xmlEnclosure.attr('length').value()).to.be.equal('218910')
- expect(xmlEnclosure.attr('url').value()).to.contain('720.torrent')
+ const rss = await server.feed.getXML({ feed: 'videos', ignoreCache: true })
+ expect(XMLValidator.validate(rss)).to.be.true
+
+ const parser = new XMLParser({ parseAttributeValue: true, ignoreAttributes: false })
+ const xmlDoc = parser.parse(rss)
+
+ const enclosure = xmlDoc.rss.channel.item[0].enclosure
+ expect(enclosure).to.exist
+
+ expect(enclosure['@_type']).to.equal('video/webm')
+ expect(enclosure['@_length']).to.equal(218910)
+ expect(enclosure['@_url']).to.contain('-720.webm')
}
})
it('Should contain a valid \'attachments\' object (covers JSON feed 1.0 endpoint)', async function () {
for (const server of servers) {
- const json = await getJSONfeed(server.url, 'videos')
- const jsonObj = JSON.parse(json.text)
+ const json = await server.feed.getJSON({ feed: 'videos', ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(2)
expect(jsonObj.items[0].attachments).to.exist
expect(jsonObj.items[0].attachments.length).to.be.eq(1)
it('Should filter by account', async function () {
{
- const json = await getJSONfeed(servers[0].url, 'videos', { accountId: rootAccountId })
- const jsonObj = JSON.parse(json.text)
+ const json = await servers[0].feed.getJSON({ feed: 'videos', query: { accountId: rootAccountId }, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('my super name for server 1')
- expect(jsonObj.items[0].author.name).to.equal('root')
+ expect(jsonObj.items[0].author.name).to.equal('Main root channel')
}
{
- const json = await getJSONfeed(servers[0].url, 'videos', { accountId: userAccountId })
- const jsonObj = JSON.parse(json.text)
+ const json = await servers[0].feed.getJSON({ feed: 'videos', query: { accountId: userAccountId }, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('user video')
- expect(jsonObj.items[0].author.name).to.equal('john')
+ expect(jsonObj.items[0].author.name).to.equal('Main john channel')
}
for (const server of servers) {
{
- const json = await getJSONfeed(server.url, 'videos', { accountName: 'root@localhost:' + servers[0].port })
- const jsonObj = JSON.parse(json.text)
+ const json = await server.feed.getJSON({ feed: 'videos', query: { accountName: 'root@' + servers[0].host }, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('my super name for server 1')
}
{
- const json = await getJSONfeed(server.url, 'videos', { accountName: 'john@localhost:' + servers[0].port })
- const jsonObj = JSON.parse(json.text)
+ const json = await server.feed.getJSON({ feed: 'videos', query: { accountName: 'john@' + servers[0].host }, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('user video')
}
it('Should filter by video channel', async function () {
{
- const json = await getJSONfeed(servers[0].url, 'videos', { videoChannelId: rootChannelId })
- const jsonObj = JSON.parse(json.text)
+ const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: rootChannelId }, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('my super name for server 1')
- expect(jsonObj.items[0].author.name).to.equal('root')
+ expect(jsonObj.items[0].author.name).to.equal('Main root channel')
}
{
- const json = await getJSONfeed(servers[0].url, 'videos', { videoChannelId: userChannelId })
- const jsonObj = JSON.parse(json.text)
+ const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: userChannelId }, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('user video')
- expect(jsonObj.items[0].author.name).to.equal('john')
+ expect(jsonObj.items[0].author.name).to.equal('Main john channel')
}
for (const server of servers) {
{
- const json = await getJSONfeed(server.url, 'videos', { videoChannelName: 'root_channel@localhost:' + servers[0].port })
- const jsonObj = JSON.parse(json.text)
+ const query = { videoChannelName: 'root_channel@' + servers[0].host }
+ const json = await server.feed.getJSON({ feed: 'videos', query, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('my super name for server 1')
}
{
- const json = await getJSONfeed(server.url, 'videos', { videoChannelName: 'john_channel@localhost:' + servers[0].port })
- const jsonObj = JSON.parse(json.text)
+ const query = { videoChannelName: 'john_channel@' + servers[0].host }
+ const json = await server.feed.getJSON({ feed: 'videos', query, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(1)
expect(jsonObj.items[0].title).to.equal('user video')
}
}
})
+
+ it('Should correctly have videos feed with HLS only', async function () {
+ this.timeout(120000)
+
+ await serverHLSOnly.videos.upload({ attributes: { name: 'hls only video' } })
+
+ await waitJobs([ serverHLSOnly ])
+
+ const json = await serverHLSOnly.feed.getJSON({ feed: 'videos', ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(1)
+ expect(jsonObj.items[0].attachments).to.exist
+ expect(jsonObj.items[0].attachments.length).to.be.eq(4)
+
+ for (let i = 0; i < 4; i++) {
+ expect(jsonObj.items[0].attachments[i].mime_type).to.be.eq('application/x-bittorrent')
+ expect(jsonObj.items[0].attachments[i].size_in_bytes).to.be.greaterThan(0)
+ expect(jsonObj.items[0].attachments[i].url).to.exist
+ }
+ })
+
+ it('Should not display waiting live videos', async function () {
+ const { uuid } = await servers[0].live.create({
+ fields: {
+ name: 'live',
+ privacy: VideoPrivacy.PUBLIC,
+ channelId: rootChannelId
+ }
+ })
+ liveId = uuid
+
+ const json = await servers[0].feed.getJSON({ feed: 'videos', ignoreCache: true })
+
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(2)
+ expect(jsonObj.items[0].title).to.equal('my super name for server 1')
+ expect(jsonObj.items[1].title).to.equal('user video')
+ })
+
+ it('Should display published live videos', async function () {
+ this.timeout(120000)
+
+ const ffmpeg = await servers[0].live.sendRTMPStreamInVideo({ videoId: liveId, copyCodecs: true, fixtureName: 'video_short.mp4' })
+ await servers[0].live.waitUntilPublished({ videoId: liveId })
+
+ const json = await servers[0].feed.getJSON({ feed: 'videos', ignoreCache: true })
+
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(3)
+ expect(jsonObj.items[0].title).to.equal('live')
+ expect(jsonObj.items[1].title).to.equal('my super name for server 1')
+ expect(jsonObj.items[2].title).to.equal('user video')
+
+ await stopFfmpeg(ffmpeg)
+ })
+
+ it('Should have the channel avatar as feed icon', async function () {
+ const json = await servers[0].feed.getJSON({ feed: 'videos', query: { videoChannelId: rootChannelId }, ignoreCache: true })
+
+ const jsonObj = JSON.parse(json)
+ const imageUrl = jsonObj.icon
+ expect(imageUrl).to.include('/lazy-static/avatars/')
+ await makeRawRequest({ url: imageUrl, expectedStatus: HttpStatusCode.OK_200 })
+ })
})
describe('Video comments feed', function () {
- it('Should contain valid comments (covers JSON feed 1.0 endpoint)', async function () {
+
+ it('Should contain valid comments (covers JSON feed 1.0 endpoint) and not from unlisted videos', async function () {
for (const server of servers) {
- const json = await getJSONfeed(server.url, 'video-comments')
+ const json = await server.feed.getJSON({ feed: 'video-comments', ignoreCache: true })
+
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(2)
+ expect(jsonObj.items[0].content_html).to.contain('<p>super comment 2</p>')
+ expect(jsonObj.items[1].content_html).to.contain('<p>super comment 1</p>')
+ }
+ })
+
+ it('Should not list comments from muted accounts or instances', async function () {
+ this.timeout(30000)
+
+ const remoteHandle = 'root@' + servers[0].host
+
+ await servers[1].blocklist.addToServerBlocklist({ account: remoteHandle })
- const jsonObj = JSON.parse(json.text)
+ {
+ const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(0)
+ }
+
+ await servers[1].blocklist.removeFromServerBlocklist({ account: remoteHandle })
+
+ {
+ const videoUUID = (await servers[1].videos.quickUpload({ name: 'server 2' })).uuid
+ await waitJobs(servers)
+ await servers[0].comments.createThread({ videoId: videoUUID, text: 'super comment' })
+ await waitJobs(servers)
+
+ const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(3)
+ }
+
+ await servers[1].blocklist.addToMyBlocklist({ account: remoteHandle })
+
+ {
+ const json = await servers[1].feed.getJSON({ feed: 'video-comments', ignoreCache: true })
+ const jsonObj = JSON.parse(json)
expect(jsonObj.items.length).to.be.equal(2)
- expect(jsonObj.items[0].html_content).to.equal('super comment 2')
- expect(jsonObj.items[1].html_content).to.equal('super comment 1')
}
})
})
+ describe('Video feed from my subscriptions', function () {
+ let feeduserAccountId: number
+ let feeduserFeedToken: string
+
+ it('Should list no videos for a user with no videos and no subscriptions', async function () {
+ const attr = { username: 'feeduser', password: 'password' }
+ await servers[0].users.create({ username: attr.username, password: attr.password })
+ const feeduserAccessToken = await servers[0].login.getAccessToken(attr)
+
+ {
+ const user = await servers[0].users.getMyInfo({ token: feeduserAccessToken })
+ feeduserAccountId = user.account.id
+ }
+
+ {
+ const token = await servers[0].users.getMyScopedTokens({ token: feeduserAccessToken })
+ feeduserFeedToken = token.feedToken
+ }
+
+ {
+ const body = await servers[0].videos.listMySubscriptionVideos({ token: feeduserAccessToken })
+ expect(body.total).to.equal(0)
+
+ const query = { accountId: feeduserAccountId, token: feeduserFeedToken }
+ const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(0) // no subscription, it should not list the instance's videos but list 0 videos
+ }
+ })
+
+ it('Should fail with an invalid token', async function () {
+ const query = { accountId: feeduserAccountId, token: 'toto' }
+ await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
+ })
+
+ it('Should fail with a token of another user', async function () {
+ const query = { accountId: feeduserAccountId, token: userFeedToken }
+ await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
+ })
+
+ it('Should list no videos for a user with videos but no subscriptions', async function () {
+ const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
+ expect(body.total).to.equal(0)
+
+ const query = { accountId: userAccountId, token: userFeedToken }
+ const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(0) // no subscription, it should not list the instance's videos but list 0 videos
+ })
+
+ it('Should list self videos for a user with a subscription to themselves', async function () {
+ this.timeout(30000)
+
+ await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'john_channel@' + servers[0].host })
+ await waitJobs(servers)
+
+ {
+ const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
+ expect(body.total).to.equal(1)
+ expect(body.data[0].name).to.equal('user video')
+
+ const query = { accountId: userAccountId, token: userFeedToken }
+ const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(1) // subscribed to self, it should not list the instance's videos but list john's
+ }
+ })
+
+ it('Should list videos of a user\'s subscription', async function () {
+ this.timeout(30000)
+
+ await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'root_channel@' + servers[0].host })
+ await waitJobs(servers)
+
+ {
+ const body = await servers[0].videos.listMySubscriptionVideos({ token: userAccessToken })
+ expect(body.total).to.equal(2, 'there should be 2 videos part of the subscription')
+
+ const query = { accountId: userAccountId, token: userFeedToken }
+ const json = await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
+ const jsonObj = JSON.parse(json)
+ expect(jsonObj.items.length).to.be.equal(2) // subscribed to root, it should not list the instance's videos but list root/john's
+ }
+ })
+
+ it('Should renew the token, and so have an invalid old token', async function () {
+ await servers[0].users.renewMyScopedTokens({ token: userAccessToken })
+
+ const query = { accountId: userAccountId, token: userFeedToken }
+ await servers[0].feed.getJSON({ feed: 'subscriptions', query, expectedStatus: HttpStatusCode.FORBIDDEN_403, ignoreCache: true })
+ })
+
+ it('Should succeed with the new token', async function () {
+ const token = await servers[0].users.getMyScopedTokens({ token: userAccessToken })
+ userFeedToken = token.feedToken
+
+ const query = { accountId: userAccountId, token: userFeedToken }
+ await servers[0].feed.getJSON({ feed: 'subscriptions', query, ignoreCache: true })
+ })
+
+ })
+
after(async function () {
- await cleanupTests(servers)
+ await cleanupTests([ ...servers, serverHLSOnly ])
})
})
projects / github / Chocobozzz / PeerTube.git / blobdiff