fix: Improved validation handling.

Author: Shogun

lib/validation.js

@@ -62,11 +62,17 @@ function convertValidationErrors(section, data, validationErrors) {
     if (section === 'querystring') {
         section = 'query';
     }
+    // For each error
     for (const e of validationErrors) {
-        // For each error
-        let baseKey = e.dataPath.substring(e.dataPath.startsWith('.') ? 1 : 0);
-        let key = baseKey;
         let message = '';
+        // Normalize the key
+        let key = e.dataPath;
+        if (key.startsWith('.')) {
+            key = key.substring(1);
+        }
+        if (key.startsWith('[') && key.endsWith(']')) {
+            key = key.substring(1, key.length - 1);
+        }
         // Depending on the type
         switch (e.keyword) {
             case 'required':
@@ -128,12 +134,15 @@ function convertValidationErrors(section, data, validationErrors) {
             message = `${e.message.replace(/^should/, 'must')} (${e.keyword})`;
         }
         // Find the property to add
-        let property = Array.from(new Set([baseKey, key].filter((p) => p)))
-            .join('.')
-            .replace(/\[(\d+)\]/g, '.$1');
+        let property = key
+            .replace(/\[(\d+)\]/g, '.$1') // Array path
+            .replace(/\[([^\]]+)\]/g, '.$1'); // Object path
         if (!property) {
             property = '$root';
         }
+        if (property.match(/(?:^['"])(?:[^\.]+)(?:['"]$)/)) {
+            property = property.substring(1, property.length - 1);
+        }
         errors[property] = message;
     }
     return { [section]: errors };

package.json

@@ -28,11 +28,10 @@
   "scripts": {
     "lint": "tslint --project tsconfig.test.json -t stylish src/*.ts test/*.ts",
     "test": "jest test --coverage --coverageReporters=html --coverageReporters=text",
-    "ci": "jest test --coverage --ci --coverageReporters=json",
-    "sanity": "yarn lint && yarn test",
+    "ci": "yarn lint && jest --coverage --coverageThreshold='{\"global\":{\"branches\":90,\"functions\":90,\"lines\":90,\"statements\":90}}' --ci --coverageReporters=json",
     "prebuild": "rm -rf lib/* types/* && yarn lint",
     "build": "tsc -p .",
-    "prepublishOnly": "yarn sanity",
+    "prepublishOnly": "yarn ci",
     "postpublish": "git push origin && git push origin -f --tags"
   },
   "dependencies": {

src/validation.ts

@@ -85,12 +85,21 @@ export function convertValidationErrors(
     section = 'query'
   }
 
+  // For each error
   for (const e of validationErrors) {
-    // For each error
-    let baseKey = e.dataPath.substring(e.dataPath.startsWith('.') ? 1 : 0)
-    let key = baseKey
     let message = ''
 
+    // Normalize the key
+    let key = e.dataPath
+
+    if (key.startsWith('.')) {
+      key = key.substring(1)
+    }
+
+    if (key.startsWith('[') && key.endsWith(']')) {
+      key = key.substring(1, key.length - 1)
+    }
+
     // Depending on the type
     switch (e.keyword) {
       case 'required':
@@ -159,10 +168,16 @@ export function convertValidationErrors(
     }
 
     // Find the property to add
-    let property = Array.from(new Set([baseKey, key].filter((p: string) => p)))
-      .join('.')
-      .replace(/\[(\d+)\]/g, '.$1')
+    let property = key
+      .replace(/\[(\d+)\]/g, '.$1') // Array path
+      .replace(/\[([^\]]+)\]/g, '.$1') // Object path
+
+    // Remove useless quotes
+    if (property.match(/(?:^['"])(?:[^\.]+)(?:['"]$)/)) {
+      property = property.substring(1, property.length - 1)
+    }
 
+    // Fix empty properties
     if (!property) {
       property = '$root'
     }

test/validation.spec.ts

@@ -2,7 +2,7 @@ import Ajv from 'ajv'
 import { ValidationResult } from 'fastify'
 import { convertValidationErrors, niceJoin } from '../src'
 
-describe.only('Validation', function(): void {
+describe('Validation', function(): void {
   it('should correctly parse validation errors', function(): void {
     const ajv = new Ajv({
       removeAdditional: false,
@@ -125,10 +125,16 @@ describe.only('Validation', function(): void {
         objectPath: {
           type: 'object',
           properties: {
-            abc: {
+            'x-abc': {
+              type: 'number'
+            },
+            cde: {
               type: 'number'
             }
           }
+        },
+        'needs-quotes': {
+          type: 'number'
         }
       },
       additionalProperties: false,
@@ -162,8 +168,10 @@ describe.only('Validation', function(): void {
       noMessage: true,
       arrayPath: ['abc'],
       objectPath: {
-        abc: 'abc'
-      }
+        'x-abc': 'abc',
+        cde: 'cde'
+      },
+      'needs-quotes': 'nq'
     }
 
     const expected = {
@@ -180,7 +188,8 @@ describe.only('Validation', function(): void {
         minItems: 'must be an array with at least 2 items',
         maxItems: 'must be an array with at most 2 items',
         'arrayPath.0': 'must be a valid number',
-        'objectPath.abc': 'must be a valid number',
+        "objectPath.'x-abc'": 'must be a valid number',
+        'objectPath.cde': 'must be a valid number',
         minimum: 'must be a number greater than or equal to 5',
         maximum: 'must be a number less than or equal to 5',
         number: 'must be a valid number',
@@ -195,7 +204,8 @@ describe.only('Validation', function(): void {
         response:
           'The response returned from the endpoint violates its specification for the HTTP status invalidResponse.',
         responseCode: 'This endpoint cannot respond with HTTP status invalidResponseCode.',
-        noMessage: 'must match format "noMessage" (format)'
+        noMessage: 'must match format "noMessage" (format)',
+        'needs-quotes': 'must be a valid number'
       }
     }