[BUGFIX] Fixed crashes on Search#924
Merged
Merged
Conversation
augustjohnson
approved these changes
May 19, 2026
Collaborator
augustjohnson
left a comment
augustjohnson
left a comment
There was a problem hiding this comment.
Makes sense, no concerns.
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
2 participants
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
This PR fixes a bug that was causing the v2 Search to crash when certain terms were searched for (see issue #922).
The bug appears to be in the code that adds additional contextually relevant fields to search results. adding a spell's school and level when the search returns a spell, for example.
The
Documentmodel'ssearch_result_extra_fieldsmethod instructed the serializer to add the"school"field to any search result that inherits from theFromDocumentmodel. I can only assume that this bug only triggered on some search terms and not others was because in many cases thesearch_result_extra_fieldsis overloaded in the Class that inherited from theFromDocumentabstract model, obscuring the bug. A quick peak at the error messages/stack trace reveals that it was theItemmodel which was giving the API issues, and investigating the Item model it looks like this method is not defined there. Surprise surprise.This would normally be the type of bug that
pytestwould catch, but it looks like the Search is a blind-spot in our testing suite. Would be well worth adding this in!Related Issue
Closes #922
How was this tested?
pytest(all tests green)