Files
neovim/test/functional/terminal/synchronized_output_spec.lua
mgleonard425 b38173e493 feat(terminal): synchronized output (mode 2026) #38284
Problem:
Applications running inside :terminal that use DEC private mode 2026
(synchronized output) to batch screen updates get garbled rendering.
Neovim's embedded libvterm does not handle mode 2026, so the
synchronization sequences are ignored and intermediate screen states
leak through as visual corruption.

Solution:
Add mode 2026 support to libvterm's state machine and wire it through
to terminal.c. When an application enables mode 2026, invalidation of
the terminal buffer is deferred until the application disables it,
causing all accumulated screen updates to flush as a single
atomic refresh.

* fix(terminal): harden sync output redraw gating

Problem:
The initial mode 2026 implementation gated invalidate_terminal()
but missed three other redraw paths: term_sb_push/term_sb_pop
bypassed the gate by directly adding to invalidated_terminals,
refresh_timer_cb could fire mid-sync flushing partial state, and
the 10ms timer delay after sync-end left a window for stale
repaints.

Solution:
- Gate term_sb_push/term_sb_pop during synchronized output
- Skip syncing terminals in refresh_timer_cb
- On sync end, schedule a zero-delay full-screen refresh via
  sync_flush_pending flag in terminal_receive()
- Add news.txt entry for mode 2026 support

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* test(terminal): add vterm unit tests for mode 2026

Add unit-level tests for synchronized output (mode 2026) to
vterm_spec.lua, covering settermprop callbacks and DECRQM
query/response.

Suggested-by: justinmk

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(terminal): address review feedback for mode 2026

- Use multiqueue_put(main_loop.events) instead of restarting the
  global refresh timer on sync end, to avoid affecting other
  invalidated terminals.
- Add screen:expect_unchanged() to verify screen doesn't update
  during sync mode.
- Merge buffer-lines test into existing test.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-17 17:40:49 -04:00

160 lines
5.7 KiB
Lua

local t = require('test.testutil')
local n = require('test.functional.testnvim')()
local Screen = require('test.functional.ui.screen')
local clear = n.clear
local api = n.api
local eq = t.eq
local poke_eventloop = n.poke_eventloop
local assert_alive = n.assert_alive
local CSI = '\027['
describe(':terminal synchronized output (mode 2026)', function()
local screen, chan, buf
before_each(function()
clear()
screen = Screen.new(50, 7)
buf = api.nvim_create_buf(true, true)
chan = api.nvim_open_term(buf, {})
api.nvim_win_set_buf(0, buf)
end)
it('renders content sent inside a synchronized update', function()
api.nvim_chan_send(chan, CSI .. '?2026h')
api.nvim_chan_send(chan, 'synced line 1\r\n')
api.nvim_chan_send(chan, 'synced line 2\r\n')
api.nvim_chan_send(chan, CSI .. '?2026l')
screen:expect([[
^synced line 1 |
synced line 2 |
|*4
|
]])
end)
it('renders all lines from a synchronized update', function()
api.nvim_chan_send(chan, CSI .. '?2026h')
for i = 1, 5 do
api.nvim_chan_send(chan, 'line ' .. i .. '\r\n')
end
api.nvim_chan_send(chan, CSI .. '?2026l')
screen:expect([[
^line 1 |
line 2 |
line 3 |
line 4 |
line 5 |
|
|
]])
-- Buffer lines should also match.
local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
eq('line 1', lines[1])
eq('line 2', lines[2])
eq('line 5', lines[5])
end)
it('handles multiple synchronized update cycles', function()
-- First cycle.
api.nvim_chan_send(chan, CSI .. '?2026h')
api.nvim_chan_send(chan, 'cycle 1\r\n')
api.nvim_chan_send(chan, CSI .. '?2026l')
screen:expect([[
^cycle 1 |
|*5
|
]])
-- Second cycle.
api.nvim_chan_send(chan, CSI .. '?2026h')
api.nvim_chan_send(chan, 'cycle 2\r\n')
api.nvim_chan_send(chan, CSI .. '?2026l')
screen:expect([[
^cycle 1 |
cycle 2 |
|*4
|
]])
end)
it('works with content before and after sync', function()
-- Unsynchronized content.
api.nvim_chan_send(chan, 'before\r\n')
poke_eventloop()
screen:expect([[
^before |
|*5
|
]])
-- Synchronized content.
api.nvim_chan_send(chan, CSI .. '?2026h')
api.nvim_chan_send(chan, 'during\r\n')
api.nvim_chan_send(chan, CSI .. '?2026l')
screen:expect([[
^before |
during |
|*4
|
]])
-- More unsynchronized content.
api.nvim_chan_send(chan, 'after\r\n')
screen:expect([[
^before |
during |
after |
|*3
|
]])
end)
it('does not crash when mode 2026 is set and queried', function()
api.nvim_chan_send(chan, CSI .. '?2026h')
assert_alive()
api.nvim_chan_send(chan, CSI .. '?2026l')
assert_alive()
end)
it('defers screen update during sync mode', function()
-- Establish a known screen state first.
api.nvim_chan_send(chan, 'visible\r\n')
screen:expect([[
^visible |
|*5
|
]])
-- Begin sync and send more content — screen should not change.
api.nvim_chan_send(chan, CSI .. '?2026h')
api.nvim_chan_send(chan, 'deferred\r\n')
screen:expect_unchanged()
-- End sync — now the deferred content should appear.
api.nvim_chan_send(chan, CSI .. '?2026l')
screen:expect([[
^visible |
deferred |
|*4
|
]])
end)
it('handles rapid sync on/off toggling', function()
for i = 1, 5 do
api.nvim_chan_send(chan, CSI .. '?2026h')
api.nvim_chan_send(chan, 'rapid ' .. i .. '\r\n')
api.nvim_chan_send(chan, CSI .. '?2026l')
end
screen:expect([[
^rapid 1 |
rapid 2 |
rapid 3 |
rapid 4 |
rapid 5 |
|
|
]])
end)
end)