feat: return data_source_info and data_source_detail_dict - #23
Conversation
| "position": document.position, | ||
| "data_source_type": document.data_source_type, | ||
| "data_source_info": data_source_info, | ||
| "data_source_info": document.data_source_info_dict, |
There was a problem hiding this comment.
Bug: The data_source_info field is populated with different data sources (data_source_detail_dict vs data_source_info_dict) depending on the metadata parameter, causing an inconsistent API response.
Severity: HIGH
Suggested Fix
To ensure a consistent API response, modify line 791 in api/controllers/console/datasets/datasets_document.py. Change "data_source_info": document.data_source_info_dict to "data_source_info": document.data_source_detail_dict. This will align the behavior for metadata="all" with the metadata="without" case and the service API implementation.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: api/controllers/console/datasets/datasets_document.py#L791
Potential issue: The `DocumentApi.get()` method populates the `data_source_info` field
in the API response inconsistently based on the `metadata` parameter. When `metadata` is
`"without"`, the field is assigned the value from `document.data_source_detail_dict`
(which contains enriched data). However, when `metadata` is `"all"`, the field is
assigned the value from `document.data_source_info_dict` (which contains raw data). This
discrepancy, located at line 791, contrasts with the service API's behavior, which
consistently uses `data_source_detail_dict`. This will cause the API to return different
data structures for the same field, potentially breaking client-side applications that
expect a consistent response format.
Did we get this right? 👍 / 👎 to inform future reviews.
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.
Benchmark PR from qodo-benchmark#179