-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
request-parsing.acceptance.ts
192 lines (179 loc) · 5.41 KB
/
request-parsing.acceptance.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
// Node module: @loopback/rest
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT
import {inject} from '@loopback/core';
import {
Client,
createRestAppClient,
expect,
givenHttpServerConfig,
} from '@loopback/testlab';
import {OptionsUrlencoded} from 'body-parser';
import crypto from 'crypto';
import qs from 'qs';
import {
getParserOptions,
JsonBodyParser,
post,
RawBodyParser,
Request,
requestBody,
RequestBodyParserOptions,
RestApplication,
RestBindings,
} from '../../..';
describe('request parsing', () => {
let client: Client;
let app: RestApplication;
let parsedRequestBodyValue: unknown;
beforeEach(givenAClient);
afterEach(async () => {
await app.stop();
});
it('supports x-parser extension', async () => {
await postRequest('/show-body-json');
});
it('allows built-in body parsers to be overridden', async () => {
class MyJsonBodyParser extends JsonBodyParser {
supports(mediaType: string) {
return false;
}
}
app.bodyParser(MyJsonBodyParser, RestBindings.REQUEST_BODY_PARSER_JSON);
await postRequest('/show-body', 415);
await postRequest('/show-body-json');
});
it('invokes custom body parsers before built-in ones', async () => {
let invoked = false;
class MyJsonBodyParser extends JsonBodyParser {
name = Symbol('my-json');
async parse(request: Request) {
const body = await super.parse(request);
invoked = true;
return body;
}
}
app.bodyParser(MyJsonBodyParser);
await client
.post('/show-body')
.set('Content-Type', 'application/json')
.send({key: 'value'})
.expect(200, {key: 'new-value'});
expect(invoked).to.be.true();
});
it('invokes custom body parsers to calculate hash', async () => {
let invoked = false;
class UrlEncodedBodyParserForHash extends RawBodyParser {
private urlEncodedOptions: OptionsUrlencoded;
constructor(
@inject(RestBindings.REQUEST_BODY_PARSER_OPTIONS, {optional: true})
private options: RequestBodyParserOptions = {},
) {
super(options);
this.urlEncodedOptions = getParserOptions('urlencoded', this.options);
}
async parse(request: Request) {
const body = await super.parse(request);
const buffer = body.value;
const hash = crypto.createHash('sha256').update(buffer).digest('hex');
// We cannot use UrlEncodedParser as `request.body` is set by `RawBodyParser`
const value = qs.parse(
buffer.toString('utf-8'),
this.urlEncodedOptions,
);
value.hash = hash;
invoked = true;
body.value = value;
return body;
}
}
app.controller(
givenBodyParamController(
'/show-body-encoded',
UrlEncodedBodyParserForHash,
),
'Controller3',
);
await client
.post('/show-body-encoded')
.set('Content-Type', 'application/x-www-form-urlencoded')
.send({key: 'value'})
.expect(200, {
key: 'new-value',
parser: 'UrlEncodedBodyParserForHash',
});
expect(invoked).to.be.true();
});
it('allows built-in body parsers to be removed', async () => {
app.unbind(RestBindings.REQUEST_BODY_PARSER_JSON);
await postRequest('/show-body', 415);
});
async function givenAClient() {
parsedRequestBodyValue = undefined;
app = new RestApplication({rest: givenHttpServerConfig()});
app.controller(
givenBodyParamController('/show-body-json', 'json'),
'Controller1',
);
app.controller(givenBodyParamController('/show-body'), 'Controller2');
await app.start();
client = createRestAppClient(app);
}
async function postRequest(url = '/show-body', expectedStatusCode = 200) {
const res = await client
.post(url)
.set('Content-Type', 'application/json')
.send({key: 'value'})
.expect(expectedStatusCode);
if (expectedStatusCode === 200) {
expect(parsedRequestBodyValue).to.eql({key: 'value'});
}
return res;
}
function givenBodyParamController(url: string, parser?: string | Function) {
class RouteParamController {
@post(url, {
responses: {
200: {
content: {
'application/json': {
schema: {
type: 'object',
},
},
},
description: '',
},
},
})
async showBody(
@requestBody({
required: true,
content: {
'application/json': {
// Customize body parsing
'x-parser': parser,
schema: {type: 'object'},
},
'application/x-www-form-urlencoded': {
// Customize body parsing
'x-parser': parser,
schema: {type: 'object'},
},
},
})
request: // eslint-disable-next-line @typescript-eslint/no-explicit-any
any,
): Promise<object> {
parsedRequestBodyValue = request;
if (parser === 'stream') {
parsedRequestBodyValue = request.body;
}
const parserName = typeof parser === 'string' ? parser : parser?.name;
return {key: 'new-value', parser: parserName};
}
}
return RouteParamController;
}
});