Merge pull request #1976 from seglo/seglo/custom-schema-enum-discrimi…

…nator [BUG] oneOfUsingField fails for case object enums that inherit enumeratum EnumEntry reproducer
softwaremill · Mar 28, 2022 · 4354132 · 4354132
2 parents 2563701 + 1375714
commit 4354132
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/core/src/main/scala-2/sttp/tapir/generic/internal/OneOfMacro.scala b/core/src/main/scala-2/sttp/tapir/generic/internal/OneOfMacro.scala
@@ -57,7 +57,7 @@ object OneOfMacro {
             import _root_.sttp.tapir.SchemaType._
             import _root_.scala.collection.immutable.{List, Map}
             val mappingAsList = List(..$mapping)
-            val mappingAsMap = mappingAsList.toMap
+            val mappingAsMap: Map[$weakTypeV, Schema[_]] = mappingAsList.toMap
             val discriminator = SDiscriminator(
               _root_.sttp.tapir.FieldName($name, $conf.toEncodedName($name)),
               // cannot use .collect because of a bug in ScalaJS (Trying to access the this of another class ... during phase: jscode)

diff --git a/...ions/enumeratum/src/test/scala/sttp/tapir/codec/enumeratum/TapirCodecEnumeratumTest.scala b/...ions/enumeratum/src/test/scala/sttp/tapir/codec/enumeratum/TapirCodecEnumeratumTest.scala
@@ -1,5 +1,6 @@
 package sttp.tapir.codec.enumeratum
 
+import enumeratum.EnumEntry.Snakecase
 import enumeratum._
 import enumeratum.values._
 import org.scalatest.flatspec.AnyFlatSpec
@@ -8,6 +9,8 @@ import sttp.tapir.Codec.PlainCodec
 import sttp.tapir.Schema.SName
 import sttp.tapir.Schema.annotations.{default, description}
 import sttp.tapir.SchemaType.{SInteger, SString}
+import sttp.tapir.generic.Derived
+import sttp.tapir.generic.auto._
 import sttp.tapir.{DecodeResult, Schema, Validator}
 
 class TapirCodecEnumeratumTest extends AnyFlatSpec with Matchers {
@@ -100,9 +103,31 @@ class TapirCodecEnumeratumTest extends AnyFlatSpec with Matchers {
   }
 
   it should "find schema for enumeratum enum entries and enrich with metadata from default annotations" in {
-    implicitly[Schema[TestEnumEntryWithSomeEncodedDefault]].default shouldBe Some((TestEnumEntryWithSomeEncodedDefault.Value2, Some(TestEnumEntryWithSomeEncodedDefault.Value2)))
+    implicitly[Schema[TestEnumEntryWithSomeEncodedDefault]].default shouldBe Some(
+      (TestEnumEntryWithSomeEncodedDefault.Value2, Some(TestEnumEntryWithSomeEncodedDefault.Value2))
+    )
     implicitly[Schema[TestEnumEntryWithNoEncodedDefault]].default shouldBe Some((TestEnumEntryWithNoEncodedDefault.Value2, None))
   }
+
+  it should "create schema with custom discriminator based on enumeratum enum" in {
+    // given
+    sealed trait OfferType extends EnumEntry with Snakecase
+    object OfferType {
+      case object OfferOne extends OfferType
+    }
+
+    sealed trait CreateOfferRequest {
+      def `type`: OfferType
+    }
+
+    final case class CreateOfferOneRequest(`type`: OfferType) extends CreateOfferRequest
+
+    // then - should compile
+    val createOfferRequestSchema: Schema[CreateOfferRequest] = {
+      val one = implicitly[Derived[Schema[CreateOfferOneRequest]]].value
+      Schema.oneOfUsingField[CreateOfferRequest, OfferType](_.`type`, _.entryName)(OfferType.OfferOne -> one)
+    }
+  }
 }
 
 object TapirCodecEnumeratumTest {