Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Schema Coordinates #3044

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Schema Coordinates #3044

wants to merge 1 commit into from

Conversation

leebyron
Copy link
Contributor

@leebyron leebyron commented Apr 16, 2021 •
edited
Loading

Depends on #3115

Implements graphql/graphql-spec#794

Adds:

  • DOT punctuator in lexer
  • Improvements to lexer errors around misuse of .
  • Minor improvement to parser core which simplified this addition
  • SchemaCoordinate node and isSchemaCoodinate() predicate
  • Support in print() and visit()
  • Added function parseSchemaCoordinate() since it is a parser entry point.
  • Added function resolveSchemaCoordinate() and resolveASTSchemeCoordinate() which implement the semantics (name mirrored from buildASTSchema) as well as the return type GraphQLSchemaElement

@leebyron leebyron requested a review from IvanGoncharov April 16, 2021 09:33
@leebyron leebyron force-pushed the schema-coordinates branch 2 times, most recently from c7b87e2 to 0a5630a Compare April 16, 2021 09:46
@IvanGoncharov IvanGoncharov added the spec RFC Implementation of a proposed change to the GraphQL specification label Apr 16, 2021
magicmark
magicmark reviewed Apr 16, 2021
View reviewed changes
src/language/lexer.js Outdated Show resolved Hide resolved
magicmark
magicmark approved these changes Apr 16, 2021
View reviewed changes
Copy link

@magicmark magicmark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing!

This is way beyond what I was hacking with. Hadn't even considered reusing the existing parser. (I was fiddling around with regexes...)

Thanks for putting this together - this makes a lot of sense.

src/language/printer.js Outdated
isDirective && '@',
name,
wrap('.', fieldName),
wrap('(', argumentName, ':)'),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:)

IvanGoncharov
IvanGoncharov reviewed Apr 20, 2021
View reviewed changes
src/language/ast.js Outdated Show resolved Hide resolved
@leebyron leebyron force-pushed the schema-coordinates branch from a4a8920 to 42f9072 Compare April 22, 2021 07:27
@leebyron
Copy link
Contributor Author

leebyron commented Apr 22, 2021 •
edited
Loading

Great feedback - I think I've resolved both:

  • Replaced fieldName with memberName in the AST to ensure it's generalized between fields, input fields, and enum values. Those are all specific instances of the general pattern of "members of a set", which is pretty common terminology for this generalized dot access pattern.
  • Took both of your great suggestions for wrapping the return type of resolveSchemaCoordinate - the ResolvedSchemaElement type is now a union of wrappers. This had the added benefits of disambiguating between "field argument" and "directive argument" and including the coordinate context in the return value

@leebyron leebyron requested a review from IvanGoncharov April 22, 2021 16:58
@leebyron leebyron force-pushed the schema-coordinates branch from 42f9072 to 1399f7c Compare May 27, 2021 23:55
@leebyron leebyron changed the base branch from main to lexer-cleanup May 27, 2021 23:55
@leebyron leebyron added the PR: feature 🚀 requires increase of "minor" version number label May 27, 2021
@leebyron leebyron force-pushed the lexer-cleanup branch 2 times, most recently from 3451e3e to 2f893d6 Compare May 28, 2021 22:21
@leebyron leebyron force-pushed the schema-coordinates branch from 1399f7c to 3cec8c2 Compare May 28, 2021 22:31
@leebyron leebyron mentioned this pull request May 28, 2021
Open
@leebyron leebyron force-pushed the schema-coordinates branch from 3cec8c2 to e688f88 Compare May 30, 2021 06:30
IvanGoncharov
IvanGoncharov reviewed Jun 1, 2021
View reviewed changes
src/language/ast.ts Outdated Show resolved Hide resolved
@leebyron leebyron force-pushed the schema-coordinates branch from e688f88 to c68ca9b Compare June 2, 2021 17:55
@leebyron leebyron requested a review from IvanGoncharov June 2, 2021 17:55
@leebyron leebyron mentioned this pull request Jun 2, 2021
Closed
@leebyron leebyron force-pushed the schema-coordinates branch from c68ca9b to 8fa8a4c Compare June 3, 2021 17:00
Base automatically changed from lexer-cleanup to main June 3, 2021 17:34
@leebyron
Schema Coordinates
98e7541 
Implements graphql/graphql-spec#794

