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

Revert GRPC context changes #15780

Merged

Conversation

dbussink
Copy link
Contributor

These changes were made assuming we could use grpc.NewClient everywhere. But we had failing test for that. In a specific case, we replace it with grpc.Dial but that's not the same.

If we can't move it all to grpc.NewClient yet, we have to keep the context setup we do as well, or otherwise grpc.Dial could hang indefinitely even if the caller context is cancelled since it gets started with the background context.

Related Issue(s)

Broken #15743

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

These changes were made assuming we could use `grpc.NewClient`
everywhere. But we had failing test for that. In a specific case, we
replace it with `grpc.Dial` but that's not the same.

If we can't move it all to `grpc.NewClient` yet, we have to keep the
context setup we do as well, or otherwise `grpc.Dial` could hang
indefinitely even if the caller context is cancelled since it gets
started with the background context.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Copy link
Contributor

vitess-bot bot commented Apr 23, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Apr 23, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 23, 2024
Copy link

codecov bot commented Apr 23, 2024

Codecov Report

Attention: Patch coverage is 84.61538% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 68.41%. Comparing base (a89b2cb) to head (4736a0e).
Report is 1 commits behind head on main.

Files Patch % Lines
go/vt/vtgate/grpcvtgateconn/conn.go 66.66% 2 Missing ⚠️
go/vt/vtgate/fakerpcvtgateconn/conn.go 0.00% 1 Missing ⚠️
go/vtbench/client.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15780      +/-   ##
==========================================
- Coverage   68.43%   68.41%   -0.03%     
==========================================
  Files        1556     1556              
  Lines      195433   195437       +4     
==========================================
- Hits       133743   133700      -43     
- Misses      61690    61737      +47     

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

@dbussink dbussink added Type: Bug Component: General Changes throughout the code base Type: Dependencies Dependency updates and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 23, 2024
@dbussink dbussink merged commit 07858c2 into vitessio:main Apr 23, 2024
112 of 117 checks passed
@dbussink dbussink deleted the dbussink/revert-grpc-context-changes branch April 23, 2024 08:11
dbussink added a commit to planetscale/vitess that referenced this pull request Apr 23, 2024
The change in vitessio#15780 made me
audit the rest of the places where we dial with GRPC today where we
don't pass in a context yet. This is something we should do, since the
Dial can block otherwise indefinitely even on context cancel in
the caller.

This fixes those cases and even cleans up a TODO that mentioned this
needed to be done in a specific spot.

Once we move to grpc.NewClient in a more piecemeal fashion, we can
probably clean up / undo a lot of these cases but until then we should
do this properly with a context passed in.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: General Changes throughout the code base Type: Bug Type: Dependencies Dependency updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants