batches: Introduce ui package and implement task execution UI in TUI and JSONLines (#571)

This is part of https://github.com/sourcegraph/sourcegraph/issues/22766 and adds the missing task execution status updates in the `-text-only` output.

It does so by defining the `executor.TaskExecutionUI` that the `Coordinator` and the `executor` use to let the UI know about the current state of the task execution.

In order to make this happen I moved all of the UI-related things out of the `main` package and into a new, separate `batches/ui` package that contains the `ui.JSONLines` UI and the old TUI under a new name, `ui.TUI`.

Both UIs can return a `TaskExecutionUI`: a `taskExecutionJSONLines` or `taskExecTUI`. The latter was formerly known as `batchProgressPrinter` and a mess of spaghetti code.

Since the UIs are essentially event-driven it's much easier to implement a stateful UI such as `taskExecTUI`. It also feels quicker.

Author: mrnugget

CHANGELOG.md

@@ -15,6 +15,9 @@ All notable changes to `src-cli` are documented in this file.
 
 ### Changed
 
+- For internal use only: `-text-only` now contains detailed information about task execution. [#571](https://github.com/sourcegraph/src-cli/pull/571)
+- As part of the above: the TUI of `src batch [preview|apply]` has been reworked and should now feel snappier.
+
 ### Fixed
 
 ### Removed

cmd/src/api.go

@@ -3,15 +3,16 @@ package main
 import (
 	"context"
 	"encoding/json"
-	"errors"
 	"flag"
 	"fmt"
 	"io/ioutil"
 	"os"
 	"strings"
 
-	"github.com/mattn/go-isatty"
 	"github.com/sourcegraph/src-cli/internal/api"
+	"github.com/sourcegraph/src-cli/internal/cmderrors"
+
+	"github.com/mattn/go-isatty"
 )
 
 func init() {
@@ -65,7 +66,7 @@ Examples:
 		if query == "" {
 			// Read query from stdin instead.
 			if isatty.IsTerminal(os.Stdin.Fd()) {
-				return &usageError{errors.New("expected query to be piped into 'src api' or -query flag to be specified")}
+				return cmderrors.Usage("expected query to be piped into 'src api' or -query flag to be specified")
 			}
 			data, err := ioutil.ReadAll(os.Stdin)
 			if err != nil {
@@ -84,7 +85,7 @@ Examples:
 		for _, arg := range flagSet.Args() {
 			idx := strings.Index(arg, "=")
 			if idx == -1 {
-				return &usageError{fmt.Errorf("parsing argument %q expected 'variable=value' syntax (missing equals)", arg)}
+				return cmderrors.Usagef("parsing argument %q expected 'variable=value' syntax (missing equals)", arg)
 			}
 			key := arg[:idx]
 			value := arg[idx+1:]

cmd/src/batch_apply.go

@@ -2,11 +2,12 @@ package main
 
 import (
 	"context"
-	"errors"
 	"flag"
 	"fmt"
 
 	"github.com/sourcegraph/sourcegraph/lib/output"
+	"github.com/sourcegraph/src-cli/internal/batches/ui"
+	"github.com/sourcegraph/src-cli/internal/cmderrors"
 )
 
 func init() {
@@ -35,18 +36,18 @@ Examples:
 		}
 
 		if len(flagSet.Args()) != 0 {
-			return &usageError{errors.New("additional arguments not allowed")}
+			return cmderrors.Usage("additional arguments not allowed")
 		}
 
 		ctx, cancel := contextCancelOnInterrupt(context.Background())
 		defer cancel()
 
-		var ui batchExecUI
+		var execUI ui.ExecUI
 		if flags.textOnly {
-			ui = &batchExecJSONLinesUI{}
+			execUI = &ui.JSONLines{}
 		} else {
 			out := output.NewOutput(flagSet.Output(), output.OutputOpts{Verbose: *verbose})
-			ui = &batchExecTUI{out: out}
+			execUI = &ui.TUI{Out: out}
 		}
 
 		err := executeBatchSpec(ctx, executeBatchSpecOpts{
@@ -55,10 +56,10 @@ Examples:
 
 			applyBatchSpec: true,
 
-			ui: ui,
+			ui: execUI,
 		})
 		if err != nil {
-			return &exitCodeError{nil, 1}
+			return cmderrors.ExitCode(1, nil)
 		}
 
 		return nil

cmd/src/batch_common.go

@@ -15,19 +15,14 @@ import (
 
 	"github.com/hashicorp/go-multierror"
 	"github.com/pkg/errors"
-	"github.com/sourcegraph/sourcegraph/lib/output"
 	"github.com/sourcegraph/src-cli/internal/api"
 	"github.com/sourcegraph/src-cli/internal/batches"
 	"github.com/sourcegraph/src-cli/internal/batches/executor"
 	"github.com/sourcegraph/src-cli/internal/batches/graphql"
 	"github.com/sourcegraph/src-cli/internal/batches/service"
+	"github.com/sourcegraph/src-cli/internal/batches/ui"
 	"github.com/sourcegraph/src-cli/internal/batches/workspace"
-)
-
-var (
-	batchPendingColor = output.StylePending
-	batchSuccessColor = output.StyleSuccess
-	batchSuccessEmoji = output.EmojiSuccess
+	"github.com/sourcegraph/src-cli/internal/cmderrors"
 )
 
 type batchExecuteFlags struct {
@@ -125,14 +120,6 @@ func newBatchExecuteFlags(flagSet *flag.FlagSet, cacheDir, tempDir string) *batc
 	return caf
 }
 
-func batchCreatePending(out *output.Output, message string) output.Pending {
-	return out.Pending(output.Line("", batchPendingColor, message))
-}
-
-func batchCompletePending(p output.Pending, message string) {
-	p.Complete(output.Line(batchSuccessEmoji, batchSuccessColor, message))
-}
-
 func batchDefaultCacheDir() string {
 	uc, err := os.UserCacheDir()
 	if err != nil {
@@ -199,7 +186,7 @@ type executeBatchSpecOpts struct {
 
 	applyBatchSpec bool
 
-	ui batchExecUI
+	ui ui.ExecUI
 
 	client api.Client
 }
@@ -238,10 +225,7 @@ func executeBatchSpec(ctx context.Context, opts executeBatchSpecOpts) (err error
 	if err != nil {
 		if merr, ok := err.(*multierror.Error); ok {
 			opts.ui.ParsingBatchSpecFailure(merr)
-			return &exitCodeError{
-				error:    nil,
-				exitCode: 2,
-			}
+			return cmderrors.ExitCode(2, nil)
 		} else {
 			// This shouldn't happen; let's just punt and let the normal
 			// rendering occur.
@@ -315,12 +299,12 @@ func executeBatchSpec(ctx context.Context, opts executeBatchSpecOpts) (err error
 	}
 	opts.ui.CheckingCacheSuccess(len(cachedSpecs), len(uncachedTasks))
 
-	printer := opts.ui.ExecutingTasks(*verbose, opts.flags.parallelism)
-	freshSpecs, logFiles, err := coord.Execute(ctx, uncachedTasks, batchSpec, printer)
+	taskExecUI := opts.ui.ExecutingTasks(*verbose, opts.flags.parallelism)
+	freshSpecs, logFiles, err := coord.Execute(ctx, uncachedTasks, batchSpec, taskExecUI)
 	if err != nil && !opts.flags.skipErrors {
 		return err
 	}
-	opts.ui.ExecutingTasksSuccess()
+	taskExecUI.Success()
 	if err != nil && opts.flags.skipErrors {
 		opts.ui.ExecutingTasksSkippingErrors(err)
 	}