cbartosiak / bson-codecs-jsr310 Goto Github PK

Codecs should be configurable to allow for conversions to and from different BSON types:

• Duration → String, Object, Decimal128;
• Instant → String, Object, Date;
• LocalDate → String, Object, Date;
• LocalDateTime → String, Object, Date;
• LocalTime → String, Object, Date, 64-bit integer (a number of nanoseconds since midnight);
• MonthDay → String, Object, Decimal128;
• OffsetDateTime → String, Object;
• OffsetTime → String, Object;
• Period → String, Object;
• YearMonth → String, Object, Decimal128;
• ZoneOffset → String, 32-bit integer;
• ZonedDateTime → String, Object;

This will allow for supporting different use cases dependent on a given context, e.g. one would like to sacrifice sortability in exchange for queryability.

Hello,

First, thanks for this wonderful library!

I'd like to configure its data-representations to be as close as possible as the original processing done by MongoBD, and as compact as possible.

Here is my configuration:

@Singleton
public class Jsr310AdditionalCodecsProvider implements CodecProvider {
    // As date objects to be able to compare them and have an ISO and smaller representation
    private static final LocalDateTimeCodec LOCAL_DATE_TIME_CODEC = new LocalDateTimeCodec();

    // As strings to have an ISO and smaller representation
    private static final ZoneOffsetAsStringCodec ZONE_OFFSET_CODEC = new ZoneOffsetAsStringCodec();

    // As strings to have a smaller representation
    private static final ZoneIdAsStringCodec ZONE_ID_CODEC = new ZoneIdAsStringCodec();

    @Override
    public <T> Codec<T> get(Class<T> clazz, CodecRegistry registry) {
        if (clazz.equals(ZonedDateTime.class)) {
            return (Codec<T>) new ZonedDateTimeAsDocumentCodec(LOCAL_DATE_TIME_CODEC, ZONE_OFFSET_CODEC, ZONE_ID_CODEC);
        } else if (clazz.equals(OffsetDateTime.class)) {
            return (Codec<T>) new OffsetDateTimeAsDocumentCodec(LOCAL_DATE_TIME_CODEC, ZONE_OFFSET_CODEC);
        } else if (clazz.equals(ZoneOffset.class)) {
            return (Codec<T>) ZONE_OFFSET_CODEC;
        } else if (clazz.equals(ZoneId.class)) {
            return (Codec<T>) ZONE_ID_CODEC;
        }
        return null; // Other default codecs are fine to us
    }
}

The goal is to store OffsetDateTime & ZonedDateTime as close as possible as the default MongoDB codecs: as $date fields to be able to compare them, with just one or two additional fields to be able to restore the original offset, lost with the default MongoDB converter, as well as the original zone, non-standard, and thus also lost.

Unfortunately, the dateTime fields are stored as LocalDate with a "Z" appended, making the date objects not comparable.

Example of stored document: the two OffsetDateTimes are at the same moment, created on my machine that is currently GMT+1 (will be GMT+2 in 6 months when DST kicks in):

{
  "offsetDateTime": {
    "dateTime": { "$date": "2022-03-02T15:15:44.555Z" },
    "offset": "+01:00"
  },
  "offsetDateTime2": {
    "dateTime": { "$date": "2022-03-02T16:15:44.555Z" },
    "offset": "+02:00"
  }
}

So, as long as you create documents on the same machine, or on machines with the same offset AND that do not honor Daylight Saving Time, then the created dates are comparable.

That's a lot of ifs :)

And semantically speaking, if we store a "Z"-date in database, we expect it to be UTC, like MongoDB does by default.

We would also expect Instant.parse(offsetDateTime2.dateTime).atOffset(ZoneOffset.of(offsetDateTime2.zone)) to restore the original OffsetDateTime: it currently does not.

I'd like both fields above to have theirs dateTime to "$date": "2022-03-02T14:15:44.555Z".

Did I use the library wrong? Is there a possible way to do this?

If not, is it possible to create alternate ZonedDateTimeAsDocumentCodec & OffsetDateTimeAsDocumentCodec classes that do not use a LocalDateTimeCodec or that convert them to UTC first?

Thanks a lot.

Implement codecs for the following types:

• ZoneId - convertible to and from String;
• DayOfWeek - convertible to and from String and 32-bit integer;
• Month - convertible to and from String and 32-bit integer;

Note that #1 has to be done first.

CodecConfigurationException, BSONException or its subtypes should be the only unchecked exceptions thrown by the codecs.

For example it's worth noting that LocalDate, when converted to BSON Date, represents a start of a day in UTC.