- Notifications
You must be signed in to change notification settings - Fork928
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
eb33f76 Initial implementation
dannykopping686c2b7 Adding tests
dannykopping993904c Improve naming
dannykopping4df8a3b Typo, naming
dannykoppingb08e633 Merge branch 'main' of github.com:/coder/coder into dk/cliq
dannykopping4367e65 Ensuring tests don't run indefinitely
dannykoppingFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
40 changes: 35 additions & 5 deletionscli/cliui/provisionerjob.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 { | ||
| @@ -63,8 +68,9 @@ func ProvisionerJob(ctx context.Context, wr io.Writer, opts ProvisionerJobOption | ||
| defer cancelFunc() | ||
| var ( | ||
| currentStage =ProvisioningStateQueued | ||
| currentStageStartedAt = time.Now().UTC() | ||
| currentQueuePos = -1 | ||
| errChan = make(chan error, 1) | ||
| job codersdk.ProvisionerJob | ||
| @@ -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() { | ||
| out := currentStage | ||
dannykopping marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| 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) | ||
mtojek marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| updateStage := func(stage string, startedAt time.Time) { | ||
| @@ -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're first in the queue, because it's redundant | ||
| if !initialState && currentQueuePos != 0 { | ||
| printStage() | ||
| } | ||
| } | ||
| if job.StartedAt == nil { | ||
| return | ||
| } | ||
| if currentStage !=ProvisioningStateQueued { | ||
| // If another stage is already running, there's no need | ||
| // for us to notify the user we're running! | ||
| return | ||
| } | ||
| updateStage(ProvisioningStateRunning, *job.StartedAt) | ||
| } | ||
| if opts.Cancel != nil { | ||
| @@ -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. | ||
| updateJob() | ||
| printStage() | ||
| logs, closer, err := opts.Logs() | ||
| if err != nil { | ||
139 changes: 116 additions & 23 deletionscli/cliui/provisionerjob_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -2,13 +2,16 @@ package cliui_test | ||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "regexp" | ||
| "runtime" | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
| "github.com/coder/coder/v2/testutil" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/coder/coder/v2/cli/cliui" | ||
| @@ -25,7 +28,11 @@ func TestProvisionerJob(t *testing.T) { | ||
| t.Parallel() | ||
| test := newProvisionerJob(t) | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) | ||
| defer cancel() | ||
| testutil.Go(t, func() { | ||
| <-test.Next | ||
| test.JobMutex.Lock() | ||
| test.Job.Status = codersdk.ProvisionerJobRunning | ||
| @@ -39,20 +46,26 @@ func TestProvisionerJob(t *testing.T) { | ||
| test.Job.CompletedAt = &now | ||
| close(test.Logs) | ||
| test.JobMutex.Unlock() | ||
| }) | ||
| testutil.Eventually(ctx, t, func(ctx context.Context) (done bool) { | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateRunning) | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateRunning) | ||
| return true | ||
| }, testutil.IntervalFast) | ||
| }) | ||
| t.Run("Stages", func(t *testing.T) { | ||
| t.Parallel() | ||
| test := newProvisionerJob(t) | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) | ||
| defer cancel() | ||
| testutil.Go(t, func() { | ||
| <-test.Next | ||
| test.JobMutex.Lock() | ||
| test.Job.Status = codersdk.ProvisionerJobRunning | ||
| @@ -70,13 +83,86 @@ func TestProvisionerJob(t *testing.T) { | ||
| test.Job.CompletedAt = &now | ||
| close(test.Logs) | ||
| test.JobMutex.Unlock() | ||
| }) | ||
| testutil.Eventually(ctx, t, func(ctx context.Context) (done bool) { | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) | ||
| test.PTY.ExpectMatch("Something") | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch("Something") | ||
| return true | ||
| }, testutil.IntervalFast) | ||
| }) | ||
| t.Run("Queue Position", func(t *testing.T) { | ||
| t.Parallel() | ||
| stage := cliui.ProvisioningStateQueued | ||
| tests := []struct { | ||
| name string | ||
| queuePos int | ||
| expected string | ||
| }{ | ||
| { | ||
| name: "first", | ||
| queuePos: 0, | ||
| expected: fmt.Sprintf("%s$", stage), | ||
| }, | ||
| { | ||
| name: "next", | ||
| queuePos: 1, | ||
| expected: fmt.Sprintf(`%s %s$`, stage, regexp.QuoteMeta("(next)")), | ||
| }, | ||
| { | ||
| name: "other", | ||
| queuePos: 4, | ||
| expected: fmt.Sprintf(`%s %s$`, stage, regexp.QuoteMeta("(position: 4)")), | ||
| }, | ||
| } | ||
| for _, tc := range tests { | ||
| tc := tc | ||
| t.Run(tc.name, func(t *testing.T) { | ||
dannykopping marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| t.Parallel() | ||
| test := newProvisionerJob(t) | ||
| test.JobMutex.Lock() | ||
| test.Job.QueuePosition = tc.queuePos | ||
| test.Job.QueueSize = tc.queuePos | ||
| test.JobMutex.Unlock() | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) | ||
| defer cancel() | ||
| testutil.Go(t, func() { | ||
| <-test.Next | ||
| test.JobMutex.Lock() | ||
| test.Job.Status = codersdk.ProvisionerJobRunning | ||
| now := dbtime.Now() | ||
| test.Job.StartedAt = &now | ||
| test.JobMutex.Unlock() | ||
| <-test.Next | ||
| test.JobMutex.Lock() | ||
| test.Job.Status = codersdk.ProvisionerJobSucceeded | ||
| now = dbtime.Now() | ||
| test.Job.CompletedAt = &now | ||
| close(test.Logs) | ||
| test.JobMutex.Unlock() | ||
| }) | ||
| testutil.Eventually(ctx, t, func(ctx context.Context) (done bool) { | ||
| test.PTY.ExpectRegexMatch(tc.expected) | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) // step completed | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateRunning) | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateRunning) | ||
| return true | ||
| }, testutil.IntervalFast) | ||
| }) | ||
| } | ||
| }) | ||
| // This cannot be ran in parallel because it uses a signal. | ||
| @@ -90,7 +176,11 @@ func TestProvisionerJob(t *testing.T) { | ||
| } | ||
| test := newProvisionerJob(t) | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) | ||
| defer cancel() | ||
| testutil.Go(t, func() { | ||
| <-test.Next | ||
| currentProcess, err := os.FindProcess(os.Getpid()) | ||
| assert.NoError(t, err) | ||
| @@ -103,12 +193,15 @@ func TestProvisionerJob(t *testing.T) { | ||
| test.Job.CompletedAt = &now | ||
| close(test.Logs) | ||
| test.JobMutex.Unlock() | ||
| }) | ||
| testutil.Eventually(ctx, t, func(ctx context.Context) (done bool) { | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch("Gracefully canceling") | ||
| test.Next <- struct{}{} | ||
| test.PTY.ExpectMatch(cliui.ProvisioningStateQueued) | ||
| return true | ||
| }, testutil.IntervalFast) | ||
| }) | ||
| } | ||
25 changes: 23 additions & 2 deletionspty/ptytest/ptytest.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -6,6 +6,7 @@ import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "regexp" | ||
| "runtime" | ||
| "strings" | ||
| "sync" | ||
| @@ -145,16 +146,36 @@ type outExpecter struct { | ||
| } | ||
| func (e *outExpecter) ExpectMatch(str string) string { | ||
| return e.expectMatchContextFunc(str, e.ExpectMatchContext) | ||
| } | ||
| func (e *outExpecter) ExpectRegexMatch(str string) string { | ||
| return e.expectMatchContextFunc(str, e.ExpectRegexMatchContext) | ||
| } | ||
| func (e *outExpecter) expectMatchContextFunc(str string, fn func(ctx context.Context, str string) string) string { | ||
| e.t.Helper() | ||
| timeout, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium) | ||
| defer cancel() | ||
| returnfn(timeout, str) | ||
| } | ||
| // TODO(mafredri): Rename this to ExpectMatch when refactoring. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @mafredri not really sure what this TODO is about since both this and the Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Essentially the non-context variant should be marked deprecated. All usage switched to context. Then delete the non-context one and rename this to not have context in the name. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. OK, is it because we need to be able to control the deadline? | ||
| func (e *outExpecter) ExpectMatchContext(ctx context.Context, str string) string { | ||
| return e.expectMatcherFunc(ctx, str, func(src, pattern string) bool { | ||
| return strings.Contains(src, pattern) | ||
| }) | ||
| } | ||
| func (e *outExpecter) ExpectRegexMatchContext(ctx context.Context, str string) string { | ||
| return e.expectMatcherFunc(ctx, str, func(src, pattern string) bool { | ||
| return regexp.MustCompile(pattern).MatchString(src) | ||
| }) | ||
| } | ||
| func (e *outExpecter) expectMatcherFunc(ctx context.Context, str string, fn func(src, pattern string) bool) string { | ||
| e.t.Helper() | ||
| var buffer bytes.Buffer | ||
| @@ -168,7 +189,7 @@ func (e *outExpecter) ExpectMatchContext(ctx context.Context, str string) string | ||
| if err != nil { | ||
| return err | ||
| } | ||
| iffn(buffer.String(), str) { | ||
| return nil | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.