fix: copy include list before mutating in get/query#7109
Open
rmotgi1227 wants to merge 1 commit into
Open
Conversation
_validate_and_prepare_get_request and _validate_and_prepare_query_request
both assigned request_include = include (a reference) and then called
request_include.append('uris'). This mutated the caller's list in place,
so passing the same include list to multiple calls would accumulate 'uris'
entries and cause unexpected behaviour on repeated calls.
Fix: request_include = list(include) makes a shallow copy so the original
is never modified.
Fixes chroma-core#5857
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
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.
If you pass the same
includelist to multiplecollection.query()orcollection.get()calls, the list gets"uris"appended to it on the first call and stays mutated for all subsequent calls. Depending on how many times you call it you can end up with duplicate entries which then fails validation.Root cause:
_validate_and_prepare_get_requestand_validate_and_prepare_query_requestboth dorequest_include = include(a reference, not a copy) before callingrequest_include.append("uris").Fix is
request_include = list(include)in both places — one line each.Fixes #5857