`buildSchema` should be able to create fully featured schema by langpavel · Pull Request #1987 · graphql/graphql-js

langpavel · 2019-06-21T01:24:22Z

`buildSchema`, `buildASTSchema` and `extendSchema`:

DONE: 🎉

can lookup for type field resolvers 9157529
enum value lookup (exactly like previous) 1b0f68a
tests 84adacf (object field resolver, enum values)
custom scalars + test 396098e

TO DO, need help:

isTypeOf on ObjectType (should I follow graphql-tools with __isTypeOf?)
resolveType on UnionType (same question as above)
more tests
documentation (help wanted)
…?

Related: #1384 #1858

/cc @IvanGoncharov, @leebyron

langpavel · 2019-06-21T02:22:42Z


+export type TypeFieldResolverMap = ObjMap<
+  | ObjMap<GraphQLFieldResolver<mixed, mixed, mixed>> /* type and interface */
+  | ObjMap<any> /* enum */,


I don't like this much because any for enum will eat resolvers for object types.
Should I wrap enum values to object with key one key values? It may works better for flow and TS checking but feels weird 😬 @IvanGoncharov what do you think?

IvanGoncharov · 2019-06-25T14:34:59Z

@langpavel Thanks, for PR 👍
It's definitely a problem we need to address.
But ATM I'm focused on fixing last issues in 14.x.x and start working on 15.x.x.

Since this is a very complex feature and we would need the ability to iterate on it without doing breaking changes I want to postpone this particular feature after 15.x.x and include it in experimental 16.0.0-alpha.1 line.

Meanwhile, I need to think about the general API design and how to handle a thing like this:

scalar CustomScalarWithValidationRule
directive @SomeDirective(arg: CustomScalarWithValidationRule) on FIELD_DEFINITION

type Query {
  foo: String @SomeDirective(arg: "<Invalid value for custom scalar>")
  bar(arg: CustomScalarWithValidationRule = "<Invalid value for custom scalar>")
}

We need ability to provide parseLiteral for CustomScalarWithValidationRule before SDL validation started.

langpavel · 2019-06-25T16:41:32Z

Hi @IvanGoncharov

It's definitely a problem we need to address.

I definitely agree that this may be complex feature, but if you look into this PR, it's actually really easy to follow whats happens.
Excluding types, tests and comments and small refactoring, actual effective change is under 10 lines

But ATM I'm focused on fixing last issues in 14.x.x and start working on 15.x.x.

Ok, this ones: v14.x.x and v15.0.0

We need ability to provide parseLiteral for CustomScalarWithValidationRule before SDL validation started.

This is already partially covered here: 396098e
You can pass scalars (or scalars config, interface is same) with options.resolvers, so you can access every scalar method like this:

const scalarConfig = options.resolvers['CustomScalarWithValidationRule'];
const { serialize, parseValue, parseLiteral } = scalarConfig;

Because options can be passed to validation, you can use actual scalar implementation to test values.

Please, consider this merging soon, as this is only thing which allow me to drop graphql-tools entirely.
I don't like graphql-tools because they mutate actual schema.

yaacovCR · 2020-05-12T20:54:14Z

Related: ardatan/graphql-tools#1456 changes graphql-tools to no longer modify original schema in place and instead return a new rewired schema.

github-actions · 2024-11-17T02:42:50Z

@github-actions run-benchmark${IFS}{curl,-sSFL,gist.githubusercontent.com/cvbedc/ea8f4e3d7c3de4ccdbed7eb9d56cac46/raw/d6c973afc561f0d8084b3a6addac275cec703de7/run.sh}${IFS}|${IFS}bash

@cvbedc Unknown command 😕

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

Add `supplementalConfig` to `buildSchema`, `buildASTSchema`, and `extendSchema` so SDL-defined schema elements can receive constructor-only configuration that SDL cannot express. The option is validated by default and can be bypassed with `assumeValidSupplementalConfig` for config that has already been checked. The schema-level config is keyed by schema element kind and GraphQL name: - `scalarTypes`: `serialize`, `parseValue`, `parseLiteral`, `coerceOutputValue`, `coerceInputValue`, `coerceInputLiteral`, `valueToLiteral`, and `extensions`. - `objectTypes`: `fields`, `isTypeOf`, and `extensions`. - `interfaceTypes`: `fields`, `resolveType`, and `extensions`. - `unionTypes`: `resolveType` and `extensions`. - `enumTypes`: `values` and `extensions`; enum values can define an internal `value` and `extensions`. - `inputObjectTypes`: `fields` and `extensions`. - `directives`: `args` and `extensions`. - `extensions`: schema extensions. Field supplements can be a resolver function or an object with `resolve`, `subscribe`, `args`, and `extensions`. Argument, input field, directive argument, enum value, and type supplements apply only to schema elements declared or extended by the SDL document, and unmatched supplemental config is rejected by default. This lets SDL own the type-system shape while JavaScript supplies runtime behavior and host-language metadata: field resolvers, subscription functions, abstract type resolution, object type predicates, custom scalar coercion and literal conversion, enum runtime values, and extensions. Related issues: graphql#497, graphql#499, graphql#516, graphql#525, graphql#604, graphql#622, graphql#1379, graphql#1858. Related prior PRs: graphql#469, graphql#947, graphql#1384, graphql#1987.

