Skip to content

fix: prevent infinite recursion when SchemaMismatch for other reasons#493

Open
cnjsstong wants to merge 1 commit intomilvus-io:mainfrom
cnjsstong:patch-1
Open

fix: prevent infinite recursion when SchemaMismatch for other reasons#493
cnjsstong wants to merge 1 commit intomilvus-io:mainfrom
cnjsstong:patch-1

Conversation

@cnjsstong
Copy link
Contributor

If insert/upsert ends up with SchemaMismatch for some reason other than cached collection description, this method will be trapped in an infinite recursion, and finally crash with OOM.

In my case, if my project was bundled with ncc, the grpc part would be somehow corrupted.

@sre-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: cnjsstong

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist
Copy link

Summary of Changes

Hello @cnjsstong, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical bug in the _insert method where a SchemaMismatch error, if not caused by an outdated collection cache, could lead to an infinite recursion and eventual Out Of Memory crash. The changes introduce a mechanism to control collection caching during insert/upsert operations and refine the error handling logic to prevent repeated retries when the cache is not the root cause of the schema mismatch, ensuring stability and preventing resource exhaustion.

Highlights

  • Prevented Infinite Recursion: Modified the _insert method to prevent an infinite recursion loop when a SchemaMismatch error occurs for reasons other than an outdated collection cache, which previously could lead to an Out Of Memory (OOM) crash.
  • Introduced Cache Control: Added a new collection_cache boolean parameter to the private _insert method, allowing explicit control over whether collection information is fetched from cache during insert/upsert operations.
  • Refined Schema Mismatch Handling: The retry logic for SchemaMismatch errors now conditionally re-attempts the insert/upsert with caching disabled only if the initial attempt was made with caching enabled, effectively breaking the recursion for non-cache-related schema mismatches.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses a potential infinite recursion issue within the _insert method. When a SchemaMismatch error occurs for reasons other than a stale cache, the previous implementation could lead to an endless loop. The fix introduces a collection_cache parameter to control cache usage during insertion and ensures that a retry is attempted only once with the cache disabled. This is a solid approach that effectively prevents the infinite recursion. My review includes a minor suggestion to improve code clarity in the recursive call.

promise = await this._insert(data, upsert);
if (promise.status.error_code === ErrorCode.SchemaMismatch && collection_cache) {
// redo the insert request with collection cache off
promise = this._insert(data, upsert, false);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better code clarity and to maintain type consistency for the promise variable, it would be better to await the result of the recursive call to _insert. While returning the promise directly works, awaiting it makes the flow more explicit and easier to follow, ensuring that the promise variable consistently holds a MutationResult object rather than switching between MutationResult and Promise<MutationResult>.

Suggested change
promise = this._insert(data, upsert, false);
promise = await this._insert(data, upsert, false);

@shanghaikid
Copy link
Contributor

I think you can use skip_check_schema to skip the check.

await client.insert({
...,
 skip_check_schema: true
})

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants