com.expediagroup.graphql.client.ktor.GraphQLKtorClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphql-kotlin-ktor-client Show documentation
Show all versions of graphql-kotlin-ktor-client Show documentation
A lightweight typesafe GraphQL HTTP Client based on Ktor HttpClient
/*
* 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.graphql.client.ktor
import com.expediagroup.graphql.client.GraphQLClient
import com.expediagroup.graphql.client.extensions.getQueryId
import com.expediagroup.graphql.client.extensions.toExtensionsBodyMap
import com.expediagroup.graphql.client.extensions.toQueryParamString
import com.expediagroup.graphql.client.serializer.GraphQLClientSerializer
import com.expediagroup.graphql.client.serializer.defaultGraphQLSerializer
import com.expediagroup.graphql.client.types.AutomaticPersistedQueriesExtension
import com.expediagroup.graphql.client.types.AutomaticPersistedQueriesSettings
import com.expediagroup.graphql.client.types.GraphQLClientRequest
import com.expediagroup.graphql.client.types.GraphQLClientResponse
import io.ktor.client.HttpClient
import io.ktor.client.call.body
import io.ktor.client.engine.cio.CIO
import io.ktor.client.plugins.expectSuccess
import io.ktor.client.request.HttpRequestBuilder
import io.ktor.client.request.accept
import io.ktor.client.request.get
import io.ktor.client.request.header
import io.ktor.client.request.post
import io.ktor.client.request.setBody
import io.ktor.http.ContentType
import io.ktor.http.HttpHeaders
import io.ktor.http.content.TextContent
import java.io.Closeable
import java.net.URL
/**
* A lightweight typesafe GraphQL HTTP client using Ktor HTTP client engine.
*/
open class GraphQLKtorClient(
private val url: URL,
private val httpClient: HttpClient = HttpClient(engineFactory = CIO),
private val serializer: GraphQLClientSerializer = defaultGraphQLSerializer(),
override val automaticPersistedQueriesSettings: AutomaticPersistedQueriesSettings = AutomaticPersistedQueriesSettings()
) : GraphQLClient, Closeable {
override suspend fun execute(request: GraphQLClientRequest, requestCustomizer: HttpRequestBuilder.() -> Unit): GraphQLClientResponse {
return if (automaticPersistedQueriesSettings.enabled) {
val queryId = request.getQueryId()
val automaticPersistedQueriesExtension = AutomaticPersistedQueriesExtension(
version = AutomaticPersistedQueriesSettings.VERSION,
sha256Hash = queryId
)
val extensions = request.extensions?.let {
automaticPersistedQueriesExtension.toExtensionsBodyMap().plus(it)
} ?: automaticPersistedQueriesExtension.toExtensionsBodyMap()
val apqRawResultWithoutQuery: String = when (automaticPersistedQueriesSettings.httpMethod) {
is AutomaticPersistedQueriesSettings.HttpMethod.GET -> {
httpClient
.get(url) {
expectSuccess = true
header(HttpHeaders.ContentType, ContentType.Application.FormUrlEncoded)
accept(ContentType.Application.Json)
url {
parameters.append("extension", automaticPersistedQueriesExtension.toQueryParamString())
}
}.body()
}
is AutomaticPersistedQueriesSettings.HttpMethod.POST -> {
val requestWithoutQuery = object : GraphQLClientRequest by request {
override val query = null
override val extensions = extensions
}
httpClient
.post(url) {
expectSuccess = true
apply(requestCustomizer)
accept(ContentType.Application.Json)
setBody(TextContent(serializer.serialize(requestWithoutQuery), ContentType.Application.Json))
}.body()
}
}
serializer.deserialize(apqRawResultWithoutQuery, request.responseType()).let {
if (it.errors.isNullOrEmpty() && it.data != null) return it
}
val apqRawResultWithQuery: String = when (automaticPersistedQueriesSettings.httpMethod) {
is AutomaticPersistedQueriesSettings.HttpMethod.GET -> {
httpClient
.get(url) {
expectSuccess = true
header(HttpHeaders.ContentType, ContentType.Application.FormUrlEncoded)
accept(ContentType.Application.Json)
url {
parameters.append("query", serializer.serialize(request))
parameters.append("extension", automaticPersistedQueriesExtension.toQueryParamString())
}
}.body()
}
is AutomaticPersistedQueriesSettings.HttpMethod.POST -> {
val requestWithQuery = object : GraphQLClientRequest by request {
override val extensions = extensions
}
httpClient
.post(url) {
expectSuccess = true
apply(requestCustomizer)
accept(ContentType.Application.Json)
setBody(TextContent(serializer.serialize(requestWithQuery), ContentType.Application.Json))
}.body()
}
}
serializer.deserialize(apqRawResultWithQuery, request.responseType())
} else {
val rawResult: String = httpClient.post(url) {
expectSuccess = true
apply(requestCustomizer)
setBody(TextContent(serializer.serialize(request), ContentType.Application.Json))
}.body()
serializer.deserialize(rawResult, request.responseType())
}
}
override suspend fun execute(requests: List>, requestCustomizer: HttpRequestBuilder.() -> Unit): List> {
val rawResult: String = httpClient.post(url) {
expectSuccess = true
apply(requestCustomizer)
setBody(TextContent(serializer.serialize(requests), ContentType.Application.Json))
}.body()
return serializer.deserialize(rawResult, requests.map { it.responseType() })
}
override fun close() {
httpClient.close()
}
}