fix(streaming_renderer): lifecycle improvements

Trying to clean up the lifecycle management of streaming_renderer and
other objects by leverage the state listeners more.

Also move the improved autoscrolling code from output_renderer. Note,
there is an issue with permission replacement that leaves the cursor up
a few lines which stops scrolling so I'm still looking at that

Looked up the session compacted event and realized we don't need to
reset there but it would be nice to render something for the user.

Author: cameronr

lua/opencode/core.lua

@@ -27,10 +27,9 @@ function M.select_session(parent_id)
     state.active_session = selected_session
     if state.windows then
       state.restore_points = {}
-      require('opencode.ui.streaming_renderer').reset()
-      ui.render_output(true)
+      -- Don't need to update either renderer because they subscribe to
+      -- session changes
       ui.focus_input()
-      ui.scroll_to_bottom()
     else
       M.open()
     end
@@ -178,8 +177,6 @@ function M.stop()
       state.api_client:abort_session(state.active_session.id):wait()
     end
     require('opencode.ui.footer').clear()
-    -- ui.stop_render_output()
-    -- require('opencode.ui.streaming_renderer').reset_and_render()
     input_window.set_content('')
     require('opencode.history').index = nil
     ui.focus_input()

lua/opencode/event_manager.lua

@@ -320,51 +320,6 @@ end
 function EventManager.setup()
   state.event_manager = EventManager.new()
   state.event_manager:start()
-
-  local streaming_renderer = require('opencode.ui.streaming_renderer')
-
-  state.event_manager:subscribe('message.updated', function(event_data)
-    -- state.last_output = os.time()
-    -- vim.notify(vim.inspect(event_data) .. ',')
-    streaming_renderer.handle_message_updated(event_data)
-  end)
-
-  state.event_manager:subscribe('message.part.updated', function(event_data)
-    -- state.last_output = os.time()
-    -- vim.notify(vim.inspect(event_data) .. ',')
-    streaming_renderer.handle_part_updated(event_data)
-  end)
-
-  state.event_manager:subscribe('message.removed', function(event_data)
-    -- state.last_output = os.time()
-    -- vim.notify(vim.inspect(event_data) .. ',')
-    streaming_renderer.handle_message_removed(event_data)
-  end)
-
-  state.event_manager:subscribe('message.part.removed', function(event_data)
-    -- state.last_output = os.time()
-    -- vim.notify(vim.inspect(event_data) .. ',')
-    streaming_renderer.handle_part_removed(event_data)
-  end)
-
-  state.event_manager:subscribe('session.compacted', function(event_data)
-    -- state.last_output = os.time()
-    -- vim.notify(vim.inspect(event_data) .. ',')
-    streaming_renderer.handle_session_compacted()
-  end)
-
-  state.event_manager:subscribe('session.error', function(event_data)
-    -- state.last_output = os.time()
-    streaming_renderer.handle_session_error(event_data)
-  end)
-
-  state.event_manager:subscribe('permission.updated', function(event_data)
-    streaming_renderer.handle_permission_updated(event_data)
-  end)
-
-  state.event_manager:subscribe('permission.replied', function(event_data)
-    streaming_renderer.handle_permission_replied(event_data)
-  end)
 end
 
 return EventManager

lua/opencode/types.lua

@@ -211,6 +211,7 @@
 ---@field snapshot string|nil Snapshot commit hash
 ---@field sessionID string|nil Session identifier
 ---@field messageID string|nil Message identifier
+---@field callID string|nil Call identifier (used for tools)
 ---@field hash string|nil Hash identifier for patch parts
 ---@field files string[]|nil List of file paths for patch parts
 ---@field synthetic boolean|nil Whether the message was generated synthetically

lua/opencode/ui/output_renderer.lua

@@ -7,10 +7,6 @@ local output_window = require('opencode.ui.output_window')
 local util = require('opencode.util')
 local Promise = require('opencode.promise')
 
-M._cache = {
-  prev_line_count = 0,
-}
-
 M._subscriptions = {}
 M._ns_id = vim.api.nvim_create_namespace('opencode_output')
 M._debounce_ms = 50
