#1162 Add unfinished experimental code for supporting LSP completion, clean up the tests, and make the completion cancelling better

5 files changed, 473 insertions, 0 deletions

diff --git a/test/completion/test_completion_events.vader b/test/completion/test_completion_events.vader
new file mode 100644
index 00000000..49d485f6
--- /dev/null
+++ b/test/completion/test_completion_events.vader
@@ -0,0 +1,172 @@
+Before:
+  Save g:ale_completion_enabled
+  Save g:ale_completion_delay
+  Save g:ale_completion_max_suggestions
+  Save g:ale_completion_experimental_lsp_support
+  Save &l:omnifunc
+  Save &l:completeopt
+
+  unlet! g:ale_completion_experimental_lsp_support
+
+  let g:ale_completion_enabled = 1
+  let g:get_completions_called = 0
+  let g:feedkeys_calls = []
+
+  runtime autoload/ale/util.vim
+
+  function! ale#util#FeedKeys(string, mode) abort
+    call add(g:feedkeys_calls, [a:string, a:mode])
+  endfunction
+
+  function! CheckCompletionCalled(expect_success) abort
+    let g:get_completions_called = 0
+
+    " We just want to check if the function is called.
+    function! ale#completion#GetCompletions()
+      let g:get_completions_called = 1
+    endfunction
+
+    let g:ale_completion_delay = 0
+    call ale#completion#Queue()
+    sleep 1m
+
+    AssertEqual a:expect_success, g:get_completions_called
+  endfunction
+
+After:
+  Restore
+
+  unlet! g:get_completions_called
+  unlet! b:ale_old_omnifunc
+  unlet! b:ale_old_completopt
+  unlet! b:ale_completion_info
+  unlet! b:ale_completion_response
+  unlet! b:ale_completion_parser
+  unlet! b:ale_complete_done_time
+  unlet! g:ale_completion_experimental_lsp_support
+
+  delfunction CheckCompletionCalled
+
+  " Stop any timers we left behind.
+  " This stops the tests from failing randomly.
+  call ale#completion#StopTimer()
+
+  runtime autoload/ale/completion.vim
+  runtime autoload/ale/util.vim
+
+Execute(ale#completion#GetCompletions should be called when the cursor position stays the same):
+  call CheckCompletionCalled(1)
+
+Given typescript():
+  let abc = y.
+  let foo = ab
+  let foo = (ab)
+
+Execute(ale#completion#GetCompletions should not be called when the cursor position changes):
+  call setpos('.', [bufnr(''), 1, 2, 0])
+
+  " We just want to check if the function is called.
+  function! ale#completion#GetCompletions()
+    let g:get_completions_called = 1
+  endfunction
+
+  let g:ale_completion_delay = 0
+  call ale#completion#Queue()
+
+  " Change the cursor position before the callback is triggered.
+  call setpos('.', [bufnr(''), 2, 2, 0])
+
+  sleep 1m
+
+  Assert !g:get_completions_called
+
+Execute(Completion should not be done shortly after the CompleteDone function):
+  call CheckCompletionCalled(1)
+  call ale#completion#Done()
+  call CheckCompletionCalled(0)
+
+Execute(ale#completion#Show() should remember the omnifunc setting and replace it):
+  let &l:omnifunc = 'FooBar'
+
+  call ale#completion#Show('Response', 'Parser')
+
+  AssertEqual 'FooBar', b:ale_old_omnifunc
+  AssertEqual 'ale#completion#OmniFunc', &l:omnifunc
+
+Execute(ale#completion#Show() should remember the completeopt setting and replace it):
+  let &l:completeopt = 'menu'
+
+  call ale#completion#Show('Response', 'Parser')
+
+  AssertEqual 'menu', b:ale_old_completopt
+  AssertEqual 'menu,menuone,preview,noselect,noinsert', &l:completeopt
+
+Execute(ale#completion#OmniFunc() should also remember the completeopt setting and replace it):
+  let &l:completeopt = 'menu'
+
+  call ale#completion#OmniFunc(0, '')
+
+  AssertEqual 'menu', b:ale_old_completopt
+  AssertEqual 'menu,menuone,preview,noselect,noinsert', &l:completeopt
+
+Execute(ale#completion#Show() should make the correct feedkeys() call):
+  call ale#completion#Show('Response', 'Parser')
+
+  AssertEqual [["\<C-x>\<C-o>", 'n']], g:feedkeys_calls
+
+Execute(ale#completion#Show() should set up the response and parser):
+  call ale#completion#Show('Response', 'Parser')
+
+  AssertEqual 'Response', b:ale_completion_response
+  AssertEqual 'Parser', b:ale_completion_parser
+
+Execute(ale#completion#Done() should restore old omnifunc values):
+  let b:ale_old_omnifunc = 'FooBar'
+
+  call ale#completion#Done()
+
+  " We reset the old omnifunc setting and remove the buffer variable.
+  AssertEqual 'FooBar', &l:omnifunc
+  Assert !has_key(b:, 'ale_old_omnifunc')
+
+Execute(ale#completion#Done() should restore the old completeopt setting):
+  let b:ale_old_completopt = 'menu'
+  let &l:completeopt = 'menu,menuone,preview,noselect,noinsert'
+
+  call ale#completion#Done()
+
+  AssertEqual 'menu', &l:completeopt
+  Assert !has_key(b:, 'ale_old_completopt')
+
+Execute(ale#completion#Done() should leave settings alone when none were remembered):
+  let &l:omnifunc = 'BazBoz'
+  let &l:completeopt = 'menu'
+
+  call ale#completion#Done()
+
+  AssertEqual 'BazBoz', &l:omnifunc
+  AssertEqual 'menu', &l:completeopt
+
+Execute(The completion request_id should be reset when queuing again):
+  let b:ale_completion_info = {'request_id': 123}
+
+  let g:ale_completion_delay = 0
+  call ale#completion#Queue()
+  sleep 1m
+
+  AssertEqual 0, b:ale_completion_info.request_id
+
+Execute(b:ale_completion_info should be set up correctly when requesting completions):
+  call setpos('.', [bufnr(''), 3, 14, 0])
+  call ale#completion#GetCompletions()
+
+  AssertEqual
+  \ {
+  \   'request_id': 0,
+  \   'conn_id': 0,
+  \   'column': 14,
+  \   'line_length': 14,
+  \   'line': 3,
+  \   'prefix': 'ab',
+  \ },
+  \ b:ale_completion_info
diff --git a/test/completion/test_completion_filtering.vader b/test/completion/test_completion_filtering.vader
new file mode 100644
index 00000000..3e461aef
--- /dev/null
+++ b/test/completion/test_completion_filtering.vader
@@ -0,0 +1,36 @@
+Execute(Prefix filtering should work for Lists of strings):
+  AssertEqual
+  \ ['FooBar', 'foo'],
+  \ ale#completion#Filter(['FooBar', 'FongBar', 'baz', 'foo'], 'foo')
+  AssertEqual
+  \ ['FooBar', 'FongBar', 'baz', 'foo'],
+  \ ale#completion#Filter(['FooBar', 'FongBar', 'baz', 'foo'], '.')
+
+Execute(Prefix filtering should work for completion items):
+  AssertEqual
+  \ [{'word': 'FooBar'}, {'word': 'foo'}],
+  \ ale#completion#Filter(
+  \   [
+  \     {'word': 'FooBar'},
+  \     {'word': 'FongBar'},
+  \     {'word': 'baz'},
+  \     {'word': 'foo'},
+  \   ],
+  \   'foo'
+  \ )
+  AssertEqual
+  \ [
+  \   {'word': 'FooBar'},
+  \   {'word': 'FongBar'},
+  \   {'word': 'baz'},
+  \   {'word': 'foo'},
+  \ ],
+  \ ale#completion#Filter(
+  \   [
+  \     {'word': 'FooBar'},
+  \     {'word': 'FongBar'},
+  \     {'word': 'baz'},
+  \     {'word': 'foo'},
+  \   ],
+  \   '.'
+  \ )
diff --git a/test/completion/test_completion_prefixes.vader b/test/completion/test_completion_prefixes.vader
new file mode 100644
index 00000000..8ac29326
--- /dev/null
+++ b/test/completion/test_completion_prefixes.vader
@@ -0,0 +1,19 @@
+Given typescript():
+  let abc = y.
+  let foo = ab
+  let foo = (ab)
+
+Execute(Completion should be done after dots in TypeScript):
+  AssertEqual '.', ale#completion#GetPrefix(&filetype, 1, 13)
+
+Execute(Completion should be done after words in TypeScript):
+  AssertEqual 'ab', ale#completion#GetPrefix(&filetype, 2, 13)
+
+Execute(Completion should be done after words in parens in TypeScript):
+  AssertEqual 'ab', ale#completion#GetPrefix(&filetype, 3, 14)
+
+Execute(Completion should not be done after parens in TypeScript):
+  AssertEqual '', ale#completion#GetPrefix(&filetype, 3, 15)
+
+Execute(Completion prefixes should work for other filetypes):
+  AssertEqual 'ab', ale#completion#GetPrefix('xxxyyyzzz', 3, 14)
diff --git a/test/completion/test_lsp_completion_messages.vader b/test/completion/test_lsp_completion_messages.vader
new file mode 100644
index 00000000..df340fbe
--- /dev/null
+++ b/test/completion/test_lsp_completion_messages.vader
@@ -0,0 +1,171 @@
+Before:
+  Save g:ale_completion_delay
+  Save g:ale_completion_max_suggestions
+  Save g:ale_completion_info
+  Save g:ale_completion_experimental_lsp_support
+  Save &l:omnifunc
+  Save &l:completeopt
+
+  unlet! g:ale_completion_experimental_lsp_support
+
+  let g:ale_completion_enabled = 1
+
+  call ale#test#SetDirectory('/testplugin/test/completion')
+  call ale#test#SetFilename('dummy.txt')
+
+  runtime autoload/ale/lsp.vim
+
+  let g:message = []
+  let g:Callback = ''
+
+  function! ale#linter#StartLSP(buffer, linter, callback) abort
+    let g:Callback = a:callback
+
+    return {
+    \ 'connection_id': 347,
+    \ 'project_root': '/foo/bar',
+    \}
+  endfunction
+
+  " Replace the Send function for LSP, so we can monitor calls to it.
+  function! ale#lsp#Send(conn_id, message, ...) abort
+    let g:message = a:message
+  endfunction
+
+After:
+  Restore
+
+  unlet! g:message
+  unlet! g:Callback
+  unlet! b:ale_old_omnifunc
+  unlet! b:ale_old_completopt
+  unlet! b:ale_completion_info
+  unlet! b:ale_completion_response
+  unlet! b:ale_completion_parser
+  unlet! b:ale_complete_done_time
+  unlet! b:ale_linters
+  unlet! g:ale_completion_experimental_lsp_support
+
+  call ale#test#RestoreDirectory()
+  call ale#linter#Reset()
+
+  " Stop any timers we left behind.
+  " This stops the tests from failing randomly.
+  call ale#completion#StopTimer()
+
+  runtime autoload/ale/completion.vim
+  runtime autoload/ale/lsp.vim
+
+Given typescript(Some typescript file):
+  foo
+  somelongerline
+  bazxyzxyzxyz
+
+Execute(The right message should be sent for the initial tsserver request):
+  runtime ale_linters/typescript/tsserver.vim
+  let b:ale_linters = ['tsserver']
+  " The cursor position needs to match what was saved before.
+  call setpos('.', [bufnr(''), 1, 3, 0])
+
+  call ale#completion#GetCompletions()
+
+  " We should send the right callback.
+  AssertEqual
+  \ 'function(''ale#completion#HandleTSServerResponse'')',
+  \ string(g:Callback)
+  " We should send the right message.
+  AssertEqual
+  \ [0, 'ts@completions', {'file': expand('%:p'), 'line': 1, 'offset': 3, 'prefix': 'fo'}],
+  \ g:message
+  " We should set up the completion info correctly.
+  AssertEqual
+  \ {
+  \   'line_length': 3,
+  \   'conn_id': 0,
+  \   'column': 3,
+  \   'request_id': 0,
+  \   'line': 1,
+  \   'prefix': 'fo',
+  \ },
+  \ get(b:, 'ale_completion_info', {})
+
+Execute(The right message sent to the tsserver LSP when the first completion message is received):
+  " The cursor position needs to match what was saved before.
+  call setpos('.', [bufnr(''), 1, 1, 0])
+  let b:ale_completion_info = {
+  \ 'conn_id': 123,
+  \ 'prefix': 'f',
+  \ 'request_id': 4,
+  \ 'line': 1,
+  \ 'column': 1,
+  \}
+  " We should only show up to this many suggestions.
+  let g:ale_completion_max_suggestions = 3
+
+  " Handle the response for completions.
+  call ale#completion#HandleTSServerResponse(123, {
+  \ 'request_seq': 4,
+  \ 'command': 'completions',
+  \ 'body': [
+  \   {'name': 'Baz'},
+  \   {'name': 'dingDong'},
+  \   {'name': 'Foo'},
+  \   {'name': 'FooBar'},
+  \   {'name': 'frazzle'},
+  \   {'name': 'FFS'},
+  \ ],
+  \})
+
+  " The entry details messages should have been sent.
+  AssertEqual
+  \ [
+  \   0,
+  \   'ts@completionEntryDetails',
+  \   {
+  \     'file': expand('%:p'),
+  \     'entryNames': ['Foo', 'FooBar', 'frazzle'],
+  \     'offset': 1,
+  \     'line': 1,
+  \   },
+  \ ],
+  \ g:message
+
+Given python(Some Python file):
+  foo
+  somelongerline
+  bazxyzxyzxyz
+
+Execute(The right message should be sent for the initial LSP request):
+  let g:ale_completion_experimental_lsp_support = 1
+
+  runtime ale_linters/python/pyls.vim
+  let b:ale_linters = ['pyls']
+  " The cursor position needs to match what was saved before.
+  call setpos('.', [bufnr(''), 1, 5, 0])
+
+  call ale#completion#GetCompletions()
+
+  " We should send the right callback.
+  AssertEqual
+  \ 'function(''ale#completion#HandleLSPResponse'')',
+  \ string(g:Callback)
+  " We should send the right message.
+  " The character index needs to be at most the index of the last character on
+  " the line, or integration with pyls will be broken.
+  AssertEqual
+  \ [0, 'textDocument/completion', {
+  \   'textDocument': {'uri': ale#path#ToURI(expand('%:p'))},
+  \   'position': {'line': 0, 'character': 2},
+  \ }],
+  \ g:message
+  " We should set up the completion info correctly.
+  AssertEqual
+  \ {
+  \   'line_length': 3,
+  \   'conn_id': 0,
+  \   'column': 3,
+  \   'request_id': 0,
+  \   'line': 1,
+  \   'prefix': 'fo',
+  \ },
+  \ get(b:, 'ale_completion_info', {})
diff --git a/test/completion/test_tsserver_completion_parsing.vader b/test/completion/test_tsserver_completion_parsing.vader
new file mode 100644
index 00000000..b663ef40
--- /dev/null
+++ b/test/completion/test_tsserver_completion_parsing.vader
@@ -0,0 +1,75 @@
+Execute(TypeScript completions responses should be parsed correctly):
+  AssertEqual [],
+  \ ale#completion#ParseTSServerCompletions({
+  \ 'body': [],
+  \})
+  AssertEqual ['foo', 'bar', 'baz'],
+  \ ale#completion#ParseTSServerCompletions({
+  \ 'body': [
+  \   {'name': 'foo'},
+  \   {'name': 'bar'},
+  \   {'name': 'baz'},
+  \ ],
+  \})
+
+Execute(TypeScript completion details responses should be parsed correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'word': 'abc',
+  \     'menu': '(property) Foo.abc: number',
+  \     'info': '',
+  \     'kind': 'f',
+  \     'icase': 1,
+  \   },
+  \   {
+  \     'word': 'def',
+  \     'menu': '(property) Foo.def: number',
+  \     'info': 'foo bar baz',
+  \     'kind': 'f',
+  \     'icase': 1,
+  \   },
+  \ ],
+  \ ale#completion#ParseTSServerCompletionEntryDetails({
+  \ 'body': [
+  \   {
+  \     'name': 'abc',
+  \     'kind': 'parameterName',
+  \     'displayParts': [
+  \       {'text': '('},
+  \       {'text': 'property'},
+  \       {'text': ')'},
+  \       {'text': ' '},
+  \       {'text': 'Foo'},
+  \       {'text': '.'},
+  \       {'text': 'abc'},
+  \       {'text': ':'},
+  \       {'text': ' '},
+  \       {'text': 'number'},
+  \     ],
+  \   },
+  \   {
+  \     'name': 'def',
+  \     'kind': 'parameterName',
+  \     'displayParts': [
+  \       {'text': '('},
+  \       {'text': 'property'},
+  \       {'text': ')'},
+  \       {'text': ' '},
+  \       {'text': 'Foo'},
+  \       {'text': '.'},
+  \       {'text': 'def'},
+  \       {'text': ':'},
+  \       {'text': ' '},
+  \       {'text': 'number'},
+  \     ],
+  \     'documentation': [
+  \       {'text': 'foo'},
+  \       {'text': ' '},
+  \       {'text': 'bar'},
+  \       {'text': ' '},
+  \       {'text': 'baz'},
+  \     ],
+  \   },
+  \ ],
+  \})