graphql / graphql-js
99%
master: 98%

LAST BUILD BRANCH: directives
DEFAULT BRANCH: master
Repo Added
Files 0
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH schema-scalar-of-type
branch: schema-scalar-of-type
CHANGE BRANCH
x

3834

push

travis-ci

IvanGoncharov 
RFC: Define custom scalars in terms of built-in scalars.

This proposes an additive change which allows custom scalars to be defined in terms of the built-in scalars. The motivation is for client-side code generators to understand how to map between the GraphQL type system and a native type system. As an example, a `URL` custom type may be defined in terms of the built-in scalar `String`. It could define additional serialization and parsing logic, however client tools can know to treat `URL` values as `String`. Presently, we do this by defining these mappings manually on the client, which is difficult to scale, or by giving up and making no assumptions of how the custom types serialize.

Another real use case of giving client tools this information is GraphiQL: this change will allow GraphiQL to show more useful errors when a literal of an incorrect kind is provided to a custom scalar. Currently GraphiQL simply accepts all values.

To accomplish this, this proposes adding the following:

* A new property when defining `GraphQLScalarType` (`ofType`) which asserts that only built-in scalar types are provided.

* A second type coercion to guarantee to a client that the serialized values match the `ofType`.

* Delegating the `parseLiteral` and `parseValue` functions to those in `ofType` (this enables downstream validation / GraphiQL features)

* Exposing `ofType` in the introspection system, and consuming that introspection in `buildClientSchema`.

* Adding optional syntax to the SDL, and consuming that in `buildASTSchema` and `extendSchema` as well as in `schemaPrinter`.

* Adding a case to `findBreakingChanges` which looks for a scalar's ofType changing.

3688 of 3959 branches covered (93.15%)

28 of 28 new or added lines in 8 files covered. (100.0%)

11086 of 11230 relevant lines covered (98.72%)

1243.85 hits per line

Relevant lines Covered
11230 RELEVANT LINES 11086 COVERED LINES
1243.85 HITS PER LINE
Source Files on schema-scalar-of-type

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
3834 schema-scalar-of-type RFC: Define custom scalars in terms of built-in scalars. This proposes an additive change which allows custom scalars to be defined in terms of the built-in scalars. The motivation is for client-side code generators to understand how to map betwe... push IvanGoncharov travis-ci pending completion  
3835 schema-scalar-of-type RFC: Define custom scalars in terms of built-in scalars. This proposes an additive change which allows custom scalars to be defined in terms of the built-in scalars. The motivation is for client-side code generators to understand how to map betwe... Pull #914 web-flow travis-ci pending completion  
3011 schema-scalar-of-type Merging #1173, fixes tests push leebyron travis-ci pending completion  
2302 schema-scalar-of-type Replace `=` with `as` push leebyron travis-ci pending completion  
2292 schema-scalar-of-type Replace `=` with `as` push leebyron travis-ci pending completion  
2285 schema-scalar-of-type RFC: Define custom scalars in terms of built-in scalars. This proposes an additive change which allows custom scalars to be defined in terms of the built-in scalars. The motivation is for client-side code generators to understand how to map betwe... push leebyron travis-ci pending completion  
See All Builds (3630)