Refactor gRPC pool connection management

[kpango]

Description

This pull request includes changes to the internal/net/grpc package to enhance the gRPC client and pool configuration options, as well as a minor logging level adjustment in the test configuration. The most important changes include adding context support to the Disconnect method, refining the pool option configuration, and updating the logging level in the test assets.

Enhancements to gRPC client and pool configuration:

• internal/net/grpc/client.go: Modified the Disconnect method in the gRPCClient struct to accept a context parameter for better control over the disconnection process.
• internal/net/grpc/pool/option.go: Added new functional options for configuring the pool, including WithAddr, WithHost, WithPort, WithStartPort, WithEndPort, WithResolveDNS, WithBackoff, WithSize, WithDialOptions, WithDialTimeout, WithOldConnCloseDelay, and WithErrGroup. This refactor improves readability and flexibility in configuring the pool.

Test configuration update:

• tests/v2/e2e/assets/unary_crud.yaml: Changed the logging level from info to debug to provide more detailed logs during end-to-end tests.

Related Issue

Versions

• Vald Version: v1.7.16
• Go Version: v1.24.0
• Rust Version: v1.84.1
• 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

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (3)

• main
• master
• release/*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

• 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>, 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.
• @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

[kpango]

@coderabbitai full-review

[coderabbitai]

🧩 Analysis chain

CodeRabbitAI: Let me analyze the changes in this PR to provide a comprehensive review.

---

🏁 Script executed:

#!/bin/bash
# Get the files changed in the PR
git show --name-only

# Examine the specific changes to the key files mentioned in the PR description
git show -- internal/net/grpc/client.go internal/net/grpc/pool/option.go tests/v2/e2e/assets/unary_crud.yaml

# Look at the context of client.go to understand the Disconnect method changes
cat internal/net/grpc/client.go

Length of output: 77991

---

🏁 Script executed:

#!/bin/bash
# Get the diff for the key files mentioned in the PR description
git diff --unified=10 HEAD~1 internal/net/grpc/client.go
git diff --unified=10 HEAD~1 internal/net/grpc/pool/option.go
git diff --unified=10 HEAD~1 tests/v2/e2e/assets/unary_crud.yaml

# Find references to the Disconnect method to better understand usage context
grep -r "Disconnect" --include="*.go" internal/net/grpc/

Length of output: 2323

---

🏁 Script executed:

#!/bin/bash
# Get the diff for the specific files using the commit hash from the git show output
git diff e2d953892cae5b97bb1d7daa9833e8191698bb44^ e2d953892cae5b97bb1d7daa9833e8191698bb44 -- internal/net/grpc/client.go internal/net/grpc/pool/option.go tests/v2/e2e/assets/unary_crud.yaml

# Look at the current implementation of client.go and pool/option.go to understand the changes
head -n 100 internal/net/grpc/client.go
head -n 100 internal/net/grpc/pool/option.go
cat tests/v2/e2e/assets/unary_crud.yaml

Length of output: 18056

---

🏁 Script executed:

#!/bin/bash
# Let's try to get diffs using git show on the specific files
git show e2d953892cae5b97bb1d7daa9833e8191698bb44 -- internal/net/grpc/client.go
git show e2d953892cae5b97bb1d7daa9833e8191698bb44 -- internal/net/grpc/pool/option.go
git show e2d953892cae5b97bb1d7daa9833e8191698bb44 -- tests/v2/e2e/assets/unary_crud.yaml

# Let's also check how the Disconnect method is currently implemented
grep -A 15 "func (g \*gRPCClient) Disconnect" internal/net/grpc/client.go

Length of output: 52060

---

@kpango I've reviewed the changes in PR #2895 that refactor the gRPC pool connection management. Here's my assessment:

Positive Aspects

1. Context Support in Disconnect Method:

   • Adding context to the Disconnect method improves context propagation and enables proper cancellation and timeout handling
   • Well-integrated with observability through trace spans
   • Consistent error handling with proper context propagation

2. Enhanced Pool Configuration Options:

   • Excellent use of the functional options pattern for configuration
   • Comprehensive set of options (WithAddr, WithHost, WithPort, etc.) makes the pool highly configurable
   • Well-defined default options
   • Clear separation between different configuration concerns

3. General Code Quality:

   • Good error handling throughout
   • Clean implementation of trace spans for observability
   • Proper use of atomic operations for thread safety

Potential Considerations

1. Debug Logging in Tests:
   • Changing from info to debug in tests will generate more verbose logs
   • This provides more detail for troubleshooting but might make it harder to identify important information

Suggestions

1. Documentation:
   • Consider adding example usage in comments for the new pool options
   • Adding some brief descriptions about when to use specific options could help future users

The PR represents a solid enhancement to the gRPC client and pool configuration, following Go best practices and improving the flexibility of the connection management system.

✅ Actions performed

Full review triggered.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	e576570
Status:	✅  Deploy successful!
Preview URL:	https://b1918c61.vald.pages.dev
Branch Preview URL:	https://refactor-internal-grpc-pool.vald.pages.dev

View logs

[vdaas-ci]

[WARNING:INTCFG] Changes in interal/config may require you to change Helm charts. Please check.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.44%. Comparing base (18682c3) to head (e576570).

Additional details and impacted files

@@                                Coverage Diff                                 @@
##           refactor/test-e2e/add-v2-e2e-strategic-testing    #2895      +/-   ##
==================================================================================
+ Coverage                                           13.02%   17.44%   +4.41%     
==================================================================================
  Files                                                 128      130       +2     
  Lines                                               12761    14610    +1849     
==================================================================================
+ Hits                                                 1662     2548     +886     
- Misses                                              10934    11763     +829     
- Partials                                              165      299     +134     

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

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.