@openaddresses/batch-schema 10.21.0 → 10.22.0

package/CHANGELOG.md

@@ -10,6 +10,10 @@
 
 ## Version History
 
+### v10.22.0
+
+- :rocket: Increase usefulness of schema error messages by including the schema path and the value that failed validation
+
 ### v10.21.0
 
 - :rocket: Surface outgoing schema errors in the logs

package/lib/schema.ts

@@ -159,7 +159,11 @@ export default class Schemas {
                 const errors: Array<ErrorListItem> = [];
                 if (paramsValidation && !paramsValidation(req.params)) errors.push({ type: 'Params', errors: paramsValidation.errors as ErrorObject[] });
                 if (queryValidation && !queryValidation(req.query)) errors.push({ type: 'Query', errors: queryValidation.errors as ErrorObject[] });
-                if (errors.length) return Err.respond(new Err(400, null, 'Validation Error'), res, errors);
+                if (errors.length) {
+                    return Err.respond(new Err(
+                        400, null, `Validation Error GET ${path}`
+                    ), res, errors);
+                }
 
                 const json = res.json;
                 res.json = function(obj) {
@@ -207,7 +211,11 @@ export default class Schemas {
                 const errors: Array<ErrorListItem> = [];
                 if (paramsValidation && !paramsValidation(req.params)) errors.push({ type: 'Params', errors: paramsValidation.errors as ErrorObject[] });
                 if (queryValidation && !queryValidation(req.query)) errors.push({ type: 'Query', errors: queryValidation.errors as ErrorObject[] });
-                if (errors.length) return Err.respond(new Err(400, null, 'Validation Error'), res, errors);
+                if (errors.length) {
+                    return Err.respond(new Err(
+                        400, null, `Validation Error DELETE ${path}`
+                    ), res, errors);
+                }
 
                 const json = res.json;
                 res.json = function(obj) {
@@ -256,7 +264,11 @@ export default class Schemas {
                 if (paramsValidation && !paramsValidation(req.params)) errors.push({ type: 'Params', errors: paramsValidation.errors as ErrorObject[] });
                 if (queryValidation && !queryValidation(req.query)) errors.push({ type: 'Query', errors: queryValidation.errors as ErrorObject[] });
                 if (bodyValidation && !bodyValidation(req.body)) errors.push({ type: 'Body', errors: bodyValidation.errors as ErrorObject[] });
-                if (errors.length) return Err.respond(new Err(400, null, 'Validation Error'), res, errors);
+                if (errors.length) {
+                    return Err.respond(new Err(
+                        400, null, `Validation Error POST ${path}`
+                    ), res, errors);
+                }
 
                 const json = res.json;
                 res.json = function(obj) {
@@ -305,7 +317,11 @@ export default class Schemas {
                 if (paramsValidation && !paramsValidation(req.params)) errors.push({ type: 'Params', errors: paramsValidation.errors as ErrorObject[] });
                 if (queryValidation && !queryValidation(req.query)) errors.push({ type: 'Query', errors: queryValidation.errors as ErrorObject[] });
                 if (bodyValidation && !bodyValidation(req.body)) errors.push({ type: 'Body', errors: bodyValidation.errors as ErrorObject[] });
-                if (errors.length) return Err.respond(new Err(400, null, 'Validation Error'), res, errors);
+                if (errors.length) {
+                    return Err.respond(new Err(
+                        400, null, `Validation Error PATCH ${path}`
+                    ), res, errors);
+                }
 
                 const json = res.json;
                 res.json = function(obj) {
@@ -354,7 +370,11 @@ export default class Schemas {
                 if (paramsValidation && !paramsValidation(req.params)) errors.push({ type: 'Params', errors: paramsValidation.errors as ErrorObject[] });
                 if (queryValidation && !queryValidation(req.query)) errors.push({ type: 'Query', errors: queryValidation.errors as ErrorObject[] });
                 if (bodyValidation && !bodyValidation(req.body)) errors.push({ type: 'Body', errors: bodyValidation.errors as ErrorObject[] });
-                if (errors.length) return Err.respond(new Err(400, null, 'Validation Error'), res, errors);
+                if (errors.length) {
+                    return Err.respond(new Err(
+                        400, null, `Validation Error PUT ${path}`
+                    ), res, errors);
+                }
 
                 const json = res.json;
                 res.json = function(obj) {

package/package.json

@@ -4,7 +4,7 @@
     "root": true,
     "main": "dist/index.js",
     "types": "index.ts",
-    "version": "10.21.0",
+    "version": "10.22.0",
     "description": "Strongly Validated JSON Schema support for address",
     "repository": "git@github.com:openaddresses/batch-schema",
     "author": "ingalls <nick@ingalls.ca>",

package/test/schema.srv.test.ts

@@ -48,7 +48,7 @@ test('GET: api/schema?method=FAKE', async (t) => {
 
         t.deepEquals(await res.json(), {
             status: 400,
-            message: 'Validation Error',
+            message: 'Validation Error GET /schema',
             messages: [
                 {"type":"Query","errors":[{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/0/const","keyword":"const","params":{"allowedValue":"GET"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/1/const","keyword":"const","params":{"allowedValue":"PUT"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/2/const","keyword":"const","params":{"allowedValue":"POST"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/3/const","keyword":"const","params":{"allowedValue":"DELETE"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/4/const","keyword":"const","params":{"allowedValue":"OPTIONS"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/5/const","keyword":"const","params":{"allowedValue":"HEAD"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/6/const","keyword":"const","params":{"allowedValue":"PATCH"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf/7/const","keyword":"const","params":{"allowedValue":"TRACE"},"message":"must be equal to constant"},{"instancePath":"/method","schemaPath":"#/properties/method/anyOf","keyword":"anyOf","params":{},"message":"must match a schema in anyOf"}]}
             ]