Skip to content

feat: render session.status message in loading footer #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sudo-tee merged 2 commits into from
Mar 9, 2026
Merged

feat: render session.status message in loading footer #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4994d4a
feat: render `session.status` message in loading footer
disrupted Mar 9, 2026
dff8238
test: create unit and synthetic replay test
disrupted Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions lua/opencode/event_manager.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,18 @@ local log = require('opencode.log')
--- @field type "session.error"
--- @field properties {sessionID: string, error: table}

--- @class EventSessionStatus
--- @field type "session.status"
--- @field properties {
--- sessionID: string,
--- status: {
--- type: string,
--- message?: string,
--- attempt?: number,
--- next?: number
--- }
--- }

--- @class OpencodePermission
--- @field id string
--- @field type string
Expand Down Expand Up @@ -146,6 +158,7 @@ local log = require('opencode.log')
--- | "session.updated"
--- | "session.deleted"
--- | "session.error"
--- | "session.status"
--- | "permission.updated"
--- | "permission.asked"
--- | "permission.replied"
Expand Down Expand Up @@ -208,6 +221,7 @@ end
--- @overload fun(self: EventManager, event_name: "session.updated", callback: fun(data: EventSessionUpdated['properties']): nil)
--- @overload fun(self: EventManager, event_name: "session.deleted", callback: fun(data: EventSessionDeleted['properties']): nil)
--- @overload fun(self: EventManager, event_name: "session.error", callback: fun(data: EventSessionError['properties']): nil)
--- @overload fun(self: EventManager, event_name: "session.status", callback: fun(data: EventSessionStatus['properties']): nil)
--- @overload fun(self: EventManager, event_name: "permission.updated", callback: fun(data: EventPermissionUpdated['properties']): nil)
--- @overload fun(self: EventManager, event_name: "permission.replied", callback: fun(data: EventPermissionReplied['properties']): nil)
--- @overload fun(self: EventManager, event_name: "file.edited", callback: fun(data: EventFileEdited['properties']): nil)
Expand Down Expand Up @@ -249,6 +263,7 @@ end
--- @overload fun(self: EventManager, event_name: "session.updated", callback: fun(data: EventSessionUpdated['properties']): nil)
--- @overload fun(self: EventManager, event_name: "session.deleted", callback: fun(data: EventSessionDeleted['properties']): nil)
--- @overload fun(self: EventManager, event_name: "session.error", callback: fun(data: EventSessionError['properties']): nil)
--- @overload fun(self: EventManager, event_name: "session.status", callback: fun(data: EventSessionStatus['properties']): nil)
--- @overload fun(self: EventManager, event_name: "permission.updated", callback: fun(data: EventPermissionUpdated['properties']): nil)
--- @overload fun(self: EventManager, event_name: "permission.replied", callback: fun(data: EventPermissionReplied['properties']): nil)
--- @overload fun(self: EventManager, event_name: "file.edited", callback: fun(data: EventFileEdited['properties']): nil)
Expand Down
112 changes: 111 additions & 1 deletion lua/opencode/ui/loading_animation.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,115 @@ local M = {}
M._animation = {
frames = nil,
text = 'Thinking... ',
status_data = nil,
current_frame = 1,
timer = nil,
fps = 10,
extmark_id = nil,
ns_id = vim.api.nvim_create_namespace('opencode_loading_animation'),
status_event_manager = nil,
}

---@param status table|nil
---@return string|nil
function M._format_status_text(status)
if type(status) ~= 'table' then
return nil
end

local status_type = status.type

if status_type == 'busy' then
return M._animation.text
end

if status_type == 'idle' then
return nil
end

if status_type == 'retry' then
local message = status.message or 'Retrying request'
local details = {}

if type(status.attempt) == 'number' then
table.insert(details, 'retry ' .. status.attempt)
end

if type(status.next) == 'number' then
local now_ms = os.time() * 1000
local seconds = math.max(0, math.ceil((status.next - now_ms) / 1000))
table.insert(details, 'in ' .. seconds .. 's')
end

if #details > 0 then
return string.format('%s (%s)... ', message, table.concat(details, ', '))
end

return message .. '... '
end

if type(status.message) == 'string' and status.message ~= '' then
return status.message .. '... '
end

return M._animation.text
end

local function unsubscribe_session_status_event(manager)
if manager and M._animation.status_event_manager == manager then
manager:unsubscribe('session.status', M.on_session_status)
M._animation.status_event_manager = nil
end
end

local function subscribe_session_status_event(manager)
if not manager then
return
end

if M._animation.status_event_manager and M._animation.status_event_manager ~= manager then
unsubscribe_session_status_event(M._animation.status_event_manager)
end

if M._animation.status_event_manager == manager then
return
end

manager:subscribe('session.status', M.on_session_status)
M._animation.status_event_manager = manager
end

function M.on_session_status(properties)
if not properties or type(properties) ~= 'table' then
return
end

