GraphQL Schema not found when project is a gradle multi module

[andimarek]

Hi,

not sure really this is a spring problem or a Gradle/IDEA problem, but when you have a Gradle multi module project and one of the modules is your Spring GraphQL app, then loading a GraphQL schema from the resources classpath fails (DefaultGraphQlSchemaCondition can't find it).

I created a minimal project to observe that here: https://github.com/andimarek/spring-graphql-multimodule-test

Just import in IDEA and run it. The result is that the GraphQL schema file resources/graphql/schema.graphqls is not found and hence so GraphQL setup/bootstrapping takes place.

Cheers

[bclozel]

Hey Andi

This sounds similar to #117 as this happens in an IDE and your application is using the "graphql" top level package.

You can configure a different schema location like "classpath*:graphql/". I would still suggest to use a different package namespace to avoid split packages issues with graphql-java.

Let us know if this works and if you got a failure analyzer message as in #117. We can refine this case a bit more based on your feedback.

[andimarek]

I remember the other discussion, but what is a bit strange is that it works in a normal gradle project. Only when I move it to multi module it breaks.

[spring-projects-issues]

If you would like us to look at this issue, please provide the requested information. If the information is not provided within the next 7 days this issue will be closed.

[bclozel]

I have verified that updating the configuration with the following works:

spring.graphql.schema.locations=classpath*:graphql/**/

I think that this can happen in some cases and not others, because this really depends on classpath ordering. As soon as classes in the graphql package are ordered ahead of the application resources, resolving resources against this location is problematic.

At this stage, I'm seeing two options:

1. move the default schema location to classpath:graphqlschema/**/ or something else. This will break tons of apps and there's no easy way to help developers migrate
2. use classpath*:graphql/**/ as the default location value; but this means we would be suddenly scanning schemas that were brought transitively. This can also break applications in surprising ways.

I think that assuming that developers won't be shipping classes in the graphql package is sensible, since applications doing so would already put themselves in a split package situation with the graphql-java library.

[spring-projects-issues]

If you would like us to look at this issue, please provide the requested information. If the information is not provided within the next 7 days this issue will be closed.