Deprecate --progress-format flag and remove progress logger types (#3820)

## Changes

This change removes remaining references to the "progress logger".

All terminal I/O now goes through a single type in `cmdio`.

Builds on #3811, #3812, and #3818.

Author: pietern

NEXT_CHANGELOG.md

@@ -8,6 +8,7 @@
 ### CLI
 * Remove `inplace` mode for the `--progress-format` flag. ([#3811](https://github.com/databricks/cli/pull/3811))
 * Remove `json` mode for the `--progress-format` flag. ([#3812](https://github.com/databricks/cli/pull/3812))
+* Deprecate the `--progress-format` flag. ([#3819](https://github.com/databricks/cli/pull/3819))
 
 ### Dependency updates
 

cmd/pipelines/root/progress_logger.go

@@ -1,51 +1,12 @@
-// Copied from cmd/root/progress_logger.go and adapted for pipelines use.
 package root
 
 import (
-	"context"
-
-	"github.com/databricks/cli/libs/cmdio"
-	"github.com/databricks/cli/libs/env"
-	"github.com/databricks/cli/libs/flags"
 	"github.com/spf13/cobra"
 )
 
-const envProgressFormat = "DATABRICKS_CLI_PROGRESS_FORMAT"
-
-type progressLoggerFlag struct {
-	flags.ProgressLogFormat
-}
-
-func (f *progressLoggerFlag) initializeContext(ctx context.Context) (context.Context, error) {
-	// No need to initialize the logger if it's already set in the context. This
-	// happens in unit tests where the logger is setup as a fixture.
-	if _, ok := cmdio.FromContext(ctx); ok {
-		return ctx, nil
-	}
-
-	format := f.ProgressLogFormat
-	if format == flags.ModeDefault {
-		format = flags.ModeAppend
-	}
-
-	progressLogger := cmdio.NewLogger(format)
-	return cmdio.NewContext(ctx, progressLogger), nil
-}
-
-func initProgressLoggerFlag(cmd *cobra.Command, logFlags *logFlags) *progressLoggerFlag {
-	f := progressLoggerFlag{
-		ProgressLogFormat: flags.NewProgressLogFormat(),
-	}
-
-	// Configure defaults from environment, if applicable.
-	// If the provided value is invalid it is ignored.
-	if v, ok := env.Lookup(cmd.Context(), envProgressFormat); ok {
-		_ = f.Set(v)
-	}
-
+func initProgressLoggerFlag(cmd *cobra.Command, logFlags *logFlags) {
 	flags := cmd.PersistentFlags()
-	flags.Var(&f.ProgressLogFormat, "progress-format", "format for progress logs (append)")
+	_ = flags.String("progress-format", "", "format for progress logs")
 	flags.MarkHidden("progress-format")
-	cmd.RegisterFlagCompletionFunc("progress-format", f.Complete)
-	return &f
+	flags.MarkDeprecated("progress-format", "this flag is no longer functional")
 }

cmd/pipelines/root/root.go

@@ -36,11 +36,13 @@ func New(ctx context.Context) *cobra.Command {
 
 	// Initialize flags
 	logFlags := initLogFlags(cmd)
-	progressLoggerFlag := initProgressLoggerFlag(cmd, logFlags)
 	outputFlag := initOutputFlag(cmd)
 	initProfileFlag(cmd)
 	initTargetFlag(cmd)
 
+	// Deprecated flag. Warn if it is specified.
+	initProgressLoggerFlag(cmd, logFlags)
+
 	cmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
 		ctx := cmd.Context()
 
@@ -55,11 +57,6 @@ func New(ctx context.Context) *cobra.Command {
 			slog.String("version", build.GetInfo().Version),
 			slog.String("args", strings.Join(os.Args, ", ")))
 
-		// Configure progress logger
-		ctx, err = progressLoggerFlag.initializeContext(ctx)
-		if err != nil {
-			return err
-		}
 		// set context, so that initializeIO can have the current context
 		cmd.SetContext(ctx)
 

cmd/root/progress_logger.go

@@ -1,50 +1,12 @@
 package root
 
 import (
-	"context"
-
-	"github.com/databricks/cli/libs/cmdio"
-	"github.com/databricks/cli/libs/env"
-	"github.com/databricks/cli/libs/flags"
 	"github.com/spf13/cobra"
 )
 
-const envProgressFormat = "DATABRICKS_CLI_PROGRESS_FORMAT"
-
-type progressLoggerFlag struct {
-	flags.ProgressLogFormat
-}
-
-func (f *progressLoggerFlag) initializeContext(ctx context.Context) (context.Context, error) {
-	// No need to initialize the logger if it's already set in the context. This
-	// happens in unit tests where the logger is setup as a fixture.
-	if _, ok := cmdio.FromContext(ctx); ok {
-		return ctx, nil
-	}
-
-	format := f.ProgressLogFormat
-	if format == flags.ModeDefault {
-		format = flags.ModeAppend
-	}
-
-	progressLogger := cmdio.NewLogger(format)
-	return cmdio.NewContext(ctx, progressLogger), nil
-}
-
-func initProgressLoggerFlag(cmd *cobra.Command, logFlags *logFlags) *progressLoggerFlag {
-	f := progressLoggerFlag{
-		ProgressLogFormat: flags.NewProgressLogFormat(),
-	}
-
-	// Configure defaults from environment, if applicable.
-	// If the provided value is invalid it is ignored.
-	if v, ok := env.Lookup(cmd.Context(), envProgressFormat); ok {
-		_ = f.Set(v)
-	}
-
+func initProgressLoggerFlag(cmd *cobra.Command, logFlags *logFlags) {
 	flags := cmd.PersistentFlags()
-	flags.Var(&f.ProgressLogFormat, "progress-format", "format for progress logs (append)")
+	_ = flags.String("progress-format", "", "format for progress logs")
 	flags.MarkHidden("progress-format")
-	cmd.RegisterFlagCompletionFunc("progress-format", f.Complete)
-	return &f
+	flags.MarkDeprecated("progress-format", "this flag is no longer functional")
 }

cmd/root/progress_logger_test.go

@@ -42,12 +42,14 @@ func New(ctx context.Context) *cobra.Command {
 
 	// Initialize flags
 	logFlags := initLogFlags(cmd)
-	progressLoggerFlag := initProgressLoggerFlag(cmd, logFlags)
 	outputFlag := initOutputFlag(cmd)
 	initProfileFlag(cmd)
 	initEnvironmentFlag(cmd)
 	initTargetFlag(cmd)
 
+	// Deprecated flag. Warn if it is specified.
+	initProgressLoggerFlag(cmd, logFlags)
+
 	cmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
 		ctx := cmd.Context()
 
@@ -62,11 +64,6 @@ func New(ctx context.Context) *cobra.Command {
 			slog.String("version", build.GetInfo().Version),
 			slog.String("args", strings.Join(os.Args, ", ")))
 
-		// Configure progress logger
-		ctx, err = progressLoggerFlag.initializeContext(ctx)
-		if err != nil {
-			return err
-		}
 		// set context, so that initializeIO can have the current context
 		cmd.SetContext(ctx)
 

cmd/root/root.go

@@ -69,8 +69,6 @@ func deployBundle(t testutil.TestingT, ctx context.Context, path string) {
 
 func runResource(t testutil.TestingT, ctx context.Context, path, key string) (string, error) {
 	ctx = env.Set(ctx, "BUNDLE_ROOT", path)
-	ctx = cmdio.NewContext(ctx, cmdio.Default())
-
 	c := testcli.NewRunner(t, ctx, "bundle", "run", key)
 	stdout, _, err := c.Run()
 	return stdout.String(), err

integration/bundle/helpers_test.go

@@ -16,7 +16,6 @@ import (
 	"github.com/databricks/cli/cmd/root"
 	"github.com/databricks/cli/internal/testutil"
 	"github.com/databricks/cli/libs/cmdio"
-	"github.com/databricks/cli/libs/flags"
 )
 
 // Helper for running the root command in the background.
@@ -101,13 +100,8 @@ func (r *Runner) RunBackground() {
 	var stdoutW, stderrW io.WriteCloser
 	stdoutR, stdoutW = io.Pipe()
 	stderrR, stderrW = io.Pipe()
-	ctx := cmdio.NewContext(r.ctx, &cmdio.Logger{
-		Mode:   flags.ModeAppend,
-		Reader: bufio.Reader{},
-		Writer: stderrW,
-	})
 
-	cli := cmd.New(ctx)
+	cli := cmd.New(r.ctx)
 	cli.SetOut(stdoutW)
 	cli.SetErr(stderrW)
 	cli.SetArgs(r.args)
@@ -116,7 +110,7 @@ func (r *Runner) RunBackground() {
 	}
 
 	errch := make(chan error)
-	ctx, cancel := context.WithCancel(ctx)
+	ctx, cancel := context.WithCancel(r.ctx)
 
 	// Tee stdout/stderr to buffers.
 	stdoutR = io.TeeReader(stdoutR, &r.stdout)
@@ -183,13 +177,8 @@ func (r *Runner) RunBackground() {
 func (r *Runner) Run() (bytes.Buffer, bytes.Buffer, error) {
 	r.Helper()
 	var stdout, stderr bytes.Buffer
-	ctx := cmdio.NewContext(r.ctx, &cmdio.Logger{
-		Mode:   flags.ModeAppend,
-		Reader: bufio.Reader{},
-		Writer: &stderr,
-	})
 
-	cli := cmd.New(ctx)
+	cli := cmd.New(r.ctx)
 	cli.SetOut(&stdout)
 	cli.SetErr(&stderr)
 	cli.SetArgs(r.args)
@@ -198,7 +187,7 @@ func (r *Runner) Run() (bytes.Buffer, bytes.Buffer, error) {
 		r.Logf("  args: %s", strings.Join(r.args, ", "))
 	}
 
-	err := root.Execute(ctx, cli)
+	err := root.Execute(r.ctx, cli)
 	if err != nil {
 		if r.Verbose {
 			r.Logf(" error: %s", err)