Add coder-sdk executor interface (#177)

cmoog · web-flow · commit 6df7494d3f34 · 2020-11-04T12:06:06.000-06:00
diff --git a/coder-sdk/config.go b/coder-sdk/config.go
@@ -100,7 +100,7 @@ type configSetupMode struct {
 func (c Client) SiteSetupModeEnabled(ctx context.Context) (bool, error) {
 	var conf configSetupMode
 	if err := c.requestBody(ctx, http.MethodGet, "/api/config/setup-mode", nil, &conf); err != nil {
-		return false, nil
+		return false, err
 	}
 	return conf.SetupMode, nil
 }
diff --git a/coder-sdk/env.go b/coder-sdk/env.go
@@ -5,6 +5,7 @@ import (
 	"net/http"
 	"time"
 
+	"cdr.dev/wsep"
 	"golang.org/x/xerrors"
 	"nhooyr.io/websocket"
 	"nhooyr.io/websocket/wsjson"
@@ -142,8 +143,17 @@ func (c Client) EditEnvironment(ctx context.Context, envID string, req UpdateEnv
 
 // DialWsep dials an environments command execution interface
 // See https://github.com/cdr/wsep for details.
-func (c Client) DialWsep(ctx context.Context, env *Environment) (*websocket.Conn, error) {
-	return c.dialWebsocket(ctx, "/proxy/environments/"+env.ID+"/wsep")
+func (c Client) DialWsep(ctx context.Context, envID string) (*websocket.Conn, error) {
+	return c.dialWebsocket(ctx, "/proxy/environments/"+envID+"/wsep")
+}
+
+// DialExecutor gives a remote execution interface for performing commands inside an environment.
+func (c Client) DialExecutor(ctx context.Context, envID string) (wsep.Execer, error) {
+	ws, err := c.DialWsep(ctx, envID)
+	if err != nil {
+		return nil, err
+	}
+	return wsep.RemoteExecer(ws), nil
 }
 
 // DialIDEStatus opens a websocket connection for cpu load metrics on the environment.
@@ -234,17 +244,17 @@ type buildLogMsg struct {
 }
 
 // WaitForEnvironmentReady will watch the build log and return when done.
-func (c Client) WaitForEnvironmentReady(ctx context.Context, env *Environment) error {
-	conn, err := c.DialEnvironmentBuildLog(ctx, env.ID)
+func (c Client) WaitForEnvironmentReady(ctx context.Context, envID string) error {
+	conn, err := c.DialEnvironmentBuildLog(ctx, envID)
 	if err != nil {
-		return xerrors.Errorf("%s: dial build log: %w", env.Name, err)
+		return xerrors.Errorf("%s: dial build log: %w", envID, err)
 	}
 
 	for {
 		msg := buildLogMsg{}
 		err := wsjson.Read(ctx, conn, &msg)
 		if err != nil {
-			return xerrors.Errorf("%s: reading build log msg: %w", env.Name, err)
+			return xerrors.Errorf("%s: reading build log msg: %w", envID, err)
 		}
 
 		if msg.Type == BuildLogTypeDone {
diff --git a/internal/cmd/shell.go b/internal/cmd/shell.go
@@ -140,7 +140,7 @@ func runCommand(ctx context.Context, envName, command string, args []string) err
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
-	conn, err := client.DialWsep(ctx, env)
+	conn, err := client.DialWsep(ctx, env.ID)
 	if err != nil {
 		return xerrors.Errorf("dial websocket: %w", err)
 	}
diff --git a/internal/sync/singlefile.go b/internal/sync/singlefile.go
@@ -17,7 +17,7 @@ import (
 
 // SingleFile copies the given file into the remote dir or remote path of the given coder.Environment.
 func SingleFile(ctx context.Context, local, remoteDir string, env *coder.Environment, client *coder.Client) error {
-	conn, err := client.DialWsep(ctx, env)
+	conn, err := client.DialWsep(ctx, env.ID)
 	if err != nil {
 		return xerrors.Errorf("dial remote execer: %w", err)
 	}
diff --git a/internal/sync/sync.go b/internal/sync/sync.go
@@ -89,7 +89,7 @@ func (s Sync) syncPaths(delete bool, local, remote string) error {
 }
 
 func (s Sync) remoteCmd(ctx context.Context, prog string, args ...string) error {
-	conn, err := s.Client.DialWsep(ctx, &s.Env)
+	conn, err := s.Client.DialWsep(ctx, s.Env.ID)
 	if err != nil {
 		return xerrors.Errorf("dial websocket: %w", err)
 	}
@@ -270,7 +270,7 @@ func (s Sync) Version() (string, error) {
 	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
 	defer cancel()
 
-	conn, err := s.Client.DialWsep(ctx, &s.Env)
+	conn, err := s.Client.DialWsep(ctx, s.Env.ID)
 	if err != nil {
 		return "", err
 	}

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ type configSetupMode struct {`
`100`	`100`	`func (c Client) SiteSetupModeEnabled(ctx context.Context) (bool, error) {`
`101`	`101`	`var conf configSetupMode`
`102`	`102`	`if err := c.requestBody(ctx, http.MethodGet, "/api/config/setup-mode", nil, &conf); err != nil {`
`103`		`- return false, nil`
	`103`	`+ return false, err`
`104`	`104`	`}`
`105`	`105`	`return conf.SetupMode, nil`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ func runCommand(ctx context.Context, envName, command string, args []string) err`
`140`	`140`	`ctx, cancel := context.WithCancel(ctx)`
`141`	`141`	`defer cancel()`
`142`	`142`
`143`		`- conn, err := client.DialWsep(ctx, env)`
	`143`	`+ conn, err := client.DialWsep(ctx, env.ID)`
`144`	`144`	`if err != nil {`
`145`	`145`	`return xerrors.Errorf("dial websocket: %w", err)`
`146`	`146`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import (`
`17`	`17`
`18`	`18`	`// SingleFile copies the given file into the remote dir or remote path of the given coder.Environment.`
`19`	`19`	`func SingleFile(ctx context.Context, local, remoteDir string, env coder.Environment, client coder.Client) error {`
`20`		`- conn, err := client.DialWsep(ctx, env)`
	`20`	`+ conn, err := client.DialWsep(ctx, env.ID)`
`21`	`21`	`if err != nil {`
`22`	`22`	`return xerrors.Errorf("dial remote execer: %w", err)`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ func (s Sync) syncPaths(delete bool, local, remote string) error {`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`func (s Sync) remoteCmd(ctx context.Context, prog string, args ...string) error {`
`92`		`- conn, err := s.Client.DialWsep(ctx, &s.Env)`
	`92`	`+ conn, err := s.Client.DialWsep(ctx, s.Env.ID)`
`93`	`93`	`if err != nil {`
`94`	`94`	`return xerrors.Errorf("dial websocket: %w", err)`
`95`	`95`	`}`
`@@ -270,7 +270,7 @@ func (s Sync) Version() (string, error) {`
`270`	`270`	`ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)`
`271`	`271`	`defer cancel()`
`272`	`272`
`273`		`- conn, err := s.Client.DialWsep(ctx, &s.Env)`
	`273`	`+ conn, err := s.Client.DialWsep(ctx, s.Env.ID)`
`274`	`274`	`if err != nil {`
`275`	`275`	`return "", err`
`276`	`276`	`}`