feat: improve validation errors

Signed-off-by: Michael Dawson <[email protected]>

Author: mhdawson

index.js

@@ -4,6 +4,7 @@ const fs = require('fs')
 const normalizeUrl = require('normalize-url')
 const Ajv = require('ajv')
 const got = require('got')
+const betterAjvErrors = require('better-ajv-errors')
 
 let ajv
 let compiledSchema
@@ -17,14 +18,15 @@ module.exports.defaultPackageSupport = 'package-support.json'
 
 module.exports.validateSupportElement = (obj) => {
   if (!ajvElement) {
-    ajvElement = new Ajv()
+    ajvElement = new Ajv({ jsonPointers: true })
     compiledSchemaElement = ajvElement.compile(supportElementSchema)
   }
 
   const validates = compiledSchemaElement(obj)
   if (!validates) {
     const err = new Error('Validation Failed')
     err.validationErrors = compiledSchemaElement.errors
+    err.prettyValidationErrors = betterAjvErrors(supportElementSchema, obj, compiledSchemaElement.errors)
     err.validationSchema = compiledSchemaElement.schema
     throw err
   }
@@ -33,14 +35,15 @@ module.exports.validateSupportElement = (obj) => {
 
 module.exports.validate = (obj) => {
   if (!ajv) {
-    ajv = new Ajv()
+    ajv = new Ajv({ jsonPointers: true })
     compiledSchema = ajv.compile(schema)
   }
 
   const validates = compiledSchema(obj)
   if (!validates) {
     const err = new Error('Validation Failed')
     err.validationErrors = compiledSchema.errors
+    err.prettyValidationErrors = betterAjvErrors(schema, obj, compiledSchema.errors)
     err.validationSchema = compiledSchema.schema
     throw err
   }

lib/cli/commands/validate.js

@@ -4,6 +4,8 @@ const fs = require('fs-extra')
 const path = require('path')
 const support = require('../../../index.js')
 
+const errorInSupportElement = 'Error in support element in package.json'
+
 module.exports = function (opts) {
   return {
     command: 'validate',
@@ -26,11 +28,18 @@ module.exports = function (opts) {
       let supportData = userPackageJson.support
       if ((supportData === false) || supportData) {
         // first validate that the supportData is correct
-        try {
-          support.validateSupportElement({ support: supportData })
-        } catch (e) {
-          argv.log.info('validate: ', e.validationErrors)
+        if ((supportData !== true) && !(supportData instanceof Object)) {
+          console.log(errorInSupportElement)
+          console.log('Support element should either be true or an Object matching the required schema')
           return
+        } else {
+          try {
+            support.validateSupportElement({ support: supportData })
+          } catch (e) {
+            console.log(errorInSupportElement)
+            console.log(e.prettyValidationErrors)
+            return
+          }
         }
 
         // support element was ok so validate the data itself
@@ -48,7 +57,7 @@ module.exports = function (opts) {
               return
             }
           } catch (e) {
-            argv.log.info('validate: ', e.validationErrors)
+            argv.log.info('validate: ', e.prettyValidationErrors)
           }
         } else {
           argv.log.info('support info not resolved: ' + supportData.url)

package.json

@@ -27,6 +27,7 @@
   "dependencies": {
     "@npmcli/arborist": "0.0.0-pre.19",
     "ajv": "^6.11.0",
+    "better-ajv-errors": "^0.6.7",
     "got": "^11.1.3",
     "loggerr": "^3.0.0-0",
     "normalize-url": "^5.0.0",

test/cli/validate-local-bad-element1/expected

@@ -1,29 +1,2 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/2/type',
-  params: { type: 'object' },
-  message: 'should be object'
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+Support element should either be true or an Object matching the required schema

test/cli/validate-local-bad-element2/expected

@@ -1,29 +1,2 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/2/type',
-  params: { type: 'object' },
-  message: 'should be object'
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+Support element should either be true or an Object matching the required schema

test/cli/validate-local-bad-element3/expected

@@ -1,29 +1,5 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'required',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/2/required',
-  params: { missingProperty: 'repository' },
-  message: "should have required property 'repository'"
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+REQUIRED should have required property 'repository'
+
+> 1 | {"support":{}}
+    |            ^ ☹️  repository is missing here!

test/cli/validate-local-repository-bad1/expected

@@ -1,29 +1,21 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'enum',
-  dataPath: '.support.repository.type',
-  schemaPath: '#Repository/properties/type/enum',
-  params: { allowedValues: [ 'git' ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+ENUM should be equal to one of the allowed values
+
+> 1 | {"support":{"repository":{"type":"xxx","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  enum should be equal to one of the allowed values
+
+TYPE should be string
+
+> 1 | {"support":{"repository":{"type":"xxx","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  type should be string
+
+ONEOF should match exactly one schema in oneOf
+
+> 1 | {"support":{"repository":{"type":"xxx","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  oneOf should match exactly one schema in oneOf
+
+ENUM should be equal to one of the allowed values
+(git)
+
+> 1 | {"support":{"repository":{"type":"xxx","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |                                  ^^^^^ 👈🏽  Did you mean git here?

test/cli/validate-local-repository-bad2/expected

@@ -1,29 +1,20 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'required',
-  dataPath: '.support.repository',
-  schemaPath: '#Repository/required',
-  params: { missingProperty: 'url' },
-  message: "should have required property 'url'"
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+ENUM should be equal to one of the allowed values
+
+> 1 | {"support":{"repository":{"type":"git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  enum should be equal to one of the allowed values
+
+TYPE should be string
+
+> 1 | {"support":{"repository":{"type":"git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  type should be string
+
+ONEOF should match exactly one schema in oneOf
+
+> 1 | {"support":{"repository":{"type":"git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  oneOf should match exactly one schema in oneOf
+
+REQUIRED should have required property 'url'
+
+> 1 | {"support":{"repository":{"type":"git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |                          ^ ☹️  url is missing here!

test/cli/validate-local-repository-bad3/expected

@@ -1,29 +1,20 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'required',
-  dataPath: '.support.repository',
-  schemaPath: '#Repository/required',
-  params: { missingProperty: 'type' },
-  message: "should have required property 'type'"
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+ENUM should be equal to one of the allowed values
+
+> 1 | {"support":{"repository":{"url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  enum should be equal to one of the allowed values
+
+TYPE should be string
+
+> 1 | {"support":{"repository":{"url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  type should be string
+
+ONEOF should match exactly one schema in oneOf
+
+> 1 | {"support":{"repository":{"url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  oneOf should match exactly one schema in oneOf
+
+REQUIRED should have required property 'type'
+
+> 1 | {"support":{"repository":{"url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2"},"path":"./MySupportPackage.json"}}
+    |                          ^ ☹️  type is missing here!

test/cli/validate-local-repository-bad4/expected

@@ -1,29 +1,20 @@
-info    › validate:  
-  - 0: {
-  keyword: 'enum',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/0/enum',
-  params: { allowedValues: [ true ] },
-  message: 'should be equal to one of the allowed values'
-}
-  - 1: {
-  keyword: 'type',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf/1/type',
-  params: { type: 'string' },
-  message: 'should be string'
-}
-  - 2: {
-  keyword: 'additionalProperties',
-  dataPath: '.support.repository',
-  schemaPath: '#Repository/additionalProperties',
-  params: { additionalProperty: 'extra' },
-  message: 'should NOT have additional properties'
-}
-  - 3: {
-  keyword: 'oneOf',
-  dataPath: '.support',
-  schemaPath: '#/properties/support/oneOf',
-  params: { passingSchemas: null },
-  message: 'should match exactly one schema in oneOf'
-}
+Error in support element in package.json
+ENUM should be equal to one of the allowed values
+
+> 1 | {"support":{"repository":{"type":"git","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2","extra":"123"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  enum should be equal to one of the allowed values
+
+TYPE should be string
+
+> 1 | {"support":{"repository":{"type":"git","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2","extra":"123"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  type should be string
+
+ONEOF should match exactly one schema in oneOf
+
+> 1 | {"support":{"repository":{"type":"git","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2","extra":"123"},"path":"./MySupportPackage.json"}}
+    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 👈🏽  oneOf should match exactly one schema in oneOf
+
+ADDTIONAL PROPERTY should NOT have additional properties
+
+> 1 | {"support":{"repository":{"type":"git","url":"https://github.com/pkgjs/support-separate-repo-other.git","directory":"subdir2","extra":"123"},"path":"./MySupportPackage.json"}}
+    |                                                                                                                               ^^^^^^^ 😲  extra is not expected to be here!