1
0
Fork 0
peertube/shared/extra-utils/server/servers.ts

402 lines
10 KiB
TypeScript
Raw Normal View History

2020-01-31 10:56:52 -05:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
2018-12-11 03:16:41 -05:00
2020-11-06 10:43:43 -05:00
import { expect } from 'chai'
2017-09-04 15:21:47 -04:00
import { ChildProcess, exec, fork } from 'child_process'
2020-12-10 05:24:17 -05:00
import { copy, ensureDir, pathExists, readdir, readFile, remove } from 'fs-extra'
2020-11-06 10:43:43 -05:00
import { join } from 'path'
2019-04-24 09:10:37 -04:00
import { randomInt } from '../../core-utils/miscs/miscs'
2021-02-16 02:50:40 -05:00
import { VideoChannel } from '../../models/videos'
2021-07-05 10:37:50 -04:00
import { BulkCommand } from '../bulk'
import { CLICommand } from '../cli'
2021-07-06 03:55:05 -04:00
import { CustomPagesCommand } from '../custom-pages'
2021-07-06 04:21:35 -04:00
import { FeedCommand } from '../feeds'
2021-07-06 04:34:29 -04:00
import { LogsCommand } from '../logs'
2020-12-10 05:24:17 -05:00
import { buildServerDirectory, getFileSize, isGithubCI, root, wait } from '../miscs/miscs'
2021-01-13 03:38:19 -05:00
import { makeGetRequest } from '../requests/requests'
2017-09-04 15:21:47 -04:00
interface ServerInfo {
2020-01-31 10:56:52 -05:00
app: ChildProcess
2020-11-02 09:43:44 -05:00
2017-09-04 15:21:47 -04:00
url: string
host: string
2020-11-02 09:43:44 -05:00
hostname: string
2019-04-24 05:54:23 -04:00
port: number
2020-11-02 09:43:44 -05:00
2020-11-06 10:43:43 -05:00
rtmpPort: number
2019-04-24 05:54:23 -04:00
parallel: boolean
internalServerNumber: number
2017-09-07 09:27:35 -04:00
serverNumber: number
2017-09-04 15:21:47 -04:00
client: {
2020-01-31 10:56:52 -05:00
id: string
2017-09-04 15:21:47 -04:00
secret: string
}
user: {
2020-01-31 10:56:52 -05:00
username: string
password: string
2017-09-04 15:21:47 -04:00
email?: string
}
2019-04-24 09:10:37 -04:00
customConfigFile?: string
2017-09-04 15:21:47 -04:00
accessToken?: string
refreshToken?: string
2019-03-05 04:58:44 -05:00
videoChannel?: VideoChannel
2017-09-04 15:21:47 -04:00
video?: {
id: number
uuid: string
shortUUID: string
2020-07-08 09:51:46 -04:00
name?: string
url?: string
2021-05-14 06:04:44 -04:00
2020-07-08 09:51:46 -04:00
account?: {
2018-03-12 06:06:15 -04:00
name: string
}
2021-05-14 06:04:44 -04:00
embedPath?: string
2017-09-04 15:21:47 -04:00
}
remoteVideo?: {
id: number
uuid: string
}
2019-03-05 04:58:44 -05:00
videos?: { id: number, uuid: string }[]
2021-07-05 10:37:50 -04:00
bulkCommand?: BulkCommand
cliCommand?: CLICommand
2021-07-06 03:55:05 -04:00
customPageCommand?: CustomPagesCommand
2021-07-06 04:21:35 -04:00
feedCommand?: FeedCommand
2021-07-06 04:34:29 -04:00
logsCommand?: LogsCommand
2017-09-04 15:21:47 -04:00
}
2019-04-24 09:10:37 -04:00
function parallelTests () {
return process.env.MOCHA_PARALLEL === 'true'
}
2018-09-14 03:57:21 -04:00
function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
2020-01-31 10:56:52 -05:00
const apps = []
2017-09-04 15:21:47 -04:00
let i = 0
return new Promise<ServerInfo[]>(res => {
function anotherServerDone (serverNumber, app) {
apps[serverNumber - 1] = app
i++
if (i === totalServers) {
return res(apps)
}
}
2019-04-24 04:53:40 -04:00
for (let j = 1; j <= totalServers; j++) {
flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
}
2017-09-04 15:21:47 -04:00
})
}
2019-04-24 04:53:40 -04:00
function flushTests (serverNumber?: number) {
2017-09-04 15:21:47 -04:00
return new Promise<void>((res, rej) => {
2019-04-24 04:53:40 -04:00
const suffix = serverNumber ? ` -- ${serverNumber}` : ''
2019-07-29 05:59:29 -04:00
return exec('npm run clean:server:test' + suffix, (err, _stdout, stderr) => {
if (err || stderr) return rej(err || new Error(stderr))
2017-09-04 15:21:47 -04:00
return res()
})
})
}
2019-04-24 05:54:23 -04:00
function randomServer () {
const low = 10
const high = 10000
2019-04-24 09:10:37 -04:00
return randomInt(low, high)
2019-04-24 05:54:23 -04:00
}
2020-11-06 10:43:43 -05:00
function randomRTMP () {
const low = 1900
const high = 2100
return randomInt(low, high)
}
2020-11-30 08:47:54 -05:00
type RunServerOptions = {
hideLogs?: boolean
execArgv?: string[]
}
async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = [], options: RunServerOptions = {}) {
2019-04-24 09:10:37 -04:00
const parallel = parallelTests()
2019-04-24 05:54:23 -04:00
const internalServerNumber = parallel ? randomServer() : serverNumber
2020-11-17 10:14:11 -05:00
const rtmpPort = parallel ? randomRTMP() : 1936
2019-04-24 05:54:23 -04:00
const port = 9000 + internalServerNumber
2019-04-24 09:10:37 -04:00
await flushTests(internalServerNumber)
2019-04-24 06:02:04 -04:00
2017-09-04 15:21:47 -04:00
const server: ServerInfo = {
app: null,
2019-04-24 05:54:23 -04:00
port,
internalServerNumber,
2020-11-06 10:43:43 -05:00
rtmpPort,
2019-04-24 05:54:23 -04:00
parallel,
2019-04-24 09:10:37 -04:00
serverNumber,
2019-04-24 05:54:23 -04:00
url: `http://localhost:${port}`,
host: `localhost:${port}`,
2020-11-02 09:43:44 -05:00
hostname: 'localhost',
2017-09-04 15:21:47 -04:00
client: {
id: null,
secret: null
},
user: {
username: null,
password: null
}
}
2020-11-30 08:47:54 -05:00
return runServer(server, configOverride, args, options)
2019-04-24 08:00:30 -04:00
}
2020-11-30 08:47:54 -05:00
async function runServer (server: ServerInfo, configOverrideArg?: any, args = [], options: RunServerOptions = {}) {
2017-09-04 15:21:47 -04:00
// These actions are async so we need to be sure that they have both been done
const serverRunString = {
2021-01-11 04:33:29 -05:00
'HTTP server listening': false
2017-09-04 15:21:47 -04:00
}
2019-04-24 08:00:30 -04:00
const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
2017-09-04 15:21:47 -04:00
serverRunString[key] = false
const regexps = {
client_id: 'Client id: (.+)',
client_secret: 'Client secret: (.+)',
user_username: 'Username: (.+)',
user_password: 'User password: (.+)'
}
2019-04-24 09:10:37 -04:00
if (server.internalServerNumber !== server.serverNumber) {
const basePath = join(root(), 'config')
const tmpConfigFile = join(basePath, `test-${server.internalServerNumber}.yaml`)
await copy(join(basePath, `test-${server.serverNumber}.yaml`), tmpConfigFile)
server.customConfigFile = tmpConfigFile
}
2017-09-07 09:27:35 -04:00
2019-04-24 09:10:37 -04:00
const configOverride: any = {}
2019-04-24 05:54:23 -04:00
2019-04-24 08:00:30 -04:00
if (server.parallel) {
2019-04-24 09:10:37 -04:00
Object.assign(configOverride, {
2019-04-24 05:54:23 -04:00
listen: {
2019-04-24 08:00:30 -04:00
port: server.port
2019-04-24 05:54:23 -04:00
},
webserver: {
2019-04-24 08:00:30 -04:00
port: server.port
2019-04-24 05:54:23 -04:00
},
database: {
2019-04-24 08:00:30 -04:00
suffix: '_test' + server.internalServerNumber
2019-04-24 05:54:23 -04:00
},
storage: {
2019-04-24 08:00:30 -04:00
tmp: `test${server.internalServerNumber}/tmp/`,
avatars: `test${server.internalServerNumber}/avatars/`,
videos: `test${server.internalServerNumber}/videos/`,
streaming_playlists: `test${server.internalServerNumber}/streaming-playlists/`,
redundancy: `test${server.internalServerNumber}/redundancy/`,
logs: `test${server.internalServerNumber}/logs/`,
previews: `test${server.internalServerNumber}/previews/`,
thumbnails: `test${server.internalServerNumber}/thumbnails/`,
torrents: `test${server.internalServerNumber}/torrents/`,
captions: `test${server.internalServerNumber}/captions/`,
2019-07-19 11:30:41 -04:00
cache: `test${server.internalServerNumber}/cache/`,
plugins: `test${server.internalServerNumber}/plugins/`
2019-04-24 05:54:23 -04:00
},
admin: {
2019-04-24 08:00:30 -04:00
email: `admin${server.internalServerNumber}@example.com`
2020-11-06 10:43:43 -05:00
},
live: {
rtmp: {
port: server.rtmpPort
}
2019-04-24 05:54:23 -04:00
}
2019-04-24 09:10:37 -04:00
})
2019-04-24 05:54:23 -04:00
}
if (configOverrideArg !== undefined) {
Object.assign(configOverride, configOverrideArg)
2017-09-07 09:27:35 -04:00
}
2019-04-24 09:10:37 -04:00
// Share the environment
const env = Object.create(process.env)
env['NODE_ENV'] = 'test'
env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
2019-04-24 05:54:23 -04:00
env['NODE_CONFIG'] = JSON.stringify(configOverride)
2020-11-30 08:47:54 -05:00
const forkOptions = {
2017-09-04 15:21:47 -04:00
silent: true,
2019-04-24 09:10:37 -04:00
env,
2020-11-30 08:47:54 -05:00
detached: true,
execArgv: options.execArgv || []
2017-09-04 15:21:47 -04:00
}
return new Promise<ServerInfo>(res => {
2020-11-30 08:47:54 -05:00
server.app = fork(join(root(), 'dist', 'server.js'), args, forkOptions)
2019-04-24 06:02:04 -04:00
server.app.stdout.on('data', function onStdout (data) {
let dontContinue = false
// Capture things if we want to
for (const key of Object.keys(regexps)) {
2020-01-31 10:56:52 -05:00
const regexp = regexps[key]
2019-04-24 06:02:04 -04:00
const matches = data.toString().match(regexp)
if (matches !== null) {
2020-01-31 10:56:52 -05:00
if (key === 'client_id') server.client.id = matches[1]
else if (key === 'client_secret') server.client.secret = matches[1]
else if (key === 'user_username') server.user.username = matches[1]
else if (key === 'user_password') server.user.password = matches[1]
2019-04-24 06:02:04 -04:00
}
}
// Check if all required sentences are here
for (const key of Object.keys(serverRunString)) {
2020-01-31 10:56:52 -05:00
if (data.toString().indexOf(key) !== -1) serverRunString[key] = true
if (serverRunString[key] === false) dontContinue = true
2019-04-24 06:02:04 -04:00
}
// If no, there is maybe one thing not already initialized (client/user credentials generation...)
if (dontContinue === true) return
2020-11-30 08:47:54 -05:00
if (options.hideLogs === false) {
2020-11-24 08:08:23 -05:00
console.log(data.toString())
} else {
server.app.stdout.removeListener('data', onStdout)
}
2019-04-24 06:02:04 -04:00
process.on('exit', () => {
try {
process.kill(server.app.pid)
} catch { /* empty */ }
2019-01-17 05:23:40 -05:00
})
2019-04-24 06:02:04 -04:00
2021-07-05 10:37:50 -04:00
server.bulkCommand = new BulkCommand(server)
server.cliCommand = new CLICommand(server)
2021-07-06 03:55:05 -04:00
server.customPageCommand = new CustomPagesCommand(server)
2021-07-06 04:21:35 -04:00
server.feedCommand = new FeedCommand(server)
2021-07-06 04:34:29 -04:00
server.logsCommand = new LogsCommand(server)
2021-07-05 10:37:50 -04:00
2019-04-24 06:02:04 -04:00
res(server)
})
2017-09-04 15:21:47 -04:00
})
}
async function reRunServer (server: ServerInfo, configOverride?: any) {
2019-04-24 08:00:30 -04:00
const newServer = await runServer(server, configOverride)
2018-01-11 05:40:18 -05:00
server.app = newServer.app
return server
}
2021-02-02 07:45:58 -05:00
async function checkTmpIsEmpty (server: ServerInfo) {
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 05:13:41 -04:00
await checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css', 'hls', 'resumable-uploads' ])
2021-02-02 07:45:58 -05:00
if (await pathExists(join('test' + server.internalServerNumber, 'tmp', 'hls'))) {
await checkDirectoryIsEmpty(server, 'tmp/hls')
}
2019-01-29 02:37:25 -05:00
}
async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
2019-04-26 02:50:52 -04:00
const testDirectory = 'test' + server.internalServerNumber
2018-12-11 03:16:41 -05:00
2019-01-29 02:37:25 -05:00
const directoryPath = join(root(), testDirectory, directory)
2018-12-11 03:16:41 -05:00
const directoryExists = await pathExists(directoryPath)
2018-12-11 03:16:41 -05:00
expect(directoryExists).to.be.true
const files = await readdir(directoryPath)
const filtered = files.filter(f => exceptions.includes(f) === false)
expect(filtered).to.have.lengthOf(0)
2018-12-11 03:16:41 -05:00
}
2017-09-04 15:21:47 -04:00
function killallServers (servers: ServerInfo[]) {
for (const server of servers) {
2019-04-24 09:10:37 -04:00
if (!server.app) continue
2017-09-04 15:21:47 -04:00
process.kill(-server.app.pid)
2019-04-24 09:10:37 -04:00
server.app = null
2017-09-04 15:21:47 -04:00
}
}
2020-12-10 05:24:17 -05:00
async function cleanupTests (servers: ServerInfo[]) {
2019-04-24 05:54:23 -04:00
killallServers(servers)
2020-12-10 05:24:17 -05:00
if (isGithubCI()) {
await ensureDir('artifacts')
}
2019-04-24 05:54:23 -04:00
const p: Promise<any>[] = []
for (const server of servers) {
2020-12-10 05:24:17 -05:00
if (isGithubCI()) {
const origin = await buildServerDirectory(server, 'logs/peertube.log')
const destname = `peertube-${server.internalServerNumber}.log`
console.log('Saving logs %s.', destname)
await copy(origin, join('artifacts', destname))
}
2019-04-24 05:54:23 -04:00
if (server.parallel) {
p.push(flushTests(server.internalServerNumber))
}
2019-04-24 09:10:37 -04:00
if (server.customConfigFile) {
p.push(remove(server.customConfigFile))
}
2019-04-24 05:54:23 -04:00
}
return Promise.all(p)
}
2020-04-09 05:00:30 -04:00
async function waitUntilLog (server: ServerInfo, str: string, count = 1, strictCount = true) {
2020-11-24 09:22:56 -05:00
const logfile = buildServerDirectory(server, 'logs/peertube.log')
2018-10-02 03:04:19 -04:00
while (true) {
const buf = await readFile(logfile)
const matches = buf.toString().match(new RegExp(str, 'g'))
if (matches && matches.length === count) return
2020-04-09 05:00:30 -04:00
if (matches && strictCount === false && matches.length >= count) return
2018-10-02 03:04:19 -04:00
await wait(1000)
}
}
async function getServerFileSize (server: ServerInfo, subPath: string) {
2020-11-24 09:22:56 -05:00
const path = buildServerDirectory(server, subPath)
return getFileSize(path)
}
2021-01-13 03:38:19 -05:00
function makePingRequest (server: ServerInfo) {
return makeGetRequest({
url: server.url,
path: '/api/v1/ping',
statusCodeExpected: 200
})
}
2017-09-04 15:21:47 -04:00
// ---------------------------------------------------------------------------
export {
2019-01-29 02:37:25 -05:00
checkDirectoryIsEmpty,
2018-12-11 03:16:41 -05:00
checkTmpIsEmpty,
getServerFileSize,
2017-09-04 15:21:47 -04:00
ServerInfo,
2019-04-24 09:10:37 -04:00
parallelTests,
2019-04-24 05:54:23 -04:00
cleanupTests,
2017-09-04 15:21:47 -04:00
flushAndRunMultipleServers,
flushTests,
2021-01-13 03:38:19 -05:00
makePingRequest,
2019-04-24 04:53:40 -04:00
flushAndRunServer,
2018-01-11 05:40:18 -05:00
killallServers,
2018-10-02 03:04:19 -04:00
reRunServer,
waitUntilLog
2017-09-04 15:21:47 -04:00
}