graphql-engine/server/tests-py/queries/remote_schemas/validation/field_prefix_validation.yaml
Samir Talwar eab4f75212 An ErrorMessage type, to encapsulate.
This introduces an `ErrorMessage` newtype which wraps `Text` in a manner which is designed to be easy to construct, and difficult to deconstruct.

It provides functionality similar to `Data.Text.Extended`, but designed _only_ for error messages. Error messages are constructed through `fromString`, concatenation, or the `toErrorValue` function, which is designed to be overridden for all meaningful domain types that might show up in an error message. Notably, there are not and should never be instances of `ToErrorValue` for `String`, `Text`, `Int`, etc. This is so that we correctly represent the value in a way that is specific to its type. For example, all `Name` values (from the _graphql-parser-hs_ library) are single-quoted now; no exceptions.

I have mostly had to add `instance ToErrorValue` for various backend types (and also add newtypes where necessary). Some of these are not strictly necessary for this changeset, as I had bigger aspirations when I started. These aspirations have been tempered by trying and failing twice.

As such, in this changeset, I have started by introducing this type to the `parseError` and `parseErrorWith` functions. In the future, I would like to extend this to the `QErr` record and the various `throwError` functions, but this is a much larger task and should probably be done in stages.

For now, `toErrorMessage` and `fromErrorMessage` are provided for conversion to and from `Text`, but the intent is to stop exporting these once all error messages are converted to the new type.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5018
GitOrigin-RevId: 84b37e238992e4312255a87ca44f41af65e2d89a
2022-07-18 20:27:06 +00:00

80 lines
1.5 KiB
YAML

- description: query with prefix field name in inline fragment
url: /v1/graphql
status: 200
query:
query: |
{
hero(episode: 4) {
foo_id
foo_name
... on Droid {
foo_id
foo_name
foo_primaryFunction
}
}
}
response:
data:
hero:
foo_id: '1'
foo_name: R2-D2
foo_primaryFunction: Astromech
- description: query with prefix field name and non-existing (renamed) field
url: /v1/graphql
status: 200
query:
query: |
{
hero(episode: 4) {
id
}
}
response:
errors:
- extensions:
path: $.selectionSet.hero.selectionSet.id
code: validation-failed
message: "field 'id' not found in type: 'Human'"
- description: query aliases
url: /v1/graphql
status: 200
query:
query: |
{
hero(episode: 4) {
name: foo_id
id: foo_name
... on Droid {
foo_name: foo_primaryFunction
}
}
}
response:
data:
hero:
name: '1'
id: R2-D2
foo_name: Astromech
- description: query with __typename (__typename should _not_ be affected by field prefix/suffix customization)
url: /v1/graphql
status: 200
query:
query: |
{
hero(episode: 4) {
foo_id
foo_name
__typename
}
}
response:
data:
hero:
foo_id: "1"
foo_name: R2-D2
__typename: Droid