Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport PR #2811 to release/v1.7 for add Search_Config validation #2817

Conversation

vdaas-ci
Copy link
Collaborator

Description

Search_Config is required field for Search request.
However, it might be forget to set a Search_Config value, unintentionally.
Add Search_Config validation gateway and return error response from it.

Related Issue

Versions

  • Vald Version: v1.7.15
  • Go Version: v1.23.4
  • Rust Version: v1.83.0
  • Docker Version: v27.4.0
  • Kubernetes Version: v1.32.0
  • Helm Version: v3.16.3
  • NGT Version: v2.3.5
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • New Features

    • Introduced a new error variable ErrInvalidSearchConfig to handle invalid search configuration scenarios.
    • Added a new configuration field in search requests to allow for more detailed specifications.
  • Bug Fixes

    • Enhanced error handling in search-related functions to prevent potential nil configuration issues.
    • Added robust checks to prevent unexpected behavior when search configuration is not provided.
  • Improvements

    • Improved error tracing and context for search configuration validation.
    • Strengthened error handling mechanisms in search-related methods.

* add Search_Config validation

* change to error function and generate individual errors

* add search configuration
Copy link

cloudflare-workers-and-pages bot commented Jan 29, 2025

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: f1cfea5
Status: ✅  Deploy successful!
Preview URL: https://a1cd8950.vald.pages.dev
Branch Preview URL: https://backport-release-v1-7-bugfix-6149.vald.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

📝 Walkthrough

Walkthrough

This pull request introduces enhanced error handling and configuration management across multiple components. A new error variable ErrInvalidSearchConfig is added to the errors package, which is then utilized in load balancer and gateway handler functions to validate search configurations. Additionally, the load testing service's search request configuration is expanded with default parameters, providing more structured configuration options.

Changes

File Change Summary
internal/errors/lb.go Added ErrInvalidSearchConfig error function for invalid search configurations
pkg/gateway/lb/handler/grpc/aggregation.go Added nil check for base configuration with error handling
pkg/gateway/lb/handler/grpc/handler.go Enhanced doSearch method with configuration validation and error tracing
pkg/tools/cli/loadtest/service/search.go Added Config field to Search_Request with default parameters

Sequence Diagram

sequenceDiagram
    participant Client
    participant Handler
    participant ErrorHandler
    
    Client->>Handler: Search Request
    Handler->>Handler: Validate Configuration
    alt Invalid Configuration
        Handler->>ErrorHandler: Generate ErrInvalidSearchConfig
        ErrorHandler-->>Handler: Return Error
        Handler-->>Client: Return Error
    else Valid Configuration
        Handler->>Handler: Process Search
        Handler-->>Client: Return Search Results
    end
Loading

Possibly related PRs

Suggested labels

type/bug, priority/medium, size/M, area/gateway/lb, area/internal, area/tools/cli/loadtest

Suggested reviewers

  • vankichi
  • hlts2
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
🪧 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.
    • 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 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
pkg/tools/cli/loadtest/service/search.go (1)

37-41: Consider documenting the default Search_Config values.

While the default values (Num=10, Radius=-1, Epsilon=0.1) seem reasonable, adding comments explaining their significance and why these specific values were chosen would improve maintainability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 400e5ba and d207eeb.

📒 Files selected for processing (4)
  • internal/errors/lb.go (1 hunks)
  • pkg/gateway/lb/handler/grpc/aggregation.go (1 hunks)
  • pkg/gateway/lb/handler/grpc/handler.go (1 hunks)
  • pkg/tools/cli/loadtest/service/search.go (1 hunks)
🔇 Additional comments (3)
internal/errors/lb.go (1)

28-32: LGTM! Well-structured error handling implementation.

The new ErrInvalidSearchConfig error function follows the package's error handling pattern and provides clear error messages.

pkg/gateway/lb/handler/grpc/aggregation.go (1)

68-71: LGTM! Good placement of validation check.

The nil check for bcfg is well-placed at the start of the function for early error detection. The error handling is consistent with the package's patterns.

pkg/gateway/lb/handler/grpc/handler.go (1)

441-461: LGTM! Comprehensive error handling with proper tracing.

The validation for nil Search_Config is well-implemented with:

  • Detailed error message
  • Proper error wrapping with BadRequest details
  • Consistent tracing and span handling

@vdaas-ci
Copy link
Collaborator Author

[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

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

Attention: Patch coverage is 0% with 31 lines in your changes missing coverage. Please review.

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

Files with missing lines Patch % Lines
pkg/gateway/lb/handler/grpc/handler.go 0.00% 20 Missing ⚠️
pkg/tools/cli/loadtest/service/search.go 0.00% 5 Missing ⚠️
internal/errors/lb.go 0.00% 3 Missing ⚠️
pkg/gateway/lb/handler/grpc/aggregation.go 0.00% 3 Missing ⚠️
Additional details and impacted files
@@               Coverage Diff               @@
##             release/v1.7    #2817   +/-   ##
===============================================
  Coverage                ?   23.91%           
===============================================
  Files                   ?      547           
  Lines                   ?    54586           
  Branches                ?        0           
===============================================
  Hits                    ?    13052           
  Misses                  ?    40749           
  Partials                ?      785           

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

@vankichi vankichi merged commit 220a33f into release/v1.7 Jan 31, 2025
138 of 142 checks passed
@vankichi vankichi deleted the backport/release/v1.7/bugfix/grpc/panic-caused-with-nil-search-config branch January 31, 2025 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants