Check LSP capabilities before using them

7 files changed, 133 insertions, 33 deletions

diff --git a/test/completion/test_lsp_completion_messages.vader b/test/completion/test_lsp_completion_messages.vader
index 00a174dc..30a9c8e1 100644
--- a/test/completion/test_lsp_completion_messages.vader
+++ b/test/completion/test_lsp_completion_messages.vader
@@ -13,11 +13,11 @@ Before:
   runtime autoload/ale/lsp.vim
 
   let g:message_list = []
+  let g:capability_checked = ''
   let g:Callback = ''
+  let g:WaitCallback = v:null
 
-  function! ale#lsp_linter#StartLSP(buffer, linter, callback) abort
-    let g:Callback = a:callback
-
+  function! ale#lsp_linter#StartLSP(buffer, linter) abort
     let l:conn = ale#lsp#NewConnection({})
     let l:conn.id = 347
     let l:conn.open_documents = {a:buffer : -1}
@@ -35,6 +35,15 @@ Before:
     return 'i'
   endfunction
 
+  function! ale#lsp#WaitForCapability(conn_id, project_root, capability, callback) abort
+    let g:capability_checked = a:capability
+    let g:WaitCallback = a:callback
+  endfunction
+
+  function! ale#lsp#RegisterCallback(conn_id, callback) abort
+    let g:Callback = a:callback
+  endfunction
+
   " Replace the Send function for LSP, so we can monitor calls to it.
   function! ale#lsp#Send(conn_id, message, ...) abort
     call add(g:message_list, a:message)
@@ -44,6 +53,8 @@ After:
   Restore
 
   unlet! g:message_list
+  unlet! g:capability_checked
+  unlet! g:WaitCallback
   unlet! g:Callback
   unlet! b:ale_old_omnifunc
   unlet! b:ale_old_completopt
@@ -84,6 +95,13 @@ Execute(The right message should be sent for the initial tsserver request):
 
   call ale#completion#GetCompletions()
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'completion', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   " We should send the right callback.
   AssertEqual
   \ 'function(''ale#completion#HandleTSServerResponse'')',
@@ -164,6 +182,13 @@ Execute(The right message should be sent for the initial LSP request):
 
   call ale#completion#GetCompletions()
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'completion', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   " We should send the right callback.
   AssertEqual
   \ 'function(''ale#completion#HandleLSPResponse'')',
diff --git a/test/lsp/test_did_save_event.vader b/test/lsp/test_did_save_event.vader
index b696ee4b..428135fb 100644
--- a/test/lsp/test_did_save_event.vader
+++ b/test/lsp/test_did_save_event.vader
@@ -14,7 +14,6 @@ Before:
   let g:ale_lsp_next_message_id = 1
   let g:ale_run_synchronously = 1
   let g:message_list = []
-  let g:Callback = ''
 
   function! LanguageCallback() abort
     return 'foobar'
@@ -34,9 +33,7 @@ Before:
   \ })
   let g:ale_linters = {'foobar': ['dummy_linter']}
 
-  function! ale#lsp_linter#StartLSP(buffer, linter, callback) abort
-    let g:Callback = a:callback
-
+  function! ale#lsp_linter#StartLSP(buffer, linter) abort
     let l:conn = ale#lsp#NewConnection({})
     let l:conn.id = 347
     let l:conn.open_documents = {a:buffer : -1}
@@ -59,7 +56,6 @@ After:
 
   unlet! b:ale_enabled
   unlet! b:ale_linters
-  unlet! g:Callback
   unlet! g:message_list
 
   delfunction LanguageCallback
diff --git a/test/lsp/test_lsp_command_formatting.vader b/test/lsp/test_lsp_command_formatting.vader
index f436397f..9d2c84ee 100644
--- a/test/lsp/test_lsp_command_formatting.vader
+++ b/test/lsp/test_lsp_command_formatting.vader
@@ -23,15 +23,14 @@ Execute(Command formatting should be applied correctly for LSP linters):
   \   'executable': has('win32') ? 'cmd': 'true',
   \   'command': '%e --foo',
   \ },
-  \ {->0}
   \)
 
   if has('win32')
     AssertEqual
-    \ ['cmd', 'cmd /s/c "cmd --foo"', '/foo/bar'],
-    \ g:args[:2]
+    \ ['cmd', 'cmd /s/c "cmd --foo"', {}],
+    \ g:args
   else
     AssertEqual
