mirrors/lazygit
1
0
Fork 0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-05-12 04:45:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix flaky integration test (#4432)

Browse source 
- **PR Description**

The integration test `stash/rename.go` occasionally fails for me
locally. This PR fixes it.

In 8b8343b8a9 we made a change to run newPtyTask from AfterLayout; this
is needed so that the PTY gets the new, updated view size. However, this
created a race condition for integration tests that select a line in a
list view and then expect the main view to have certain content;
sometimes that content gets rendered too late.

I'm surprised that this didn't cause more tests to fail; right now I
only know of one test that occasionally fails because of this, which is
`stash/rename.go`.

Fix this by moving the AfterLayout to inside newPtyTask, and do it only
when we are actually using a PTY (we don't when no pager is configured,
which is the case for integration tests).

The diff is best viewed with "ignore whitespace" turned on.
This commit is contained in:
Stefan Haller 2025-03-31 10:50:39 +02:00 • committed by GitHub
commit cd2286276c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 39 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

5
pkg/gui/main_panels.go
View file

@ -20,10 +20,7 @@ func (gui *Gui) runTaskForView(view *gocui.View, task types.UpdateTask) error {
return gui.newCmdTask(view, v.Cmd, v.Prefix) return gui.newCmdTask(view, v.Cmd, v.Prefix)
case *types.RunPtyTask: case *types.RunPtyTask:
gui.afterLayout(func() error { return gui.newPtyTask(view, v.Cmd, v.Prefix)
return gui.newPtyTask(view, v.Cmd, v.Prefix)
})
return nil
} }
return nil return nil

70
pkg/gui/pty.go
View file

@ -54,45 +54,51 @@ func (gui *Gui) newPtyTask(view *gocui.View, cmd *exec.Cmd, prefix string) error
return gui.newCmdTask(view, cmd, prefix) return gui.newCmdTask(view, cmd, prefix)
} }
cmdStr := strings.Join(cmd.Args, " ") // Run the pty after layout so that it gets the correct size
gui.afterLayout(func() error {
// Need to get the width and the pager again because the layout might have
// changed the size of the view
width = view.InnerWidth()
pager = gui.git.Config.GetPager(width)
// This communicates to pagers that we're in a very simple cmdStr := strings.Join(cmd.Args, " ")
// terminal that they should not expect to have much capabilities.
// Moving the cursor, clearing the screen, or querying for colors are among such "advanced" capabilities.
// Context: https://github.com/jesseduffield/lazygit/issues/3419
cmd.Env = removeExistingTermEnvVars(cmd.Env)
cmd.Env = append(cmd.Env, "TERM=dumb")
cmd.Env = append(cmd.Env, "GIT_PAGER="+pager) // This communicates to pagers that we're in a very simple
// terminal that they should not expect to have much capabilities.
// Moving the cursor, clearing the screen, or querying for colors are among such "advanced" capabilities.
// Context: https://github.com/jesseduffield/lazygit/issues/3419
cmd.Env = removeExistingTermEnvVars(cmd.Env)
cmd.Env = append(cmd.Env, "TERM=dumb")
manager := gui.getManager(view) cmd.Env = append(cmd.Env, "GIT_PAGER="+pager)
var ptmx *os.File manager := gui.getManager(view)
start := func() (*exec.Cmd, io.Reader) {
var err error var ptmx *os.File
ptmx, err = pty.StartWithSize(cmd, gui.desiredPtySize(view)) start := func() (*exec.Cmd, io.Reader) {
if err != nil { var err error
gui.c.Log.Error(err) ptmx, err = pty.StartWithSize(cmd, gui.desiredPtySize(view))
if err != nil {
gui.c.Log.Error(err)
}
gui.Mutexes.PtyMutex.Lock()
gui.viewPtmxMap[view.Name()] = ptmx
gui.Mutexes.PtyMutex.Unlock()
return cmd, ptmx
} }
gui.Mutexes.PtyMutex.Lock() onClose := func() {
gui.viewPtmxMap[view.Name()] = ptmx gui.Mutexes.PtyMutex.Lock()
gui.Mutexes.PtyMutex.Unlock() ptmx.Close()
delete(gui.viewPtmxMap, view.Name())
gui.Mutexes.PtyMutex.Unlock()
}
return cmd, ptmx linesToRead := gui.linesToReadFromCmdTask(view)
} return manager.NewTask(manager.NewCmdTask(start, prefix, linesToRead, onClose), cmdStr)
})
onClose := func() {
gui.Mutexes.PtyMutex.Lock()
ptmx.Close()
delete(gui.viewPtmxMap, view.Name())
gui.Mutexes.PtyMutex.Unlock()
}
linesToRead := gui.linesToReadFromCmdTask(view)
if err := manager.NewTask(manager.NewCmdTask(start, prefix, linesToRead, onClose), cmdStr); err != nil {
return err
}
return nil return nil
} }