fix: Drop polling after watching build logs for online

Emyrk · Emyrk · commit b40af272c68e · 2021-01-22T14:48:01.000Z
Environment status should be not 'creating' after build logs,
so no need to poll after watching the logs.
diff --git a/internal/cmd/ceapi.go b/internal/cmd/ceapi.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 	"strings"
-	"time"
 
 	"cdr.dev/coder-cli/coder-sdk"
 	"cdr.dev/coder-cli/pkg/clog"
@@ -92,42 +91,6 @@ func findEnv(ctx context.Context, client *coder.Client, envName, userEmail strin
 	return env, nil
 }
 
-// waitForEnvOnline will wait up to the maximum time allowed for an environment to have a 'ON' status.
-// It expects the status to be 'Creating'. If the status is 'failed' or 'off', this function will also terminate
-// The returned values is the last known env status and an error if the env never came online
-func waitForEnvOnline(ctx context.Context, client *coder.Client, envID string, maxWait time.Duration) (status coder.EnvironmentStatus, err error) {
-	status = coder.EnvironmentUnknown
-	tmoCtx, cancel := context.WithTimeout(ctx, maxWait)
-	// Retry every 50ms until we get it or we timeout.
-	retry := time.NewTicker(time.Millisecond * 50)
-	defer cancel()
-
-	for {
-		select {
-		case <-tmoCtx.Done():
-			return status, context.DeadlineExceeded
-		case <-retry.C:
-			env, err := client.EnvironmentByID(ctx, envID)
-			if err != nil {
-				// If this api call failed, it will likely fail again, no point to retry and make the user wait
-				return status, err
-			}
-
-			status = env.LatestStat.ContainerStatus
-			switch status {
-			case coder.EnvironmentOn:
-				return status, nil // Exit function, env is online
-			case coder.EnvironmentOff:
-				// Well waiting won't help...
-				return status, fmt.Errorf("environment is off and will not come online")
-			case coder.EnvironmentFailed:
-				// Well waiting won't help...
-				return status, fmt.Errorf("environment has failed to build and will not come online")
-			}
-		}
-	}
-}
-
 type findImgConf struct {
 	email   string
 	imgName string
diff --git a/internal/cmd/shell.go b/internal/cmd/shell.go
@@ -68,8 +68,9 @@ func shCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:   "sh [environment_name] [<command [args...]>]",
 		Short: "Open a shell and execute commands in a Coder environment",
-		Long: "Execute a remote command on the environment\\nIf no command is specified, the default shell is opened.\\n" +
-			"If the command is run in an interactive shell, a user prompt will occur if the environment needs to be rebuilt.",
+		Long: `Execute a remote command on the environment
+If no command is specified, the default shell is opened.
+If the command is run in an interactive shell, a user prompt will occur if the environment needs to be rebuilt.`,
 		Args:               shValidArgs,
 		DisableFlagParsing: true,
 		ValidArgsFunction:  getEnvsForCompletion(coder.Me),
@@ -138,7 +139,6 @@ func rebuildPrompt(env *coder.Environment) (prompt func() error) {
 			_, err = confirm.Run()
 			return
 		}
-
 	}
 
 	// Option 2: If there are required rebuild messages, the rebuild is needed
@@ -175,6 +175,7 @@ func rebuildPrompt(env *coder.Environment) (prompt func() error) {
 //	- Environment is offline
 //	- Environment has rebuild messages requiring a rebuild
 func checkAndRebuildEnvironment(ctx context.Context, client *coder.Client, env *coder.Environment) error {
+	var err error
 	rebuildPrompt := rebuildPrompt(env) // Fetch the prompt for rebuilding envs w/ reason
 
 	switch {
@@ -221,15 +222,33 @@ func checkAndRebuildEnvironment(ctx context.Context, client *coder.Client, env *
 		// newline after trailBuildLogs to place user on a fresh line for their shell
 		fmt.Println()
 
-		// Ensure the env is actually 'ON' after the rebuild. Timeout after
-		// `maxWait`
-		status, err := waitForEnvOnline(ctx, client, env.ID, maxWait)
+		// At this point the buildlog is complete, and the status of the env should be 'ON'
+		env, err = client.EnvironmentByID(ctx, env.ID)
+		if err != nil {
+			// If this api call failed, it will likely fail again, no point to retry and make the user wait
+			return err
+		}
+
+		// Get a nice error based on the status
+		switch env.LatestStat.ContainerStatus {
+		case coder.EnvironmentOn:
+			// This is the case we expect, just making it explicit
+		case coder.EnvironmentOff:
+			err = fmt.Errorf("environment %q is off and will not come online", env.Name)
+		case coder.EnvironmentFailed:
+			err = fmt.Errorf("environment %q has failed to build and will not come online", env.Name)
+		case coder.EnvironmentCreating:
+			// This should never happen
+			err = fmt.Errorf("environment %q did not finish being created", env.Name)
+		default:
+			err = fmt.Errorf("environment %q has run into an unknown issue", env.Name)
+		}
+
 		if err != nil {
 			// This means we had a timeout
 			return clog.Fatal("the environment rebuild ran into an issue",
-				fmt.Sprintf("timed out waiting for environment %q to come online", env.Name),
-				fmt.Sprintf("its current status is %q", status),
-				"if the container is still being created, it might still come online after some time",
+				err.Error(),
+				fmt.Sprintf("its current status is %q", env.LatestStat.ContainerStatus),
 				clog.BlankLine,
 				// TODO: (@emyrk) can they check these logs from the cli? Isn't this the logs that
 				//			I just showed them? I'm trying to decide what exactly to tell a user.
