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

fix: Remove the default connection close header (v2 branch) #1765

Merged
merged 1 commit into from
Aug 18, 2023

Conversation

dhedey
Copy link
Contributor

@dhedey dhedey commented Jul 27, 2023

This backports #1736 fixing #1735 to the 2.x branch. Reasoning for why this is important is in this comment.

I believe this change is low-risk for applying against 2.x, for a few reasons:

  • Note that the Connection Close isn't included if an agent is provided, which has seen no reported issues. This was likely a bug fix added because in old node (eg v4) specifying an agent changed the default behaviour to keep-alive, which triggered this bug.
  • I don't believe sending a Connection: Close was ever needed. It appears to have always caused issues if trying to combine with keep-alive.
  • Even on eg Node v4 docs for the default agent, it doesn't mention sending a Connection: Close header: https://nodejs.org/docs/latest-v4.x/api/http.html#http_http_globalagent. - there is a slim chance it might cause slight behaviour differences in terms of connection handling with some legacy web servers, but I believe it is unlikely to break anything and the risk is slim compared with the issue many people are encountering when not fixing the issue.

Instead, we rely on the underlying http implementation in Node.js to handle this, as per the documentation at
https://nodejs.org/api/http.html#new-agentoptions

This fixes #1735 and likely replaces #1473

The original change introducing this provided no clear motivation for the override, and the implementation has since been changed to disable this header when an agent is provided, so I think there is sufficient evidence that removing this is the correct behaviour. af21ae6 7f68577

This commit is backported to the v2 branch from #1736 against v3.

Instead, we rely on the underlying http implementation in Node.js
to handle this, as per the documentation at
https://nodejs.org/api/http.html#new-agentoptions

This fixes node-fetch#1735 and likely replaces node-fetch#1473

The original change introducing this provided no clear motivation
for the override, and the implementation has since been changed to
disable this header when an agent is provided, so I think there
is sufficient evidence that removing this is the correct behaviour.
node-fetch@af21ae6
node-fetch@7f68577

This commit is backported to the v2 branch from node-fetch#1736 against v3.
@dhedey dhedey changed the title fix: Remove the default connection close header fix: Remove the default connection close header (v2 branch) Jul 27, 2023
Copy link
Member

@LinusU LinusU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@arthurk777

This comment was marked as resolved.

@jimmywarting jimmywarting merged commit 65ae25a into node-fetch:2.x Aug 18, 2023
@github-actions
Copy link

🎉 This PR is included in version 2.6.13 🎉

The release is available on:

Your semantic-release bot 📦🚀

@felipelube
Copy link

This has broken some tests we did with https://github.com/nock/nock 's NockBack feature where we expected the "connection: close" header to be sent. We've updated the tests and everything is fine.

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

Successfully merging this pull request may close these issues.

5 participants