Add coordinate field to schema element definitions #3145

leebyron · 2021-05-28T23:53:41Z

Depends on #3044

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

* 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.

magicmark

I've read over this and tried to understand what's going on. Adding the GraphQLSchemaElement base class, and having everything be a class that inherits it makes a lot of sense. I think all the elements are covered here.

Looks great to me! (But I'm still getting up to speed on this codebase)

mjmahone

I have no issue with switching the couple of schema interfaces to concrete classes, but if something would go wrong with this diff that's where I'd anticipate downstream issues.

mjmahone · 2021-07-23T02:32:18Z

src/type/introspection.ts

-  args: [
-    {
-      name: 'name',
-      description: undefined,
-      type: new GraphQLNonNull(GraphQLString),
-      defaultValue: undefined,
-      deprecationReason: undefined,
-      extensions: undefined,
-      astNode: undefined,
-    },
-  ],


nice cleanup

mjmahone · 2021-07-23T02:34:31Z

src/type/validate.ts

@@ -184,17 +184,17 @@ function validateDirectives(context: SchemaValidationContext): void {
      // Ensure the type is an input type.
      if (!isInputType(arg.type)) {
        context.reportError(
-          `The type of @${directive.name}(${arg.name}:) must be Input Type ` +
+          `The type of ${arg} must be Input Type ` +


oooh this is a much nicer pattern too. Quite clever, that the arg will be schematized when it's stringified.

mjmahone · 2021-07-23T02:36:31Z

src/validation/rules/KnownArgumentNamesRule.ts


-      if (!argDef && fieldDef && parentType) {


oh that is a much cleaner pattern: it's great that we can now remove the only-needed-for-the-message value.

mjmahone · 2021-07-23T02:53:34Z

src/type/definition.ts

@@ -1724,14 +1701,46 @@ export interface GraphQLInputFieldConfig {

 export type GraphQLInputFieldConfigMap = ObjMap<GraphQLInputFieldConfig>;

-export interface GraphQLInputField {
+export class GraphQLInputField extends GraphQLSchemaElement {


This change seems likely to break implementations that implement GraphQLInputField in a custom way. I don't know how common that is, but definitely not a purely safe adjustment.

mjmahone · 2021-07-23T02:55:31Z

src/validation/rules/custom/NoDeprecatedCustomRule.ts

        context.reportError(
          new GraphQLError(
-            `The field ${parentType.name}.${fieldDef.name} is deprecated. ${deprecationReason}`,
+            `The field ${fieldDef} is deprecated. ${deprecationReason}`,


Should this be Field ${fieldDef} is deprecated. similar to what you're doing in ValuesOfCorrectTypeRule?

@leebyron

[#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 <[email protected]>

…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 <[email protected]>

leebyron added the PR: polish 💅 PR doesn't change public API or any observed behaviour label May 28, 2021

leebyron requested a review from IvanGoncharov May 28, 2021 23:53

leebyron force-pushed the definition-coordinates branch 2 times, most recently from b842aaa to 42eaa34 Compare May 30, 2021 06:18

leebyron force-pushed the schema-coordinates branch from 3cec8c2 to e688f88 Compare May 30, 2021 06:30

leebyron force-pushed the definition-coordinates branch 2 times, most recently from 10377f4 to 9d5277a Compare June 1, 2021 18:54

leebyron mentioned this pull request Jun 1, 2021

Add coerceInputLiteral() #3092

Closed

leebyron force-pushed the definition-coordinates branch from 9d5277a to 4e4d16e Compare June 1, 2021 21:42

leebyron force-pushed the schema-coordinates branch 2 times, most recently from c68ca9b to 8fa8a4c Compare June 3, 2021 17:00

leebyron force-pushed the definition-coordinates branch from 4e4d16e to a4c7cea Compare June 3, 2021 17:02

leebyron force-pushed the schema-coordinates branch from 8fa8a4c to 98e7541 Compare June 3, 2021 17:53

leebyron force-pushed the definition-coordinates branch from a4c7cea to b8ee9a2 Compare June 3, 2021 17:53

magicmark reviewed Jun 3, 2021

View reviewed changes

mjmahone approved these changes Jul 23, 2021

View reviewed changes

This was referenced Dec 30, 2022

Add coordinate field to schema element definitions #3808

Open

RFC: Default value validation & coercion #3814

Merged

yaacovCR mentioned this pull request Nov 7, 2024

introduce GraphQLField, GraphQLInputField, GraphQLArgument, and GraphQLEnumValue #4288

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add coordinate field to schema element definitions #3145

Add coordinate field to schema element definitions #3145

leebyron commented May 28, 2021 •

edited

Loading

magicmark left a comment

mjmahone left a comment

mjmahone Jul 23, 2021

mjmahone Jul 23, 2021

mjmahone Jul 23, 2021

mjmahone Jul 23, 2021

mjmahone Jul 23, 2021

Add coordinate field to schema element definitions #3145

Are you sure you want to change the base?

Add coordinate field to schema element definitions #3145

Conversation

leebyron commented May 28, 2021 • edited Loading

magicmark left a comment

Choose a reason for hiding this comment

mjmahone left a comment

Choose a reason for hiding this comment

mjmahone Jul 23, 2021

Choose a reason for hiding this comment

mjmahone Jul 23, 2021

Choose a reason for hiding this comment

mjmahone Jul 23, 2021

Choose a reason for hiding this comment

mjmahone Jul 23, 2021

Choose a reason for hiding this comment

mjmahone Jul 23, 2021

Choose a reason for hiding this comment

leebyron commented May 28, 2021 •

edited

Loading