]>
Commit | Line | Data |
---|---|---|
c0e8b12e | 1 | /* eslint-disable @typescript-eslint/no-floating-promises */ |
a1587156 | 2 | |
9107d791 | 3 | import { decode } from 'querystring' |
2d1ad5b9 C |
4 | import * as request from 'supertest' |
5 | import { URL } from 'url' | |
c0e8b12e C |
6 | import { HttpStatusCode } from '@shared/models' |
7 | import { buildAbsoluteFixturePath } from '../miscs/tests' | |
09209296 | 8 | |
c0e8b12e | 9 | export type CommonRequestParams = { |
a1587156 C |
10 | url: string |
11 | path?: string | |
a1587156 | 12 | contentType?: string |
4c280004 | 13 | range?: string |
9107d791 | 14 | redirects?: number |
012580d9 | 15 | accept?: string |
41d1d075 | 16 | host?: string |
c0e8b12e C |
17 | token?: string |
18 | headers?: { [ name: string ]: string } | |
19 | type?: string | |
20 | xForwardedFor?: string | |
21 | expectedStatus?: HttpStatusCode | |
22 | } | |
eec63bbc | 23 | |
c0e8b12e C |
24 | function makeRawRequest (url: string, expectedStatus?: HttpStatusCode, range?: string) { |
25 | const { host, protocol, pathname } = new URL(url) | |
eec63bbc | 26 | |
c0e8b12e | 27 | return makeGetRequest({ url: `${protocol}//${host}`, path: pathname, expectedStatus, range }) |
eec63bbc C |
28 | } |
29 | ||
c0e8b12e C |
30 | function makeGetRequest (options: CommonRequestParams & { |
31 | query?: any | |
eec63bbc | 32 | }) { |
c0e8b12e C |
33 | const req = request(options.url).get(options.path) |
34 | .query(options.query) | |
eec63bbc | 35 | |
c0e8b12e C |
36 | return buildRequest(req, { contentType: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options }) |
37 | } | |
eec63bbc | 38 | |
c0e8b12e C |
39 | function makeHTMLRequest (url: string, path: string) { |
40 | return makeGetRequest({ | |
41 | url, | |
42 | path, | |
43 | accept: 'text/html', | |
44 | expectedStatus: HttpStatusCode.OK_200 | |
45 | }) | |
46 | } | |
eec63bbc | 47 | |
c0e8b12e C |
48 | function makeActivityPubGetRequest (url: string, path: string, expectedStatus = HttpStatusCode.OK_200) { |
49 | return makeGetRequest({ | |
50 | url, | |
51 | path, | |
52 | expectedStatus: expectedStatus, | |
53 | accept: 'application/activity+json,text/html;q=0.9,\\*/\\*;q=0.8' | |
54 | }) | |
0e1dc3e7 C |
55 | } |
56 | ||
c0e8b12e C |
57 | function makeDeleteRequest (options: CommonRequestParams) { |
58 | const req = request(options.url).delete(options.path) | |
59 | ||
60 | return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options }) | |
61 | } | |
62 | ||
63 | function makeUploadRequest (options: CommonRequestParams & { | |
a1587156 | 64 | method?: 'POST' | 'PUT' |
d23dd9fb | 65 | |
a1587156 | 66 | fields: { [ fieldName: string ]: any } |
77e9f859 | 67 | attaches?: { [ attachName: string ]: any | any[] } |
0e1dc3e7 | 68 | }) { |
c0e8b12e C |
69 | let req = options.method === 'PUT' |
70 | ? request(options.url).put(options.path) | |
71 | : request(options.url).post(options.path) | |
0e1dc3e7 | 72 | |
c0e8b12e | 73 | req = buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options }) |
ac81d1a0 | 74 | |
c0e8b12e | 75 | buildFields(req, options.fields) |
0e1dc3e7 | 76 | |
77e9f859 | 77 | Object.keys(options.attaches || {}).forEach(attach => { |
0e1dc3e7 | 78 | const value = options.attaches[attach] |
c0e8b12e | 79 | |
2769e297 C |
80 | if (Array.isArray(value)) { |
81 | req.attach(attach, buildAbsoluteFixturePath(value[0]), value[1]) | |
82 | } else { | |
83 | req.attach(attach, buildAbsoluteFixturePath(value)) | |
84 | } | |
0e1dc3e7 C |
85 | }) |
86 | ||
d23dd9fb | 87 | return req |
0e1dc3e7 C |
88 | } |
89 | ||
c0e8b12e | 90 | function makePostBodyRequest (options: CommonRequestParams & { |
a1587156 | 91 | fields?: { [ fieldName: string ]: any } |
0e1dc3e7 | 92 | }) { |
c0e8b12e C |
93 | const req = request(options.url).post(options.path) |
94 | .send(options.fields) | |
0e1dc3e7 | 95 | |
c0e8b12e | 96 | return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options }) |
0e1dc3e7 C |
97 | } |
98 | ||
99 | function makePutBodyRequest (options: { | |
a1587156 C |
100 | url: string |
101 | path: string | |
102 | token?: string | |
103 | fields: { [ fieldName: string ]: any } | |
c0e8b12e | 104 | expectedStatus?: HttpStatusCode |
4bbfc6c6 | 105 | }) { |
c0e8b12e C |
106 | const req = request(options.url).put(options.path) |
107 | .send(options.fields) | |
4bbfc6c6 | 108 | |
c0e8b12e | 109 | return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options }) |
4bbfc6c6 C |
110 | } |
111 | ||
9107d791 C |
112 | function decodeQueryString (path: string) { |
113 | return decode(path.split('?')[1]) | |
114 | } | |
115 | ||
c1bc8ee4 | 116 | function unwrapBody <T> (test: request.Test): Promise<T> { |
e8bd7ce7 C |
117 | return test.then(res => res.body) |
118 | } | |
119 | ||
c1bc8ee4 C |
120 | function unwrapText (test: request.Test): Promise<string> { |
121 | return test.then(res => res.text) | |
122 | } | |
123 | ||
0e1dc3e7 C |
124 | // --------------------------------------------------------------------------- |
125 | ||
126 | export { | |
e032aec9 | 127 | makeHTMLRequest, |
0e1dc3e7 | 128 | makeGetRequest, |
9107d791 | 129 | decodeQueryString, |
ac81d1a0 | 130 | makeUploadRequest, |
0e1dc3e7 | 131 | makePostBodyRequest, |
eec63bbc | 132 | makePutBodyRequest, |
4bbfc6c6 | 133 | makeDeleteRequest, |
09209296 | 134 | makeRawRequest, |
2d1ad5b9 | 135 | makeActivityPubGetRequest, |
c1bc8ee4 | 136 | unwrapBody, |
c0e8b12e C |
137 | unwrapText |
138 | } | |
139 | ||
140 | // --------------------------------------------------------------------------- | |
141 | ||
142 | function buildRequest (req: request.Test, options: CommonRequestParams) { | |
143 | if (options.contentType) req.set('Accept', options.contentType) | |
144 | if (options.token) req.set('Authorization', 'Bearer ' + options.token) | |
145 | if (options.range) req.set('Range', options.range) | |
146 | if (options.accept) req.set('Accept', options.accept) | |
147 | if (options.host) req.set('Host', options.host) | |
148 | if (options.redirects) req.redirects(options.redirects) | |
149 | if (options.expectedStatus) req.expect(options.expectedStatus) | |
150 | if (options.xForwardedFor) req.set('X-Forwarded-For', options.xForwardedFor) | |
151 | if (options.type) req.type(options.type) | |
152 | ||
153 | Object.keys(options.headers || {}).forEach(name => { | |
154 | req.set(name, options.headers[name]) | |
155 | }) | |
156 | ||
157 | return req | |
158 | } | |
159 | ||
160 | function buildFields (req: request.Test, fields: { [ fieldName: string ]: any }, namespace?: string) { | |
161 | if (!fields) return | |
162 | ||
163 | let formKey: string | |
164 | ||
165 | for (const key of Object.keys(fields)) { | |
166 | if (namespace) formKey = `${namespace}[${key}]` | |
167 | else formKey = key | |
168 | ||
169 | if (fields[key] === undefined) continue | |
170 | ||
171 | if (Array.isArray(fields[key]) && fields[key].length === 0) { | |
172 | req.field(key, null) | |
173 | continue | |
174 | } | |
175 | ||
176 | if (fields[key] !== null && typeof fields[key] === 'object') { | |
177 | buildFields(req, fields[key], formKey) | |
178 | } else { | |
179 | req.field(formKey, fields[key]) | |
180 | } | |
181 | } | |
0e1dc3e7 | 182 | } |