-    \ ['true', [&shell, '-c', '''true'' --foo'], '/foo/bar'],
-    \ g:args[:2]
+    \ ['true', [&shell, '-c', '''true'' --foo'], {}],
+    \ g:args
   endif
diff --git a/test/lsp/test_lsp_connections.vader b/test/lsp/test_lsp_connections.vader
index 8651d801..ae64eadb 100644
--- a/test/lsp/test_lsp_connections.vader
+++ b/test/lsp/test_lsp_connections.vader
@@ -2,6 +2,10 @@ Before:
   let g:ale_lsp_next_message_id = 1
 
 After:
+  if exists('b:conn') && has_key(b:conn, 'id')
+    call ale#lsp#RemoveConnectionWithID(b:conn.id)
+  endif
+
   unlet! b:data
   unlet! b:conn
 
@@ -223,17 +227,20 @@ Execute(ale#lsp#ReadMessageData() should handle a message with part of a second
   \ )
 
 Execute(Projects with regular project roots should be registered correctly):
-  let b:conn = {'projects': {}}
-
-  call ale#lsp#RegisterProject(b:conn, '/foo/bar')
+  let b:conn = ale#lsp#NewConnection({})
+  call ale#lsp#RegisterProject(b:conn.id, '/foo/bar')
 
   AssertEqual
   \ {
-  \   'projects': {
-  \     '/foo/bar': {'initialized': 0, 'message_queue': [], 'init_request_id': 0},
+  \   '/foo/bar': {
+  \     'root': '/foo/bar',
+  \     'initialized': 0,
+  \     'message_queue': [],
+  \     'capabilities_queue': [],
+  \     'init_request_id': 0,
   \   },
   \ },
-  \ b:conn
+  \ b:conn.projects
 
 Execute(Projects with regular project roots should be fetched correctly):
   let b:conn = {
@@ -247,17 +254,20 @@ Execute(Projects with regular project roots should be fetched correctly):
   \ ale#lsp#GetProject(b:conn, '/foo/bar')
 
 Execute(Projects with empty project roots should be registered correctly):
-  let b:conn = {'projects': {}}
-
-  call ale#lsp#RegisterProject(b:conn, '')
+  let b:conn = ale#lsp#NewConnection({})
+  call ale#lsp#RegisterProject(b:conn.id, '')
 
   AssertEqual
   \ {
-  \   'projects': {
-  \     '<<EMPTY>>': {'initialized': 1, 'message_queue': [], 'init_request_id': 0},
+  \   '<<EMPTY>>': {
+  \     'root': '',
+  \     'initialized': 1,
+  \     'message_queue': [],
+  \     'capabilities_queue': [],
+  \     'init_request_id': 0,
   \   },
   \ },
-  \ b:conn
+  \ b:conn.projects
 
 Execute(Projects with empty project roots should be fetched correctly):
   let b:conn = {
diff --git a/test/lsp/test_other_initialize_message_handling.vader b/test/lsp/test_other_initialize_message_handling.vader
index f9567ee0..45457979 100644
--- a/test/lsp/test_other_initialize_message_handling.vader
+++ b/test/lsp/test_other_initialize_message_handling.vader
@@ -3,6 +3,7 @@ Before:
   \ 'initialized': 0,
   \ 'init_request_id': 3,
   \ 'message_queue': [],
+  \ 'capabilities_queue': [],
   \}
 
   let b:conn = {
@@ -34,6 +35,7 @@ Execute(publishDiagnostics messages with files inside project directories should
   \   'initialized': 0,
   \   'init_request_id': 3,
   \   'message_queue': [],
+  \   'capabilities_queue': [],
   \ },
   \ b:project
 
@@ -47,6 +49,7 @@ Execute(publishDiagnostics messages with files inside project directories should
   \   'initialized': 1,
   \   'init_request_id': 3,
   \   'message_queue': [],
+  \   'capabilities_queue': [],
   \ },
   \ b:project
 
@@ -60,6 +63,7 @@ Execute(Messages with no method and capabilities should initialize projects):
   \   'initialized': 1,
   \   'init_request_id': 3,
   \   'message_queue': [],
+  \   'capabilities_queue': [],
   \ },
   \ b:project
 
@@ -120,6 +124,7 @@ Execute(Capabilities should bet set up correctly):
   \     '/foo/bar': {
   \       'initialized': 1,
   \       'message_queue': [],
+  \       'capabilities_queue': [],
   \       'init_request_id': 3,
   \     },
   \   },
@@ -170,6 +175,7 @@ Execute(Disabled capabilities should be recognised correctly):
   \     '/foo/bar': {
   \       'initialized': 1,
   \       'message_queue': [],
+  \       'capabilities_queue': [],
   \       'init_request_id': 3,
   \     },
   \   },
diff --git a/test/test_find_references.vader b/test/test_find_references.vader
index 150e0471..ecced068 100644
--- a/test/test_find_references.vader
+++ b/test/test_find_references.vader
@@ -3,20 +3,20 @@ Before:
   call ale#test#SetFilename('dummy.txt')
 
   let g:old_filename = expand('%:p')
-  let g:Callback = 0
+  let g:Callback = ''
   let g:expr_list = []
   let g:message_list = []
   let g:preview_called = 0
   let g:item_list = []
+  let g:capability_checked = ''
+  let g:WaitCallback = v:null
 
   runtime autoload/ale/linter.vim
   runtime autoload/ale/lsp.vim
   runtime autoload/ale/util.vim
   runtime autoload/ale/preview.vim
 
-  function! ale#lsp_linter#StartLSP(buffer, linter, callback) abort
-    let g:Callback = a:callback
-
+  function! ale#lsp_linter#StartLSP(buffer, linter) abort
     let l:conn = ale#lsp#NewConnection({})
     let l:conn.id = 347
     let l:conn.open_documents = {a:buffer : -1}
@@ -29,6 +29,15 @@ Before:
     \}
   endfunction
 
+  function! ale#lsp#WaitForCapability(conn_id, project_root, capability, callback) abort
+    let g:capability_checked = a:capability
+    let g:WaitCallback = a:callback
+  endfunction
+
+  function! ale#lsp#RegisterCallback(conn_id, callback) abort
+    let g:Callback = a:callback
+  endfunction
+
   function! ale#lsp#Send(conn_id, message, root) abort
     call add(g:message_list, a:message)
 
@@ -50,6 +59,8 @@ After:
   call ale#test#RestoreDirectory()
   call ale#linter#Reset()
 
+  unlet! g:capability_checked
+  unlet! g:WaitCallback
   unlet! g:old_filename
   unlet! g:Callback
   unlet! g:message_list
@@ -152,6 +163,13 @@ Execute(tsserver reference requests should be sent):
 
   ALEFindReferences
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'references', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   AssertEqual
   \ 'function(''ale#references#HandleTSServerResponse'')',
   \ string(g:Callback)
@@ -226,6 +244,13 @@ Execute(LSP reference requests should be sent):
 
   ALEFindReferences
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'references', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   AssertEqual
   \ 'function(''ale#references#HandleLSPResponse'')',
   \ string(g:Callback)
diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader
index 749f4d7e..7f0e3fcb 100644
--- a/test/test_go_to_definition.vader
+++ b/test/test_go_to_definition.vader
@@ -3,17 +3,17 @@ Before:
   call ale#test#SetFilename('dummy.txt')
 
   let g:old_filename = expand('%:p')
-  let g:Callback = 0
+  let g:Callback = ''
   let g:message_list = []
   let g:expr_list = []
+  let g:capability_checked = ''
+  let g:WaitCallback = v:null
 
   runtime autoload/ale/linter.vim
   runtime autoload/ale/lsp.vim
   runtime autoload/ale/util.vim
 
-  function! ale#lsp_linter#StartLSP(buffer, linter, callback) abort
-    let g:Callback = a:callback
-
+  function! ale#lsp_linter#StartLSP(buffer, linter) abort
     let l:conn = ale#lsp#NewConnection({})
     let l:conn.id = 347
     let l:conn.open_documents = {a:buffer : -1}
@@ -26,6 +26,15 @@ Before:
     \}
   endfunction
 
+  function! ale#lsp#WaitForCapability(conn_id, project_root, capability, callback) abort
+    let g:capability_checked = a:capability
+    let g:WaitCallback = a:callback
+  endfunction
+
+  function! ale#lsp#RegisterCallback(conn_id, callback) abort
+    let g:Callback = a:callback
+  endfunction
+
   function! ale#lsp#Send(conn_id, message, root) abort
     call add(g:message_list, a:message)
 
@@ -42,6 +51,8 @@ After:
   call ale#test#RestoreDirectory()
   call ale#linter#Reset()
 
+  unlet! g:capability_checked
+  unlet! g:WaitCallback
   unlet! g:old_filename
   unlet! g:Callback
   unlet! g:message_list
@@ -137,6 +148,13 @@ Execute(tsserver completion requests should be sent):
 
   ALEGoToDefinition
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'definition', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   AssertEqual
   \ 'function(''ale#definition#HandleTSServerResponse'')',
   \ string(g:Callback)
@@ -151,6 +169,13 @@ Execute(tsserver tab completion requests should be sent):
 
   ALEGoToDefinitionInTab
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'definition', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   AssertEqual
   \ 'function(''ale#definition#HandleTSServerResponse'')',
   \ string(g:Callback)
@@ -276,6 +301,13 @@ Execute(LSP completion requests should be sent):
 
   ALEGoToDefinition
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'definition', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   AssertEqual
   \ 'function(''ale#definition#HandleLSPResponse'')',
   \ string(g:Callback)
@@ -305,6 +337,13 @@ Execute(LSP tab completion requests should be sent):
 
   ALEGoToDefinitionInTab
 
+  " We shouldn't register the callback yet.
+  AssertEqual '''''', string(g:Callback)
+
+  AssertEqual type(function('type')), type(g:WaitCallback)
+  AssertEqual 'definition', g:capability_checked
+  call call(g:WaitCallback, [347, '/foo/bar'])
+
   AssertEqual
   \ 'function(''ale#definition#HandleLSPResponse'')',
   \ string(g:Callback)