From b67f689e4cb08ac3f33432038ae9aec81383a9f3 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Wed, 14 Apr 2021 21:29:32 +0200
Subject: lsp: Accept text document edits with version zero

There were a couple of reports of "Buffer X newer than edits" problems.
We first assumed that it is incorrect for a server to send 0 as a
version - and stated that they should send a `null` instead, given that
in the specification the `textDocument` of a `TextDocumentEdit` is a
`OptionalVersionedTextDocumentIdentifier`.

But it turns out that this was a change in 3.16, and in 3.15 and earlier
versions of the specification it was a `VersionedTextDocumentIdentifier`
and language servers didn't have a better option than sending `0` if
they don't keep track of the version numbers.

So this changes the version check to always accept `0` values.

See

- https://github.com/neovim/neovim/issues/12970
- https://github.com/neovim/neovim/issues/14256
- https://github.com/haskell/haskell-language-server/pull/1727
---
 test/functional/plugin/lsp_spec.lua | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'test')

diff --git a/test/functional/plugin/lsp_spec.lua b/test/functional/plugin/lsp_spec.lua
index 66b33cc9e1..49e443d56c 100644
--- a/test/functional/plugin/lsp_spec.lua
+++ b/test/functional/plugin/lsp_spec.lua
@@ -1124,6 +1124,19 @@ describe('LSP', function()
         '2nd line of 语text';
       }, buf_lines(target_bufnr))
     end)
+    it('always accepts edit with version = 0', function()
+      exec_lua([[
+        local args = {...}
+        local bufnr = select(1, ...)
+        local text_edit = select(2, ...)
+        vim.lsp.util.buf_versions[bufnr] = 10
+        vim.lsp.util.apply_text_document_edit(text_edit)
+      ]], target_bufnr, text_document_edit(0))
+      eq({
+        'First ↥ 🤦 🦄 line of text';
+        '2nd line of 语text';
+      }, buf_lines(target_bufnr))
+    end)
     it('correctly goes ahead with the edit if the version is vim.NIL', function()
       -- we get vim.NIL when we decode json null value.
       local json = exec_lua[[
-- 
cgit 


From 046991e4d5c6bc25ee11bbe28f0b685f00cf1d3d Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Wed, 14 Apr 2021 21:42:03 +0200
Subject: lsp: Remove vim.NIL handling from apply_text_document_edit

The rpc layer normalizes `vim.NIL` to `nil`, so the scenario tested
should never happen.
---
 test/functional/plugin/lsp_spec.lua | 13 -------------
 1 file changed, 13 deletions(-)

(limited to 'test')

diff --git a/test/functional/plugin/lsp_spec.lua b/test/functional/plugin/lsp_spec.lua
index 49e443d56c..557f8a206f 100644
--- a/test/functional/plugin/lsp_spec.lua
+++ b/test/functional/plugin/lsp_spec.lua
@@ -1137,19 +1137,6 @@ describe('LSP', function()
         '2nd line of 语text';
       }, buf_lines(target_bufnr))
     end)
-    it('correctly goes ahead with the edit if the version is vim.NIL', function()
-      -- we get vim.NIL when we decode json null value.
-      local json = exec_lua[[
-        return vim.fn.json_decode("{ \"a\": 1, \"b\": null }")
-      ]]
-      eq(json.b, exec_lua("return vim.NIL"))
-
-      exec_lua('vim.lsp.util.apply_text_document_edit(...)', text_document_edit(exec_lua("return vim.NIL")))
-      eq({
-        'First ↥ 🤦 🦄 line of text';
-        '2nd line of 语text';
-      }, buf_lines(target_bufnr))
-    end)
     it('skips the edit if the version of the edit is behind the local buffer ', function()
       local apply_edit_mocking_current_version = function(edit, versionedBuf)
         exec_lua([[
-- 
cgit