Skip to content

Avoid panic on network error in DO API get requests #216

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

Conversation

timoreimann
Copy link
Contributor

What this PR does / why we need it:
When a digitalocean/godo request fails due to a network error, the returned response variable will be nil. Thus, we need to check for nil in case of a non-nil error before referencing response fields to avoid panicking.

As a drive-by improvement, we also simplify how we return the droplet variable when no error occurs.

Release note:

Avoid panic on networking errors in get droplet requests

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 6, 2020
@k8s-ci-robot k8s-ci-robot requested review from chuckha and ncdc December 6, 2020 23:12
@k8s-ci-robot
Copy link

Hi @timoreimann. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 6, 2020
When a digitalocean/godo request fails due to a network error, the
returned response variable will be nil. Thus, we need to check for nil
in case of a non-nil error before referencing response fields to avoid
panicking.

As a drive-by improvement, we also simplify how we return the droplet
variable when no error occurs.
@timoreimann timoreimann force-pushed the avoid-panic-on-network-error-in-get-droplet-request branch from 6bd4856 to f687f26 Compare December 6, 2020 23:39
@timoreimann timoreimann changed the title Avoid panic on network error in get droplet request Avoid panic on network error in DO API get requests Dec 6, 2020
@prksu
Copy link
Contributor

prksu commented Dec 7, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 7, 2020
Copy link
Member

@MorrisLaw MorrisLaw left a comment

Choose a reason for hiding this comment

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

👍

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MorrisLaw, timoreimann

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 Dec 7, 2020
@MorrisLaw
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2020
@MorrisLaw
Copy link
Member

/hold for @prksu final review

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 7, 2020
@prksu
Copy link
Contributor

prksu commented Dec 7, 2020

/lgtm
/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 7, 2020
@k8s-ci-robot k8s-ci-robot merged commit 4050eaf into kubernetes-sigs:master Dec 7, 2020
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Dec 7, 2020
prksu pushed a commit to prksu/cluster-api-provider-digitalocean that referenced this pull request Dec 11, 2020
)

When a digitalocean/godo request fails due to a network error, the
returned response variable will be nil. Thus, we need to check for nil
in case of a non-nil error before referencing response fields to avoid
panicking.

As a drive-by improvement, we also simplify how we return the droplet
variable when no error occurs.
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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants