fix: improve duplicate template version name error (#14572)

ethanndickson · web-flow · commit 208a5beb954d · 2024-09-06T16:13:34.000+10:00
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1448,11 +1448,19 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 			UserVariableValues: req.UserVariableValues,
 		})
 		if err != nil {
-			return xerrors.Errorf("marshal job input: %w", err)
+			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+				Message: "Internal error creating template version.",
+				Detail:  xerrors.Errorf("marshal job input: %w", err).Error(),
+			})
+			return err
 		}
 		traceMetadataRaw, err := json.Marshal(tracing.MetadataFromContext(ctx))
 		if err != nil {
-			return xerrors.Errorf("marshal job metadata: %w", err)
+			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+				Message: "Internal error creating template version.",
+				Detail:  xerrors.Errorf("marshal job metadata: %w", err).Error(),
+			})
+			return err
 		}
 
 		provisionerJob, err = tx.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{
@@ -1473,7 +1481,11 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 			},
 		})
 		if err != nil {
-			return xerrors.Errorf("insert provisioner job: %w", err)
+			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+				Message: "Internal error creating template version.",
+				Detail:  xerrors.Errorf("insert provisioner job: %w", err).Error(),
+			})
+			return err
 		}
 
 		var templateID uuid.NullUUID
@@ -1501,20 +1513,36 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 			CreatedBy:      apiKey.UserID,
 		})
 		if err != nil {
-			return xerrors.Errorf("insert template version: %w", err)
+			if database.IsUniqueViolation(err, database.UniqueTemplateVersionsTemplateIDNameKey) {
+				httpapi.Write(ctx, rw, http.StatusConflict, codersdk.Response{
+					Message: fmt.Sprintf("A template version with name %q already exists for this template.", req.Name),
+					Validations: []codersdk.ValidationError{{
+						Field:  "name",
+						Detail: "This value is already in use and should be unique.",
+					}},
+				})
+				return err
+			}
+			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+				Message: "Internal error creating template version.",
+				Detail:  xerrors.Errorf("insert template version: %w", err).Error(),
+			})
+			return err
 		}
 
 		templateVersion, err = tx.GetTemplateVersionByID(ctx, templateVersionID)
 		if err != nil {
-			return xerrors.Errorf("fetched inserted template version: %w", err)
+			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+				Message: "Internal error creating template version.",
+				Detail:  xerrors.Errorf("fetched inserted template version: %w", err).Error(),
+			})
+			return err
 		}
 
 		return nil
 	}, nil)
 	if err != nil {
-		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
-			Message: err.Error(),
-		})
+		// Each failure case in the tx should have already written a response.
 		return
 	}
 	aReq.New = templateVersion
diff --git a/provisionerd/runner/runner.go b/provisionerd/runner/runner.go
@@ -222,7 +222,7 @@ func (r *Runner) Run() {
 		err := r.sender.CompleteJob(ctx, r.completedJob)
 		if err != nil {
 			r.logger.Error(ctx, "sending CompletedJob failed", slog.Error(err))
-			err = r.sender.FailJob(ctx, r.failedJobf("internal provisionerserver error"))
+			err = r.sender.FailJob(ctx, r.failedJobf("internal provisionerserver error: %s", err))
 			if err != nil {
 				r.logger.Error(ctx, "sending FailJob failed (while CompletedJob)", slog.Error(err))
 			}

Original file line number	Diff line number	Diff line change
`@@ -222,7 +222,7 @@ func (r *Runner) Run() {`
`222`	`222`	`err := r.sender.CompleteJob(ctx, r.completedJob)`
`223`	`223`	`if err != nil {`
`224`	`224`	`r.logger.Error(ctx, "sending CompletedJob failed", slog.Error(err))`
`225`		`- err = r.sender.FailJob(ctx, r.failedJobf("internal provisionerserver error"))`
	`225`	`+ err = r.sender.FailJob(ctx, r.failedJobf("internal provisionerserver error: %s", err))`
`226`	`226`	`if err != nil {`
`227`	`227`	`r.logger.Error(ctx, "sending FailJob failed (while CompletedJob)", slog.Error(err))`
`228`	`228`	`}`