Add path to formatError

While path was added to the serializable error, it was not yet added to the default formatError function. Adding this is technically breaking since it begins to expose new information from your API.
graphql · Nov 9, 2016 · 3e069f5 · 3e069f5
1 parent 95c1bc2
commit 3e069f5
Show file tree

Hide file tree

Showing 29 changed files with 211 additions and 86 deletions.
diff --git a/src/error/__tests__/GraphQLError-test.js b/src/error/__tests__/GraphQLError-test.js
@@ -10,7 +10,7 @@
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
-import { parse, Source, GraphQLError } from '../../';
+import { parse, Source, GraphQLError, formatError } from '../../';
 
 
 describe('GraphQLError', () => {
@@ -123,4 +123,20 @@ describe('GraphQLError', () => {
     );
   });
 
+  it('default error formatter includes path', () => {
+    const e = new GraphQLError(
+      'msg',
+      null,
+      null,
+      null,
+      [ 'path', 3, 'to', 'field' ]
+    );
+
+    expect(formatError(e)).to.deep.equal({
+      message: 'msg',
+      locations: undefined,
+      path: [ 'path', 3, 'to', 'field' ]
+    });
+  });
+
 });
diff --git a/src/error/formatError.js b/src/error/formatError.js
@@ -20,13 +20,15 @@ export function formatError(error: GraphQLError): GraphQLFormattedError {
   invariant(error, 'Received null or undefined error.');
   return {
     message: error.message,
-    locations: error.locations
+    locations: error.locations,
+    path: error.path
   };
 }
 
 export type GraphQLFormattedError = {
   message: string,
-  locations: ?Array<GraphQLErrorLocation>
+  locations: ?Array<GraphQLErrorLocation>,
+  path: ?Array<string | number>
 };
 
 export type GraphQLErrorLocation = {

diff --git a/src/execution/__tests__/executor-test.js b/src/execution/__tests__/executor-test.js
@@ -403,27 +403,38 @@ describe('Execute: Handles basic execution tasks', () => {
 
     expect(result.errors && result.errors.map(formatError)).to.deep.equal([
       { message: 'Error getting syncError',
-        locations: [ { line: 3, column: 7 } ] },
+        locations: [ { line: 3, column: 7 } ],
+        path: [ 'syncError' ] },
       { message: 'Error getting syncRawError',
-        locations: [ { line: 4, column: 7 } ] },
+        locations: [ { line: 4, column: 7 } ],
+        path: [ 'syncRawError' ] },
       { message: 'Error getting syncReturnError',
-        locations: [ { line: 5, column: 7 } ] },
+        locations: [ { line: 5, column: 7 } ],
+        path: [ 'syncReturnError' ] },
       { message: 'Error getting syncReturnErrorList1',
-        locations: [ { line: 6, column: 7 } ] },
+        locations: [ { line: 6, column: 7 } ],
+        path: [ 'syncReturnErrorList', 1 ] },
       { message: 'Error getting syncReturnErrorList3',
-        locations: [ { line: 6, column: 7 } ] },
+        locations: [ { line: 6, column: 7 } ],
+        path: [ 'syncReturnErrorList', 3 ] },
       { message: 'Error getting asyncReject',
-        locations: [ { line: 8, column: 7 } ] },
+        locations: [ { line: 8, column: 7 } ],
+        path: [ 'asyncReject' ] },
       { message: 'Error getting asyncRawReject',
-        locations: [ { line: 9, column: 7 } ] },
+        locations: [ { line: 9, column: 7 } ],
+        path: [ 'asyncRawReject' ] },
       { message: 'An unknown error occurred.',
-        locations: [ { line: 10, column: 7 } ] },
+        locations: [ { line: 10, column: 7 } ],
+        path: [ 'asyncEmptyReject' ] },
       { message: 'Error getting asyncError',
-        locations: [ { line: 11, column: 7 } ] },
+        locations: [ { line: 11, column: 7 } ],
+        path: [ 'asyncError' ] },
       { message: 'Error getting asyncRawError',
-        locations: [ { line: 12, column: 7 } ] },
+        locations: [ { line: 12, column: 7 } ],
+        path: [ 'asyncRawError' ] },
       { message: 'Error getting asyncReturnError',
-        locations: [ { line: 13, column: 7 } ] },
+        locations: [ { line: 13, column: 7 } ],
+        path: [ 'asyncReturnError' ] },
     ]);
   });
 

diff --git a/src/execution/__tests__/lists-test.js b/src/execution/__tests__/lists-test.js
@@ -104,7 +104,8 @@ describe('Execute: Accepts any iterable as list value', () => {
     { data: { nest: { test: null } },
       errors: [ {
         message: 'Expected Iterable, but did not find one for field DataType.test.',
-        locations: [ { line: 1, column: 10 } ]
+        locations: [ { line: 1, column: 10 } ],
+        path: [ 'nest', 'test' ]
       } ] }
   ));
 
