Backport PR #2598 to release/v1.7 for Bugfix NGT flush logic

[vdaas-ci]

Description

If a CRUD operation such as insert is executed again after flush, a nil pointer error occurred.
Initialize with the RegenerateIndexes function, but do not rewrite the receiver. So I changed that the field is override.

Related Issue

Versions

• Vald Version: v1.7.13
• Go Version: v1.23.0
• Rust Version: v1.80.0
• Docker Version: v27.1.1
• Kubernetes Version: v1.30.3
• Helm Version: v3.15.3
• NGT Version: v2.2.4
• Faiss Version: v1.8.0

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

Summary by CodeRabbit

• Bug Fixes

  • Adjusted the logic for directory deletion based on the memory state, ensuring proper handling when the inMem flag is false.
  • Enhanced checks in key methods to prevent nil pointer dereferences, ensuring valid lengths are returned only when the instance is in a proper state.
  • Improved error handling in index creation methods to provide clearer feedback when flushing is in progress.

• New Features

  • Introduced a new method for copying ngt instances, enhancing state duplication.
  • Added a method for loading index statistics, promoting better organization of the code.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	7efd16c
Status:	✅  Deploy successful!
Preview URL:	https://6c4ca025.vald.pages.dev
Branch Preview URL:	https://backport-release-v1-7-fix-ng.vald.pages.dev

View logs

[coderabbitai]

Walkthrough

Walkthrough

The changes in this pull request enhance error handling and functionality within the ngt struct and its associated methods. Key modifications include improved error handling for index creation processes, the introduction of a method to copy internal states, and additional checks to prevent operations during flushing. The refactoring of certain methods promotes better modularity and clarity in control flow, while new getter methods ensure robust value retrieval.

Changes

File Path	Change Summary
pkg/agent/core/ngt/handler/grpc/index.go	Enhanced error handling in CreateIndex and CreateAndSaveIndex methods for flushing state.
pkg/agent/core/ngt/service/ngt.go	Added copyNGT method, modified Start, RegenerateIndexes, and CreateIndex for robustness, and introduced loadStatistics method. Updated several getter methods for nil checks.

Possibly related PRs

• Bugfix NGT flush logic #2598: Modifies error handling logic in CreateIndex and CreateAndSaveIndex methods, addressing the flushing condition relevant to this PR.

Suggested labels

actions/backport/release/v1.7, area/agent/core/ngt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[codecov]

Codecov Report

Attention: Patch coverage is 28.20513% with 28 lines in your changes missing coverage. Please review.

Please upload report for BASE (release/v1.7@626873f). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
pkg/agent/core/ngt/service/ngt.go	33.33%	22 Missing ⚠️
pkg/agent/core/ngt/handler/grpc/index.go	0.00%	6 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff               @@
##             release/v1.7    #2606   +/-   ##
===============================================
  Coverage                ?   24.38%           
===============================================
  Files                   ?      531           
  Lines                   ?    45850           
  Branches                ?        0           
===============================================
  Hits                    ?    11179           
  Misses                  ?    33923           
  Partials                ?      748           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.