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

Rework Update JSON encoders and decoders #3261

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Rework Update JSON encoders and decoders #3261

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f362631
Rework `Update` JSON encoders and decoders
fthomas Jan 15, 2025
1aa0972
Use Decoder/Encoder forProduct to define instances
fthomas Jan 15, 2025
61e4780
Scala 3 needs more type annotations
fthomas Jan 15, 2025
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
136 changes: 94 additions & 42 deletions modules/core/src/main/scala/org/scalasteward/core/data/Update.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package org.scalasteward.core.data

import cats.Order
import cats.implicits.*
import io.circe.generic.semiauto.*
import io.circe.syntax.*
import io.circe.{Decoder, Encoder, HCursor, Json}
import org.scalasteward.core.repoconfig.PullRequestGroup
Expand Down Expand Up @@ -198,30 +197,57 @@ object Update {
}
}

// TODO: Derive all instances of `Encoder`/`Decoder` here using `deriveCodec`
// Partially manually implemented so we don't fail reading old caches (those
// still using `Single`/`Group`)
implicit val SingleOrder: Order[Single] =
Order.by((u: Single) => (u.crossDependencies, u.newerVersions))

implicit val ForArtifactIdEncoder: Encoder[ForArtifactId] = {
val derived = deriveEncoder[ForArtifactId]
// Encoder and Decoder instances

derived.mapJson(json => Json.obj("ForArtifactId" -> json))
}
// ForArtifactId

implicit val ForArtifactIdDecoder: Decoder[ForArtifactId] = {
val derived = deriveDecoder[ForArtifactId]
derived
.prepare(_.downField("ForArtifactId"))
.or(derived.prepare(_.downField("Single")))
}

implicit val ForGroupIdEncoder: Encoder[ForGroupId] = {
val derived = deriveEncoder[ForGroupId]
private val forArtifactIdEncoder: Encoder[ForArtifactId] =
Encoder.instance[ForArtifactId] { forArtifactId =>
Json.obj(
"ForArtifactId" -> Json.obj(
"crossDependency" -> forArtifactId.crossDependency.asJson,
"newerVersions" -> forArtifactId.newerVersions.asJson,
"newerGroupId" -> forArtifactId.newerGroupId.asJson,
"newerArtifactId" -> forArtifactId.newerArtifactId.asJson
)
)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (non-blocking): You can also use Encoder/Decoder forProduct to reduce boilerplate from this file

This comment follows the conventionalcomments.org standard

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like this?


derived.mapJson(json => Json.obj("ForGroupId" -> json))
}
private val unwrappedForArtifactIdDecoder: Decoder[ForArtifactId] =
(c: HCursor) =>
for {
crossDependency <- c.downField("crossDependency").as[CrossDependency]
newerVersions <- c.downField("newerVersions").as[Nel[Version]]
newerGroupId <- c.downField("newerGroupId").as[Option[GroupId]]
newerArtifactId <- c.downField("newerArtifactId").as[Option[String]]
} yield ForArtifactId(crossDependency, newerVersions, newerGroupId, newerArtifactId)

private val forArtifactIdDecoderV1: Decoder[ForArtifactId] =
unwrappedForArtifactIdDecoder.prepare(_.downField("Single"))

private val forArtifactIdDecoderV2 =
unwrappedForArtifactIdDecoder.prepare(_.downField("ForArtifactId"))

private val forArtifactIdDecoder: Decoder[ForArtifactId] =
forArtifactIdDecoderV2.or(forArtifactIdDecoderV1)

// ForGroupId

private val forGroupIdEncoder: Encoder[ForGroupId] =
Encoder.instance[ForGroupId] { forGroupId =>
Json.obj(
"ForGroupId" -> Json.obj(
"forArtifactIds" -> Encoder
.encodeNonEmptyList(forArtifactIdEncoder)
.apply(forGroupId.forArtifactIds)
)
)
}

private val oldForGroupIdDecoder: Decoder[ForGroupId] =
private val unwrappedForGroupIdDecoderV1: Decoder[ForGroupId] =
(c: HCursor) =>
for {
crossDependencies <- c.downField("crossDependencies").as[Nel[CrossDependency]]
Expand All @@ -230,34 +256,60 @@ object Update {
.map(crossDependency => ForArtifactId(crossDependency, newerVersions))
} yield ForGroupId(forArtifactIds)

implicit val ForGroupIdDecoder: Decoder[ForGroupId] =
deriveDecoder[ForGroupId]
.prepare(_.downField("ForGroupId"))
.or(oldForGroupIdDecoder.prepare(_.downField("ForGroupId")))
.or(oldForGroupIdDecoder.prepare(_.downField("Group")))
private val unwrappedForGroupIdDecoderV3: Decoder[ForGroupId] =
(c: HCursor) =>
for {
forArtifactIds <- Decoder
.decodeNonEmptyList(forArtifactIdDecoder)
.tryDecode(c.downField("forArtifactIds"))
} yield ForGroupId(forArtifactIds)

implicit val GroupedEncoder: Encoder[Grouped] = {
val derived = deriveEncoder[Grouped]
private val forGroupIdDecoderV1: Decoder[ForGroupId] =
unwrappedForGroupIdDecoderV1.prepare(_.downField("Group"))

derived.mapJson(json => Json.obj("Grouped" -> json))
}
private val forGroupIdDecoderV2: Decoder[ForGroupId] =
unwrappedForGroupIdDecoderV1.prepare(_.downField("ForGroupId"))

implicit val GroupedDecoder: Decoder[Grouped] =
deriveDecoder[Grouped].prepare(_.downField("Grouped"))
private val forGroupIdDecoderV3: Decoder[ForGroupId] =
unwrappedForGroupIdDecoderV3.prepare(_.downField("ForGroupId"))

implicit val SingleOrder: Order[Single] =
Order.by((u: Single) => (u.crossDependencies, u.newerVersions))
private val forGroupIdDecoder: Decoder[ForGroupId] =
forGroupIdDecoderV3.or(forGroupIdDecoderV2).or(forGroupIdDecoderV1)

// Grouped

private val groupedEncoder: Encoder[Grouped] =
Encoder.instance[Grouped] { grouped =>
Json.obj(
"Grouped" -> Json.obj(
"name" -> grouped.name.asJson,
"title" -> grouped.title.asJson,
"updates" -> Encoder.encodeList(forArtifactIdEncoder).apply(grouped.updates)
)
)
}

private val groupedDecoder: Decoder[Grouped] =
(c: HCursor) => {
val c1 = c.downField("Grouped")
for {
name <- c1.downField("name").as[String]
title <- c1.downField("title").as[Option[String]]
updates <- Decoder.decodeList(forArtifactIdDecoder).tryDecode(c1.downField("updates"))
} yield Grouped(name, title, updates)
}

// Update

implicit val UpdateEncoder: Encoder[Update] = {
case update: Grouped => update.asJson
case update: ForArtifactId => update.asJson
case update: ForGroupId => update.asJson
implicit val updateEncoder: Encoder[Update] = {
case update: ForArtifactId => forArtifactIdEncoder.apply(update)
case update: ForGroupId => forGroupIdEncoder.apply(update)
case update: Grouped => groupedEncoder.apply(update)
}

implicit val UpdateDecoder: Decoder[Update] =
ForArtifactIdDecoder
implicit val updateDecoder: Decoder[Update] =
forArtifactIdDecoder
.widen[Update]
.or(ForGroupIdDecoder.widen[Update])
.or(Decoder[Grouped].widen[Update])

.or(forGroupIdDecoder.widen[Update])
.or(groupedDecoder.widen[Update])
}
Loading
Loading