internal: give more useful panics when (mis)using context.Background #68
Conversation
This file contains hidden or 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
Instead of waiting for a nil return from fromContext to panic, I've updated all callers to proactively return/panic with a common error type. Panic is appropriate here, as it is a failed precondition of values passed into the functions. It's not introducing any new panics, just ones with more useful messages. Addresses googleapis/google-cloud-go#523
broady
approved these changes
Apr 7, 2017
internal/api.go
Outdated
| if c == nil { | ||
| // Give a good error message rather than a panic lower down. | ||
| return errors.New("not an App Engine context") | ||
| return errNonAEContext |
There was a problem hiding this comment.
errNotAppEngineContext, maybe? Don't feel strongly.
internal/api_common.go
Outdated
| } | ||
| } | ||
|
|
||
| var errNonAEContext = errors.New("not an App Engine context") |
|
How did these tests pass on Travis? We even run |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Instead of waiting for a nil return from fromContext to panic, I've
updated all callers to proactively return/panic with a common error
type. Panic is appropriate here, as it is a failed precondition of
values passed into the functions. It's not introducing any new panics,
just ones with more useful messages.
Addresses googleapis/google-cloud-go#523