all: use net.JoinHostPort instead of fmt.Sprintf #388
Merged
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
|
|
|
I tried to run the tests on my Mac and got the following error, which could be related to my change but I can't tell. |
| @@ -107,7 +108,7 @@ func newIntegrationClientServer( | |||
| }() | |||
|
|
|||
| httpURL := fmt.Sprintf("https://localhost:%d/hello", httpPort) | |||
There was a problem hiding this comment.
I mean you could do e.g. := "https://"+net.JoinHostPort("localhost", strconv.Itoa(httpPort)) + "/hello" but it obscures the URL a bit too much for me in terms of a readability vs. fit for purpose tradeoff.
There was a problem hiding this comment.
I think this is fine as-is.
There was a problem hiding this comment.
OK - I left as is so I think we are golden.
charleskorn
previously approved these changes
Sep 27, 2023
| @@ -107,7 +108,7 @@ func newIntegrationClientServer( | |||
| }() | |||
|
|
|||
| httpURL := fmt.Sprintf("https://localhost:%d/hello", httpPort) | |||
There was a problem hiding this comment.
I think this is fine as-is.
I don't get the same failure when running these changes on my machine (also a Mac) - does the test consistently fail for you in the same way? |
charleskorn
reviewed
Sep 27, 2023
Yes, I'll open a new ticket. |
charleskorn
reviewed
Sep 27, 2023
|
apologies - I will update shortly |
kevinburkesegment
force-pushed
the
join-host-port
branch
2 times, most recently
from
ee70bd0
to
d3dae63
Compare
|
OK, I've added a changelog entry and double checked the rest of the PR comments - I think this is ready for another look. |
charleskorn
reviewed
Oct 9, 2023
CHANGELOG.md
Outdated
| @@ -147,6 +147,7 @@ | |||
| * [ENHANCEMENT] server: clarify documentation for `-server.grpc-max-concurrent-streams` CLI flag. #369 | |||
| * [ENHANCEMENT] Ring: Add ID attribute to `InstanceDesc` for ring members. #387 | |||
| * [ENHANCEMENT] httpgrpc, grpcutil: added constants and functions for adding request details into outgoing grpc metadata. #391 | |||
| * [ENHANCEMENT] Use `net.JoinHostPort` instead of `fmt.Sprintf` to concatenate host and port throughout the codebase to ensure ipv6 compatibility for provided hosts. #388 | |||
There was a problem hiding this comment.
I'd rephrase this to focus on the outcome, not the mechanism we use to achieve it, and I think this can be classified as a bug fix rather than an enhancement (in which case, it should be moved to the end of the list):
Suggested change
| * [ENHANCEMENT] Use `net.JoinHostPort` instead of `fmt.Sprintf` to concatenate host and port throughout the codebase to ensure ipv6 compatibility for provided hosts. #388 | |
| * [BUGFIX] Correctly format `host:port` addresses when using IPv6. #388 |
auto-merge was automatically disabled
October 9, 2023 05:06
Head branch was pushed to by a user without write access
kevinburkesegment
force-pushed
the
join-host-port
branch
from
325bbda
to
c2130c6
Compare
charleskorn
reviewed
Oct 9, 2023
CHANGELOG.md
Outdated
| @@ -1,5 +1,6 @@ | |||
| ## Changelog | |||
|
|
|||
| port throughout the codebase. | |||
There was a problem hiding this comment.
Looks like this line was left behind 😬
There was a problem hiding this comment.
Ugh, not sure how I missed that one.
kevinburkesegment
force-pushed
the
join-host-port
branch
from
c2130c6
to
ea40743
Compare
This will ensure ipv6 compatibility for provided hosts, and this method should also be faster than the general purpose fmt.Sprintf, which must first parse the input string. Fixes grafana#380.
kevinburkesegment
force-pushed
the
join-host-port
branch
from
ea40743
to
ccccec6
Compare
charleskorn
approved these changes
Oct 10, 2023
|
Thanks @kevinburkesegment! |
ying-jeanne
pushed a commit
that referenced
this pull request
Nov 2, 2023
This will ensure ipv6 compatibility for provided hosts, and this method should also be faster than the general purpose fmt.Sprintf, which must first parse the input string. Fixes #380.
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 will ensure ipv6 compatibility for provided hosts, and this method should also be faster than the general purpose fmt.Sprintf, which must first parse the input string.
Fixes #380.
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]