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 possible resource leak on KubernetesClientConfiguration without introducing IDisposable #1449

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

Conversation

PSanetra
Copy link
Contributor

Fix #1446 without introducing IDisposable on KubernetesClientConfiguration

Breaking Changes:

  • Using KubernetesClientConfiguration.SslCaCerts or KubernetesClientConfiguration.LoadSslCaCerts() requires the user to dispose the returned X509Certificate2Collection after usage.
  • Setter of KubernetesClientConfiguration.SslCaCerts was removed.

@k8s-ci-robot k8s-ci-robot added do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 10, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: PSanetra
Once this PR has been reviewed and has the lgtm label, please assign brendandburns for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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
Copy link
Contributor

Welcome @PSanetra!

It looks like this is your first PR to kubernetes-client/csharp 🎉. 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/csharp 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 Nov 10, 2023
… introducing `IDisposable`

Breaking Changes:
* Using `KubernetesClientConfiguration.SslCaCerts` or `KubernetesClientConfiguration.LoadSslCaCerts()` requires the user to dispose the returned `X509Certificate2Collection` after usage.
* Setter of `KubernetesClientConfiguration.SslCaCerts` was removed.
@PSanetra PSanetra force-pushed the fix-resource-leak-on-KubernetesClientConfiguration branch from 62477b3 to b7d0a16 Compare November 10, 2023 13:15
@PSanetra PSanetra changed the title Fix #1446 without introducing IDisposable on KubernetesClientConfiguration Fix possible resource leak on KubernetesClientConfiguration without introducing IDisposable Nov 10, 2023
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Nov 10, 2023
@tg123
Copy link
Member

tg123 commented Nov 11, 2023

prefer idisposable which does not introduce breaking change

@PSanetra
Copy link
Contributor Author

PSanetra commented Nov 13, 2023

@tg123 Introducing the IDisposable interface is a breaking change as well as it requires to introduce code changes in many code bases. All code bases which instantiated a KubernetesClientConfiguration somewhere must dispose the KubernetesClientConfiguration.

In comparison introducing the IDisposable interface is a silent breaking change while the breaking changes in this PR will hint developers by a breaking compiler build to these changes. I would prefer this kind of breaking change over a silent breaking change.

Additionally the proposed approach in this PR will probably affect only very few code bases. Only those which did directly use SslCaCerts. I guess this will be mostly just this project internally.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 2, 2024
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 2, 2024
@PSanetra
Copy link
Contributor Author

PSanetra commented May 2, 2024

@tg123 Can you have another look at this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. 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.

KubernetesClientConfiguration does not implement IDisposable.
4 participants