@@ -157,7 +158,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: null } },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -180,7 +182,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: [ 1, null, 2 ] } },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -208,7 +211,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -231,7 +235,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -240,7 +245,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -263,7 +269,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: [ 1, null, 2 ] } },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -286,7 +293,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: null } },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -309,7 +317,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: null } },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -323,7 +332,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: null } },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -341,7 +351,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: null } },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -350,7 +361,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: { test: null } },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -375,7 +387,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -384,7 +397,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -402,7 +416,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -411,7 +426,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -420,7 +436,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test' ] }
           ] }
       ));
 
@@ -438,7 +455,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'Cannot return null for non-nullable field DataType.test.',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 
@@ -447,7 +465,8 @@ describe('Execute: Handles list nullability', () => {
         { data: { nest: null },
           errors: [
             { message: 'bad',
-              locations: [ { line: 1, column: 10 } ] }
+              locations: [ { line: 1, column: 10 } ],
+              path: [ 'nest', 'test', 1 ] }
           ] }
       ));
 

diff --git a/src/validation/__tests__/ArgumentsOfCorrectType-test.js b/src/validation/__tests__/ArgumentsOfCorrectType-test.js
@@ -27,6 +27,7 @@ function badValue(argName, typeName, value, line, column, errors) {
   return {
     message: badValueMessage(argName, typeName, value, realErrors),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/DefaultValuesOfCorrectType-test.js b/src/validation/__tests__/DefaultValuesOfCorrectType-test.js
@@ -20,6 +20,7 @@ function defaultForNonNullArg(varName, typeName, guessTypeName, line, column) {
   return {
     message: defaultForNonNullArgMessage(varName, typeName, guessTypeName),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 
@@ -35,6 +36,7 @@ function badValue(varName, typeName, val, line, column, errors) {
   return {
     message: badValueForDefaultArgMessage(varName, typeName, val, realErrors),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/FieldsOnCorrectType-test.js b/src/validation/__tests__/FieldsOnCorrectType-test.js
@@ -32,6 +32,7 @@ function undefinedField(
       suggestedFields
     ),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/FragmentsOnCompositeTypes-test.js b/src/validation/__tests__/FragmentsOnCompositeTypes-test.js
@@ -19,6 +19,7 @@ function error(fragName, typeName, line, column) {
   return {
     message: fragmentOnNonCompositeErrorMessage(fragName, typeName),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 
@@ -101,7 +102,8 @@ describe('Validate: Fragments on composite types', () => {
       }
     `, [
       { message: inlineFragmentOnNonCompositeErrorMessage('String'),
-        locations: [ { line: 3, column: 16 } ] }
+        locations: [ { line: 3, column: 16 } ],
+        path: undefined }
     ]);
   });
 

diff --git a/src/validation/__tests__/KnownArgumentNames-test.js b/src/validation/__tests__/KnownArgumentNames-test.js
@@ -20,6 +20,7 @@ function unknownArg(argName, fieldName, typeName, suggestedArgs, line, column) {
   return {
     message: unknownArgMessage(argName, fieldName, typeName, suggestedArgs),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 
@@ -33,6 +34,7 @@ function unknownDirectiveArg(
   return {
     message: unknownDirectiveArgMessage(argName, directiveName, suggestedArgs),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/KnownDirectives-test.js b/src/validation/__tests__/KnownDirectives-test.js
@@ -22,14 +22,16 @@ import {
 function unknownDirective(directiveName, line, column) {
   return {
     message: unknownDirectiveMessage(directiveName),
-    locations: [ { line, column } ]
+    locations: [ { line, column } ],
+    path: undefined,
   };
 }
 
 function misplacedDirective(directiveName, placement, line, column) {
   return {
     message: misplacedDirectiveMessage(directiveName, placement),
-    locations: [ { line, column } ]
+    locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/KnownFragmentNames-test.js b/src/validation/__tests__/KnownFragmentNames-test.js
@@ -18,7 +18,8 @@ import {
 function undefFrag(fragName, line, column) {
   return {
     message: unknownFragmentMessage(fragName),
-    locations: [ { line, column } ]
+    locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/KnownTypeNames-test.js b/src/validation/__tests__/KnownTypeNames-test.js
@@ -19,6 +19,7 @@ function unknownType(typeName, suggestedTypes, line, column) {
   return {
     message: unknownTypeMessage(typeName, suggestedTypes),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }
 

diff --git a/src/validation/__tests__/LoneAnonymousOperation-test.js b/src/validation/__tests__/LoneAnonymousOperation-test.js
@@ -19,6 +19,7 @@ function anonNotAlone(line, column) {
   return {
     message: anonOperationNotAloneMessage(),
     locations: [ { line, column } ],
+    path: undefined,
   };
 }