From 55b62a937c27715f7e6c299ae312c38edf08fa74 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mathias=20Fu=C3=9Fenegger?=
 <mfussenegger@users.noreply.github.com>
Date: Mon, 11 May 2020 16:56:35 +0200
Subject: [PATCH] LSP: Make applyEdit return a response (#12270)

According to the specification workspace/applyEdit needs to respond with
a `ApplyWorkspaceEditResponse`

See https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit

This is a subset of https://github.com/neovim/neovim/pull/11607
---
 runtime/lua/vim/lsp/callbacks.lua   |  6 +++++-
 test/functional/plugin/lsp_spec.lua | 16 +++++++++++++++-
 2 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/runtime/lua/vim/lsp/callbacks.lua b/runtime/lua/vim/lsp/callbacks.lua
index 70d21be8e7..09ca4b61e4 100644
--- a/runtime/lua/vim/lsp/callbacks.lua
+++ b/runtime/lua/vim/lsp/callbacks.lua
@@ -17,7 +17,11 @@ M['workspace/applyEdit'] = function(_, _, workspace_edit)
   if workspace_edit.label then
     print("Workspace edit", workspace_edit.label)
   end
-  util.apply_workspace_edit(workspace_edit.edit)
+  local status, result = pcall(util.apply_workspace_edit, workspace_edit.edit)
+  return {
+    applied = status;
+    failureReason = result;
+  }
 end
 
 M['textDocument/publishDiagnostics'] = function(_, _, result)
diff --git a/test/functional/plugin/lsp_spec.lua b/test/functional/plugin/lsp_spec.lua
index a263c6527d..e48d50ff47 100644
--- a/test/functional/plugin/lsp_spec.lua
+++ b/test/functional/plugin/lsp_spec.lua
@@ -913,7 +913,21 @@ describe('LSP', function()
       }, buf_lines(target_bufnr))
     end)
   end)
-
+  describe('workspace_apply_edit', function()
+    it('workspace/applyEdit returns ApplyWorkspaceEditResponse', function()
+      local expected = {
+        applied = true;
+        failureReason = nil;
+      }
+      eq(expected, exec_lua [[
+        local apply_edit = {
+          label = nil;
+          edit = {};
+        }
+        return vim.lsp.callbacks['workspace/applyEdit'](nil, nil, apply_edit)
+      ]])
+    end)
+  end)
   describe('completion_list_to_complete_items', function()
     -- Completion option precedence:
     -- textEdit.newText > insertText > label