Limit date ranges that end far in the future #22592
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sgiehl
added
c: Usability
sgiehl
force-pushed
the
disallowfuturedates
branch
2 times, most recently
from
007a431
to
a72d66c
Compare
sgiehl
force-pushed
the
disallowfuturedates
branch
from
a72d66c
to
707cc29
Compare
sgiehl
changed the title
| * | ||
| * @return int | ||
| */ | ||
| public static function getMaxAllowedEndTimestamp(): int |
There was a problem hiding this comment.
Does the method need to be public if not used elsewhere?
There was a problem hiding this comment.
It doesn't and it might not even need to be static. But this new "Limit" is supposed to be something global for ranges. So it imho should be reusable if needed anywhere else.
We could actually even consider to mark this method as @api, so it will be shown in the documentation 🤔
There was a problem hiding this comment.
Hmmm, ok, well if we want to have it in the API scope, then yeah, keep it public. With the static vs dynamic, it seemed to me we prefer dynamic in a lot of places, even just to get a single thing we instantiate a class.. so I could see that used here as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Matomo currently only restricts provided dates in the past. A date currently can't be set to earlier than August 1991 - the date were the first website went live.
Future dates are currently not restricted, even though it doesn't make sense to provide dates that are far in the future. As Matomo won't archive future dates, there can't be any data returned anyway.
Providing single periods like
day,week,monthoryearfar in the future is unproblematic, as Matomo would simply display no data for it.Range periods and multiple period requests however are a bit different, as Matomo would try to process all subperiods that are included. As dates in the future can't have any data anyway, there is not much value in even trying to process those dates unlimited.
Therefor this PR introduces an internal limit for range periods. If a range is provided with an end date that is more than 10 years in the future, Matomo will automatically cut down the range to end at end of the current year + 10 years.
Review