feat(coderd): add support for provisioner job id and tag filter (coder#16556)

This change adds to new filters to the provisionerjobs endpoint, id
(array) and tags (map).

Updates coder#15084
Updates coder#15192
Related coder#16532

Author: mafredri

coderd/apidoc/docs.go

@@ -4170,6 +4170,9 @@ func (q *FakeQuerier) GetProvisionerJobsByOrganizationAndStatusWithQueuePosition
 		if len(arg.IDs) > 0 && !slices.Contains(arg.IDs, job.ID) {
 			continue
 		}
+		if len(arg.Tags) > 0 && !tagsSubset(job.Tags, arg.Tags) {
+			continue
+		}
 
 		row := database.GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerRow{
 			ProvisionerJob: rowQP.ProvisionerJob,

coderd/apidoc/swagger.json

@@ -158,6 +158,7 @@ WHERE
 	(sqlc.narg('organization_id')::uuid IS NULL OR pj.organization_id = @organization_id)
 	AND (COALESCE(array_length(@ids::uuid[], 1), 0) = 0 OR pj.id = ANY(@ids::uuid[]))
 	AND (COALESCE(array_length(@status::provisioner_job_status[], 1), 0) = 0 OR pj.job_status = ANY(@status::provisioner_job_status[]))
+	AND (@tags::tagset = 'null'::tagset OR provisioner_tagset_contains(pj.tags::tagset, @tags::tagset))
 GROUP BY
 	pj.id,
 	qp.queue_position,

coderd/database/dbmem/dbmem.go

@@ -72,7 +72,9 @@ func (api *API) provisionerJob(rw http.ResponseWriter, r *http.Request) {
 // @Tags Organizations
 // @Param organization path string true "Organization ID" format(uuid)
 // @Param limit query int false "Page limit"
+// @Param ids query []string false "Filter results by job IDs" format(uuid)
 // @Param status query codersdk.ProvisionerJobStatus false "Filter results by status" enums(pending,running,succeeded,canceling,canceled,failed)
+// @Param tags query object false "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})"
 // @Success 200 {array} codersdk.ProvisionerJob
 // @Router /organizations/{organization}/provisionerjobs [get]
 func (api *API) provisionerJobs(rw http.ResponseWriter, r *http.Request) {
@@ -103,6 +105,10 @@ func (api *API) handleAuthAndFetchProvisionerJobs(rw http.ResponseWriter, r *htt
 	p := httpapi.NewQueryParamParser()
 	limit := p.PositiveInt32(qp, 50, "limit")
 	status := p.Strings(qp, nil, "status")
+	if ids == nil {
+		ids = p.UUIDs(qp, nil, "ids")
+	}
+	tagsRaw := p.String(qp, "", "tags")
 	p.ErrorExcessParams(qp)
 	if len(p.Errors) > 0 {
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
@@ -112,11 +118,23 @@ func (api *API) handleAuthAndFetchProvisionerJobs(rw http.ResponseWriter, r *htt
 		return nil, false
 	}
 
+	tags := database.StringMap{}
+	if tagsRaw != "" {
+		if err := tags.Scan([]byte(tagsRaw)); err != nil {
+			httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
+				Message: "Invalid tags query parameter",
+				Detail:  err.Error(),
+			})
+			return nil, false
+		}
+	}
+
 	jobs, err := api.Database.GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisioner(ctx, database.GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerParams{
 		OrganizationID: uuid.NullUUID{UUID: org.ID, Valid: true},
 		Status:         slice.StringEnums[database.ProvisionerJobStatus](status),
 		Limit:          sql.NullInt32{Int32: limit, Valid: limit > 0},
 		IDs:            ids,
+		Tags:           tags,
 	})
 	if err != nil {
 		if httpapi.Is404Error(err) {

coderd/database/queries.sql.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"database/sql"
 	"encoding/json"
+	"strconv"
 	"testing"
 	"time"
 
@@ -65,9 +66,10 @@ func TestProvisionerJobs(t *testing.T) {
 	})
 
 	// Add more jobs than the default limit.
-	for range 60 {
+	for i := range 60 {
 		dbgen.ProvisionerJob(t, db, nil, database.ProvisionerJob{
 			OrganizationID: owner.OrganizationID,
+			Tags:           database.StringMap{"count": strconv.Itoa(i)},
 		})
 	}
 
@@ -132,6 +134,16 @@ func TestProvisionerJobs(t *testing.T) {
 		require.Len(t, jobs, 50)
 	})
 
+	t.Run("IDs", func(t *testing.T) {
+		t.Parallel()
+		ctx := testutil.Context(t, testutil.WaitMedium)
+		jobs, err := templateAdminClient.OrganizationProvisionerJobs(ctx, owner.OrganizationID, &codersdk.OrganizationProvisionerJobsOptions{
+			IDs: []uuid.UUID{workspace.LatestBuild.Job.ID, version.Job.ID},
+		})
+		require.NoError(t, err)
+		require.Len(t, jobs, 2)
+	})
+
 	t.Run("Status", func(t *testing.T) {
 		t.Parallel()
 		ctx := testutil.Context(t, testutil.WaitMedium)
@@ -142,6 +154,16 @@ func TestProvisionerJobs(t *testing.T) {
 		require.Len(t, jobs, 1)
 	})
 
+	t.Run("Tags", func(t *testing.T) {
+		t.Parallel()
+		ctx := testutil.Context(t, testutil.WaitMedium)
+		jobs, err := templateAdminClient.OrganizationProvisionerJobs(ctx, owner.OrganizationID, &codersdk.OrganizationProvisionerJobsOptions{
+			Tags: map[string]string{"count": "1"},
+		})
+		require.NoError(t, err)
+		require.Len(t, jobs, 1)
+	})
+
 	t.Run("Limit", func(t *testing.T) {
 		t.Parallel()
 		ctx := testutil.Context(t, testutil.WaitMedium)

coderd/database/queries/provisionerjobs.sql

@@ -346,7 +346,9 @@ func (c *Client) OrganizationProvisionerDaemons(ctx context.Context, organizatio
 
 type OrganizationProvisionerJobsOptions struct {
 	Limit  int
+	IDs    []uuid.UUID
 	Status []ProvisionerJobStatus
+	Tags   map[string]string
 }
 
 func (c *Client) OrganizationProvisionerJobs(ctx context.Context, organizationID uuid.UUID, opts *OrganizationProvisionerJobsOptions) ([]ProvisionerJob, error) {
@@ -355,9 +357,19 @@ func (c *Client) OrganizationProvisionerJobs(ctx context.Context, organizationID
 		if opts.Limit > 0 {
 			qp.Add("limit", strconv.Itoa(opts.Limit))
 		}
+		if len(opts.IDs) > 0 {
+			qp.Add("ids", joinSliceStringer(opts.IDs))
+		}
 		if len(opts.Status) > 0 {
 			qp.Add("status", joinSlice(opts.Status))
 		}
+		if len(opts.Tags) > 0 {
+			tagsRaw, err := json.Marshal(opts.Tags)
+			if err != nil {
+				return nil, xerrors.Errorf("marshal tags: %w", err)
+			}
+			qp.Add("tags", string(tagsRaw))
+		}
 	}
 
 	res, err := c.Request(ctx, http.MethodGet,
@@ -401,6 +413,14 @@ func joinSlice[T ~string](s []T) string {
 	return strings.Join(ss, ",")
 }
 
+func joinSliceStringer[T fmt.Stringer](s []T) string {
+	var ss []string
+	for _, v := range s {
+		ss = append(ss, v.String())
+	}
+	return strings.Join(ss, ",")
+}
+
 // CreateTemplateVersion processes source-code and optionally associates the version with a template.
 // Executing without a template is useful for validating source-code.
 func (c *Client) CreateTemplateVersion(ctx context.Context, organizationID uuid.UUID, req CreateTemplateVersionRequest) (TemplateVersion, error) {