feat(coderd): add provisioner daemon name to provisioner jobs responses

coder · ssncferreira · May 19, 2025 · May 16, 2025 · May 16, 2025 · May 16, 2025
commit 5fc39a0a69e3ec807150b3858cf0c3fd236fd658
diff --git a/cli/testdata/coder_list_--output_json.golden b/cli/testdata/coder_list_--output_json.golden
@@ -37,6 +37,7 @@
         "completed_at": "====[timestamp]=====",
         "status": "succeeded",
         "worker_id": "====[workspace build worker ID]=====",
+        "worker_name": "test-daemon",
         "file_id": "=====[workspace build file ID]======",
         "tags": {
           "owner": "",

diff --git a/cli/testdata/coder_provisioner_jobs_list_--help.golden b/cli/testdata/coder_provisioner_jobs_list_--help.golden
@@ -11,7 +11,7 @@ OPTIONS:
   -O, --org string, $CODER_ORGANIZATION
           Select which organization (uuid or name) to use.
 
-  -c, --column [id|created at|started at|completed at|canceled at|error|error code|status|worker id|file id|tags|queue position|queue size|organization id|template version id|workspace build id|type|available workers|template version name|template id|template name|template display name|template icon|workspace id|workspace name|organization|queue] (default: created at,id,type,template display name,status,queue,tags)
+  -c, --column [id|created at|started at|completed at|canceled at|error|error code|status|worker id|worker name|file id|tags|queue position|queue size|organization id|template version id|workspace build id|type|available workers|template version name|template id|template name|template display name|template icon|workspace id|workspace name|organization|queue] (default: created at,id,type,template display name,status,queue,tags)
           Columns to display in table output.
 
   -l, --limit int, $CODER_PROVISIONER_JOB_LIST_LIMIT (default: 50)

diff --git a/cli/testdata/coder_provisioner_jobs_list_--output_json.golden b/cli/testdata/coder_provisioner_jobs_list_--output_json.golden
@@ -6,6 +6,7 @@
     "completed_at": "====[timestamp]=====",
     "status": "succeeded",
     "worker_id": "====[workspace build worker ID]=====",
+    "worker_name": "test-daemon",
     "file_id": "=====[workspace build file ID]======",
     "tags": {
       "owner": "",
@@ -34,6 +35,7 @@
     "completed_at": "====[timestamp]=====",
     "status": "succeeded",
     "worker_id": "====[workspace build worker ID]=====",
+    "worker_name": "test-daemon",
     "file_id": "=====[workspace build file ID]======",
     "tags": {
       "owner": "",

diff --git a/cli/testdata/coder_provisioner_list.golden b/cli/testdata/coder_provisioner_list.golden
@@ -1,2 +1,2 @@
-CREATED AT            LAST SEEN AT          KEY NAME  NAME  VERSION       STATUS  TAGS                            
-====[timestamp]=====  ====[timestamp]=====  built-in  test  v0.0.0-devel  idle    map[owner: scope:organization]  
+CREATED AT            LAST SEEN AT          KEY NAME  NAME         VERSION       STATUS  TAGS                            
+====[timestamp]=====  ====[timestamp]=====  built-in  test-daemon  v0.0.0-devel  idle    map[owner: scope:organization]  
diff --git a/cli/testdata/coder_provisioner_list_--output_json.golden b/cli/testdata/coder_provisioner_list_--output_json.golden
@@ -5,7 +5,7 @@
     "key_id": "00000000-0000-0000-0000-000000000001",
     "created_at": "====[timestamp]=====",
     "last_seen_at": "====[timestamp]=====",
-    "name": "test",
+    "name": "test-daemon",
     "version": "v0.0.0-devel",
     "api_version": "1.6",
     "provisioners": [

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/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -96,6 +96,8 @@ import (
 	"github.com/coder/coder/v2/testutil"
 )
 
+const defaultTestDaemonName = "test-daemon"
+
 type Options struct {
 	// AccessURL denotes a custom access URL. By default we use the httptest
 	// server's URL. Setting this may result in unexpected behavior (especially
@@ -601,7 +603,7 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
 	setHandler(rootHandler)
 	var provisionerCloser io.Closer = nopcloser{}
 	if options.IncludeProvisionerDaemon {
-		provisionerCloser = NewTaggedProvisionerDaemon(t, coderAPI, "test", options.ProvisionerDaemonTags)
+		provisionerCloser = NewTaggedProvisionerDaemon(t, coderAPI, defaultTestDaemonName, options.ProvisionerDaemonTags)
 	}
 	client := codersdk.New(serverURL)
 	t.Cleanup(func() {
@@ -645,7 +647,7 @@ func (c *ProvisionerdCloser) Close() error {
 // well with coderd testing. It registers the "echo" provisioner for
 // quick testing.
 func NewProvisionerDaemon(t testing.TB, coderAPI *coderd.API) io.Closer {
-	return NewTaggedProvisionerDaemon(t, coderAPI, "test", nil)
+	return NewTaggedProvisionerDaemon(t, coderAPI, defaultTestDaemonName, nil)
 }
 
 func NewTaggedProvisionerDaemon(t testing.TB, coderAPI *coderd.API, name string, provisionerTags map[string]string) io.Closer {

diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -1267,6 +1267,14 @@ func (q *FakeQuerier) getProvisionerJobsByIDsWithQueuePositionLockedTagBasedQueu
 	// Step 6: Compute the final results with minimal checks
 	var results []database.GetProvisionerJobsByIDsWithQueuePositionRow
 	for _, job := range filteredJobs {
+		workerName := ""
+		// Add daemon name to provisioner job
+		for _, daemon := range q.provisionerDaemons {
+			if job.WorkerID.Valid && job.WorkerID.UUID == daemon.ID {
+				workerName = daemon.Name
+			}
+		}
+
 		// If the job has a computed rank, use it
 		if rank, found := jobQueueStats[job.ID]; found {
 			results = append(results, rank)
@@ -1278,6 +1286,7 @@ func (q *FakeQuerier) getProvisionerJobsByIDsWithQueuePositionLockedTagBasedQueu
 				ProvisionerJob: job,
 				QueuePosition:  0,
 				QueueSize:      0,
+				WorkerName:     workerName,
 			})
 		}
 	}
@@ -4848,6 +4857,13 @@ func (q *FakeQuerier) GetProvisionerJobsByOrganizationAndStatusWithQueuePosition
 				row.AvailableWorkers = append(row.AvailableWorkers, worker.ID)
 			}
 		}
+
+		// Add daemon name to provisioner job
+		for _, daemon := range q.provisionerDaemons {
+			if job.WorkerID.Valid && job.WorkerID.UUID == daemon.ID {
+				row.WorkerName = daemon.Name
+			}
+		}
 		rows = append(rows, row)
 	}
 

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
@@ -100,12 +100,15 @@ SELECT
 	fj.created_at,
 	sqlc.embed(pj),
 	fj.queue_position,
-	fj.queue_size
+	fj.queue_size,
+	COALESCE(pd.name, '') AS worker_name
 FROM
 	final_jobs fj
 		INNER JOIN provisioner_jobs pj
 				ON fj.id = pj.id -- Ensure we retrieve full details from `provisioner_jobs`.
                                  -- JOIN with pj is required for sqlc.embed(pj) to compile successfully.
+		LEFT JOIN provisioner_daemons pd -- Join to get the daemon name corresponding to the job's worker_id
+		  ON pj.worker_id = pd.id
 ORDER BY
 	fj.created_at;
 
@@ -160,7 +163,9 @@ SELECT
 	COALESCE(t.display_name, '') AS template_display_name,
 	COALESCE(t.icon, '') AS template_icon,
 	w.id AS workspace_id,
-	COALESCE(w.name, '') AS workspace_name
+	COALESCE(w.name, '') AS workspace_name,
+	-- Include the name of the provisioner_daemon associated to the job
+	COALESCE(pd.name, '') AS worker_name
 FROM
 	provisioner_jobs pj
 LEFT JOIN
@@ -185,6 +190,9 @@ LEFT JOIN
 		t.id = tv.template_id
 		AND t.organization_id = pj.organization_id
 	)
+LEFT JOIN
+	-- Join to get the daemon name corresponding to the job's worker_id
+	provisioner_daemons pd ON pd.id = pj.worker_id
 WHERE
 	pj.organization_id = @organization_id::uuid
 	AND (COALESCE(array_length(@ids::uuid[], 1), 0) = 0 OR pj.id = ANY(@ids::uuid[]))
@@ -200,7 +208,8 @@ GROUP BY
 	t.display_name,
 	t.icon,
 	w.id,
-	w.name
+	w.name,
+	pd.name
 ORDER BY
 	pj.created_at DESC
 LIMIT

diff --git a/coderd/provisionerjobs.go b/coderd/provisionerjobs.go
@@ -354,6 +354,7 @@ func convertProvisionerJob(pj database.GetProvisionerJobsByIDsWithQueuePositionR
 	provisionerJob := pj.ProvisionerJob
 	job := codersdk.ProvisionerJob{
 		ID:             provisionerJob.ID,
+		WorkerName:     pj.WorkerName,
 		OrganizationID: provisionerJob.OrganizationID,
 		CreatedAt:      provisionerJob.CreatedAt,
 		Type:           codersdk.ProvisionerJobType(provisionerJob.Type),
@@ -392,6 +393,7 @@ func convertProvisionerJob(pj database.GetProvisionerJobsByIDsWithQueuePositionR
 func convertProvisionerJobWithQueuePosition(pj database.GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerRow) codersdk.ProvisionerJob {
 	job := convertProvisionerJob(database.GetProvisionerJobsByIDsWithQueuePositionRow{
 		ProvisionerJob: pj.ProvisionerJob,
+		WorkerName:     pj.WorkerName,
 		QueuePosition:  pj.QueuePosition,
 		QueueSize:      pj.QueueSize,
 	})