adds decorated data path (atlassian#28)

* adds decorated data path

* keep standard json pointer path

* migrate tests

* remove integration test

.gitignore

@@ -2,3 +2,4 @@
 /node_modules/
 /coverage/
 *.log
+.vscode

package.json

@@ -69,7 +69,7 @@
   },
   "jest": {
     "testMatch": [
-      "<rootDir>/src/**/__tests__/*.js"
+      "<rootDir>/src/**/__tests__/**/*.js"
     ]
   },
   "prettier": {

src/json/get-decorated-data-pah.js

@@ -0,0 +1,36 @@
+export default function getDecoratedDataPath(jsonAst, dataPath) {
+  // TODO: Handle json pointer escape notation and better error handling
+  const pointers = dataPath.split('/').slice(1);
+  let decoratedPath = '';
+  pointers.reduce((obj, pointer, idx) => {
+    switch (obj.type) {
+      case 'Object': {
+        decoratedPath += `/${pointer}`;
+        const filtered = obj.children.filter(
+          child => child.key.value === pointer
+        );
+        if (filtered.length !== 1) {
+          throw new Error(`Couldn't find property ${pointer} of ${dataPath}`);
+        }
+        return filtered[0].value;
+      }
+      case 'Array':
+        decoratedPath += `/${pointer}${getTypeName(obj.children[pointer])}`;
+        return obj.children[pointer];
+      default:
+        // eslint-disable-next-line no-console
+        console.log(obj);
+    }
+  }, jsonAst);
+  return decoratedPath;
+}
+
+function getTypeName(obj) {
+  const type = obj.children.filter(child => child.key.value === 'type');
+
+  if (!type.length) {
+    return '';
+  }
+
+  return (type[0].value && `:${type[0].value.value}`) || '';
+}

src/json/index.js

@@ -1 +1,2 @@
 export { default as getMetaFromPath } from './get-meta-from-path';
+export { default as getDecoratedDataPath } from './get-decorated-data-pah';

src/validation-errors/__tests__/__snapshots__/main.js.snap

@@ -8,7 +8,8 @@ Array [
       "line": 1,
       "offset": 26,
     },
-    "error": "Property baz is not expected to be here",
+    "error": " Property baz is not expected to be here",
+    "path": "",
     "start": Object {
       "column": 22,
       "line": 1,
@@ -27,6 +28,7 @@ Array [
       "offset": 24,
     },
     "error": "/id: type should be number",
+    "path": "/id",
     "start": Object {
       "column": 7,
       "line": 1,
@@ -45,6 +47,7 @@ Array [
       "offset": 11,
     },
     "error": "/id should be equal to one of the allowed values: foo, bar",
+    "path": "/id",
     "start": Object {
       "column": 7,
       "line": 1,
@@ -59,6 +62,7 @@ exports[`Main should support js output format for required errors 1`] = `
 Array [
   Object {
     "error": "/nested should have required property 'id'",
+    "path": "/nested",
     "start": Object {
       "column": 11,
       "line": 1,

src/validation-errors/additional-prop.js

@@ -26,7 +26,10 @@ export default class AdditionalPropValidationError extends BaseValidationError {
 
     return {
       ...this.getLocation(`${dataPath}/${params.additionalProperty}`),
-      error: `Property ${params.additionalProperty} is not expected to be here`,
+      error: `${this.getDecoratedPath(dataPath)} Property ${
+        params.additionalProperty
+      } is not expected to be here`,
+      path: dataPath,
     };
   }
 }

src/validation-errors/base.js

@@ -1,5 +1,5 @@
 import { codeFrameColumns } from '@babel/code-frame';
-import { getMetaFromPath } from '../json';
+import { getMetaFromPath, getDecoratedDataPath } from '../json';
 
 export default class BaseValidationError {
   constructor(
@@ -26,6 +26,11 @@ export default class BaseValidationError {
     };
   }
 
+  getDecoratedPath(dataPath = this.options.dataPath) {
+    const decoratedPath = getDecoratedDataPath(this.jsonAst, dataPath);
+    return decoratedPath;
+  }
+
   getCodeFrame(message, dataPath = this.options.dataPath) {
     return codeFrameColumns(this.jsonRaw, this.getLocation(dataPath), {
       highlightCode: true,

src/validation-errors/default.js

@@ -16,7 +16,8 @@ export default class DefaultValidationError extends BaseValidationError {
 
     return {
       ...this.getLocation(),
-      error: `${dataPath}: ${keyword} ${message}`,
+      error: `${this.getDecoratedPath(dataPath)}: ${keyword} ${message}`,
+      path: dataPath,
     };
   }
 }

src/validation-errors/enum.js

@@ -5,7 +5,10 @@ import BaseValidationError from './base';
 
 export default class EnumValidationError extends BaseValidationError {
   print() {
-    const { message, params: { allowedValues } } = this.options;
+    const {
+      message,
+      params: { allowedValues },
+    } = this.options;
     const bestMatch = this.findBestMatch();
 
     const output = [
@@ -28,7 +31,10 @@ export default class EnumValidationError extends BaseValidationError {
 
     const output = {
       ...this.getLocation(),
-      error: `${dataPath} ${message}: ${params.allowedValues.join(', ')}`,
+      error: `${this.getDecoratedPath(
+        dataPath
+      )} ${message}: ${params.allowedValues.join(', ')}`,
+      path: dataPath,
     };
 
     if (bestMatch !== null) {
@@ -39,7 +45,10 @@ export default class EnumValidationError extends BaseValidationError {
   }
 
   findBestMatch() {
-    const { dataPath, params: { allowedValues } } = this.options;
+    const {
+      dataPath,
+      params: { allowedValues },
+    } = this.options;
     const currentValue = pointer.get(this.data, dataPath);
 
     if (!currentValue) {

src/validation-errors/required.js

@@ -19,11 +19,12 @@ export default class RequiredValidationError extends BaseValidationError {
   }
 
   getError() {
-    const { message, dataPath, params } = this.options;
+    const { message, dataPath } = this.options;
 
     return {
       ...this.getLocation(),
-      error: `${dataPath} ${message}`,
+      error: `${this.getDecoratedPath(dataPath)} ${message}`,
+      path: dataPath,
     };
   }
 }