Define API params in order to be able to filter correctly #413
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
deluxetom
commented
Dec 17, 2024
•
deluxetom
commented
- resolves All parameters are used for the cache path hash #412
- Added new tests to make sure only valid parameters are used
- New interface method for each manipulator to know the API parameters used
- no BC break
deluxetom
commented
Dec 17, 2024
| @@ -410,6 +409,7 @@ public function testGetAllParams() | |||
| $all_params = $this->server->getAllParams([ | |||
| 'w' => '100', | |||
| 'p' => 'small', | |||
| 'invalid' => '1', | |||
There was a problem hiding this comment.
@ADmad I realize I added some fixes that are out of scope of the issue, but this is the test fixing the cache path issue
I believe it shouldn't accept invalid parameters
ADmad
reviewed
Dec 17, 2024
src/Api/Api.php
Outdated
| $params = []; | ||
|
|
||
| array_walk($this->manipulators, function (ManipulatorInterface $manipulator) use (&$params) { | ||
| foreach ($manipulator->getApiParams() as $param) { |
There was a problem hiding this comment.
Why loop through each instead of using array merge?
ADmad
reviewed
Dec 17, 2024
src/Api/Api.php
Outdated
Comment on lines
145
to
147
| foreach ($manipulator->getApiParams() as $param) { | ||
| $this->apiParams[] = $param; | ||
| } |
There was a problem hiding this comment.
Suggested change
| foreach ($manipulator->getApiParams() as $param) { | |
| $this->apiParams[] = $param; | |
| } | |
| $this->apiParams = array_merge($this->apiParams, $manipulator->getApiParams()); |
There was a problem hiding this comment.
I was over-complicating this, thanks for pointing it out!
Art4
reviewed
Dec 17, 2024
src/Manipulators/BaseManipulator.php
Outdated
| * | ||
| * @return list<string> | ||
| */ | ||
| abstract public function getApiParams(): array; |
There was a problem hiding this comment.
We don't need this abstract method because it is defined already in ManipulatorInterface
There was a problem hiding this comment.
I agree, I was following what was done for the run method, I removed both from BaseManipulator
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.