Add a --skip-idle-time flag to tsh play (#44013)

This tells tsh to respect timing data (and the configured playback speed) while there is active recording data, but to skip over larger periods of idle time.
gravitational · Jul 16, 2024 · 2d628ff · 2d628ff
1 parent 8b54439
commit 2d628ff
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 18 deletions.
diff --git a/e b/e
diff --git a/lib/client/api.go b/lib/client/api.go
@@ -2123,7 +2123,7 @@ func (tc *TeleportClient) Join(ctx context.Context, mode types.SessionParticipan
 }
 
 // Play replays the recorded session.
-func (tc *TeleportClient) Play(ctx context.Context, sessionID string, speed float64) error {
+func (tc *TeleportClient) Play(ctx context.Context, sessionID string, speed float64, skipIdleTime bool) error {
 	ctx, span := tc.Tracer.Start(
 		ctx,
 		"teleportClient/Play",
@@ -2140,7 +2140,7 @@ func (tc *TeleportClient) Play(ctx context.Context, sessionID string, speed floa
 	}
 	defer clusterClient.Close()
 
-	return playSession(ctx, sessionID, speed, clusterClient.AuthClient)
+	return playSession(ctx, sessionID, speed, clusterClient.AuthClient, skipIdleTime)
 }
 
 const (
@@ -2153,7 +2153,7 @@ const (
 	keyDown  = 66
 )
 
-func playSession(ctx context.Context, sessionID string, speed float64, streamer libplayer.Streamer) error {
+func playSession(ctx context.Context, sessionID string, speed float64, streamer libplayer.Streamer, skipIdleTime bool) error {
 	sid, err := session.ParseID(sessionID)
 	if err != nil {
 		return trace.Wrap(err)
@@ -2177,8 +2177,9 @@ func playSession(ctx context.Context, sessionID string, speed float64, streamer
 	term.SetCursorPos(1, 1)
 
 	player, err := libplayer.New(&libplayer.Config{
-		SessionID: *sid,
-		Streamer:  streamer,
+		SessionID:    *sid,
+		Streamer:     streamer,
+		SkipIdleTime: skipIdleTime,
 	})
 	if err != nil {
 		return trace.Wrap(err)
@@ -2273,9 +2274,9 @@ func setTermSize(w io.Writer, size string) error {
 }
 
 // PlayFile plays the recorded session from a file.
-func PlayFile(ctx context.Context, filename, sid string, speed float64) error {
+func PlayFile(ctx context.Context, filename, sid string, speed float64, skipIdleTime bool) error {
 	streamer := &playFromFileStreamer{filename: filename}
-	return playSession(ctx, sid, speed, streamer)
+	return playSession(ctx, sid, speed, streamer, skipIdleTime)
 }
 
 // SFTP securely copies files between Nodes or SSH servers using SFTP

diff --git a/lib/player/player.go b/lib/player/player.go
@@ -41,10 +41,11 @@ import (
 // Player is used to stream recorded sessions over a channel.
 type Player struct {
 	// read only config fields
-	clock     clockwork.Clock
-	log       logrus.FieldLogger
-	sessionID session.ID
-	streamer  Streamer
+	clock        clockwork.Clock
+	log          logrus.FieldLogger
+	sessionID    session.ID
+	streamer     Streamer
+	skipIdleTime bool
 
 	speed      atomic.Value // playback speed (1.0 for normal speed)
 	lastPlayed atomic.Int64 // timestamp of most recently played event
@@ -106,10 +107,11 @@ type sessionPrintTranslator interface {
 
 // Config configures a session player.
 type Config struct {
-	Clock     clockwork.Clock
-	Log       logrus.FieldLogger
-	SessionID session.ID
-	Streamer  Streamer
+	Clock        clockwork.Clock
+	Log          logrus.FieldLogger
+	SessionID    session.ID
+	Streamer     Streamer
+	SkipIdleTime bool
 }
 
 func New(cfg *Config) (*Player, error) {
@@ -337,6 +339,9 @@ loop:
 		// will not apply until after the sleep completes
 		speed := p.speed.Load().(float64)
 		scaled := float64(currentDelay-lastDelay) / speed
+		if p.skipIdleTime {
+			scaled = min(scaled, 500.0*float64(time.Millisecond))
+		}
 
 		timer := p.clock.NewTimer(time.Duration(scaled) * time.Millisecond)
 		defer timer.Stop()

diff --git a/tool/tsh/common/play.go b/tool/tsh/common/play.go
@@ -78,7 +78,7 @@ func playSession(cf *CLIConf) error {
 	isLocalFile := path.Ext(cf.SessionID) == ".tar"
 	if isLocalFile {
 		sid := sessionIDFromPath(cf.SessionID)
-		if err := client.PlayFile(cf.Context, cf.SessionID, sid, speed); err != nil {
+		if err := client.PlayFile(cf.Context, cf.SessionID, sid, speed, cf.NoWait); err != nil {
 			return trace.Wrap(err)
 		}
 		return nil
@@ -89,7 +89,7 @@ func playSession(cf *CLIConf) error {
 		return trace.Wrap(err)
 	}
 
-	if err := tc.Play(cf.Context, cf.SessionID, speed); err != nil {
+	if err := tc.Play(cf.Context, cf.SessionID, speed, cf.NoWait); err != nil {
 		if trace.IsNotFound(err) {
 			log.WithError(err).Debug("error playing session")
 			return trace.NotFound("Recording for session %s not found.", cf.SessionID)

diff --git a/tool/tsh/common/tsh.go b/tool/tsh/common/tsh.go
@@ -969,6 +969,7 @@ func Run(ctx context.Context, args []string, opts ...CliOption) error {
 	play := app.Command("play", "Replay the recorded session (SSH, Kubernetes, App, DB).")
 	play.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
 	play.Flag("speed", "Playback speed, applicable when streaming SSH or Kubernetes sessions.").Default("1x").EnumVar(&cf.PlaySpeed, "0.5x", "1x", "2x", "4x", "8x")
+	play.Flag("skip-idle-time", "Quickly skip over idle time, applicable when streaming SSH or Kubernetes sessions.").BoolVar(&cf.NoWait)
 	play.Flag("format", defaults.FormatFlagDescription(
 		teleport.PTY, teleport.JSON, teleport.YAML,
 	)).Short('f').Default(teleport.PTY).EnumVar(&cf.Format, teleport.PTY, teleport.JSON, teleport.YAML)