Removes the Tasks API and task orchestration from coderd and codersdk: the `/api/v2/tasks` handlers, task middleware and search filters, task name generation, autobuild pause/resume logic, task notification enqueues, telemetry, and the codersdk task types. Regenerates apidoc, the API reference docs, and `typesGenerated.ts`. **Breaking change:** the Tasks API is removed; requests to `/api/v2/tasks` fail. Tasks was deprecated in v2.34. **Stack context:** Coder Tasks removal stack (CODAGT-642): #28743 frontend → #28788 CLI → #28789 API → #28790 provisioner → #29084 notifications → #29085 build reasons → #29086 tables → #28750 permissions. The last four PRs replace the single data-drop migration that used to live in #28750; each carries one concern and its own migration number. **Why:** with the UI (#28743) and CLI (#28788) gone, this deletes the server surface. Database tables, RBAC, and notification templates stay until the top of the stack so every layer builds and migrates independently. **What to scrutinize:** - The `enable-ai-tasks` option is removed outright (review feedback): configs still carrying `enableAITasks` fail to parse until the key is deleted. - provisionerdserver now writes `HasAITask: false` on template/build flags; the column and these lines are dropped in #29085. - `codersdk.ResourceTypeTask` stays so audit logs recorded before the removal keep rendering. **Validation:** `go build ./...`, `go vet ./...`, `go test ./codersdk/...`, site biome and tsc, CLI goldens regenerated, pre-commit hooks. **Size:** +242/-10,792 over 76 files; additions are regenerated docs/goldens and test fixture updates. > Created by Xum (AI agent) on behalf of @ibetitsmike.
241 lines
8.0 KiB
Go
241 lines
8.0 KiB
Go
package agentapi
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"golang.org/x/xerrors"
|
|
|
|
"cdr.dev/slog/v3"
|
|
agentproto "github.com/coder/coder/v2/agent/proto"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
|
"github.com/coder/coder/v2/coderd/database/dbtime"
|
|
"github.com/coder/coder/v2/coderd/notifications"
|
|
strutil "github.com/coder/coder/v2/coderd/util/strings"
|
|
"github.com/coder/coder/v2/coderd/workspacestats"
|
|
"github.com/coder/coder/v2/coderd/wspubsub"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/quartz"
|
|
)
|
|
|
|
type AppsAPI struct {
|
|
AgentID uuid.UUID
|
|
AgentFn func(context.Context) (database.WorkspaceAgent, error)
|
|
Database database.Store
|
|
Log slog.Logger
|
|
Workspace *CachedWorkspaceFields
|
|
PublishWorkspaceUpdateFn func(context.Context, uuid.UUID, wspubsub.WorkspaceEventKind) error
|
|
NotificationsEnqueuer notifications.Enqueuer
|
|
Clock quartz.Clock
|
|
}
|
|
|
|
func (a *AppsAPI) BatchUpdateAppHealths(ctx context.Context, req *agentproto.BatchUpdateAppHealthRequest) (*agentproto.BatchUpdateAppHealthResponse, error) {
|
|
a.Log.Debug(ctx, "got batch app health update",
|
|
slog.F("agent_id", a.AgentID.String()),
|
|
slog.F("updates", req.Updates),
|
|
)
|
|
|
|
if len(req.Updates) == 0 {
|
|
return &agentproto.BatchUpdateAppHealthResponse{}, nil
|
|
}
|
|
|
|
apps, err := a.Database.GetWorkspaceAppsByAgentID(ctx, a.AgentID)
|
|
if err != nil {
|
|
return nil, xerrors.Errorf("get workspace apps by agent ID %q: %w", a.AgentID, err)
|
|
}
|
|
|
|
var newApps []database.WorkspaceApp
|
|
for _, update := range req.Updates {
|
|
updateID, err := uuid.FromBytes(update.Id)
|
|
if err != nil {
|
|
return nil, xerrors.Errorf("parse workspace app ID %q: %w", update.Id, err)
|
|
}
|
|
|
|
old := func() *database.WorkspaceApp {
|
|
for _, app := range apps {
|
|
if app.ID == updateID {
|
|
return &app
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}()
|
|
if old == nil {
|
|
return nil, xerrors.Errorf("workspace app ID %q not found", updateID)
|
|
}
|
|
|
|
if old.HealthcheckUrl == "" {
|
|
return nil, xerrors.Errorf("workspace app %q (%q) does not have healthchecks enabled", updateID, old.Slug)
|
|
}
|
|
|
|
var newHealth database.WorkspaceAppHealth
|
|
switch update.Health {
|
|
case agentproto.AppHealth_DISABLED:
|
|
newHealth = database.WorkspaceAppHealthDisabled
|
|
case agentproto.AppHealth_INITIALIZING:
|
|
newHealth = database.WorkspaceAppHealthInitializing
|
|
case agentproto.AppHealth_HEALTHY:
|
|
newHealth = database.WorkspaceAppHealthHealthy
|
|
case agentproto.AppHealth_UNHEALTHY:
|
|
newHealth = database.WorkspaceAppHealthUnhealthy
|
|
default:
|
|
return nil, xerrors.Errorf("unknown health status %q for app %q (%q)", update.Health, updateID, old.Slug)
|
|
}
|
|
|
|
// Don't bother updating if the value hasn't changed.
|
|
if old.Health == newHealth {
|
|
continue
|
|
}
|
|
old.Health = newHealth
|
|
|
|
newApps = append(newApps, *old)
|
|
}
|
|
|
|
for _, app := range newApps {
|
|
err = a.Database.UpdateWorkspaceAppHealthByID(ctx, database.UpdateWorkspaceAppHealthByIDParams{
|
|
ID: app.ID,
|
|
Health: app.Health,
|
|
})
|
|
if err != nil {
|
|
return nil, xerrors.Errorf("update workspace app health for app %q (%q): %w", app.ID, app.Slug, err)
|
|
}
|
|
}
|
|
|
|
if a.PublishWorkspaceUpdateFn != nil && len(newApps) > 0 {
|
|
err = a.PublishWorkspaceUpdateFn(ctx, a.AgentID, wspubsub.WorkspaceEventKindAppHealthUpdate)
|
|
if err != nil {
|
|
return nil, xerrors.Errorf("publish workspace update: %w", err)
|
|
}
|
|
}
|
|
return &agentproto.BatchUpdateAppHealthResponse{}, nil
|
|
}
|
|
|
|
func (a *AppsAPI) UpdateAppStatus(ctx context.Context, req *agentproto.UpdateAppStatusRequest) (*agentproto.UpdateAppStatusResponse, error) {
|
|
if len(req.Message) > 160 {
|
|
return nil, codersdk.NewError(http.StatusBadRequest, codersdk.Response{
|
|
Message: "Message is too long.",
|
|
Detail: "Message must be less than 160 characters.",
|
|
Validations: []codersdk.ValidationError{
|
|
{Field: "message", Detail: "Message must be less than 160 characters."},
|
|
},
|
|
})
|
|
}
|
|
|
|
var dbState database.WorkspaceAppStatusState
|
|
switch req.State {
|
|
case agentproto.UpdateAppStatusRequest_COMPLETE:
|
|
dbState = database.WorkspaceAppStatusStateComplete
|
|
case agentproto.UpdateAppStatusRequest_FAILURE:
|
|
dbState = database.WorkspaceAppStatusStateFailure
|
|
case agentproto.UpdateAppStatusRequest_WORKING:
|
|
dbState = database.WorkspaceAppStatusStateWorking
|
|
case agentproto.UpdateAppStatusRequest_IDLE:
|
|
dbState = database.WorkspaceAppStatusStateIdle
|
|
default:
|
|
return nil, codersdk.NewError(http.StatusBadRequest, codersdk.Response{
|
|
Message: "Invalid state provided.",
|
|
Detail: fmt.Sprintf("invalid state: %q", req.State),
|
|
Validations: []codersdk.ValidationError{
|
|
{Field: "state", Detail: "State must be one of: complete, failure, working, idle."},
|
|
},
|
|
})
|
|
}
|
|
|
|
app, err := a.Database.GetWorkspaceAppByAgentIDAndSlug(ctx, database.GetWorkspaceAppByAgentIDAndSlugParams{
|
|
AgentID: a.AgentID,
|
|
Slug: req.Slug,
|
|
})
|
|
if err != nil {
|
|
return nil, codersdk.NewError(http.StatusBadRequest, codersdk.Response{
|
|
Message: "Failed to get workspace app.",
|
|
Detail: fmt.Sprintf("No app found with slug %q", req.Slug),
|
|
})
|
|
}
|
|
|
|
ws, ok := a.Workspace.AsWorkspaceIdentity()
|
|
if !ok {
|
|
return nil, codersdk.NewError(http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Workspace identity not cached.",
|
|
})
|
|
}
|
|
|
|
// Treat the message as untrusted input.
|
|
cleaned := strutil.UISanitize(req.Message)
|
|
|
|
// Get the latest status for the workspace app to detect no-op updates
|
|
// nolint:gocritic // This is a system restricted operation.
|
|
latestAppStatus, err := a.Database.GetLatestWorkspaceAppStatusByAppID(dbauthz.AsSystemRestricted(ctx), app.ID)
|
|
if err != nil && !xerrors.Is(err, sql.ErrNoRows) {
|
|
return nil, codersdk.NewError(http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to get latest workspace app status.",
|
|
Detail: err.Error(),
|
|
})
|
|
}
|
|
// If no rows found, latestAppStatus will be a zero-value struct (ID == uuid.Nil)
|
|
|
|
// nolint:gocritic // This is a system restricted operation.
|
|
_, err = a.Database.InsertWorkspaceAppStatus(dbauthz.AsSystemRestricted(ctx), database.InsertWorkspaceAppStatusParams{
|
|
ID: uuid.New(),
|
|
CreatedAt: dbtime.Now(),
|
|
WorkspaceID: ws.ID,
|
|
AgentID: a.AgentID,
|
|
AppID: app.ID,
|
|
State: dbState,
|
|
Message: cleaned,
|
|
Uri: sql.NullString{
|
|
String: req.Uri,
|
|
Valid: req.Uri != "",
|
|
},
|
|
})
|
|
if err != nil {
|
|
return nil, codersdk.NewError(http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to insert workspace app status.",
|
|
Detail: err.Error(),
|
|
})
|
|
}
|
|
|
|
if a.PublishWorkspaceUpdateFn != nil {
|
|
err = a.PublishWorkspaceUpdateFn(ctx, a.AgentID, wspubsub.WorkspaceEventKindAgentAppStatusUpdate)
|
|
if err != nil {
|
|
return nil, codersdk.NewError(http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to publish workspace update.",
|
|
Detail: err.Error(),
|
|
})
|
|
}
|
|
}
|
|
|
|
if shouldBump(dbState, latestAppStatus) {
|
|
// We pass time.Time{} for nextAutostart since we don't have access to
|
|
// TemplateScheduleStore here. The activity bump logic handles this by
|
|
// defaulting to the template's activity_bump duration (typically 1 hour).
|
|
workspacestats.ActivityBumpWorkspace(ctx, a.Log, a.Database, ws.ID, time.Time{}, workspacestats.ActivityBumpReasonAppActivity)
|
|
}
|
|
// just return a blank response because it doesn't contain any settable fields at present.
|
|
return new(agentproto.UpdateAppStatusResponse), nil
|
|
}
|
|
|
|
func shouldBump(dbState database.WorkspaceAppStatusState, latestAppStatus database.WorkspaceAppStatus) bool {
|
|
// Bump deadline when agent reports working or transitions away from working.
|
|
// This prevents auto-pause during active work and gives users time to interact
|
|
// after work completes.
|
|
|
|
// Bump if reporting working state.
|
|
if dbState == database.WorkspaceAppStatusStateWorking {
|
|
return true
|
|
}
|
|
|
|
// Bump if transitioning away from working state.
|
|
if latestAppStatus.ID != uuid.Nil {
|
|
prevState := latestAppStatus.State
|
|
if prevState == database.WorkspaceAppStatusStateWorking {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|