Skip to content

[Bugfix] Adjust $ref handling logic in DefaultJsonSchemaFactory #613

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.

Sign up for GitHub

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

Open
mSobhy90 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Bugfix] Adjust $ref handling logic in DefaultJsonSchemaFactory #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions sdk-serde-kotlinx/src/main/kotlin/dev/restate/serde/kotlinx/DefaultJsonSchemaFactory.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import io.github.smiley4.schemakenerator.jsonschema.jsonDsl.array
import io.github.smiley4.schemakenerator.serialization.SerializationSteps.analyzeTypeUsingKotlinxSerialization
import io.github.smiley4.schemakenerator.serialization.SerializationSteps.initial
import io.github.smiley4.schemakenerator.serialization.SerializationSteps.renameMembers
import kotlin.collections.set
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.KSerializer
import kotlinx.serialization.json.Json
Expand Down Expand Up @@ -67,7 +66,7 @@ object DefaultJsonSchemaFactory : KotlinSerializationSerdeFactory.JsonSchemaFact
// Add $schema
rootNode.properties.put(
"\$schema",
JsonTextValue("https://json-schema.org/draft/2020-12/schema"),
JsonTextValue("https://json-schema.org/draft/2020-12/schema"),
)
// Add $defs
val definitions =
Expand Down Expand Up @@ -109,7 +108,7 @@ object DefaultJsonSchemaFactory : KotlinSerializationSerdeFactory.JsonSchemaFact
(schema.json as JsonObject).properties["title"] == null
) {
(schema.json as JsonObject).properties["title"] =
JsonTextValue(TitleBuilder.BUILDER_SIMPLE(schema.typeData, this.typeDataById))
JsonTextValue(TitleBuilder.BUILDER_SIMPLE(schema.typeData, this.typeDataById))
}
}
}
Expand All @@ -126,8 +125,10 @@ object DefaultJsonSchemaFactory : KotlinSerializationSerdeFactory.JsonSchemaFact
private fun JsonObject.fixRefsPrefix(rootDefinition: String) {
this.properties.computeIfPresent("\$ref") { key, node ->
if (node is JsonTextValue) {
if (node.value.startsWith(rootDefinition)) {
JsonTextValue("#/" + node.value.removePrefix(rootDefinition))
if (node.value == rootDefinition) {
JsonTextValue("#/")
} else if (node.value.startsWith("$rootDefinition/")) {
JsonTextValue("#/" + node.value.removePrefix("$rootDefinition/"))
} else {
JsonTextValue("#/\$defs/" + node.value.removePrefix("#/definitions/"))
}
Expand Down
65 changes: 65 additions & 0 deletions sdk-serde-kotlinx/src/test/kotlin/dev/restate/serde/kotlinx/KotlinxSerdeTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,71 @@ class KotlinxSerdeTest {
)
}

@Serializable
enum class TaskStatus {
TODO,
IN_PROGRESS,
DONE,
}

@Serializable
enum class PriorityOrder {
HIGH,
MID,
LOW,
}

@Serializable
data class Task(val title: String, val status: TaskStatus, val priority: PriorityOrder)

@Test
fun schemaGenWithExternalEnum() {
testSchemaGen<Task>(
$$"""
{
"type": "object",
"required": [
"title",
"status",
"priority"
],
"properties": {
"title": {
"type": "string"
},
"priority": {
"$ref": "#/$defs/PriorityOrder"
},
"status": {
"$ref": "#/$defs/TaskStatus"
}
},
"title": "Task",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"TaskStatus": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"title": "TaskStatus"
},
"PriorityOrder": {
"enum": [
"HIGH",
"MID",
"LOW"
],
"title": "PriorityOrder"
}
}
}
"""
.trimIndent()
)
}

inline fun <reified T : Any?> testSchemaGen(expectedSchema: String) {
val expectedJsonElement = Json.decodeFromString<JsonElement>(expectedSchema)
val actualSchema =
Expand Down
Loading