local active_session = state.active_session
if active_session and active_session.id and properties.sessionID ~= active_session.id then
return
end

M._animation.status_data = properties.status
M.render(state.windows)
end

local function on_active_session_change(_, new_session, old_session)
local new_id = new_session and new_session.id
local old_id = old_session and old_session.id
if new_id ~= old_id then
M._animation.status_data = nil
end
end

local function on_event_manager_change(_, new_manager, old_manager)
unsubscribe_session_status_event(old_manager)
subscribe_session_status_event(new_manager)
end

function M._get_display_text()
return M._format_status_text(M._animation.status_data) or M._animation.text
end

function M._get_frames()
if M._animation.frames then
return M._animation.frames
Expand Down Expand Up @@ -41,7 +143,7 @@ M.render = vim.schedule_wrap(function(windows)
return false
end

local loading_text = M._animation.text .. M._get_frames()[M._animation.current_frame]
local loading_text = M._get_display_text() .. M._get_frames()[M._animation.current_frame]

M._animation.extmark_id = vim.api.nvim_buf_set_extmark(windows.footer_buf, M._animation.ns_id, 0, 0, {
id = M._animation.extmark_id or nil,
Expand Down Expand Up @@ -97,6 +199,7 @@ end
function M.stop()
M._clear_animation_timer()
M._animation.current_frame = 1
M._animation.status_data = nil
if state.windows and state.windows.footer_buf and vim.api.nvim_buf_is_valid(state.windows.footer_buf) then
pcall(vim.api.nvim_buf_clear_namespace, state.windows.footer_buf, M._animation.ns_id, 0, -1)
end
Expand All @@ -120,10 +223,17 @@ end

function M.setup()
state.subscribe('job_count', on_running_change)
state.subscribe('active_session', on_active_session_change)
state.subscribe('event_manager', on_event_manager_change)
subscribe_session_status_event(state.event_manager)
end

function M.teardown()
state.unsubscribe('job_count', on_running_change)
state.unsubscribe('active_session', on_active_session_change)
state.unsubscribe('event_manager', on_event_manager_change)
unsubscribe_session_status_event(M._animation.status_event_manager)
M._animation.status_data = nil
end

return M
168 changes: 168 additions & 0 deletions tests/data/provider-overloaded-status.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
{
"actions": [],
"extmarks": [
[
1,
1,
0,
{
"ns_id": 3,
"priority": 10,
"right_gravity": true,
"virt_text": [
[
"▌󰭻 ",
"OpencodeMessageRoleUser"
],
[
" "
],
[
"USER",
"OpencodeMessageRoleUser"
],
[
"",
"OpencodeHint"
],
[
" [msg_0000000000001]",
"OpencodeHint"
]
],
"virt_text_hide": false,
"virt_text_pos": "win_col",
"virt_text_repeat_linebreak": false,
"virt_text_win_col": -3
}
],
[
2,
1,
0,
{
"ns_id": 3,
"priority": 9,
"right_gravity": true,
"virt_text": [
[
" 2023-11-14 22:13:20",
"OpencodeHint"
]
],
"virt_text_hide": false,
"virt_text_pos": "right_align",
"virt_text_repeat_linebreak": false
}
],
[
3,
2,
0,
{
"ns_id": 3,
"priority": 4096,
"right_gravity": true,
"virt_text": [
[
"▌",
"OpencodeMessageRoleUser"
]
],
"virt_text_hide": false,
"virt_text_pos": "win_col",
"virt_text_repeat_linebreak": true,
"virt_text_win_col": -3
}
],
[
4,
3,
0,
{
"ns_id": 3,
"priority": 4096,
"right_gravity": true,
"virt_text": [
[
"▌",
"OpencodeMessageRoleUser"
]
],
"virt_text_hide": false,
"virt_text_pos": "win_col",
"virt_text_repeat_linebreak": true,
"virt_text_win_col": -3
}
],
[
5,
6,
0,
{
"ns_id": 3,
"priority": 10,
"right_gravity": true,
"virt_text": [
[
" ",
"OpencodeMessageRoleAssistant"
],
[
" "
],
[
"BUILD",
"OpencodeMessageRoleAssistant"
],
[
" claude-sonnet-4-5",
"OpencodeHint"
],
[
" [msg_0000000000002]",
"OpencodeHint"
]
],
"virt_text_hide": false,
"virt_text_pos": "win_col",
"virt_text_repeat_linebreak": false,
"virt_text_win_col": -3
}
],
[
6,
6,
0,
{
"ns_id": 3,
"priority": 9,
"right_gravity": true,
"virt_text": [
[
" 2023-11-14 22:13:21",
"OpencodeHint"
]
],
"virt_text_hide": false,
"virt_text_pos": "right_align",
"virt_text_repeat_linebreak": false
}
]
],
"lines": [
"----",
"",
"",
"Can you help me fix this bug?",
"",
"----",
"",
"",
"Sure, I can help with that.",
"",
""
],
"timestamp": 1773091221
}

Loading