bug: rendering issues

move to a background refreshing thread approach

Author: ibuildthecloud

area.go

@@ -24,11 +24,6 @@ func (a *area) Fd() uintptr {
 	return os.Stdout.Fd()
 }
 
-func (a *area) Finish(text string) {
-	a.Update(text)
-	cursor.Show()
-}
-
 func (a *area) Update(text string) {
 	if a.cursor == nil {
 		c := cursor.NewArea().WithWriter(a)

display.go

@@ -2,21 +2,28 @@ package tui
 
 import (
 	"strings"
+	"sync"
 	"time"
 
-	"github.com/pterm/pterm"
+	"atomicgo.dev/cursor"
 )
 
 var (
-	defaultDuration = 200 * time.Millisecond
+	loopDelay = 200 * time.Millisecond
 )
 
+type displayState struct {
+	area      area
+	lastPrint string
+	content   string
+	finish    bool
+}
+
 type display struct {
-	area         area
-	prompter     *prompter
-	last         time.Time
-	lastDuration time.Duration
-	stopped      bool
+	displayState
+	prompter    *prompter
+	contentLock sync.Mutex
+	closer      func()
 }
 
 func newDisplay(tool string) (*display, error) {
@@ -25,25 +32,43 @@ func newDisplay(tool string) (*display, error) {
 		return nil, err
 	}
 
-	return &display{
-		prompter:     prompter,
-		lastDuration: defaultDuration,
-	}, nil
+	t := time.NewTicker(loopDelay)
+	d := &display{
+		prompter: prompter,
+		closer:   t.Stop,
+	}
+
+	go func() {
+		for range t.C {
+			d.paint()
+		}
+	}()
+
+	return d, nil
+}
+
+func (a *display) readline(f func() (string, bool)) (string, bool) {
+	a.paint()
+	cursor.Show()
+	defer cursor.Hide()
+	return f()
 }
 
 func (a *display) Ask(text string, sensitive bool) (string, bool) {
 	a.setMultiLinePrompt(text)
 	if sensitive {
-		return a.prompter.ReadPassword()
+		return a.readline(a.prompter.ReadPassword)
 	}
-	return a.prompter.Readline()
+	return a.readline(a.prompter.Readline)
 }
 
 func (a *display) setMultiLinePrompt(text string) {
 	lines := strings.Split(text, "\n")
 	a.prompter.SetPrompt(lines[len(lines)-1])
 	if len(lines) > 1 {
-		a.area.Update(a.area.content + "\n" + strings.Join(lines[:len(lines)-1], "\n") + "\n")
+		a.contentLock.Lock()
+		defer a.contentLock.Unlock()
+		a.content = a.area.content + "\n" + strings.Join(lines[:len(lines)-1], "\n") + "\n"
 	}
 }
 
@@ -58,7 +83,7 @@ const (
 func (a *display) AskYesNo(text string) (Answer, bool, error) {
 	a.setMultiLinePrompt(text)
 	for {
-		line, ok := a.prompter.Readline()
+		line, ok := a.readline(a.prompter.Readline)
 		if !ok {
 			return No, ok, nil
 		}
@@ -75,49 +100,49 @@ func (a *display) AskYesNo(text string) (Answer, bool, error) {
 
 func (a *display) Prompt(text string) (string, bool) {
 	a.prompter.SetPrompt(text)
-	return a.prompter.Readline()
+	return a.readline(a.prompter.Readline)
 }
 
-func (a *display) Progress(text string) error {
-	if text == "" {
-		return nil
+func (a *display) paint() {
+	a.contentLock.Lock()
+	if a.finish {
+		a.area.Update(a.content)
+		cursor.Show()
+		a.displayState = displayState{}
+		a.contentLock.Unlock()
+		return
 	}
 
-	if a.stopped {
-		a.area = area{}
-		a.stopped = false
-		a.last = time.Time{}
-		a.lastDuration = defaultDuration
-	}
+	newContent := a.content
+	a.contentLock.Unlock()
 
-	start := time.Now()
-	if start.Sub(a.last) > a.lastDuration {
-		lines := strings.Split(text, "\n")
-		height := pterm.GetTerminalHeight()
-		if len(lines) > height {
-			lines = lines[len(lines)-height:]
-		}
-		newText := strings.Join(lines, "\n")
-		a.area.Update(newText)
-		done := time.Now()
-		delta := done.Sub(start)
-		if delta > a.lastDuration {
-			a.lastDuration = delta
-		}
-		a.last = done
+	if newContent == a.lastPrint {
+		return
 	}
 
-	return nil
+	a.area.Update(newContent)
+	a.lastPrint = newContent
+}
+
+func (a *display) Progress(text string) {
+	a.contentLock.Lock()
+	defer a.contentLock.Unlock()
+	a.content = text
 }
 
 func (a *display) Close() error {
+	a.closer()
 	return a.prompter.Close()
 }
 
 func (a *display) Finished(text string) {
+	defer a.paint()
+	a.contentLock.Lock()
+	defer a.contentLock.Unlock()
+
 	if !strings.HasSuffix(text, "\n") {
 		text += "\n"
 	}
-	a.stopped = true
-	a.area.Finish(text)
+	a.finish = true
+	a.content = text
 }

go.mod

@@ -9,10 +9,9 @@ require (
 	github.com/charmbracelet/lipgloss v0.11.0
 	github.com/chzyer/readline v1.5.1
 	github.com/fatih/color v1.17.0
-	github.com/gptscript-ai/go-gptscript v0.9.3-0.20240731222146-b67275f3fa69
+	github.com/gptscript-ai/go-gptscript v0.9.4-0.20240801203434-840b14393b17
 	github.com/pterm/pterm v0.12.79
 	github.com/sourcegraph/go-diff-patch v0.0.0-20240223163233-798fd1e94a8e
-	github.com/stretchr/testify v1.8.4
 	golang.org/x/exp v0.0.0-20240103183307-be819d1f06fc
 )
 
@@ -24,7 +23,6 @@ require (
 	github.com/aymerick/douceur v0.2.0 // indirect
 	github.com/charmbracelet/x/ansi v0.1.1 // indirect
 	github.com/containerd/console v1.0.4 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dlclark/regexp2 v1.4.0 // indirect
 	github.com/getkin/kin-openapi v0.124.0 // indirect
 	github.com/go-openapi/jsonpointer v0.20.2 // indirect
@@ -45,7 +43,6 @@ require (
 	github.com/muesli/termenv v0.15.2 // indirect
 	github.com/olekukonko/tablewriter v0.0.6-0.20230925090304-df64c4bbad77 // indirect
 	github.com/perimeterx/marshmallow v1.1.5 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
 	github.com/yuin/goldmark v1.5.4 // indirect

go.sum

@@ -64,8 +64,8 @@ github.com/gookit/color v1.5.4 h1:FZmqs7XOyGgCAxmWyPslpiok1k05wmY3SJTytgvYFs0=
 github.com/gookit/color v1.5.4/go.mod h1:pZJOeOS8DM43rXbp4AZo1n9zCU2qjpcRko0b6/QJi9w=
 github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY=
 github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c=
-github.com/gptscript-ai/go-gptscript v0.9.3-0.20240731222146-b67275f3fa69 h1:c+Tf6I8jUg8hDgfP8jKs93UcC9dDIGxClWGZUL36Hd0=
-github.com/gptscript-ai/go-gptscript v0.9.3-0.20240731222146-b67275f3fa69/go.mod h1:Dh6vYRAiVcyC3ElZIGzTvNF1FxtYwA07BHfSiFKQY7s=
+github.com/gptscript-ai/go-gptscript v0.9.4-0.20240801203434-840b14393b17 h1:BTfJ6ls31Roq42lznlZnuPzRf0wrT8jT+tWcvq7wDXY=
+github.com/gptscript-ai/go-gptscript v0.9.4-0.20240801203434-840b14393b17/go.mod h1:Dh6vYRAiVcyC3ElZIGzTvNF1FxtYwA07BHfSiFKQY7s=
 github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
 github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
 github.com/invopop/yaml v0.2.0 h1:7zky/qH+O0DwAyoobXUqvVBwgBFRxKoQ/3FjcVpjTMY=

run.go

@@ -14,6 +14,7 @@ import (
 	"strings"
 	"time"
 
+	"atomicgo.dev/cursor"
 	"github.com/fatih/color"
 	"github.com/gptscript-ai/go-gptscript"
 	"github.com/pterm/pterm"
@@ -129,6 +130,7 @@ func Run(ctx context.Context, tool string, opts ...RunOptions) error {
 		eventOut              io.Writer
 	)
 	defer cancel()
+	defer cursor.Show()
 
 	if err != nil {
 		return err
@@ -256,9 +258,7 @@ func Run(ctx context.Context, tool string, opts ...RunOptions) error {
 
 			if event.Call != nil {
 				text = render(input, run)
-				if err := ui.Progress(text); err != nil {
-					return err
-				}
+				ui.Progress(text)
 			}
 
 			if ok, err := confirm.HandlePrompt(localCtx, event, ui.Ask); !ok {