feat: GraalVM native image support for Spring server #1769
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import com.expediagroup.graphql.plugin.gradle.graphql | ||
| import org.jetbrains.kotlin.gradle.tasks.KotlinCompile | ||
|
|
||
| @Suppress("DSL_SCOPE_VIOLATION") // TODO: remove once KTIJ-19369 / Gradle#22797 is fixed | ||
| plugins { | ||
| alias(libs.plugins.kotlin.jvm) | ||
| application | ||
| alias(libs.plugins.graalvm.native) | ||
| alias(libs.plugins.kotlin.spring) | ||
| alias(libs.plugins.spring.boot) | ||
| id("com.expediagroup.graphql") | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation("com.expediagroup", "graphql-kotlin-spring-server") | ||
| implementation(projects.commonGraalvmServer) | ||
| testImplementation(libs.junit.api) | ||
| testImplementation(libs.kotlin.test) | ||
| testImplementation(libs.spring.boot.test) | ||
| } | ||
|
|
||
| tasks.test { | ||
| useJUnitPlatform() | ||
| } | ||
|
|
||
| tasks.withType<KotlinCompile> { | ||
| kotlinOptions.jvmTarget = "17" | ||
| } | ||
|
|
||
| graalvmNative { | ||
| toolchainDetection.set(false) | ||
| binaries { | ||
| named("main") { | ||
| verbose.set(true) | ||
| } | ||
| metadataRepository { | ||
| enabled.set(true) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| graphql { | ||
| graalVm { | ||
| packages = listOf("com.expediagroup.graalvm") | ||
| mainClassName = "com.expediagroup.graalvm.spring.ApplicationKt" | ||
| } | ||
| } | ||
|
|
||
| tasks.register("buildGraalVmNativeImage") { | ||
| dependsOn("build") | ||
| dependsOn("nativeCompile") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Copyright 2023 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.graalvm.spring | ||
|
|
||
| import com.expediagroup.graalvm.hooks.CustomHooks | ||
| import com.expediagroup.graalvm.schema.ArgumentQuery | ||
| import com.expediagroup.graalvm.schema.AsyncQuery | ||
| import com.expediagroup.graalvm.schema.BasicMutation | ||
| import com.expediagroup.graalvm.schema.ContextualQuery | ||
| import com.expediagroup.graalvm.schema.CustomScalarQuery | ||
| import com.expediagroup.graalvm.schema.EnumQuery | ||
| import com.expediagroup.graalvm.schema.ErrorQuery | ||
| import com.expediagroup.graalvm.schema.IdQuery | ||
| import com.expediagroup.graalvm.schema.InnerClassQuery | ||
| import com.expediagroup.graalvm.schema.ListQuery | ||
| import com.expediagroup.graalvm.schema.PolymorphicQuery | ||
| import com.expediagroup.graalvm.schema.ScalarQuery | ||
| import com.expediagroup.graalvm.schema.TypesQuery | ||
| import com.expediagroup.graalvm.schema.dataloader.ExampleDataLoader | ||
| import com.expediagroup.graalvm.schema.model.ExampleInterface | ||
| import com.expediagroup.graalvm.schema.model.ExampleUnion | ||
| import com.expediagroup.graalvm.schema.model.FirstImpl | ||
| import com.expediagroup.graalvm.schema.model.FirstUnionMember | ||
| import com.expediagroup.graalvm.schema.model.SecondImpl | ||
| import com.expediagroup.graalvm.schema.model.SecondUnionMember | ||
| import com.expediagroup.graphql.dataloader.KotlinDataLoaderRegistryFactory | ||
| import com.expediagroup.graphql.generator.GraphQLTypeResolver | ||
| import com.expediagroup.graphql.generator.SimpleTypeResolver | ||
| import org.springframework.boot.autoconfigure.SpringBootApplication | ||
| import org.springframework.boot.runApplication | ||
| import org.springframework.context.annotation.Bean | ||
|
|
||
| @SpringBootApplication | ||
| class Application { | ||
|
|
||
| @Bean | ||
| fun hooks(): CustomHooks = CustomHooks() | ||
|
|
||
| @Bean | ||
| fun dataLoaderRegistryFactory(): KotlinDataLoaderRegistryFactory = KotlinDataLoaderRegistryFactory( | ||
| ExampleDataLoader | ||
| ) | ||
|
|
||
| @Bean | ||
| fun typeResolver(): GraphQLTypeResolver = SimpleTypeResolver( | ||
| mapOf( | ||
| ExampleInterface::class to listOf(FirstImpl::class, SecondImpl::class), | ||
| ExampleUnion::class to listOf(FirstUnionMember::class, SecondUnionMember::class) | ||
| ) | ||
| ) | ||
|
|
||
| // queries | ||
| @Bean | ||
| fun argumentQuery() = ArgumentQuery() | ||
|
|
||
| @Bean | ||
| fun asyncQuery() = AsyncQuery() | ||
|
|
||
| @Bean | ||
| fun contextualQuery() = ContextualQuery() | ||
|
|
||
| @Bean | ||
| fun customScalarQuery() = CustomScalarQuery() | ||
|
|
||
| @Bean | ||
| fun enumQuery() = EnumQuery() | ||
|
|
||
| @Bean | ||
| fun errorQuery() = ErrorQuery() | ||
|
|
||
| @Bean | ||
| fun idQuery() = IdQuery() | ||
|
|
||
| @Bean | ||
| fun innerClassQuery() = InnerClassQuery() | ||
|
|
||
| @Bean | ||
| fun listQuery() = ListQuery() | ||
|
|
||
| @Bean | ||
| fun polymorphicQuery() = PolymorphicQuery() | ||
|
|
||
| @Bean | ||
| fun scalarQuery() = ScalarQuery() | ||
|
|
||
| @Bean | ||
| fun typesQuery() = TypesQuery() | ||
|
|
||
| // mutations | ||
| @Bean | ||
| fun basicMutation() = BasicMutation() | ||
| } | ||
|
|
||
| fun main(args: Array<String>) { | ||
| runApplication<Application>(*args) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Copyright 2023 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.graalvm.spring.context | ||
|
|
||
| import com.expediagroup.graphql.generator.extensions.plus | ||
| import com.expediagroup.graphql.server.spring.execution.DefaultSpringGraphQLContextFactory | ||
| import graphql.GraphQLContext | ||
| import org.springframework.stereotype.Component | ||
| import org.springframework.web.reactive.function.server.ServerRequest | ||
| import java.util.UUID | ||
|
|
||
| @Component | ||
| class CustomContextFactory : DefaultSpringGraphQLContextFactory() { | ||
| override suspend fun generateContext(request: ServerRequest): GraphQLContext { | ||
| return super.generateContext(request).plus(mapOf("custom" to (request.headers().firstHeader("X-Custom-Header") ?: UUID.randomUUID().toString()))) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| graphql: | ||
| packages: | ||
| - "com.expediagroup.graalvm" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * Copyright 2023 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.graalvm.spring.schema | ||
|
|
||
| import com.expediagroup.graalvm.schema.model.InputOnly | ||
| import com.expediagroup.graphql.server.types.GraphQLRequest | ||
| import org.junit.jupiter.api.Test | ||
| import org.junit.jupiter.api.TestInstance | ||
| import org.springframework.beans.factory.annotation.Autowired | ||
| import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient | ||
| import org.springframework.boot.test.context.SpringBootTest | ||
| import org.springframework.http.MediaType | ||
| import org.springframework.test.web.reactive.server.WebTestClient | ||
|
|
||
| @SpringBootTest | ||
| @AutoConfigureWebTestClient | ||
| @TestInstance(TestInstance.Lifecycle.PER_CLASS) | ||
| class TypesQueryTest(@Autowired private val testClient: WebTestClient) { | ||
|
|
||
| @Test | ||
| fun `verify input only query`() { | ||
| val request = GraphQLRequest( | ||
| query = "query InputOnlyQuery(\$inputArg: InputOnlyInput){ inputTypeQuery(arg: \$inputArg) }", | ||
| operationName = "InputOnlyQuery", | ||
| variables = mapOf("inputArg" to InputOnly(id = 123)) | ||
| ) | ||
|
|
||
| testClient.post() | ||
| .uri("/graphql") | ||
| .accept(MediaType.APPLICATION_JSON) | ||
| .contentType(MediaType.APPLICATION_JSON) | ||
| .bodyValue(request) | ||
| .exchange() | ||
| .expectStatus().isOk | ||
| .expectBody() | ||
| .jsonPath("$.data.inputTypeQuery").exists() | ||
| .jsonPath("$.data.inputTypeQuery").isEqualTo("InputOnly(id=123)") | ||
| .jsonPath("$.errors").doesNotExist() | ||
| .jsonPath("$.extensions").doesNotExist() | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GraalVM native plugin dynamically generates some "helper" methods so we need to ensure they are generated just once for whole composite project, otherwise build blows up with classpath issues.