neovim/test/functional/plugin/lsp/incremental_sync_spec.lua

-- Test suite for testing interactions with the incremental sync algorithms powering the LSP client
local helpers = require('test.functional.helpers')(after_each)

local meths = helpers.meths
local clear = helpers.clear
local eq = helpers.eq
local exec_lua = helpers.exec_lua
local feed = helpers.feed

before_each(function ()
  clear()
  exec_lua [[
    local evname = ...
    local sync = require('vim.lsp.sync')
    local events = {}
    local buffer_cache = {}

    -- local format_line_ending = {
    --   ["unix"] = '\n',
    --   ["dos"] = '\r\n',
    --   ["mac"] = '\r',
    -- }

    -- local line_ending = format_line_ending[vim.api.nvim_buf_get_option(0, 'fileformat')]


    function test_register(bufnr, id, offset_encoding, line_ending)
      local curr_lines
      local prev_lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, true)

      local function callback(_, bufnr, changedtick, firstline, lastline, new_lastline)
        if test_unreg == id then
          return true
        end

        local curr_lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, true)
        local incremental_change = sync.compute_diff(
          prev_lines, curr_lines, firstline, lastline, new_lastline, offset_encoding, line_ending)

        table.insert(events, incremental_change)
        prev_lines = curr_lines
      end
      local opts = {on_lines=callback, on_detach=callback, on_reload=callback}
      vim.api.nvim_buf_attach(bufnr, false, opts)
    end

    function get_events()
      local ret_events = events
      events = {}
      return ret_events
    end
  ]]
end)

local function test_edit(prev_buffer, edit_operations, expected_text_changes, offset_encoding, line_ending)
  offset_encoding = offset_encoding or 'utf-16'
  line_ending = line_ending or '\n'

  meths.buf_set_lines(0, 0, -1, true, prev_buffer)
  exec_lua("return test_register(...)", 0, "test1", offset_encoding, line_ending)

  for _, edit in ipairs(edit_operations) do
    feed(edit)
  end
  eq(expected_text_changes, exec_lua("return get_events(...)" ))
  exec_lua("test_unreg = 'test1'")

end
describe('incremental synchronization', function()
  describe('single line edit', function()
    it('inserting a character in an empty buffer', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 0,
              line = 0
            },
            ['end'] = {
              character = 0,
              line = 0
            }
          },
          rangeLength = 0,
          text = 'a'
        }
      }
      test_edit({""}, {"ia"}, expected_text_changes, 'utf-16', '\n')
    end)
    it('inserting a character in the middle of a the first line', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 1,
              line = 0
            },
            ['end'] = {
              character = 1,
              line = 0
            }
          },
          rangeLength = 0,
          text = 'a'
        }
      }
      test_edit({"ab"}, {"lia"}, expected_text_changes, 'utf-16', '\n')
    end)
    it('deleting the only character in a buffer', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 0,
              line = 0
            },
            ['end'] = {
              character = 1,
              line = 0
            }
          },
          rangeLength = 1,
          text = ''
        }
      }
      test_edit({"a"}, {"x"}, expected_text_changes, 'utf-16', '\n')
    end)
    it('deleting a character in the middle of the line', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 1,
              line = 0
            },
            ['end'] = {
              character = 2,
              line = 0
            }
          },
          rangeLength = 1,
          text = ''
        }
      }
      test_edit({"abc"}, {"lx"}, expected_text_changes, 'utf-16', '\n')
    end)
    it('replacing a character', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 0,
              line = 0
            },
            ['end'] = {
              character = 1,
              line = 0
            }
          },
          rangeLength = 1,
          text = 'b'
        }
      }
      test_edit({"a"}, {"rb"}, expected_text_changes, 'utf-16', '\n')
    end)
    describe('multi-byte edits', function()
      it('join and undo', function()
        local expected_text_changes = {
          {
            range = {
              ['start'] = {
                character = 11,
                line = 0
              },
              ['end'] = {
                character = 11,
                line = 0
              }
            },
            rangeLength = 0,
            text = ' test3'
          },{
            range = {
              ['start'] = {
                character = 0,
                line = 1
              },
              ['end'] = {
                character = 0,
                line = 2
              }
            },
            rangeLength = 6,
            text = ''
          },{
            range = {
              ['start'] = {
                character = 11,
                line = 0
              },
              ['end'] = {
                character = 17,
                line = 0
              }
            },
            rangeLength = 6,
            text = '\ntest3'
          },
        }
        test_edit({"test1 test2", "test3"}, {"J", "u"}, expected_text_changes, 'utf-16', '\n')
      end)
    end)
  end)
  describe('multi-byte edits', function()
    it('deleting a multibyte character', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 0,
              line = 0
            },
            ['end'] = {
              character = 2,
              line = 0
            }
          },
          rangeLength = 2,
          text = ''
        }
      }
      test_edit({"🔥"}, {"x"}, expected_text_changes, 'utf-16', '\n')
    end)
    it('deleting a multiple lines containing multibyte characters', function()
      local expected_text_changes = {
        {
          range = {
            ['start'] = {
              character = 0,
              line = 1
            },
            ['end'] = {
              character = 0,
              line = 3
            }
          },
          --utf 16 len of 🔥 is 2
          rangeLength = 8,
          text = ''
        }
      }
      test_edit({"a🔥", "b🔥", "c🔥", "d🔥"}, {"j2dd"}, expected_text_changes, 'utf-16', '\n')
    end)
  end)
end)

-- TODO(mjlbach): Add additional tests
-- deleting single lone line
-- 2 lines -> 2 line delete -> undo -> redo
-- describe('future tests', function()
--   -- This test is currently wrong, ask bjorn why dd on an empty line triggers on_lines
--   it('deleting an empty line', function()
--     local expected_text_changes = {{ }}
--     test_edit({""}, {"ggdd"}, expected_text_changes, 'utf-16', '\n')
--   end)
-- end)