-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: improves UX around validation errors (#1209)
- Loading branch information
Showing
7 changed files
with
239 additions
and
69 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| package server | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/go-playground/validator/v10" | ||
| "github.com/infrahq/infra/api" | ||
| "github.com/infrahq/infra/internal" | ||
| "github.com/infrahq/infra/internal/logging" | ||
| ) | ||
|
|
||
| func sendAPIError(c *gin.Context, err error) { | ||
| resp := &api.Error{ | ||
| Code: http.StatusInternalServerError, | ||
| Message: "internal server error", // don't leak any info by default | ||
| } | ||
|
|
||
| var validationErrors = &validator.ValidationErrors{} | ||
|
|
||
| switch { | ||
| case errors.Is(err, internal.ErrUnauthorized): | ||
| resp.Code = http.StatusUnauthorized | ||
| resp.Message = "unauthorized" | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.Is(err, internal.ErrForbidden): | ||
| resp.Code = http.StatusForbidden | ||
| resp.Message = "forbidden" | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.Is(err, internal.ErrDuplicate): | ||
| resp.Code = http.StatusConflict | ||
| resp.Message = err.Error() | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.Is(err, internal.ErrNotFound): | ||
| resp.Code = http.StatusNotFound | ||
| resp.Message = err.Error() | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.As(err, validationErrors): | ||
| resp.Code = http.StatusBadRequest | ||
| resp.Message = err.Error() | ||
|
|
||
| parseFieldErrors(resp, validationErrors) | ||
|
|
||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.Is(err, internal.ErrBadRequest): | ||
| resp.Code = http.StatusBadRequest | ||
| resp.Message = err.Error() | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.Is(err, internal.ErrNotImplemented): | ||
| resp.Code = http.StatusNotImplemented | ||
| resp.Message = internal.ErrNotImplemented.Error() | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| case errors.Is(err, (*validator.InvalidValidationError)(nil)): | ||
| resp.Code = http.StatusBadRequest | ||
| resp.Message = err.Error() | ||
| logging.WrappedSugarLogger(c).Debugw(err.Error(), "statusCode", resp.Code) | ||
| default: | ||
| logging.WrappedSugarLogger(c).Errorw(err.Error(), "statusCode", resp.Code) | ||
| } | ||
|
|
||
| c.JSON(int(resp.Code), resp) | ||
| c.Abort() | ||
| } | ||
|
|
||
| func parseFieldErrors(resp *api.Error, validationErrors *validator.ValidationErrors) { | ||
| errs := map[string][]string{} | ||
| for _, field := range *validationErrors { | ||
| msg := "" | ||
| if field.Tag() == "required" { | ||
| msg = "is required" | ||
| } else { | ||
| msg = fmt.Sprintf("failed the %q check", field.Tag()) | ||
| } | ||
|
|
||
| errs[field.Namespace()] = append(errs[field.Field()], msg) | ||
| } | ||
|
|
||
| for f, vals := range errs { | ||
| resp.FieldErrors = append(resp.FieldErrors, api.FieldError{FieldName: f, Errors: vals}) | ||
| } | ||
|
|
||
| // rebuild the error message, because the default is just bad. | ||
| if len(resp.FieldErrors) > 0 { | ||
| errs := []string{} | ||
| for _, fe := range resp.FieldErrors { | ||
| errs = append(errs, fe.FieldName+": "+strings.Join(fe.Errors, ", ")) | ||
| } | ||
| resp.Message = strings.Join(errs, ". ") | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| package server | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/infrahq/infra/api" | ||
| "github.com/infrahq/infra/internal" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestSendAPIError(t *testing.T) { | ||
| gin.SetMode(gin.ReleaseMode) | ||
|
|
||
| tests := []struct { | ||
| err error | ||
| result api.Error | ||
| }{ | ||
| { | ||
| err: internal.ErrBadRequest, | ||
| result: api.Error{ | ||
| Code: 400, | ||
| Message: "bad request", | ||
| }, | ||
| }, | ||
| { | ||
| err: internal.ErrUnauthorized, | ||
| result: api.Error{ | ||
| Code: http.StatusUnauthorized, | ||
| Message: "unauthorized", | ||
| }, | ||
| }, | ||
| { | ||
| err: internal.ErrForbidden, | ||
| result: api.Error{ | ||
| Code: http.StatusForbidden, | ||
| Message: "forbidden", | ||
| }, | ||
| }, | ||
| { | ||
| err: internal.ErrDuplicate, | ||
| result: api.Error{ | ||
| Code: http.StatusConflict, | ||
| Message: "duplicate record", | ||
| }, | ||
| }, | ||
| { | ||
| err: internal.ErrNotFound, | ||
| result: api.Error{ | ||
| Code: http.StatusNotFound, | ||
| Message: "record not found", | ||
| }, | ||
| }, | ||
| { | ||
| err: internal.ErrNotImplemented, | ||
| result: api.Error{ | ||
| Code: http.StatusNotImplemented, | ||
| Message: "not implemented", | ||
| }, | ||
| }, | ||
| { | ||
| err: validate.Struct(struct { | ||
| Email string `validate:"required,email" json:"email"` | ||
| }{}), | ||
| result: api.Error{ | ||
| Code: http.StatusBadRequest, | ||
| Message: "Email: is required", | ||
| FieldErrors: []api.FieldError{ | ||
| api.FieldError{ | ||
| FieldName: "Email", | ||
| Errors: []string{"is required"}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| err: validate.Struct(struct { | ||
| Email string `validate:"required,email" json:"email"` | ||
| }{Email: "foo#example!com"}), | ||
| result: api.Error{ | ||
| Code: http.StatusBadRequest, | ||
| Message: `Email: failed the "email" check`, | ||
| FieldErrors: []api.FieldError{ | ||
| api.FieldError{ | ||
| FieldName: "Email", | ||
| Errors: []string{`failed the "email" check`}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.err.Error(), func(t *testing.T) { | ||
| resp := httptest.NewRecorder() | ||
| c, _ := gin.CreateTestContext(resp) | ||
|
|
||
| sendAPIError(c, test.err) | ||
|
|
||
| require.EqualValues(t, test.result.Code, resp.Result().StatusCode) | ||
| actual := &api.Error{} | ||
| json.NewDecoder(resp.Body).Decode(actual) | ||
|
|
||
| require.Equal(t, test.result.Code, actual.Code) | ||
| require.Equal(t, test.result.Message, actual.Message) | ||
|
|
||
| require.Equal(t, test.result.FieldErrors, actual.FieldErrors) | ||
| }) | ||
|
|
||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.