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.

Sign up for GitHub

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

Jump to bottom

🐛 Fix TerminalError(nil).Error() panic #2438

Merged
merged 1 commit into from
Aug 7, 2023
Merged

🐛 Fix TerminalError(nil).Error() panic #2438

merged 1 commit into from
Aug 7, 2023

Conversation

sheidkamp
Copy link
Contributor

Fixes #2430 by checking it err is nil before calling Error() on it.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 4, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 4, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: sheidkamp / name: Seth Heidkamp (e3ad494)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 4, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @sheidkamp!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. 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-sigs/controller-runtime 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 4, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @sheidkamp. 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 size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 4, 2023
@sheidkamp sheidkamp force-pushed the nil-terminal-error-fix branch from a993454 to e3ad494 Compare August 7, 2023 16:02
@sheidkamp sheidkamp mentioned this pull request Aug 7, 2023
Closed
vincepri
vincepri reviewed Aug 7, 2023
View reviewed changes
pkg/reconcile/reconcile.go
Comment on lines +121 to +123
if te.err == nil {
return "nil terminal error"
}
Copy link
Member

Choose a reason for hiding this comment

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

Is this a common pattern? We're at this point creating an error with a nil cause/inner error which might throw off the reconciliation loop.

Copy link
Contributor Author

@sheidkamp sheidkamp Aug 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I only see it used here:

controller-runtime/pkg/internal/controller/controller.go

Line 319 in 7f0c6dc

if errors.Is(err, reconcile.TerminalError(nil)) {

which doesn't totally make sense because the previous line checks for err==nil (<- strikethrough because checking for err==nil does not mean that the unwrapped error is not nil)

An alternate solution would be to modify the controller to create that error with a non-nil value (empty string?) and maybe add protection in the TerminalError() function to not allow nil values.

Copy link
Member

Choose a reason for hiding this comment

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

cc @alvaroaleman

Copy link
Member

@alvaroaleman alvaroaleman Aug 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

The nil terminal error there is only used for the errors.Is comparison, in that context, the Error() method will never be called.

It isn't really expected to construct a terminal error with a nil inner error when returning it, as that means logging will not be able to tell you what the issue was. When did you run into this panicing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We run into this error when using the Eris error handling library. Example here:
https://go.dev/play/p/4N0EmuNcPHJ

errors.Is calls the 1st argument's Is method here: https://cs.opensource.google/go/go/+/master:src/errors/wrap.go;l=54?q=wrap.go&ss=go%2Fgo
And then Eris' Is function does call target.Error()
https://github.com/rotisserie/eris/blob/d0c56b6433ca96eedf3c9482ec51456aa80dd772/eris.go#L212
leading to the panic.

@sheidkamp sheidkamp marked this pull request as ready for review August 7, 2023 16:20
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 7, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, sheidkamp

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 lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Aug 7, 2023
@k8s-ci-robot k8s-ci-robot merged commit 357eb83 into kubernetes-sigs:main Aug 7, 2023
@sheidkamp sheidkamp mentioned this pull request Aug 8, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vincepri vincepri vincepri left review comments

@alvaroaleman alvaroaleman alvaroaleman approved these changes

@inteon inteon Awaiting requested review from inteon

@joelanford joelanford Awaiting requested review from joelanford

@varshaprasad96 varshaprasad96 Awaiting requested review from varshaprasad96

Assignees

@alvaroaleman alvaroaleman

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. 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

TerminalError(nil).Error() panics
4 participants
@sheidkamp @k8s-ci-robot @vincepri @alvaroaleman