Add coordinate field to schema element definitions #3808

yaacovCR · 2022-12-30T09:21:27Z

depends on #3044

Changes GraphQLSchemaElement interface into a base class which defines a .coordinate property and toString/toJSON methods.
Uses the base class to types, fields, arguments, input fields, enum values, and directives.
Uses this in validation error printing string templates.
Exports the now finalized GraphQLSchemaElement, GraphQLField, GraphQLArgument, GraphQLInputField, GraphQLEnumValue classes.

This differs from the original PR #3145 in that GraphQLField, GraphQLArgument, GraphQLInputField, GraphQLEnumValue constructors now take the parent type/field itself as the first argument instead of the parent coordinate. This obviates any need to validate the parent coordinate.

@leebyron comments from original PR:

Defines a GraphQLSchemaElement base class which defines a .coordinate property and toString/toJSON methods.

Adds base class to types, fields, arguments, input fields, enum values, and directives.

Uses this in validation error printing string templates.

Results in a net-reduction of code, minor simplification of definition.ts, and simplification/standardization of error messages

netlify · 2022-12-30T09:21:38Z

✅ Deploy Preview for compassionate-pike-271cb3 ready!

Name	Link
🔨 Latest commit	`163918f`
🔍 Latest deploy log	https://app.netlify.com/sites/compassionate-pike-271cb3/deploys/672b53adca8de30008be3a60
😎 Deploy Preview	https://deploy-preview-3808--compassionate-pike-271cb3.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2022-12-30T09:21:57Z

Hi @yaacovCR, I'm @github-actions bot happy to help you with this PR 👋

Supported commands

Please post this commands in separate comments and only one per comment:

@github-actions run-benchmark - Run benchmark comparing base and merge commits for this PR
@github-actions publish-pr-on-npm - Build package from this PR and publish it on NPM

yaacovCR · 2023-01-02T12:48:30Z

@IvanGoncharov @leebyron

While rebasing/reviewing this, I noticed that the new .toConfig() methods return actual *Config types rather than *NormalizedConfig types.

I initially thought to just add them in, but then I also noticed that some of the existing *NormalizedConfig do not carry all of the type parameters from the original *Config types, and I was unsure why and therefore unsure of how to proceed with the new and potentially generic *NormalizedConfig types.

Questions:

Must the new .toConfig() methods return *NormalizedConfig types?
What is the right approach to type parameters with *NormalizedConfig types?

extracted from graphql#3808

extracted from graphql#3808 PR graphql#3808 uses schema coordinates to improve GraphQL-JS error messages. To reduce the size of the PR, this commit standardizes error messages according to the general pattern that will be introduced with schema coordinates without introducing the coordinates themselves, in the hopes of aiding review of the later PR. Parenthetically, extracting these changes out of graphql#3808 demonstrates how the use of schema coordinates improves our error messages. For example, it is difficult when printing an error message regarding an argument to easily look up the field of that argument, and, if it a nested input field, the full field path. It is similarly sometimes difficult to know the type of the field or argument triggering the error. Embedding schema coordinates within GraphQL-JS makes this trivial. This PR simply omits the changes from graphql#3808 that are directly enabled by the use of schema coordinates. graphql#3808 can then be rebased on top of this PR to demonstrate the code changes and the direct improvement in the various error messages.

…4177) extracted from #3808 PR #3808 uses schema coordinates to improve GraphQL-JS error messages. To reduce the size of the PR, this commit standardizes error messages according to the general pattern that will be introduced with schema coordinates without introducing the coordinates themselves, in the hopes of aiding review of the later PR. EDITED 8/26/2024: I was able to reproduce all of the standardized error messages from #3808 except for the ones in getArgumentValues when it is passed a Field Definition, because the parent type is not passed. Everything else can be calculated for the error messages we are currently printing, although schema coordinates simplifies things. Extracting these changes out of #3808 and rebasing #3808 on main will therefore will better demonstrate how schema coordinates improves the clarity of some of our error messages (namely, getArgumentValues) and simplifies printing them.

