fix: deep-copy cache entries so mutating search results cannot corrupt the cache#617
Open
gaoflow wants to merge 1 commit into
Open
fix: deep-copy cache entries so mutating search results cannot corrupt the cache#617gaoflow wants to merge 1 commit into
gaoflow wants to merge 1 commit into
Conversation
…t the cache `Table.search` stored and returned shallow copies of the document list, meaning the `Document` objects inside the cache and the caller's list were the same objects. Mutating a nested mutable value (e.g. appending to a list field) inside a returned document therefore silently corrupted the cached results, causing subsequent searches to return stale/wrong data. Switch to `copy.deepcopy` when writing to and reading from `_query_cache` so that cached entries and returned results are fully independent. Fixes msiemens#516
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.
Problem
Table.searchstored and returned shallow copies of the documentlist (
docs[:]). TheDocumentobjects inside the cache and thelist returned to the caller were therefore the same objects.
Mutating a nested mutable value (e.g. appending to a list field) in a
returned document silently corrupted the cached results, causing
subsequent identical searches to return wrong data.
Minimal reproduction:
This was reported in issue #516.
Fix
Use
copy.deepcopywhen writing to and reading from_query_cache, so cached entries and returned results are fullyindependent. The change is two lines in
Table.search:Tests
A new test
test_query_cache_not_corrupted_by_mutationis addedalongside the existing
test_query_cache. All 217 tests pass.