- Notifications
You must be signed in to change notification settings - Fork928
feat: Add UI for awaiting agent connections#578
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
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
7ed283c
048f29a
2152758
e774dd7
172d4fe
82f60db
6bff973
3654022
aef12e1
15cae15
fb9fbb6
c91b3cc
9ad326b
342b03d
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
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 { | ||
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. Can we comment what this function is doing? With lack of returns except 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. Yup, certainly should. | ||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This will fail We should use atomic or just a mutex to protect that 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. 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 | ||
} | ||
} |
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 | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,37 @@ | ||
package cliui | ||
import ( | ||
"flag" | ||
"io" | ||
"os" | ||
"github.com/AlecAivazis/survey/v2" | ||
"github.com/spf13/cobra" | ||
) | ||
func init() { | ||
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. I don't know this survey stuff. Not looking to understand this atm lol 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. All of the libraries are questionable in their own rights tbh | ||
survey.SelectQuestionTemplate = ` | ||
{{- define "option"}} | ||
{{- " " }}{{- if eq .SelectedIndex .CurrentIndex }}{{color "green" }}{{ .Config.Icons.SelectFocus.Text }} {{else}}{{color "default"}} {{end}} | ||
{{- .CurrentOpt.Value}} | ||
{{- color "reset"}} | ||
{{end}} | ||
{{- if not .ShowAnswer }} | ||
{{- if .Config.Icons.Help.Text }} | ||
{{- if .FilterMessage }}{{ "Search:" }}{{ .FilterMessage }} | ||
{{- else }} | ||
{{- color "black+h"}}{{- "Type to search" }}{{color "reset"}} | ||
{{- end }} | ||
{{- "\n" }} | ||
{{- end }} | ||
{{- "\n" }} | ||
{{- range $ix, $option := .PageEntries}} | ||
{{- template "option" $.IterateOption $ix $option}} | ||
{{- end}} | ||
{{- end }}` | ||
} | ||
type SelectOptions struct { | ||
Options []string | ||
Size int | ||
@@ -18,59 +40,43 @@ type SelectOptions struct { | ||
// Select displays a list of user options. | ||
func Select(cmd *cobra.Command, opts SelectOptions) (string, error) { | ||
// The survey library used *always* fails when testing on Windows, | ||
// as it requires a live TTY (can't be a conpty). We should fork | ||
// this library to add a dummy fallback, that simply reads/writes | ||
// to the IO provided. See: | ||
// https://github.com/AlecAivazis/survey/blob/master/terminal/runereader_windows.go#L94 | ||
if flag.Lookup("test.v") != nil { | ||
return opts.Options[0], nil | ||
} | ||
opts.HideSearch = false | ||
var value string | ||
err := survey.AskOne(&survey.Select{ | ||
Options: opts.Options, | ||
PageSize: opts.Size, | ||
}, &value, survey.WithIcons(func(is *survey.IconSet) { | ||
is.Help.Text = "Type to search" | ||
if opts.HideSearch { | ||
is.Help.Text = "" | ||
} | ||
}), survey.WithStdio(fileReadWriter{ | ||
Reader: cmd.InOrStdin(), | ||
}, fileReadWriter{ | ||
Writer: cmd.OutOrStdout(), | ||
}, cmd.OutOrStdout())) | ||
return value, err | ||
} | ||
type fileReadWriter struct { | ||
io.Reader | ||
io.Writer | ||
} | ||
func (f fileReadWriter) Fd() uintptr { | ||
if file, ok := f.Reader.(*os.File); ok { | ||
return file.Fd() | ||
} | ||
if file, ok := f.Writer.(*os.File); ok { | ||
return file.Fd() | ||
} | ||
return 0 | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -64,7 +64,7 @@ func Root() *cobra.Command { | ||
projects(), | ||
users(), | ||
workspaces(), | ||
ssh(), | ||
workspaceTunnel(), | ||
) | ||
Uh oh!
There was an error while loading.Please reload this page.