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.

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

Remove LocalDate and LocalDateTime converters #11381

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,8 @@ public void register(MutableConversionService conversionService) {
addTemporalToDateConverter(conversionService, ZonedDateTime.class, ZonedDateTime::toInstant);
// these two are a bit icky, but required for yaml parsing compatibility
// TODO Micronaut 4 Consider deletion
addTemporalToDateConverter(conversionService, LocalDate.class, ld -> ld.atTime(0, 0).toInstant(ZoneOffset.UTC));
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This line is converting LocaleDate to Date using UTC and micronaut-data is using default timezone when converting back so we are getting date diff issues. I believe this should use default timezone as well.
There is also comment about removal of this conversion in Micronaut4. Can it be removed? If yes, then we can add converter needed in micronaut-data using default timezone and the issue would be fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@yawkat Can we remove these conversions above, or change it to not use UTC but default timezone? It is causing issue in micronat-data explained in the description of this PR.

Copy link
Member

Choose a reason for hiding this comment

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

I disagree that this should be default TZ. Yes they should be removed, but using system TZ is worse.

Why does data need to convert these at all? java.sql.Date has actual well-defined conversions from and to LocalDate

Copy link
Contributor Author

Choose a reason for hiding this comment

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

micronaut-data registers various conversions for dates and is always using timezones.
With this converter defined in micronaut-core, even if we register this in micronaut-data

conversionService.addConverter(java.sql.Date.class, LocalDate.class, date -> date.toLocalDate());

we will get wrong date when converted back.

I removed these converters from micronaut-core, hopefully nothing will break.

addTemporalToDateConverter(conversionService, LocalDateTime.class, ldt -> ldt.toInstant(ZoneOffset.UTC));
addTemporalToDateConverter(conversionService, LocalDate.class, ld -> ld.atStartOfDay(ZoneId.systemDefault()).toInstant());
addTemporalToDateConverter(conversionService, LocalDateTime.class, ldt -> ldt.atZone(ZoneId.systemDefault()).toInstant());
}

private <T extends TemporalAccessor> void addTemporalStringConverters(MutableConversionService conversionService, Class<T> temporalType, DateTimeFormatter isoFormatter, TemporalQuery<T> query) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
package io.micronaut.runtime.converters

import io.micronaut.context.ApplicationContext
import io.micronaut.core.convert.ConversionService
import spock.lang.AutoCleanup
import spock.lang.Shared
import spock.lang.Specification

import java.text.DateFormat
import java.text.SimpleDateFormat
import java.time.Instant
import java.time.LocalDate
import java.time.LocalDateTime
import java.time.ZoneId
import java.time.ZoneOffset
import java.time.format.DateTimeFormatter

class TimeConverterRegistrarSpec extends Specification {

@AutoCleanup
@Shared
ApplicationContext context = ApplicationContext.run()

static final String DATE_FORMAT = "yyyy-MM-dd"
static final String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm"
static final String TEST_TIME_ZONE = "America/New_York"

void 'test converting LocalDate and LocalDateTime'() {
given:
def timeZone = TimeZone.default
TimeZone.default = TimeZone.getTimeZone(TEST_TIME_ZONE)
def conversionService = context.getBean(ConversionService)
def localDate = LocalDate.of(2024, 1, 1)
def localDateTime = LocalDateTime.of(2024, 1, 1, 2, 30)
def localDateStr = createDateTimeFormatter(DATE_FORMAT).format(localDate)
def localDateTimeStr = createDateTimeFormatter(DATE_TIME_FORMAT).format(localDateTime)
when:
def date = conversionService.convert(localDate, Date).orElse(null)
def dateTime = conversionService.convert(localDateTime, Date).orElse(null)
then:
def dateStr = createDateFormat(DATE_FORMAT).format(date)
dateStr == localDateStr
def dateTimeStr = new SimpleDateFormat(DATE_TIME_FORMAT).format(dateTime)
dateTimeStr == localDateTimeStr
cleanup:
TimeZone.default = timeZone
}

static DateTimeFormatter createDateTimeFormatter(String pattern) {
return DateTimeFormatter.ofPattern(pattern)
}

static DateFormat createDateFormat(String pattern) {
return new SimpleDateFormat(pattern)
}
}
Loading