Refactor to remove build warnings (#611)

* Refactor to clean up some build warnings

Non-functional change that just adds some internal documentation and cleans up some build and IDE warnings

* Suppress unused wanrings in tests

* Undo RouteConfiguration changes

* Move strings to const

* Move constants to internal file reference

* Remove unessacary function calls

Author: smyrick

examples/gradle.properties

@@ -4,3 +4,4 @@ version = 1.0-SNAPSHOT
 # build config
 org.gradle.caching=true
 org.gradle.parallel=true
+kapt.incremental.apt=true

gradle.properties

@@ -4,6 +4,7 @@ version = 2.0.0-SNAPSHOT
 # build config
 org.gradle.caching=true
 org.gradle.parallel=true
+kapt.incremental.apt=true
 
 # See https://github.com/gradle/gradle/issues/11308
 systemProp.org.gradle.internal.publish.checksums.insecure=true

graphql-kotlin-schema-generator/src/test/kotlin/com/expediagroup/graphql/generator/ToSchemaTest.kt

@@ -44,10 +44,14 @@ import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 
-@Suppress("Detekt.UnusedPrivateMember",
+@Suppress(
+    "Detekt.UnusedPrivateMember",
     "Detekt.FunctionOnlyReturningConstant",
     "Detekt.LargeClass",
-    "Detekt.MethodOverloading")
+    "Detekt.MethodOverloading",
+    "UNUSED_PARAMETER",
+    "unused"
+)
 class ToSchemaTest {
 
     @Test
@@ -452,11 +456,11 @@ class ToSchemaTest {
     }
 
     class QueryWithJavaClass {
-        fun query(): java.net.CookieManager? = CookieManager()
+        fun query(): CookieManager? = CookieManager()
     }
 
     class QueryWithListOfJavaClass {
-        fun listQuery(): List<java.net.CookieManager> = listOf(CookieManager())
+        fun listQuery(): List<CookieManager> = listOf(CookieManager())
     }
 
     class QueryWithConflictingTypes {

graphql-kotlin-spring-server/src/main/kotlin/com/expediagroup/graphql/spring/RoutesConfiguration.kt

@@ -35,6 +35,11 @@ import org.springframework.web.reactive.function.server.buildAndAwait
 import org.springframework.web.reactive.function.server.coRouter
 import org.springframework.web.reactive.function.server.json
 
+internal const val REQUEST_PARAM_QUERY = "query"
+internal const val REQUEST_PARAM_OPERATION_NAME = "operationName"
+internal const val REQUEST_PARAM_VARIABLES = "variables"
+internal val graphQLMediaType = MediaType("application", "graphql")
+
 /**
  * Default route configuration for GraphQL service and SDL service endpoints.
  */
@@ -45,7 +50,6 @@ class RoutesConfiguration(
     private val queryHandler: QueryHandler,
     private val objectMapper: ObjectMapper
 ) {
-    private val graphQLMediaType: MediaType = MediaType("application", "graphql")
     private val mapTypeReference: MapType = TypeFactory.defaultInstance().constructMapType(HashMap::class.java, String::class.java, Any::class.java)
 
     @Bean
@@ -84,10 +88,10 @@ class RoutesConfiguration(
     // https://github.com/FasterXML/jackson-module-kotlin/issues/221
     @Suppress("BlockingMethodInNonBlockingContext")
     private suspend fun createGraphQLRequest(serverRequest: ServerRequest): GraphQLRequest? = when {
-        serverRequest.queryParam("query").isPresent -> {
-            val query = serverRequest.queryParam("query").get()
-            val operationName: String? = serverRequest.queryParam("operationName").orElseGet { null }
-            val variables: String? = serverRequest.queryParam("variables").orElseGet { null }
+        serverRequest.queryParam(REQUEST_PARAM_QUERY).isPresent -> {
+            val query = serverRequest.queryParam(REQUEST_PARAM_QUERY).get()
+            val operationName: String? = serverRequest.queryParam(REQUEST_PARAM_OPERATION_NAME).orElseGet { null }
+            val variables: String? = serverRequest.queryParam(REQUEST_PARAM_VARIABLES).orElseGet { null }
             val graphQLVariables: Map<String, Any>? = variables?.let {
                 objectMapper.readValue(it, mapTypeReference)
             }

graphql-kotlin-spring-server/src/test/kotlin/com/expediagroup/graphql/spring/FederationConfigurationTest.kt

@@ -132,6 +132,7 @@ class FederationConfigurationTest {
         )
     }
 
+    @Suppress("unused")
     class FederatedQuery : Query {
         fun widget(): Widget = Widget(1, "hello")
     }

graphql-kotlin-spring-server/src/test/kotlin/com/expediagroup/graphql/spring/SubscriptionConfigurationTest.kt

@@ -139,6 +139,7 @@ class SubscriptionConfigurationTest {
         fun query(): String = "hello!"
     }
 
+    @Suppress("unused")
     class SimpleSubscription : Subscription {
         fun ticker(): Flux<Int> = Flux.range(1, 5)
             .delayElements(Duration.ofMillis(100))

graphql-kotlin-spring-server/src/test/kotlin/com/expediagroup/graphql/spring/instrumentation/InstrumentationIT.kt

@@ -38,6 +38,7 @@ class InstrumentationIT(@Autowired private val testClient: WebTestClient) {
         fun secondInstrumentation(): Instrumentation = OrderedInstrumentation(DEFAULT_INSTRUMENTATION_ORDER + 1, atomicCounter)
     }
 
+    @Suppress("unused")
     class BasicQuery : Query {
         fun helloWorld(name: String) = "Hello $name!"
     }

graphql-kotlin-spring-server/src/test/kotlin/com/expediagroup/graphql/spring/routes/RouteConfigurationIT.kt

@@ -17,7 +17,11 @@
 package com.expediagroup.graphql.spring.routes
 
 import com.expediagroup.graphql.annotations.GraphQLContext
+import com.expediagroup.graphql.spring.REQUEST_PARAM_OPERATION_NAME
+import com.expediagroup.graphql.spring.REQUEST_PARAM_QUERY
+import com.expediagroup.graphql.spring.REQUEST_PARAM_VARIABLES
 import com.expediagroup.graphql.spring.execution.GraphQLContextFactory
+import com.expediagroup.graphql.spring.graphQLMediaType
 import com.expediagroup.graphql.spring.model.GraphQLRequest
 import com.expediagroup.graphql.spring.operations.Query
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
@@ -124,7 +128,7 @@ class RouteConfigurationIT(@Autowired private val testClient: WebTestClient) {
         testClient.get()
             .uri { builder ->
                 builder.path("/graphql")
-                    .queryParam("query", "{query}")
+                    .queryParam(REQUEST_PARAM_QUERY, "{query}")
                     .build(query)
             }
             .exchange()
@@ -139,9 +143,9 @@ class RouteConfigurationIT(@Autowired private val testClient: WebTestClient) {
         testClient.get()
             .uri { builder ->
                 builder.path("/graphql")
-                    .queryParam("query", "{query}")
-                    .queryParam("variables", "{variables}")
-                    .queryParam("operationName", "{operationName}")
+                    .queryParam(REQUEST_PARAM_QUERY, "{query}")
+                    .queryParam(REQUEST_PARAM_VARIABLES, "{variables}")
+                    .queryParam(REQUEST_PARAM_OPERATION_NAME, "{operationName}")
                     .build(query, jacksonObjectMapper().writeValueAsString(variables), operationName)
             }
             .exchange()
@@ -159,7 +163,7 @@ class RouteConfigurationIT(@Autowired private val testClient: WebTestClient) {
         testClient.post()
             .uri { builder ->
                 builder.path("/graphql")
-                    .queryParam("query", "{query}")
+                    .queryParam(REQUEST_PARAM_QUERY, "{query}")
                     .build("{ hello(name: \"POST query param\") }")
             }
             .accept(MediaType.APPLICATION_JSON)
@@ -174,7 +178,7 @@ class RouteConfigurationIT(@Autowired private val testClient: WebTestClient) {
         testClient.post()
             .uri("/graphql")
             .accept(MediaType.APPLICATION_JSON)
-            .contentType(MediaType("application", "graphql"))
+            .contentType(graphQLMediaType)
             .bodyValue("query { hello(name: \"POST application/graphql\") }")
             .exchange()
             .verifyGraphQLRoute("Hello POST application/graphql!")

graphql-kotlin-spring-server/src/test/kotlin/com/expediagroup/graphql/spring/routes/SubscriptionRoutesConfigurationIT.kt

@@ -16,6 +16,7 @@
 
 package com.expediagroup.graphql.spring.routes
 
+import com.expediagroup.graphql.spring.REQUEST_PARAM_QUERY
 import com.expediagroup.graphql.spring.model.GraphQLRequest
 import com.expediagroup.graphql.spring.model.SubscriptionOperationMessage
 import com.expediagroup.graphql.spring.operations.Query
@@ -32,7 +33,6 @@ import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
 import org.springframework.http.MediaType
 import org.springframework.test.web.reactive.server.WebTestClient
-import org.springframework.web.reactive.socket.WebSocketMessage
 import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient
 import reactor.core.publisher.Flux
 import reactor.core.publisher.Mono
@@ -69,6 +69,7 @@ class SubscriptionRoutesConfigurationIT(
         fun hello(name: String) = "Hello $name!"
     }
 
+    @Suppress("unused")
     class SimpleSubscription : Subscription {
         fun getNumber(): Flux<Int> = Flux.just(42)
     }
@@ -96,7 +97,7 @@ class SubscriptionRoutesConfigurationIT(
         testClient.get()
             .uri { builder ->
                 builder.path("/foo")
-                    .queryParam("query", "{query}")
+                    .queryParam(REQUEST_PARAM_QUERY, "{query}")
                     .build(query)
             }
             .exchange()
@@ -115,8 +116,7 @@ class SubscriptionRoutesConfigurationIT(
         val sessionMono = client.execute(uri) { session ->
             session.send(Mono.just(session.textMessage(objectMapper.writeValueAsString(message))))
                 .thenMany(session.receive()
-                    .map(WebSocketMessage::getPayloadAsText)
-                    .map { objectMapper.readValue<SubscriptionOperationMessage>(it) }
+                    .map { objectMapper.readValue<SubscriptionOperationMessage>(it.payloadAsText) }
                     .map { objectMapper.writeValueAsString(it.payload) }
                 )
                 .subscribeWith(output)