Fix requested changes

kylecarbs · kylecarbs · commit a81243c93878 · 2022-03-29T00:01:23.000Z
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -3,6 +3,7 @@ package cliui
 import (
 	"context"
 	"fmt"
+	"sync"
 	"time"
 
 	"github.com/briandowns/spinner"
@@ -19,13 +20,15 @@ type AgentOptions struct {
 	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)
@@ -52,6 +55,8 @@ func Agent(cmd *cobra.Command, opts AgentOptions) error {
 			return
 		case <-timer.C:
 		}
+		resourceMutex.Lock()
+		defer resourceMutex.Unlock()
 		message := "Don't panic, your workspace is booting up!"
 		if resource.Agent.Status == codersdk.WorkspaceAgentDisconnected {
 			message = "The workspace agent lost connection! Wait for it to reconnect or run: " + Styles.Code.Render("coder workspaces rebuild "+opts.WorkspaceName)
@@ -67,13 +72,16 @@ func Agent(cmd *cobra.Command, opts AgentOptions) error {
 			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
 	}
 }
diff --git a/cli/cliui/agent_test.go b/cli/cliui/agent_test.go
@@ -0,0 +1,52 @@
+package cliui_test
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/coder/coder/cli/cliui"
+	"github.com/coder/coder/codersdk"
+	"github.com/coder/coder/pty/ptytest"
+	"github.com/spf13/cobra"
+	"github.com/stretchr/testify/require"
+	"go.uber.org/atomic"
+)
+
+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
+}
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -258,7 +258,6 @@ func AwaitWorkspaceAgents(t *testing.T, client *codersdk.Client, build uuid.UUID
 			if resource.Agent == nil {
 				continue
 			}
-			// fmt.Printf("resources: %+v\n", resource.Agent)
 			if resource.Agent.FirstConnectedAt == nil {
 				return false
 			}
diff --git a/examples/gcp-linux/main.tf b/examples/gcp-linux/main.tf
@@ -8,7 +8,7 @@ terraform {
 }
 
 variable "service_account" {
-  description = <<EOT
+  description = <<EOF
 Coder requires a Google Cloud Service Account to provision workspaces.
 
 1. Create a service account:
@@ -19,7 +19,7 @@ Coder requires a Google Cloud Service Account to provision workspaces.
 3. Click on the created key, and navigate to the "Keys" tab.
 4. Click "Add key", then "Create new key".
 5. Generate a JSON private key, and paste the contents in \'\' quotes below.
-EOT
+EOF
   sensitive   = true
 }
 
diff --git a/examples/gcp-windows/main.tf b/examples/gcp-windows/main.tf
@@ -8,7 +8,7 @@ terraform {
 }
 
 variable "service_account" {
-  description = <<EOT
+  description = <<EOF
 Coder requires a Google Cloud Service Account to provision workspaces.
 
 1. Create a service account:
@@ -19,7 +19,7 @@ Coder requires a Google Cloud Service Account to provision workspaces.
 3. Click on the created key, and navigate to the "Keys" tab.
 4. Click "Add key", then "Create new key".
 5. Generate a JSON private key, and paste the contents in \'\' quotes below.
-EOT
+EOF
   sensitive   = true
 }
 

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package cliui`
`3`	`3`	`import (`
`4`	`4`	`"context"`
`5`	`5`	`"fmt"`
	`6`	`+ "sync"`
`6`	`7`	`"time"`
`7`	`8`
`8`	`9`	`"github.com/briandowns/spinner"`
`@@ -19,13 +20,15 @@ type AgentOptions struct {`
`19`	`20`	`WarnInterval time.Duration`
`20`	`21`	`}`
`21`	`22`
	`23`	`+// Agent displays a spinning indicator that waits for a workspace agent to connect.`
`22`	`24`	`func Agent(cmd *cobra.Command, opts AgentOptions) error {`
`23`	`25`	`if opts.FetchInterval == 0 {`
`24`	`26`	`opts.FetchInterval = 500 * time.Millisecond`
`25`	`27`	`}`
`26`	`28`	`if opts.WarnInterval == 0 {`
`27`	`29`	`opts.WarnInterval = 30 * time.Second`
`28`	`30`	`}`
	`31`	`+ var resourceMutex sync.Mutex`
`29`	`32`	`resource, err := opts.Fetch(cmd.Context())`
`30`	`33`	`if err != nil {`
`31`	`34`	`return xerrors.Errorf("fetch: %w", err)`
`@@ -52,6 +55,8 @@ func Agent(cmd *cobra.Command, opts AgentOptions) error {`
`52`	`55`	`return`
`53`	`56`	`case <-timer.C:`
`54`	`57`	`}`
	`58`	`+ resourceMutex.Lock()`
	`59`	`+ defer resourceMutex.Unlock()`
`55`	`60`	`message := "Don't panic, your workspace is booting up!"`
`56`	`61`	`if resource.Agent.Status == codersdk.WorkspaceAgentDisconnected {`
`57`	`62`	`message = "The workspace agent lost connection! Wait for it to reconnect or run: " + Styles.Code.Render("coder workspaces rebuild "+opts.WorkspaceName)`
`@@ -67,13 +72,16 @@ func Agent(cmd *cobra.Command, opts AgentOptions) error {`
`67`	`72`	`return cmd.Context().Err()`
`68`	`73`	`case <-ticker.C:`
`69`	`74`	`}`
	`75`	`+ resourceMutex.Lock()`
`70`	`76`	`resource, err = opts.Fetch(cmd.Context())`
`71`	`77`	`if err != nil {`
`72`	`78`	`return xerrors.Errorf("fetch: %w", err)`
`73`	`79`	`}`
`74`	`80`	`if resource.Agent.Status != codersdk.WorkspaceAgentConnected {`
	`81`	`+ resourceMutex.Unlock()`
`75`	`82`	`continue`
`76`	`83`	`}`
	`84`	`+ resourceMutex.Unlock()`
`77`	`85`	`return nil`
`78`	`86`	`}`
`79`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,6 @@ func AwaitWorkspaceAgents(t testing.T, client codersdk.Client, build uuid.UUID`
`258`	`258`	`if resource.Agent == nil {`
`259`	`259`	`continue`
`260`	`260`	`}`
`261`		`- // fmt.Printf("resources: %+v\n", resource.Agent)`
`262`	`261`	`if resource.Agent.FirstConnectedAt == nil {`
`263`	`262`	`return false`
`264`	`263`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ terraform {`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`variable "service_account" {`
`11`		`- description = <<EOT`
	`11`	`+ description = <<EOF`
`12`	`12`	`Coder requires a Google Cloud Service Account to provision workspaces.`
`13`	`13`
`14`	`14`	`1. Create a service account:`
`@@ -19,7 +19,7 @@ Coder requires a Google Cloud Service Account to provision workspaces.`
`19`	`19`	`3. Click on the created key, and navigate to the "Keys" tab.`
`20`	`20`	`4. Click "Add key", then "Create new key".`
`21`	`21`	`5. Generate a JSON private key, and paste the contents in \'\' quotes below.`
`22`		`-EOT`
	`22`	`+EOF`
`23`	`23`	`sensitive = true`
`24`	`24`	`}`
`25`	`25`