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
|
2019-02-07 08:08:19 -06:00
|
|
|
range?: string
|
2020-04-29 02:04:42 -05:00
|
|
|
redirects?: number
|
2021-05-28 03:21:39 -05:00
|
|
|
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 })
|
2018-02-13 11:17:05 -06:00
|
|
|
|
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
|
2018-06-29 04:29:23 -05:00
|
|
|
}) {
|
2021-07-16 03:42:24 -05:00
|
|
|
const req = request(options.url).put(options.path)
|
|
|
|
.send(options.fields)
|
2018-06-29 04:29:23 -05:00
|
|
|
|
2021-07-16 03:42:24 -05:00
|
|
|
return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
|
2018-06-29 04:29:23 -05:00
|
|
|
}
|
|
|
|
|
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)
|
|
|
|
}
|
|
|
|
|
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 {
|
2018-07-18 02:52:46 -05:00
|
|
|
makeHTMLRequest,
|
2017-09-04 14:21:47 -05:00
|
|
|
makeGetRequest,
|
2020-04-29 02:04:42 -05:00
|
|
|
decodeQueryString,
|
2018-02-13 11:17:05 -06:00
|
|
|
makeUploadRequest,
|
2017-09-04 14:21:47 -05:00
|
|
|
makePostBodyRequest,
|
2017-12-28 07:29:57 -06:00
|
|
|
makePutBodyRequest,
|
2018-06-29 04:29:23 -05:00
|
|
|
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,
|
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) {
|
2021-08-18 04:12:21 -05:00
|
|
|
req.field(key, [])
|
2021-07-16 03:42:24 -05:00
|
|
|
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
|
|
|
}
|