feat: add tag and value in validation error details (#1760)

AbhineetJain · web-flow · commit 9929189c45d1 · 2022-05-27T10:13:13.000-04:00
* add tag and value in validation error details

* fix unit tests and linter

* add quotes around value

* fix unit tests
diff --git 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 %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
@@ -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))
 		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool {`
`104`	`104`	`for _, validationError := range validationErrors {`
`105`	`105`	`apiErrors = append(apiErrors, Error{`
`106`	`106`	`Field: validationError.Field(),`
`107`		`- Detail: validationError.Tag(),`
	`107`	`+ Detail: fmt.Sprintf("Validation failed for tag %q with value: \"%v\"", validationError.Tag(), validationError.Value()),`
`108`	`108`	`})`
`109`	`109`	`}`
`110`	`110`	`Write(rw, http.StatusBadRequest, Response{`