Revert deletion of annotation class

Undo the deletion of the old annotation and instead make these changes a minor feature addition

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 {
+class MyGraphQLContextFactory : GraphQLContextFactory<MyGraphQLContext> {
 
     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/annotations/GraphQLContext.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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.annotations
+
+/**
+ * Mark something for the GraphQL context.
+ */
+annotation class GraphQLContext

graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/generator/extensions/kParameterExtensions.kt

@@ -20,13 +20,15 @@ import com.expediagroup.graphql.exceptions.CouldNotGetNameOfKParameterException
 import com.expediagroup.graphql.execution.GraphQLContext
 import graphql.schema.DataFetchingEnvironment
 import kotlin.reflect.KParameter
+import kotlin.reflect.full.findAnnotation
 import kotlin.reflect.full.isSubclassOf
+import com.expediagroup.graphql.annotations.GraphQLContext as GraphQLContextAnnotation
 
 internal fun KParameter.isInterface() = this.type.getKClass().isInterface()
 
 internal fun KParameter.isList() = this.type.getKClass().isSubclassOf(List::class)
 
-internal fun KParameter.isGraphQLContext() = this.type.getKClass().isSubclassOf(GraphQLContext::class)
+internal fun KParameter.isGraphQLContext() = this.type.getKClass().isSubclassOf(GraphQLContext::class) || this.findAnnotation<GraphQLContextAnnotation>() != null
 
 internal fun KParameter.isDataFetchingEnvironment() = this.type.classifier == DataFetchingEnvironment::class
 

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

@@ -30,6 +30,7 @@ import kotlin.test.assertFalse
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
+import com.expediagroup.graphql.annotations.GraphQLContext as GraphQLContextAnnotation
 
 internal class FunctionDataFetcherTest {
 
@@ -42,7 +43,9 @@ internal class FunctionDataFetcherTest {
 
         fun printList(items: List<String>) = items.joinToString(separator = ":")
 
-        fun context(myContext: MyContext) = myContext.value
+        fun context(@GraphQLContextAnnotation string: String) = string
+
+        fun contextClass(myContext: MyContext) = myContext.value
 
         fun dataFetchingEnvironment(environment: DataFetchingEnvironment): String = environment.field.name
 
@@ -93,9 +96,17 @@ internal class FunctionDataFetcherTest {
     }
 
     @Test
-    fun `valid target with context`() {
+    fun `valid target with context annotation`() {
         val dataFetcher = FunctionDataFetcher(target = MyClass(), fn = MyClass::context)
         val mockEnvironmet: DataFetchingEnvironment = mockk()
+        every { mockEnvironmet.getContext<String>() } returns "foo"
+        assertEquals(expected = "foo", actual = dataFetcher.get(mockEnvironmet))
+    }
+
+    @Test
+    fun `valid target with context class`() {
+        val dataFetcher = FunctionDataFetcher(target = MyClass(), fn = MyClass::contextClass)
+        val mockEnvironmet: DataFetchingEnvironment = mockk()
         every { mockEnvironmet.getContext<MyContext>() } returns MyContext("foo")
         assertEquals(expected = "foo", actual = dataFetcher.get(mockEnvironmet))
     }

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

@@ -21,6 +21,7 @@ import com.expediagroup.graphql.execution.GraphQLContext
 import graphql.schema.DataFetchingEnvironment
 import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
+import com.expediagroup.graphql.annotations.GraphQLContext as GraphQLContextAnnotation
 
 internal class KFunctionExtensionsKtTest {
 
@@ -39,7 +40,7 @@ internal class KFunctionExtensionsKtTest {
     }
 
     @Test
-    fun `getValidArguments should ignore GraphQLContext`() {
+    fun `getValidArguments should ignore GraphQLContext annotations and classes`() {
         val args = TestingClass::context.getValidArguments()
         assertEquals(expected = 1, actual = args.size)
         assertEquals(expected = "notContext", actual = args.first().getName())
@@ -57,7 +58,7 @@ internal class KFunctionExtensionsKtTest {
 
         fun ignored(@GraphQLIgnore ignoredArg: String, notIgnored: String) = "$ignoredArg and $notIgnored"
 
-        fun context(contextArg: GraphQLContext, notContext: String) = "$contextArg and $notContext"
+        fun context(@GraphQLContextAnnotation contextAnnation: String, contextClass: GraphQLContext, notContext: String) = "Value was $notContext"
 
         fun dataFetchingEnvironment(environment: DataFetchingEnvironment, notEnvironment: String): String = "${environment.field.name} and $notEnvironment"
     }

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) : WebFilter, Ordered {
+open class ContextWebFilter(config: GraphQLConfigurationProperties, private val contextFactory: GraphQLContextFactory<Any>) : 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

@@ -29,18 +29,18 @@ const val GRAPHQL_CONTEXT_KEY = "graphQLContext"
 /**
  * Factory that generates GraphQL context.
  */
-interface GraphQLContextFactory {
+interface GraphQLContextFactory<out T : Any> {
 
     /**
      * Generate GraphQL context based on the incoming request and the corresponding response.
      */
-    suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): GraphQLContext
+    suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): T
 }
 
 /**
  * Default context factory that generates empty GraphQL context.
  */
-internal object EmptyContextFactory : GraphQLContextFactory {
+internal object EmptyContextFactory : GraphQLContextFactory<GraphQLContext> {
 
     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 = mockk()
+        fun myCustomContextFactory(): GraphQLContextFactory<Map<String, Any>> = 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

@@ -54,7 +54,7 @@ class ContextWebFilterTest {
             }
         }
 
-        val simpleFactory: GraphQLContextFactory = mockk {
+        val simpleFactory: GraphQLContextFactory<Any> = mockk {
             coEvery { generateContext(any(), any()) } returns EmptyGraphQLContext()
         }
 
@@ -90,7 +90,7 @@ class ContextWebFilterTest {
             }
         }
 
-        val simpleFactory: GraphQLContextFactory = mockk {
+        val simpleFactory: GraphQLContextFactory<Any> = mockk {
             coEvery { generateContext(any(), any()) } returns EmptyGraphQLContext()
         }
 

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 = object : GraphQLContextFactory {
+        fun customContextFactory(): GraphQLContextFactory<CustomContext> = object : GraphQLContextFactory<CustomContext> {
             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 = object : GraphQLContextFactory {
+        fun customContextFactory(): GraphQLContextFactory<SubscriptionContext> = object : GraphQLContextFactory<SubscriptionContext> {
             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 = object : GraphQLContextFactory {
+        fun customContextFactory(): GraphQLContextFactory<CustomContext> = object : GraphQLContextFactory<CustomContext> {
             override suspend fun generateContext(request: ServerHttpRequest, response: ServerHttpResponse): CustomContext = CustomContext(
                 value = request.headers.getFirst("X-Custom-Header") ?: "default"
             )