fix potential panic in IsRecoverable #104
Merged
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
The way `unrecoverableError` wraps an error can lead to potential panics. In `IsRecoverable`, an `unrecoverableError` is passed to `errors.Is` without an embedded error. This is problematic because any error type that implements the `Is` interface and expects to be able to call `Error()` will trigger a panic due to the embedded error being `nil`. To fix this, we can implement `Error()` on `unrecoverableError` and handle the case where the embedded error is nil.
|
This is very problematic because there is no simple workaround for this issue. |
JaSei
approved these changes
Nov 14, 2023
|
Thanks for your PR. |
kodiakhq bot
referenced
this pull request
in cloudquery/plugin-pb-go
Dec 1, 2023
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/avast/retry-go/v4](https://github.com/avast/retry-go) | require | patch | `v4.5.0` -> `v4.5.1` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>avast/retry-go (github.com/avast/retry-go/v4)</summary> ### [`v4.5.1`](https://github.com/avast/retry-go/releases/tag/v4.5.1) [Compare Source](https://github.com/avast/retry-go/compare/4.5.0...4.5.1) #### What's Changed - Bump github.com/stretchr/testify from 1.8.2 to 1.8.4 by [@​dependabot](https://github.com/dependabot) in [https://github.com/avast/retry-go/pull/95](https://github.com/avast/retry-go/pull/95) - add missing comma in the example by [@​spacewander](https://github.com/spacewander) in [https://github.com/avast/retry-go/pull/101](https://github.com/avast/retry-go/pull/101) - Add an example which shows err history by [@​avinassh](https://github.com/avinassh) in [https://github.com/avast/retry-go/pull/98](https://github.com/avast/retry-go/pull/98) - fix potential panic in IsRecoverable by [@​jalaziz](https://github.com/jalaziz) in [https://github.com/avast/retry-go/pull/104](https://github.com/avast/retry-go/pull/104) #### New Contributors - [@​spacewander](https://github.com/spacewander) made their first contribution in [https://github.com/avast/retry-go/pull/101](https://github.com/avast/retry-go/pull/101) - [@​avinassh](https://github.com/avinassh) made their first contribution in [https://github.com/avast/retry-go/pull/98](https://github.com/avast/retry-go/pull/98) - [@​jalaziz](https://github.com/jalaziz) made their first contribution in [https://github.com/avast/retry-go/pull/104](https://github.com/avast/retry-go/pull/104) **Full Changelog**: avast/retry-go@4.5.0...v4.5.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on the first day of the month" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMDkuNCIsInVwZGF0ZWRJblZlciI6IjM2LjEwOS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
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 way
unrecoverableErrorwraps an error can lead to potential panics. InIsRecoverable, anunrecoverableErroris passed toerrors.Iswithout an embedded error. This is problematic because any error type that implements theIsinterface and expects to be able to callError()will trigger a panic due to the embedded error beingnil.To fix this, we can implement
Error()onunrecoverableErrorand handle the case where the embedded error is nil.