Convert string as number to support numbers in query params

SamyPesse · SamyPesse · commit 79aba63575dc · 2023-10-20T18:53:30.000+02:00
diff --git a/src/compileValueSchema.ts b/src/compileValueSchema.ts
@@ -616,12 +616,48 @@ function compileNumberSchema(
             return [...nodes, ...enumCheck];
         }
 
+        // Try to convert the value to a number
         nodes.push(
             builders.ifStatement(
                 builders.binaryExpression(
-                    '!==',
+                    '===',
                     builders.unaryExpression('typeof', value),
-                    builders.literal('number'),
+                    builders.literal('string'),
+                ),
+                builders.blockStatement([
+                    builders.expressionStatement(
+                        builders.assignmentExpression(
+                            '=',
+                            value,
+                            builders.callExpression(
+                                builders.memberExpression(
+                                    builders.identifier('Number'),
+                                    builders.identifier('parseFloat'),
+                                ),
+                                [value],
+                            ),
+                        ),
+                    ),
+                ]),
+            ),
+        );
+
+        nodes.push(
+            builders.ifStatement(
+                builders.logicalExpression(
+                    '||',
+                    builders.binaryExpression(
+                        '!==',
+                        builders.unaryExpression('typeof', value),
+                        builders.literal('number'),
+                    ),
+                    builders.callExpression(
+                        builders.memberExpression(
+                            builders.identifier('Number'),
+                            builders.identifier('isNaN'),
+                        ),
+                        [value],
+                    ),
                 ),
                 builders.blockStatement([builders.returnStatement(error('expected a number'))]),
             ),
diff --git a/src/tests/__snapshots__/compileValueSchema.test.ts.snap b/src/tests/__snapshots__/compileValueSchema.test.ts.snap
@@ -29,7 +29,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj0(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -65,7 +68,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj0(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -104,7 +110,10 @@ function obj0(path, value, context) {
     if (value === null) {
         return value;
     }
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -256,7 +265,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj1(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -331,7 +343,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj1(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -425,7 +440,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj1(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -482,7 +500,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj1(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -713,7 +734,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj1(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -766,7 +790,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj1(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -826,7 +853,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj2(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
diff --git a/src/tests/__snapshots__/compiler.test.ts.snap b/src/tests/__snapshots__/compiler.test.ts.snap
@@ -29,7 +29,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj0(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
@@ -102,7 +105,10 @@ export class ValidationError extends RequestError {
     }
 }
 function obj0(path, value, context) {
-    if (typeof value !== 'number') {
+    if (typeof value === 'string') {
+        value = Number.parseFloat(value);
+    }
+    if (typeof value !== 'number' || Number.isNaN(value)) {
         return new ValidationError(path, 'expected a number');
     }
     return value;
diff --git a/tests/gitbook.test.ts b/tests/gitbook.test.ts
@@ -55,6 +55,27 @@ test('GET orgs/microsoft/collections?limit=invalid', () => {
     expect(result instanceof ValidationError ? result.path : null).toEqual(['query', 'limit']);
 });
 
+test('GET orgs/microsoft/collections?limit=10', () => {
+    const result = validateRequest({
+        path: '/orgs/microsoft/collections',
+        method: 'get',
+        headers: {
+            'content-type': 'application/json',
+        },
+        query: {
+            limit: '10',
+        },
+    });
+    expect(result).toMatchObject({
+        params: {
+            organizationId: 'microsoft',
+        },
+        query: {
+            limit: 10,
+        },
+    });
+});
+
 test('POST orgs/appleId/custom-fields', () => {
     const result = validateRequest({
         path: '/orgs/appleId/spaces',

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,10 @@ export class ValidationError extends RequestError {`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`	`function obj0(path, value, context) {`
`32`		`- if (typeof value !== 'number') {`
	`32`	`+ if (typeof value === 'string') {`
	`33`	`+ value = Number.parseFloat(value);`
	`34`	`+ }`
	`35`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`33`	`36`	`return new ValidationError(path, 'expected a number');`
`34`	`37`	`}`
`35`	`38`	`return value;`
`@@ -65,7 +68,10 @@ export class ValidationError extends RequestError {`
`65`	`68`	`}`
`66`	`69`	`}`
`67`	`70`	`function obj0(path, value, context) {`
`68`		`- if (typeof value !== 'number') {`
	`71`	`+ if (typeof value === 'string') {`
	`72`	`+ value = Number.parseFloat(value);`
	`73`	`+ }`
	`74`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`69`	`75`	`return new ValidationError(path, 'expected a number');`
`70`	`76`	`}`
`71`	`77`	`return value;`
`@@ -104,7 +110,10 @@ function obj0(path, value, context) {`
`104`	`110`	`if (value === null) {`
`105`	`111`	`return value;`
`106`	`112`	`}`
`107`		`- if (typeof value !== 'number') {`
	`113`	`+ if (typeof value === 'string') {`
	`114`	`+ value = Number.parseFloat(value);`
	`115`	`+ }`
	`116`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`108`	`117`	`return new ValidationError(path, 'expected a number');`
`109`	`118`	`}`
`110`	`119`	`return value;`
`@@ -256,7 +265,10 @@ export class ValidationError extends RequestError {`
`256`	`265`	`}`
`257`	`266`	`}`
`258`	`267`	`function obj1(path, value, context) {`
`259`		`- if (typeof value !== 'number') {`
	`268`	`+ if (typeof value === 'string') {`
	`269`	`+ value = Number.parseFloat(value);`
	`270`	`+ }`
	`271`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`260`	`272`	`return new ValidationError(path, 'expected a number');`
`261`	`273`	`}`
`262`	`274`	`return value;`
`@@ -331,7 +343,10 @@ export class ValidationError extends RequestError {`
`331`	`343`	`}`
`332`	`344`	`}`
`333`	`345`	`function obj1(path, value, context) {`
`334`		`- if (typeof value !== 'number') {`
	`346`	`+ if (typeof value === 'string') {`
	`347`	`+ value = Number.parseFloat(value);`
	`348`	`+ }`
	`349`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`335`	`350`	`return new ValidationError(path, 'expected a number');`
`336`	`351`	`}`
`337`	`352`	`return value;`
`@@ -425,7 +440,10 @@ export class ValidationError extends RequestError {`
`425`	`440`	`}`
`426`	`441`	`}`
`427`	`442`	`function obj1(path, value, context) {`
`428`		`- if (typeof value !== 'number') {`
	`443`	`+ if (typeof value === 'string') {`
	`444`	`+ value = Number.parseFloat(value);`
	`445`	`+ }`
	`446`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`429`	`447`	`return new ValidationError(path, 'expected a number');`
`430`	`448`	`}`
`431`	`449`	`return value;`
`@@ -482,7 +500,10 @@ export class ValidationError extends RequestError {`
`482`	`500`	`}`
`483`	`501`	`}`
`484`	`502`	`function obj1(path, value, context) {`
`485`		`- if (typeof value !== 'number') {`
	`503`	`+ if (typeof value === 'string') {`
	`504`	`+ value = Number.parseFloat(value);`
	`505`	`+ }`
	`506`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`486`	`507`	`return new ValidationError(path, 'expected a number');`
`487`	`508`	`}`
`488`	`509`	`return value;`
`@@ -713,7 +734,10 @@ export class ValidationError extends RequestError {`
`713`	`734`	`}`
`714`	`735`	`}`
`715`	`736`	`function obj1(path, value, context) {`
`716`		`- if (typeof value !== 'number') {`
	`737`	`+ if (typeof value === 'string') {`
	`738`	`+ value = Number.parseFloat(value);`
	`739`	`+ }`
	`740`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`717`	`741`	`return new ValidationError(path, 'expected a number');`
`718`	`742`	`}`
`719`	`743`	`return value;`
`@@ -766,7 +790,10 @@ export class ValidationError extends RequestError {`
`766`	`790`	`}`
`767`	`791`	`}`
`768`	`792`	`function obj1(path, value, context) {`
`769`		`- if (typeof value !== 'number') {`
	`793`	`+ if (typeof value === 'string') {`
	`794`	`+ value = Number.parseFloat(value);`
	`795`	`+ }`
	`796`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`770`	`797`	`return new ValidationError(path, 'expected a number');`
`771`	`798`	`}`
`772`	`799`	`return value;`
`@@ -826,7 +853,10 @@ export class ValidationError extends RequestError {`
`826`	`853`	`}`
`827`	`854`	`}`
`828`	`855`	`function obj2(path, value, context) {`
`829`		`- if (typeof value !== 'number') {`
	`856`	`+ if (typeof value === 'string') {`
	`857`	`+ value = Number.parseFloat(value);`
	`858`	`+ }`
	`859`	`+ if (typeof value !== 'number' \|\| Number.isNaN(value)) {`
`830`	`860`	`return new ValidationError(path, 'expected a number');`
`831`	`861`	`}`
`832`	`862`	`return value;`