Skip to content

Commit

Permalink
fix: provide base Query type to extend with _entities (#575)
Browse files Browse the repository at this point in the history
Co-authored-by: David Stutt <david@wundergraph.com>
  • Loading branch information
Aenimus and David Stutt committed Aug 8, 2023
1 parent cc982b9 commit e9eb3a8
Show file tree
Hide file tree
Showing 4 changed files with 287 additions and 58 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1101,11 +1101,11 @@ func (p *Planner) printOperation() []byte {
p.stopWithError("unable to parse upstream schema")
return nil
}
}

if err := asttransform.MergeDefinitionWithBaseSchema(definition); err != nil {
p.stopWithError("unable to merge upstream schema with base schema")
return nil
if err := asttransform.MergeDefinitionWithBaseSchema(definition); err != nil {
p.stopWithError("unable to merge upstream schema with base schema")
return nil
}
}

// When datasource is nested and definition query type do not contain operation field
Expand Down
274 changes: 274 additions & 0 deletions pkg/federation/fixtures/federated_schema.golden
Original file line number Diff line number Diff line change
@@ -0,0 +1,274 @@
scalar String

scalar Int

scalar ID

schema {
query: Query
}

type Query {
me: User
topProducts(first: Int = 5): [Product]
__schema: __Schema!
__type(name: String!): __Type
__typename: String!
_service: _Service!
_entities(representations: [_Any!]!): [_Entity]!
}

type Product {
upc: String!
name: String!
price: Int!
reviews: [Review]
__typename: String!
}

type Review {
body: String!
author: User!
product: Product!
__typename: String!
}

type User {
id: ID!
username: String!
reviews: [Review]
__typename: String!
}

"The 'Int' scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1."
scalar Int

"The 'Float' scalar type represents signed double-precision fractional values as specified by [IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point)."
scalar Float

"The 'String' scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text."
scalar String

"The 'Boolean' scalar type represents 'true' or 'false' ."
scalar Boolean

"The 'ID' scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as '4') or integer (such as 4) input value will be accepted as an ID."
scalar ID

