Add tags param to provisioner daemons endpoint

coder · SasSwart · Nov 15, 2024 · Nov 8, 2024 · Nov 8, 2024 · Nov 8, 2024
commit 8bf79c8e2432530b071c71c1a4cc136a999fc6fb
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/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/provisionerdaemons.sql b/coderd/database/queries/provisionerdaemons.sql
@@ -11,14 +11,10 @@ FROM
 	provisioner_daemons
 WHERE
 	-- This is the original search criteria:
-	(@organization_id :: uuid IS NULL OR organization_id = @organization_id :: uuid)
+	organization_id = @organization_id :: uuid
 	AND
 	-- adding support for searching by tags:
-	(@tags :: jsonb IS NULL OR tags_compatible(@tags :: jsonb, provisioner_daemons.tags :: jsonb))
-	AND
-	-- Because we're adding @tags as a second search parameter, we need to do this check to
-	-- ensure that the first parameter's behavior remains unchanged when no second parameter is provided:
-	(@organization_id :: uuid IS NOT NULL OR @tags IS NOT NULL);
+	(@tags :: jsonb IS NULL OR tags_compatible(@tags :: jsonb, provisioner_daemons.tags :: jsonb));
 
 -- name: DeleteOldProvisionerDaemons :exec
 -- Delete provisioner daemons that have been created at least a week ago

diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"net/url"
 	"strings"
 	"time"
 
@@ -314,11 +315,21 @@ func (c *Client) ProvisionerDaemons(ctx context.Context) ([]ProvisionerDaemon, e
 	return daemons, json.NewDecoder(res.Body).Decode(&daemons)
 }
 
-func (c *Client) OrganizationProvisionerDaemons(ctx context.Context, organizationID uuid.UUID) ([]ProvisionerDaemon, error) {
-	res, err := c.Request(ctx, http.MethodGet,
-		fmt.Sprintf("/api/v2/organizations/%s/provisionerdaemons", organizationID.String()),
-		nil,
-	)
+func (c *Client) OrganizationProvisionerDaemons(ctx context.Context, organizationID uuid.UUID, tags []string) ([]ProvisionerDaemon, error) {
+	baseURL := fmt.Sprintf("/api/v2/organizations/%s/provisionerdaemons", organizationID.String())
+
+	queryParams := url.Values{}
+	if len(tags) > 0 {
+		for _, tag := range tags {
+			queryParams.Add("tags", tag)
+		}
+	}
+
+	if len(queryParams) > 0 {
+		baseURL = fmt.Sprintf("%s?%s", baseURL, queryParams.Encode())
+	}
+
+	res, err := c.Request(ctx, http.MethodGet, baseURL, nil)
 	if err != nil {
 		return nil, xerrors.Errorf("execute request: %w", err)
 	}

diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md
diff --git a/enterprise/cli/provisionerdaemonstart_test.go b/enterprise/cli/provisionerdaemonstart_test.go
@@ -236,7 +236,7 @@ func TestProvisionerDaemon_SessionToken(t *testing.T) {
 		var daemons []codersdk.ProvisionerDaemon
 		var err error
 		require.Eventually(t, func() bool {
-			daemons, err = client.OrganizationProvisionerDaemons(ctx, anotherOrg.ID)
+			daemons, err = client.OrganizationProvisionerDaemons(ctx, anotherOrg.ID, nil)
 			if err != nil {
 				return false
 			}
@@ -282,7 +282,7 @@ func TestProvisionerDaemon_ProvisionerKey(t *testing.T) {
 
 		var daemons []codersdk.ProvisionerDaemon
 		require.Eventually(t, func() bool {
-			daemons, err = client.OrganizationProvisionerDaemons(ctx, user.OrganizationID)
+			daemons, err = client.OrganizationProvisionerDaemons(ctx, user.OrganizationID, nil)
 			if err != nil {
 				return false
 			}
@@ -376,7 +376,7 @@ func TestProvisionerDaemon_ProvisionerKey(t *testing.T) {
 
 		var daemons []codersdk.ProvisionerDaemon
 		require.Eventually(t, func() bool {
-			daemons, err = client.OrganizationProvisionerDaemons(ctx, anotherOrg.ID)
+			daemons, err = client.OrganizationProvisionerDaemons(ctx, anotherOrg.ID, nil)
 			if err != nil {
 				return false
 			}

diff --git a/enterprise/coderd/provisionerdaemons.go b/enterprise/coderd/provisionerdaemons.go
@@ -3,6 +3,7 @@ package coderd
 import (
 	"context"
 	"database/sql"
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
@@ -56,13 +57,22 @@ func (api *API) provisionerDaemonsEnabledMW(next http.Handler) http.Handler {
 // @Produce json
 // @Tags Enterprise
 // @Param organization path string true "Organization ID" format(uuid)
+// @Param tags query []string false "Provisioner tags to filter by"
 // @Success 200 {array} codersdk.ProvisionerDaemon
 // @Router /organizations/{organization}/provisionerdaemons [get]
 func (api *API) provisionerDaemons(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	org := httpmw.OrganizationParam(r)
 
-	daemons, err := api.Database.GetProvisionerDaemonsByOrganization(ctx, database.GetProvisionerDaemonsByOrganizationParams{OrganizationID: org.ID})
+	tags := provisionerTags(r)
+
+	daemons, err := api.Database.GetProvisionerDaemonsByOrganization(
+		ctx,
+		database.GetProvisionerDaemonsByOrganizationParams{
+			OrganizationID: org.ID,
+			Tags:           tags,
+		},
+	)
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
 			Message: "Internal error fetching provisioner daemons.",
@@ -74,6 +84,24 @@ func (api *API) provisionerDaemons(rw http.ResponseWriter, r *http.Request) {
 	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.List(daemons, db2sdk.ProvisionerDaemon))
 }
 
+func provisionerTags(r *http.Request) json.RawMessage {
+	tags := r.URL.Query()["tags"]
+	if len(tags) == 0 {
+		return json.RawMessage("{}")
+	}
+
+	var pairs []string
+	for _, tag := range tags {
+		parts := strings.SplitN(tag, "=", 2)
+		if len(parts) == 2 {
+			pairs = append(pairs, fmt.Sprintf(`%q:%q`, parts[0], parts[1]))
+		}
+	}
+
+	jsonString := fmt.Sprintf("{%s}", strings.Join(pairs, ","))
+	return json.RawMessage(jsonString)
+}
+
 type provisiionerDaemonAuthResponse struct {
 	keyID uuid.UUID
 	orgID uuid.UUID

diff --git a/enterprise/coderd/provisionerdaemons_test.go b/enterprise/coderd/provisionerdaemons_test.go
@@ -768,7 +768,7 @@ func TestGetProvisionerDaemons(t *testing.T) {
 		require.NoError(t, err)
 		srv.DRPCConn().Close()
 
-		daemons, err := orgAdmin.OrganizationProvisionerDaemons(ctx, org.ID)
+		daemons, err := orgAdmin.OrganizationProvisionerDaemons(ctx, org.ID, nil)
 		require.NoError(t, err)
 		require.Len(t, daemons, 1)