Cleanup the system resources of webhook servers/tunnels #874
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
nolar
force-pushed
the
webhook-resources-cleanup
branch
from
68e983f
to
15cd0e0
Compare
|
This pull request introduces 2 alerts when merging 15cd0e0 into a9aa4ed - view on LGTM.com new alerts:
|
The webhook server/tunnel protocol is extended with an optional part: it can now be an asynchronous context manager. This is a more explicit way of cleaning up the system resources than relying on the `finally:` block or the `GeneratorExit` exception. The latter is not guaranteed to happen until the generator is garbage-collected, which can happen much later than expected (or never). In that case, the resources remain leaked and can fail the tests. For example, this was happening in PyPy 3.8. The webhook servers & tunnels provided by Kopf support both protocols: the simple callable protocol (with the cleanup on garbage collection in the `finally:` block) and the async context manager (with the explicit cleanup on exiting). Signed-off-by: Sergey Vasilyev <nolar@nolar.info>
nolar
force-pushed
the
webhook-resources-cleanup
branch
from
15cd0e0
to
33cd998
Compare
This was referenced Dec 3, 2021
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.
The webhook server/tunnel protocol is extended with an optional part: it can now be an asynchronous context manager. This is a more explicit way of cleaning up the system resources than relying on the
finally:block or theGeneratorExitexception. The latter is not guaranteed to happen until the generator is garbage-collected, which can happen much later than expected (or never). In that case, the resources remain leaked and can fail the tests. For example, this was happening in PyPy 3.8.The webhook servers & tunnels provided by Kopf support both protocols: the simple callable protocol (with the cleanup on garbage collection in the
finally:block) and the async context manager (with the explicit cleanup on exiting).Related: #872.