1
0
Fork 0
peertube/server/tests/api/videos/single-server.ts
kontrollanten f6d6e7f861
Resumable video uploads (#3933)
* WIP: resumable video uploads

relates to #324

* fix review comments

* video upload: error handling

* fix audio upload

* fixes after self review

* Update server/controllers/api/videos/index.ts

Co-authored-by: Rigel Kent <par@rigelk.eu>

* Update server/middlewares/validators/videos/videos.ts

Co-authored-by: Rigel Kent <par@rigelk.eu>

* Update server/controllers/api/videos/index.ts

Co-authored-by: Rigel Kent <par@rigelk.eu>

* update after code review

* refactor upload route

- restore multipart upload route
- move resumable to dedicated upload-resumable route
- move checks to middleware
- do not leak internal fs structure in response

* fix yarn.lock upon rebase

* factorize addVideo for reuse in both endpoints

* add resumable upload API to openapi spec

* add initial test and test helper for resumable upload

* typings for videoAddResumable middleware

* avoid including aws and google packages via node-uploadx, by only including uploadx/core

* rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio

* add video-upload-tmp-folder-cleaner job

* stronger typing of video upload middleware

* reduce dependency to @uploadx/core

* add audio upload test

* refactor resumable uploads cleanup from job to scheduler

* refactor resumable uploads scheduler to compare to last execution time

* make resumable upload validator to always cleanup on failure

* move legacy upload request building outside of uploadVideo test helper

* filter upload-resumable middlewares down to POST, PUT, DELETE

also begin to type metadata

* merge add duration functions

* stronger typings and documentation for uploadx behaviour, move init validator up

* refactor(client/video-edit): options > uploadxOptions

* refactor(client/video-edit): remove obsolete else

* scheduler/remove-dangling-resum: rename tag

* refactor(server/video): add UploadVideoFiles type

* refactor(mw/validators): restructure eslint disable

* refactor(mw/validators/videos): rename import

* refactor(client/vid-upload): rename html elem id

* refactor(sched/remove-dangl): move fn to method

* refactor(mw/async): add method typing

* refactor(mw/vali/video): double quote > single

* refactor(server/upload-resum): express use > all

* proper http methud enum server/middlewares/async.ts

* properly type http methods

* factorize common video upload validation steps

* add check for maximum partially uploaded file size

* fix audioBg use

* fix extname(filename) in addVideo

* document parameters for uploadx's resumable protocol

* clear META files in scheduler

* last audio refactor before cramming preview in the initial POST form data

* refactor as mulitpart/form-data initial post request

this allows preview/thumbnail uploads alongside the initial request,
and cleans up the upload form

* Add more tests for resumable uploads

* Refactor remove dangling resumable uploads

* Prepare changelog

* Add more resumable upload tests

* Remove user quota check for resumable uploads

* Fix upload error handler

* Update nginx template for upload-resumable

* Cleanup comment

* Remove unused express methods

* Prefer to use got instead of raw http

* Don't retry on error 500

Co-authored-by: Rigel Kent <par@rigelk.eu>
Co-authored-by: Rigel Kent <sendmemail@rigelk.eu>
Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 11:13:41 +02:00

502 lines
15 KiB
TypeScript

/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import 'mocha'
import * as chai from 'chai'
import { keyBy } from 'lodash'
import {
checkVideoFilesWereRemoved,
cleanupTests,
completeVideoCheck,
flushAndRunServer,
getVideo,
getVideoCategories,
getVideoLanguages,
getVideoLicences,
getVideoPrivacies,
getVideosList,
getVideosListPagination,
getVideosListSort,
getVideosWithFilters,
rateVideo,
removeVideo,
ServerInfo,
setAccessTokensToServers,
testImage,
updateVideo,
uploadVideo,
viewVideo,
wait
} from '../../../../shared/extra-utils'
import { VideoPrivacy } from '../../../../shared/models/videos'
import { HttpStatusCode } from '@shared/core-utils'
const expect = chai.expect
describe('Test a single server', function () {
function runSuite (mode: 'legacy' | 'resumable') {
let server: ServerInfo = null
let videoId = -1
let videoId2 = -1
let videoUUID = ''
let videosListBase: any[] = null
const getCheckAttributes = () => ({
name: 'my super name',
category: 2,
licence: 6,
language: 'zh',
nsfw: true,
description: 'my super description',
support: 'my super support text',
account: {
name: 'root',
host: 'localhost:' + server.port
},
isLocal: true,
duration: 5,
tags: [ 'tag1', 'tag2', 'tag3' ],
privacy: VideoPrivacy.PUBLIC,
commentsEnabled: true,
downloadEnabled: true,
channel: {
displayName: 'Main root channel',
name: 'root_channel',
description: '',
isLocal: true
},
fixture: 'video_short.webm',
files: [
{
resolution: 720,
size: 218910
}
]
})
const updateCheckAttributes = () => ({
name: 'my super video updated',
category: 4,
licence: 2,
language: 'ar',
nsfw: false,
description: 'my super description updated',
support: 'my super support text updated',
account: {
name: 'root',
host: 'localhost:' + server.port
},
isLocal: true,
tags: [ 'tagup1', 'tagup2' ],
privacy: VideoPrivacy.PUBLIC,
duration: 5,
commentsEnabled: false,
downloadEnabled: false,
channel: {
name: 'root_channel',
displayName: 'Main root channel',
description: '',
isLocal: true
},
fixture: 'video_short3.webm',
files: [
{
resolution: 720,
size: 292677
}
]
})
before(async function () {
this.timeout(30000)
server = await flushAndRunServer(1)
await setAccessTokensToServers([ server ])
})
it('Should list video categories', async function () {
const res = await getVideoCategories(server.url)
const categories = res.body
expect(Object.keys(categories)).to.have.length.above(10)
expect(categories[11]).to.equal('News & Politics')
})
it('Should list video licences', async function () {
const res = await getVideoLicences(server.url)
const licences = res.body
expect(Object.keys(licences)).to.have.length.above(5)
expect(licences[3]).to.equal('Attribution - No Derivatives')
})
it('Should list video languages', async function () {
const res = await getVideoLanguages(server.url)
const languages = res.body
expect(Object.keys(languages)).to.have.length.above(5)
expect(languages['ru']).to.equal('Russian')
})
it('Should list video privacies', async function () {
const res = await getVideoPrivacies(server.url)
const privacies = res.body
expect(Object.keys(privacies)).to.have.length.at.least(3)
expect(privacies[3]).to.equal('Private')
})
it('Should not have videos', async function () {
const res = await getVideosList(server.url)
expect(res.body.total).to.equal(0)
expect(res.body.data).to.be.an('array')
expect(res.body.data.length).to.equal(0)
})
it('Should upload the video', async function () {
this.timeout(10000)
const videoAttributes = {
name: 'my super name',
category: 2,
nsfw: true,
licence: 6,
tags: [ 'tag1', 'tag2', 'tag3' ]
}
const res = await uploadVideo(server.url, server.accessToken, videoAttributes, HttpStatusCode.OK_200, mode)
expect(res.body.video).to.not.be.undefined
expect(res.body.video.id).to.equal(1)
expect(res.body.video.uuid).to.have.length.above(5)
videoId = res.body.video.id
videoUUID = res.body.video.uuid
})
it('Should get and seed the uploaded video', async function () {
this.timeout(5000)
const res = await getVideosList(server.url)
expect(res.body.total).to.equal(1)
expect(res.body.data).to.be.an('array')
expect(res.body.data.length).to.equal(1)
const video = res.body.data[0]
await completeVideoCheck(server.url, video, getCheckAttributes())
})
it('Should get the video by UUID', async function () {
this.timeout(5000)
const res = await getVideo(server.url, videoUUID)
const video = res.body
await completeVideoCheck(server.url, video, getCheckAttributes())
})
it('Should have the views updated', async function () {
this.timeout(20000)
await viewVideo(server.url, videoId)
await viewVideo(server.url, videoId)
await viewVideo(server.url, videoId)
await wait(1500)
await viewVideo(server.url, videoId)
await viewVideo(server.url, videoId)
await wait(1500)
await viewVideo(server.url, videoId)
await viewVideo(server.url, videoId)
// Wait the repeatable job
await wait(8000)
const res = await getVideo(server.url, videoId)
const video = res.body
expect(video.views).to.equal(3)
})
it('Should remove the video', async function () {
await removeVideo(server.url, server.accessToken, videoId)
await checkVideoFilesWereRemoved(videoUUID, 1)
})
it('Should not have videos', async function () {
const res = await getVideosList(server.url)
expect(res.body.total).to.equal(0)
expect(res.body.data).to.be.an('array')
expect(res.body.data).to.have.lengthOf(0)
})
it('Should upload 6 videos', async function () {
this.timeout(25000)
const videos = new Set([
'video_short.mp4', 'video_short.ogv', 'video_short.webm',
'video_short1.webm', 'video_short2.webm', 'video_short3.webm'
])
for (const video of videos) {
const videoAttributes = {
name: video + ' name',
description: video + ' description',
category: 2,
licence: 1,
language: 'en',
nsfw: true,
tags: [ 'tag1', 'tag2', 'tag3' ],
fixture: video
}
await uploadVideo(server.url, server.accessToken, videoAttributes, HttpStatusCode.OK_200, mode)
}
})
it('Should have the correct durations', async function () {
const res = await getVideosList(server.url)
expect(res.body.total).to.equal(6)
const videos = res.body.data
expect(videos).to.be.an('array')
expect(videos).to.have.lengthOf(6)
const videosByName = keyBy<{ duration: number }>(videos, 'name')
expect(videosByName['video_short.mp4 name'].duration).to.equal(5)
expect(videosByName['video_short.ogv name'].duration).to.equal(5)
expect(videosByName['video_short.webm name'].duration).to.equal(5)
expect(videosByName['video_short1.webm name'].duration).to.equal(10)
expect(videosByName['video_short2.webm name'].duration).to.equal(5)
expect(videosByName['video_short3.webm name'].duration).to.equal(5)
})
it('Should have the correct thumbnails', async function () {
const res = await getVideosList(server.url)
const videos = res.body.data
// For the next test
videosListBase = videos
for (const video of videos) {
const videoName = video.name.replace(' name', '')
await testImage(server.url, videoName, video.thumbnailPath)
}
})
it('Should list only the two first videos', async function () {
const res = await getVideosListPagination(server.url, 0, 2, 'name')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(2)
expect(videos[0].name).to.equal(videosListBase[0].name)
expect(videos[1].name).to.equal(videosListBase[1].name)
})
it('Should list only the next three videos', async function () {
const res = await getVideosListPagination(server.url, 2, 3, 'name')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(3)
expect(videos[0].name).to.equal(videosListBase[2].name)
expect(videos[1].name).to.equal(videosListBase[3].name)
expect(videos[2].name).to.equal(videosListBase[4].name)
})
it('Should list the last video', async function () {
const res = await getVideosListPagination(server.url, 5, 6, 'name')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(1)
expect(videos[0].name).to.equal(videosListBase[5].name)
})
it('Should not have the total field', async function () {
const res = await getVideosListPagination(server.url, 5, 6, 'name', true)
const videos = res.body.data
expect(res.body.total).to.not.exist
expect(videos.length).to.equal(1)
expect(videos[0].name).to.equal(videosListBase[5].name)
})
it('Should list and sort by name in descending order', async function () {
const res = await getVideosListSort(server.url, '-name')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(6)
expect(videos[0].name).to.equal('video_short.webm name')
expect(videos[1].name).to.equal('video_short.ogv name')
expect(videos[2].name).to.equal('video_short.mp4 name')
expect(videos[3].name).to.equal('video_short3.webm name')
expect(videos[4].name).to.equal('video_short2.webm name')
expect(videos[5].name).to.equal('video_short1.webm name')
videoId = videos[3].uuid
videoId2 = videos[5].uuid
})
it('Should list and sort by trending in descending order', async function () {
const res = await getVideosListPagination(server.url, 0, 2, '-trending')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(2)
})
it('Should list and sort by hotness in descending order', async function () {
const res = await getVideosListPagination(server.url, 0, 2, '-hot')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(2)
})
it('Should list and sort by best in descending order', async function () {
const res = await getVideosListPagination(server.url, 0, 2, '-best')
const videos = res.body.data
expect(res.body.total).to.equal(6)
expect(videos.length).to.equal(2)
})
it('Should update a video', async function () {
const attributes = {
name: 'my super video updated',
category: 4,
licence: 2,
language: 'ar',
nsfw: false,
description: 'my super description updated',
commentsEnabled: false,
downloadEnabled: false,
tags: [ 'tagup1', 'tagup2' ]
}
await updateVideo(server.url, server.accessToken, videoId, attributes)
})
it('Should filter by tags and category', async function () {
const res1 = await getVideosWithFilters(server.url, { tagsAllOf: [ 'tagup1', 'tagup2' ], categoryOneOf: [ 4 ] })
expect(res1.body.total).to.equal(1)
expect(res1.body.data[0].name).to.equal('my super video updated')
const res2 = await getVideosWithFilters(server.url, { tagsAllOf: [ 'tagup1', 'tagup2' ], categoryOneOf: [ 3 ] })
expect(res2.body.total).to.equal(0)
})
it('Should have the video updated', async function () {
this.timeout(60000)
const res = await getVideo(server.url, videoId)
const video = res.body
await completeVideoCheck(server.url, video, updateCheckAttributes())
})
it('Should update only the tags of a video', async function () {
const attributes = {
tags: [ 'supertag', 'tag1', 'tag2' ]
}
await updateVideo(server.url, server.accessToken, videoId, attributes)
const res = await getVideo(server.url, videoId)
const video = res.body
await completeVideoCheck(server.url, video, Object.assign(updateCheckAttributes(), attributes))
})
it('Should update only the description of a video', async function () {
const attributes = {
description: 'hello everybody'
}
await updateVideo(server.url, server.accessToken, videoId, attributes)
const res = await getVideo(server.url, videoId)
const video = res.body
const expectedAttributes = Object.assign(updateCheckAttributes(), { tags: [ 'supertag', 'tag1', 'tag2' ] }, attributes)
await completeVideoCheck(server.url, video, expectedAttributes)
})
it('Should like a video', async function () {
await rateVideo(server.url, server.accessToken, videoId, 'like')
const res = await getVideo(server.url, videoId)
const video = res.body
expect(video.likes).to.equal(1)
expect(video.dislikes).to.equal(0)
})
it('Should dislike the same video', async function () {
await rateVideo(server.url, server.accessToken, videoId, 'dislike')
const res = await getVideo(server.url, videoId)
const video = res.body
expect(video.likes).to.equal(0)
expect(video.dislikes).to.equal(1)
})
it('Should sort by originallyPublishedAt', async function () {
{
const now = new Date()
const attributes = { originallyPublishedAt: now.toISOString() }
await updateVideo(server.url, server.accessToken, videoId, attributes)
const res = await getVideosListSort(server.url, '-originallyPublishedAt')
const names = res.body.data.map(v => v.name)
expect(names[0]).to.equal('my super video updated')
expect(names[1]).to.equal('video_short2.webm name')
expect(names[2]).to.equal('video_short1.webm name')
expect(names[3]).to.equal('video_short.webm name')
expect(names[4]).to.equal('video_short.ogv name')
expect(names[5]).to.equal('video_short.mp4 name')
}
{
const now = new Date()
const attributes = { originallyPublishedAt: now.toISOString() }
await updateVideo(server.url, server.accessToken, videoId2, attributes)
const res = await getVideosListSort(server.url, '-originallyPublishedAt')
const names = res.body.data.map(v => v.name)
expect(names[0]).to.equal('video_short1.webm name')
expect(names[1]).to.equal('my super video updated')
expect(names[2]).to.equal('video_short2.webm name')
expect(names[3]).to.equal('video_short.webm name')
expect(names[4]).to.equal('video_short.ogv name')
expect(names[5]).to.equal('video_short.mp4 name')
}
})
after(async function () {
await cleanupTests([ server ])
})
}
describe('Legacy upload', function () {
runSuite('legacy')
})
describe('Resumable upload', function () {
runSuite('resumable')
})
})