coder · mtojek · Mar 8, 2023 · Mar 8, 2023 · Mar 8, 2023 · Mar 8, 2023
diff --git a/cli/cliui/provisionerjob.go b/cli/cliui/provisionerjob.go
@@ -41,6 +41,17 @@ type ProvisionerJobOptions struct {
 	Silent bool
 }
 
+type ProvisionerJobError struct {
+	Message string
+	Code    codersdk.JobErrorCode
+}
+
+var _ error = new(ProvisionerJobError)
+
+func (err *ProvisionerJobError) Error() string {
+	return err.Message
-	return err.Message
+	return fmt.Sprintf("%s (%s)", err.Message, err.Code)
-	return err.Message
+	return fmt.Sprintf("%s (%s)", err.Message, err.Code)
+}
+
 // ProvisionerJob renders a provisioner job with interactive cancellation.
 func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOptions) error {
 	if opts.FetchInterval == 0 {
@@ -181,7 +192,10 @@ func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOp
 					return nil
 				case codersdk.ProvisionerJobFailed:
 				}
-				err = xerrors.New(job.Error)
+				err = &ProvisionerJobError{
+					Message: job.Error,
+					Code:    job.ErrorCode,
+				}
 				jobMutex.Unlock()
 				flushLogBuffer()
 				return err

diff --git a/cli/templatecreate.go b/cli/templatecreate.go
@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -196,7 +197,8 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 		},
 	})
 	if err != nil {
-		if !provisionerd.IsMissingParameterError(err.Error()) {
+		var jobErr *cliui.ProvisionerJobError
+		if errors.As(err, &jobErr) && !provisionerd.IsMissingParameterErrorCode(string(jobErr.Code)) {
 			return nil, nil, err
 		}
 	}
@@ -233,7 +235,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
 		}
 	}
 
-	if provisionerd.IsMissingParameterError(version.Job.Error) {
+	if provisionerd.IsMissingParameterErrorCode(string(version.Job.ErrorCode)) {
 		valuesBySchemaID := map[string]codersdk.ComputedParameter{}
 		for _, parameterValue := range parameterValues {
 			valuesBySchemaID[parameterValue.SchemaID.String()] = parameterValue

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -3512,6 +3512,7 @@ func (q *fakeQuerier) UpdateProvisionerJobWithCompleteByID(_ context.Context, ar
 		job.UpdatedAt = arg.UpdatedAt
 		job.CompletedAt = arg.CompletedAt
 		job.Error = arg.Error
+		job.ErrorCode = arg.ErrorCode
 		q.provisionerJobs[index] = job
 		return nil
 	}

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000107_provisioner_jobs_error_code.down.sql b/coderd/database/migrations/000107_provisioner_jobs_error_code.down.sql
@@ -0,0 +1 @@
+ALTER TABLE provisioner_jobs DROP COLUMN error_code;
diff --git a/coderd/database/migrations/000107_provisioner_jobs_error_code.up.sql b/coderd/database/migrations/000107_provisioner_jobs_error_code.up.sql
@@ -0,0 +1 @@
+ALTER TABLE provisioner_jobs ADD COLUMN error_code text DEFAULT NULL;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/provisionerjobs.sql b/coderd/database/queries/provisionerjobs.sql
@@ -91,6 +91,7 @@ UPDATE
 SET
 	updated_at = $2,
 	completed_at = $3,
-	error = $4
+	error = $4,
+	error_code = $5
 WHERE
 	id = $1;
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -113,6 +113,7 @@ func (server *Server) AcquireJob(ctx context.Context, _ *proto.Empty) (*proto.Ac
 				String: errorMessage,
 				Valid:  true,
 			},
+			ErrorCode: job.ErrorCode,
 		})
 		if err != nil {
 			return xerrors.Errorf("update provisioner job: %w", err)
@@ -639,12 +640,17 @@ func (server *Server) FailJob(ctx context.Context, failJob *proto.FailedJob) (*p
 		String: failJob.Error,
 		Valid:  failJob.Error != "",
 	}
+	job.ErrorCode = sql.NullString{
+		String: failJob.ErrorCode,
+		Valid:  failJob.ErrorCode != "",
+	}
 
 	err = server.Database.UpdateProvisionerJobWithCompleteByID(ctx, database.UpdateProvisionerJobWithCompleteByIDParams{
 		ID:          jobID,
 		CompletedAt: job.CompletedAt,
 		UpdatedAt:   database.Now(),
 		Error:       job.Error,
+		ErrorCode:   job.ErrorCode,
 	})
 	if err != nil {
 		return nil, xerrors.Errorf("update provisioner job: %w", err)

diff --git a/coderd/provisionerjobs.go b/coderd/provisionerjobs.go
@@ -317,6 +317,7 @@ func convertProvisionerJob(provisionerJob database.ProvisionerJob) codersdk.Prov
 		ID:        provisionerJob.ID,
 		CreatedAt: provisionerJob.CreatedAt,
 		Error:     provisionerJob.Error.String,
+		ErrorCode: codersdk.JobErrorCode(provisionerJob.ErrorCode.String),
 		FileID:    provisionerJob.FileID,
 		Tags:      provisionerJob.Tags,
 	}

diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -67,6 +67,14 @@ const (
 	ProvisionerJobFailed    ProvisionerJobStatus = "failed"
 )
 
+// JobErrorCode defines the error code returned by job runner.
+type JobErrorCode string
+
+const (
+	MissingTemplateParameter  JobErrorCode = "MISSING_TEMPLATE_PARAMETER"
+	RequiredTemplateVariables JobErrorCode = "REQUIRED_TEMPLATE_VARIABLES"
+)
+
 // ProvisionerJob describes the job executed by the provisioning daemon.
 type ProvisionerJob struct {
 	ID          uuid.UUID            `json:"id" format:"uuid"`
@@ -75,6 +83,7 @@ type ProvisionerJob struct {
 	CompletedAt *time.Time           `json:"completed_at,omitempty" format:"date-time"`
 	CanceledAt  *time.Time           `json:"canceled_at,omitempty" format:"date-time"`
 	Error       string               `json:"error,omitempty"`
+	ErrorCode   JobErrorCode         `json:"error_code,omitempty" enums:"MISSING_TEMPLATE_PARAMETER,REQUIRED_TEMPLATE_VARIABLES"`
 	Status      ProvisionerJobStatus `json:"status" enums:"pending,running,succeeded,canceling,canceled,failed"`
 	WorkerID    *uuid.UUID           `json:"worker_id,omitempty" format:"uuid"`
 	FileID      uuid.UUID            `json:"file_id" format:"uuid"`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE provisioner_jobs DROP COLUMN error_code;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE provisioner_jobs ADD COLUMN error_code text DEFAULT NULL;
Copy link Member mafredri Mar 8, 2023 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Could we potentially run into multiple errors? Would it make sense to store an array here? Copy link Member Author mtojek Mar 8, 2023 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. I would stick to the `error_code` at the moment. Most (all?) flows fail fast (`return failJob(...)`), so there is no simple way to aggregate multiple errors. Moreover, we have single `error` property. In this case, we would need `errors []` as well. mafredri reacted with thumbs up emoji