ActivityPub-federated video streaming platform using P2P directly in your web browser
/* oxlint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import { HttpStatusCode, VideoPrivacy } from '@peertube/peertube-models'
import { areMockObjectStorageTestsDisabled } from '@peertube/peertube-node-utils'
import {
cleanupTests,
ConfigCommand,
createMultipleServers,
createSingleServer,
doubleFollow,
makeGetRequest,
makePostBodyRequest,
makeRawRequest,
ObjectStorageCommand,
PeerTubeServer,
PluginsCommand,
setAccessTokensToServers,
waitJobs
} from '@peertube/peertube-server-commands'
import { MockSmtpServer } from '@tests/shared/mock-servers/mock-email.js'
import { checkVideoFilesWereRemoved } from '@tests/shared/videos.js'
import { expect } from 'chai'
import { pathExists } from 'fs-extra/esm'
function postCommand (server: PeerTubeServer, command: string, bodyArg?: object) {
const body = { command }
if (bodyArg) Object.assign(body, bodyArg)
return makePostBodyRequest({
url: server.url,
path: '/plugins/test-four/router/commander',
fields: body,
expectedStatus: HttpStatusCode.NO_CONTENT_204
})
}
describe('Test plugin helpers', function () {
let servers: PeerTubeServer[]
const emails: object[] = []
before(async function () {
this.timeout(60000)
const emailPort = await MockSmtpServer.Instance.collectEmails(emails)
servers = await createMultipleServers(2, ConfigCommand.getEmailOverrideConfig(emailPort))
await setAccessTokensToServers(servers)
await doubleFollow(servers[0], servers[1])
await servers[0].plugins.install({ path: PluginsCommand.getPluginTestPath('-four') })
})
describe('Logger', function () {
it('Should have logged things', async function () {
await servers[0].servers.waitUntilLog(servers[0].host + ' peertube-plugin-test-four', 1, false)
await servers[0].servers.waitUntilLog('Hello world from plugin four', 1)
})
})
describe('Database', function () {
it('Should have made a query', async function () {
await servers[0].servers.waitUntilLog(`root email is admin${servers[0].internalServerNumber}@example.com`)
})
})
describe('Config', function () {
it('Should have the correct webserver url', async function () {
await servers[0].servers.waitUntilLog(`server url is ${servers[0].url}`)
})
it('Should have the correct listening config', async function () {
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/server-listening-config',
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.config).to.exist
expect(res.body.config.hostname).to.equal('::')
expect(res.body.config.port).to.equal(servers[0].port)
})
it('Should have the correct config', async function () {
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/server-config',
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.serverConfig).to.exist
expect(res.body.serverConfig.instance.name).to.equal('PeerTube')
})
})
describe('Server', function () {
it('Should get the server actor', async function () {
await servers[0].servers.waitUntilLog('server actor name is peertube')
})
})
describe('Socket', function () {
it('Should sendNotification without any exceptions', async () => {
const user = await servers[0].users.create({ username: 'notis_redding', password: 'secret1234?' })
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/send-notification',
fields: {
userId: user.id
},
expectedStatus: HttpStatusCode.CREATED_201
})
})
it('Should sendVideoLiveNewState without any exceptions', async () => {
const res = await servers[0].videos.quickUpload({ name: 'video server 1' })
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/send-video-live-new-state/' + res.uuid,
expectedStatus: HttpStatusCode.CREATED_201
})
await servers[0].videos.remove({ id: res.uuid })
})
})
describe('Email', function () {
it('Should send an email', async function () {
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/send-email',
fields: {
to: '[email protected]',
subject: 'Email sent by a plugin',
text: 'Hello from plugin four'
},
expectedStatus: HttpStatusCode.CREATED_201
})
await waitJobs(servers)
expect(emails).to.have.lengthOf(1)
const email = emails[0]
expect(email['to'][0]['address']).to.equal('[email protected]')
expect(email['subject']).to.contain('Email sent by a plugin')
expect(email['text']).to.contain('Hello from plugin four')
// No title provided, so the subject is used as the HTML heading
expect(email['html']).to.contain('Email sent by a plugin')
})
it('Should send an email with a custom title', async function () {
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/send-email',
fields: {
to: '[email protected]',
subject: 'Email sent by a plugin',
title: 'Custom email title',
text: 'Hello from plugin four'
},
expectedStatus: HttpStatusCode.CREATED_201
})
await waitJobs(servers)
expect(emails).to.have.lengthOf(2)
const email = emails[1]
expect(email['to'][0]['address']).to.equal('[email protected]')
expect(email['subject']).to.contain('Email sent by a plugin')
expect(email['text']).to.contain('Hello from plugin four')
// The custom title is used as the HTML heading, not the subject
expect(email['html']).to.contain('Custom email title')
})
})
describe('Plugin', function () {
it('Should get the base static route', async function () {
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/static-route',
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.staticRoute).to.equal('/plugins/test-four/0.0.1/static/')
})
it('Should get the base static route', async function () {
const baseRouter = '/plugins/test-four/0.0.1/router/'
const res = await makeGetRequest({
url: servers[0].url,
path: baseRouter + 'router-route',
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.routerRoute).to.equal(baseRouter)
})
})
describe('User', function () {
let rootId: number
it('Should not get a user if not authenticated', async function () {
await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/user',
expectedStatus: HttpStatusCode.NOT_FOUND_404
})
})
it('Should get a user if authenticated', async function () {
const res = await makeGetRequest({
url: servers[0].url,
token: servers[0].accessToken,
path: '/plugins/test-four/router/user',
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.username).to.equal('root')
expect(res.body.displayName).to.equal('root')
expect(res.body.isAdmin).to.be.true
expect(res.body.isModerator).to.be.false
expect(res.body.isUser).to.be.false
rootId = res.body.id
})
it('Should load a user by id', async function () {
{
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/user/' + rootId,
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.username).to.equal('root')
}
{
await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/user/42',
expectedStatus: HttpStatusCode.NOT_FOUND_404
})
}
})
})
describe('Moderation', function () {
let videoUUIDServer1: string
before(async function () {
this.timeout(60000)
{
const res = await servers[0].videos.quickUpload({ name: 'video server 1' })
videoUUIDServer1 = res.uuid
}
{
await servers[1].videos.quickUpload({ name: 'video server 2' })
}
await waitJobs(servers)
const { data } = await servers[0].videos.list()
expect(data).to.have.lengthOf(2)
})
it('Should mute server 2', async function () {
await postCommand(servers[0], 'blockServer', { hostToBlock: servers[1].host })
const { data } = await servers[0].videos.list()
expect(data).to.have.lengthOf(1)
expect(data[0].name).to.equal('video server 1')
})
it('Should unmute server 2', async function () {
await postCommand(servers[0], 'unblockServer', { hostToUnblock: servers[1].host })
const { data } = await servers[0].videos.list()
expect(data).to.have.lengthOf(2)
})
it('Should mute account of server 2', async function () {
await postCommand(servers[0], 'blockAccount', { handleToBlock: `root@${servers[1].host}` })
const { data } = await servers[0].videos.list()
expect(data).to.have.lengthOf(1)
expect(data[0].name).to.equal('video server 1')
})
it('Should unmute account of server 2', async function () {
await postCommand(servers[0], 'unblockAccount', { handleToUnblock: `root@${servers[1].host}` })
const { data } = await servers[0].videos.list()
expect(data).to.have.lengthOf(2)
})
it('Should blacklist video', async function () {
await postCommand(servers[0], 'blacklist', { videoUUID: videoUUIDServer1, unfederate: true })
await waitJobs(servers)
for (const server of servers) {
const { data } = await server.videos.list()
expect(data).to.have.lengthOf(1)
expect(data[0].name).to.equal('video server 2')
}
})
it('Should unblacklist video', async function () {
await postCommand(servers[0], 'unblacklist', { videoUUID: videoUUIDServer1 })
await waitJobs(servers)
for (const server of servers) {
const { data } = await server.videos.list()
expect(data).to.have.lengthOf(2)
}
})
})
describe('Videos', function () {
let videoUUID: string
let videoPath: string
before(async function () {
this.timeout(240000)
await servers[0].config.enableTranscoding({ webVideo: true, hls: true, resolutions: 'max' })
const res = await servers[0].videos.quickUpload({ name: 'video1' })
videoUUID = res.uuid
await waitJobs(servers)
})
it('Should get video files', async function () {
const { body } = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/video-files/' + videoUUID,
expectedStatus: HttpStatusCode.OK_200
})
// Video files check
{
expect(body.webVideo.videoFiles).to.be.an('array')
expect(body.hls.videoFiles).to.be.an('array')
for (const resolution of [ 144, 240, 360, 480, 720 ]) {
for (const files of [ body.webVideo.videoFiles, body.hls.videoFiles ]) {
const file = files.find(f => f.resolution === resolution)
expect(file).to.exist
expect(file.size).to.be.a('number')
expect(file.fps).to.equal(25)
expect(await pathExists(file.path)).to.be.true
await makeRawRequest({ url: file.url, expectedStatus: HttpStatusCode.OK_200 })
}
}
videoPath = body.webVideo.videoFiles[0].path
}
// Thumbnails check
{
expect(body.thumbnails).to.be.an('array')
const miniature = body.thumbnails.find(t => t.type === 1)
expect(miniature).to.exist
expect(miniature.width).to.equal(280)
expect(miniature.height).to.equal(157)
expect(await pathExists(miniature.path)).to.be.true
await makeRawRequest({ url: miniature.url, expectedStatus: HttpStatusCode.OK_200 })
const preview = body.thumbnails.find(t => t.type === 2 && t.width === 850 && t.height === 480)
expect(preview).to.exist
expect(await pathExists(preview.path)).to.be.true
await makeRawRequest({ url: preview.url, expectedStatus: HttpStatusCode.OK_200 })
}
})
it('Should provide a locked video file to the plugin (local storage)', async function () {
const { body: filesBody } = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/video-files/' + videoUUID,
expectedStatus: HttpStatusCode.OK_200
})
for (const file of [ ...filesBody.webVideo.videoFiles, ...filesBody.hls.videoFiles ]) {
const { body } = await makeGetRequest({
url: servers[0].url,
path: `/plugins/test-four/router/with-file/${videoUUID}/${file.id}`,
expectedStatus: HttpStatusCode.OK_200
})
expect(body.path).to.equal(file.path)
expect(body.streamsLength).to.equal(2)
expect(body.existsDuringCallback).to.be.true
// Local storage files are not cleaned up after the plugin used them
expect(body.existsAfterCallback).to.be.true
expect(await pathExists(body.path)).to.be.true
}
})
it('Should return 404 when the video file does not belong to the video', async function () {
const { uuid: otherUUID } = await servers[0].videos.quickUpload({ name: 'other video' })
await waitJobs(servers)
const { body: filesBody } = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/video-files/' + videoUUID,
expectedStatus: HttpStatusCode.OK_200
})
const fileId = filesBody.webVideo.videoFiles[0].id
await makeGetRequest({
url: servers[0].url,
path: `/plugins/test-four/router/with-file/${otherUUID}/${fileId}`,
expectedStatus: HttpStatusCode.NOT_FOUND_404
})
})
it('Should probe a file', async function () {
const { body } = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/ffprobe',
query: {
path: videoPath
},
expectedStatus: HttpStatusCode.OK_200
})
expect(body.streams).to.be.an('array')
expect(body.streams).to.have.lengthOf(2)
})
it('Should update a video', async function () {
const { uuid } = await servers[0].videos.quickUpload({
name: 'video to update',
privacy: VideoPrivacy.PRIVATE,
nsfw: false
})
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/update-video/' + uuid,
fields: {
name: 'video1 updated by plugin',
support: 'support text updated by plugin',
nsfw: true,
privacy: VideoPrivacy.PUBLIC
},
expectedStatus: HttpStatusCode.NO_CONTENT_204
})
await waitJobs(servers)
for (const server of servers) {
const video = await server.videos.get({ id: uuid })
expect(video.name).to.equal('video1 updated by plugin')
expect(video.support).to.equal('support text updated by plugin')
expect(video.privacy.id).to.equal(VideoPrivacy.PUBLIC)
expect(video.nsfw).to.be.true
}
})
it('Should remove a video after a view', async function () {
this.timeout(40000)
// Should not throw -> video exists
const video = await servers[0].videos.get({ id: videoUUID })
// Should delete the video
await servers[0].views.simulateView({ id: videoUUID })
await servers[0].servers.waitUntilLog('Video deleted by plugin four.')
try {
// Should throw because the video should have been deleted
await servers[0].videos.get({ id: videoUUID })
throw new Error('Video exists')
} catch (err) {
if (err.message.includes('exists')) throw err
}
await checkVideoFilesWereRemoved({ server: servers[0], video })
})
it('Should have fetched the video by URL', async function () {
await servers[0].servers.waitUntilLog(`video from DB uuid is ${videoUUID}`)
})
})
after(async function () {
await cleanupTests(servers)
})
})
describe('Test plugin helpers videos.withFile with object storage', function () {
if (areMockObjectStorageTestsDisabled()) return
let server: PeerTubeServer
let videoUUID: string
const objectStorage = new ObjectStorageCommand()
before(async function () {
this.timeout(240000)
await objectStorage.prepareDefaultMockBuckets()
server = await createSingleServer(1, objectStorage.getDefaultMockConfig())
await setAccessTokensToServers([ server ])
await server.plugins.install({ path: PluginsCommand.getPluginTestPath('-four') })
await server.config.enableTranscoding({ webVideo: true, hls: true, resolutions: 'max' })
const res = await server.videos.quickUpload({ name: 'video1' })
videoUUID = res.uuid
await waitJobs([ server ])
})
it('Should provide a locked video file to the plugin, cleaning it up afterwards', async function () {
const { body: filesBody } = await makeGetRequest({
url: server.url,
path: '/plugins/test-four/router/video-files/' + videoUUID,
expectedStatus: HttpStatusCode.OK_200
})
// Object storage files do not have a local FS path
expect(filesBody.webVideo.videoFiles[0].path).to.be.null
expect(filesBody.hls.videoFiles[0].path).to.be.null
for (const file of [ ...filesBody.webVideo.videoFiles, ...filesBody.hls.videoFiles ]) {
const { body } = await makeGetRequest({
url: server.url,
path: `/plugins/test-four/router/with-file/${videoUUID}/${file.id}`,
expectedStatus: HttpStatusCode.OK_200
})
expect(body.path).to.be.a('string')
expect(body.streamsLength).to.equal(2)
expect(body.existsDuringCallback).to.be.true
// The file was downloaded from object storage to a tmp destination that must be cleaned up afterwards
expect(body.existsAfterCallback).to.be.false
expect(await pathExists(body.path)).to.be.false
}
})
after(async function () {
await objectStorage.cleanupMock()
await cleanupTests([ server ])
})
})