Merge pull request #2179 from Netflix/feature/strict-mode-property

Add a dgs.graphql.strictmode.enabled property

Author: paulbakker

graphql-dgs-spring-graphql/src/main/kotlin/com/netflix/graphql/dgs/autoconfig/DgsConfigurationProperties.kt

@@ -32,6 +32,7 @@ data class DgsConfigurationProperties(
     val preparsedDocumentProvider: DgsPreparsedDocumentProviderConfigurationProperties =
         DgsPreparsedDocumentProviderConfigurationProperties(),
     val introspection: DgsIntrospectionConfigurationProperties = DgsIntrospectionConfigurationProperties(),
+    val strictMode: DgsStrictModeProperties = DgsStrictModeProperties(),
 ) {
     data class DgsPreparsedDocumentProviderConfigurationProperties(
         val enabled: Boolean = false,
@@ -45,4 +46,8 @@ data class DgsConfigurationProperties(
          * This property toggles that visibility. */
         val showSdlComments: Boolean = true,
     )
+
+    data class DgsStrictModeProperties(
+        val enabled: Boolean = true,
+    )
 }

graphql-dgs-spring-graphql/src/main/kotlin/com/netflix/graphql/dgs/springgraphql/autoconfig/DgsSpringGraphQLAutoConfiguration.kt

@@ -307,6 +307,7 @@ open class DgsSpringGraphQLAutoConfiguration(
             schemaWiringValidationEnabled = configProps.schemaWiringValidationEnabled,
             enableEntityFetcherCustomScalarParsing = configProps.enableEntityFetcherCustomScalarParsing,
             fallbackTypeResolver = fallbackTypeResolver,
+            enableStrictMode = configProps.strictMode.enabled,
         )
 
     @Bean

graphql-dgs-spring-graphql/src/main/resources/META-INF/spring-configuration-metadata.json

@@ -96,6 +96,12 @@
       "type": "java.lang.Boolean",
       "description": "Enable async dispatching in the request handling. This can reduce the number of server working threads required, but requires all filters to be async aware, and tests to handle async correctly."
     },
+    {
+      "name": "dgs.graphql.strict-mode.enabled",
+      "defaultValue": "true",
+      "type": "java.lang.Boolean",
+      "description": "Enable GraphQL Java strict mode on RuntimeWiring.Builder."
+    },
     {
       "name": "dgs.graphql.virtualthreads.enabled",
       "defaultValue": "false",

graphql-dgs-spring-graphql/src/test/kotlin/com/netflix/graphql/dgs/springgraphql/autoconfig/DgsSpringGraphQlAutoConfigurationTest.kt

@@ -17,6 +17,7 @@
 package com.netflix.graphql.dgs.springgraphql.autoconfig
 
 import com.netflix.graphql.dgs.DgsQueryExecutor
+import com.netflix.graphql.dgs.autoconfig.DgsConfigurationProperties
 import com.netflix.graphql.dgs.internal.DgsSchemaProvider
 import com.netflix.graphql.dgs.mvc.internal.method.HandlerMethodArgumentResolverAdapter
 import com.netflix.graphql.dgs.reactive.DgsReactiveQueryExecutor
@@ -324,4 +325,31 @@ class DgsSpringGraphQlAutoConfigurationTest {
                 }
             }
     }
+
+    @Test
+    fun loadsDefaultStrictmodeConfiguration() {
+        ApplicationContextRunner()
+            .withConfiguration(autoConfigurations)
+            .run { context ->
+                assertThat(
+                    context
+                        .getBean(DgsConfigurationProperties::class.java)
+                        .strictMode.enabled,
+                ).isTrue()
+            }
+    }
+
+    @Test
+    fun loadsStrictmodeConfiguration() {
+        ApplicationContextRunner()
+            .withConfiguration(autoConfigurations)
+            .withPropertyValues("dgs.graphql.strict-mode.enabled=false")
+            .run { context ->
+                assertThat(
+                    context
+                        .getBean(DgsConfigurationProperties::class.java)
+                        .strictMode.enabled,
+                ).isFalse()
+            }
+    }
 }

graphql-dgs/src/main/kotlin/com/netflix/graphql/dgs/internal/DgsSchemaProvider.kt

