Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: batchLoaderContext to access to dataFetchingEnvironment #1490

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Copyright 2022 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.dataloader.instrumentation.extensions

import graphql.GraphQLContext
import graphql.schema.DataFetchingEnvironment
import org.dataloader.BatchLoaderEnvironment
import org.dataloader.DataLoader

/**
* get the [DataFetchingEnvironment] from the [BatchLoaderEnvironment], in order to access to it,
* you need to pass your [DataFetchingEnvironment] to the [DataLoader.load] as second argument
* Example:
* ```
* dataloader.load(yourKey, dataFetchingEnvironment)
* ```
*/
fun BatchLoaderEnvironment.getDataFetchingEnvironment(): DataFetchingEnvironment? =
keyContextsList.firstOrNull() as? DataFetchingEnvironment

/**
* get the [GraphQLContext] from the [BatchLoaderEnvironment], in order to access to it,
* you need to pass your [DataFetchingEnvironment] to the [DataLoader.load] as second argument
* Example:
* ```
* dataloader.load(yourKey, dataFetchingEnvironment)
* ```
*/
fun BatchLoaderEnvironment.getGraphQLContext(): GraphQLContext? =
getDataFetchingEnvironment()?.graphQlContext
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2022 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.dataloader.instrumentation.extensions

import com.expediagroup.graphql.dataloader.KotlinDataLoaderRegistry
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* Copyright 2022 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.dataloader.instrumentation.extensions

import graphql.GraphQLContext
import graphql.schema.DataFetchingEnvironment
import io.mockk.every
import io.mockk.mockk
import io.mockk.spyk
import io.mockk.verify
import org.dataloader.DataLoaderFactory
import org.junit.jupiter.api.Test
import java.util.concurrent.CompletableFuture

class BatchLoaderEnvironmentExtensionsTest {
@Test
fun `BatchLoaderEnvironment should access to the DataFetchingEnvironment`() {
val stringMapperDataLoader = DataLoaderFactory.newDataLoader<String, String> { keys, batchLoaderEnvironment ->
CompletableFuture.completedFuture(
keys.map { key ->
batchLoaderEnvironment.getGraphQLContext()?.get<(String) -> String>("StringModifierLambda")?.invoke(key)
}
)
}

val stringModifierLambda = spyk(
{ string: String -> string.uppercase() }
)

val dataFetchingEnvironment = mockk<DataFetchingEnvironment> {
every { graphQlContext } returns GraphQLContext.newContext().put(
"StringModifierLambda",
stringModifierLambda
).build()
}

stringMapperDataLoader.load("hello", dataFetchingEnvironment)
stringMapperDataLoader.load("world", dataFetchingEnvironment)

stringMapperDataLoader.dispatch()

verify(exactly = 1) {
stringModifierLambda("hello")
stringModifierLambda("world")
}
}
}