fix(questions/permissions): prevent scroll jump when navigating

Author: sudo-tee

lua/opencode/ui/renderer/events.lua

@@ -76,6 +76,8 @@ function M.render_permissions_display()
     return
   end
 
+  local should_scroll = ctx.render_state:get_part('permission-display-part') == nil
+
   local fake_message = {
     info = {
       id = 'permission-display-message',
@@ -93,6 +95,10 @@ function M.render_permissions_display()
     type = 'permissions-display',
   }
   M.on_part_updated({ part = fake_part })
+
+  if should_scroll then
+    scroll(true)
+  end
 end
 
 ---Render the current question as a synthetic part at the end of the buffer
@@ -111,6 +117,8 @@ function M.render_question_display()
     return
   end
 
+  local should_scroll = ctx.render_state:get_part('question-display-part') == nil
+
   local fake_message = {
     info = {
       id = 'question-display-message',
@@ -128,7 +136,9 @@ function M.render_question_display()
     type = 'questions-display',
   }
   M.on_part_updated({ part = fake_part })
-  scroll(true)
+  if should_scroll then
+    scroll(true)
+  end
 end
 
 ---Remove the question display from the buffer
@@ -460,7 +470,6 @@ function M.on_permission_updated(permission)
 
   permission_window.add_permission(permission)
   M.render_permissions_display()
-  scroll(true)
 end
 
 ---Handle permission.replied — remove the resolved permission and update display

lua/opencode/ui/renderer/flush.lua

@@ -10,6 +10,16 @@ local append = require('opencode.ui.renderer.append')
 local M = {}
 local warned_part_render_error = false
 
+local pinned_overlay_part_ids = {
+  ['permission-display-part'] = true,
+  ['question-display-part'] = true,
+}
+
+local pinned_overlay_message_ids = {
+  ['permission-display-message'] = true,
+  ['question-display-message'] = true,
+}
+
 ---@param part_id string
 ---@param message_id string|nil
 ---@param err any
@@ -401,7 +411,39 @@ local function apply_pending(pending)
     return false
   end
 
-  local scroll_snapshot = scroll.pre_flush(buf)
+  local only_pinned_overlay_updates = true
+  for _, part_id in ipairs(pending.removed_part_order) do
+    if pending.removed_parts[part_id] and not pinned_overlay_part_ids[part_id] then
+      only_pinned_overlay_updates = false
+      break
+    end
+  end
+  if only_pinned_overlay_updates then
+    for _, message_id in ipairs(pending.removed_message_order) do
+      if pending.removed_messages[message_id] and not pinned_overlay_message_ids[message_id] then
+        only_pinned_overlay_updates = false
+        break
+      end
+    end
+  end
+  if only_pinned_overlay_updates then
+    for _, message_id in ipairs(pending.dirty_message_order) do
+      if pending.dirty_messages[message_id] and not pinned_overlay_message_ids[message_id] then
+        only_pinned_overlay_updates = false
+        break
+      end
+    end
+  end
+  if only_pinned_overlay_updates then
+    for _, part_id in ipairs(pending.dirty_part_order) do
+      if pending.dirty_parts[part_id] and not pinned_overlay_part_ids[part_id] then
+        only_pinned_overlay_updates = false
+        break
+      end
+    end
+  end
+
+  local scroll_snapshot = only_pinned_overlay_updates and nil or scroll.pre_flush(buf)
   with_suppressed_output_autocmds(function()
     for _, part_id in ipairs(pending.removed_part_order) do
       if pending.removed_parts[part_id] then

tests/unit/permission_integration_spec.lua

@@ -505,4 +505,38 @@ describe('permission prompt rendering', function()
     assert.are.equal('perm_no_meta', state.pending_permissions[1].id)
     assert.are.equal(1, permission_window.get_permission_count())
   end)
+
+  it('does not auto-scroll on permission navigation redraws', function()
+    helpers.replay_setup()
+    state.session.set_active({ id = 'session_123' })
+    vim.api.nvim_set_current_win(state.windows.output_win)
+
+    local output_window_local = require('opencode.ui.output_window')
+
+    local lines = {}
+    for i = 1, 40 do
+      lines[i] = 'line ' .. i
+    end
+    output_window_local.set_lines(lines)
+    vim.api.nvim_win_set_cursor(state.windows.output_win, { 5, 0 })
+    output_window_local.sync_cursor_with_viewport(state.windows.output_win)
+
+    events.on_permission_updated({
+      id = 'perm_nav',
+      permission = 'bash',
+      title = 'Run command',
+      metadata = {},
+    })
+
+    flush.flush()
+    output_window_local.sync_cursor_with_viewport(state.windows.output_win)
+
+    local before = vim.api.nvim_win_get_cursor(state.windows.output_win)
+    permission_window._dialog:navigate(1)
+    flush.flush()
+
+    local after = vim.api.nvim_win_get_cursor(state.windows.output_win)
+    assert.equals(before[1], after[1])
+    assert.equals(before[2], after[2])
+  end)
 end)

tests/unit/question_window_spec.lua

@@ -3,6 +3,7 @@ local Output = require('opencode.ui.output')
 local Promise = require('opencode.promise')
 local state = require('opencode.state')
 local stub = require('luassert.stub')
+local helpers = require('tests.helpers')
 
 describe('question_window', function()
   after_each(function()
@@ -151,4 +152,52 @@ describe('question_window', function()
 
     show_stub:revert()
   end)
+
+  it('does not force-scroll on question navigation redraws', function()
+    helpers.replay_setup()
+    state.session.set_active({ id = 'sess1' })
+    vim.api.nvim_set_current_win(state.windows.output_win)
+
+    local renderer = require('opencode.ui.renderer')
+    local output_window = require('opencode.ui.output_window')
+
+    local lines = {}
+    for i = 1, 40 do
+      lines[i] = 'line ' .. i
+    end
+    output_window.set_lines(lines)
+    vim.api.nvim_win_set_cursor(state.windows.output_win, { 5, 0 })
+    output_window.sync_cursor_with_viewport(state.windows.output_win)
+
+    question_window.show_question({
+      id = 'q-nav',
+      sessionID = 'sess1',
+      questions = {
+        {
+          question = 'Pick one',
+          options = {
+            { label = 'One' },
+            { label = 'Two' },
+          },
+        },
+      },
+    })
+
+    local flush = require('opencode.ui.renderer.flush')
+    flush.flush()
+    output_window.sync_cursor_with_viewport(state.windows.output_win)
+
+    local before = vim.api.nvim_win_get_cursor(state.windows.output_win)
+    question_window._dialog:navigate(1)
+    flush.flush()
+
+    local after = vim.api.nvim_win_get_cursor(state.windows.output_win)
+    assert.equals(before[1], after[1])
+    assert.equals(before[2], after[2])
+
+    question_window.clear_question()
+    if state.windows then
+      require('opencode.ui.ui').close_windows(state.windows)
+    end
+  end)
 end)