PeerTube/server/helpers/requests.ts

248 lines
6.7 KiB
TypeScript
Raw Normal View History

2019-02-21 17:19:16 +01:00
import { createWriteStream, remove } from 'fs-extra'
2021-11-16 11:17:52 +01:00
import got, { CancelableRequest, NormalizedOptions, Options as GotOptions, RequestError, Response } from 'got'
import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent'
2021-11-29 15:45:02 +01:00
import { ACTIVITY_PUB, BINARY_CONTENT_TYPES, PEERTUBE_VERSION, REQUEST_TIMEOUTS, WEBSERVER } from '../initializers/constants'
2021-03-08 14:24:11 +01:00
import { pipelinePromise } from './core-utils'
import { logger, loggerTagsFactory } from './logger'
import { getProxy, isProxyEnabled } from './proxy'
const lTags = loggerTagsFactory('request')
const httpSignature = require('@peertube/http-signature')
2017-12-28 11:16:08 +01:00
2021-03-09 14:01:44 +01:00
export interface PeerTubeRequestError extends Error {
statusCode?: number
responseBody?: any
2021-11-16 11:17:52 +01:00
responseHeaders?: any
2021-03-09 14:01:44 +01:00
}
2021-03-08 14:24:11 +01:00
type PeerTubeRequestOptions = {
2021-11-29 15:45:02 +01:00
timeout?: number
2021-03-08 14:24:11 +01:00
activityPub?: boolean
bodyKBLimit?: number // 1MB
httpSignature?: {
algorithm: string
authorizationHeaderName: string
keyId: string
key: string
headers: string[]
}
jsonResponse?: boolean
} & Pick<GotOptions, 'headers' | 'json' | 'method' | 'searchParams'>
const peertubeGot = got.extend({
...getAgent(),
2021-03-08 14:24:11 +01:00
headers: {
'user-agent': getUserAgent()
},
handlers: [
(options, next) => {
const promiseOrStream = next(options) as CancelableRequest<any>
2021-03-09 09:58:08 +01:00
const bodyKBLimit = options.context?.bodyKBLimit as number
2021-03-08 14:24:11 +01:00
if (!bodyKBLimit) throw new Error('No KB limit for this request')
2021-03-09 09:58:08 +01:00
const bodyLimit = bodyKBLimit * 1000
2021-03-08 14:24:11 +01:00
/* eslint-disable @typescript-eslint/no-floating-promises */
promiseOrStream.on('downloadProgress', progress => {
2021-03-09 09:58:08 +01:00
if (progress.transferred > bodyLimit && progress.percent !== 1) {
const message = `Exceeded the download limit of ${bodyLimit} B`
logger.warn(message, lTags())
2021-03-09 09:58:08 +01:00
// CancelableRequest
if (promiseOrStream.cancel) {
promiseOrStream.cancel()
return
}
// Stream
(promiseOrStream as any).destroy()
2021-03-08 14:24:11 +01:00
}
})
2019-07-16 14:52:24 +02:00
2021-03-08 14:24:11 +01:00
return promiseOrStream
}
],
hooks: {
beforeRequest: [
options => {
const headers = options.headers || {}
headers['host'] = options.url.host
},
options => {
const httpSignatureOptions = options.context?.httpSignature
if (httpSignatureOptions) {
const method = options.method ?? 'GET'
const path = options.path ?? options.url.pathname
if (!method || !path) {
throw new Error(`Cannot sign request without method (${method}) or path (${path}) ${options}`)
}
httpSignature.signRequest({
getHeader: function (header: string) {
const value = options.headers[header.toLowerCase()]
if (!value) logger.warn('Unknown header requested by http-signature.', { headers: options.headers, header })
return value
2021-03-08 14:24:11 +01:00
},
setHeader: function (header: string, value: string) {
2021-03-08 14:24:11 +01:00
options.headers[header] = value
},
method,
path
}, httpSignatureOptions)
}
}
2021-11-16 11:17:52 +01:00
],
beforeRetry: [
(_options: NormalizedOptions, error: RequestError, retryCount: number) => {
logger.debug('Retrying request to %s.', error.request.requestUrl, { retryCount, error: buildRequestError(error), ...lTags() })
}
2021-03-08 14:24:11 +01:00
]
2017-12-28 11:16:08 +01:00
}
2021-03-08 14:24:11 +01:00
})
2017-11-09 17:51:58 +01:00
2021-03-08 14:24:11 +01:00
function doRequest (url: string, options: PeerTubeRequestOptions = {}) {
const gotOptions = buildGotOptions(options)
return peertubeGot(url, gotOptions)
.catch(err => { throw buildRequestError(err) })
}
function doJSONRequest <T> (url: string, options: PeerTubeRequestOptions = {}) {
const gotOptions = buildGotOptions(options)
return peertubeGot<T>(url, { ...gotOptions, responseType: 'json' })
.catch(err => { throw buildRequestError(err) })
2017-11-09 17:51:58 +01:00
}
2016-02-05 18:03:20 +01:00
2021-03-08 14:24:11 +01:00
async function doRequestAndSaveToFile (
url: string,
2019-02-21 17:19:16 +01:00
destPath: string,
2021-03-08 14:24:11 +01:00
options: PeerTubeRequestOptions = {}
2019-02-21 17:19:16 +01:00
) {
2021-11-29 15:45:02 +01:00
const gotOptions = buildGotOptions({ ...options, timeout: options.timeout ?? REQUEST_TIMEOUTS.FILE })
2018-02-15 18:40:24 +01:00
2021-03-08 14:24:11 +01:00
const outFile = createWriteStream(destPath)
2019-02-21 17:19:16 +01:00
2021-03-08 14:24:11 +01:00
try {
await pipelinePromise(
peertubeGot.stream(url, gotOptions),
outFile
)
} catch (err) {
remove(destPath)
.catch(err => logger.error('Cannot remove %s after request failure.', destPath, { err, ...lTags() }))
2019-02-21 17:19:16 +01:00
2021-03-08 14:24:11 +01:00
throw buildRequestError(err)
}
2017-11-10 14:34:45 +01:00
}
function getAgent () {
if (!isProxyEnabled()) return {}
const proxy = getProxy()
logger.info('Using proxy %s.', proxy, lTags())
const proxyAgentOptions = {
keepAlive: true,
keepAliveMsecs: 1000,
maxSockets: 256,
maxFreeSockets: 256,
scheduling: 'lifo' as 'lifo',
proxy
}
return {
agent: {
http: new HttpProxyAgent(proxyAgentOptions),
https: new HttpsProxyAgent(proxyAgentOptions)
}
}
}
2019-07-16 14:52:24 +02:00
function getUserAgent () {
2019-07-17 10:03:55 +02:00
return `PeerTube/${PEERTUBE_VERSION} (+${WEBSERVER.URL})`
2019-07-16 14:52:24 +02:00
}
function isBinaryResponse (result: Response<any>) {
return BINARY_CONTENT_TYPES.has(result.headers['content-type'])
}
async function findLatestRedirection (url: string, options: PeerTubeRequestOptions, iteration = 1) {
if (iteration > 10) throw new Error('Too much iterations to find final URL ' + url)
const { headers } = await peertubeGot(url, { followRedirect: false, ...buildGotOptions(options) })
if (headers.location) return findLatestRedirection(headers.location, options, iteration + 1)
return url
}
// ---------------------------------------------------------------------------
2016-02-05 18:03:20 +01:00
2017-05-15 22:22:03 +02:00
export {
PeerTubeRequestOptions,
2017-11-09 17:51:58 +01:00
doRequest,
2021-03-08 14:24:11 +01:00
doJSONRequest,
2018-11-16 16:48:17 +01:00
doRequestAndSaveToFile,
isBinaryResponse,
getAgent,
findLatestRedirection,
2021-10-15 08:32:06 +02:00
peertubeGot
2017-05-15 22:22:03 +02:00
}
2019-02-21 17:19:16 +01:00
// ---------------------------------------------------------------------------
2021-03-08 14:24:11 +01:00
function buildGotOptions (options: PeerTubeRequestOptions) {
const { activityPub, bodyKBLimit = 1000 } = options
2019-02-21 17:19:16 +01:00
2021-03-08 14:24:11 +01:00
const context = { bodyKBLimit, httpSignature: options.httpSignature }
2019-02-21 17:19:16 +01:00
2021-03-08 14:24:11 +01:00
let headers = options.headers || {}
2021-03-10 11:17:20 +01:00
if (!headers.date) {
headers = { ...headers, date: new Date().toUTCString() }
}
2021-03-08 14:24:11 +01:00
2021-03-10 11:17:20 +01:00
if (activityPub && !headers.accept) {
2021-03-08 14:24:11 +01:00
headers = { ...headers, accept: ACTIVITY_PUB.ACCEPT_HEADER }
2019-02-21 17:19:16 +01:00
}
2021-03-08 14:24:11 +01:00
return {
method: options.method,
dnsCache: true,
2021-11-29 15:45:02 +01:00
timeout: options.timeout ?? REQUEST_TIMEOUTS.DEFAULT,
2021-03-08 14:24:11 +01:00
json: options.json,
searchParams: options.searchParams,
retry: 2,
2021-03-08 14:24:11 +01:00
headers,
context
}
}
2021-03-09 14:01:44 +01:00
function buildRequestError (error: RequestError) {
const newError: PeerTubeRequestError = new Error(error.message)
2021-03-08 14:24:11 +01:00
newError.name = error.name
newError.stack = error.stack
2021-03-09 14:01:44 +01:00
if (error.response) {
newError.responseBody = error.response.body
2021-11-16 11:17:52 +01:00
newError.responseHeaders = error.response.headers
2021-03-09 14:01:44 +01:00
newError.statusCode = error.response.statusCode
2021-03-08 14:24:11 +01:00
}
2021-03-09 14:01:44 +01:00
return newError
2019-02-21 17:19:16 +01:00
}