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.

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

refactor(bower): Port the deserialization code from Jackson to KxS #8911

Merged
merged 1 commit into from
Jul 19, 2024
Merged

refactor(bower): Port the deserialization code from Jackson to KxS #8911

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
8 changes: 5 additions & 3 deletions plugins/package-managers/bower/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
plugins {
// Apply precompiled plugins.
id("ort-library-conventions")

// Apply third-party plugins.
alias(libs.plugins.kotlinSerialization)
}

dependencies {
Expand All @@ -37,9 +40,8 @@ dependencies {
implementation(projects.utils.ortUtils)
implementation(projects.utils.spdxUtils)

implementation(libs.jackson.core)
implementation(libs.jackson.databind)
implementation(libs.jackson.module.kotlin)
implementation(libs.kotlinx.serialization.core)
implementation(libs.kotlinx.serialization.json)

funTestImplementation(testFixtures(projects.analyzer))
}
60 changes: 31 additions & 29 deletions plugins/package-managers/bower/src/main/kotlin/Model.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,19 @@

package org.ossreviewtoolkit.plugins.packagemanagers.bower

import com.fasterxml.jackson.annotation.JsonIgnoreProperties
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.core.JsonParser
import com.fasterxml.jackson.databind.DeserializationContext
import com.fasterxml.jackson.databind.JsonNode
import com.fasterxml.jackson.databind.PropertyNamingStrategies
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.fasterxml.jackson.databind.deser.std.StdDeserializer
import com.fasterxml.jackson.module.kotlin.readValue
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.builtins.ListSerializer
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonArray
import kotlinx.serialization.json.JsonElement
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.JsonTransformingSerializer
import kotlinx.serialization.json.jsonArray

import org.ossreviewtoolkit.model.jsonMapper
import org.ossreviewtoolkit.plugins.packagemanagers.bower.PackageMeta.Author
import org.ossreviewtoolkit.utils.common.textValueOrEmpty

@JsonIgnoreProperties(ignoreUnknown = true)
@Serializable
internal data class PackageInfo(
val pkgMeta: PackageMeta,
val dependencies: Map<String, PackageInfo> = emptyMap()
Expand All @@ -42,57 +40,61 @@ internal data class PackageInfo(
/**
* See https://github.com/bower/spec/blob/master/json.md.
*/
@JsonIgnoreProperties(ignoreUnknown = true)
@Serializable
internal data class PackageMeta(
val name: String? = null,
@Serializable(with = AuthorListSerializer::class)
val authors: List<Author> = emptyList(),
val description: String? = null,
val license: String? = null,
val homepage: String? = null,
val dependencies: Map<String, String> = emptyMap(),
val devDependencies: Map<String, String> = emptyMap(),
val version: String? = null,
@JsonProperty("_resolution")
@SerialName("_resolution")
val resolution: Resolution? = null,
val repository: Repository? = null,
@JsonProperty("_source")
val source: String?
@SerialName("_source")
val source: String? = null
) {
@JsonIgnoreProperties(ignoreUnknown = true)
@Serializable
data class Resolution(
val type: String? = null,
val tag: String? = null,
val commit: String? = null
)

@JsonDeserialize(using = AuthorDeserializer::class)
@Serializable
data class Author(
val name: String,
val email: String? = null
)

@JsonIgnoreProperties(ignoreUnknown = true)
@Serializable
data class Repository(
val type: String,
val url: String
)
}

private val MAPPER = jsonMapper.copy().setPropertyNamingStrategy(PropertyNamingStrategies.LOWER_CAMEL_CASE)
private val JSON = Json { ignoreUnknownKeys = true }

internal fun parsePackageInfoJson(json: String): PackageInfo = MAPPER.readValue<PackageInfo>(json)
internal fun parsePackageInfoJson(json: String): PackageInfo = JSON.decodeFromString<PackageInfo>(json)

/**
* Parse information about the author. According to https://github.com/bower/spec/blob/master/json.md#authors,
* there are two formats to specify the authors of a package (similar to NPM). The difference is that the
* strings or objects are inside an array.
*
* Note: As of Kotlin 2.0.20 it will be supported to associate the serializer with a class annotation. So, the
* serializer then can be simplified into a single item deserializer. See also
* https://github.com/Kotlin/kotlinx.serialization/issues/1169#issuecomment-2083213759.
*/
private class AuthorDeserializer : StdDeserializer<Author>(Author::class.java) {
override fun deserialize(p: JsonParser, ctxt: DeserializationContext): Author {
val node = p.codec.readTree<JsonNode>(p)
return when {
node.isTextual -> Author(node.textValue())
else -> Author(node["name"].textValueOrEmpty(), node["email"]?.textValue())
}
}
private object AuthorListSerializer : JsonTransformingSerializer<List<Author>>(ListSerializer(Author.serializer())) {
override fun transformDeserialize(element: JsonElement): JsonElement =
JsonArray(
element.jsonArray.map { item ->
item.takeIf { it is JsonObject } ?: JsonObject(mapOf("name" to item))
}
)
}
Loading