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

balancer: fix SubConn embedding requirement to not recommend a nil panic hazard #7840

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

dfawley
Copy link
Member

@dfawley dfawley commented Nov 13, 2024

I deleted the release notes from #7758 and updated them here.

RELEASE NOTES:

  • balancer: An internal method is added to the balancer.SubConn interface to force implementors to embed a delegate implementation. This requirement is present in the interface documentation, but wasn't enforced earlier.

@dfawley dfawley added the Type: API Change Breaking API changes (experimental APIs only!) label Nov 13, 2024
@dfawley dfawley added this to the 1.69 Release milestone Nov 13, 2024
@dfawley dfawley requested review from easwars and arjan-bal November 13, 2024 23:15
Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.95%. Comparing base (a365199) to head (d69ef1c).
Report is 9 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7840      +/-   ##
==========================================
+ Coverage   81.86%   81.95%   +0.09%     
==========================================
  Files         374      375       +1     
  Lines       37978    37993      +15     
==========================================
+ Hits        31089    31138      +49     
+ Misses       5587     5565      -22     
+ Partials     1302     1290      -12     
Files with missing lines Coverage Δ
balancer/balancer.go 96.29% <ø> (-0.48%) ⬇️
balancer/subconn.go 100.00% <100.00%> (ø)
balancer_wrapper.go 84.55% <ø> (ø)

... and 19 files with indirect coverage changes

---- 🚨 Try these New Features:

Copy link
Contributor

@arjan-bal arjan-bal left a comment

Choose a reason for hiding this comment

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

vet is requesting adding godoc for the NoOpSubConn methods. One small comment about embedding in test SubConns, otherwise LGTM.

@arjan-bal arjan-bal assigned dfawley and unassigned arjan-bal Nov 14, 2024
@dfawley
Copy link
Member Author

dfawley commented Nov 15, 2024

I have removed NopSubConn and rewrote things in the SubConn documentation for clarity and to remove some redundancy.

Thinking about it, if a user is writing their own LB policy and needs a fake SubConn for testing, then they can safely implement only the methods they know their policy calls and embed a nil SubConn interface.

@easwars easwars removed their assignment Nov 19, 2024
@dfawley dfawley merged commit 3244606 into grpc:master Nov 19, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: API Change Breaking API changes (experimental APIs only!)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants