-
Notifications
You must be signed in to change notification settings - Fork 354
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[client] support non JSON primitive scalars (#1488)
Update `kotlinx-serialization` handling of custom scalars to allow non-primitive values. While custom scalars are most often represented as some primitive value (e.g. UUID -> String), there are use cases when scalars need to be represented as objects. One common use case is Apollo Federation and its usage of `_Any` scalar to represent arbitrary entity object map that contains various fields to uniquely identity it. Updated custom scalar documentation with examples n how to use arbitrary objects as custom scalars. Resolves: * #1408 * #1435 * #1445
- Loading branch information
1 parent
a911ded
commit 186c46f
Showing
41 changed files
with
1,323 additions
and
434 deletions.
There are no files selected for viewing
This file contains 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
48 changes: 48 additions & 0 deletions
48
...ent-jackson/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/EntitiesQuery.kt
This file contains 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,48 @@ | ||
| /* | ||
| * 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.client.jackson.data | ||
|
|
||
| import com.expediagroup.graphql.client.jackson.data.entitiesquery._Entity | ||
| import com.expediagroup.graphql.client.jackson.data.scalars.AnyToAnyConverter | ||
| import com.expediagroup.graphql.client.types.GraphQLClientRequest | ||
| import com.fasterxml.jackson.databind.annotation.JsonDeserialize | ||
| import com.fasterxml.jackson.databind.annotation.JsonSerialize | ||
| import kotlin.reflect.KClass | ||
|
|
||
| class EntitiesQuery( | ||
| override val variables: Variables, | ||
| ) : GraphQLClientRequest<EntitiesQuery.Result> { | ||
| override val query: String = "ENTITIES_QUERY" | ||
|
|
||
| override val operationName: String = "EntitiesQuery" | ||
|
|
||
| override fun responseType(): KClass<Result> = Result::class | ||
|
|
||
| data class Variables( | ||
| @JsonSerialize(contentConverter = AnyToAnyConverter::class) | ||
| @JsonDeserialize(contentConverter = AnyToAnyConverter::class) | ||
| public val representations: List<Any>, | ||
| ) | ||
|
|
||
| data class Result( | ||
| /** | ||
| * Union of all types that use the @key directive, including both types native to the schema and | ||
| * extended types | ||
| */ | ||
| val _entities: List<_Entity?>, | ||
| ) | ||
| } |
This file contains 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
43 changes: 43 additions & 0 deletions
43
...son/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/entitiesquery/_Entity.kt
This file contains 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,43 @@ | ||
| /* | ||
| * 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.client.jackson.data.entitiesquery | ||
|
|
||
| import com.fasterxml.jackson.`annotation`.JsonSubTypes | ||
| import com.fasterxml.jackson.`annotation`.JsonTypeInfo | ||
| import kotlin.String | ||
|
|
||
| @JsonTypeInfo( | ||
| use = JsonTypeInfo.Id.NAME, | ||
| include = JsonTypeInfo.As.PROPERTY, | ||
| property = "__typename", | ||
| defaultImpl = Default_EntityImplementation::class, | ||
| ) | ||
| @JsonSubTypes( | ||
| value = [ | ||
| JsonSubTypes.Type(value = Product::class, name = "Product") | ||
| ] | ||
| ) | ||
| interface _Entity | ||
|
|
||
| data class Product( | ||
| public val name: String | ||
| ) : _Entity | ||
|
|
||
| /** | ||
| * Fallback _Entity implementation that will be used when unknown/unhandled type is encountered. | ||
| */ | ||
| class Default_EntityImplementation() : _Entity |
This file contains 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
40 changes: 40 additions & 0 deletions
40
...on/src/test/kotlin/com/expediagroup/graphql/client/jackson/data/scalars/UUIDConverters.kt
This file contains 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,40 @@ | ||
| /* | ||
| * 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.client.jackson.data.scalars | ||
|
|
||
| import com.expediagroup.graphql.client.converter.ScalarConverter | ||
| import com.fasterxml.jackson.databind.util.StdConverter | ||
| import java.util.UUID | ||
| import kotlin.Any | ||
|
|
||
| class AnyToUUIDConverter : StdConverter<Any, UUID>() { | ||
| private val converter: UUIDScalarConverter = UUIDScalarConverter() | ||
|
|
||
| override fun convert(`value`: Any): UUID = converter.toScalar(value) | ||
| } | ||
|
|
||
| class UUIDToAnyConverter : StdConverter<UUID, Any>() { | ||
| private val converter: UUIDScalarConverter = UUIDScalarConverter() | ||
|
|
||
| override fun convert(`value`: UUID): Any = converter.toJson(value) | ||
| } | ||
|
|
||
| // scalar converter would not be part of the generated sources | ||
| class UUIDScalarConverter : ScalarConverter<UUID> { | ||
| override fun toScalar(rawValue: Any): UUID = UUID.fromString(rawValue.toString()) | ||
| override fun toJson(value: UUID): String = value.toString() | ||
| } |
This file contains 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
57 changes: 57 additions & 0 deletions
57
...ation/src/test/kotlin/com/expediagroup/graphql/client/serialization/data/EntitiesQuery.kt
This file contains 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,57 @@ | ||
| /* | ||
| * 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.client.serialization.data | ||
|
|
||
| import com.expediagroup.graphql.client.Generated | ||
| import com.expediagroup.graphql.client.serialization.data.scalars.JsonObjectSerializer | ||
| import com.expediagroup.graphql.client.types.GraphQLClientRequest | ||
| import com.expediagroup.graphql.client.serialization.data.entitiesquery._Entity | ||
| import kotlin.String | ||
| import kotlin.collections.List | ||
| import kotlin.reflect.KClass | ||
| import kotlinx.serialization.Required | ||
| import kotlinx.serialization.Serializable | ||
| import kotlinx.serialization.json.JsonObject | ||
|
|
||
| @Serializable | ||
| class EntitiesQuery( | ||
| override val variables: Variables, | ||
| ) : GraphQLClientRequest<EntitiesQuery.Result> { | ||
| @Required | ||
| override val query: String = "ENTITIES_QUERY" | ||
|
|
||
| @Required | ||
| override val operationName: String = "EntitiesQuery" | ||
|
|
||
| override fun responseType(): KClass<Result> = Result::class | ||
|
|
||
| @Generated | ||
| @Serializable | ||
| public data class Variables( | ||
| public val representations: List<@Serializable(with = JsonObjectSerializer::class) JsonObject>, | ||
| ) | ||
|
|
||
| @Generated | ||
| @Serializable | ||
| public data class Result( | ||
| /** | ||
| * Union of all types that use the @key directive, including both types native to the schema and | ||
| * extended types | ||
| */ | ||
| public val _entities: List<_Entity?>, | ||
| ) | ||
| } |
Oops, something went wrong.