Capture a design discussion (no code yet; implementation is a future session): - The escape-from-staging restore should anchor on the explorer view's current patch identity at escape time, not a saved numeric scroll/index, since staging or dropping hunks changes the content. This is the inverse direction of the diff-line-metadata primitive (identity -> rendered row) and the same operation the -U scroll-preservation consumer needs; record it as consumer #6 and split the consumer list into forward (1-4) and inverse (5-6) directions. - Record the escape-routing cases the current prototype gets wrong (staging the last hunk should land in the staged half; <tab> between staged/unstaged; the empty-view and custom-patch-builder cases). - Decide to solve the new restore mechanism, the §11 timing races, and the BufferLineForViewLine staleness trap together in the prototype rather than defer them to productionization (you can't plan around unsolved entangled mechanisms), with a dependency-first attack order (§8 fix, characterize the races, then the predicate-scroll restore). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
40 KiB
Focused main view — session notes
A working document capturing everything we discussed, built, and learned in this session. It is meant as a starting point for future sessions, which might:
- Continue solving the problem we were in the middle of (restoring scroll + selection when escaping back to a focused main view) — still at prototype quality.
- Enhance the prototype with a few more missing pieces.
- Productionize the whole thing: better quality, a clean commit history, and tests. (We did not make that plan; this doc gives a future session enough context to make it.)
Status at end of session 3 (the latest): branch
use-delta-hyperlinks-for-clicking-in-diff. The escape scroll/selection restore is implemented and committed — at normal speed there is no visible flicker. Session 3 implemented §6's proposed fix (a cmd/pty analogue ofRenderStringWithScrollTask), discovered and fixed a second cause of the top-flicker (the scroll-reset loop inrefreshMainViewsran beforeCopyContent), and corrected session 2's belief that theonNewKeysuppression could be dropped (it can't — it's folded into the same mechanism). Full story in the new §11, which supersedes §6's "correct fix" subsection. The working tree is now clean (everything committed); the tree builds, isgofumpt-clean, unit tests pass, ande2e-allis green except one pre-existing direnv-environmental worktree test.What's left before productionizing: under
LAZYGIT_SLOW_RENDERa few imperfect intermediate frames still appear occasionally — real timing races we agreed to investigate and eliminate (not paper over with "fine at normal speed"). See §11 "Remaining timing races". Memory:focused-main-view-flicker-timing-races.
1. The big picture: what this feature is
lazygit has a "focused main view": you press 0 (Universal.FocusMainView),
or click, to move focus from a side panel (files, commits, commit-files,
stash, branches, …) into the main view that shows its diff, so you can
scroll and interact with the diff itself. The branch builds this out into a
real interaction model:
- A selection can be shown in the focused main view (a highlighted line), toggled on demand.
- With a selection showing you can:
enter/ double-click → dive into staging (files) or patch building (commits / commit-files) for the clicked line.e→ edit that line in your editor (like the staging view'se).G→ open the selected line in the current branch's GitHub PR diff (so you can comment on it).
- Clicking sets the selection at the clicked line; double-click
activates (dives in).
0focuses without a selection (scroll mode).
This all relies on delta emitting lazygit-edit://<path>:<line> OSC-8
hyperlinks in the rendered diff (hence the branch name); lazygit parses those
to know which file/line a view line corresponds to.
2. Branch state
Branch: use-delta-hyperlinks-for-clicking-in-diff (off lazygit master). The
working tree is clean — everything is committed. The branch was rebased
in session 3 (SHAs below are current): the LAZYGIT_SLOW_RENDER knob was moved
to the base of the branch (so it can be tested against master), and the
SetOriginX/Y chokepoint refactor was squashed into one commit.
Current commit list (most recent first), master..HEAD:
625e7dbad Restore scroll and selection seamlessly when escaping to a focused main view ← session 3
054d139fe Let a cmd/pty task restore a saved scroll position at its first paint ← session 3
7f547a5a3 Reset other main views' scroll after copying content, not before ← session 3
fe79d18b6 Route all view origin writes through SetOriginX and SetOriginY ← session 3 (chokepoint refactor; candidate for master)
89e6f6b14 Session notes: corrected flicker diagnosis and the 3 bug fixes
86f4b3486 Fire queued ReadToEnd callbacks when the initial read reaches EOF ← session 2 bug fix
b7470af27 Don't scroll a view up to fill blank space while its content is loading ← session 2 bug fix
788d959ad Lock the view and guard the line index when reading a hyperlink ← session 2 bug fix
63221c3dd Session notes
5f500893a WIP FocusedMainViewSnapshot approach ← WIP (needs rework)
207927e0d WIP New click behavior ← WIP (needs rework)
385d2e9dd Open a browser at the selected line in the diff of the current branch's PR
c5dd8ddc6 Press `e` in focused main view (when selection is showing) to edit that line
55922f81a Replace gui.showSelectionInFocusedMainView config with on-demand selection
877812c6a WIP After going straight to patch building from main view, esc goes all the way back out ← WIP (needs rework)
0088f26c1 Press enter in main view of commits panel to enter patch building for clicked line
ec50f3122 Extract some functions from CommitFilesController to a new CommitFilesHelper
ed2015cac Press enter in main view of files/commitFiles to enter staging/patch-building
1e5f31dd6 Select line that is in the middle of the screen
fff7a0d19 Press enter in focused main view when user config is on
8a26bebbb Add user config gui.showSelectionInFocusedMainView
ed48988a9 Add LAZYGIT_SLOW_RENDER debug knob for watching async render frames ← base; candidate for master
The three WIP commits and the heavily-iterated FocusedMainViewSnapshot
machinery will need re-sequencing for productionization (see §8). The two
clearly-standalone, master-worthy commits (ed48988a9 slow-render at the base,
fe79d18b6 the SetOriginX/Y chokepoint) are deliberately isolated so they can
be cherry-picked off.
3. Architecture primer (what we learned about lazygit internals)
Contexts, the stack, and NextInStack
- Each panel/view is a context. The
ContextMgrkeeps a stack (pkg/gui/context.go).Push/Popmanage it. Kinds:SIDE_CONTEXT,MAIN_CONTEXT, popups, etc. - Pushing a
SIDE_CONTEXTwipes the stack down to just it. Pushing aMAIN_CONTEXTevicts other main contexts but keeps non-main ones beneath. Only one main context is ever on the stack at a time. - A focused main view's "side panel" is found via
ContextMgr.NextInStack(ctx)— the entry just below it on the stack. This was introduced on master in commitbbd17abc43a("Add ContextMgr.NextInStack…") specifically to stop abusing the parent-context mechanism for this. Earlier prototype code on this branch assumed the focused main view's parent context was its side panel; that assumption is gone now — useNextInStack. (Memory:worktree-path-vs-repo-pathis unrelated; this is a different gotcha.)
The focused main view contexts vs. the patch-explorer contexts
pkg/gui/context/setup.go:
Normal→Mainview, window"main";NormalSecondary→Secondaryview, window"secondary". These areMainContext(aSimpleContext). This is the focused main view.Staging→Stagingview, window"main";StagingSecondary→StagingSecondaryview, window"secondary";CustomPatchBuilder→PatchBuildingview, window"main". These arePatchExplorerContext(alsoMAIN_CONTEXT).- Crucial:
NormalandStaging/CustomPatchBuildershare the same window but are separate gocui views. Only one view per window is shown at a time; the others are hidden but retain their buffer (content, scroll, selection). So entering staging hides theMainview rather than overwriting it — its scroll/selection survive unless something explicitly re-renders theMainview (see "the clobber" below).
Dispatch: GetOnClickFocusedMainView
- Controllers expose
GetOnClickFocusedMainView() func(mainViewName string, clickedLineIdx int) error. pkg/gui/controllers/attach.goregisters it on the context (AddOnClickFocusedMainViewFn).MainViewController.enterForLine/onClickInAlreadyFocusedViewcallNextInStack(self.context).GetOnClickFocusedMainView()(viewName, lineIdx).- Implementers:
FilesController(→ staging),CommitFilesController(→ patch building),SwitchToDiffFilesController(commits/stash → patch building). - The line/file is resolved from the
lazygit-edit://hyperlink viaStagingHelper.GetFileAndLineForClickedDiffLine(viewName, lineIdx)— this reads the hyperlink on the given view line (so it accounts for wrapping) and parseslazygit-edit://<path>:<line>.
The async render-task system (pkg/tasks/tasks.go) — the crux of our blocker
Rendering a diff into a view is asynchronous and lazy:
- A view has a
ViewBufferManager.RenderToMainViews→ a cmd task keyed on the command string. - The initial render reads only
linesToReadFromCmdTask(view)lines (one screenful, ~37), then the task waits on itsreadLineschannel for more (e.g. when you scroll down,ViewSelectionControllerrequests more). ViewBufferManager.ReadToEnd(then)sends{Total:-1, Then:then}toreadLines; the loop reads to EOF, runsonEndOfInput, then callsthen. But ifself.readLines == nil(no live task),ReadToEndcallsthen()immediately/synchronously — this is a premature-fire trap.- A task's
readLinesis created inside the task goroutine (async), so right afterPush/render the channel may not exist yet. onNewKey(view.SetOrigin(0,0)) runs at task start iff the key changed. Same command/key ⇒ origin preserved; different key ⇒ origin reset to top.view.Reset()(beforeStart) rewinds the write pointer; it does not reset origin.onEndOfInputclamps origin if the new content is shorter.MainViewController.openSearchis the existing precedent that usesGetViewBufferManagerForView(view).ReadToEnd(func(){ OnUIThread(...) })— but it does so on a view that's already focused with a live task, which is exactly the precondition we keep failing to establish.
Gocui view bits we used
view.OriginY()/view.SetOrigin(x,y)— scroll.SetOriginclamps<0only (not to content length).view.SelectedLineIdx()=OriginY + CursorY(absolute view-line).view.FocusPoint(cx, cy, scrollIntoView)— sets cursor to absolutecy(v.cy = cy - v.oy); withscrollIntoViewit adjusts origin viacalculateNewOrigin. Returns early ifcy < 0 || cy > lineCount— so it silently no-ops if the content isn't loaded that far. (This is why a deep selection "doesn't take" when only a screenful is loaded.)view.Highlight/view.HighlightInactive— whether/how the selection is drawn.SimpleContext.HandleFocusLostsetsHighlight=false(so the focused-main selection is cleared whenever the view loses focus). We addedMainViewController.GetOnFocusto resetHighlightInactive=falseon the way back in.
4. The decided UX (don't relitigate without reason)
- Click = point at a line ⇒ select it. Single-click sets/moves the
selection to the clicked line and does nothing else. Double-click = the
"activate/open" gesture ⇒ dive into staging/patch building for that line.
Clicking an unfocused view focuses and selects (one click → ready for
e/G/enter).0focuses with no selection (scroll mode) — because it doesn't point at a line. - Escape from staging/patch-building should return to the focused main view
you came from, showing the same main-view content again (fresh, not
stale), with the same scroll position and selection, and with the main
view focused (not the side panel). One
enterin → oneescout. - For commits/stash, "the same content" means the whole-commit diff you were looking at — not a different focused main view (e.g. not the commit-files file diff). Landing on a different focused main view was explicitly rejected.
- "Stale content is out of the question" — when the underlying file changed (e.g. after staging), the returned main view must re-render fresh. (We accept that the selection may then be slightly off, since the diff changed — no fix planned.)
Keybindings (focused main view, when a selection is showing)
In MainViewController.GetKeybindings: Universal.Select (space) toggles
selection; Universal.GoInto (enter) dives in; Universal.Edit (e) edits;
Commits.OpenPullRequestInBrowser (G) opens the PR line;
Universal.Return (esc) hides selection / exits. </> are goto top/bottom
(so G is free).
5. The GitHub PR-line feature (working, committed 77157c5ad)
MainViewController.openPullRequestForSelectedLine:
- URL form:
<pr.Url>/changes/<commitSha>#diff-<sha256(relPath)>R<line>.<commitSha>=DiffableContext.RefForAdjustingLineNumberInDiff()of the side panel (selected commit / the commit-files "to" ref). Using the specific commit's view means the right-side line numbers match what's shown, so noAdjustLineNumberneeded here (unlikee).relPath= repo-relative path viafilepath.Rel(RepoPaths.WorktreePath(), abs)thenfilepath.ToSlash. The anchor issha256(relPath)— exact bytes, forward slashes, original case, no trailing newline. (Verified empirically; the#diff-…hash is SHA-256 of the new-file path.R<line>= right/new side;L= left/old.)
- Branch resolution (
branchForPullRequest):commits→CheckedOutBranch;subCommits→SubCommits.GetRef().RefName();commitFiles→ recurse into its parent context. GitHub-only (driven byModel().PullRequestsMap).
GOTCHA recorded to memory
WorktreePath() vs RepoPath(): to make a working-tree path repo-relative use
RepoPaths.WorktreePath(), not RepoPath() — they differ in linked
worktrees (this dev setup uses .worktrees/scratch), and RepoPath()
silently produced the wrong relative path → wrong sha256 anchor. See memory
worktree-path-vs-repo-path.
6. THE IN-PROGRESS PROBLEM (where to resume)
Goal: escaping staging/patch building that was entered from a focused main view should return to that focused main view, fresh content, scroll + selection restored, main view focused.
The mechanism (now committed + a little still uncommitted)
types.FocusedMainViewSnapshot { SidePanel, SidePanelSelectedLineIdx, MainView, OriginY, SelectedLineIdx }(pkg/gui/types/context.go).- Stored on
PatchExplorerContext.focusedMainViewSnapshot(nil⇒ entered the normal way ⇒ plainPop()), captured at entry infocusedMainViewSnapshot(…)(main_view_controller.go), threaded throughFilesController.EnterFile/CommitFilesHelper.EnterCommitFile. All of this is committed ind901a9711. - Escape:
helpers.EscapeFromPatchExplorer(c, ctx)restores the side panel's selection,Push(SidePanel),Push(MainView), then restores origin + selection. The current version of this (theReadToEnd-based restore plus thekeepOriginmachinery below) is the uncommitted part left in the working tree — it's WIP because the flicker isn't fully solved.
Where session 2 landed: the flicker is fully diagnosed; 3 bug fixes committed
Restoring scroll + selection on escape works (the final state is correct).
What remained was a flicker on the way in: a brief intermediate frame before
the view settles at the saved position. Chasing it uncovered three genuine,
independent bugs (all now committed on top of e5326c3a6):
6c7d9a295Lock the view + guard the line index inHyperLinkInLine. It readv.lines/v.viewLineswith nowriteMutex, racing a concurrent re-render, and indexedv.lines[viewLines[y].linesY]after only checkingyagainstlen(viewLines). BecauserefreshViewLinesIfNeededoverwritesviewLinesin place without truncating, the tail keeps stale entries whoselinesYpoints past a shrunkv.lines→ out-of-range panic onenterwhile a shorter diff was still loading.3b31cfe01Don't scroll a view up to fill blank space while loading. The layout's scroll-up clamp ([layout.go], added in6114f69ee5ef) clamps a view's origin toTotalContentHeight()— which for a main view is just the lines loaded so far. During an async re-render that's a fraction of the eventual content, so it yanked the view to the top. Fix: a synchronously-setViewBufferManager.loadingflag (set in the cmd/pty wrappers before the layout pass, cleared at EOF but not on stop), and the layout skips the clamp while loading.a4b72a6f6Fire queuedReadToEndcallbacks when the initial read hits EOF. The read loop processes one request at a time; the initial request has noThenand a large line count, so if the content is shorter it hits EOF on that request andbreaks out, abandoning any queuedReadToEndrequest in the channel → itsThensilently dropped (this was session 1's "ReadToEnd'sthennever fired" mystery!). Fix: drain queued requests and fire theirThens on EOF.
Corrected diagnosis (session 1's §6 diagnosis was WRONG in its mechanism)
Session 1 said "on restore only the initial screenful (height=37) is loaded,
so FocusPoint returns early." That was inaccurate. The truth, confirmed by
instrumenting every write to the main view's oy (see Debug tooling §10):
linesToReadFromCmdTaskreadsheight*(height-1)+oylines (≈1332+, capped at 5000) — not one screenful. For typical diffs the whole thing loads quickly.- The scroll wasn't failing because content was unloaded at restore time (the
ReadToEndrestore, once the drain fix above made it fire, sets the final position correctly). It was failing because the layout clamp (bug #2) was resettingoyto 0 on every layout pass during the async load, until the content caught up. That is the real cause of "scroll resets to the top."
The full origin-reset chain on escape (and how each is handled now)
Tracing every oy write during a commits-scrolled-down escape, three different
things were all moving the origin off the saved value:
onNewKey(tasks_adapter.go) resetsoyto 0 when the re-render's command key differs from the last one (it does, because the commit-files render clobbered the main view on entry). → handled byViewBufferManager.KeepOriginForNextTask()(uncommitted feature machinery), which suppresses that one reset.CopyContent(view.go, viamoveMainContextToTop) copies the previous top view's buffer and origin into the main view to avoid a blank frame. → handled by re-assertingSetOrigin(saved)after the pushes.- The layout scroll-up clamp → handled by bug fix #2 (the
loadingflag).
The one remaining flicker (and the correct fix — IMPLEMENTED in session 3, see §11)
Update (session 3): the fix described below was implemented, but the diagnosis here was incomplete in two ways that §11 corrects: (a) the
onNewKeysuppression could not be dropped, and (b) there was a second source of the top-flicker — the scroll-reset loop inrefreshMainViews. Read §11 as the current truth; the text below is session 2's understanding.
With all three handled, the scroll no longer jumps. But there's still a brief
intermediate frame, and we found exactly what it is: CopyContent seeds the
main view with the patch-building view's buffer, and since we set the origin
to the saved position (far down) while that placeholder is shorter, the draw
shows the placeholder's last line at the top with blank below — until the pty
task finishes loading the real diff and repaints at the saved position. (It
"appears scrolled up by a varying amount" purely because what shows at the saved
oy depends on the patch's length, via min(oy, patchLines-1).)
NOTE — a rejected red herring: "avoid clobbering the main view on entry"
does not fix this. CopyContent overwrites the main view's buffer
regardless of what was there, so preserving the original commit diff on entry
wouldn't change the placeholder frame.
The correct fix (user's conclusion, agreed): we're applying the saved origin
too early. It must be applied exactly when the pty task does its first
repaint (when it has read enough to fill the view at the saved scroll). The
catch: InitialRefreshAfter — which decides when that first repaint happens —
is computed from the view's OriginY at task-creation time. So the target
origin must be known at creation (so the task reads enough), but the view must
keep showing the placeholder until that first paint, and only snap to the saved
position as part of that paint. Concretely: a cmd/pty analogue of
RenderStringWithScrollTask — "render this command and scroll to Y once
you've read enough" — applying the origin at the InitialRefreshAfter refresh
rather than up front. This is the concrete next step; it's bounded but real
work, and likely lets us drop the keepOrigin + after-push SetOrigin
machinery (they'd be subsumed by the task setting the origin itself).
7. Prototype enhancements still missing (for an "enhance" session)
- Directory case follow-up: entering staging from a files/commit-files
directory selection expands the tree and changes the selection to the
clicked file. We restore the side panel's selected line on exit
(
SidePanelSelectedLineIdx) so the main view shows the directory's combined diff again — but we don't restore the tree's expanded/collapsed state, so the panel comes back more expanded than it was. Decide whether to restore that too. Also, the directory case shares the scroll/selection-restore bug above. onClickInOtherViewOfMainViewPair(clicking the other pane of a main view pair) now also selects + double-click-stages for consistency; double-check this is desired and that the secondary-pane paths behave.- Stale selection after stage/unstage: explicitly accepted as out of scope; no fix planned.
- No integration tests exist for any of the focused-main-view interactions
(click/double-click/
enter/e/G/escape-restore). They were skipped on purpose during prototyping.
8. Productionization notes (for a future planning session — do NOT plan yet)
Context a planning session will need:
- Commit history needs rework. Two
WIPcommits (673b90c10"esc goes all the way back out",30e625a8d"New click behavior") plus the large uncommitted escape/restore change. AGENTS.md (this repo) mandates: small, self-contained, compiling,gofumpt-clean commits; "why not what" messages; prep-refactors split from behavior changes;fixup!/amend!against the right commit andgit rebase --autosquash; no conventional-commit prefixes. The escape/restore work especially will want to be re-sequenced into clean commits (and theescapeContext→FocusedMainViewSnapshotevolution collapsed, since it was iterated heavily). - Demonstrate-bugs-before-fixing pattern (AGENTS.md) with
EXPECTED/ACTUAL— relevant if any of this lands as bug-fix-shaped commits. - Tests: integration tests live under
pkg/integration/tests/...; conventions in AGENTS.md (chaint.Views().<View>()fluently, no local view vars; usestretchr/testify). A unit-testable seam worth noting: the scroll/selection restore and the GitHub-anchor URL builder (githubPullRequestLineURL) are pure-ish and could be unit-tested; the patch index↔view line wrapping logic lives inpkg/gui/patch_exploring/state.go. - Config:
gui.showSelectionInFocusedMainViewwas added then removed (c4aba31c9) in favor of on-demand selection — don't reintroduce a config toggle for this without reason. - Commands: use the
justfilerecipes (just generateregenerates the test list + cheatsheets and CI fails if stale;just format,just build,just unit-test,just e2e-all,just lint). Preferjustovermake. Adding/renaming a keybinding ⇒ runjust generateand commit the result (note: gated descriptions — the focused-main bindings use empty descriptions when no selection is shown, so they don't appear in cheatsheets, matching the existingenterbinding). - The unrelated
M AGENTS.mdin the working tree is the "Common commands" section documentingjust— keep or commit separately.
9. Key files (quick map)
pkg/gui/controllers/main_view_controller.go— the focused main view controller: keybindings,toggleSelection,enter/enterForLine,editLine,openPullRequestForSelectedLine,branchForPullRequest, click handlers,showSelectionAtLine,focusedMainViewContextForViewName,focusedMainViewSnapshot,githubPullRequestLineURL.pkg/gui/controllers/switch_to_focused_main_view_controller.go— focuses the main view from a side panel (0/ click); click passes a line so it selects,0passes -1 so it doesn't.pkg/gui/controllers/switch_to_diff_files_controller.go— commits/stash → patch building entry (GetOnClickFocusedMainView,enter).pkg/gui/controllers/files_controller.go— files → staging entry (GetOnClickFocusedMainView,EnterFile).pkg/gui/controllers/commits_files_controller.go— commit-files → patch building entry.pkg/gui/controllers/helpers/commit_files_helper.go—EnterCommitFile.pkg/gui/controllers/helpers/patch_building_helper.go—Escape+EscapeFromPatchExplorer(the shared escape/restore logic).pkg/gui/controllers/staging_controller.go—Escape(callsEscapeFromPatchExplorer).pkg/gui/context/patch_explorer_context.go—FocusedMainViewSnapshotstorage.pkg/gui/types/context.go—FocusedMainViewSnapshot,IPatchExplorerContextadditions.pkg/gui/controllers/helpers/staging_helper.go—GetFileAndLineForClickedDiffLine(hyperlink parsing).pkg/tasks/tasks.go— the async render-task system (ViewBufferManager,ReadToEnd, the read loop). Session 3 addedScrollToOriginYForNextTask/GetScrollToOriginYForNextTask,LinesToRead.ApplyInitialScroll, the first-paint apply in the read loop, and theonNewKeysuppression (§11). Also hosts the committedLAZYGIT_SLOW_RENDERknob.pkg/gui/tasks_adapter.go+pkg/gui/pty.go— cmd/pty task wrappers; both now peek the manager's pending scroll and pass it tolinesToReadFromCmdTask(view, targetOriginY)(view_helpers.go).pkg/gui/main_panels.go—refreshMainViews(the scroll-reset loop, now aftermoveMainContextPairToTop, §11) andmoveMainContextToTop→CopyContent.pkg/gui/layout.go— the scroll-up-to-fill clamp (setViewFromDimensions); skipped while a view's taskIsLoading().pkg/gocui/view.go—SetOriginX/SetOriginYare now the single chokepoints for allox/oywrites (fe79d18b6); ideal breakpoint spot.
10. Debug tooling
Slow down rendering (LAZYGIT_SLOW_RENDER=<ms>) — now COMMITTED
This is no longer a paste-back snippet: it's committed at the base of the
branch (ed48988a9). Sleeps <ms> after each line written to a view, so the
frames of an async re-render become visible. No effect when unset. Run as
LAZYGIT_SLOW_RENDER=40 just debug (with just print-log in another tab).
This is the tool that makes the remaining timing races (§11) visible — they
are essentially invisible at normal speed.
Trace every change to a view's scroll position — now a single chokepoint
Session 3's SetOriginX/SetOriginY refactor (fe79d18b6) routed every
write to v.oy/v.ox through SetOriginY/SetOriginX. So you no longer need
to scatter the tracer across SetOrigin/CopyContent/FocusPoint/draw/
ScrollUp/ScrollDown — set one breakpoint (or one log line) inside
SetOriginY in pkg/gocui/view.go and you catch all of them, with the
bt/Call-Stack giving the caller. (This is exactly how session 3 found the
refreshMainViews reset-loop cause — see §11.) The old multi-site
debugMainOriginReset(v, newY) helper still works if you want a /tmp log with
a trimmed call stack; drop it into SetOriginY and filter by v.name:
func debugMainOriginReset(v *View, newY int) {
if v.name != "main" || newY == v.oy {
return
}
pc := make([]uintptr, 6)
n := runtime.Callers(3, pc)
frames := runtime.CallersFrames(pc[:n])
var b strings.Builder
for i := 0; i < 4; i++ {
fr, more := frames.Next()
fmt.Fprintf(&b, " <- %s:%d", fr.File[strings.LastIndex(fr.File, "/")+1:], fr.Line)
if !more {
break
}
}
if f, err := os.OpenFile("/tmp/fmvs_origin.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o644); err == nil {
fmt.Fprintf(f, "main oy %d->%d%s\n", v.oy, newY, b.String())
f.Close()
}
}
11. Session 3: the flicker fix (implemented) + remaining timing races
Session 3 turned §6's proposal into working, committed code, and corrected the diagnosis twice along the way. At normal speed the escape is now flicker-free.
What "applying the saved scroll at first paint" became (commit 054d139fe)
The cmd/pty analogue of RenderStringWithScrollTask, driven by one field on
ViewBufferManager:
ScrollToOriginYForNextTask(originY int)setsscrollToOriginYForNextTask *int. The escape calls it on the main view's manager before the re-render is triggered. It has two effects on the next cmd/pty task:- Suppresses the start-of-task origin reset (
onNewKey) — so theCopyContentplaceholder keeps showing at its scroll instead of being yanked to the top. (This is the part session 2 thought we could drop. We can't — see below.) - Sizes the initial read to
originY(linesToReadFromCmdTask(view, targetOriginY *int)uses it instead of the view's currentOriginY) and scrolls there at the first refresh via a newLinesToRead.ApplyInitialScrollcallback, applied once (guarded bysync.Once) — at theInitialRefreshAfterpoint, and in the EOF branch beforeonEndOfInput(so a now-shorter diff gets clamped back into range).
- Suppresses the start-of-task origin reset (
- The field is peeked (
GetScrollToOriginYForNextTask) by the cmd/pty wrappers (tasks_adapter.go,pty.go) to size the read, and cleared inNewTaskafter theonNewKeydecision — so it survives long enough to drive both effects, and applies to exactly one task. (Per-view managers, so the secondary view isn't affected.) - Behaviour-preserving until a caller sets it.
Escape wiring simplified (commit 625e7dbad)
EscapeFromPatchExplorer now just calls ScrollToOriginYForNextTask(snapshot.OriginY)
before the pushes, and restores the selection only (FocusPoint + highlight)
via ReadToEnd once the diff is fully loaded. The session-2 dance — up-front
SetOrigin, after-push SetOrigin, and KeepOriginForNextTask — is gone;
the task owns the scroll now.
Correction #1: onNewKey suppression could NOT be dropped
§6 predicted the new mechanism would let us drop the onNewKey suppression. It
didn't. CopyContent's entire purpose is that the newly-revealed view keeps
showing the previous view's content at its scroll ("as if nothing changed")
until the real content paints. Letting onNewKey reset that to the top is a
flicker. So the suppression is kept — folded into the same
scrollToOriginYForNextTask field (effect #1 above) rather than a separate
keepOrigin flag.
Correction #2: there was a SECOND cause of the top-flicker — refreshMainViews (commit 7f547a5a3)
Even with onNewKey suppressed, the placeholder still flicked to the top under
slow render. A SetOriginY breakpoint (trivial now, thanks to the chokepoint
refactor) caught it: refreshMainViews (main_panels.go) reset the scroll of
every other main view at the top of the function — i.e. it zeroed the
patch-building view's origin before moveMainContextPairToTop →
CopyContent copied that view (now at origin 0) into the Normal view. So the 0
came from the reset feeding CopyContent, independent of onNewKey.
Fix: move the reset loop to after moveMainContextPairToTop. End state is
unchanged (every other main still ends at 0, and the destination always
re-renders), but CopyContent now copies the source at its real scroll, so the
placeholder stays put. This also makes every cross-pair transition's
placeholder seamless, not just our escape.
Verification
just build/just lint/just unit-testall green. (TestNewCmdTaskInstantStopis a pre-existing timing flake that only trips under the full suite's parallel load; passes 10/10 in isolation, and the session-3 task changes are inert on its instant-stop path.)just e2e-all: green exceptworktree/associate_branch_rebase, which fails environmentally —cd-ing into the linked worktree triggers lazygit's direnv integration to pop a "Press to run 'direnv allow'" confirmation (this checkout's.envrcis blocked), stealing focus from the.Focus()assertion. Rundirenv allow(or confirm it fails the same onmaster).
Remaining timing races (DO THIS before productionizing)
At normal speed there's no visible flicker, but under LAZYGIT_SLOW_RENDER
occasional imperfect intermediate frames remain. The user's explicit call:
these point to real timing races in the async render/scroll path, and we
should eliminate them rather than rely on normal timing masking them. Not yet
characterised — next session should:
- Reproduce under
LAZYGIT_SLOW_RENDER(try a range of values; the races are intermittent) across the three transitions (files→staging, commit→patch-building, and the escape), all while scrolled down. - Use the single
SetOriginYchokepoint +btand/or the §10 tracer, plus theReadToEnd/InitialRefreshAfter/ApplyInitialScrollordering, to pin which interleavings produce a bad frame. Suspects worth scrutinising: the ordering between the task's firstApplyInitialScrollpaint and theReadToEnd-driven selection restore; theafterLayout-deferred pty task creation racing a layout pass; andCopyContentvs. the task's first write. - Memory:
focused-main-view-flicker-timing-races.
12. Restore by patch identity, escape routing, and the plan to solve the three entangled problems
A design discussion (it did not result in code; the implementation is for a new session). Three things came out of it: a better model for the escape restore, a set of escape-routing cases the current prototype gets wrong, and a decision about when to solve the hard async problems.
12.1 The restore should anchor on a patch identity, not a numeric scroll/index
The current escape (§6/§11) saves the main view's OriginY + selection index
and replays them. That's only right when the content is unchanged. But the whole
reason you'd escape after doing something in the staging/patch view is that you
changed the content — you staged a hunk, or d-dropped one — so a numeric index
now points at a different line. (§4 already conceded "the selection may be
slightly off; no fix planned.")
The right model: on escape, read the explorer view's current selection at that
moment as a patch identity (file, type, source-line, side) — after the
host's auto-advance has already moved it to a still-valid line — then find that
identity in the freshly re-rendered main view and scroll it into view. This is
the inverse of the diff-line-metadata primitive (identity → rendered row,
rather than row → identity), and it is the same operation as the -U
context-change scroll-preservation consumer (see diff-line-metadata-notes.md §1
item 5). It also lets the FocusedMainViewSnapshot store less (the OriginY +
main-view SelectedLineIdx become derivable), which is a simplification.
Note the difference from the -U case's "anchor on the nearest surviving change
line" fallback: that's for when context lines genuinely vanish. For staging-escape
the host's auto-advance normally hands us a valid line directly; the
nearest-surviving fallback is only for the degenerate cases below.
12.2 Escape routing — which half to return to, or whether to at all
The escape target is really (context, identity): which focused-main half
corresponds to where the explorer's selection ended up. The current prototype
gets several cases wrong:
- Stage a non-last hunk — selection auto-advances within unstaged → restore there. The common, already-conceptually-fine case.
- Stage the last unstaged hunk — unstaged becomes empty and the selection crosses to the staged panel → escape should land in the staged half (the secondary view), not unstaged. Currently lands in the files panel — bug.
<tab>between unstaged/staged inside the staging view — escape should return to the half matching the side you're on. Currently broken — bug.- Drop the last unstaged hunk with nothing staged — the staging view auto-closes; focus goes to the files panel. Correct as-is: the main view would only show "No changed files", so there's no point focusing it. (Probably not deliberate in the prototype, but it's the right outcome.)
- Drop a hunk in the custom patch builder (dropping it from the commit), or "Remove patch from original commit" from the custom-patch menu — the patch builder always closes (it can't mutate the commit from within it), not just on the last hunk. Re-focusing the main view is right, but here there is no host auto-advance, so we'd have to advance the selection ourselves. Since these are infrequent, acceptably focusing the side panel instead is a fine shortcut.
So the return target is: unstaged-selection → main; staged-selection → secondary; no valid selection / empty → files panel; custom-patch-builder → side panel (shortcut) or self-advance.
12.3 Decision: solve the three entangled problems in the prototype (next session)
The new restore mechanism, the §11 timing races, and the
BufferLineForViewLine staleness trap (diff-line-metadata-notes.md §8) are
entangled: the identity-based restore reads/parses the buffer while it is still
loading, which is exactly where both the races and the staleness bite. We
decided not to defer these to productionization. A production plan written
around three unsolved, entangled mechanisms isn't a plan; the prototype exists to
retire that unknown cheaply (build-order §7). Resolve them here, and
productionization becomes transcription.
Attack order (dependency-first, to keep it from ballooning):
- §8 staleness fix first. A bounded correctness fix with a known shape
(snapshot
viewLines+linesunder one lock, or tie the read to the task that produced the buffer). Needed regardless, and it's what makes reading/parsing-during-load safe — which everything else depends on. - Characterize the §11 races early, timeboxed, before designing around them. The one real sink risk is that they're not yet characterised: we don't know if each is a specific bad interleaving (bounded fix) or a fundamental tension in the async-lazy-render model (e.g. no flicker-free first paint without buffering a screenful first). That distinction changes the restore design and is itself a key production-plan input, so pin it cheaply up front. This is "understand the race to choose the right fix", not "decide whether to fix it" (we fix it).
- The new restore mechanism, which splits:
- sync half — the §12.2 routing (which context / side panel); largely independent of timing, can progress in parallel.
- async half — a predicate scroll: generalize
ScrollToOriginYForNextTask(y)(§11) to "scroll to the row matching this predicate, applied the first refresh at which it's satisfiable" (the read loop scans the lines read so far via the metadata primitive; the fixed-ycase is then just a trivial predicate). This is the "keep parsing as it loads" piece and is the part that sits on §8+§11.
12.4 Memory
focused-main-view-flicker-timing-races already covers the races. The escape
restore reworking and the three-problem plan above are recorded here.