fix: Simplify provisionerd job acquire

kylecarbs · kylecarbs · commit 5054d16ea99e · 2022-02-03T23:05:36.000Z
This uses a simple channel to detect whether a
job is running or not, and moves all cancels
to be in goroutines.
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -23,6 +23,7 @@ type Options struct {
 func New(options *Options) http.Handler {
 	api := &api{
 		Database: options.Database,
+		Logger:   options.Logger,
 		Pubsub:   options.Pubsub,
 	}
 
@@ -110,5 +111,6 @@ func New(options *Options) http.Handler {
 // be added to this struct for code clarity.
 type api struct {
 	Database database.Store
+	Logger   slog.Logger
 	Pubsub   database.Pubsub
 }
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -125,7 +125,7 @@ func New(t *testing.T) Server {
 	}
 
 	handler := coderd.New(&coderd.Options{
-		Logger:   slogtest.Make(t, nil),
+		Logger:   slogtest.Make(t, nil).Leveled(slog.LevelDebug),
 		Database: db,
 		Pubsub:   pubsub,
 	})
diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -19,6 +19,8 @@ import (
 	"storj.io/drpc/drpcmux"
 	"storj.io/drpc/drpcserver"
 
+	"cdr.dev/slog"
+
 	"github.com/coder/coder/coderd/projectparameter"
 	"github.com/coder/coder/database"
 	"github.com/coder/coder/httpapi"
@@ -84,6 +86,7 @@ func (api *api) provisionerDaemonsServe(rw http.ResponseWriter, r *http.Request)
 		Database:     api.Database,
 		Pubsub:       api.Pubsub,
 		Provisioners: daemon.Provisioners,
+		Logger:       api.Logger.Named(fmt.Sprintf("provisionerd-%s", daemon.Name)),
 	})
 	if err != nil {
 		_ = conn.Close(websocket.StatusInternalError, fmt.Sprintf("drpc register provisioner daemon: %s", err))
@@ -109,6 +112,7 @@ type projectImportJob struct {
 // Implementation of the provisioner daemon protobuf server.
 type provisionerdServer struct {
 	ID           uuid.UUID
+	Logger       slog.Logger
 	Provisioners []database.ProvisionerType
 	Database     database.Store
 	Pubsub       database.Pubsub
@@ -136,6 +140,8 @@ func (server *provisionerdServer) AcquireJob(ctx context.Context, _ *proto.Empty
 	if err != nil {
 		return nil, xerrors.Errorf("acquire job: %w", err)
 	}
+	server.Logger.Debug(ctx, "locked job from database", slog.F("id", job.ID))
+
 	// Marks the acquired job as failed with the error message provided.
 	failJob := func(errorMessage string) error {
 		err = server.Database.UpdateProvisionerJobByID(ctx, database.UpdateProvisionerJobByIDParams{
@@ -495,6 +501,7 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
 					return xerrors.Errorf("insert project parameter %q: %w", projectParameter.Name, err)
 				}
 			}
+			server.Logger.Debug(ctx, "marked import job as completed", slog.F("job_id", jobID))
 			return nil
 		})
 		if err != nil {
diff --git a/coderd/provisioners.go b/coderd/provisioners.go
@@ -12,7 +12,7 @@ type ProvisionerJobStatus string
 
 // Completed returns whether the job is still processing.
 func (p ProvisionerJobStatus) Completed() bool {
-	return p == ProvisionerJobStatusSucceeded || p == ProvisionerJobStatusFailed
+	return p == ProvisionerJobStatusSucceeded || p == ProvisionerJobStatusFailed || p == ProvisionerJobStatusCancelled
 }
 
 const (
diff --git a/coderd/workspacehistory.go b/coderd/workspacehistory.go
@@ -82,6 +82,10 @@ func (api *api) postWorkspaceHistoryByUser(rw http.ResponseWriter, r *http.Reque
 			Message: fmt.Sprintf("The provided project history %q has failed to import. You cannot create workspaces using it!", projectHistory.Name),
 		})
 		return
+	case ProvisionerJobStatusCancelled:
+		httpapi.Write(rw, http.StatusPreconditionFailed, httpapi.Response{
+			Message: "The provided project history was canceled during import. You cannot create workspaces using it!",
+		})
 	}
 
 	project, err := api.Database.GetProjectByID(r.Context(), projectHistory.ProjectID)
diff --git a/coderd/workspacehistory_test.go b/coderd/workspacehistory_test.go
@@ -56,6 +56,7 @@ func TestWorkspaceHistory(t *testing.T) {
 		require.Eventually(t, func() bool {
 			hist, err := client.ProjectHistory(context.Background(), user.Organization, project.Name, projectHistory.Name)
 			require.NoError(t, err)
+			t.Logf("Import status: %s\n", hist.Import.Status)
 			return hist.Import.Status.Completed()
 		}, 15*time.Second, 50*time.Millisecond)
 		return projectHistory
diff --git a/provisionerd/provisionerd.go b/provisionerd/provisionerd.go

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ type Options struct {`
`23`	`23`	`func New(options *Options) http.Handler {`
`24`	`24`	`api := &api{`
`25`	`25`	`Database: options.Database,`
	`26`	`+ Logger: options.Logger,`
`26`	`27`	`Pubsub: options.Pubsub,`
`27`	`28`	`}`
`28`	`29`
`@@ -110,5 +111,6 @@ func New(options *Options) http.Handler {`
`110`	`111`	`// be added to this struct for code clarity.`
`111`	`112`	`type api struct {`
`112`	`113`	`Database database.Store`
	`114`	`+ Logger slog.Logger`
`113`	`115`	`Pubsub database.Pubsub`
`114`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ func New(t *testing.T) Server {`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`handler := coderd.New(&coderd.Options{`
`128`		`- Logger: slogtest.Make(t, nil),`
	`128`	`+ Logger: slogtest.Make(t, nil).Leveled(slog.LevelDebug),`
`129`	`129`	`Database: db,`
`130`	`130`	`Pubsub: pubsub,`
`131`	`131`	`})`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ type ProvisionerJobStatus string`
`12`	`12`
`13`	`13`	`// Completed returns whether the job is still processing.`
`14`	`14`	`func (p ProvisionerJobStatus) Completed() bool {`
`15`		`- return p == ProvisionerJobStatusSucceeded \|\| p == ProvisionerJobStatusFailed`
	`15`	`+ return p == ProvisionerJobStatusSucceeded \|\| p == ProvisionerJobStatusFailed \|\| p == ProvisionerJobStatusCancelled`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`const (`