Improve shell disconnect error

cmoog · cmoog · commit 320c906e72ce · 2020-09-02T13:14:17.000-05:00
diff --git a/coder-sdk/env.go b/coder-sdk/env.go
@@ -76,16 +76,28 @@ type CreateEnvironmentRequest struct {
 	Services []string `json:"services"`
 }
 
+// EnvironmentByName gets a single environment environment for the authenticted user by name.
+func (c Client) EnvironmentByName(ctx context.Context, name string) (*Environment, error) {
+	var env Environment
+	err := c.requestBody(
+		ctx,
+		http.MethodGet, "/api/environments/"+name,
+		nil,
+		&env,
+	)
+	return &env, err
+}
+
 // CreateEnvironment sends a request to create an environment.
 func (c Client) CreateEnvironment(ctx context.Context, orgID string, req CreateEnvironmentRequest) (*Environment, error) {
-	var env *Environment
+	var env Environment
 	err := c.requestBody(
 		ctx,
 		http.MethodPost, "/api/orgs/"+orgID+"/environments",
 		req,
-		env,
+		&env,
 	)
-	return env, err
+	return &env, err
 }
 
 // EnvironmentsByOrganization gets the list of environments owned by the given user.
diff --git a/internal/cmd/shell.go b/internal/cmd/shell.go
@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"context"
+	"fmt"
 	"io"
 	"os"
 	"strings"
@@ -142,11 +143,7 @@ func runCommand(ctx context.Context, envName string, command string, args []stri
 		Env:     cmdEnv,
 	})
 	if err != nil {
-		var closeErr websocket.CloseError
-		if xerrors.As(err, &closeErr) {
-			return xerrors.Errorf("network error, is %q online?", envName)
-		}
-		return err
+		return prettyShellExitError(ctx, err, entClient, env.Name)
 	}
 
 	if tty {
@@ -178,15 +175,36 @@ func runCommand(ctx context.Context, envName string, command string, args []stri
 	}()
 	err = process.Wait()
 	if err != nil {
-		var closeErr websocket.CloseError
-		if xerrors.Is(err, ctx.Err()) || xerrors.As(err, &closeErr) {
-			return xerrors.Errorf("network error, is %q online?", envName)
-		}
-		return err
+		return prettyShellExitError(ctx, err, entClient, env.Name)
 	}
 	return nil
 }
 
+func prettyShellExitError(ctx context.Context, err error, client *coder.Client, envName string) error {
+	var closeErr websocket.CloseError
+	if xerrors.Is(err, ctx.Err()) || xerrors.As(err, &closeErr) {
+		if err != nil {
+			return xerrors.Errorf("network error, %s", envErrorMessage(ctx, client, envName))
+		}
+	}
+	return err
+}
+
+func envErrorMessage(ctx context.Context, client *coder.Client, envName string) string {
+	env, err := client.EnvironmentByName(ctx, envName)
+	if err != nil {
+		return fmt.Sprintf("failed to fetch environment status: %v", err)
+	}
+	if env.LatestStat.ContainerStatus == "" {
+		return "environment status not found"
+	}
+	if env.LatestStat.ContainerStatus == coder.EnvironmentOn {
+		return fmt.Sprintf(`environment status is "%s", please try again`, env.LatestStat.ContainerStatus)
+	}
+
+	return fmt.Sprintf(`environment "%s" has a status of "%s"`, envName, env.LatestStat.ContainerStatus)
+}
+
 func heartbeat(ctx context.Context, c *websocket.Conn, interval time.Duration) {
 	ticker := time.NewTicker(interval)
 	defer ticker.Stop()
