Spring GraphQL integration causes breaking change

[GregLyons]

Hello, I recently tried to update the DGS dependency in our project, and I'm met with the following error whenever I try to run the application:

Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.springframework.graphql.ExecutionGraphQlService]: Factory method 'executionGraphQlService' threw exception with message: No node type for 'TestConnection'
	at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:177) ~[spring-beans-6.1.6.jar:6.1.6]
	at org.springframework.beans.factory.support.ConstructorResolver.instantiate(ConstructorResolver.java:644) ~[spring-beans-6.1.6.jar:6.1.6]
	... 32 common frames omitted
Caused by: java.lang.IllegalStateException: No node type for 'TestConnection'
	at org.springframework.util.Assert.state(Assert.java:76) ~[spring-core-6.1.6.jar:6.1.6]
	at org.springframework.graphql.execution.SchemaMappingInspector.getPaginatedType(SchemaMappingInspector.java:226) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.graphql.execution.SchemaMappingInspector.checkField(SchemaMappingInspector.java:177) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.graphql.execution.SchemaMappingInspector.checkFieldsContainer(SchemaMappingInspector.java:153) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.graphql.execution.SchemaMappingInspector.checkSchemaFields(SchemaMappingInspector.java:126) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.graphql.execution.SchemaMappingInspector.getOrCreateReport(SchemaMappingInspector.java:117) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.graphql.execution.SchemaMappingInspector.inspect(SchemaMappingInspector.java:337) ~[spring-graphql-1.2.6.jar:1.2.6]
	at com.netflix.graphql.dgs.springgraphql.DgsGraphQLSourceBuilder.setupSchemaReporter$lambda$2(DgsGraphQLSourceBuilder.kt:127) ~[graphql-dgs-spring-graphql-8.6.0.jar:8.6.0]
	at java.base/java.util.function.Consumer.lambda$andThen$0(Consumer.java:65) ~[na:na]
	at org.springframework.graphql.execution.AbstractGraphQlSourceBuilder.applyGraphQlConfigurers(AbstractGraphQlSourceBuilder.java:161) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.graphql.execution.AbstractGraphQlSourceBuilder.build(AbstractGraphQlSourceBuilder.java:118) ~[spring-graphql-1.2.6.jar:1.2.6]
	at com.netflix.graphql.dgs.springgraphql.ReloadableGraphQLSource.getSource(ReloadableGraphQLSource.kt:43) ~[graphql-dgs-spring-graphql-8.6.0.jar:8.6.0]
	at com.netflix.graphql.dgs.springgraphql.ReloadableGraphQLSource.graphQl(ReloadableGraphQLSource.kt:33) ~[graphql-dgs-spring-graphql-8.6.0.jar:8.6.0]
	at org.springframework.graphql.execution.DefaultExecutionGraphQlService.<init>(DefaultExecutionGraphQlService.java:62) ~[spring-graphql-1.2.6.jar:1.2.6]
	at org.springframework.boot.autoconfigure.graphql.GraphQlAutoConfiguration.executionGraphQlService(GraphQlAutoConfiguration.java:149) ~[spring-boot-autoconfigure-3.2.5.jar:3.2.5]
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) ~[na:na]
	at java.base/java.lang.reflect.Method.invoke(Method.java:580) ~[na:na]
	at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:140) ~[spring-beans-6.1.6.jar:6.1.6]
	... 33 common frames omitted

What's happening is that org.springframework.graphql.execution.SchemaMappingInspector#getPaginatedType from the Spring GraphQL package is trying to enforce a specific naming convention on my schema:

private GraphQLType getPaginatedType(GraphQLObjectType type) {
		String name = type.getName().substring(0, type.getName().length() - 10);
		GraphQLType nodeType = this.schema.getType(name);
		Assert.state(nodeType != null, "No node type for '" + type.getName() + "'");
		return nodeType;
	}

Basically, if you have a type called TestConnection, there must be a type called Test in the schema. Otherwise, this validation will prevent the application from starting.

I'm not aware of any spec that this behavior is following. The Relay connection spec, which is the only spec I've seen for pagination with connections, only necessitates that the connection types themselves end with Connection; it doesn't require anything on the naming of the edge or node types. In our project, we suffix our node types with Node, for example.

What options do we have to update? Given that the validation holds even if TestNode is an interface, we cannot change the name of an interface like TestNode since that would be a breaking change to our API consumers trying to query the interface. The least disruptive change I can think of is to make a dummy type with the expected name:

type Test {
    useless: String
}

