Not able to store UUID type in mongo out of the Box

[anandsahilct]

I am trying to store UUID in Mongo as JUUID but somehow in the mongo4cats library, I am not able to do this by default and it always ends up as a string. I am already specifying the codec from the mong driver in the client when initializing the Mongo client.

Is this something that is supported out of the box I am not able to do this.
Can someone please help and guide me to a sample code or documentation for achieving my use case?

[Kirill5k]

Could you provide an example of your data model that you are trying to achieve it with?

[ivche]

Hello, we are using the mongo-circe derivation which always resolves a UUID as String

case class Dummy(_id: UUID, iter: List[String])
object Dummy {
 implicit val mongo: MongoCodecProvider[Dummy] = deriveCirceCodecProvider[Dummy]
}

which at the end resolves into e.g
_id: b2603a74-2c64-4fea-a5a7-3b56a24bbb44 String
whereas we need an _id to be of type UUID("b2603a74-2c64-4fea-a5a7-3b56a24bbb44") mongo docs .
We also set the codec registry in MongoClientSettings.uuidRepresentation(UuidRepresentation.STANDARD)
I was wondering if we are doing something wrong here

[Kirill5k]

I see. By default circe will serialise UUIDs as strings, therefore the result that you are getting kind of makes sense.

I made an attempt at implementing serialisation logic that will handle UUIDs properly as these need to be actually treated as binary data. You can take a peek at my commit here

I still need to do a bit of cleaning and testing of it, but hopefully I'll be able to release it tomorrow.

[ivche]

thank you very much for the quick response! ☀️

[anandsahilct]

Thank you @Kirill5k for the quick response and the solution this will help us integrate faster save us from lots of custom derivations 🙏

[Kirill5k]

I have finished testing and refactoring UUID serialisation logic and made a fresh release. If you pull version 0.6.13, then everything should work.

You can refer to this unit test as an example

[CodeCombiner]

Hi, same here when add custom field with UUID and then try to find by field and UUID value:
.find(Filter.eq("sessionId", UUID.fromString("29ca24a5-8e95-4fc1-bec0-7c0d08de5196")))

org.bson.codecs.configuration.CodecConfigurationException: The uuidRepresentation has not been specified, so the UUID cannot be encoded. at org.bson.codecs.UuidCodec.encode(UuidCodec.java:72) at org.bson.codecs.UuidCodec.encode(UuidCodec.java:37) at com.mongodb.client.model.BuildersHelper.encodeValue(BuildersHelper.java:37) at com.mongodb.client.model.Filters$SimpleEncodingFilter.toBsonDocument(Filters.java:1210) at com.mongodb.internal.operation.Operations.createFindOperation(Operations.java:190) at com.mongodb.internal.operation.Operations.find(Operations.java:178) at com.mongodb.internal.operation.AsyncOperations.find(AsyncOperations.java:124) at com.mongodb.reactivestreams.client.internal.FindPublisherImpl.asAsyncReadOperation(FindPublisherImpl.java:222) at com.mongodb.reactivestreams.client.internal.FindPublisherImpl.asAsyncReadOperation(FindPublisherImpl.java:38) at com.mongodb.reactivestreams.client.internal.BatchCursorPublisher.lambda$batchCursor$3(BatchCursorPublisher.java:129) at com.mongodb.reactivestreams.client.internal.MongoOperationPublisher.createReadOperationMono(MongoOperationPublisher.java:441) at com.mongodb.reactivestreams.client.internal.MongoOperationPublisher.createReadOperationMono(MongoOperationPublisher.java:434) at com.mongodb.reactivestreams.client.internal.BatchCursorPublisher.batchCursor(BatchCursorPublisher.java:133) at com.mongodb.reactivestreams.client.internal.BatchCursorPublisher.batchCursor(BatchCursorPublisher.java:129) at com.mongodb.reactivestreams.client.internal.BatchCursorFlux.lambda$subscribe$1(BatchCursorFlux.java:53) at reactor.core.publisher.FluxCreate$BaseSink.onRequest(FluxCreate.java:557) at reactor.core.publisher.FluxCreate$SerializedFluxSink.onRequest(FluxCreate.java:271) at com.mongodb.reactivestreams.client.internal.BatchCursorFlux.lambda$subscribe$2(BatchCursorFlux.java:47) at reactor.core.publisher.FluxCreate.subscribe(FluxCreate.java:95) at reactor.core.publisher.Flux.subscribe(Flux.java:8660) at com.mongodb.reactivestreams.client.internal.BatchCursorFlux.subscribe(BatchCursorFlux.java:73) at com.mongodb.reactivestreams.client.internal.BatchCursorPublisher.subscribe(BatchCursorPublisher.java:125) at mongo4cats.zio.syntax$PublisherSyntax$.asyncIterableF$extension$$anonfun$1$$anonfun$1(syntax.scala:64) at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15) at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10) at zio.ZIOCompanionVersionSpecific.async$$anonfun$1(ZIOCompanionVersionSpecific.scala:24) at zio.internal.FiberRuntime.initiateAsync(FiberRuntime.scala:665) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:988) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:890) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:890) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:890) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:1029) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:967) at zio.internal.FiberRuntime.runLoop(FiberRuntime.scala:1029) at zio.internal.FiberRuntime.evaluateEffect(FiberRuntime.scala:381) at zio.internal.FiberRuntime.evaluateMessageWhileSuspended(FiberRuntime.scala:504) at zio.internal.FiberRuntime.drainQueueOnCurrentThread(FiberRuntime.scala:220) at zio.internal.FiberRuntime.run(FiberRuntime.scala:139) at zio.internal.ZScheduler$$anon$4.run(ZScheduler.scala:478)

[Kirill5k]

Looks like this is a bug specific to ZMongoClient. I'll release a fix for this later tonight

[Kirill5k]

I did a release. The error should disappear in version 0.7.2

[CodeCombiner]

Many thanks for so fast feedback Kirill