Merge pull request #2882 from ActiveState/mitchell/dx-2214-2

Disable terminal echo while State Tool is running.
ActiveState · Nov 15, 2023 · 137a5d7 · 137a5d7
2 parents 94b8811 + 750654a
commit 137a5d7
Show file tree

Hide file tree

Showing 14 changed files with 182 additions and 1 deletion.
diff --git a/cmd/state/main.go b/cmd/state/main.go
@@ -207,6 +207,13 @@ func run(args []string, isInteractive bool, cfg *config.Instance, out output.Out
 
 	// Set up conditional, which accesses a lot of primer data
 	sshell := subshell.New(cfg)
+	if isInteractive {
+		// Disable terminal echo while State Tool is running.
+		// Other than in prompts and subshells (which temporarily re-enable echo), user typing should
+		// not interfere with output (e.g. runtime progress bars).
+		sshell.TurnOffEcho()
+		defer sshell.TurnOnEcho()
+	}
 
 	conditional := constraints.NewPrimeConditional(auth, pj, sshell.Shell())
 	project.RegisterConditional(conditional)

diff --git a/internal/runbits/activation/activation.go b/internal/runbits/activation/activation.go
@@ -67,6 +67,8 @@ func ActivateAndWait(
 	if err := ss.Activate(proj, cfg, out); err != nil {
 		return locale.WrapError(err, "error_could_not_activate_subshell", "Could not activate a new subshell.")
 	}
+	ss.TurnOnEcho() // temporarily re-enable echo while the subshell is active
+	defer ss.TurnOffEcho()
 
 	a, err := process.NewActivation(cfg, os.Getpid())
 	if err != nil {

diff --git a/internal/runbits/runtime/progress/progress.go b/internal/runbits/runtime/progress/progress.go
@@ -7,14 +7,14 @@ import (
 	"sync"
 	"time"
 
-	"github.com/ActiveState/cli/internal/multilog"
 	"github.com/go-openapi/strfmt"
 	"github.com/vbauerster/mpb/v7"
 	"golang.org/x/net/context"
 
 	"github.com/ActiveState/cli/internal/errs"
 	"github.com/ActiveState/cli/internal/locale"
 	"github.com/ActiveState/cli/internal/logging"
+	"github.com/ActiveState/cli/internal/multilog"
 	"github.com/ActiveState/cli/internal/output"
 	"github.com/ActiveState/cli/pkg/platform/runtime/artifact"
 	"github.com/ActiveState/cli/pkg/platform/runtime/setup/events"

diff --git a/internal/subshell/bash/bash.go b/internal/subshell/bash/bash.go
@@ -15,6 +15,7 @@ import (
 	"github.com/ActiveState/cli/internal/osutils/user"
 	"github.com/ActiveState/cli/internal/output"
 	"github.com/ActiveState/cli/internal/subshell/sscommon"
+	"github.com/ActiveState/cli/internal/subshell/termecho"
 	"github.com/ActiveState/cli/pkg/project"
 )
 
@@ -219,3 +220,17 @@ func (v *SubShell) IsAvailable() bool {
 	}
 	return fileutils.FileExists(rcFile)
 }
+
+func (v *SubShell) TurnOffEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.Off()
+}
+
+func (v *SubShell) TurnOnEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.On()
+}
diff --git a/internal/subshell/cmd/cmd.go b/internal/subshell/cmd/cmd.go
@@ -12,6 +12,7 @@ import (
 	"github.com/ActiveState/cli/internal/osutils"
 	"github.com/ActiveState/cli/internal/output"
 	"github.com/ActiveState/cli/internal/subshell/sscommon"
+	"github.com/ActiveState/cli/internal/subshell/termecho"
 	"github.com/ActiveState/cli/pkg/project"
 )
 
@@ -203,3 +204,11 @@ func (v *SubShell) IsActive() bool {
 func (v *SubShell) IsAvailable() bool {
 	return runtime.GOOS == "windows"
 }
+
+func (v *SubShell) TurnOffEcho() {
+	termecho.Off()
+}
+
+func (v *SubShell) TurnOnEcho() {
+	termecho.On()
+}
diff --git a/internal/subshell/fish/fish.go b/internal/subshell/fish/fish.go
@@ -5,6 +5,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"runtime"
 
 	"github.com/ActiveState/cli/internal/constants"
 	"github.com/ActiveState/cli/internal/errs"
@@ -14,6 +15,7 @@ import (
 	"github.com/ActiveState/cli/internal/osutils/user"
 	"github.com/ActiveState/cli/internal/output"
 	"github.com/ActiveState/cli/internal/subshell/sscommon"
+	"github.com/ActiveState/cli/internal/subshell/termecho"
 	"github.com/ActiveState/cli/pkg/project"
 )
 
@@ -195,3 +197,17 @@ func (v *SubShell) IsAvailable() bool {
 	}
 	return fileutils.FileExists(rcFile)
 }
+
+func (v *SubShell) TurnOffEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.Off()
+}
+
+func (v *SubShell) TurnOnEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.On()
+}
diff --git a/internal/subshell/subshell.go b/internal/subshell/subshell.go
@@ -84,6 +84,12 @@ type SubShell interface {
 
 	// IsAvailable returns whether the shell is available on the system
 	IsAvailable() bool
+
+	// TurnOffEcho turns off input echoing.
+	TurnOffEcho()
+
+	// TurnOnEcho turns on input echoing.
+	TurnOnEcho()
 }
 
 // New returns the subshell relevant to the current process, but does not activate it