This gets rid of the error, but isn't so satisfactory. Perhaps there's a way to remove it from introspection? At least then it wouldn't be visible to API consumers.

I understand that this issue is caused by Spring GraphQL rather than the DGS Framework itself, but given that DGS is moving towards integration with Spring GraphQL, I'd like to know if DGS has any recommendations that would make this adoption easier. I personally would suggest to Spring GraphQL that they either give the option to opt-out of the validation altogether, and/or give the option to have a consistent suffix on the node types, especially since I'm not aware of any spec that requires this naming convention that they're enforcing. Is there anyway to make it so that we could at least configure the graphql-dgs-spring-graphql-starter to prevent this behavior?

[GregLyons]

Here's my build.gradle and my schema in a minimal example:

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.5'
    id 'io.spring.dependency-management' version '1.1.4'
    id "com.netflix.dgs.codegen" version "6.1.10"
}

group = 'org.example'
version = '0.0.1-SNAPSHOT'

java {
    sourceCompatibility = '21'
}

repositories {
    mavenCentral()
}

dependencyManagement {
    imports {
        mavenBom("com.netflix.graphql.dgs:graphql-dgs-platform-dependencies:latest.release")
    }
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    implementation "com.netflix.graphql.dgs:graphql-dgs-spring-graphql-starter"
}

tasks.named('test') {
    useJUnitPlatform()
}

generateJava{
    schemaPaths = ["${projectDir}/src/main/resources/schema"] // List of directories containing schema files
    packageName = 'com.example.graphqltypes' // The package name to use to generate sources
    generateClient = true // Enable generating the type safe query API
}

interface Node {
    id: ID!
}

interface Edge {
    cursor: String!
    node: Node!
}

type PageInfo {
    endCursor: String
    hasNextPage: Boolean!
    startCursor: String
    hasPreviousPage: Boolean!
}

interface Connection {
    pageInfo: PageInfo!
    edges: [Edge!]!
}

type TestNode implements Node {
    id: ID!
}

type TestEdge implements Edge {
    cursor: String!
    node: TestNode!
}

type TestConnection implements Connection {
    pageInfo: PageInfo!
    edges: [TestEdge!]!
}

type Query {
    tests: TestConnection!
}

The error arises once I implement a data fetcher for the Query#tests field.

@DgsComponent
public class TestDataFetcher {
    @DgsQuery(field = DgsConstants.QUERY.Tests)
    public TestConnection tests() {
        return null;
    }
}

[paulbakker]

It’s a known issue with the schema validation in spring graphql related to connections. While that issue exists, you can disable the validation with a property.

…

On Mon, May 13, 2024 at 10:56 AM GregLyons ***@***.***> wrote: Here's my build.gradle and my schema in a minimal example: plugins { id 'java' id 'org.springframework.boot' version '3.2.5' id 'io.spring.dependency-management' version '1.1.4' id "com.netflix.dgs.codegen" version "6.1.10" } group = 'org.example' version = '0.0.1-SNAPSHOT' java { sourceCompatibility = '21' } repositories { mavenCentral() } dependencyManagement { imports { mavenBom("com.netflix.graphql.dgs:graphql-dgs-platform-dependencies:latest.release") } } dependencies { implementation 'org.springframework.boot:spring-boot-starter' testImplementation 'org.springframework.boot:spring-boot-starter-test' implementation "com.netflix.graphql.dgs:graphql-dgs-spring-graphql-starter" } tasks.named('test') { useJUnitPlatform() } generateJava{ schemaPaths = ["${projectDir}/src/main/resources/schema"] // List of directories containing schema files packageName = 'com.example.graphqltypes' // The package name to use to generate sources generateClient = true // Enable generating the type safe query API } interface Node { id: ID! } interface Edge { cursor: String! node: Node! } type PageInfo { endCursor: String hasNextPage: Boolean! startCursor: String hasPreviousPage: Boolean! } interface Connection { pageInfo: PageInfo! edges: [Edge!]! } type TestNode implements Node { id: ID! } type TestEdge implements Edge { cursor: String! node: TestNode! } type TestConnection implements Connection { pageInfo: PageInfo! edges: [TestEdge!]! } type Query { tests: TestConnection! } type Test { useless: String } — Reply to this email directly, view it on GitHub <#1907 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAA2XLHXXTBHYZHWOMRJPM3ZCAMUXAVCNFSM6AAAAABHTJZI42VHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TIMJSGI3DS> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.*** com>

[GregLyons]

Thank you, I was able to find the property:

# Prevent "No node type for '...Connection'" IllegalStateException
spring.graphql.schema.inspection.enabled=false