add Search_Config validation #2811

kmrmt · 2025-01-23T09:32:49Z

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

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

New Features
- Added a new error variable ErrNilSearch_Config to handle nil search configuration scenarios
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

coderabbitai · 2025-01-23T09:32:57Z

📝 Walkthrough

Walkthrough

This pull request introduces a new error variable ErrNilSearch_Config in the internal/errors/lb.go file and adds corresponding nil configuration checks in multiple gateway load balancing handler files. The changes enhance error handling by explicitly checking for nil search configurations in the aggregationSearch and doSearch methods, preventing potential runtime errors and providing more explicit error feedback when configurations are missing.

Changes

File	Change Summary
`internal/errors/lb.go`	Added new error variable `ErrNilSearch_Config`
`pkg/gateway/lb/handler/grpc/aggregation.go`	Added nil check for `bcfg`, returning `errors.ErrNilSearch_Config` if nil
`pkg/gateway/lb/handler/grpc/handler.go`	Enhanced `doSearch` method with nil configuration error handling, wrapping `ErrNilSearch_Config` with additional context

Sequence Diagram

sequenceDiagram
    participant Caller
    participant Handler
    participant ErrorHandling

    Caller->>Handler: Call with search configuration
    alt Nil Configuration
        Handler->>ErrorHandling: Check configuration
        ErrorHandling-->>Handler: Return ErrNilSearch_Config
        Handler-->>Caller: Return error
    else Valid Configuration
        Handler->>Handler: Proceed with search
    end

Possibly related PRs

Fix gRPC error msg handling for lb-gateway handler #2663: The changes in this PR enhance error handling in the doSearch method by checking for a nil configuration and returning errors.ErrNilSearch_Config

Suggested labels

type/refactoring

Suggested reviewers

hlts2
kpango

📜 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 ecd6ed2 and 434d801.

📒 Files selected for processing (3)

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

⏰ Context from checks skipped due to timeout of 90000ms (30)

GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build
GitHub Check: Run tests for pkg packages
GitHub Check: coverage
GitHub Check: runner / go build

🔇 Additional comments (3)

internal/errors/lb.go (1)

28-30: LGTM! The new error variable follows the established pattern.

The addition of ErrNilSearch_Config is well-documented and follows the existing error variable pattern in the codebase.

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

68-71: LGTM! Early validation prevents nil pointer dereference.

The nil check for bcfg is well-placed at the start of the function and prevents potential runtime errors by failing fast.

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

441-461: LGTM! Comprehensive error handling for nil configuration.

The nil check for cfg includes detailed error information and proper error wrapping, following the established error handling patterns in the codebase.

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

cloudflare-workers-and-pages · 2025-01-23T09:33:10Z

Deploying vald with Cloudflare Pages

Latest commit:	`434d801`
Status:	✅ Deploy successful!
Preview URL:	https://461898ac.vald.pages.dev
Branch Preview URL:	https://bugfix-grpc-panic-caused-wit.vald.pages.dev

View logs

vdaas-ci · 2025-01-23T09:33:11Z

[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 · 2025-01-23T09:54:26Z

Codecov Report

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

Project coverage is 23.93%. Comparing base (6065fd9) to head (434d801).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/gateway/lb/handler/grpc/handler.go	0.00%	20 Missing ⚠️
pkg/gateway/lb/handler/grpc/aggregation.go	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2811      +/-   ##
==========================================
- Coverage   23.93%   23.93%   -0.01%     
==========================================
  Files         546      546              
  Lines       54555    54578      +23     
==========================================
+ Hits        13058    13063       +5     
- Misses      40712    40731      +19     
+ Partials      785      784       -1

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

vdaas-ci · 2025-01-23T12:05:46Z

Profile Report

type	vald-agent-ngt	vald-lb-gateway	vald-discoverer	vald-manager-index
cpu
heap

other images

add Search_Config validation

434d801

kmrmt force-pushed the bugfix/grpc/panic-caused-with-nil-search-config branch from eb8e500 to 434d801 Compare January 23, 2025 09:33

github-actions bot added area/internal area/gateway/lb size/S type/bug Something isn't working priority/medium labels Jan 23, 2025

coderabbitai bot approved these changes Jan 23, 2025

View reviewed changes

kmrmt requested review from a team, kpango and vankichi and removed request for a team January 23, 2025 11:56

kmrmt added actions/backport/release/v1.7 actions/e2e-deploy actions/e2e-chaos actions/e2e-profiling actions/e2e-max-dim labels Jan 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add Search_Config validation #2811

add Search_Config validation #2811

kmrmt commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

cloudflare-workers-and-pages bot commented Jan 23, 2025 •

edited

Loading

vdaas-ci commented Jan 23, 2025

codecov bot commented Jan 23, 2025

vdaas-ci commented Jan 23, 2025

add Search_Config validation #2811

Are you sure you want to change the base?

add Search_Config validation #2811

Conversation

kmrmt commented Jan 23, 2025 • edited by coderabbitai bot Loading

Description

Related Issue

Versions

Checklist

Special notes for your reviewer

Summary by CodeRabbit

coderabbitai bot commented Jan 23, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

cloudflare-workers-and-pages bot commented Jan 23, 2025 • edited Loading

Deploying vald with Cloudflare Pages

vdaas-ci commented Jan 23, 2025

codecov bot commented Jan 23, 2025

Codecov Report

vdaas-ci commented Jan 23, 2025

Profile Report

kmrmt commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

cloudflare-workers-and-pages bot commented Jan 23, 2025 •

edited

Loading