mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
77306f3de1
This change adds provisioner daemon ID filter to the provisioner daemons endpoint, and also implements the limiting to 50 results. Test coverage is greatly improved and template information for jobs associated to the daemon was also fixed. Updates #15084 Updates #15192 Related #16532
108 lines
3.7 KiB
Go
108 lines
3.7 KiB
Go
package coderd
|
|
|
|
import (
|
|
"database/sql"
|
|
"net/http"
|
|
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/db2sdk"
|
|
"github.com/coder/coder/v2/coderd/httpapi"
|
|
"github.com/coder/coder/v2/coderd/httpmw"
|
|
"github.com/coder/coder/v2/coderd/provisionerdserver"
|
|
"github.com/coder/coder/v2/coderd/util/ptr"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
)
|
|
|
|
// @Summary Get provisioner daemons
|
|
// @ID get-provisioner-daemons
|
|
// @Security CoderSessionToken
|
|
// @Produce json
|
|
// @Tags Provisioning
|
|
// @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.ProvisionerDaemon
|
|
// @Router /organizations/{organization}/provisionerdaemons [get]
|
|
func (api *API) provisionerDaemons(rw http.ResponseWriter, r *http.Request) {
|
|
var (
|
|
ctx = r.Context()
|
|
org = httpmw.OrganizationParam(r)
|
|
)
|
|
|
|
qp := r.URL.Query()
|
|
p := httpapi.NewQueryParamParser()
|
|
limit := p.PositiveInt32(qp, 50, "limit")
|
|
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{
|
|
Message: "Invalid query parameters.",
|
|
Validations: p.Errors,
|
|
})
|
|
return
|
|
}
|
|
|
|
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
|
|
}
|
|
}
|
|
|
|
daemons, err := api.Database.GetProvisionerDaemonsWithStatusByOrganization(
|
|
ctx,
|
|
database.GetProvisionerDaemonsWithStatusByOrganizationParams{
|
|
OrganizationID: org.ID,
|
|
StaleIntervalMS: provisionerdserver.StaleInterval.Milliseconds(),
|
|
Limit: sql.NullInt32{Int32: limit, Valid: limit > 0},
|
|
IDs: ids,
|
|
Tags: tags,
|
|
},
|
|
)
|
|
if err != nil {
|
|
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Internal error fetching provisioner daemons.",
|
|
Detail: err.Error(),
|
|
})
|
|
return
|
|
}
|
|
|
|
httpapi.Write(ctx, rw, http.StatusOK, db2sdk.List(daemons, func(dbDaemon database.GetProvisionerDaemonsWithStatusByOrganizationRow) codersdk.ProvisionerDaemon {
|
|
pd := db2sdk.ProvisionerDaemon(dbDaemon.ProvisionerDaemon)
|
|
var currentJob, previousJob *codersdk.ProvisionerDaemonJob
|
|
if dbDaemon.CurrentJobID.Valid {
|
|
currentJob = &codersdk.ProvisionerDaemonJob{
|
|
ID: dbDaemon.CurrentJobID.UUID,
|
|
Status: codersdk.ProvisionerJobStatus(dbDaemon.CurrentJobStatus.ProvisionerJobStatus),
|
|
TemplateName: dbDaemon.CurrentJobTemplateName,
|
|
TemplateIcon: dbDaemon.CurrentJobTemplateIcon,
|
|
TemplateDisplayName: dbDaemon.CurrentJobTemplateDisplayName,
|
|
}
|
|
}
|
|
if dbDaemon.PreviousJobID.Valid {
|
|
previousJob = &codersdk.ProvisionerDaemonJob{
|
|
ID: dbDaemon.PreviousJobID.UUID,
|
|
Status: codersdk.ProvisionerJobStatus(dbDaemon.PreviousJobStatus.ProvisionerJobStatus),
|
|
TemplateName: dbDaemon.PreviousJobTemplateName,
|
|
TemplateIcon: dbDaemon.PreviousJobTemplateIcon,
|
|
TemplateDisplayName: dbDaemon.PreviousJobTemplateDisplayName,
|
|
}
|
|
}
|
|
|
|
// Add optional fields.
|
|
pd.KeyName = &dbDaemon.KeyName
|
|
pd.Status = ptr.Ref(codersdk.ProvisionerDaemonStatus(dbDaemon.Status))
|
|
pd.CurrentJob = currentJob
|
|
pd.PreviousJob = previousJob
|
|
|
|
return pd
|
|
}))
|
|
}
|