@@ -112,6 +112,7 @@ class DgsSchemaProvider
         private val schemaWiringValidationEnabled: Boolean = true,
         private val enableEntityFetcherCustomScalarParsing: Boolean = false,
         private val fallbackTypeResolver: TypeResolver? = null,
+        private val enableStrictMode: Boolean = true,
     ) {
         @Suppress("UNUSED_PARAMETER")
         @Deprecated("The mockProviders argument is no longer supported")
@@ -230,7 +231,11 @@ class DgsSchemaProvider
             }
 
             val runtimeWiringBuilder =
-                RuntimeWiring.newRuntimeWiring().codeRegistry(codeRegistryBuilder).fieldVisibility(fieldVisibility)
+                RuntimeWiring
+                    .newRuntimeWiring()
+                    .strictMode(enableStrictMode)
+                    .codeRegistry(codeRegistryBuilder)
+                    .fieldVisibility(fieldVisibility)
 
             val dgsCodeRegistryBuilder =
                 DgsCodeRegistryBuilder(dataFetcherResultProcessors, codeRegistryBuilder, applicationContext)

graphql-dgs/src/test/kotlin/com/netflix/graphql/dgs/DgsSchemaProviderTest.kt

@@ -36,8 +36,11 @@ import graphql.language.TypeName
 import graphql.schema.DataFetcher
 import graphql.schema.FieldCoordinates
 import graphql.schema.GraphQLCodeRegistry
+import graphql.schema.GraphQLScalarType
 import graphql.schema.TypeResolver
+import graphql.schema.idl.RuntimeWiring
 import graphql.schema.idl.TypeDefinitionRegistry
+import graphql.schema.idl.errors.StrictModeWiringException
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatNoException
 import org.junit.jupiter.api.Assertions.assertEquals
@@ -83,6 +86,7 @@ internal class DgsSchemaProviderTest {
         schemaWiringValidationEnabled: Boolean = true,
         dataFetcherResultProcessors: List<DataFetcherResultProcessor> = emptyList(),
         fallbackTypeResolver: TypeResolver? = null,
+        strictMode: Boolean = true,
     ): DgsSchemaProvider =
         DgsSchemaProvider(
             applicationContext = applicationContext,
@@ -100,6 +104,7 @@ internal class DgsSchemaProviderTest {
             schemaWiringValidationEnabled = schemaWiringValidationEnabled,
             dataFetcherResultProcessors = dataFetcherResultProcessors,
             fallbackTypeResolver = fallbackTypeResolver,
+            enableStrictMode = strictMode,
         )
 
     @DgsComponent
@@ -1343,4 +1348,47 @@ internal class DgsSchemaProviderTest {
             assert(sdlCommentsInResult.isEmpty())
         }
     }
+
+    @Test
+    fun `StrictMode should fail when enabled and duplicate scalars are registered`() {
+        contextRunner.withBeans(DuplicateScalarWiring::class).run { context ->
+            val schemaProvider = schemaProvider(applicationContext = context, strictMode = true)
+            assertThrows<StrictModeWiringException> { schemaProvider.schema() }
+        }
+    }
+
+    @Test
+    fun `StrictMode should not fail when disabled and duplicate scalars are registered`() {
+        contextRunner.withBeans(DuplicateScalarWiring::class).run { context ->
+            val schemaProvider = schemaProvider(applicationContext = context, strictMode = false)
+            assertDoesNotThrow { schemaProvider.schema() }
+        }
+    }
+
+    @DgsComponent
+    class DuplicateScalarWiring {
+        @DgsRuntimeWiring
+        fun customWiring(builder: RuntimeWiring.Builder): RuntimeWiring.Builder {
+            builder.scalar(
+                GraphQLScalarType
+                    .Builder()
+                    .name("Test")
+                    .coercing(LocalDateTimeScalar())
+                    .build(),
+            )
+            return builder
+        }
+
+        @DgsRuntimeWiring
+        fun customWiring2(builder: RuntimeWiring.Builder): RuntimeWiring.Builder {
+            builder.scalar(
+                GraphQLScalarType
+                    .Builder()
+                    .name("Test")
+                    .coercing(LocalDateTimeScalar())
+                    .build(),
+            )
+            return builder
+        }
+    }
 }