Skip to content

feat(cli): show queue position during workspace builds #12606

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
merged 6 commits into from
Mar 18, 2024
Merged

feat(cli): show queue position during workspace builds #12606

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eb33f76
Initial implementation
dannykopping Mar 15, 2024
686c2b7
Adding tests
dannykopping Mar 15, 2024
993904c
Improve naming
dannykopping Mar 15, 2024
4df8a3b
Typo, naming
dannykopping Mar 15, 2024
b08e633
Merge branch 'main' of github.com:/coder/coder into dk/cliq
dannykopping Mar 18, 2024
4367e65
Ensuring tests don't run indefinitely
dannykopping Mar 18, 2024
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
Next Next commit
Initial implementation 
Signed-off-by: Danny Kopping <danny@coder.com>
  • Loading branch information
@dannykopping
dannykopping committed Mar 15, 2024
commit eb33f76c6dbf3d95003da1fd16beb76d3e9282e6
40 changes: 35 additions & 5 deletions cli/cliui/provisionerjob.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ func (err *ProvisionerJobError) Error() string {
return err.Message
}

const (
ProvisioningStateQueued = "Queued"
ProvisioningStateRunning = "Running"
)

// ProvisionerJob renders a provisioner job with interactive cancellation.
func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOptions) error {
if opts.FetchInterval == 0 {
Expand All @@ -63,8 +68,9 @@ func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOption
defer cancelFunc()

var (
currentStage = "Queued"
currentStage = ProvisioningStateQueued
currentStageStartedAt = time.Now().UTC()
currentQueuePos = -1

errChan = make(chan error, 1)
job codersdk.ProvisionerJob
Expand All @@ -74,7 +80,20 @@ func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOption
sw := &stageWriter{w: wr, verbose: opts.Verbose, silentLogs: opts.Silent}

printStage := func() {
sw.Start(currentStage)
out := currentStage

if currentStage == ProvisioningStateQueued && currentQueuePos > 0 {
var queuePos string
if currentQueuePos == 1 {
queuePos = "next"
} else {
queuePos = fmt.Sprintf("position: %d", currentQueuePos)
}

out = pretty.Sprintf(DefaultStyles.Warn, "%s (%s)", currentStage, queuePos)
}

sw.Start(out)
}

updateStage := func(stage string, startedAt time.Time) {
Expand Down Expand Up @@ -103,15 +122,26 @@ func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOption
errChan <- xerrors.Errorf("fetch: %w", err)
return
}
if job.QueuePosition != currentQueuePos {
initialState := currentQueuePos == -1

currentQueuePos = job.QueuePosition
// Print an update when the queue position changes, but:
// - not initially, because the stage is printed at startup
// - not when we first in the queue, because it's redundant
if !initialState && currentQueuePos != 0 {
printStage()
}
}
if job.StartedAt == nil {
return
}
if currentStage != "Queued" {
if currentStage != ProvisioningStateQueued {
// If another stage is already running, there's no need
// for us to notify the user we're running!
return
}
updateStage("Running", *job.StartedAt)
updateStage(ProvisioningStateRunning, *job.StartedAt)
}

if opts.Cancel != nil {
Expand Down Expand Up @@ -143,8 +173,8 @@ func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOption
}

// The initial stage needs to print after the signal handler has been registered.
printStage()
updateJob()
printStage()

logs, closer, err := opts.Logs()
if err != nil {
Expand Down
16 changes: 8 additions & 8 deletions cli/cliui/provisionerjob_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ func TestProvisionerJob(t *testing.T) {
close(test.Logs)
test.JobMutex.Unlock()
}()
test.PTY.ExpectMatch("Queued")
test.PTY.ExpectMatch(cliui.ProvisioningStateQueued)
test.Next <- struct{}{}
test.PTY.ExpectMatch("Queued")
test.PTY.ExpectMatch("Running")
test.PTY.ExpectMatch(cliui.ProvisioningStateQueued)
test.PTY.ExpectMatch(cliui.ProvisioningStateRunning)
test.Next <- struct{}{}
test.PTY.ExpectMatch("Running")
test.PTY.ExpectMatch(cliui.ProvisioningStateRunning)
})

t.Run("Stages", func(t *testing.T) {
Expand All @@ -71,9 +71,9 @@ func TestProvisionerJob(t *testing.T) {
close(test.Logs)
test.JobMutex.Unlock()
}()
test.PTY.ExpectMatch("Queued")
test.PTY.ExpectMatch(cliui.ProvisioningStateQueued)
test.Next <- struct{}{}
test.PTY.ExpectMatch("Queued")
test.PTY.ExpectMatch(cliui.ProvisioningStateQueued)
test.PTY.ExpectMatch("Something")
test.Next <- struct{}{}
test.PTY.ExpectMatch("Something")
Expand Down Expand Up @@ -104,11 +104,11 @@ func TestProvisionerJob(t *testing.T) {
close(test.Logs)
test.JobMutex.Unlock()
}()
test.PTY.ExpectMatch("Queued")
test.PTY.ExpectMatch(cliui.ProvisioningStateQueued)
test.Next <- struct{}{}
test.PTY.ExpectMatch("Gracefully canceling")
test.Next <- struct{}{}
test.PTY.ExpectMatch("Queued")
test.PTY.ExpectMatch(cliui.ProvisioningStateQueued)
})
}

Expand Down