Skip to content

fix: fix grpc document, image, inference object without options conversion#1052

Merged
joein merged 1 commit into
devfrom
fix-document-conversion
Jul 31, 2025
Merged

fix: fix grpc document, image, inference object without options conversion#1052
joein merged 1 commit into
devfrom
fix-document-conversion

Conversation

@joein
Copy link
Copy Markdown
Member

@joein joein commented Jul 31, 2025

conversion of inference objects was broken when options=None
tests did not catch it, because we do conversions from grpc to rest and then from rest to grpc, which was working fine because after the first conversion we were loosing None in favour of an empty dict

@netlify
Copy link
Copy Markdown

netlify Bot commented Jul 31, 2025 •
edited
Loading

✅ Deploy Preview for poetic-froyo-8baba7 ready!

Name Link
🔨 Latest commit c107bbc
🔍 Latest deploy log https://app.netlify.com/projects/poetic-froyo-8baba7/deploys/688ba50bab57560008678265
😎 Deploy Preview https://deploy-preview-1052--poetic-froyo-8baba7.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 31, 2025

📝 Walkthrough

Walkthrough

The RestToGrpc class in qdrant_client/conversions/conversion.py was updated so that the convert_document, convert_image, and convert_inference_object methods now check if the options attribute is not None before converting it. If options is None, the corresponding gRPC message's options field is set to None. Additionally, a new test, test_inference_without_options, was added to tests/conversions/test_validate_conversions.py to verify that conversions work correctly when the options field is omitted, ensuring the attribute is handled as an empty dictionary after round-trip conversion.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

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 1a63b86 and c107bbc.

📒 Files selected for processing (2)
  • qdrant_client/conversions/conversion.py (1 hunks)
  • tests/conversions/test_validate_conversions.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
  • GitHub Check: Redirect rules - poetic-froyo-8baba7
  • GitHub Check: Header rules - poetic-froyo-8baba7
  • GitHub Check: Pages changed - poetic-froyo-8baba7
  • GitHub Check: Python 3.13.x on ubuntu-latest test
  • GitHub Check: Python 3.9.x on ubuntu-latest test
  • GitHub Check: Python 3.12.x on ubuntu-latest test
  • GitHub Check: Python 3.11.x on ubuntu-latest test
  • GitHub Check: Python 3.10.x on ubuntu-latest test
🔇 Additional comments (4)
qdrant_client/conversions/conversion.py (3)

3486-3491: LGTM! Proper null safety for options conversion.

The conditional check for model.options is not None correctly prevents errors when the options field is None, addressing the core issue described in the PR objectives.

3494-3499: LGTM! Consistent null safety implementation.

The conditional options conversion matches the pattern used in convert_document and properly handles the None case to prevent conversion errors.

3502-3507: LGTM! Completes the consistent fix across all inference object conversion methods.

The conditional options conversion ensures all three methods (convert_document, convert_image, and convert_inference_object) handle None options consistently, fully addressing the conversion issue described in the PR.

tests/conversions/test_validate_conversions.py (1)

508-526: Excellent test coverage for the options conversion bug.

This test effectively addresses the core issue described in the PR objectives. The test correctly:

  1. Creates model instances without specifying options (simulating the None case)
  2. Performs the problematic REST→gRPC conversion that was previously broken
  3. Completes the round-trip conversion back to REST
  4. Validates that options is properly initialized as an empty dictionary

The test design is particularly valuable because it would have caught the original bug where conversions failed when options was None, and it ensures the fix works correctly for all three affected model types.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-document-conversion

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
🪧 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.

@joein joein requested a review from generall July 31, 2025 17:37
@joein joein merged commit e4c7bfa into dev Jul 31, 2025
14 checks passed
joein added a commit that referenced this pull request Jul 31, 2025
@joein
fix: fix grpc document, image, inference object without options conve…
755d788 
…rsion (#1052)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@generall generall generall approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@joein @generall