Skip to content

fix: wait for build in task status load generator #20800

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
spikecurtis merged 1 commit into from
Nov 19, 2025
Merged

fix: wait for build in task status load generator #20800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 21 additions & 40 deletions scaletest/taskstatus/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,9 @@ import (
"cdr.dev/slog"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/codersdk/agentsdk"
"github.com/coder/quartz"
)

// createExternalWorkspaceResult contains the results from creating an external workspace.
type createExternalWorkspaceResult struct {
WorkspaceID uuid.UUID
AgentToken string
}

// client abstracts the details of using codersdk.Client for workspace operations.
// This interface allows for easier testing by enabling mock implementations and
// provides a cleaner separation of concerns.
Expand All @@ -27,9 +22,14 @@ type createExternalWorkspaceResult struct {
// 1. Create the client with newClient(coderClient)
// 2. Configure logging when the io.Writer is available in Run()
type client interface {
// createExternalWorkspace creates an external workspace and returns the workspace ID
// and agent token for the first external agent found in the workspace resources.
createExternalWorkspace(ctx context.Context, req codersdk.CreateWorkspaceRequest) (createExternalWorkspaceResult, error)
// CreateUserWorkspace creates a workspace for a user.
CreateUserWorkspace(ctx context.Context, userID string, req codersdk.CreateWorkspaceRequest) (codersdk.Workspace, error)

// WorkspaceByOwnerAndName retrieves a workspace by owner and name.
WorkspaceByOwnerAndName(ctx context.Context, owner string, name string, params codersdk.WorkspaceOptions) (codersdk.Workspace, error)

// WorkspaceExternalAgentCredentials retrieves credentials for an external agent.
WorkspaceExternalAgentCredentials(ctx context.Context, workspaceID uuid.UUID, agentName string) (codersdk.ExternalAgentCredentials, error)

// watchWorkspace watches for updates to a workspace.
watchWorkspace(ctx context.Context, workspaceID uuid.UUID) (<-chan codersdk.Workspace, error)
Expand All @@ -56,48 +56,28 @@ type appStatusPatcher interface {
// codersdk.Client.
type sdkClient struct {
coderClient *codersdk.Client
clock quartz.Clock
logger slog.Logger
}

// newClient creates a new client implementation using the provided codersdk.Client.
func newClient(coderClient *codersdk.Client) client {
return &sdkClient{
coderClient: coderClient,
clock: quartz.NewReal(),
}
}

func (c *sdkClient) createExternalWorkspace(ctx context.Context, req codersdk.CreateWorkspaceRequest) (createExternalWorkspaceResult, error) {
// Create the workspace
workspace, err := c.coderClient.CreateUserWorkspace(ctx, codersdk.Me, req)
if err != nil {
return createExternalWorkspaceResult{}, err
}

// Get the workspace with latest build details
workspace, err = c.coderClient.WorkspaceByOwnerAndName(ctx, codersdk.Me, workspace.Name, codersdk.WorkspaceOptions{})
if err != nil {
return createExternalWorkspaceResult{}, err
}
func (c *sdkClient) CreateUserWorkspace(ctx context.Context, userID string, req codersdk.CreateWorkspaceRequest) (codersdk.Workspace, error) {
return c.coderClient.CreateUserWorkspace(ctx, userID, req)
}

// Find external agents in resources
for _, resource := range workspace.LatestBuild.Resources {
if resource.Type != "coder_external_agent" || len(resource.Agents) == 0 {
continue
}

// Get credentials for the first agent
agent := resource.Agents[0]
credentials, err := c.coderClient.WorkspaceExternalAgentCredentials(ctx, workspace.ID, agent.Name)
if err != nil {
return createExternalWorkspaceResult{}, err
}

return createExternalWorkspaceResult{
WorkspaceID: workspace.ID,
AgentToken: credentials.AgentToken,
}, nil
}
func (c *sdkClient) WorkspaceByOwnerAndName(ctx context.Context, owner string, name string, params codersdk.WorkspaceOptions) (codersdk.Workspace, error) {
return c.coderClient.WorkspaceByOwnerAndName(ctx, owner, name, params)
}

return createExternalWorkspaceResult{}, xerrors.Errorf("no external agent found in workspace")
func (c *sdkClient) WorkspaceExternalAgentCredentials(ctx context.Context, workspaceID uuid.UUID, agentName string) (codersdk.ExternalAgentCredentials, error) {
return c.coderClient.WorkspaceExternalAgentCredentials(ctx, workspaceID, agentName)
}

func (c *sdkClient) watchWorkspace(ctx context.Context, workspaceID uuid.UUID) (<-chan codersdk.Workspace, error) {
Expand All @@ -118,6 +98,7 @@ func (c *sdkClient) deleteWorkspace(ctx context.Context, workspaceID uuid.UUID)

func (c *sdkClient) initialize(logger slog.Logger) {
// Configure the coder client logging
c.logger = logger
c.coderClient.SetLogger(logger)
c.coderClient.SetLogBodies(true)
}
Expand Down
95 changes: 88 additions & 7 deletions scaletest/taskstatus/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ import (

const statusUpdatePrefix = "scaletest status update:"

// createExternalWorkspaceResult contains the results from creating an external workspace.
type createExternalWorkspaceResult struct {
workspaceID uuid.UUID
agentToken string
}

type Runner struct {
client client
patcher appStatusPatcher
Expand Down Expand Up @@ -65,6 +71,10 @@ func (r *Runner) Run(ctx context.Context, name string, logs io.Writer) error {
}
}()

// ensure these labels are initialized, so we see the time series right away in prometheus.
r.cfg.Metrics.MissingStatusUpdatesTotal.WithLabelValues(r.cfg.MetricLabelValues...).Add(0)
r.cfg.Metrics.ReportTaskStatusErrorsTotal.WithLabelValues(r.cfg.MetricLabelValues...).Add(0)

logs = loadtestutil.NewSyncWriter(logs)
r.logger = slog.Make(sloghuman.Sink(logs)).Leveled(slog.LevelDebug).Named(name)
r.client.initialize(r.logger)
Expand All @@ -74,26 +84,23 @@ func (r *Runner) Run(ctx context.Context, name string, logs io.Writer) error {
slog.F("template_id", r.cfg.TemplateID),
slog.F("workspace_name", r.cfg.WorkspaceName))

result, err := r.client.createExternalWorkspace(ctx, codersdk.CreateWorkspaceRequest{
result, err := r.createExternalWorkspace(ctx, codersdk.CreateWorkspaceRequest{
TemplateID: r.cfg.TemplateID,
Name: r.cfg.WorkspaceName,
})
if err != nil {
r.cfg.Metrics.ReportTaskStatusErrorsTotal.WithLabelValues(r.cfg.MetricLabelValues...).Inc()
return xerrors.Errorf("create external workspace: %w", err)
}

// Set the workspace ID
r.workspaceID = result.WorkspaceID
r.workspaceID = result.workspaceID
r.logger.Info(ctx, "created external workspace", slog.F("workspace_id", r.workspaceID))

// Initialize the patcher with the agent token
r.patcher.initialize(r.logger, result.AgentToken)
r.patcher.initialize(r.logger, result.agentToken)
r.logger.Info(ctx, "initialized app status patcher with agent token")

// ensure these labels are initialized, so we see the time series right away in prometheus.
r.cfg.Metrics.MissingStatusUpdatesTotal.WithLabelValues(r.cfg.MetricLabelValues...).Add(0)
r.cfg.Metrics.ReportTaskStatusErrorsTotal.WithLabelValues(r.cfg.MetricLabelValues...).Add(0)

workspaceUpdatesCtx, cancelWorkspaceUpdates := context.WithCancel(ctx)
defer cancelWorkspaceUpdates()
workspaceUpdatesResult := make(chan error, 1)
Expand Down Expand Up @@ -257,3 +264,77 @@ func parseStatusMessage(message string) (int, bool) {
}
return msgNo, true
}

// createExternalWorkspace creates an external workspace and returns the workspace ID
// and agent token for the first external agent found in the workspace resources.
func (r *Runner) createExternalWorkspace(ctx context.Context, req codersdk.CreateWorkspaceRequest) (createExternalWorkspaceResult, error) {
// Create the workspace
workspace, err := r.client.CreateUserWorkspace(ctx, codersdk.Me, req)
if err != nil {
return createExternalWorkspaceResult{}, err
}

r.logger.Info(ctx, "waiting for workspace build to complete",
slog.F("workspace_name", workspace.Name),
slog.F("workspace_id", workspace.ID))

// Poll the workspace until the build is complete
var finalWorkspace codersdk.Workspace
buildComplete := xerrors.New("build complete") // sentinel error
waiter := r.clock.TickerFunc(ctx, 30*time.Second, func() error {
// Get the workspace with latest build details
workspace, err := r.client.WorkspaceByOwnerAndName(ctx, codersdk.Me, workspace.Name, codersdk.WorkspaceOptions{})
if err != nil {
r.logger.Error(ctx, "failed to poll workspace while waiting for build to complete", slog.Error(err))
return nil
}

jobStatus := workspace.LatestBuild.Job.Status
r.logger.Debug(ctx, "checking workspace build status",
slog.F("status", jobStatus),
slog.F("build_id", workspace.LatestBuild.ID))

switch jobStatus {
case codersdk.ProvisionerJobSucceeded:
// Build succeeded
r.logger.Info(ctx, "workspace build succeeded")
finalWorkspace = workspace
return buildComplete
case codersdk.ProvisionerJobFailed:
return xerrors.Errorf("workspace build failed: %s", workspace.LatestBuild.Job.Error)
case codersdk.ProvisionerJobCanceled:
return xerrors.Errorf("workspace build was canceled")
case codersdk.ProvisionerJobPending, codersdk.ProvisionerJobRunning, codersdk.ProvisionerJobCanceling:
// Still in progress, continue polling
return nil
default:
return xerrors.Errorf("unexpected job status: %s", jobStatus)
}
}, "createExternalWorkspace")

err = waiter.Wait()
if err != nil && !xerrors.Is(err, buildComplete) {
return createExternalWorkspaceResult{}, xerrors.Errorf("wait for build completion: %w", err)
}

// Find external agents in resources
for _, resource := range finalWorkspace.LatestBuild.Resources {
if resource.Type != "coder_external_agent" || len(resource.Agents) == 0 {
continue
}

// Get credentials for the first agent
agent := resource.Agents[0]
credentials, err := r.client.WorkspaceExternalAgentCredentials(ctx, finalWorkspace.ID, agent.Name)
if err != nil {
return createExternalWorkspaceResult{}, err
}

return createExternalWorkspaceResult{
workspaceID: finalWorkspace.ID,
agentToken: credentials.AgentToken,
}, nil
}

return createExternalWorkspaceResult{}, xerrors.Errorf("no external agent found in workspace")
}
Loading
Loading