PeerTube/server/tests/client.ts

465 lines
19 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
2017-09-04 21:21:47 +02:00
import 'mocha'
import * as chai from 'chai'
import { omit } from 'lodash'
import { HttpStatusCode } from '@shared/core-utils/miscs/http-error-codes'
2021-07-07 11:51:09 +02:00
import { Account, HTMLServerConfig, ServerConfig, VideoPlaylistCreateResult, VideoPlaylistPrivacy } from '@shared/models'
2017-09-04 21:21:47 +02:00
import {
2019-04-24 15:10:37 +02:00
cleanupTests,
doubleFollow,
2021-07-16 09:47:51 +02:00
createMultipleServers,
makeGetRequest,
2018-08-03 16:23:45 +02:00
makeHTMLRequest,
2021-07-16 09:47:51 +02:00
PeerTubeServer,
setAccessTokensToServers,
2020-07-31 13:13:02 +02:00
setDefaultVideoChannel,
waitJobs
} from '../../shared/extra-utils'
2018-08-03 16:23:45 +02:00
const expect = chai.expect
2018-07-23 11:28:27 +02:00
2021-05-14 12:04:44 +02:00
function checkIndexTags (html: string, title: string, description: string, css: string, config: ServerConfig) {
2018-07-23 11:28:27 +02:00
expect(html).to.contain('<title>' + title + '</title>')
expect(html).to.contain('<meta name="description" content="' + description + '" />')
expect(html).to.contain('<style class="custom-css-style">' + css + '</style>')
2021-05-14 12:04:44 +02:00
const htmlConfig: HTMLServerConfig = omit(config, 'signup')
expect(html).to.contain(`<script type="application/javascript">window.PeerTubeServerConfig = '${JSON.stringify(htmlConfig)}'</script>`)
2018-07-23 11:28:27 +02:00
}
2017-09-04 21:21:47 +02:00
describe('Test a client controllers', function () {
2021-07-16 09:47:51 +02:00
let servers: PeerTubeServer[] = []
2020-07-31 13:13:02 +02:00
let account: Account
const videoName = 'my super name for server 1'
const videoDescription = 'my<br> super __description__ for *server* 1<p></p>'
const videoDescriptionPlainText = 'my super description for server 1'
2020-07-31 13:13:02 +02:00
const playlistName = 'super playlist name'
const playlistDescription = 'super playlist description'
let playlist: VideoPlaylistCreateResult
2020-07-31 13:13:02 +02:00
const channelDescription = 'my super channel description'
2017-09-04 21:21:47 +02:00
const watchVideoBasePaths = [ '/videos/watch/', '/w/' ]
const watchPlaylistBasePaths = [ '/videos/watch/playlist/', '/w/p/' ]
let videoIds: (string | number)[] = []
let playlistIds: (string | number)[] = []
2017-09-04 21:21:47 +02:00
before(async function () {
this.timeout(120000)
2021-07-16 09:47:51 +02:00
servers = await createMultipleServers(2)
await setAccessTokensToServers(servers)
await doubleFollow(servers[0], servers[1])
await setDefaultVideoChannel(servers)
2017-09-04 21:21:47 +02:00
2021-07-16 09:04:35 +02:00
await servers[0].channels.update({
channelName: servers[0].store.channel.name,
2021-07-09 11:21:30 +02:00
attributes: { description: channelDescription }
})
2020-07-31 13:13:02 +02:00
// Video
2021-07-15 10:02:54 +02:00
{
const attributes = { name: videoName, description: videoDescription }
2021-07-16 09:04:35 +02:00
await servers[0].videos.upload({ attributes })
2017-09-04 21:21:47 +02:00
2021-07-16 09:04:35 +02:00
const { data } = await servers[0].videos.list()
2021-07-15 10:02:54 +02:00
expect(data.length).to.equal(1)
2017-09-04 21:21:47 +02:00
2021-07-15 10:02:54 +02:00
const video = data[0]
2021-07-16 09:04:35 +02:00
servers[0].store.video = video
2021-07-15 10:02:54 +02:00
videoIds = [ video.id, video.uuid, video.shortUUID ]
}
// Playlist
2021-07-15 10:02:54 +02:00
{
const attributes = {
displayName: playlistName,
description: playlistDescription,
privacy: VideoPlaylistPrivacy.PUBLIC,
2021-07-16 09:04:35 +02:00
videoChannelId: servers[0].store.channel.id
2021-07-15 10:02:54 +02:00
}
2021-07-16 09:04:35 +02:00
playlist = await servers[0].playlists.create({ attributes })
2021-07-15 10:02:54 +02:00
playlistIds = [ playlist.id, playlist.shortUUID, playlist.uuid ]
2021-07-16 09:04:35 +02:00
await servers[0].playlists.addElement({ playlistId: playlist.shortUUID, attributes: { videoId: servers[0].store.video.id } })
2021-07-15 10:02:54 +02:00
}
// Account
2021-07-15 10:02:54 +02:00
{
2021-07-16 09:04:35 +02:00
await servers[0].users.updateMe({ description: 'my account description' })
2021-07-16 09:04:35 +02:00
account = await servers[0].accounts.get({ accountName: `${servers[0].store.user.username}@${servers[0].host}` })
2021-07-15 10:02:54 +02:00
}
await waitJobs(servers)
2017-09-04 21:21:47 +02:00
})
2020-08-05 15:35:58 +02:00
describe('oEmbed', function () {
2020-08-05 15:35:58 +02:00
it('Should have valid oEmbed discovery tags for videos', async function () {
for (const basePath of watchVideoBasePaths) {
for (const id of videoIds) {
const res = await makeGetRequest({
url: servers[0].url,
path: basePath + id,
accept: 'text/html',
statusCodeExpected: HttpStatusCode.OK_200
})
2017-09-04 21:21:47 +02:00
const port = servers[0].port
2017-09-04 21:21:47 +02:00
const expectedLink = '<link rel="alternate" type="application/json+oembed" href="http://localhost:' + port + '/services/oembed?' +
2021-07-16 09:04:35 +02:00
`url=http%3A%2F%2Flocalhost%3A${port}%2Fw%2F${servers[0].store.video.uuid}" ` +
`title="${servers[0].store.video.name}" />`
expect(res.text).to.contain(expectedLink)
}
}
2020-08-05 15:35:58 +02:00
})
2020-08-05 15:35:58 +02:00
it('Should have valid oEmbed discovery tags for a playlist', async function () {
for (const basePath of watchPlaylistBasePaths) {
for (const id of playlistIds) {
const res = await makeGetRequest({
url: servers[0].url,
path: basePath + id,
accept: 'text/html',
statusCodeExpected: HttpStatusCode.OK_200
})
2020-08-05 15:35:58 +02:00
const port = servers[0].port
const expectedLink = '<link rel="alternate" type="application/json+oembed" href="http://localhost:' + port + '/services/oembed?' +
`url=http%3A%2F%2Flocalhost%3A${port}%2Fw%2Fp%2F${playlist.uuid}" ` +
`title="${playlistName}" />`
expect(res.text).to.contain(expectedLink)
}
}
2020-08-05 15:35:58 +02:00
})
})
2020-08-05 15:35:58 +02:00
describe('Open Graph', function () {
async function accountPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain(`<meta property="og:title" content="${account.displayName}" />`)
expect(text).to.contain(`<meta property="og:description" content="${account.description}" />`)
expect(text).to.contain('<meta property="og:type" content="website" />')
2021-07-16 09:04:35 +02:00
expect(text).to.contain(`<meta property="og:url" content="${servers[0].url}/accounts/${servers[0].store.user.username}" />`)
}
async function channelPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
2017-09-04 21:21:47 +02:00
2021-07-16 09:04:35 +02:00
expect(text).to.contain(`<meta property="og:title" content="${servers[0].store.channel.displayName}" />`)
expect(text).to.contain(`<meta property="og:description" content="${channelDescription}" />`)
expect(text).to.contain('<meta property="og:type" content="website" />')
2021-07-16 09:04:35 +02:00
expect(text).to.contain(`<meta property="og:url" content="${servers[0].url}/video-channels/${servers[0].store.channel.name}" />`)
}
async function watchVideoPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain(`<meta property="og:title" content="${videoName}" />`)
expect(text).to.contain(`<meta property="og:description" content="${videoDescriptionPlainText}" />`)
expect(text).to.contain('<meta property="og:type" content="video" />')
2021-07-16 09:04:35 +02:00
expect(text).to.contain(`<meta property="og:url" content="${servers[0].url}/w/${servers[0].store.video.uuid}" />`)
}
async function watchPlaylistPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain(`<meta property="og:title" content="${playlistName}" />`)
expect(text).to.contain(`<meta property="og:description" content="${playlistDescription}" />`)
expect(text).to.contain('<meta property="og:type" content="video" />')
expect(text).to.contain(`<meta property="og:url" content="${servers[0].url}/w/p/${playlist.uuid}" />`)
}
it('Should have valid Open Graph tags on the account page', async function () {
2021-07-16 09:04:35 +02:00
await accountPageTest('/accounts/' + servers[0].store.user.username)
await accountPageTest('/a/' + servers[0].store.user.username)
await accountPageTest('/@' + servers[0].store.user.username)
2020-08-05 15:35:58 +02:00
})
2017-10-16 10:05:49 +02:00
2020-08-05 15:35:58 +02:00
it('Should have valid Open Graph tags on the channel page', async function () {
2021-07-16 09:04:35 +02:00
await channelPageTest('/video-channels/' + servers[0].store.channel.name)
await channelPageTest('/c/' + servers[0].store.channel.name)
await channelPageTest('/@' + servers[0].store.channel.name)
2020-08-05 15:35:58 +02:00
})
2017-10-16 10:05:49 +02:00
it('Should have valid Open Graph tags on the watch page', async function () {
for (const path of watchVideoBasePaths) {
for (const id of videoIds) {
await watchVideoPageTest(path + id)
}
}
2020-08-05 15:35:58 +02:00
})
2020-08-05 15:35:58 +02:00
it('Should have valid Open Graph tags on the watch playlist page', async function () {
for (const path of watchPlaylistBasePaths) {
for (const id of playlistIds) {
await watchPlaylistPageTest(path + id)
}
}
2020-08-05 15:35:58 +02:00
})
})
2020-08-05 15:35:58 +02:00
describe('Twitter card', async function () {
describe('Not whitelisted', function () {
async function accountPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="summary" />')
expect(text).to.contain('<meta property="twitter:site" content="@Chocobozzz" />')
expect(text).to.contain(`<meta property="twitter:title" content="${account.name}" />`)
expect(text).to.contain(`<meta property="twitter:description" content="${account.description}" />`)
}
async function channelPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="summary" />')
expect(text).to.contain('<meta property="twitter:site" content="@Chocobozzz" />')
2021-07-16 09:04:35 +02:00
expect(text).to.contain(`<meta property="twitter:title" content="${servers[0].store.channel.displayName}" />`)
expect(text).to.contain(`<meta property="twitter:description" content="${channelDescription}" />`)
}
async function watchVideoPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="summary_large_image" />')
expect(text).to.contain('<meta property="twitter:site" content="@Chocobozzz" />')
expect(text).to.contain(`<meta property="twitter:title" content="${videoName}" />`)
expect(text).to.contain(`<meta property="twitter:description" content="${videoDescriptionPlainText}" />`)
}
async function watchPlaylistPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="summary" />')
expect(text).to.contain('<meta property="twitter:site" content="@Chocobozzz" />')
expect(text).to.contain(`<meta property="twitter:title" content="${playlistName}" />`)
expect(text).to.contain(`<meta property="twitter:description" content="${playlistDescription}" />`)
}
it('Should have valid twitter card on the watch video page', async function () {
for (const path of watchVideoBasePaths) {
for (const id of videoIds) {
await watchVideoPageTest(path + id)
}
}
})
it('Should have valid twitter card on the watch playlist page', async function () {
for (const path of watchPlaylistBasePaths) {
for (const id of playlistIds) {
await watchPlaylistPageTest(path + id)
}
}
})
it('Should have valid twitter card on the account page', async function () {
await accountPageTest('/accounts/' + account.name)
await accountPageTest('/a/' + account.name)
await accountPageTest('/@' + account.name)
})
it('Should have valid twitter card on the channel page', async function () {
2021-07-16 09:04:35 +02:00
await channelPageTest('/video-channels/' + servers[0].store.channel.name)
await channelPageTest('/c/' + servers[0].store.channel.name)
await channelPageTest('/@' + servers[0].store.channel.name)
})
2020-08-05 15:35:58 +02:00
})
describe('Whitelisted', function () {
before(async function () {
2021-07-16 09:04:35 +02:00
const config = await servers[0].config.getCustomConfig()
config.services.twitter = {
username: '@Kuja',
whitelisted: true
}
2021-07-16 09:04:35 +02:00
await servers[0].config.updateCustomConfig({ newCustomConfig: config })
})
async function accountPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="summary" />')
expect(text).to.contain('<meta property="twitter:site" content="@Kuja" />')
}
async function channelPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="summary" />')
expect(text).to.contain('<meta property="twitter:site" content="@Kuja" />')
}
async function watchVideoPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
2020-08-05 15:35:58 +02:00
expect(text).to.contain('<meta property="twitter:card" content="player" />')
expect(text).to.contain('<meta property="twitter:site" content="@Kuja" />')
}
async function watchPlaylistPageTest (path: string) {
const res = await makeGetRequest({ url: servers[0].url, path, accept: 'text/html', statusCodeExpected: HttpStatusCode.OK_200 })
const text = res.text
expect(text).to.contain('<meta property="twitter:card" content="player" />')
expect(text).to.contain('<meta property="twitter:site" content="@Kuja" />')
}
it('Should have valid twitter card on the watch video page', async function () {
for (const path of watchVideoBasePaths) {
for (const id of videoIds) {
await watchVideoPageTest(path + id)
}
}
})
it('Should have valid twitter card on the watch playlist page', async function () {
for (const path of watchPlaylistBasePaths) {
for (const id of playlistIds) {
await watchPlaylistPageTest(path + id)
}
}
})
it('Should have valid twitter card on the account page', async function () {
await accountPageTest('/accounts/' + account.name)
await accountPageTest('/a/' + account.name)
await accountPageTest('/@' + account.name)
})
it('Should have valid twitter card on the channel page', async function () {
2021-07-16 09:04:35 +02:00
await channelPageTest('/video-channels/' + servers[0].store.channel.name)
await channelPageTest('/c/' + servers[0].store.channel.name)
await channelPageTest('/@' + servers[0].store.channel.name)
})
2020-08-05 15:35:58 +02:00
})
2018-07-23 11:28:27 +02:00
})
2020-08-05 15:35:58 +02:00
describe('Index HTML', function () {
it('Should have valid index html tags (title, description...)', async function () {
2021-07-16 09:04:35 +02:00
const config = await servers[0].config.getConfig()
const res = await makeHTMLRequest(servers[0].url, '/videos/trending')
2020-08-05 15:35:58 +02:00
const description = 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
2021-07-07 11:51:09 +02:00
checkIndexTags(res.text, 'PeerTube', description, '', config)
2018-08-03 16:23:45 +02:00
})
2018-07-23 11:28:27 +02:00
2020-08-05 15:35:58 +02:00
it('Should update the customized configuration and have the correct index html tags', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].config.updateCustomSubConfig({
2021-07-07 11:51:09 +02:00
newConfig: {
instance: {
name: 'PeerTube updated',
shortDescription: 'my short description',
description: 'my super description',
terms: 'my super terms',
defaultNSFWPolicy: 'blur',
defaultClientRoute: '/videos/recently-added',
customizations: {
javascript: 'alert("coucou")',
css: 'body { background-color: red; }'
}
2020-08-05 15:35:58 +02:00
}
}
})
2018-07-23 11:28:27 +02:00
2021-07-16 09:04:35 +02:00
const config = await servers[0].config.getConfig()
const res = await makeHTMLRequest(servers[0].url, '/videos/trending')
2020-08-05 15:35:58 +02:00
2021-07-07 11:51:09 +02:00
checkIndexTags(res.text, 'PeerTube updated', 'my short description', 'body { background-color: red; }', config)
2020-08-05 15:35:58 +02:00
})
2018-07-23 11:28:27 +02:00
2020-08-05 15:35:58 +02:00
it('Should have valid index html updated tags (title, description...)', async function () {
2021-07-16 09:04:35 +02:00
const config = await servers[0].config.getConfig()
const res = await makeHTMLRequest(servers[0].url, '/videos/trending')
2018-07-23 11:28:27 +02:00
2021-07-07 11:51:09 +02:00
checkIndexTags(res.text, 'PeerTube updated', 'my short description', 'body { background-color: red; }', config)
2020-08-05 15:35:58 +02:00
})
it('Should use the original video URL for the canonical tag', async function () {
for (const basePath of watchVideoBasePaths) {
for (const id of videoIds) {
const res = await makeHTMLRequest(servers[1].url, basePath + id)
2021-07-16 09:04:35 +02:00
expect(res.text).to.contain(`<link rel="canonical" href="${servers[0].url}/videos/watch/${servers[0].store.video.uuid}" />`)
}
}
})
it('Should use the original account URL for the canonical tag', async function () {
2021-07-07 11:51:09 +02:00
const accountURLtest = res => {
expect(res.text).to.contain(`<link rel="canonical" href="${servers[0].url}/accounts/root" />`)
}
accountURLtest(await makeHTMLRequest(servers[1].url, '/accounts/root@' + servers[0].host))
accountURLtest(await makeHTMLRequest(servers[1].url, '/a/root@' + servers[0].host))
accountURLtest(await makeHTMLRequest(servers[1].url, '/@root@' + servers[0].host))
})
it('Should use the original channel URL for the canonical tag', async function () {
2021-07-07 11:51:09 +02:00
const channelURLtests = res => {
expect(res.text).to.contain(`<link rel="canonical" href="${servers[0].url}/video-channels/root_channel" />`)
}
channelURLtests(await makeHTMLRequest(servers[1].url, '/video-channels/root_channel@' + servers[0].host))
channelURLtests(await makeHTMLRequest(servers[1].url, '/c/root_channel@' + servers[0].host))
channelURLtests(await makeHTMLRequest(servers[1].url, '/@root_channel@' + servers[0].host))
})
it('Should use the original playlist URL for the canonical tag', async function () {
for (const basePath of watchPlaylistBasePaths) {
for (const id of playlistIds) {
const res = await makeHTMLRequest(servers[1].url, basePath + id)
expect(res.text).to.contain(`<link rel="canonical" href="${servers[0].url}/video-playlists/${playlist.uuid}" />`)
}
}
})
2018-07-23 11:28:27 +02:00
})
2021-05-14 12:04:44 +02:00
describe('Embed HTML', function () {
it('Should have the correct embed html tags', async function () {
2021-07-16 09:04:35 +02:00
const config = await servers[0].config.getConfig()
const res = await makeHTMLRequest(servers[0].url, servers[0].store.video.embedPath)
2021-05-14 12:04:44 +02:00
2021-07-07 11:51:09 +02:00
checkIndexTags(res.text, 'PeerTube updated', 'my short description', 'body { background-color: red; }', config)
2021-05-14 12:04:44 +02:00
})
})
2019-04-24 15:10:37 +02:00
after(async function () {
await cleanupTests(servers)
2017-09-04 21:21:47 +02:00
})
})