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

chore: do not set Endpoint and Headers for grpc #62

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

devnev
Copy link
Contributor

@devnev devnev commented Aug 16, 2024

Reason for This PR

As discussed in roadrunner-server/roadrunner#1848, otel packages can read a standardised set of environments, but only if values have not been overridden. In the previous PR addressing this, only the http client was updated. This PR updates the grpc client to match.

Description of Changes

Only set (and thus override) the endpoint and header options if they're actually set in the config.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • New Features

    • Enhanced conditional logic for configuring gRPC options, allowing for more flexible and meaningful configurations.
  • Bug Fixes

    • Prevented the addition of default or empty values to gRPC options, reducing potential misconfigurations.

This is applying the change from roadrunner-server#60 to the grpc client.
Copy link

coderabbitai bot commented Aug 16, 2024

Walkthrough

The updates to the grpcOptions function in plugin.go enhance the flexibility of gRPC configuration. By introducing checks for endpoint validity and header presence, the function now avoids appending empty values to the options array. This improvement ensures that only meaningful configurations are applied, enhancing robustness and preventing potential misconfigurations.

Changes

Files Change Summary
plugin.go Enhanced grpcOptions logic to conditionally append endpoint and headers based on validity checks.

Poem

🐰 In fields of code where options grow,
The rabbit hops with joy, you know!
No more empty strings to weigh us down,
Just valid configs, we wear the crown!
Let's cheer for changes, so neat and bright,
Hopping forth into the coding night! 🌙✨


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2c6862a and 6fe9082.

Files selected for processing (1)
  • plugin.go (1 hunks)
Additional comments not posted (1)
plugin.go (1)

190-197: LGTM! Verify the logic alignment with HTTP client configuration.

The changes ensure that the endpoint and headers are only appended to the gRPC options if they are explicitly set in the configuration. This aligns with the PR objectives and mirrors the behavior of the HTTP client.

To ensure consistency across the codebase, verify that similar logic is applied to the HTTP client configuration.

@rustatian rustatian added the enhancement New feature or request label Aug 16, 2024
@rustatian
Copy link
Member

Hey @devnev 👋
Thank you for the PR 👍

@rustatian rustatian self-requested a review August 16, 2024 10:15
Copy link
Member

@rustatian rustatian left a comment

Choose a reason for hiding this comment

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

LGTM

@rustatian rustatian merged commit b4dcac2 into roadrunner-server:master Aug 16, 2024
3 of 4 checks passed
@devnev devnev deleted the patch-1 branch August 16, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants