Improve Tunnel Server RESPONSE dumps #279
Open
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
"Tunnel Server RESPONSE" debugs() in Http::Tunneler::handleResponse() incorrectly assumed that readBuf contained hdr_sz bytes, but in reality it contains no header bytes and usually is empty. To avoid such problems we must pair rawContent() with the SBuf's length().
rousskov
requested changes
Dec 26, 2024
Adjusted Http::Tunneler::handleResponse() in line with a similar HttpStateData::processReplyHeader().
rousskov
changed the title
rousskov
approved these changes
Dec 28, 2024
There was a problem hiding this comment.
Thank you for fixing this. I think we must disclose the known problems associated with this duplicated code. I adjusted PR description accordingly and posted a suggestion. I also reduce PR title claim from "fix" to "improve" because this change can be viewed as a partial fix, and I do not want to overpromise and underdeliver.
| @@ -296,15 +296,23 @@ Http::Tunneler::handleResponse(const bool eof) | |||
| } | |||
|
|
|||
| if (!parsedOk) { | |||
| debugs(11, 3, "Non-HTTP-compliant header:\n---------\n" << readBuf << "\n----------"); | |||
There was a problem hiding this comment.
This code suffers from the same two problems that equivalent HttpStateData::processReplyHeader() code suffers from. We can propose to duplicate those problems (for now), but (if we do) we should be explicit about it (so that it does not look as if we are unknowingly adding bugs):
Suggested change
| debugs(11, 3, "Non-HTTP-compliant header:\n---------\n" << readBuf << "\n----------"); | |
| // XXX: This code and Server RESPONSE reporting code below duplicate | |
| // HttpStateData::processReplyHeader() reporting code, including its problems. | |
| debugs(11, 3, "Non-HTTP-compliant header:\n---------\n" << readBuf << "\n----------"); |
The above suggestion also documents code duplication itself.
…cache#1977) To avoid documentation duplication, current https_port and ftp_port directive descriptions reference http_port directive instead of detailing their own supported parameters. For https_port, this solution creates a false impression that the directive supports all http_port options. Our ftp_port documentation is better but still leaves the reader guessing which options are actually supported. This change starts enumerating http_port configuration parameters that ftp_port and https_port directives do _not_ support. Eventually, Squid should reject configurations with unsupported listening port options.
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.
Level-2 "Tunnel Server RESPONSE:..." debugs() incorrectly assumed that
its readBuf parameter contained hdr_sz header bytes. In reality, by the
time code reached that debugs(), readBuf no longer had any header bytes
(and often had no bytes at all). Besides broken header dumps, this bug
could lead to problems that Valgrind reports as "Conditional jump or
move depends on uninitialised value" in DebugChannel::writeToStream().
This fix mimics HttpStateData::processReplyHeader() reporting code,
including its known problems. Future changes should address those
problems and reduce code duplication across at least ten functions
containing similar "decorated" level-2 message dumps.