Change GraphQLContextFactory to return the interface

Author: Shane Myrick

examples/spring/src/main/kotlin/com/expediagroup/graphql/examples/context/MyGraphQLContextFactory.kt

@@ -9,7 +9,7 @@ import org.springframework.stereotype.Component
  * [GraphQLContextFactory] that generates [MyGraphQLContext] that will be available when processing GraphQL requests.
  */
 @Component
-class MyGraphQLContextFactory : GraphQLContextFactory<MyGraphQLContext> {
+class MyGraphQLContextFactory : GraphQLContextFactory {
 
     override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): MyGraphQLContext = MyGraphQLContext(
         myCustomValue = request.headers.getFirst("MyHeader") ?: "defaultContext",

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/execution/EmptyGraphQLContext.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2020 Expedia, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.expediagroup.graphql.execution
+
+/**
+ * Can be used as a default [GraphQLContext] if there is none provided.
+ */
+class EmptyGraphQLContext : GraphQLContext

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

@@ -123,12 +123,12 @@ class GraphQLAutoConfiguration {
 
     @Bean
     @ConditionalOnMissingBean
-    fun graphQLContextFactory(): GraphQLContextFactory<*> = EmptyContextFactory
+    fun graphQLContextFactory(): GraphQLContextFactory = EmptyContextFactory
 
     @Bean
     @ConditionalOnMissingBean
     fun contextWebFilter(
         config: GraphQLConfigurationProperties,
-        graphQLContextFactory: GraphQLContextFactory<*>
+        graphQLContextFactory: GraphQLContextFactory
     ): ContextWebFilter = ContextWebFilter(config, graphQLContextFactory)
 }

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

@@ -33,7 +33,7 @@ const val GRAPHQL_CONTEXT_FILTER_ODER = 0
 /**
  * Default web filter that populates GraphQL context in the reactor subscriber context.
  */
-open class ContextWebFilter(config: GraphQLConfigurationProperties, private val contextFactory: GraphQLContextFactory<Any>) : WebFilter, Ordered {
+open class ContextWebFilter(config: GraphQLConfigurationProperties, private val contextFactory: GraphQLContextFactory) : WebFilter, Ordered {
     private val graphQLRoute = enforceAbsolutePath(config.endpoint)
     private val subscriptionsRoute = enforceAbsolutePath(config.subscriptions.endpoint)
 

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

@@ -16,7 +16,8 @@
 
 package com.expediagroup.graphql.spring.execution
 
-import graphql.GraphQLContext
+import com.expediagroup.graphql.execution.EmptyGraphQLContext
+import com.expediagroup.graphql.execution.GraphQLContext
 import org.springframework.http.server.reactive.ServerHttpRequest
 import org.springframework.http.server.reactive.ServerHttpResponse
 
@@ -28,18 +29,18 @@ const val GRAPHQL_CONTEXT_KEY = "graphQLContext"
 /**
  * Factory that generates GraphQL context.
  */
-interface GraphQLContextFactory<out T : Any> {
+interface GraphQLContextFactory {
 
     /**
      * Generate GraphQL context based on the incoming request and the corresponding response.
      */
-    suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): T
+    suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): GraphQLContext
 }
 
 /**
  * Default context factory that generates empty GraphQL context.
  */
-internal object EmptyContextFactory : GraphQLContextFactory<GraphQLContext> {
+internal object EmptyContextFactory : GraphQLContextFactory {
 
-    override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): GraphQLContext = GraphQLContext.newContext().build()
+    override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): EmptyGraphQLContext = EmptyGraphQLContext()
 }

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

@@ -166,15 +166,15 @@ class SchemaConfigurationTest {
             .build()
 
         @Bean
-        fun myCustomContextFactory(): GraphQLContextFactory<Map<String, Any>> = mockk()
+        fun myCustomContextFactory(): GraphQLContextFactory = mockk()
 
         @Bean
         fun myDataLoaderRegistryFactory(): DataLoaderRegistryFactory = mockk()
 
         @Bean
         fun myCustomContextWebFilter(
             config: GraphQLConfigurationProperties,
-            graphQLContextFactory: GraphQLContextFactory<*>
+            graphQLContextFactory: GraphQLContextFactory
         ): ContextWebFilter = object : ContextWebFilter(config, graphQLContextFactory) {
             private val regex = config.endpoint.toRegex()
 

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

@@ -16,11 +16,11 @@
 
 package com.expediagroup.graphql.spring.context
 
+import com.expediagroup.graphql.execution.EmptyGraphQLContext
 import com.expediagroup.graphql.spring.GraphQLConfigurationProperties
 import com.expediagroup.graphql.spring.execution.ContextWebFilter
 import com.expediagroup.graphql.spring.execution.GRAPHQL_CONTEXT_KEY
 import com.expediagroup.graphql.spring.execution.GraphQLContextFactory
-import graphql.GraphQLContext
 import io.mockk.coEvery
 import io.mockk.every
 import io.mockk.mockk
@@ -54,16 +54,16 @@ class ContextWebFilterTest {
             }
         }
 
-        val simpleFactory: GraphQLContextFactory<Any> = mockk {
-            coEvery { generateContext(any(), any()) } returns GraphQLContext.newContext().build()
+        val simpleFactory: GraphQLContextFactory = mockk {
+            coEvery { generateContext(any(), any()) } returns EmptyGraphQLContext()
         }
 
         val contextFilter = ContextWebFilter(GraphQLConfigurationProperties(packages = listOf("com.expediagroup.graphql")), simpleFactory)
         StepVerifier.create(contextFilter.filter(exchange, chain))
             .verifyComplete()
 
         assertNotNull(generatedContext)
-        val graphQLContext = generatedContext?.getOrDefault<GraphQLContext>(GRAPHQL_CONTEXT_KEY, null)
+        val graphQLContext = generatedContext?.getOrDefault<EmptyGraphQLContext>(GRAPHQL_CONTEXT_KEY, null)
         assertNotNull(graphQLContext)
     }
 
@@ -90,8 +90,8 @@ class ContextWebFilterTest {
             }
         }
 
-        val simpleFactory: GraphQLContextFactory<Any> = mockk {
-            coEvery { generateContext(any(), any()) } returns GraphQLContext.newContext().build()
+        val simpleFactory: GraphQLContextFactory = mockk {
+            coEvery { generateContext(any(), any()) } returns EmptyGraphQLContext()
         }
 
         val contextFilter = ContextWebFilter(GraphQLConfigurationProperties(packages = listOf("com.expediagroup.graphql")), simpleFactory)

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

@@ -67,7 +67,7 @@ class GraphQLContextFactoryIT(@Autowired private val testClient: WebTestClient)
 
         @Bean
         @ExperimentalCoroutinesApi
-        fun customContextFactory(): GraphQLContextFactory<CustomContext> = object : GraphQLContextFactory<CustomContext> {
+        fun customContextFactory(): GraphQLContextFactory = object : GraphQLContextFactory {
             override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): CustomContext {
                 val firstValue = coroutineContext[ReactorContext]?.context?.get<String>("firstFilterValue")
                 return CustomContext(

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

@@ -170,7 +170,7 @@ class SubscriptionWebSocketHandlerIT(@LocalServerPort private var port: Int) {
         fun subscription(): Subscription = SimpleSubscription()
 
         @Bean
-        fun customContextFactory(): GraphQLContextFactory<SubscriptionContext> = object : GraphQLContextFactory<SubscriptionContext> {
+        fun customContextFactory(): GraphQLContextFactory = object : GraphQLContextFactory {
             override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): SubscriptionContext = SubscriptionContext(
                 value = request.headers.getFirst("X-Custom-Header") ?: "default"
             )

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

@@ -50,7 +50,7 @@ class RouteConfigurationIT(@Autowired private val testClient: WebTestClient) {
         fun query(): Query = SimpleQuery()
 
         @Bean
-        fun customContextFactory(): GraphQLContextFactory<CustomContext> = object : GraphQLContextFactory<CustomContext> {
+        fun customContextFactory(): GraphQLContextFactory = object : GraphQLContextFactory {
             override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): CustomContext = CustomContext(
                 value = request.headers.getFirst("X-Custom-Header") ?: "default"
             )