Skip to content

watch: prevent done callback from being called twice on connection loss #2389

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

Merged

Conversation

bverhoeven
Copy link
Contributor

Avoids multiple invocations of the done callback when a watch connection is closed unexpectedly (e.g., a premature socket close). The fix sets doneCalled = true before calling controller.abort(), to ensure that any AbortError triggered by aborting does not result in another call to the done callback.

A regression test is included to simulate an abrupt connection termination. It uses a real HTTP server that flushes headers and then destroys the connection immediately. This reliably triggers the combination of AbortError and "Premature close" needed to reproduce the issue.

Refs: #2387

Avoids multiple invocations of the done callback when a watch connection
is closed unexpectedly (e.g., a premature socket close). The fix sets
doneCalled = true before calling controller.abort(), to ensure that any
AbortError triggered by aborting does not result in another call to the
done callback.

A regression test is included to simulate an abrupt connection termination.
It uses a real HTTP server that flushes headers and then destroys the
connection immediately. This reliably triggers the combination of AbortError
and Premature close needed to reproduce the issue.

Refs: kubernetes-client#2387
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 24, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @bverhoeven!

It looks like this is your first PR to kubernetes-client/javascript 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/javascript has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 24, 2025
@cjihrig
Copy link
Contributor

cjihrig commented Apr 24, 2025

The changes LGTM. I'll give the other maintainers a chance to weigh in on the test since it's different from what we normally do (binding a port instead of using nock). Personally, I'm good with it since nock has been giving us issues lately particularly around these types of error edge cases.

@bverhoeven
Copy link
Contributor Author

Thanks! Yeah, I spent quite a bit of time trying to get this working with nock, but couldn’t get it to reliably simulate an abrupt disconnect. As mentioned in this comment, this setup seemed like the most dependable way to reproduce the issue.

Happy to adjust if maintainers prefer a different approach, but I figured it was worth using something that reliably triggers the edge case.

@brendandburns
Copy link
Contributor

This looks good to me thanks for adding the test.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 24, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, bverhoeven

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 24, 2025
@k8s-ci-robot k8s-ci-robot merged commit 133f960 into kubernetes-client:main Apr 24, 2025
8 checks passed
@bverhoeven bverhoeven deleted the fix/watch-double-done-callback branch April 24, 2025 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants