Replace json.loads with ast.literal_eval

[TamiTakamiya]

Description

This was found an issue while testing with llama-stack 0.2.16.

The logic for supporting referenced documents in streaming mode (#183) had an issue. When an empty metadata is included, the knowledge search log includes strings like:

'source': None,

the logic attempts to convert this to JSON syntax by replacing double quotes to single ones, but

"source": None,

is not correct in JSON syntax (None should be replaced with null).

I will resolve this issue by using ast.literal_eval() instead of json.loads(), which is currently used.

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Related Tickets & Documents

• Related Issue # n/a
• Closes # n/a

Checklist before requesting a review

• I have performed a self-review of my code.
• PR has passed all pre-merge test jobs.
• If it is a core feature, I have added thorough tests.

Testing

• Please provide detailed steps to perform tests related to this code change.
• How were the fix/results from this change verified? Please provide relevant screenshots or results.

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of metadata parsing in streaming queries to reduce errors and enhance reliability.

• Tests

  • Updated test data for knowledge search results to include an additional metadata field for more comprehensive coverage.

[coderabbitai]

Walkthrough

The changes update the metadata parsing logic in the streaming query endpoint to use ast.literal_eval instead of json.loads, broadening the exception handling and updating related debug messages. Additionally, test data in the unit tests is modified to include a new 'source': None key in the metadata dictionaries.

Changes

Cohort / File(s)	Change Summary
Endpoint Metadata Parsing src/app/endpoints/streaming_query.py	Switched metadata parsing from json.loads to ast.literal_eval, broadened exception handling to all exceptions, and updated debug log messages accordingly.
Test Data Update tests/unit/app/endpoints/test_streaming_query.py	Added 'source': None to metadata dictionaries in the test data constant SAMPLE_KNOWLEDGE_SEARCH_RESULTS. No test logic or control flow changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

In a warren of code, where the data streams flow,
A rabbit found parsing with ast was the way to go.
With source keys added and errors caught wide,
The tests now hop forward, with nothing to hide.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4baac29 and 5aa3876.

📒 Files selected for processing (2)

• src/app/endpoints/streaming_query.py (2 hunks)
• tests/unit/app/endpoints/test_streaming_query.py (1 hunks)

🔇 Additional comments (3)

src/app/endpoints/streaming_query.py (2)

3-3: LGTM: Import addition is correct.

The ast module import is appropriately added to support the new ast.literal_eval functionality.

---

364-372: Excellent fix for the metadata parsing issue.

The change from json.loads(match.replace("'", '"')) to ast.literal_eval(match) correctly addresses the bug where None values in metadata cause parsing failures. This approach:

• Eliminates the fragile quote replacement logic
• Properly handles Python literals including None
• Maintains security (ast.literal_eval is actually safer than json.loads)
• Uses appropriate broad exception handling since ast.literal_eval can raise various exception types

tests/unit/app/endpoints/test_streaming_query.py (1)

58-59: Good test data alignment with the fix.

Adding 'source': None to the test metadata properly reflects the real-world scenario that was causing the original parsing issue. This ensures the tests validate the ast.literal_eval fix handles None values correctly.

Also applies to: 63-64, 72-73

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch TamiTakamiya/replace-json-loads-with-ast-literal_eval

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[manstis]

LGTM 👍

Ah, the sweet smell of (llama-stack) breaking changes.