-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add helper function to return the number of days since epoch for a week-of-month date #10604
Changes from 11 commits
6104fc6
1d4667b
e4b2c78
b4504f8
e9be740
a4ff46c
555e1d9
83301ab
e718074
9ce7750
216a000
e850388
cb45539
a98fedd
6135991
b5f3be9
3165392
d3f2657
0e9412c
7a52b45
7d72017
3e2fb0c
0fcb111
0d29272
9267d21
935bab1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -144,6 +144,46 @@ bool isValidWeekDate(int32_t weekYear, int32_t weekOfYear, int32_t dayOfWeek) { | |
return true; | ||
} | ||
|
||
bool isValidWeekOfMonthDate( | ||
int32_t year, | ||
int32_t month, | ||
int32_t weekOfMonth, | ||
int32_t dayOfWeek) { | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (year < 1 || year > kMaxYear) { | ||
NEUpanning marked this conversation as resolved.
Show resolved
Hide resolved
|
||
return false; | ||
} | ||
if (month < 1 || month > 12) { | ||
return false; | ||
} | ||
// Validate week of month. | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
int32_t monthLength = | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
isLeapYear(year) ? kLeapDays[month] : kNormalDays[month]; | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
int64_t daysSinceEpochOfFirstDayOfMonth; | ||
Status status = | ||
daysSinceEpochFromDate(year, month, 1, daysSinceEpochOfFirstDayOfMonth); | ||
if (!status.ok()) { | ||
return false; | ||
} | ||
int32_t firstDayOfWeek = | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
extractISODayOfTheWeek(daysSinceEpochOfFirstDayOfMonth); | ||
int32_t firstWeekLength = 7 - firstDayOfWeek + 1; | ||
int32_t maxWeekOfMonth = 1 + ceil((monthLength - firstWeekLength) / 7.0); | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (weekOfMonth < 1 || weekOfMonth > maxWeekOfMonth) { | ||
return false; | ||
} | ||
// Validate day of week. | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (weekOfMonth == 1 && dayOfWeek < firstDayOfWeek) { | ||
return false; | ||
} | ||
int32_t lastWeekLength = (monthLength - firstWeekLength) % 7; | ||
if (weekOfMonth == maxWeekOfMonth && lastWeekLength != 0 && | ||
dayOfWeek > lastWeekLength) { | ||
return false; | ||
} | ||
|
||
return true; | ||
} | ||
|
||
inline bool validDate(int64_t daysSinceEpoch) { | ||
return daysSinceEpoch >= std::numeric_limits<int32_t>::min() && | ||
daysSinceEpoch <= std::numeric_limits<int32_t>::max(); | ||
|
@@ -593,6 +633,57 @@ Status daysSinceEpochFromWeekDate( | |
return Status::OK(); | ||
} | ||
|
||
Expected<int64_t> daysSinceEpochFromWeekOfMonthDate( | ||
int32_t year, | ||
int32_t month, | ||
int32_t weekOfMonth, | ||
int32_t dayOfWeek, | ||
bool lenient) { | ||
if (!lenient && | ||
!isValidWeekOfMonthDate(year, month, weekOfMonth, dayOfWeek)) { | ||
if (threadSkipErrorDetails()) { | ||
return folly::makeUnexpected(Status::UserError()); | ||
} else { | ||
return folly::makeUnexpected(Status::UserError( | ||
"Date out of range: {}-{}-{}-{}", | ||
year, | ||
month, | ||
weekOfMonth, | ||
dayOfWeek)); | ||
} | ||
} | ||
// If the month is out of range, adjust it into range | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
int32_t additionYears; | ||
if (month < 1) { | ||
additionYears = month / 12 - 1; | ||
month = 12 - abs(month) % 12; | ||
} else { | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
additionYears = (month - 1) / 12; | ||
month = (month - 1) % 12 + 1; | ||
} | ||
year += additionYears; | ||
|
||
int64_t daysSinceEpochOfFirstDayOfMonth; | ||
Status status = | ||
daysSinceEpochFromDate(year, month, 1, daysSinceEpochOfFirstDayOfMonth); | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (!status.ok()) { | ||
return folly::makeUnexpected(status); | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
int32_t firstDayOfWeek = | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe I asked this earlier, but I don't think I saw an answer, hence, asking again. What happens if weekOfMonth is 5, but month has only 4 weeks (Feb)? Similarly, what happens if weekOfMonth is 5 and dayOfWeek is 7 (no month has 35 days)? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In Java's SimpleDateFormat, "invalid" weekOfMonth and dayOfWeek etc. are allowed. If the date falls outside the valid range, the week or day from the preceding or following month's will be used. For example, if weekOfMonth is 5 but the current month only has 4 weeks (such as February), the first week of March will be considered as the 5th week of February. Similarly, if weekOfMonth is 5 and dayOfWeek is 7, the corresponding day from the next month will be used. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you for clarifying. Let's update method comments to explain this as it is not obvious. Do we already have tests for these cases? If not, let's make sure to add. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added this comments for clarifying and two tests for cases that days in previous/next month.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm seeing that DATE type is based on INTEGER type, hence, allows only int32_t number of days since epoch. If that's the case, then, perhaps, daysSinceEpochFromDate should return int32_t, not int64_t. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This PR is intended for date parsing, and the DateTimeFormatter::parse method returns a Timestamp. A Timestamp is based on int64_t seconds and can represent up to 106,751,991,167 days, which is calculated as (2^63 - 1) / 1000 / 86400. This value is greater than the maximum value of an int32_t. Therefore, I think that daysSinceEpochFromDate should return an int64_t.
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
extractISODayOfTheWeek(daysSinceEpochOfFirstDayOfMonth); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I notice There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looks like the cast is to avoid overflow in addition and negating. If we change it as int64_t, overflow needs to considered as well by casting to a larger type. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for your explanation. I see There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if there is any limitation for year? If the days cannot exceed INT32_MAX, it would be safe to call it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The max year is 292278994 so the days can be (292278994-1970)*365=106,681,113,760 that is bigger than 2,147,483,647(INT32_MAX). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Looks fine to me. @mbasmanova What are your thoughts? Thanks. |
||
int32_t days; | ||
if (dayOfWeek < 1) { | ||
days = 7 - abs(dayOfWeek - 1) % 7; | ||
} else if (dayOfWeek > 7) { | ||
days = (dayOfWeek - 1) % 7; | ||
} else { | ||
days = dayOfWeek % 7; | ||
} | ||
int64_t result = daysSinceEpochOfFirstDayOfMonth - (firstDayOfWeek - 1) + | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
7 * (weekOfMonth - 1) + days - 1; | ||
return result; | ||
} | ||
|
||
Status | ||
daysSinceEpochFromDayOfYear(int32_t year, int32_t dayOfYear, int64_t& out) { | ||
if (!isValidDayOfYear(year, dayOfYear)) { | ||
|
@@ -643,7 +734,7 @@ Expected<int32_t> fromDateString(const char* str, size_t len, ParseMode mode) { | |
return daysSinceEpoch; | ||
} | ||
|
||
int32_t extractISODayOfTheWeek(int32_t daysSinceEpoch) { | ||
int32_t extractISODayOfTheWeek(int64_t daysSinceEpoch) { | ||
NEUpanning marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// date of 0 is 1970-01-01, which was a Thursday (4) | ||
// -7 = 4 | ||
// -6 = 5 | ||
|
@@ -662,10 +753,10 @@ int32_t extractISODayOfTheWeek(int32_t daysSinceEpoch) { | |
// 7 = 4 | ||
if (daysSinceEpoch < 0) { | ||
// negative date: start off at 4 and cycle downwards | ||
return (7 - ((-int64_t(daysSinceEpoch) + 3) % 7)); | ||
return (7 - ((-int128_t(daysSinceEpoch) + 3) % 7)); | ||
} else { | ||
// positive date: start off at 4 and cycle upwards | ||
return ((int64_t(daysSinceEpoch) + 3) % 7) + 1; | ||
return ((int128_t(daysSinceEpoch) + 3) % 7) + 1; | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -107,6 +107,35 @@ Status daysSinceEpochFromWeekDate( | |
int32_t dayOfWeek, | ||
int64_t& out); | ||
|
||
/// Computes the signed number of days since the Unix epoch (1970-01-01). To | ||
NEUpanning marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/// align with Spark's SimpleDateFormat behavior, this function offers two | ||
/// modes: lenient and non-lenient. If `lenient` is false, it returns an error | ||
/// status if the date is invalid. If `lenient` is true, it accepts a wider | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/// range of arguments. For the month parameter, values greater than 12 wrap | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/// around to the start of the year, and values less than 1 count backward from | ||
/// December. For example, 13 corresponds to January of the following year and | ||
/// -1 corresponds to November of the previous year. For the weekOfMonth | ||
/// parameter, we consider days of the previous or next months as part of the | ||
/// specified weekOfMonth and dayOfWeek. For example, if weekOfMonth is 5 but | ||
/// the current month only has 4 weeks (such as February), the first week of | ||
/// March will be considered as the 5th week of February. For the dayOfWeek | ||
/// parameter, if weekOfMonth is 1 and dayOfWeek is 1 but the month's first day | ||
/// is a Saturday, the Monday of the last week of the previous month will be | ||
/// used. | ||
/// @param year Year, A value in [1, 292278994] range. e.g: 1996, -2000 | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
/// @param month Month of year. A value in [1, 12] range. For example, 1 is Jan, | ||
/// 7 is Jul. | ||
/// @param weekOfMonth Week of the month. A value in [1, 6] range. For example, | ||
/// 1 is 1st week, 3 is 3rd week. | ||
/// @param dayOfWeek Day number of week. A value in [1, 7] range. For example, 1 | ||
/// is Monday, 7 is Sunday. | ||
rui-mo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Expected<int64_t> daysSinceEpochFromWeekOfMonthDate( | ||
int32_t year, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The implementation imposes limits on the 'year' value. Would you document these? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks. Done. |
||
int32_t month, | ||
int32_t weekOfMonth, | ||
NEUpanning marked this conversation as resolved.
Show resolved
Hide resolved
|
||
int32_t dayOfWeek, | ||
bool lenient); | ||
|
||
/// Computes the (signed) number of days since unix epoch (1970-01-01). | ||
/// Returns UserError status if the date is invalid. | ||
Status | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the discussion at https://github.com/facebookincubator/velox/pull/10511/files#r1686566980, true result does not always indicate a valid date.
With current implementation, for some invalid date, we return user error status while for the others we return a int64_t result in the
daysSinceEpochFromWeekOfMonthDate
function, which seems to be confusing.I notice the method
isValidDate
provides an accurate evaluation for valid date. Does it make sense to use that?https://github.com/facebookincubator/velox/blob/main/velox/type/TimestampConversion.cpp#L518-L529
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right. We should remove the validation for week of month. According to SimpleDateFormat's doc the range of
day
is [1,7] soisValidDate
isn't suitable for this.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. See e718074
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you clarify the purpose of
isValidWeekOfMonthDate
? Is it to follow certain rule defined in SimpleDateFormat to check if a date is valid, and what are the rules? Perhaps add some comments for this function.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I want to do validation follows SimpleDateFormat. However, SimpleDateFormat does not provide clear rules or relevant documentation. For example, document states
WEEK_OF_MONTH
field range is from 0 to 6, , but in my tests, a value of 99 is considered valid.(https://github.com/facebookincubator/velox/pull/10511/files#r1686566980)Another example is the valid range for the
year
field, which is not documented.I tried to determine the valid range through testing, but it is too costly and not reliable enough. I wonder how to properly validate dates in Velox. Could you give me some advice?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rui-mo I don't believe this functionality is needed for Presto functions. Hence, we are free to define semantics in any "sensible" way. Assuming we need these semantics to match Spark, we can use Spark semantics.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the pointer. Understood.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mbasmanova @rui-mo According to this discussion, Spark date validation rules in document don't match with the test results. Which one should I follow? Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@NEUpanning I assume we need to follow the actual behavior of Spark. How do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rui-mo I agree with you. I will change the part of date validation for following the actual behavior of Spark.