Fix frame invalidation

Author: Lexer747

cmd/subcommands/acci-ping/acci-ping.go

@@ -27,7 +27,6 @@ type Config struct {
 	*application.SharedFlags
 	*tabflags.FlagSet
 
-	debugFps           *int
 	debuggingTermSize  *string
 	filePath           *string
 	followingOnStart   *bool
@@ -69,7 +68,6 @@ func GetFlags(info *application.BuildInfo) *Config {
 		debuggingTermSize: tf.String("debug-term-size", "", "switches the terminal to fixed mode and no iteractivity",
 			tabflags.AutoComplete{Choices: []string{"15x80", "20x85", "HxW"}}),
 		followingOnStart:   tf.Bool("follow", false, "if this flag is used the graph will be shown in following mode immediately"),
-		debugFps:           tf.Int("debug-fps", 240, "configures the internal tickrate for the graph re-paint look (in FPS)"),
 		logarithmicOnStart: tf.Bool("logarithmic", false, "if this flag is used the graph will be shown in logarithmic mode immediately"),
 	}
 	*ret.pingBufferingLimit = 10

cmd/subcommands/acci-ping/application.go

@@ -108,7 +108,7 @@ func (app *Application) Run(
 	defer close(guiControlChannel)
 	defer close(guiSpeedChange)
 	// Very high FPS is good for responsiveness in the UI (since it's locked) and re-drawing on a re-size.
-	graph, cleanup, terminalSizeUpdates, err := app.g.Run(ctx, cancelFunc, *app.config.debugFps, app.listeners(), app.fallbacks)
+	graph, cleanup, terminalSizeUpdates, err := app.g.Run(ctx, cancelFunc, app.listeners(), app.fallbacks)
 	termRecover := func() {
 		_ = app.term.ClearScreen(terminal.UpdateSize)
 		cleanup()

graph/drawing.go

@@ -28,10 +28,9 @@ import (
 )
 
 type computeFrameConfig struct {
-	timeBetweenFrames time.Duration
-	followLatestSpan  bool
-	drawSpinner       bool
-	yAxisScale        YAxisScale
+	followLatestSpan bool
+	drawSpinner      bool
+	yAxisScale       YAxisScale
 }
 
 func (c computeFrameConfig) Match(cfg computeFrameConfig) bool {
@@ -41,14 +40,6 @@ func (c computeFrameConfig) Match(cfg computeFrameConfig) bool {
 
 const drawingDebug = false
 
-func getTimeBetweenFrames(fps int, pingsPerMinute ping.PingsPerMinute) time.Duration {
-	if fps == 0 {
-		return ping.PingsPerMinuteToDuration(pingsPerMinute)
-	} else {
-		return time.Duration(1000/fps) * time.Millisecond
-	}
-}
-
 var noFrame = func(w io.Writer) error { return nil }
 
 func (g *Graph) computeFrame(cfg computeFrameConfig) func(io.Writer) error {

graph/graph.go

@@ -25,13 +25,14 @@ import (
 )
 
 type Graph struct {
-	ui             gui.GUI
-	Term           *terminal.Terminal
-	dataChannel    <-chan ping.PingResults
-	data           *graphdata.GraphData
-	frameMutex     *sync.Mutex
-	drawingBuffer  *draw.Buffer
-	presentation   *controlState
+	ui            gui.GUI
+	Term          *terminal.Terminal
+	dataChannel   <-chan ping.PingResults
+	data          *graphdata.GraphData
+	frameMutex    *sync.Mutex
+	drawingBuffer *draw.Buffer
+	presentation  *controlState
+
 	controlChannel <-chan Control
 	lastFrame      frame
 	initial        ping.PingsPerMinute
@@ -128,12 +129,9 @@ func NewGraph(ctx context.Context, cfg GraphConfiguration) *Graph {
 func (g *Graph) Run(
 	ctx context.Context,
 	stop context.CancelCauseFunc,
-	fps int, // this isn't really an FPS given how the GUI is setup and paint buffers, more like a max re-paint delay timer thing.
 	listeners []terminal.ConditionalListener,
 	fallbacks []terminal.Listener,
 ) (func() error, func(), <-chan terminal.Size, error) {
-	timeBetweenFrames := getTimeBetweenFrames(fps, g.initial)
-	frameRate := time.NewTicker(timeBetweenFrames)
 	cleanup, err := g.Term.StartRaw(ctx, stop, listeners, fallbacks)
 	if err != nil {
 		return nil, cleanup, nil, err
@@ -143,12 +141,14 @@ func (g *Graph) Run(
 		size := g.Term.GetSize()
 		defer close(terminalUpdates)
 		slog.Info("running acci-ping")
+		// The main loop of acci-ping, await on the context (will be fired by the terminal)
 		for {
 			select {
 			case <-ctx.Done():
 				return context.Cause(ctx)
-			case <-frameRate.C:
-				err = g.Term.UpdateSize()
+			default:
+				// The main body of acci-ping, get the terminal size and send on the channel if changed
+				err := g.Term.UpdateSize()
 				if err != nil {
 					return err
 				}
@@ -157,14 +157,18 @@ func (g *Graph) Run(
 					terminalUpdates <- size
 					size = g.Term.GetSize()
 				}
+				// Lock the presentation layer (this ensures we don't get GUI tearing - as in one component
+				// has data from last frame and another component has data from this frame), compute a new
+				// frame. Note that the optimisations to do no drawing are all in this function.
 				g.presentation.m.Lock()
 				toWrite := g.computeFrame(computeFrameConfig{
-					timeBetweenFrames: timeBetweenFrames,
-					followLatestSpan:  g.presentation.Following,
-					drawSpinner:       true,
-					yAxisScale:        g.presentation.YAxisScale,
+					followLatestSpan: g.presentation.Following,
+					drawSpinner:      true,
+					yAxisScale:       g.presentation.YAxisScale,
 				})
 				g.presentation.m.Unlock()
+				// Now that we have a frame to draw (may just be a spinner update), execute this function
+				// writing the painted frame to the terminal.
 				err = toWrite(g.Term)
 				if err != nil {
 					return err

graph/graphdata/graphdata.go

@@ -8,7 +8,6 @@ package graphdata
 
 import (
 	"fmt"
-	"io"
 	"sync"
 	"time"
 
@@ -67,12 +66,6 @@ func (gd *GraphData) Summary() string {
 	return gd.data.Summary()
 }
 
-func (gd *GraphData) AsCompact(w io.Writer) error {
-	gd.m.Lock()
-	defer gd.m.Unlock()
-	return gd.data.AsCompact(w)
-}
-
 func (gd *GraphData) Lock() {
 	gd.m.Lock()
 }