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.

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

Fix: Date field format parsing for legacy query engine #3160

Merged
merged 5 commits into from
Dec 2, 2024
Merged

Fix: Date field format parsing for legacy query engine #3160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d2b378d
Test cases
andy-k-improving Nov 20, 2024
322d16f
Minimise code changes
andy-k-improving Nov 20, 2024
b85826c
Format
andy-k-improving Nov 22, 2024
27af958
Update integration test
andy-k-improving Nov 27, 2024
3d805cb
Update unit test
andy-k-improving Nov 27, 2024
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
4 changes: 3 additions & 1 deletion integ-test/src/test/java/org/opensearch/sql/legacy/CursorIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,9 @@ public void testRegressionOnDateFormatChange() throws IOException {
Arrays.asList(
"2015-01-01 00:00:00.000",
"2015-01-01 12:10:30.000",
"1585882955", // by existing design, this is not formatted in MySQL standard format
// Conversion will be applied when dateTime is stored on unix timestamp,
// https://github.com/opensearch-project/sql/pull/3160
"2020-04-03 03:02:35.000",
"2020-04-08 06:10:30.000");

assertThat(actualDateList, equalTo(expectedDateList));
Expand Down
32 changes: 22 additions & 10 deletions legacy/src/main/java/org/opensearch/sql/legacy/executor/format/DateFieldFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.apache.logging.log4j.Logger;
import org.opensearch.sql.legacy.esdomain.LocalClusterState;
import org.opensearch.sql.legacy.esdomain.mapping.FieldMappings;
import org.opensearch.sql.legacy.utils.StringUtils;

/** Formatter to transform date fields into a consistent format for consumption by clients. */
public class DateFieldFormatter {
Expand Down Expand Up @@ -83,7 +84,6 @@ public void applyJDBCDateFormat(Map<String, Object> rowSource) {
Date date = parseDateString(formats, columnOriginalDate.toString());
if (date != null) {
rowSource.put(columnName, DateFormat.getFormattedDate(date, FORMAT_JDBC));
break;
} else {
LOG.warn("Could not parse date value; returning original value");
}
Expand Down Expand Up @@ -152,15 +152,27 @@ private Date parseDateString(List<String> formats, String columnOriginalDate) {
switch (columnFormat) {
case "date_optional_time":
case "strict_date_optional_time":
parsedDate =
DateUtils.parseDate(
columnOriginalDate,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_LOGS_EXCEPTION,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_FLIGHTS_EXCEPTION,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_FLIGHTS_EXCEPTION_NO_TIME,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_ECOMMERCE_EXCEPTION,
FORMAT_DOT_DATE_AND_TIME,
FORMAT_DOT_DATE);
// It's possible to have date stored in second / millisecond form without explicit
// format hint.
// Parse it on a best-effort basis.
dai-chen marked this conversation as resolved.
Show resolved Hide resolved
if (StringUtils.isNumeric(columnOriginalDate)) {
long timestamp = Long.parseLong(columnOriginalDate);
if (timestamp > Integer.MAX_VALUE) {
parsedDate = new Date(timestamp);
} else {
parsedDate = new Date(timestamp * 1000);
}
} else {
parsedDate =
DateUtils.parseDate(
columnOriginalDate,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_LOGS_EXCEPTION,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_FLIGHTS_EXCEPTION,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_FLIGHTS_EXCEPTION_NO_TIME,
FORMAT_DOT_OPENSEARCH_DASHBOARDS_SAMPLE_DATA_ECOMMERCE_EXCEPTION,
FORMAT_DOT_DATE_AND_TIME,
FORMAT_DOT_DATE);
}
break;
case "epoch_millis":
parsedDate = new Date(Long.parseLong(columnOriginalDate));
Expand Down
20 changes: 19 additions & 1 deletion legacy/src/test/java/org/opensearch/sql/legacy/executor/format/DateFieldFormatterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ public void testIncorrectFormat() {
String dateFormat = "date_optional_time";
String originalDateValue = "1581724085";
// Invalid format for date value; should return original value
String expectedDateValue = "1581724085";
String expectedDateValue = "2020-02-14 23:48:05.000";

verifyFormatting(columnName, dateFormat, originalDateValue, expectedDateValue);
}
Expand Down Expand Up @@ -609,6 +609,24 @@ public void testStrictDateOptionalTimeOrEpochMillsShouldPass() {
verifyFormatting(columnName, dateFormat, originalDateValue, expectedDateValue);
}

@Test
public void testDateInTimestampFormInSecondWithoutHint() {
String columnName = "date_field";
String dateFormat = "date_optional_time";
String originalDateValue = "1732057981";
String expectedDateValue = "2024-11-19 23:13:01.000";
verifyFormatting(columnName, dateFormat, originalDateValue, expectedDateValue);
}

@Test
public void testDateInTimestampFormInMilliSecondWithoutHint() {
String columnName = "date_field";
String dateFormat = "date_optional_time";
String originalDateValue = "1732057981000";
String expectedDateValue = "2024-11-19 23:13:01.000";
verifyFormatting(columnName, dateFormat, originalDateValue, expectedDateValue);
}

private void verifyFormatting(
String columnName,
String dateFormatProperty,
Expand Down
Loading