BED-5065: Display better error messages when creating a new user #1001
+49
−12
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
Adjust where error is being checked on api
wes-mil
changed the title
wes-mil
added
enhancement
mistahj67
reviewed
Dec 6, 2024
cmd/api/src/database/helper.go
Outdated
| ) | ||
|
|
||
| func CheckError(tx *gorm.DB) error { | ||
| if errors.Is(tx.Error, gorm.ErrRecordNotFound) { | ||
| return ErrNotFound | ||
| } | ||
|
|
||
| if tx.Error != nil { | ||
| if strings.Contains(tx.Error.Error(), "duplicate key value violates unique constraint \"users_principal_name_key\"") { |
There was a problem hiding this comment.
We want to keep this function agnostic to any specific db table as it's used across the datalayer. This error handling might be better placed in the db method directly associated with user creation
There was a problem hiding this comment.
I suspected that to be the case, but this error can also be thrown by UpdateUser. I was trying to avoid duplicating code. Would it be better to just have the explicit check in both?
There was a problem hiding this comment.
Yea in both is likely a better place than here IMO
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.
Description
Display more descriptive and better formatted errors when failing to create a new user.
Motivation and Context
This PR addresses: BED-5065
Why is this change required? What problem does it solve?
Previous error message would not indicate to the admin user why creating a new user was failing to be created.
How Has This Been Tested?
Creating a new user with a duplicate principal name now displays a more descriptive error message.
Screenshots (optional):
Duplicate principal name errors now display as:
Generic errors now display as:
Types of changes
Checklist: