NotificationsYou must be signed in to change notification settings
Fork1.1k
Star11.6k

feat: add filtering options to provisioners list#19378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

brettkolodny merged 13 commits intomainfromrafrdz/offline-provisioners

Aug 21, 2025

Merged

feat: add filtering options to provisioners list#19378

brettkolodny merged 13 commits intomainfromrafrdz/offline-provisioners

Aug 21, 2025

Conversation

Copy link

Contributor

rafrdz commentedAug 15, 2025•
edited
Loading

Summary

In this pull request we're adding support for additional filtering options to theprovisioners list CLI command and the/provisionerdaemons API endpoint.

Resolves:#18783

Changes

Added CLI Options

--show-offline: When this option is provided, all provisioner daemons will be returned. This means that when--show-offline is not provided onlyidle andbusy provisioner daemons will be returned.
--status=<list_of_statuses>: When this option is provided with a comma-separated list of valid statuses (idle,busy, oroffline) only provisioner daemons that have these statuses will be returned.
--max-age=<duration>: When this option is provided with a valid duration value (e.g.,24h,30s) only provisioner daemons with alast_seen_at timestamp within the provided max age will be returned.

Query Params

?offline=true: Include offline provisioner daemons in the results. Offline provisioner daemons will be excluded if?offline=false or if offline is not provided.
?status=<list_of_statuses>: Include provisioner daemons with the specified statuses.
?max_age=<duration>: Include provisioner daemons with alast_seen_at timestamp within the max age duration.

Frontend

Since offline provisioners will not be returned by default anymore (--show-offline has to be provided to see them), a checkbox was added to the provisioners list page to allow for offline provisioners to be displayed
- A revamp of the provisioners page will be done in:Filtering and pagination on provisioner job list #17156, this checkbox change was just added to maintain currently functionality with the backend updates

Current provisioners page (without checkbox)

Provisioners page with checkbox (unchecked)

Provisioner page with checkbox (checked) and URL updated with query parameters

Show Offline vs Offline Status

To list offline provisioner daemons, users can either:

Include the--show-offline option

Includeoffline in the list of values provided to the--status option

Rafael Rodriguez added4 commits

August 13, 2025 21:43

feat: add show-offline option to provisioners list command

65e074e

feat: add status option to provisioners list command

fe50c08

Update query/tests to handle offline param or offline status

d55026e

feat: add max-age option to provisioners list command

95713c5

github-actionsbot assignedrafrdz

Aug 15, 2025

Rafael Rodriguez added2 commits

August 15, 2025 20:24

Fix tests: offline needs to be specified

7d21e85

Merge branch 'main' into rafrdz/offline-provisioners

4b7e4b4

rafrdz marked this pull request as draft

August 15, 2025 21:26

Rafael Rodriguez added4 commits

August 15, 2025 21:31

Remove unused golden files

0b86c21

Merge branch 'main' into rafrdz/offline-provisioners

72e1e5b

Add checkbox to show offline provisioners

09a9f84

Formatting fixes

506d596

rafrdz marked this pull request as ready for review

August 20, 2025 16:43

rafrdz requested a review fromaslilac as acode owner

August 20, 2025 16:43

rafrdz requested review froma team,Emyrk,aslilac andbrettkolodny and removed request fora team andaslilac

August 20, 2025 16:43

Copy link

Contributor

brettkolodny commentedAug 20, 2025

@rafrdz Going to take a look no! For the chromatic tests we typically self check those to make sure we didn't accidentally introduce some glaring UI bug. So you can go through those yourself when you have a chance, but feel free to ping me if you're having issues on that front

brettkolodny suggested changes

Aug 20, 2025

View reviewed changes

Copy link

Contributor

brettkolodny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Just a few small changes on the TS side. The backend changes look good to me but@Emyrk may want to take another look as well

...s/OrganizationSettingsPage/OrganizationProvisionersPage/OrganizationProvisionersPageView.tsx OutdatedShow resolvedHide resolved

...pages/OrganizationSettingsPage/OrganizationProvisionersPage/OrganizationProvisionersPage.tsx OutdatedShow resolvedHide resolved

Frontend updates based on PR feedback

ce5acac

Emyrk approved these changes

Aug 20, 2025

View reviewed changes

Copy link

Member

Emyrk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

backend 👍

coderd/database/queries/provisionerdaemons.sql

Comment on lines +114 to +144

		AND (
		sqlc.narg('max_age_ms')::bigint ISNULL
		ORpd.last_seen_at ISNULL
		ORpd.last_seen_at>= (NOW()- (sqlc.narg('max_age_ms')::bigint\|\|' ms')::interval)
		)
		AND (
		-- Always include online daemons
		(pd.last_seen_atIS NOT NULLANDpd.last_seen_at>= (NOW()- (@stale_interval_ms::bigint\|\|' ms')::interval))
		-- Include offline daemons if offline param is true or 'offline' status is requested
		OR (
		(pd.last_seen_at ISNULLORpd.last_seen_at< (NOW()- (@stale_interval_ms::bigint\|\|' ms')::interval))
		AND (
		COALESCE(sqlc.narg('offline')::bool, false)= true
		OR'offline'::provisioner_daemon_status= ANY(@statuses::provisioner_daemon_status[])
		)
		)
		)
		AND (
		-- Filter daemons by any statuses if provided
		COALESCE(array_length(@statuses::provisioner_daemon_status[],1),0)=0
		OR (current_job.idIS NOT NULLAND'busy'::provisioner_daemon_status= ANY(@statuses::provisioner_daemon_status[]))
		OR (current_job.id ISNULLAND'idle'::provisioner_daemon_status= ANY(@statuses::provisioner_daemon_status[]))
		OR (
		'offline'::provisioner_daemon_status= ANY(@statuses::provisioner_daemon_status[])
		AND (pd.last_seen_at ISNULLORpd.last_seen_at< (NOW()- (@stale_interval_ms::bigint\|\|' ms')::interval))
		)
		OR (
		COALESCE(sqlc.narg('offline')::bool, false)= true
		AND (pd.last_seen_at ISNULLORpd.last_seen_at< (NOW()- (@stale_interval_ms::bigint\|\|' ms')::interval))
		)
		)

Copy link

Member

EmyrkAug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

We usually doCASE ... WHEN, but this works

coderd/database/sdk2db/sdk2db.go

Comment on lines +1 to +16

		// Package sdk2db provides common conversion routines from codersdk types to database types
		package sdk2db

		import (
		"github.com/coder/coder/v2/coderd/database"
		"github.com/coder/coder/v2/coderd/database/db2sdk"
		"github.com/coder/coder/v2/codersdk"
		)

		funcProvisionerDaemonStatus(status codersdk.ProvisionerDaemonStatus) database.ProvisionerDaemonStatus {
		returndatabase.ProvisionerDaemonStatus(status)
		}

		funcProvisionerDaemonStatuses(params []codersdk.ProvisionerDaemonStatus) []database.ProvisionerDaemonStatus {
		returndb2sdk.List(params,ProvisionerDaemonStatus)
		}