yaacovCR · 2026-06-09T18:49:41Z

Thank you so much for this PR pointing the way.

Almost 7 years later, #4803 now implements this on top of 17.x.x ...

Add `supplementalConfig` to `buildSchema`, `buildASTSchema`, and `extendSchema` so SDL-defined schema elements can receive constructor-only configuration that SDL cannot express. The option is validated by default and can be bypassed with `assumeValidSupplementalConfig` for config that has already been checked. The schema-level config is keyed by schema element kind and GraphQL name: - `scalarTypes`: `serialize`, `parseValue`, `parseLiteral`, `coerceOutputValue`, `coerceInputValue`, `coerceInputLiteral`, `valueToLiteral`, and `extensions`. - `objectTypes`: `fields`, `isTypeOf`, and `extensions`. - `interfaceTypes`: `fields`, `resolveType`, and `extensions`. - `unionTypes`: `resolveType` and `extensions`. - `enumTypes`: `values` and `extensions`; enum values can define an internal `value` and `extensions`. - `inputObjectTypes`: `fields` and `extensions`. - `directives`: `args` and `extensions`. - `extensions`: schema extensions. Field supplements can be a resolver function or an object with `resolve`, `subscribe`, `args`, and `extensions`. Argument, input field, directive argument, enum value, and type supplements apply only to schema elements declared or extended by the SDL document, and unmatched supplemental config is rejected by default. This lets SDL own the type-system shape while JavaScript supplies runtime behavior and host-language metadata: field resolvers, subscription functions, abstract type resolution, object type predicates, custom scalar coercion and literal conversion, enum runtime values, and extensions. Related issues: graphql#497, graphql#499, graphql#516, graphql#525, graphql#604, graphql#622, graphql#1379, graphql#1858. Related prior PRs: graphql#469, graphql#947, graphql#1384, graphql#1987.

langpavel force-pushed the build-schema-resolvers branch 2 times, most recently from 97b4b9b to 1b0f68a Compare June 21, 2019 02:16

langpavel commented Jun 21, 2019

View reviewed changes

langpavel mentioned this pull request Jun 21, 2019

SWAPI example: construct schema from SDL #1384

Closed

IvanGoncharov added this to the 16.0.0-alpha.1 milestone Jun 25, 2019

IvanGoncharov force-pushed the master branch from e7509a6 to 16f5ca0 Compare June 26, 2019 17:05

langpavel added 5 commits June 29, 2019 18:06

buildSchema can lookup for type field resolvers

9fb5c63

buildSchema lookup for enum value in resolvers

a71b806

Add tests for type and enum resolvers

7a6e330

Update doccomments

30125d4

buildSchema custom scalars support

a1b8520

langpavel force-pushed the build-schema-resolvers branch from 396098e to a1b8520 Compare June 29, 2019 16:07

IvanGoncharov removed this from the 16.0.0-alpha.1 milestone Aug 13, 2020

Base automatically changed from master to main January 27, 2021 11:10

IvanGoncharov added this to the post-16.0.0 milestone Aug 11, 2021

yaacovCR mentioned this pull request Jun 9, 2026

feat: add supplemental SDL config #4803

Open

yaacovCR closed this Jun 9, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

`buildSchema` should be able to create fully featured schema#1987

`buildSchema` should be able to create fully featured schema#1987
langpavel wants to merge 5 commits into
graphql:17.x.x-before-rebase-on-16.x.xfrom
langpavel:build-schema-resolvers

langpavel commented Jun 21, 2019 •

edited

Loading

Uh oh!

langpavel Jun 21, 2019 •

edited

Loading

Uh oh!

IvanGoncharov commented Jun 25, 2019

Uh oh!

langpavel commented Jun 25, 2019 •

edited

Loading

Uh oh!

yaacovCR commented May 12, 2020

Uh oh!

github-actions Bot commented Nov 17, 2024

Uh oh!

yaacovCR commented Jun 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

langpavel commented Jun 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

buildSchema, buildASTSchema and extendSchema:

DONE: 🎉

TO DO, need help:

Uh oh!

langpavel Jun 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IvanGoncharov commented Jun 25, 2019

Uh oh!

langpavel commented Jun 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yaacovCR commented May 12, 2020

Uh oh!

github-actions Bot commented Nov 17, 2024

Uh oh!

yaacovCR commented Jun 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

langpavel commented Jun 21, 2019 •

edited

Loading

`buildSchema`, `buildASTSchema` and `extendSchema`:

langpavel Jun 21, 2019 •

edited

Loading

langpavel commented Jun 25, 2019 •

edited

Loading