Exception serializing Enumeration field to BSON

Question

I am using PlayFramework 2.6 with SCALA and mongodb-driver.

Struggling with Eumeration serialization on write.

When I try to insert object containing enum fields I get exception:

Caused by: org.bson.codecs.configuration.CodecConfigurationException: Can't find a codec for class scala.Enumeration$Val.
at org.bson.codecs.configuration.CodecCache.getOrThrow(CodecCache.java:46)
at org.bson.codecs.configuration.ProvidersCodecRegistry.get(ProvidersCodecRegistry.java:63)
at org.bson.codecs.configuration.ProvidersCodecRegistry.get(ProvidersCodecRegistry.java:37)
at org.mongodb.scala.bson.codecs.macrocodecs.MacroCodec.writeValue(MacroCodec.scala:167)
at org.mongodb.scala.bson.codecs.macrocodecs.MacroCodec.writeValue$(MacroCodec.scala:162)

I created codecs for object itself, also tried to create codec for enumeration class type, but looks like it correct way.

  val routeTypeCodec: CodecProvider = Macros.createCodecProvider[RouteTypeClass]
  val routeCodec: CodecProvider = Macros.createCodecProviderIgnoreNone[Route]

enumeration:

class RouteTypeClass extends TypeReference[RouteType.type]

object RouteType extends Enumeration {
  type RouteType = Value
  val Repeat, OneTime = Value
}

object for save:

case class Route(
 ...
 routeType: RouteType
 ...
);

How to write codec for enum fields, except defining this fields as a String.

Answer 1

Drop the use of enums. Instead, use sealed trait and case classes. Not too elegant solution, but works.

sealed trait RouteType {
  def routeType: String
}

case class Repeat() extends RouteType {
  override val routeType: String = "Repeat"
}
case class OneTime() extends RouteType {
  override val routeType: String = "OneTime"
}

objet RouteType {
  def parseFromString(value: String): Option[RouteType] = {
    Vector(Repeat(), OneTime().find(_.routeType == value)
  }
}

and write a custom BSON codec for these

import org.bson.{BsonReader, BsonWriter}
import org.bson.codecs.{Codec, DecoderContext, EncoderContext}

class RouteTypeCodec extends Codec[RouteType] {
  override def encode(
    writer: BsonWriter,
    value: RouteType,
    encoderContext: EncoderContext
  ): Unit = writer.writeString(value.routeType)
  override def getEncoderClass: Class[RouteType] = classOf[RouteType]
  override def decode(reader: BsonReader,
                        decoderContext: DecoderContext): RouteType= {
    val value = reader.readString()
    val result = RouteType.parseFromString(value)
    if (result.isDefined) result.get else throw new IllegalArgumentException("No such RouteType")
  }
}