@@ -42,15 +38,13 @@ M.render = vim.schedule_wrap(function(windows, force)
       return
     end
 
-    local changed = M.write_output(windows, lines)
+    M.write_output(windows, lines)
 
-    if changed or force then
-      vim.schedule(function()
-        -- M.render_markdown()
-        M.handle_auto_scroll(windows)
-        require('opencode.ui.topbar').render()
-      end)
-    end
+    vim.schedule(function()
+      -- M.render_markdown()
+      M.handle_auto_scroll(windows)
+      require('opencode.ui.topbar').render()
+    end)
 
     pcall(function()
       vim.schedule(function()
@@ -93,39 +87,18 @@ function M.teardown()
 end
 
 function M.stop()
+  -- FIXME: the footer should probably own this... and it may
+  -- not even be necessary
   loading_animation.stop()
-  M._cache.prev_line_count = 0
 end
 
 function M.write_output(windows, output_lines)
   if not output_window.mounted(windows) then
     return false
   end
 
-  local current_line_count = #output_lines
-  local prev_line_count = M._cache.prev_line_count
-  local changed = false
-
-  if prev_line_count == 0 then
-    output_window.set_content(output_lines)
-    changed = true
-  elseif current_line_count > prev_line_count then
-    local new_lines = vim.list_slice(output_lines, prev_line_count + 1)
-    if #new_lines > 0 then
-      output_window.append_content(new_lines, prev_line_count)
-      changed = true
-    end
-  else
-    output_window.set_content(output_lines)
-    changed = true
-  end
-
-  if changed then
-    M._cache.prev_line_count = current_line_count
-    M.apply_output_extmarks(windows)
-  end
-
-  return changed
+  output_window.set_content(output_lines)
+  M.apply_output_extmarks(windows)
 end
 
 function M.apply_output_extmarks(windows)
@@ -153,28 +126,10 @@ function M.apply_output_extmarks(windows)
 end
 
 function M.handle_auto_scroll(windows)
-  local ok, line_count = pcall(vim.api.nvim_buf_line_count, windows.output_buf)
-  if not ok then
-    return
-  end
-
-  local botline = vim.fn.line('w$', windows.output_win)
-  local cursor = vim.api.nvim_win_get_cursor(windows.output_win)
-  local cursor_row = cursor[1] or 0
-  local is_focused = vim.api.nvim_get_current_win() == windows.output_win
-
-  local prev_line_count = M._cache.prev_line_count or 0
-  M._cache.prev_line_count = line_count
-
-  local was_at_bottom = (botline >= prev_line_count) or prev_line_count == 0
-
-  if is_focused and cursor_row < prev_line_count - 1 then
-    return
-  end
-
-  if was_at_bottom or not is_focused then
-    require('opencode.ui.ui').scroll_to_bottom()
-  end
+  -- NOTE: logic moved to stream renderer
+  -- output_render currently only used for loading whole sessions
+  -- so just scroll to the bottom when that happens
+  require('opencode.ui.ui').scroll_to_bottom()
 end
 
 return M

lua/opencode/ui/streaming_renderer.lua

@@ -2,18 +2,69 @@ local state = require('opencode.state')
 
 local M = {}
 
+M._subscriptions = {}
 M._part_cache = {}
 M._message_cache = {}
-M._session_id = nil
 M._namespace = vim.api.nvim_create_namespace('opencode_stream')
+M._prev_line_count = 0
 
 function M.reset()
   M._part_cache = {}
   M._message_cache = {}
-  M._session_id = nil
+  M._prev_line_count = 0
+
+  -- FIXME: this prolly isn't the right place for state.messages to be
+  -- cleared. It would probably be better to have streaming_renderer
+  -- subscribe to state changes and if state.messages is cleared, it
+  -- should clear it's state too
   state.messages = {}
 end
 
+---Set up all subscriptions
+function M.setup_subscriptions(_)
+  M._subscriptions.active_session = function(_, _, old)
+    if not old then
+      return
+    end
+    M.reset()
+  end
+  state.subscribe('active_session', M._subscriptions.active_session)
+  M._setup_event_subscriptions()
+end
+
+---Set up server event subscriptions
+---@param subscribe? boolean false to unsubscribe
+function M._setup_event_subscriptions(subscribe)
+  if not state.event_manager then
+    return
+  end
+
+  local method = (subscribe == false) and 'unsubscribe' or 'subscribe'
+
+  state.event_manager[method](state.event_manager, 'message.updated', M.on_message_updated)
+  state.event_manager[method](state.event_manager, 'message.part.updated', M.on_part_updated)
+  state.event_manager[method](state.event_manager, 'message.removed', M.on_message_removed)
+  state.event_manager[method](state.event_manager, 'message.part.removed', M.on_part_removed)
+  state.event_manager[method](state.event_manager, 'session.compacted', M.on_session_compacted)
+  state.event_manager[method](state.event_manager, 'session.error', M.on_session_error)
+  state.event_manager[method](state.event_manager, 'permission.updated', M.on_permission_updated)
+  state.event_manager[method](state.event_manager, 'permission.replied', M.on_permission_replied)
+end
+
+---Unsubscribe from local state and server subscriptions
+function M._cleanup_subscriptions()
+  M._setup_event_subscriptions(false)
+  for key, cb in pairs(M._subscriptions) do
+    state.unsubscribe(key, cb)
+  end
+  M._subscriptions = {}
+end
+
+function M.teardown()
+  M._cleanup_subscriptions()
+  M.reset()
+end
+
 function M._get_buffer_line_count()
   if not state.windows or not state.windows.output_buf then
     return 0
@@ -87,11 +138,29 @@ function M._text_to_lines(text)
 end
 
 function M._scroll_to_bottom()
-  local debounced_scroll = require('opencode.util').debounce(function()
-    require('opencode.ui.ui').scroll_to_bottom()
-  end, 50)
+  local ok, line_count = pcall(vim.api.nvim_buf_line_count, state.windows.output_buf)
+  if not ok then
+    return
+  end
 
-  debounced_scroll()
+  local botline = vim.fn.line('w$', state.windows.output_win)
+  local cursor = vim.api.nvim_win_get_cursor(state.windows.output_win)
+  local cursor_row = cursor[1] or 0
+  local is_focused = vim.api.nvim_get_current_win() == state.windows.output_win
+
+  local prev_line_count = M._prev_line_count or 0
+  M._prev_line_count = line_count
+
+  local was_at_bottom = (botline >= prev_line_count) or prev_line_count == 0
+
+  if is_focused and cursor_row < prev_line_count - 1 then
+    return
+  end
+
+  if was_at_bottom or not is_focused then
+    -- vim.notify('was_at_bottom: ' .. tostring(was_at_bottom) .. ' is_focused: ' .. tostring(is_focused))
+    require('opencode.ui.ui').scroll_to_bottom()
+  end
 end
 
 function M._write_formatted_data(formatted_data)
@@ -206,7 +275,7 @@ function M._remove_part_from_buffer(part_id)
   M._part_cache[part_id] = nil
 end
 
-function M.handle_message_updated(event)
+function M.on_message_updated(event)
   if not event or not event.properties or not event.properties.info then
     return
   end
@@ -216,13 +285,10 @@ function M.handle_message_updated(event)
     return
   end
 
-  if M._session_id and M._session_id ~= message.sessionID then
-    -- TODO: there's probably more we need to do here
-    M.reset()
+  if state.active_session.id ~= message.sessionID then
+    vim.notify('Session id does not match, discarding part: ' .. vim.inspect(message), vim.log.levels.WARN)
   end
 
-  M._session_id = message.sessionID
-
   local found_idx = nil
   for i = #state.messages, math.max(1, #state.messages - 2), -1 do
     if state.messages[i].info.id == message.id then
@@ -252,7 +318,7 @@ function M.handle_message_updated(event)
   M._scroll_to_bottom()
 end
 
-function M.handle_part_updated(event)
+function M.on_part_updated(event)
   if not event or not event.properties or not event.properties.part then
     return
   end
@@ -262,7 +328,7 @@ function M.handle_part_updated(event)
     return
   end
 
-  if M._session_id and M._session_id ~= part.sessionID then
+  if state.active_session.id ~= part.sessionID then
     vim.notify('Session id does not match, discarding part: ' .. vim.inspect(part), vim.log.levels.WARN)
     return
   end
@@ -342,7 +408,7 @@ function M.handle_part_updated(event)
   M._scroll_to_bottom()
 end
 
-function M.handle_part_removed(event)
+function M.on_part_removed(event)
   -- XXX: I don't have any sessions that remove parts so this code is
   -- currently untested
   if not event or not event.properties then
@@ -376,7 +442,7 @@ function M.handle_part_removed(event)
   M._remove_part_from_buffer(part_id)
 end
 
-function M.handle_message_removed(event)
+function M.on_message_removed(event)
   -- XXX: I don't have any sessions that remove messages so this code is
   -- currently untested
   if not event or not event.properties then
@@ -416,10 +482,9 @@ function M.handle_message_removed(event)
   end
 end
 
-function M.handle_session_compacted()
-  M.reset()
-  vim.notify('handle_session_compacted')
-  require('opencode.ui.output_renderer').render(state.windows, true)
+function M.on_session_compacted()
+  vim.notify('on_session_compacted')
+  -- TODO: render a note that the session was compacted
 end
 
 function M.reset_and_render()
@@ -428,7 +493,7 @@ function M.reset_and_render()
   require('opencode.ui.output_renderer').render(state.windows, true)
 end
 
-function M.handle_session_error(event)
+function M.on_session_error(event)
   if not event or not event.properties or not event.properties.error then
     return
   end
@@ -443,7 +508,7 @@ function M.handle_session_error(event)
   M._scroll_to_bottom()
 end
 
-function M.handle_permission_updated(event)
+function M.on_permission_updated(event)
   if not event or not event.properties then
     return
   end
@@ -461,7 +526,7 @@ function M.handle_permission_updated(event)
   end
 end
 
-function M.handle_permission_replied(event)
+function M.on_permission_replied(event)
   if not event or not event.properties then
     return
   end