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

KAFKA-18585 Fix fail test ValuesTest#shouldConvertDateValues #18611

Merged
merged 2 commits into from
Jan 21, 2025
Merged
Changes from all commits
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 @@ -887,7 +887,9 @@ public void shouldConvertTimeValues() {

@Test
public void shouldConvertDateValues() {
java.util.Date current = new java.util.Date();
LocalDateTime localTime = LocalDateTime.now();
ZoneOffset zoneOffset = ZoneId.systemDefault().getRules().getOffset(localTime);
java.util.Date current = new java.util.Date(localTime.toEpochSecond(zoneOffset) * 1000);
long currentMillis = current.getTime() % MILLIS_PER_DAY;
long days = current.getTime() / MILLIS_PER_DAY;

Expand All @@ -901,8 +903,10 @@ public void shouldConvertDateValues() {
assertEquals(currentDate, d2);

// ISO8601 strings - accept a string matching pattern "yyyy-MM-dd"
LocalDateTime localTimeTruncated = localTime.truncatedTo(ChronoUnit.DAYS);
java.util.Date d3 = Values.convertToDate(Date.SCHEMA, LocalDate.ofEpochDay(days).format(DateTimeFormatter.ISO_LOCAL_DATE));
assertEquals(currentDate, d3);
Copy link
Member

Choose a reason for hiding this comment

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

I must be missing something here so please help me understand the following:

Java's util.Date is timezone agnostic (it's always epochs in UTC timezone) until you want to print it (where you can format it). Hence, the currentDate here should already be in UTC timezone. And the actual value from LocalDate.ofEpochDay(days).format(DateTimeFormatter.ISO_LOCAL_DATE) should also be in UTC. So, where is the disconnect here?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I'm not sure either. But I can believe it's possible to write a test that is timezone-dependent.

Copy link
Member

Choose a reason for hiding this comment

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

@divijvaidya is correct that java.util.Date is timezone-agnostic. However, the LocalDate here is timezone-ignorant and the timezone offset is not accounted for. The methods available for manipulating dates and times with timezones are a bit limited, and I think that it's best to stop using LocalDate.ofEpochDay(long) and moving to LocalDateTime.ofInstant(Instant, ZoneId).

I suggest replacing the first line of the method with:

        LocalDateTime localTime = LocalDateTime.now();
        LocalDateTime localTimeTruncated = localTime.truncatedTo(ChronoUnit.DAYS);
        ZoneOffset zoneOffset = ZoneId.systemDefault().getRules().getOffset(localTime);
        java.util.Date current = new java.util.Date(localTime.toEpochSecond(zoneOffset) * 1000);

And then the check becomes:

        // ISO8601 strings - accept a string matching pattern "yyyy-MM-dd"
        java.util.Date d3 = Values.convertToDate(Date.SCHEMA, LocalDate.ofEpochDay(days).format(DateTimeFormatter.ISO_LOCAL_DATE));
        LocalDateTime date3 = LocalDateTime.ofInstant(Instant.ofEpochMilli(d3.getTime()), ZoneId.systemDefault());
        assertEquals(localTimeTruncated, date3);

I tried this with various timezones locally and it seems to work properly. Essentially, the time information is discarded in a way that a person in the timezone would expect looking at a clock.

Copy link
Collaborator Author

@m1a2st m1a2st Jan 21, 2025

Choose a reason for hiding this comment

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

We can observe that when java.util.Date performs equals comparison, it takes timezone into account. Therefore, the equals comparison will yield different results under different timezones. In my case, being in UTC+8, it results in an 8-hour difference.

https://github.com/openjdk/jdk/blob/master/src/java.base/share/classes/java/util/Date.java#L1210

Copy link
Member

Choose a reason for hiding this comment

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

@m1a2st Are you happy that this works now?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, using LocalDateTime makes sense to me.

LocalDateTime date3 = LocalDateTime.ofInstant(Instant.ofEpochMilli(d3.getTime()), ZoneId.systemDefault());
assertEquals(localTimeTruncated, date3);

// Days as string
java.util.Date d4 = Values.convertToDate(Date.SCHEMA, Long.toString(days));
Expand Down
Loading