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

net/http/httptest: ensure that a superfluous WriteHeader call panics in httptest #69440

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dmathieu
Copy link
Contributor

@dmathieu dmathieu commented Sep 13, 2024

In net/http, using WriteHeader() twice creates a log entry, since the second one is superfluous:
https://cs.opensource.google/go/go/+/refs/tags/go1.23.1:src/net/http/server.go;l=1201

In net/http/httptest though, while a check is made, there is no way to detect the superfluous usage.
That makes superfluous calls reasy to reach production runtimes.
To help prevent that, this change proposes rejecting any superfluous WriteHeader calls in the httptest package.

@dmathieu dmathieu marked this pull request as ready for review September 13, 2024 08:17
@gopherbot
Copy link
Contributor

This PR (HEAD: 562ba1c) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/612995.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@dmathieu
Copy link
Contributor Author

I considered logging first, but it appears nothing uses logs in that package (yet), and we do already have a panic() with invalid HTTP statuses.
I'm happy to change this to something less intrusive though.

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/612995.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Damien MATHIEU:

Patch Set 2:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/612995.
After addressing review feedback, remember to publish your drafts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants