You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Querying fields that is required / not required provides inconsistent responses.
Consider the repro - there are 2 fields that can be queried willFailFieldIsRequired and willFailFieldIsNotRequired both return a string and the only difference is that one field is required and the other is not. the resolvers for both fields throws an error meaning that both will fail. However the shape of the response differs.
willFailFieldIsRequired returns the expected errors array with the data property as null
Other than the fact that this is inconsistent it causes issues with apollo client, because querying a field that is required if the resolver throws an error the Apollo client fails with null is not an object (evaluating 'rootValue[aliasedFieldName]') because the clients expects the aliasedFieldName to be present within data. And it only is if the field is optional.
This essentially means it is impossible to have any required field be able to throw an error.
This "null bubbling" property is part of the GraphQL specification (http://spec.graphql.org/draft/#sec-Handling-Field-Errors). It allows you to rely on the fact that if a non-null field is requested, it will never show up as null. If you want to be able to get "partial" responses where a particular subtree is optional, then an appropriate way to create that "error boundary" is to declare the field as nullable.
There is an RFC under moderately active development (graphql/graphql-spec#895, https://github.com/graphql/graphql-wg/blob/main/rfcs/ClientControlledNullability.md) that would allow clients to treat a non-null field as nullable for (among other things) the sake of this logic. You may want to chime in there! Apollo Server's execution is defined by graphql-js, the reference implementation of GraphQL, so this behavior won't change unilaterally here.
Issue Description
Querying fields that is required / not required provides inconsistent responses.
Consider the repro - there are 2 fields that can be queried
willFailFieldIsRequired
andwillFailFieldIsNotRequired
both return a string and the only difference is that one field is required and the other is not. the resolvers for both fields throws an error meaning that both will fail. However the shape of the response differs.willFailFieldIsRequired
returns the expected errors array with the data property as nullwillFailFieldIsNotRequired
returns the expected errors array, but the data property is an object with the keywillFailFieldIsNotRequired
as null.Other than the fact that this is inconsistent it causes issues with apollo client, because querying a field that is required if the resolver throws an error the Apollo client fails with
null is not an object (evaluating 'rootValue[aliasedFieldName]')
because the clients expects the aliasedFieldName to be present within data. And it only is if the field is optional.This essentially means it is impossible to have any required field be able to throw an error.
Link to Reproduction
https://stackblitz.com/edit/node-datsna?file=index.mjs
Reproduction Steps
The text was updated successfully, but these errors were encountered: