Do not throw no archive exception for API requests triggered by the UI #20465
Conversation
This file contains hidden or 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
bx80
approved these changes
Mar 15, 2023
There was a problem hiding this comment.
Tested with newly created segments that hadn't been archived yet, only one correct message is shown 👍
- Functional review done
- Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
- Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
- Security review done
- Wording review done
- Code review done
- n/a Tests were added if useful/possible
- none Reviewed for breaking changes
- n/a Developer changelog updated if needed
- n/a Documentation added if needed
- n/a Existing documentation updated if needed
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:
When a report or an UI widget directly queries the API using a segment, it can currently happen that an UnprocessedSegmentException is thrown in the API if no usable archive can be found.
This would currently be displayed directly in the UI, as the AjaxHelper by default shows every error as notification.
As our UI has an additional way to determine if reports have been processed or not, resulting in a separate notification, there is no benefit in throwing the UnprocessedSegmentException for API requests triggered by the UI.
I've therefor changed the AjaxHelper so a XMLHttpRequest header will be sent with all requests and added some code to not throw the UnprocessedSegmentException for such requests.
Requests triggered from the UI will instead now receive the normal report with 0 values.
fixes #20222
Review