PeerTube/shared/extra-utils/requests/requests.ts

199 lines
5.6 KiB
TypeScript
Raw Normal View History

2021-07-16 03:42:24 -05:00
/* eslint-disable @typescript-eslint/no-floating-promises */
2020-01-31 09:56:52 -06:00
2020-04-29 02:04:42 -05:00
import { decode } from 'querystring'
2021-07-06 08:33:39 -05:00
import * as request from 'supertest'
import { URL } from 'url'
2021-07-16 03:42:24 -05:00
import { HttpStatusCode } from '@shared/models'
import { buildAbsoluteFixturePath } from '../miscs/tests'
2019-01-29 01:37:25 -06:00
2021-07-16 03:42:24 -05:00
export type CommonRequestParams = {
2020-01-31 09:56:52 -06:00
url: string
path?: string
contentType?: string
range?: string
2020-04-29 02:04:42 -05:00
redirects?: number
accept?: string
2021-07-13 04:05:15 -05:00
host?: string
2021-07-16 03:42:24 -05:00
token?: string
headers?: { [ name: string ]: string }
type?: string
xForwardedFor?: string
expectedStatus?: HttpStatusCode
}
2017-12-28 07:29:57 -06:00
2021-07-16 03:42:24 -05:00
function makeRawRequest (url: string, expectedStatus?: HttpStatusCode, range?: string) {
const { host, protocol, pathname } = new URL(url)
2017-12-28 07:29:57 -06:00
2021-07-16 03:42:24 -05:00
return makeGetRequest({ url: `${protocol}//${host}`, path: pathname, expectedStatus, range })
2017-12-28 07:29:57 -06:00
}
2021-07-16 03:42:24 -05:00
function makeGetRequest (options: CommonRequestParams & {
query?: any
2017-12-28 07:29:57 -06:00
}) {
2021-07-16 03:42:24 -05:00
const req = request(options.url).get(options.path)
.query(options.query)
2017-12-28 07:29:57 -06:00
2021-07-16 03:42:24 -05:00
return buildRequest(req, { contentType: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
}
2017-12-28 07:29:57 -06:00
2021-07-16 03:42:24 -05:00
function makeHTMLRequest (url: string, path: string) {
return makeGetRequest({
url,
path,
accept: 'text/html',
expectedStatus: HttpStatusCode.OK_200
})
}
2017-12-28 07:29:57 -06:00
2021-07-16 03:42:24 -05:00
function makeActivityPubGetRequest (url: string, path: string, expectedStatus = HttpStatusCode.OK_200) {
return makeGetRequest({
url,
path,
expectedStatus: expectedStatus,
accept: 'application/activity+json,text/html;q=0.9,\\*/\\*;q=0.8'
})
2017-09-04 14:21:47 -05:00
}
2021-07-16 03:42:24 -05:00
function makeDeleteRequest (options: CommonRequestParams) {
const req = request(options.url).delete(options.path)
return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
}
function makeUploadRequest (options: CommonRequestParams & {
2020-01-31 09:56:52 -06:00
method?: 'POST' | 'PUT'
2021-07-15 03:02:54 -05:00
2020-01-31 09:56:52 -06:00
fields: { [ fieldName: string ]: any }
2020-10-30 09:09:00 -05:00
attaches?: { [ attachName: string ]: any | any[] }
2017-09-04 14:21:47 -05:00
}) {
2021-07-16 03:42:24 -05:00
let req = options.method === 'PUT'
? request(options.url).put(options.path)
: request(options.url).post(options.path)
2017-09-04 14:21:47 -05:00
2021-07-16 03:42:24 -05:00
req = buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
2021-07-16 03:42:24 -05:00
buildFields(req, options.fields)
2017-09-04 14:21:47 -05:00
2020-10-30 09:09:00 -05:00
Object.keys(options.attaches || {}).forEach(attach => {
2017-09-04 14:21:47 -05:00
const value = options.attaches[attach]
2021-07-16 03:42:24 -05:00
2018-08-06 04:45:24 -05:00
if (Array.isArray(value)) {
req.attach(attach, buildAbsoluteFixturePath(value[0]), value[1])
} else {
req.attach(attach, buildAbsoluteFixturePath(value))
}
2017-09-04 14:21:47 -05:00
})
2021-07-15 03:02:54 -05:00
return req
2017-09-04 14:21:47 -05:00
}
2021-07-16 03:42:24 -05:00
function makePostBodyRequest (options: CommonRequestParams & {
2020-01-31 09:56:52 -06:00
fields?: { [ fieldName: string ]: any }
2017-09-04 14:21:47 -05:00
}) {
2021-07-16 03:42:24 -05:00
const req = request(options.url).post(options.path)
.send(options.fields)
2017-09-04 14:21:47 -05:00
2021-07-16 03:42:24 -05:00
return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
2017-09-04 14:21:47 -05:00
}
function makePutBodyRequest (options: {
2020-01-31 09:56:52 -06:00
url: string
path: string
token?: string
fields: { [ fieldName: string ]: any }
2021-07-16 03:42:24 -05:00
expectedStatus?: HttpStatusCode
}) {
2021-07-16 03:42:24 -05:00
const req = request(options.url).put(options.path)
.send(options.fields)
2021-07-16 03:42:24 -05:00
return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
}
2020-04-29 02:04:42 -05:00
function decodeQueryString (path: string) {
return decode(path.split('?')[1])
}
2021-07-06 03:21:35 -05:00
function unwrapBody <T> (test: request.Test): Promise<T> {
2021-07-06 02:55:05 -05:00
return test.then(res => res.body)
}
2021-07-06 03:21:35 -05:00
function unwrapText (test: request.Test): Promise<string> {
return test.then(res => res.text)
}
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 01:26:20 -05:00
function unwrapBodyOrDecodeToJSON <T> (test: request.Test): Promise<T> {
return test.then(res => {
if (res.body instanceof Buffer) {
return JSON.parse(new TextDecoder().decode(res.body))
}
return res.body
})
}
function unwrapTextOrDecode (test: request.Test): Promise<string> {
return test.then(res => res.text || new TextDecoder().decode(res.body))
}
2017-09-04 14:21:47 -05:00
// ---------------------------------------------------------------------------
export {
makeHTMLRequest,
2017-09-04 14:21:47 -05:00
makeGetRequest,
2020-04-29 02:04:42 -05:00
decodeQueryString,
makeUploadRequest,
2017-09-04 14:21:47 -05:00
makePostBodyRequest,
2017-12-28 07:29:57 -06:00
makePutBodyRequest,
makeDeleteRequest,
2019-01-29 01:37:25 -06:00
makeRawRequest,
2021-07-06 08:33:39 -05:00
makeActivityPubGetRequest,
2021-07-06 03:21:35 -05:00
unwrapBody,
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 01:26:20 -05:00
unwrapTextOrDecode,
unwrapBodyOrDecodeToJSON,
2021-07-16 03:42:24 -05:00
unwrapText
}
// ---------------------------------------------------------------------------
function buildRequest (req: request.Test, options: CommonRequestParams) {
if (options.contentType) req.set('Accept', options.contentType)
if (options.token) req.set('Authorization', 'Bearer ' + options.token)
if (options.range) req.set('Range', options.range)
if (options.accept) req.set('Accept', options.accept)
if (options.host) req.set('Host', options.host)
if (options.redirects) req.redirects(options.redirects)
if (options.expectedStatus) req.expect(options.expectedStatus)
if (options.xForwardedFor) req.set('X-Forwarded-For', options.xForwardedFor)
if (options.type) req.type(options.type)
Object.keys(options.headers || {}).forEach(name => {
req.set(name, options.headers[name])
})
return req
}
function buildFields (req: request.Test, fields: { [ fieldName: string ]: any }, namespace?: string) {
if (!fields) return
let formKey: string
for (const key of Object.keys(fields)) {
if (namespace) formKey = `${namespace}[${key}]`
else formKey = key
if (fields[key] === undefined) continue
if (Array.isArray(fields[key]) && fields[key].length === 0) {
req.field(key, null)
continue
}
if (fields[key] !== null && typeof fields[key] === 'object') {
buildFields(req, fields[key], formKey)
} else {
req.field(formKey, fields[key])
}
}
2017-09-04 14:21:47 -05:00
}