Return error on the getTSDB function when user is not found. #6565
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
yeya24
approved these changes
Jan 29, 2025
Signed-off-by: alanprot <[email protected]>
danielblando
approved these changes
Jan 29, 2025
oberkem
reviewed
Jan 29, 2025
| if db != nil { | ||
| if err != nil { | ||
| level.Warn(i.logger).Log("msg", "error getting user DB but userDB is not null", "err", err, "userID", userID) |
There was a problem hiding this comment.
it should never happen.. it does not change the fact that if it happens if good to have a log! maybe i can add a comment
There was a problem hiding this comment.
I was trying to understand if you had an edge case in mind. either comment or
if db != nil && err == nil
return db, nil
works
oberkem
reviewed
Jan 29, 2025
| @@ -2285,10 +2292,10 @@ func (i *Ingester) getOrCreateTSDB(userID string, force bool) (*userTSDB, error) | |||
|
|
|||
| func (i *Ingester) blockChunkQuerierFunc(userId string) tsdb.BlockChunkQuerierFunc { | |||
There was a problem hiding this comment.
[not a blocker] for the sake of following the same convention, should not this also return an error
friedrichg
approved these changes
Jan 29, 2025
oberkem
approved these changes
Jan 30, 2025
CharlieTLe
approved these changes
Jan 30, 2025
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.
What this PR does:
Im proposing to return an error on the
getTSDBfunction when the userDB is not found.Everytime we invoke this function on the codebase we need to check if the return is nil but is very easy to forget to do so and cause problem like: #6518 #6521
Ex:
cortex/pkg/ingester/ingester.go
Lines 991 to 995 in 4b32f29
I think returning an error in such case will force us to always think about this case and prevent such scenarios in the future.
Which issue(s) this PR fixes:
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]