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

Preventing panics of RecoverableError casts #2267

Merged
merged 4 commits into from
Feb 1, 2017
Merged

Preventing panics of RecoverableError casts #2267

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
09ba15f
Preventing panics of RecoverableError casts
Feb 1, 2017
5326ad3
Properly dealing with non-nil errors.
Feb 1, 2017
57c9ff3
Third time is a charm.
Feb 1, 2017
e887e80
fmt
Feb 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions nomad/node_endpoint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,7 +944,7 @@ func (n *Node) DeriveVaultToken(args *structs.DeriveVaultTokenRequest,
// setErr is a helper for setting the recoverable error on the reply and
// logging it
setErr := func(e error, recoverable bool) {
reply.Error = structs.NewRecoverableError(e, recoverable).(*structs.RecoverableError)
reply.Error = structs.NewRecoverableError(e, recoverable)
Copy link
Member

Choose a reason for hiding this comment

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

Instead of omitting the type assertion, let's just check if error is nil and return early.

Otherwise we re-introduce a bug where reply.Error gets set even when the original error e was nil!

Copy link
Author

Choose a reason for hiding this comment

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

I was going to do a type assertion before I thought I could just change the return type.
Will have shortly.

n.srv.logger.Printf("[ERR] nomad.client: DeriveVaultToken failed (recoverable %v): %v", recoverable, e)
}

Expand Down Expand Up @@ -1134,7 +1134,7 @@ func (n *Node) DeriveVaultToken(args *structs.DeriveVaultTokenRequest,
if rerr, ok := createErr.(*structs.RecoverableError); ok {
reply.Error = rerr
} else {
reply.Error = structs.NewRecoverableError(createErr, false).(*structs.RecoverableError)
reply.Error = structs.NewRecoverableError(createErr, false)
}

return nil
Expand Down
2 changes: 1 addition & 1 deletion nomad/structs/structs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4054,7 +4054,7 @@ type RecoverableError struct {

// NewRecoverableError is used to wrap an error and mark it as recoverable or
// not.
func NewRecoverableError(e error, recoverable bool) error {
func NewRecoverableError(e error, recoverable bool) *RecoverableError {
Copy link
Member

Choose a reason for hiding this comment

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

So, I changed this return value from *RecoverableError to error intentionally in 0.5.3 to avoid turning nil errors into non-nil *RecoverableErrors. Here's an example of that sort of problem: https://play.golang.org/p/Y8z9GdcAhx

So let's keep returning error here to avoid that issue.

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the awesome explanation. What a nasty side effect.

if e == nil {
return nil
}
Expand Down