…QLEnumValue (#4288) this extracts logic from #3044 and #3145 (later rebased as #3807 and #3808) to implement more informative error messages without implementing [the full schema coordinate RFC](graphql/graphql-spec#794) This is a BREAKING CHANGE because these schema elements are now longer plain objects and function differently in various scenarios, for example with `String(<schemaElement>` `JSON.stringifu(<schemaElement>` and `.toString()` and `.toJSON()` --------- Co-authored-by: Jovi De Croock <decroockjovi@gmail.com>

* Changes `GraphQLSchemaElement` interface into a base class which defines a `.coordinate` property and `toString`/`toJSON` methods. * Uses the base class to types, fields, arguments, input fields, enum values, and directives. * Uses this in validation error printing string templates. * Exports the now finalized GraphQLSchemaElement, GraphQLField, GraphQLArgument, GraphQLInputField, GraphQLEnumValue classes. This differs from the original graphql#3145 in that GraphQLField, GraphQLArgument, GraphQLInputField, GraphQLEnumValue constructors take the parent type/field as arguments instead of the parent coordinate. This obviates the need to validate the parent coordinate.

martinbonnin · 2025-06-10T09:28:34Z

src/index.ts

 export {
  resolveObjMapThunk,
  resolveReadonlyArrayThunk,
  // Definitions
  GraphQLSchema,
  GraphQLDirective,
+  GraphQLSchemaElement,


Answering here from #3044 (comment). I missed that PR during the recent coordinates dicussion. Do we need GraphQLSchemaElement?

I'm fine if there's no "bidirectionality" between a coordinate and a schema element. We could even have GraphQLSchemaElement without the coordinate property and that would probably be fine for me too. In other words, I'm ok with coordinates being "1-way".

Did we have any more context about this? Are there use cases out there that would benefit from GraphQLField having a coordinate property for an example?

We can ask @leebyron for more context, I think the original idea was to use the coordinate concept as an internal convenience to standardize our error messages. In #4288 we basically took the concept with their standardized error messages without the coordinate field itself, so that's why this rebased PR doesn't have a large error message diff and #3145 does.

yaacovCR added the PR: polish 💅 PR doesn't change public API or any observed behaviour label Dec 30, 2022

yaacovCR requested a review from leebyron December 30, 2022 09:21

yaacovCR mentioned this pull request Dec 31, 2022

Add coerceInputLiteral() #3809

Merged

yaacovCR force-pushed the definition-coordinates-rebased branch 3 times, most recently from cc309b6 to 39b5de5 Compare January 1, 2023 19:35

yaacovCR mentioned this pull request Jan 2, 2023

RFC: Default value validation & coercion #3814

Merged

yaacovCR force-pushed the definition-coordinates-rebased branch 3 times, most recently from f7e4d06 to e08f1d7 Compare February 6, 2023 12:33

yaacovCR force-pushed the definition-coordinates-rebased branch 2 times, most recently from 4dbc894 to 3df173b Compare May 31, 2023 11:07

yaacovCR force-pushed the definition-coordinates-rebased branch 3 times, most recently from d2275f2 to 1931581 Compare March 20, 2024 10:44

yaacovCR force-pushed the definition-coordinates-rebased branch from 1931581 to d8dc391 Compare August 22, 2024 21:12

yaacovCR requested a review from a team as a code owner August 22, 2024 21:12

yaacovCR added a commit to yaacovCR/graphql-js that referenced this pull request Aug 23, 2024

standardize error messages prior to introducing schema coordinates

37d13e7

extracted from graphql#3808

yaacovCR added a commit to yaacovCR/graphql-js that referenced this pull request Aug 23, 2024

standardize error messages prior to introducing schema coordinates

ccc3dcc

extracted from graphql#3808

yaacovCR mentioned this pull request Aug 23, 2024

standardize error messages prior to introducing schema coordinates #4177

Merged

yaacovCR force-pushed the definition-coordinates-rebased branch 2 times, most recently from 293f34b to 163918f Compare November 6, 2024 11:31

yaacovCR mentioned this pull request Nov 7, 2024

introduce GraphQLField, GraphQLInputField, GraphQLArgument, and GraphQLEnumValue #4288

Merged

yaacovCR mentioned this pull request May 28, 2025

RFC: Schema Coordinates #3807

Closed

yaacovCR force-pushed the definition-coordinates-rebased branch from 163918f to d0dd902 Compare June 10, 2025 08:11

yaacovCR changed the base branch from next to schema-coordinates June 10, 2025 08:13

yaacovCR mentioned this pull request Jun 10, 2025

Schema Coordinates #3044

Open

martinbonnin reviewed Jun 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add coordinate field to schema element definitions #3808

Add coordinate field to schema element definitions #3808

Uh oh!

yaacovCR commented Dec 30, 2022 •

edited

Loading

Uh oh!

netlify bot commented Dec 30, 2022 •

edited

Loading

Uh oh!

github-actions bot commented Dec 30, 2022

Uh oh!

yaacovCR commented Jan 2, 2023 •

edited

Loading

Uh oh!

martinbonnin Jun 10, 2025

Uh oh!

yaacovCR Jun 10, 2025

Uh oh!

Uh oh!

Add coordinate field to schema element definitions #3808

Are you sure you want to change the base?

Add coordinate field to schema element definitions #3808

Uh oh!

Conversation

yaacovCR commented Dec 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Dec 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for compassionate-pike-271cb3 ready!

Uh oh!

github-actions bot commented Dec 30, 2022

Uh oh!

yaacovCR commented Jan 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

martinbonnin Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

yaacovCR Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yaacovCR commented Dec 30, 2022 •

edited

Loading

netlify bot commented Dec 30, 2022 •

edited

Loading

yaacovCR commented Jan 2, 2023 •

edited

Loading