mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00

Files

Susana Ferreira f044cc3550 feat: add provisioner daemon name to provisioner jobs responses (#17877 )

# Description

This PR adds the `worker_name` field to the provisioner jobs endpoint.

To achieve this, the following SQL query was updated:
-
`GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisioner`

As a result, the `codersdk.ProvisionerJob` type, which represents the
provisioner job API response, was modified to include the new field.

**Notes:** 
* As mentioned in
[comment](https://github.com/coder/coder/pull/17877#discussion_r2093218206),
the `GetProvisionerJobsByIDsWithQueuePosition` query was not changed due
to load concerns. This means that for template and template version
endpoints, `worker_id` will still be returned, but `worker_name` will
not.
* Similar to `worker_id`, the `worker_name` is only present once a job
is assigned to a provisioner daemon. For jobs in a pending state (not
yet assigned), neither `worker_id` nor `worker_name` will be returned.

---

# Affected Endpoints

- `/organizations/{organization}/provisionerjobs`
- `/organizations/{organization}/provisionerjobs/{job}`

---

# Testing

- Added new tests verifying that both `worker_id` and `worker_name` are
returned once a provisioner job reaches the **succeeded** state.
- Existing tests covering state transitions and other logic remain
unchanged, as they test different scenarios.

---

# Front-end Changes

Admin provisioner jobs dashboard:
<img width="1088" alt="Screenshot 2025-05-16 at 11 51 33"
src="https://github.com/user-attachments/assets/0e20e360-c615-4497-84b7-693777c5443e"
/>

Fixes: https://github.com/coder/coder/issues/16982

2025-05-19 16:05:39 +01:00

3.0 KiB

Generated

Raw Blame History

provisioner jobs list

List provisioner jobs

Aliases:

Usage

coder provisioner jobs list [flags]

Options

-s, --status


Type	`[pending\|running\|succeeded\|canceling\|canceled\|failed\|unknown]`
Environment	`$CODER_PROVISIONER_JOB_LIST_STATUS`

Filter by job status.

-l, --limit


Type	`int`
Environment	`$CODER_PROVISIONER_JOB_LIST_LIMIT`
Default	`50`

Limit the number of jobs returned.

-O, --org


Type	`string`
Environment	`$CODER_ORGANIZATION`

Select which organization (uuid or name) to use.

-c, --column


Type	`[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.

-o, --output


Type	`table\|json`
Default	`table`

Output format.

3.0 KiB Generated Raw Blame History