Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 2 additions & 79 deletions src/router/RouteSchema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,11 @@ export async function parseRequestWithZod(
}

if (requestSchemas.params) {
req.params = await parseSchema(
requestSchemas.params,
coerceDataForValidation(requestSchemas.params, req.params)
)
req.params = await parseSchema(requestSchemas.params, req.params)
}

if (requestSchemas.querystring) {
req.query = await parseSchema(
requestSchemas.querystring,
coerceDataForValidation(requestSchemas.querystring, req.query)
)
req.query = await parseSchema(requestSchemas.querystring, req.query)
}
}

Expand Down Expand Up @@ -160,77 +154,6 @@ function toJsonSchema(schema: ZodAny, io: 'input' | 'output') {
return jsonSchema
}

function coerceDataForValidation(schema: ZodAny, data: any) {
return coerceDataByJsonSchema(toJsonSchema(schema, 'input'), data)
}

function coerceDataByJsonSchema(schema: any, data: any): any {
if (Is.Undefined(data) || Is.Null(data) || !schema) {
return data
}

if (schema.anyOf) {
return coerceWithAlternatives(schema.anyOf, data)
}

if (schema.oneOf) {
return coerceWithAlternatives(schema.oneOf, data)
}

if (schema.type === 'object' && Is.Object(data)) {
const coerced = { ...data }
const properties = schema.properties || {}

Object.entries(properties).forEach(([key, childSchema]) => {
if (!Object.hasOwn(coerced, key)) {
return
}

coerced[key] = coerceDataByJsonSchema(childSchema, coerced[key])
})

return coerced
}

if (schema.type === 'array' && Is.Array(data) && schema.items) {
return data.map(item => coerceDataByJsonSchema(schema.items, item))
}

if (schema.type === 'number' || schema.type === 'integer') {
return coerceNumber(data, schema.type === 'integer')
}

return data
}

function coerceWithAlternatives(schemas: any[], data: any) {
let coerced = data

schemas.forEach(schema => {
coerced = coerceDataByJsonSchema(schema, coerced)
})

return coerced
}

function coerceNumber(value: any, integerOnly: boolean) {
if (!Is.String(value) || value.trim() === '') {
return value
}

const parsed = integerOnly ? Number.parseInt(value, 10) : Number(value)

if (Number.isNaN(parsed)) {
return value
}

if (integerOnly && !Number.isInteger(parsed)) {
return value
}

return parsed
}

function isZodSchema(value: any): value is ZodAny {
return (
Is.Defined(value) &&
Expand Down
10 changes: 5 additions & 5 deletions tests/unit/router/RouteTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,15 @@ export default class RouteTest {
}

@Test()
public async shouldAutomaticallyCoerceZodQuerystringAndParams({ assert }: Context) {
public async shouldBeAbleToUseExplicitZodCoercionForQuerystringAndParams({ assert }: Context) {
Route.get('users/:id', async ctx => {
await ctx.response.send({
id: ctx.request.param('id'),
limit: ctx.request.query('limit')
})
}).schema({
params: z.object({ id: z.number() }),
querystring: z.object({ limit: z.number() }),
params: z.object({ id: z.coerce.number() }),
querystring: z.object({ limit: z.coerce.number() }),
response: {
200: z.object({
id: z.number(),
Expand All @@ -178,8 +178,8 @@ export default class RouteTest {
Config.set('openapi.paths', {
'/users/{id}': {
get: {
params: z.object({ id: z.number() }),
querystring: z.object({ limit: z.number() }),
params: z.object({ id: z.coerce.number() }),
querystring: z.object({ limit: z.coerce.number() }),
response: {
200: z.object({
id: z.number(),
Expand Down
Loading