fix: GraphiQL may render broken and cannot be fully disabled

[foo4u]

Pull request checklist

• Please read our contributor guide
• Consider creating a discussion on the discussion forum
  first
• Make sure the PR doesn't introduce backward compatibility issues
• Make sure to have sufficient test cases: tests cases already exist to cover not enabling GraphiQL for both MVC and WebFlux. However, the auto configuration for automatic resource discovery is not enabled on such tests. If you'd like this PR to be updated with static resource loading enabled I can do that.

Pull Request type

• Bugfix

Changes in this PR

Fix a few issues with GraphiQL:

• Issue bug: Sometimes DGS_GRAPHQL_PATH is not set and it breaks the GraphiQL forcing me to redeploy the app #1135
• Fix an issue where dgs.graphql.graphiql.enabled is not recognized as a valid configuration option with WebFlux
• Allow GraphiQL to be fully disabled, even if spring.web.resources.add-mappings it set to true (the default)

Alternatives considered

DGS_GRAPHQL_PATH is sometimes unset because there's a race condition between Spring's built in static resource handler and DGS' GraphiQL handlers in both Spring MVC and WebFlux. The alternative option to changing the path for graphiql would be to force applications to configure spring.web.resources.add-mappings to false; it defaults to true.

PR #1167 from another contributor, also says it fixes #1135. However, it looks like a different potential issue related non-ASCII data in queries, rather than a fix for this bug.

[foo4u]

@srinivasankavitha any way to get 👀 on this?

[srinivasankavitha]

Where is this used?

[foo4u]

It's used by Spring's metadata generator. The property isn't used directly by DGS b/c it's referred to in full dot notation as a @Conditional. This is mainly useful for IDE autocompletion.

dgs-framework/graphql-dgs-spring-webflux-autoconfigure/src/main/kotlin/com/netflix/graphql/dgs/webflux/autoconfiguration/DgsWebFluxAutoConfiguration.kt

Lines 144 to 147 in 8fa2368

	@ConditionalOnProperty(name = ["dgs.graphql.graphiql.enabled"], havingValue = "true", matchIfMissing = true)
	open fun graphiQlConfigurer(configProps: DgsWebfluxConfigurationProperties): GraphiQlConfigurer {
	return GraphiQlConfigurer(configProps)
	}

[srinivasankavitha]

For my understanding, could you explain why moving the location out of the static directory addresses the race condition?

[foo4u]

DGS_GRAPHQL_PATH is sometimes unset because there's a race condition between Spring's built in static resource handler and DGS' GraphiQL handlers in both Spring MVC and WebFlux. The alternative option to changing the path for graphiql would be to force applications to configure spring.web.resources.add-mappings to false; it defaults to true.

So, Spring attempts to serve all assets under resources/static as static files. This means the resources are served as-is from disk / JAR, and not processed by the DGS handler. Depending on bean registration order, the DGS handler may be registered after Spring's static resource handler.

From my understanding about Spring, it's best NOT to store templates that require server side rendering in /resources/[static|public].

[foo4u]

Hi @srinivasankavitha , I answered your questions and rebased this on master. It should be ready. 🙏 Thank you!