-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
coerce-parameter.ts
293 lines (257 loc) · 8.02 KB
/
coerce-parameter.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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
// Copyright IBM Corp. and LoopBack contributors 2018,2019. 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 {
isReferenceObject,
ParameterObject,
ReferenceObject,
SchemaObject,
} from '@loopback/openapi-v3';
import debugModule from 'debug';
import {
RestHttpErrors,
validateValueAgainstSchema,
ValueValidationOptions,
} from '../';
import {parseJson, sanitizeJsonParse} from '../parse-json';
import {ValidationOptions} from '../types';
import {DEFAULT_AJV_VALIDATION_OPTIONS} from '../validation/ajv-factory.provider';
import {
DateCoercionOptions,
getOAIPrimitiveType,
IntegerCoercionOptions,
isEmpty,
isFalse,
isTrue,
isValidDateTime,
matchDateFormat,
} from './utils';
import {Validator} from './validator';
const isRFC3339 = require('validator/lib/isRFC3339');
const debug = debugModule('loopback:rest:coercion');
/**
* Coerce the http raw data to a JavaScript type data of a parameter
* according to its OpenAPI schema specification.
*
* @param data - The raw data get from http request
* @param schema - The parameter's schema defined in OpenAPI specification
* @param options - The ajv validation options
*/
export async function coerceParameter(
data: string | undefined | object,
spec: ParameterObject,
options?: ValueValidationOptions,
) {
const schema = extractSchemaFromSpec(spec);
if (!schema || isReferenceObject(schema)) {
debug(
'The parameter with schema %s is not coerced since schema' +
'dereference is not supported yet.',
schema,
);
return data;
}
const OAIType = getOAIPrimitiveType(schema.type, schema.format);
const validator = new Validator({parameterSpec: spec});
validator.validateParamBeforeCoercion(data);
if (data === undefined) return data;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let result: any = data;
switch (OAIType) {
case 'byte':
result = coerceBuffer(data, spec);
break;
case 'date':
result = coerceDatetime(data, spec, {dateOnly: true});
break;
case 'date-time':
result = coerceDatetime(data, spec);
break;
case 'float':
case 'double':
case 'number':
result = coerceNumber(data, spec);
break;
case 'long':
result = coerceInteger(data, spec, {isLong: true});
break;
case 'integer':
result = coerceInteger(data, spec);
break;
case 'boolean':
result = coerceBoolean(data, spec);
break;
case 'object':
result = await coerceObject(data, spec, options);
break;
case 'string':
case 'password':
result = coerceString(data, spec);
break;
case 'array':
result = coerceArray(data, spec);
break;
}
if (result != null) {
// For date/date-time/byte, we need to pass the raw string value to AJV
if (OAIType === 'date' || OAIType === 'date-time' || OAIType === 'byte') {
await validateParam(spec, data, options);
return result;
}
result = await validateParam(spec, result, options);
}
return result;
}
function coerceString(data: string | object, spec: ParameterObject) {
if (typeof data !== 'string')
throw RestHttpErrors.invalidData(data, spec.name);
debug('data of type string is coerced to %s', data);
return data;
}
function coerceBuffer(data: string | object, spec: ParameterObject) {
if (typeof data === 'object')
throw RestHttpErrors.invalidData(data, spec.name);
return Buffer.from(data, 'base64');
}
function coerceDatetime(
data: string | object,
spec: ParameterObject,
options?: DateCoercionOptions,
) {
if (typeof data === 'object' || isEmpty(data))
throw RestHttpErrors.invalidData(data, spec.name);
if (options?.dateOnly) {
if (!matchDateFormat(data))
throw RestHttpErrors.invalidData(data, spec.name);
} else {
if (!isRFC3339(data)) throw RestHttpErrors.invalidData(data, spec.name);
}
const coercedDate = new Date(data);
if (!isValidDateTime(coercedDate))
throw RestHttpErrors.invalidData(data, spec.name);
return coercedDate;
}
function coerceNumber(data: string | object, spec: ParameterObject) {
if (typeof data === 'object' || isEmpty(data))
throw RestHttpErrors.invalidData(data, spec.name);
const coercedNum = Number(data);
if (isNaN(coercedNum)) throw RestHttpErrors.invalidData(data, spec.name);
debug('data of type number is coerced to %s', coercedNum);
return coercedNum;
}
function coerceInteger(
data: string | object,
spec: ParameterObject,
options?: IntegerCoercionOptions,
) {
if (typeof data === 'object' || isEmpty(data))
throw RestHttpErrors.invalidData(data, spec.name);
const coercedInt = Number(data);
if (isNaN(coercedInt!)) throw RestHttpErrors.invalidData(data, spec.name);
if (options?.isLong) {
if (!Number.isInteger(coercedInt))
throw RestHttpErrors.invalidData(data, spec.name);
} else {
if (!Number.isSafeInteger(coercedInt))
throw RestHttpErrors.invalidData(data, spec.name);
}
debug('data of type integer is coerced to %s', coercedInt);
return coercedInt;
}
function coerceBoolean(data: string | object, spec: ParameterObject) {
if (typeof data === 'object' || isEmpty(data))
throw RestHttpErrors.invalidData(data, spec.name);
if (isTrue(data)) return true;
if (isFalse(data)) return false;
throw RestHttpErrors.invalidData(data, spec.name);
}
async function coerceObject(
input: string | object,
spec: ParameterObject,
options?: ValidationOptions,
) {
const data = parseJsonIfNeeded(input, spec, options);
if (data == null) {
// Skip any further checks and coercions, nothing we can do with `undefined`
return data;
}
if (typeof data !== 'object' || Array.isArray(data))
throw RestHttpErrors.invalidData(input, spec.name);
return data;
}
function coerceArray(data: string | object, spec: ParameterObject) {
if (spec.in === 'query') {
if (data == null || Array.isArray(data)) return data;
return [data];
}
return data;
}
function validateParam(
spec: ParameterObject,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
data: any,
options: ValidationOptions = DEFAULT_AJV_VALIDATION_OPTIONS,
) {
const schema = extractSchemaFromSpec(spec);
if (schema) {
// Apply coercion based on properties defined by spec.schema
return validateValueAgainstSchema(
data,
schema,
{},
{...options, coerceTypes: true, source: 'parameter', name: spec.name},
);
}
return data;
}
/**
* Extract the schema from an OpenAPI parameter specification. If the root level
* one not found, search from media type 'application/json'.
*
* @param spec The parameter specification
*/
function extractSchemaFromSpec(
spec: ParameterObject,
): SchemaObject | ReferenceObject | undefined {
let schema = spec.schema;
// If a query parameter is a url encoded Json object,
// the schema is defined under content['application/json']
if (!schema && spec.in === 'query') {
schema = spec.content?.['application/json']?.schema;
}
return schema;
}
function parseJsonIfNeeded(
data: string | object,
spec: ParameterObject,
options?: ValidationOptions,
): string | object | undefined {
if (typeof data !== 'string') return data;
if (spec.in !== 'query' || (spec.in === 'query' && !spec.content)) {
debug(
'Skipping JSON.parse, argument %s is not a url encoded json object query parameter (since content field is missing in parameter schema)',
spec.name,
);
return data;
}
if (data === '') {
debug('Converted empty string to object value `undefined`');
return undefined;
}
try {
const result = parseJson(
data,
sanitizeJsonParse(undefined, options?.prohibitedKeys),
);
debug('Parsed parameter %s as %j', spec.name, result);
return result;
} catch (err) {
debug('Cannot parse %s value %j as JSON: %s', spec.name, data, err.message);
throw RestHttpErrors.invalidData(data, spec.name, {
details: {
syntaxError: err.message,
},
});
}
}