diff --git a/internal/subshell/tcsh/tcsh.go b/internal/subshell/tcsh/tcsh.go
@@ -4,6 +4,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"runtime"
 
 	"github.com/ActiveState/cli/internal/errs"
 	"github.com/ActiveState/cli/internal/fileutils"
@@ -13,6 +14,7 @@ import (
 	"github.com/ActiveState/cli/internal/osutils/user"
 	"github.com/ActiveState/cli/internal/output"
 	"github.com/ActiveState/cli/internal/subshell/sscommon"
+	"github.com/ActiveState/cli/internal/subshell/termecho"
 	"github.com/ActiveState/cli/pkg/project"
 )
 
@@ -189,3 +191,17 @@ func (v *SubShell) IsAvailable() bool {
 	}
 	return fileutils.FileExists(rcFile)
 }
+
+func (v *SubShell) TurnOffEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.Off()
+}
+
+func (v *SubShell) TurnOnEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.On()
+}
diff --git a/internal/subshell/termecho/termecho.go b/internal/subshell/termecho/termecho.go
@@ -0,0 +1,20 @@
+package termecho
+
+import (
+	"github.com/ActiveState/cli/internal/errs"
+	"github.com/ActiveState/cli/internal/multilog"
+)
+
+func Off() {
+	err := toggle(false)
+	if err != nil {
+		multilog.Error("Unable to turn off terminal echoing: %v", errs.JoinMessage(err))
+	}
+}
+
+func On() {
+	err := toggle(true)
+	if err != nil {
+		multilog.Error("Unable to turn off terminal echoing: %v", errs.JoinMessage(err))
+	}
+}
diff --git a/internal/subshell/termecho/termecho_darwin.go b/internal/subshell/termecho/termecho_darwin.go
@@ -0,0 +1,6 @@
+package termecho
+
+import "golang.org/x/sys/unix"
+
+const ioctlReadTermios = unix.TIOCGETA
+const ioctlWriteTermios = unix.TIOCSETA
diff --git a/internal/subshell/termecho/termecho_linux.go b/internal/subshell/termecho/termecho_linux.go
@@ -0,0 +1,6 @@
+package termecho
+
+import "golang.org/x/sys/unix"
+
+const ioctlReadTermios = unix.TCGETS
+const ioctlWriteTermios = unix.TCSETS
diff --git a/internal/subshell/termecho/termecho_unix.go b/internal/subshell/termecho/termecho_unix.go
@@ -0,0 +1,32 @@
+//go:build linux || darwin
+// +build linux darwin
+
+package termecho
+
+import (
+	"os"
+
+	"github.com/ActiveState/cli/internal/errs"
+	"golang.org/x/sys/unix"
+)
+
+func toggle(on bool) error {
+	fd := int(os.Stdin.Fd())
+	termios, err := unix.IoctlGetTermios(fd, ioctlReadTermios)
+	if err != nil {
+		return errs.Wrap(err, "Could not get termios")
+	}
+
+	newState := *termios // copy
+	if !on {
+		newState.Lflag &^= unix.ECHO
+	} else {
+		newState.Lflag |= unix.ECHO
+	}
+	err = unix.IoctlSetTermios(fd, ioctlWriteTermios, &newState)
+	if err != nil {
+		return errs.Wrap(err, "Could not set termios")
+	}
+
+	return nil
+}
diff --git a/internal/subshell/termecho/termecho_windows.go b/internal/subshell/termecho/termecho_windows.go
@@ -0,0 +1,30 @@
+package termecho
+
+import (
+	"os"
+
+	"github.com/ActiveState/cli/internal/errs"
+	"golang.org/x/sys/windows"
+)
+
+func toggle(on bool) error {
+	fd := windows.Handle(os.Stdin.Fd())
+	var mode uint32
+	err := windows.GetConsoleMode(fd, &mode)
+	if err != nil {
+		return errs.Wrap(err, "Error calling GetConsoleMode")
+	}
+
+	newMode := mode
+	if !on {
+		newMode &^= windows.ENABLE_ECHO_INPUT
+	} else {
+		newMode |= windows.ENABLE_ECHO_INPUT
+	}
+	err = windows.SetConsoleMode(fd, newMode)
+	if err != nil {
+		return errs.Wrap(err, "Error calling SetConsoleMode")
+	}
+
+	return nil
+}
diff --git a/internal/subshell/zsh/zsh.go b/internal/subshell/zsh/zsh.go
@@ -7,6 +7,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"runtime"
 	"strings"
 
 	"github.com/ActiveState/cli/internal/constants"
@@ -18,6 +19,7 @@ import (
 	"github.com/ActiveState/cli/internal/osutils/user"
 	"github.com/ActiveState/cli/internal/output"
 	"github.com/ActiveState/cli/internal/subshell/sscommon"
+	"github.com/ActiveState/cli/internal/subshell/termecho"
 	"github.com/ActiveState/cli/pkg/project"
 )
 
@@ -239,3 +241,17 @@ func (v *SubShell) IsAvailable() bool {
 	}
 	return fileutils.FileExists(rcFile)
 }
+
+func (v *SubShell) TurnOffEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.Off()
+}
+
+func (v *SubShell) TurnOnEcho() {
+	if runtime.GOOS == "windows" {
+		return // not supported
+	}
+	termecho.On()
+}