csharp icon indicating copy to clipboard operation
csharp copied to clipboard

Fix possible resource leak on `KubernetesClientConfiguration` without introducing `IDisposable`

Open PSanetra opened this issue 2 years ago • 7 comments

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.

PSanetra avatar Nov 10 '23 13:11 PSanetra

[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 avatar Nov 10 '23 13:11 k8s-ci-robot

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. :smiley:

k8s-ci-robot avatar Nov 10 '23 13:11 k8s-ci-robot

prefer idisposable which does not introduce breaking change

tg123 avatar Nov 11 '23 23:11 tg123

@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.

PSanetra avatar Nov 13 '23 08:11 PSanetra

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-ci-robot avatar Feb 02 '24 14:02 k8s-ci-robot

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-triage-robot avatar May 02 '24 14:05 k8s-triage-robot

@tg123 Can you have another look at this PR?

PSanetra avatar May 02 '24 17:05 PSanetra

The Kubernetes project currently lacks enough active 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 rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle rotten

k8s-triage-robot avatar Jun 01 '24 18:06 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and 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:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

k8s-triage-robot avatar Jul 01 '24 18:07 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and 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:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

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-sigs/prow repository.

k8s-ci-robot avatar Jul 01 '24 18:07 k8s-ci-robot