"Directs the executor to include this field or fragment only when the argument is true."
directive @include(
"Included when true."
if: Boolean!
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT

"Directs the executor to skip this field or fragment when the argument is true."
directive @skip(
"Skipped when true."
if: Boolean!
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT

"Marks an element of a GraphQL schema as no longer supported."
directive @deprecated(
"""
Explains why this element was deprecated, usually also including a suggestion
for how to access supported similar data. Formatted in
[Markdown](https://daringfireball.net/projects/markdown/).
"""
reason: String = "No longer supported"
) on FIELD_DEFINITION | ENUM_VALUE

"""
The @removeNullVariables directive allows you to remove variables with null value from your GraphQL Query or Mutation Operations.

A potential use-case could be that you have a graphql upstream which is not accepting null values for variables.
By enabling this directive all variables with null values will be removed from upstream query.

query ($say: String, $name: String) @removeNullVariables {
hello(say: $say, name: $name)
}

Directive will transform variables json and remove top level null values.
{ "say": null, "name": "world" }

So upstream will receive the following variables:

{ "name": "world" }
"""
directive @removeNullVariables on QUERY | MUTATION

"""
A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
In some cases, you need to provide options to alter GraphQL's execution behavior
in ways field arguments will not suffice, such as conditionally including or
skipping a field. Directives provide this by describing additional information
to the executor.
"""
type __Directive {
name: String!
description: String
locations: [__DirectiveLocation!]!
args: [__InputValue!]!
isRepeatable: Boolean!
__typename: String!
}

"""
A Directive can be adjacent to many parts of the GraphQL language, a
__DirectiveLocation describes one such possible adjacencies.
"""
enum __DirectiveLocation {
"Location adjacent to a query operation."
QUERY
"Location adjacent to a mutation operation."
MUTATION
"Location adjacent to a subscription operation."
SUBSCRIPTION
"Location adjacent to a field."
FIELD
"Location adjacent to a fragment definition."
FRAGMENT_DEFINITION
"Location adjacent to a fragment spread."
FRAGMENT_SPREAD
"Location adjacent to an inline fragment."
INLINE_FRAGMENT
"Location adjacent to a schema definition."
SCHEMA
"Location adjacent to a scalar definition."
SCALAR
"Location adjacent to an object type definition."
OBJECT
"Location adjacent to a field definition."
FIELD_DEFINITION
"Location adjacent to an argument definition."
ARGUMENT_DEFINITION
"Location adjacent to an interface definition."
INTERFACE
"Location adjacent to a union definition."
UNION
"Location adjacent to an enum definition."
ENUM
"Location adjacent to an enum value definition."
ENUM_VALUE
"Location adjacent to an input object type definition."
INPUT_OBJECT
"Location adjacent to an input object field definition."
INPUT_FIELD_DEFINITION
}

"""
One possible value for a given Enum. Enum values are unique values, not a
placeholder for a string or numeric value. However an Enum value is returned in
a JSON response as a string.
"""
type __EnumValue {
name: String!
description: String
isDeprecated: Boolean!
deprecationReason: String
__typename: String!
}

"""
Object and Interface types are described by a list of Fields, each of which has
a name, potentially a list of arguments, and a return type.
"""
type __Field {
name: String!
description: String
args: [__InputValue!]!
type: __Type!
isDeprecated: Boolean!
deprecationReason: String
__typename: String!
}

"""
Arguments provided to Fields or Directives and the input fields of an
InputObject are represented as Input Values which describe their type and
optionally a default value.
"""
type __InputValue {
name: String!
description: String
type: __Type!
"A GraphQL-formatted string representing the default value for this input value."
defaultValue: String
__typename: String!
}

"""
A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all
available types and directives on the server, as well as the entry points for
query, mutation, and subscription operations.
"""
type __Schema {
"A list of all types supported by this server."
types: [__Type!]!
"The type that query operations will be rooted at."
queryType: __Type!
"If this server supports mutation, the type that mutation operations will be rooted at."
mutationType: __Type
"If this server support subscription, the type that subscription operations will be rooted at."
subscriptionType: __Type
"A list of all directives supported by this server."
directives: [__Directive!]!
__typename: String!
}

"""
The fundamental unit of any GraphQL Schema is the type. There are many kinds of
types in GraphQL as represented by the '__TypeKind' enum.

Depending on the kind of a type, certain fields describe information about that
type. Scalar types provide no information beyond a name and description, while
Enum types provide their values. Object and Interface types provide the fields
they describe. Abstract types, Union and Interface, provide the Object types
possible at runtime. List and NonNull types compose other types.
"""
type __Type {
kind: __TypeKind!
name: String
description: String
fields(includeDeprecated: Boolean = false): [__Field!]
interfaces: [__Type!]
possibleTypes: [__Type!]
enumValues(includeDeprecated: Boolean = false): [__EnumValue!]
inputFields: [__InputValue!]
ofType: __Type
__typename: String!
}

"An enum describing what kind of type a given '__Type' is."
enum __TypeKind {
"Indicates this type is a scalar."
SCALAR
"Indicates this type is an object. 'fields' and 'interfaces' are valid fields."
OBJECT
"Indicates this type is an interface. 'fields' ' and ' 'possibleTypes' are valid fields."
INTERFACE
"Indicates this type is a union. 'possibleTypes' is a valid field."
UNION
"Indicates this type is an enum. 'enumValues' is a valid field."
ENUM
"Indicates this type is an input object. 'inputFields' is a valid field."
INPUT_OBJECT
"Indicates this type is a list. 'ofType' is a valid field."
LIST
"Indicates this type is a non-null. 'ofType' is a valid field."
NON_NULL
}

scalar _Any
scalar _FieldSet

union _Entity = Product | User

type _Service {
sdl: String
}

directive @external on FIELD_DEFINITION
directive @requires(fields: _FieldSet!) on FIELD_DEFINITION
directive @provides(fields: _FieldSet!) on FIELD_DEFINITION
directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
directive @extends on OBJECT | INTERFACE
8 changes: 7 additions & 1 deletion pkg/federation/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package federation

import (
"fmt"
"github.com/wundergraph/graphql-go-tools/pkg/asttransform"
"strings"

"github.com/wundergraph/graphql-go-tools/pkg/ast"
Expand Down Expand Up @@ -49,6 +50,11 @@ func (s *schemaBuilder) extendQueryTypeWithFederationFields(schema string) strin
if report.HasErrors() {
return schema
}

if err := asttransform.MergeDefinitionWithBaseSchema(doc); err != nil {
return schema
}

queryTypeName := doc.Index.QueryTypeName.String()
if queryTypeName == "" {
queryTypeName = "Query"
Expand Down Expand Up @@ -143,7 +149,7 @@ func (s *schemaBuilderVisitor) addEntity(entity string) {
s.entityUnionTypes = append(s.entityUnionTypes, entity)
}

func (s *schemaBuilderVisitor) EnterDocument(operation, definition *ast.Document) {
func (s *schemaBuilderVisitor) EnterDocument(operation, _ *ast.Document) {
s.definition = operation
}

Expand Down
55 changes: 2 additions & 53 deletions pkg/federation/schema_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package federation

import (
"github.com/wundergraph/graphql-go-tools/pkg/testing/goldie"
"testing"

"github.com/stretchr/testify/assert"
Expand All @@ -9,7 +10,7 @@ import (
func TestSchemaBuilder_BuildFederationSchema(t *testing.T) {
actual, err := BuildFederationSchema(baseSchema, serviceSDL)
assert.NoError(t, err)
assert.Equal(t, federatedSchema, actual)
goldie.Assert(t, "federated_schema", []byte(actual))
}

const serviceSDL = `extend type Query {topProducts(first: Int = 5): [Product]}type Product @key(fields: "upc") {upc: String!name: String! price: Int!} extend type Query {me: User} type User @key(fields: "id"){ id: ID! username: String!} type Review { body: String! author: User! @provides(fields: "username") product: Product! } extend type User @key(fields: "id") { id: ID! @external reviews: [Review] } extend type Product @key(fields: "upc") { upc: String! @external reviews: [Review] }`
Expand Down Expand Up @@ -47,55 +48,3 @@ type User {
reviews: [Review]
}
`

const federatedSchema = `scalar String
scalar Int
scalar ID
schema {
query: Query
}
type Query {
me: User
topProducts(first: Int = 5): [Product]
_service: _Service!
_entities(representations: [_Any!]!): [_Entity]!
}
type Product {
upc: String!
name: String!
price: Int!
reviews: [Review]
}
type Review {
body: String!
author: User!
product: Product!
}
type User {
id: ID!
username: String!
reviews: [Review]
}
scalar _Any
scalar _FieldSet
union _Entity = Product | User
type _Service {
sdl: String
}
directive @external on FIELD_DEFINITION
directive @requires(fields: _FieldSet!) on FIELD_DEFINITION
directive @provides(fields: _FieldSet!) on FIELD_DEFINITION
directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
directive @extends on OBJECT | INTERFACE
`

0 comments on commit e9eb3a8

Please sign in to comment.