From 4ff518bba37a41a7e0800fe02d50b61460286baf Mon Sep 17 00:00:00 2001 From: Abhineet Jain Date: Wed, 25 May 2022 20:09:37 +0000 Subject: [PATCH 1/4] add tag and value in validation error details --- coderd/httpapi/httpapi.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go index afdb4685ed063..ac45d539815ba 100644 --- a/coderd/httpapi/httpapi.go +++ b/coderd/httpapi/httpapi.go @@ -104,7 +104,7 @@ func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool { for _, validationError := range validationErrors { apiErrors = append(apiErrors, Error{ Field: validationError.Field(), - Detail: validationError.Tag(), + Detail: fmt.Sprintf("Validation failed for tag \"%s\" with value: %v", validationError.Tag(), validationError.Value()), }) } Write(rw, http.StatusBadRequest, Response{ From 5ed16236baebc74b58c77668c30e12128faa2f53 Mon Sep 17 00:00:00 2001 From: Abhineet Jain Date: Wed, 25 May 2022 20:19:15 +0000 Subject: [PATCH 2/4] fix unit tests and linter --- coderd/httpapi/httpapi.go | 2 +- coderd/httpapi/httpapi_test.go | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go index ac45d539815ba..afe8eb410f17b 100644 --- a/coderd/httpapi/httpapi.go +++ b/coderd/httpapi/httpapi.go @@ -104,7 +104,7 @@ func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool { for _, validationError := range validationErrors { apiErrors = append(apiErrors, Error{ Field: validationError.Field(), - Detail: fmt.Sprintf("Validation failed for tag \"%s\" with value: %v", validationError.Tag(), validationError.Value()), + Detail: fmt.Sprintf("Validation failed for tag %q with value: %v", validationError.Tag(), validationError.Value()), }) } Write(rw, http.StatusBadRequest, Response{ diff --git a/coderd/httpapi/httpapi_test.go b/coderd/httpapi/httpapi_test.go index ad251747aa604..c36e01cb6de7c 100644 --- a/coderd/httpapi/httpapi_test.go +++ b/coderd/httpapi/httpapi_test.go @@ -58,7 +58,7 @@ func TestRead(t *testing.T) { var validate toValidate require.True(t, httpapi.Read(rw, r, &validate)) - require.Equal(t, validate.Value, "hi") + require.Equal(t, "hi", validate.Value) }) t.Run("ValidateFailure", func(t *testing.T) { @@ -75,8 +75,8 @@ func TestRead(t *testing.T) { err := json.NewDecoder(rw.Body).Decode(&v) require.NoError(t, err) require.Len(t, v.Errors, 1) - require.Equal(t, v.Errors[0].Field, "value") - require.Equal(t, v.Errors[0].Detail, "required") + require.Equal(t, "value", v.Errors[0].Field) + require.Equal(t, "Validation failed for tag \"required\" with value: ", v.Errors[0].Detail) }) } @@ -140,7 +140,7 @@ func TestReadUsername(t *testing.T) { r := httptest.NewRequest("POST", "/", bytes.NewBuffer(data)) var validate toValidate - require.Equal(t, httpapi.Read(rw, r, &validate), testCase.Valid) + require.Equal(t, testCase.Valid, httpapi.Read(rw, r, &validate)) }) } } From 0d86c7e6f4a72a27f0973a6ef3fcafb97e8b37f7 Mon Sep 17 00:00:00 2001 From: Abhineet Jain Date: Thu, 26 May 2022 00:34:33 +0000 Subject: [PATCH 3/4] add quotes around value --- coderd/httpapi/httpapi.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go index afe8eb410f17b..385c88020e161 100644 --- a/coderd/httpapi/httpapi.go +++ b/coderd/httpapi/httpapi.go @@ -104,7 +104,7 @@ func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool { for _, validationError := range validationErrors { apiErrors = append(apiErrors, Error{ Field: validationError.Field(), - Detail: fmt.Sprintf("Validation failed for tag %q with value: %v", validationError.Tag(), validationError.Value()), + Detail: fmt.Sprintf("Validation failed for tag %q with value: \"%v\"", validationError.Tag(), validationError.Value()), }) } Write(rw, http.StatusBadRequest, Response{ From 15dbd41c49e3379127c8343f297da09dcb1925aa Mon Sep 17 00:00:00 2001 From: Abhineet Jain Date: Thu, 26 May 2022 00:38:07 +0000 Subject: [PATCH 4/4] fix unit tests --- coderd/httpapi/httpapi_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/coderd/httpapi/httpapi_test.go b/coderd/httpapi/httpapi_test.go index c36e01cb6de7c..20f7af5c08ab1 100644 --- a/coderd/httpapi/httpapi_test.go +++ b/coderd/httpapi/httpapi_test.go @@ -76,7 +76,7 @@ func TestRead(t *testing.T) { require.NoError(t, err) require.Len(t, v.Errors, 1) require.Equal(t, "value", v.Errors[0].Field) - require.Equal(t, "Validation failed for tag \"required\" with value: ", v.Errors[0].Detail) + require.Equal(t, "Validation failed for tag \"required\" with value: \"\"", v.Errors[0].Detail) }) }