Add reason field for workspace builds (#2438)

AbhineetJain · web-flow · commit 289b98978fd6 · 2022-06-17T13:41:11.000-04:00
* add reason field for workspace build

* add the reason field to FE via API

* update BuildReasonMember to BuildReasonInitiator

* add unit tests

* add more unit tests

* add error for unknown transition

* fix lint

* add documentation

* fix unit tests

* fix generated types

* remove nested transaction

* rename migration file
diff --git a/coderd/autobuild/executor/lifecycle_executor.go b/coderd/autobuild/executor/lifecycle_executor.go
@@ -209,6 +209,17 @@ func build(ctx context.Context, store database.Store, workspace database.Workspa
 	}
 	provisionerJobID := uuid.New()
 	now := database.Now()
+
+	var buildReason database.BuildReason
+	switch trans {
+	case database.WorkspaceTransitionStart:
+		buildReason = database.BuildReasonAutostart
+	case database.WorkspaceTransitionStop:
+		buildReason = database.BuildReasonAutostop
+	default:
+		return xerrors.Errorf("Unsupported transition: %q", trans)
+	}
+
 	newProvisionerJob, err := store.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{
 		ID:             provisionerJobID,
 		CreatedAt:      now,
@@ -236,6 +247,7 @@ func build(ctx context.Context, store database.Store, workspace database.Workspa
 		InitiatorID:       workspace.OwnerID,
 		Transition:        trans,
 		JobID:             newProvisionerJob.ID,
+		Reason:            buildReason,
 	})
 	if err != nil {
 		return xerrors.Errorf("insert workspace build: %w", err)
diff --git a/coderd/autobuild/executor/lifecycle_executor_test.go b/coderd/autobuild/executor/lifecycle_executor_test.go
@@ -51,6 +51,9 @@ func TestExecutorAutostartOK(t *testing.T) {
 	assert.Len(t, stats.Transitions, 1)
 	assert.Contains(t, stats.Transitions, workspace.ID)
 	assert.Equal(t, database.WorkspaceTransitionStart, stats.Transitions[workspace.ID])
+
+	workspace = coderdtest.MustWorkspace(t, client, workspace.ID)
+	assert.Equal(t, codersdk.BuildReasonAutostart, workspace.LatestBuild.Reason)
 }
 
 func TestExecutorAutostartTemplateUpdated(t *testing.T) {
@@ -200,6 +203,9 @@ func TestExecutorAutostopOK(t *testing.T) {
 	assert.Len(t, stats.Transitions, 1)
 	assert.Contains(t, stats.Transitions, workspace.ID)
 	assert.Equal(t, database.WorkspaceTransitionStop, stats.Transitions[workspace.ID])
+
+	workspace = coderdtest.MustWorkspace(t, client, workspace.ID)
+	assert.Equal(t, codersdk.BuildReasonAutostop, workspace.LatestBuild.Reason)
 }
 
 func TestExecutorAutostopExtend(t *testing.T) {
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -1744,6 +1744,7 @@ func (q *fakeQuerier) InsertWorkspaceBuild(_ context.Context, arg database.Inser
 		JobID:             arg.JobID,
 		ProvisionerState:  arg.ProvisionerState,
 		Deadline:          arg.Deadline,
+		Reason:            arg.Reason,
 	}
 	q.workspaceBuilds = append(q.workspaceBuilds, workspaceBuild)
 	return workspaceBuild, nil
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000025_workspace_build_reason.down.sql b/coderd/database/migrations/000025_workspace_build_reason.down.sql
@@ -0,0 +1,4 @@
+ALTER TABLE ONLY workspace_builds
+    DROP COLUMN IF EXISTS reason;
+
+DROP TYPE build_reason;
diff --git a/coderd/database/migrations/000025_workspace_build_reason.up.sql b/coderd/database/migrations/000025_workspace_build_reason.up.sql
@@ -0,0 +1,4 @@
+CREATE TYPE build_reason AS ENUM ('initiator', 'autostart', 'autostop');
+
+ALTER TABLE ONLY workspace_builds
+    ADD COLUMN IF NOT EXISTS reason build_reason NOT NULL DEFAULT 'initiator';
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/workspacebuilds.sql b/coderd/database/queries/workspacebuilds.sql
@@ -114,10 +114,11 @@ INSERT INTO
 		initiator_id,
 		job_id,
 		provisioner_state,
-		deadline
+		deadline,
+		reason
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12) RETURNING *;
+	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13) RETURNING *;
 
 -- name: UpdateWorkspaceBuildByID :exec
 UPDATE
diff --git a/coderd/workspacebuilds.go b/coderd/workspacebuilds.go
@@ -439,6 +439,7 @@ func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
 			InitiatorID:       apiKey.UserID,
 			Transition:        database.WorkspaceTransition(createBuild.Transition),
 			JobID:             provisionerJob.ID,
+			Reason:            database.BuildReasonInitiator,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert workspace build: %w", err)
@@ -639,6 +640,7 @@ func convertWorkspaceBuild(
 		InitiatorUsername:  initiatorName,
 		Job:                convertProvisionerJob(job),
 		Deadline:           workspaceBuild.Deadline,
+		Reason:             codersdk.BuildReason(workspaceBuild.Reason),
 	}
 }
 
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -436,6 +436,7 @@ func (api *API) postWorkspacesByOrganization(rw http.ResponseWriter, r *http.Req
 			JobID:             provisionerJob.ID,
 			BuildNumber:       1,           // First build!
 			Deadline:          time.Time{}, // provisionerd will set this upon success
+			Reason:            database.BuildReasonInitiator,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert workspace build: %w", err)
@@ -806,6 +807,7 @@ func convertWorkspaces(ctx context.Context, db database.Store, workspaces []data
 			ProvisionerState:  workspaceBuild.ProvisionerState,
 			JobID:             workspaceBuild.JobID,
 			Deadline:          workspaceBuild.Deadline,
+			Reason:            workspaceBuild.Reason,
 		}
 	}
 	templateByID := map[uuid.UUID]database.Template{}
diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -33,8 +33,10 @@ func TestWorkspace(t *testing.T) {
 		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
 		workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
 
-		_, err := client.Workspace(context.Background(), workspace.ID)
+		ws, err := client.Workspace(context.Background(), workspace.ID)
 		require.NoError(t, err)
+		require.Equal(t, user.UserID, ws.LatestBuild.InitiatorID)
+		require.Equal(t, codersdk.BuildReasonInitiator, ws.LatestBuild.Reason)
 	})
 
 	t.Run("Deleted", func(t *testing.T) {
diff --git a/codersdk/workspacebuilds.go b/codersdk/workspacebuilds.go
@@ -19,6 +19,20 @@ const (
 	WorkspaceTransitionDelete WorkspaceTransition = "delete"
 )
 
+type BuildReason string
+
+const (
+	// "initiator" is used when a workspace build is triggered by a user.
+	// Combined with the initiator id/username, it indicates which user initiated the build.
+	BuildReasonInitiator BuildReason = "initiator"
+	// "autostart" is used when a build to start a workspace is triggered by Autostart.
+	// The initiator id/username in this case is the workspace owner and can be ignored.
+	BuildReasonAutostart BuildReason = "autostart"
+	// "autostop" is used when a build to stop a workspace is triggered by Autostop.
+	// The initiator id/username in this case is the workspace owner and can be ignored.
+	BuildReasonAutostop BuildReason = "autostop"
+)
+
 // WorkspaceBuild is an at-point representation of a workspace state.
 // BuildNumbers start at 1 and increase by 1 for each subsequent build
 type WorkspaceBuild struct {
@@ -37,6 +51,7 @@ type WorkspaceBuild struct {
 	InitiatorUsername  string              `json:"initiator_name"`
 	Job                ProvisionerJob      `json:"job"`
 	Deadline           time.Time           `json:"deadline"`
+	Reason             BuildReason         `db:"reason" json:"reason"`
 }
 
 // WorkspaceBuild returns a single workspace build for a workspace.
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts

Original file line number	Diff line number	Diff line change
`@@ -1744,6 +1744,7 @@ func (q *fakeQuerier) InsertWorkspaceBuild(_ context.Context, arg database.Inser`
`1744`	`1744`	`JobID: arg.JobID,`
`1745`	`1745`	`ProvisionerState: arg.ProvisionerState,`
`1746`	`1746`	`Deadline: arg.Deadline,`
	`1747`	`+ Reason: arg.Reason,`
`1747`	`1748`	`}`
`1748`	`1749`	`q.workspaceBuilds = append(q.workspaceBuilds, workspaceBuild)`
`1749`	`1750`	`return workspaceBuild, nil`
Original file line number	Diff line number	Diff line change
`@@ -439,6 +439,7 @@ func (api API) postWorkspaceBuilds(rw http.ResponseWriter, r http.Request) {`
`439`	`439`	`InitiatorID: apiKey.UserID,`
`440`	`440`	`Transition: database.WorkspaceTransition(createBuild.Transition),`
`441`	`441`	`JobID: provisionerJob.ID,`
	`442`	`+ Reason: database.BuildReasonInitiator,`
`442`	`443`	`})`
`443`	`444`	`if err != nil {`
`444`	`445`	`return xerrors.Errorf("insert workspace build: %w", err)`
`@@ -639,6 +640,7 @@ func convertWorkspaceBuild(`
`639`	`640`	`InitiatorUsername: initiatorName,`
`640`	`641`	`Job: convertProvisionerJob(job),`
`641`	`642`	`Deadline: workspaceBuild.Deadline,`
	`643`	`+ Reason: codersdk.BuildReason(workspaceBuild.Reason),`
`642`	`644`	`}`
`643`	`645`	`}`
`644`	`646`