searchApi: fix response interceptors and suggestion config validation#302
Open
bodoque-01 wants to merge 1 commit into
Open
searchApi: fix response interceptors and suggestion config validation#302bodoque-01 wants to merge 1 commit into
bodoque-01 wants to merge 1 commit into
Conversation
Register response interceptors on the axios response pipeline in InvenioSearchApi and OSSearchApi. Call InvenioSuggestionApi.validateConfig from initSerializers and fix the responseField error message. Delete response.newQueryState after updating state from search results.
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
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.
❤️ Thank you for your contribution!
Description
This PR fixes some bugs in the search API layer.
Response Interceptors
InvenioSearchApi and OSSearchApi registered config.interceptors.response on axios.interceptors.request instead of .response, so response interceptors never ran. Now, both APIs use interceptors. response.use, with tests asserting that the handler receives {status, data}.
InvenioSuggestionApi config
validateConfig was orphaned after the parent renamed validateConfig to validateAxiosConfig (commit in 2020) and was never called from the constructor path.
Query state
updateQueryStateAfterResponse deleted response.newStateQuery instead of response.newQueryState
Impact
Bundled demos (e.g. OpenSearch on localhost:5000) behave the same on the default path, I think the fixes matters only (correct me if wrong!) when anyone who uses it uses response interceptors.
Besides adding tests, I too tested manually by adding some silly mock interceptor and verified via console logs that it indeed was being included in the logic when searching.
Checklist
Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:
Frontend
Reminder
By using GitHub, you have already agreed to the GitHub’s Terms of Service including that: