feat: Add UI for awaiting agent connections #578
There are no files selected for viewing
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package cliui | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/briandowns/spinner" | ||
| "github.com/spf13/cobra" | ||
| "golang.org/x/xerrors" | ||
|
|
||
| "github.com/coder/coder/codersdk" | ||
| ) | ||
|
|
||
| type AgentOptions struct { | ||
| WorkspaceName string | ||
| Fetch func(context.Context) (codersdk.WorkspaceResource, error) | ||
| FetchInterval time.Duration | ||
| WarnInterval time.Duration | ||
| } | ||
|
|
||
| // Agent displays a spinning indicator that waits for a workspace agent to connect. | ||
| func Agent(cmd *cobra.Command, opts AgentOptions) error { | ||
| if opts.FetchInterval == 0 { | ||
| opts.FetchInterval = 500 * time.Millisecond | ||
| } | ||
| if opts.WarnInterval == 0 { | ||
| opts.WarnInterval = 30 * time.Second | ||
| } | ||
| var resourceMutex sync.Mutex | ||
| resource, err := opts.Fetch(cmd.Context()) | ||
| if err != nil { | ||
| return xerrors.Errorf("fetch: %w", err) | ||
| } | ||
| if resource.Agent.Status == codersdk.WorkspaceAgentConnected { | ||
| return nil | ||
| } | ||
| if resource.Agent.Status == codersdk.WorkspaceAgentDisconnected { | ||
| opts.WarnInterval = 0 | ||
| } | ||
| spin := spinner.New(spinner.CharSets[78], 100*time.Millisecond, spinner.WithColor("fgHiGreen")) | ||
| spin.Writer = cmd.OutOrStdout() | ||
| spin.Suffix = " Waiting for connection from " + Styles.Field.Render(resource.Type+"."+resource.Name) + "..." | ||
| spin.Start() | ||
| defer spin.Stop() | ||
|
|
||
| ticker := time.NewTicker(opts.FetchInterval) | ||
| defer ticker.Stop() | ||
| timer := time.NewTimer(opts.WarnInterval) | ||
| defer timer.Stop() | ||
| go func() { | ||
| select { | ||
| case <-cmd.Context().Done(): | ||
| return | ||
| case <-timer.C: | ||
| } | ||
| resourceMutex.Lock() | ||
| defer resourceMutex.Unlock() | ||
| message := "Don't panic, your workspace is booting up!" | ||
| if resource.Agent.Status == codersdk.WorkspaceAgentDisconnected { | ||
|
There was a problem hiding this comment. This will fail We should use atomic or just a mutex to protect that There was a problem hiding this comment. Good point. I didn't even have a test for this, and now I shall add one. |
||
| message = "The workspace agent lost connection! Wait for it to reconnect or run: " + Styles.Code.Render("coder workspaces rebuild "+opts.WorkspaceName) | ||
| } | ||
| // This saves the cursor position, then defers clearing from the cursor | ||
| // position to the end of the screen. | ||
| _, _ = fmt.Fprintf(cmd.OutOrStdout(), "\033[s\r\033[2K%s\n\n", Styles.Paragraph.Render(Styles.Prompt.String()+message)) | ||
| defer fmt.Fprintf(cmd.OutOrStdout(), "\033[u\033[J") | ||
| }() | ||
| for { | ||
| select { | ||
| case <-cmd.Context().Done(): | ||
| return cmd.Context().Err() | ||
| case <-ticker.C: | ||
| } | ||
| resourceMutex.Lock() | ||
| resource, err = opts.Fetch(cmd.Context()) | ||
| if err != nil { | ||
| return xerrors.Errorf("fetch: %w", err) | ||
| } | ||
| if resource.Agent.Status != codersdk.WorkspaceAgentConnected { | ||
| resourceMutex.Unlock() | ||
| continue | ||
| } | ||
| resourceMutex.Unlock() | ||
| return nil | ||
| } | ||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package cliui_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/atomic" | ||
|
|
||
| "github.com/coder/coder/cli/cliui" | ||
| "github.com/coder/coder/codersdk" | ||
| "github.com/coder/coder/pty/ptytest" | ||
| ) | ||
|
|
||
| func TestAgent(t *testing.T) { | ||
| t.Parallel() | ||
| var disconnected atomic.Bool | ||
| ptty := ptytest.New(t) | ||
| cmd := &cobra.Command{ | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| err := cliui.Agent(cmd, cliui.AgentOptions{ | ||
| WorkspaceName: "example", | ||
| Fetch: func(ctx context.Context) (codersdk.WorkspaceResource, error) { | ||
| resource := codersdk.WorkspaceResource{ | ||
| Agent: &codersdk.WorkspaceAgent{ | ||
| Status: codersdk.WorkspaceAgentDisconnected, | ||
| }, | ||
| } | ||
| if disconnected.Load() { | ||
| resource.Agent.Status = codersdk.WorkspaceAgentConnected | ||
| } | ||
| return resource, nil | ||
| }, | ||
| FetchInterval: time.Millisecond, | ||
| WarnInterval: 10 * time.Millisecond, | ||
| }) | ||
| return err | ||
| }, | ||
| } | ||
| cmd.SetOutput(ptty.Output()) | ||
| cmd.SetIn(ptty.Input()) | ||
| done := make(chan struct{}) | ||
| go func() { | ||
| defer close(done) | ||
| err := cmd.Execute() | ||
| require.NoError(t, err) | ||
| }() | ||
| ptty.ExpectMatch("lost connection") | ||
| disconnected.Store(true) | ||
| <-done | ||
| } |
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
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
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
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 |
|---|---|---|
|
|
@@ -64,7 +64,7 @@ func Root() *cobra.Command { | |
| projects(), | ||
| users(), | ||
| workspaces(), | ||
| ssh(), | ||
| workspaceTunnel(), | ||
| ) | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we comment what this function is doing? With lack of returns except
error, it's a bit unclear.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, certainly should.