Added functionality to filter getReportMetadata and getSegmentsMetada in SystemTestCase #18141
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
…ta API response, #DEV-2366
AltamashShaikh
commented
Oct 13, 2021
…set and get, #DEV-2366
|
@AltamashShaikh I think it might be useful to add or change a test in core that uses that new possibility so we can directly see how and if it works. That might also prevent future regressions. You could for example change the custom dimension tests: |
sgiehl
requested changes
Oct 19, 2021
| Piwik::addAction('API.API.getSegmentsMetadata.end', function (&$reports, $info) use ($allowedModuleForApiSegmentsReport) { | ||
| $this->filterReportsCallback($reports, $info, $allowedModuleForApiSegmentsReport); | ||
| }); | ||
| } |
There was a problem hiding this comment.
I think this needs to be moved to the setUpBeforeClass method. Calling it in setUp causes each test to add a new observer. So running 10 tests would end up having 10 event observers in the last test.
If the event observer is added in the setUpBeforeClass, you could also always add it like:
Piwik::addAction('API.getReportMetadata.end', function (&$reports, $info) {
$allowedModuleForApiMetadataReport = self::getAllowedModuleToFilterApiResponse('API.getReportMetadata');
if ($allowedModuleForApiMetadataReport) {
self::filterReportsCallback($reports, $info, $allowedModuleForApiMetadataReport);
}
});
Piwik::addAction('API.API.getSegmentsMetadata.end', function (&$reports, $info) {
$allowedModuleForApiSegmentsReport = self::getAllowedModuleToFilterApiResponse('API.getSegmentsMetadata');
if ($allowedModuleForApiSegmentsReport) {
self::filterReportsCallback($reports, $info, $allowedModuleForApiSegmentsReport);
}
});Note: EvenObserver will be cleared when a Fixture is teared down, so the shouldn't be a need to remove the observers manually.
sgiehl
reviewed
Oct 20, 2021
…or getReportMetadata, #DEV-2366
sgiehl
reviewed
Oct 20, 2021
…case file, #DEV-2366
sgiehl
reviewed
Oct 21, 2021
sgiehl
approved these changes
Oct 21, 2021
sgiehl
added
not-in-changelog
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.
Added functionality to filter getReportMetadata and getSegmentsMetada in SystemTestCase
Issue: #DEV-2366
Description:
Please include a description of this change and which issue it fixes. If no issue exists yet please include context and what problem it solves.
Review