refactor: replace Code by Detail in the http API error (coder#1011)

BrunoQuaresma · web-flow · commit 3311c2f65dc2 · 2022-04-18T11:02:54.000-05:00
diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go
@@ -58,8 +58,8 @@ type Response struct {
 
 // Error represents a scoped error to a user input.
 type Error struct {
-	Field string `json:"field" validate:"required"`
-	Code  string `json:"code" validate:"required"`
+	Field  string `json:"field" validate:"required"`
+	Detail string `json:"detail" validate:"required"`
 }
 
 // Write outputs a standardized format to an HTTP response body.
@@ -97,8 +97,8 @@ func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool {
 		apiErrors := make([]Error, 0, len(validationErrors))
 		for _, validationError := range validationErrors {
 			apiErrors = append(apiErrors, Error{
-				Field: validationError.Field(),
-				Code:  validationError.Tag(),
+				Field:  validationError.Field(),
+				Detail: validationError.Tag(),
 			})
 		}
 		Write(rw, http.StatusBadRequest, Response{
diff --git 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, v.Errors[0].Field, "value")
-		require.Equal(t, v.Errors[0].Code, "required")
+		require.Equal(t, v.Errors[0].Detail, "required")
 	})
 }
 
diff --git a/coderd/organizations.go b/coderd/organizations.go
@@ -162,8 +162,8 @@ func (api *api) postTemplatesByOrganization(rw http.ResponseWriter, r *http.Requ
 		httpapi.Write(rw, http.StatusConflict, httpapi.Response{
 			Message: fmt.Sprintf("template %q already exists", createTemplate.Name),
 			Errors: []httpapi.Error{{
-				Field: "name",
-				Code:  "exists",
+				Field:  "name",
+				Detail: "this value is already in use and should be unique",
 			}},
 		})
 		return
diff --git a/coderd/users.go b/coderd/users.go
@@ -289,14 +289,14 @@ func (api *api) putUserProfile(rw http.ResponseWriter, r *http.Request) {
 		responseErrors := []httpapi.Error{}
 		if existentUser.Email == params.Email {
 			responseErrors = append(responseErrors, httpapi.Error{
-				Field: "email",
-				Code:  "exists",
+				Field:  "email",
+				Detail: "this value is already in use and should be unique",
 			})
 		}
 		if existentUser.Username == params.Username {
 			responseErrors = append(responseErrors, httpapi.Error{
-				Field: "username",
-				Code:  "exists",
+				Field:  "username",
+				Detail: "this value is already in use and should be unique",
 			})
 		}
 		httpapi.Write(rw, http.StatusConflict, httpapi.Response{
@@ -591,8 +591,8 @@ func (api *api) postWorkspacesByUser(rw http.ResponseWriter, r *http.Request) {
 		httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{
 			Message: fmt.Sprintf("template %q doesn't exist", createWorkspace.TemplateID.String()),
 			Errors: []httpapi.Error{{
-				Field: "template_id",
-				Code:  "not_found",
+				Field:  "template_id",
+				Detail: "template not found",
 			}},
 		})
 		return
@@ -637,8 +637,8 @@ func (api *api) postWorkspacesByUser(rw http.ResponseWriter, r *http.Request) {
 		httpapi.Write(rw, http.StatusConflict, httpapi.Response{
 			Message: fmt.Sprintf("workspace %q already exists in the %q template", createWorkspace.Name, template.Name),
 			Errors: []httpapi.Error{{
-				Field: "name",
-				Code:  "exists",
+				Field:  "name",
+				Detail: "this value is already in use and should be unique",
 			}},
 		})
 		return
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -115,8 +115,8 @@ func (api *api) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
 		httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{
 			Message: "template version not found",
 			Errors: []httpapi.Error{{
-				Field: "template_version_id",
-				Code:  "exists",
+				Field:  "template_version_id",
+				Detail: "template version not found",
 			}},
 		})
 		return
diff --git a/codersdk/client.go b/codersdk/client.go
@@ -127,7 +127,7 @@ func (e *Error) Error() string {
 	var builder strings.Builder
 	_, _ = fmt.Fprintf(&builder, "status code %d: %s", e.statusCode, e.Message)
 	for _, err := range e.Errors {
-		_, _ = fmt.Fprintf(&builder, "\n\t%s: %s", err.Field, err.Code)
+		_, _ = fmt.Fprintf(&builder, "\n\t%s: %s", err.Field, err.Detail)
 	}
 	return builder.String()
 }

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ func TestRead(t *testing.T) {`
`76`	`76`	`require.NoError(t, err)`
`77`	`77`	`require.Len(t, v.Errors, 1)`
`78`	`78`	`require.Equal(t, v.Errors[0].Field, "value")`
`79`		`- require.Equal(t, v.Errors[0].Code, "required")`
	`79`	`+ require.Equal(t, v.Errors[0].Detail, "required")`
`80`	`80`	`})`
`81`	`81`	`}`
`82`	`82`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ func (e *Error) Error() string {`
`127`	`127`	`var builder strings.Builder`
`128`	`128`	`_, _ = fmt.Fprintf(&builder, "status code %d: %s", e.statusCode, e.Message)`
`129`	`129`	`for _, err := range e.Errors {`
`130`		`- _, _ = fmt.Fprintf(&builder, "\n\t%s: %s", err.Field, err.Code)`
	`130`	`+ _, _ = fmt.Fprintf(&builder, "\n\t%s: %s", err.Field, err.Detail)`
`131`	`131`	`}`
`132`	`132`	`return builder.String()`
`133`	`133`	`}`