Adds:

* DOT punctuator in lexer
* Improvements to lexer errors around misuse of `.`
* Minor improvement to parser core which simplified this addition
* `SchemaCoordinate` node and `isSchemaCoodinate()` predicate
* Support in `print()` and `visit()`
* Added function `parseSchemaCoordinate()` since it is a parser entry point.
* Added function `resolveSchemaCoordinate()` and `resolveASTSchemaCoordinate()` which implement the semantics (name mirrored from `buildASTSchema`) as well as the return type `ResolvedSchemaElement`
@leebyron leebyron force-pushed the schema-coordinates branch from 8fa8a4c to 98e7541 Compare June 3, 2021 17:53
@martijnwalraven martijnwalraven mentioned this pull request Jun 18, 2021
Closed
@yaacovCR yaacovCR mentioned this pull request Dec 29, 2022
Open
This was referenced Jan 2, 2023
Open
Merged
This was referenced Sep 21, 2024
Closed
Open
yaacovCR added a commit that referenced this pull request Oct 27, 2024
@yaacovCR @leebyron
RFC: Default value validation & coercion (#3814)
fbb191a 
[#3049 rebased on
main](#3049).

This is the last rebased PR from the original PR stack concluding with
#3049.

* Rebased: #3809 [Original: #3092]
* Rebased: #3810 [Original: #3074]
* Rebased: #3811 [Original: #3077]
* Rebased: #3812 [Original: #3065]
* Rebased: #3813 [Original: #3086]
* Rebased: #3814 (this PR) [Original: #3049]

Update: #3044 and #3145 have been separated from this stack.

Changes from original PR:
1. `astFromValue()` is deprecated instead of being removed.

@leebyron comments from #3049, the original PR:
> Implements
[graphql/graphql-spec#793](graphql/graphql-spec#793)
> 
> * BREAKING: Changes default values from being represented as an
assumed-coerced "internal input value" to a pre-coerced "external input
value" (See chart below).
> This allows programmatically provided default values to be represented
in the same domain as values sent to the service via variable values,
and allows it to have well defined methods for both transforming into a
printed GraphQL literal string for introspection / schema printing (via
`valueToLiteral()`) or coercing into an "internal input value" for use
at runtime (via `coerceInputValue()`)
> To support this change in value type, this PR adds two related
behavioral changes:
>   
> * Adds coercion of default values from external to internal at runtime
(within `coerceInputValue()`)
> * Removes `astFromValue()`, replacing it with `valueToLiteral()` for
use in introspection and schema printing. `astFromValue()` performed
unsafe "uncoercion" to convert an "Internal input value" directly to a
"GraphQL Literal AST", where `valueToLiteral()` performs a well defined
transform from "External input value" to "GraphQL Literal AST".
> * Adds validation of default values during schema validation.
> Since assumed-coerced "internal" values may not pass "external"
validation (for example, Enum values), an additional validation error
has been included which attempts to detect this case and report a
strategy for resolution.
> 
> Here's a broad overview of the intended end state:
> 
> ![GraphQL Value
Flow](https://user-images.githubusercontent.com/50130/118379946-51ac5300-b593-11eb-839f-c483ecfbc875.png)

---------

Co-authored-by: Lee Byron <lee@leebyron.com>
@yaacovCR yaacovCR mentioned this pull request Nov 7, 2024
Merged
yaacovCR added a commit that referenced this pull request Dec 1, 2024
@yaacovCR @JoviDeCroock
introduce GraphQLField, GraphQLInputField, GraphQLArgument, and Graph…
79ad146 
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@magicmark magicmark magicmark approved these changes

@IvanGoncharov IvanGoncharov Awaiting requested review from IvanGoncharov

Assignees
No one assigned
Labels
PR: feature 🚀 requires increase of "minor" version number spec RFC Implementation of a proposed change to the GraphQL specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@leebyron @magicmark @IvanGoncharov