grpc: Canonicalize string returned by ClientConn.Target() and resolver.Address.String() #6923
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #6923 +/- ##
==========================================
- Coverage 83.51% 82.34% -1.18%
==========================================
Files 287 296 +9
Lines 30920 31453 +533
==========================================
+ Hits 25824 25900 +76
- Misses 4020 4491 +471
+ Partials 1076 1062 -14
|
|
Discussed offline; currently adding more test cases (and made a t-test) |
dfawley
added
Type: Behavior Change
dfawley
changed the title
|
Change LGTM; let me know when you add more tests. |
|
Added a t-test. |
dfawley
reviewed
Feb 5, 2024
clientconn.go
Outdated
| @@ -883,14 +883,14 @@ func (cc *ClientConn) channelzMetric() *channelz.ChannelInternalMetric { | |||
| } | |||
| } | |||
|
|
|||
| // Target returns the target string of the ClientConn. | |||
| // Target returns the canonicalized target string of the ClientConn. | |||
There was a problem hiding this comment.
Let's use "canonical" since "canonicalize" isn't a word.
Target returns the canonical target string...
resolver/resolver.go
Outdated
| @@ -283,7 +283,7 @@ func (t Target) Endpoint() string { | |||
|
|
|||
| // String returns a string representation of Target. | |||
clientconn_test.go
Outdated
Comment on lines
827
to
831
| { | ||
| name: "canonicalized-target-nonexistent", | ||
| addr: "nonexist:///non.existent", | ||
| targetWant: "passthrough:///nonexist:///non.existent", | ||
| }, |
There was a problem hiding this comment.
Also test dns:hostname:port->dns:///hostname:port.
dfawley
approved these changes
Feb 15, 2024
resolver/resolver.go
Outdated
| @@ -281,9 +281,9 @@ func (t Target) Endpoint() string { | |||
| return strings.TrimPrefix(endpoint, "/") | |||
| } | |||
|
|
|||
| // String returns a string representation of Target. | |||
| // String returns a canonical string representation of Target. | |||
There was a problem hiding this comment.
Super nit: "the canonical", please... there is only one canonical version of something.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR canoncializes the string returned from Target() on the ClientConn. This is a behavior change, but ok because API is marked experimental.
RELEASE NOTES: