Fix incorrect empty body provided to Wireserver #1728
Merged
+38
−8
Conversation
This file contains hidden or 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
In cases where clients using a WireserverTransport (namely the NMAgent one) do not wish to provide a body, one must be provided to satisfy quirks of Wireserver. Initially, an empty Go string was thought to be sufficient, but this is not. Wireserver expects an empty JSON string: specifically the 2-byte sequence "". Furthermore, this logic was only being triggered on cases where a nil body was presented to the WireserverTransport's logic. Given that there are now more linters enforcing the use of `http.NoBody`, this is distinct from `nil` and must be separately checked for (but treated in the same way). Tests and inline documentation have been updated to reflect this new understanding.
Because the Body of the request was replaced, Go also has no idea what the content type should be. It can't read from the reader to perform the detection, so this just sets it to JSON manually. As mentioned in the comments, this is a good idea anyway since we're being explicit rather than relying on heuristic methods to do the right thing.
rbtr
approved these changes
Dec 16, 2022
| t.Error("downstream request body to wireserver was nil, but not expected to be") | ||
| exp := `""` // an empty JSON string | ||
| if got := string(gotBody); got != exp { | ||
| t.Errorf("unexpected body received: got: %q, exp: %q\n", got, exp) |
Contributor
There was a problem hiding this comment.
nit: is the new line needed? same for others.
Member
Author
There was a problem hiding this comment.
@ramiro-gamarra do you mean the changed content, or a literal \n? There are no extra \ns (look at the line number sequence). It might be a GH display bug.
Contributor
There was a problem hiding this comment.
the \n in the error message
Member
Author
There was a problem hiding this comment.
Okay, so apparently, the presence or absence of it makes no difference in the output--they're stripped internally. I add them out of habit it because it matters for fmt.Println vs fmt.Printf. Since it won't create janky output, I'll keep it in mind for next time, but I won't fix it here to avoid blocking the merge.
ramiro-gamarra
approved these changes
Dec 16, 2022
Contributor
|
This fix works for us. Have tested by building a CNS executable and joinNetwork calls do not fail anymore. |
Member
|
This is fixing a regression in the master which has caused the releases 1.4.38 and 1.4.39 as non-usable for swift standalone. |
rjdenney
pushed a commit
to rjdenney/azure-container-networking
that referenced
this pull request
Jan 19, 2023
In cases where clients using a WireserverTransport (namely the NMAgent one) do not wish to provide a body, one must be provided to satisfy quirks of Wireserver. Initially, an empty Go string was thought to be sufficient, but this is not. Wireserver expects an empty JSON string: specifically the 2-byte sequence "". Furthermore, this logic was only being triggered on cases where a nil body was presented to the WireserverTransport's logic. Given that there are now more linters enforcing the use of `http.NoBody`, this is distinct from `nil` and must be separately checked for (but treated in the same way). Tests and inline documentation have been updated to reflect this new understanding. * Add Content-Type for outgoing Wireserver POSTs Because the Body of the request was replaced, Go also has no idea what the content type should be. It can't read from the reader to perform the detection, so this just sets it to JSON manually. As mentioned in the comments, this is a good idea anyway since we're being explicit rather than relying on heuristic methods to do the right thing.
smittal22
pushed a commit
to smittal22/azure-container-networking
that referenced
this pull request
Jan 26, 2023
In cases where clients using a WireserverTransport (namely the NMAgent one) do not wish to provide a body, one must be provided to satisfy quirks of Wireserver. Initially, an empty Go string was thought to be sufficient, but this is not. Wireserver expects an empty JSON string: specifically the 2-byte sequence "". Furthermore, this logic was only being triggered on cases where a nil body was presented to the WireserverTransport's logic. Given that there are now more linters enforcing the use of `http.NoBody`, this is distinct from `nil` and must be separately checked for (but treated in the same way). Tests and inline documentation have been updated to reflect this new understanding. * Add Content-Type for outgoing Wireserver POSTs Because the Body of the request was replaced, Go also has no idea what the content type should be. It can't read from the reader to perform the detection, so this just sets it to JSON manually. As mentioned in the comments, this is a good idea anyway since we're being explicit rather than relying on heuristic methods to do the right thing.
smittal22
pushed a commit
to smittal22/azure-container-networking
that referenced
this pull request
Jan 30, 2023
In cases where clients using a WireserverTransport (namely the NMAgent one) do not wish to provide a body, one must be provided to satisfy quirks of Wireserver. Initially, an empty Go string was thought to be sufficient, but this is not. Wireserver expects an empty JSON string: specifically the 2-byte sequence "". Furthermore, this logic was only being triggered on cases where a nil body was presented to the WireserverTransport's logic. Given that there are now more linters enforcing the use of `http.NoBody`, this is distinct from `nil` and must be separately checked for (but treated in the same way). Tests and inline documentation have been updated to reflect this new understanding. * Add Content-Type for outgoing Wireserver POSTs Because the Body of the request was replaced, Go also has no idea what the content type should be. It can't read from the reader to perform the detection, so this just sets it to JSON manually. As mentioned in the comments, this is a good idea anyway since we're being explicit rather than relying on heuristic methods to do the right thing.
smittal22
pushed a commit
to smittal22/azure-container-networking
that referenced
this pull request
Feb 3, 2023
In cases where clients using a WireserverTransport (namely the NMAgent one) do not wish to provide a body, one must be provided to satisfy quirks of Wireserver. Initially, an empty Go string was thought to be sufficient, but this is not. Wireserver expects an empty JSON string: specifically the 2-byte sequence "". Furthermore, this logic was only being triggered on cases where a nil body was presented to the WireserverTransport's logic. Given that there are now more linters enforcing the use of `http.NoBody`, this is distinct from `nil` and must be separately checked for (but treated in the same way). Tests and inline documentation have been updated to reflect this new understanding. * Add Content-Type for outgoing Wireserver POSTs Because the Body of the request was replaced, Go also has no idea what the content type should be. It can't read from the reader to perform the detection, so this just sets it to JSON manually. As mentioned in the comments, this is a good idea anyway since we're being explicit rather than relying on heuristic methods to do the right thing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
In cases where clients using a WireserverTransport (namely the NMAgent one) do not wish to provide a body, one must be provided to satisfy quirks of Wireserver. Initially, an empty Go string was thought to be sufficient, but this is not. Wireserver expects an empty JSON string: specifically the 2-byte sequence "".
Furthermore, this logic was only being triggered on cases where a nil body was presented to the WireserverTransport's logic. Given that there are now more linters enforcing the use of
http.NoBody, this is distinct fromniland must be separately checked for (but treated in the same way).Tests and inline documentation have been updated to reflect this new understanding.
Notes: