Skip to content

Fixed week of week based year handling #3299

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 5, 2025
Merged

Fixed week of week based year handling #3299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion core/src/main/java/org/opensearch/sql/expression/datetime/DateTimeFunctions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
import java.time.format.DateTimeParseException;
import java.time.format.TextStyle;
import java.time.temporal.ChronoUnit;
import java.time.temporal.IsoFields;
import java.time.temporal.TemporalAmount;
import java.util.Locale;
import java.util.Map;
Expand Down Expand Up @@ -123,7 +124,8 @@ public class DateTimeFunctions {
.put("MINUTE", "mm")
.put("HOUR", "HH")
.put("DAY", "dd")
.put("WEEK", "w")
// removing "WEEK" to standardize the extract
// .put("WEEK", "w")
.put("MONTH", "MM")
.put("YEAR", "yyyy")
.put("SECOND_MICROSECOND", "ssSSSSSS")
Expand Down Expand Up @@ -1436,6 +1438,12 @@ private ExprValue exprDayOfYear(ExprValue date) {
public ExprLongValue formatExtractFunction(ExprValue part, ExprValue timestamp) {
String partName = part.stringValue().toUpperCase();
LocalDateTime arg = timestamp.timestampValue().atZone(ZoneOffset.UTC).toLocalDateTime();

// Override "Week" to use the IsoFields week-of-week-based-year format
if (partName.equals("WEEK")) {
return new ExprLongValue(arg.get(IsoFields.WEEK_OF_WEEK_BASED_YEAR));
}

String text =
arg.format(DateTimeFormatter.ofPattern(extract_formats.get(partName), Locale.ENGLISH));

Expand Down
63 changes: 51 additions & 12 deletions core/src/test/java/org/opensearch/sql/expression/datetime/ExtractTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,21 @@

package org.opensearch.sql.expression.datetime;

import static java.time.temporal.ChronoField.ALIGNED_WEEK_OF_YEAR;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.opensearch.sql.data.type.ExprCoreType.LONG;

import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.ZoneId;
import java.time.temporal.IsoFields;
import java.util.stream.Stream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.junit.jupiter.params.provider.ValueSource;
import org.opensearch.sql.data.model.ExprDateValue;
import org.opensearch.sql.data.model.ExprTimeValue;
import org.opensearch.sql.data.model.ExprTimestampValue;
Expand All @@ -23,6 +28,7 @@
import org.opensearch.sql.expression.Expression;
import org.opensearch.sql.expression.ExpressionTestBase;
import org.opensearch.sql.expression.FunctionExpression;
import org.opensearch.sql.expression.function.FunctionProperties;

class ExtractTest extends ExpressionTestBase {

Expand Down Expand Up @@ -82,9 +88,14 @@ public void testExtractWithDatetime(String part, long expected) {
}

private void datePartWithTimeArgQuery(String part, String time, long expected) {
datePartWithTimeArgQuery(functionProperties, part, time, expected);
}

private void datePartWithTimeArgQuery(
FunctionProperties properties, String part, String time, long expected) {
ExprTimeValue timeValue = new ExprTimeValue(time);
FunctionExpression datetimeExpression =
DSL.extract(functionProperties, DSL.literal(part), DSL.literal(timeValue));
DSL.extract(properties, DSL.literal(part), DSL.literal(timeValue));

assertEquals(LONG, datetimeExpression.type());
assertEquals(expected, eval(datetimeExpression).longValue());
Expand All @@ -96,21 +107,49 @@ public void testExtractDatePartWithTimeType() {

datePartWithTimeArgQuery("DAY", timeInput, now.getDayOfMonth());

// To avoid flaky test, skip the testing in December and January because the WEEK is ISO 8601
// week-of-week-based-year which is considered to start on a Monday and week 1 is the first week
// with >3 days. it is possible for early-January dates to be part of the 52nd or 53rd week of
// the previous year, and for late-December dates to be part of the first week of the next year.
// For example, 2005-01-02 is part of the 53rd week of year 2004, while 2012-12-31 is part of
// the first week of 2013
if (now.getMonthValue() != 1 && now.getMonthValue() != 12) {
datePartWithTimeArgQuery("WEEK", datetimeInput, now.get(ALIGNED_WEEK_OF_YEAR));
}

datePartWithTimeArgQuery("MONTH", timeInput, now.getMonthValue());

datePartWithTimeArgQuery("YEAR", timeInput, now.getYear());
}

@ParameterizedTest(name = "{0}")
@ValueSource(
strings = {
"2009-12-26",
"2009-12-27",
"2008-12-28", // Week 52 of week-based-year 2008
"2009-12-29",
"2008-12-29", // Week 1 of week-based-year 2009
"2008-12-31", // Week 1 of week-based-year 2009
"2009-01-01", // Week 1 of week-based-year 2009
"2009-01-04", // Week 1 of week-based-year 2009
"2009-01-05", // Week 2 of week-based-year 2009
"2025-12-27", // year with 52 weeks
"2026-01-01", // year starts on a THURSDAY
"2028-12-30", // year with 53 weeks
"2028-12-31", // year starts in December
"2029-01-01",
"2033-12-31", // year with 53 weeks
"2034-01-01", // January 1st on a SUNDAY
"2034-12-30", // year with 52 weeks
"2034-12-31"
})
public void testExtractWeekPartWithTimeType(String arg) {

// setup default date/time properties for the extract function
ZoneId currentZoneId = ZoneId.systemDefault();
Instant nowInstant =
LocalDate.parse(arg).atTime(LocalTime.parse(timeInput)).atZone(currentZoneId).toInstant();
FunctionProperties properties = new FunctionProperties(nowInstant, currentZoneId);

// Expected WEEK value should be formated from week-of-week-based-year
LocalDateTime localDateTime = LocalDateTime.ofInstant(nowInstant, currentZoneId);
int expected = localDateTime.get(IsoFields.WEEK_OF_WEEK_BASED_YEAR);

// verify
datePartWithTimeArgQuery(properties, "WEEK", timeInput, expected);
}

@ParameterizedTest(name = "{0}")
@MethodSource("getDateResultsForExtractFunction")
public void testExtractWithDate(String part, long expected) {
Expand Down
Loading