292de25c72
This implements an asynchronous message system using a long-poll request to the server. The server provides an endpoint /receive_messages which blocks until either a timeout occurs or we receive a batch of asynchronous messages. We send this request asynchronously and poll it 4 times a second to see if we have received any messages. The messages may either be simply for display (such as startup progress) or diagnostics, which override the diagnostics returned by OnFileReqdyToParse. In the former case, we simply display the message, accepting that this might be overwritten by any other message (indeed, requiring this), and for the latter we fan out diagnostics to any open buffer for the file in question. Unfortunately, Vim has bugs related to timers when there is something displayed (such as a "confirm" prompt or other), so we suspend background timers when doing subcommands to avoid vim bugs. NOTE: This requires a new version of Vim (detected by the presence of the particular functions used).
143 lines
5.3 KiB
Python
143 lines
5.3 KiB
Python
# Copyright (C) 2017 YouCompleteMe Contributors
|
|
#
|
|
# This file is part of YouCompleteMe.
|
|
#
|
|
# YouCompleteMe is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# YouCompleteMe is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with YouCompleteMe. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
from __future__ import unicode_literals
|
|
from __future__ import print_function
|
|
from __future__ import division
|
|
from __future__ import absolute_import
|
|
# Not installing aliases from python-future; it's unreliable and slow.
|
|
from builtins import * # noqa
|
|
|
|
from ycm.tests.test_utils import MockVimModule
|
|
MockVimModule()
|
|
|
|
from hamcrest import assert_that, equal_to
|
|
from mock import patch, call
|
|
|
|
from ycm.client.messages_request import _HandlePollResponse
|
|
from ycm.tests.test_utils import ExtendedMock
|
|
|
|
|
|
def HandlePollResponse_NoMessages_test():
|
|
assert_that( _HandlePollResponse( True, None ), equal_to( True ) )
|
|
|
|
# Other non-False responses mean the same thing
|
|
assert_that( _HandlePollResponse( '', None ), equal_to( True ) )
|
|
assert_that( _HandlePollResponse( 1, None ), equal_to( True ) )
|
|
assert_that( _HandlePollResponse( {}, None ), equal_to( True ) )
|
|
|
|
|
|
def HandlePollResponse_PollingNotSupported_test():
|
|
assert_that( _HandlePollResponse( False, None ), equal_to( False ) )
|
|
|
|
# 0 is not False
|
|
assert_that( _HandlePollResponse( 0, None ), equal_to( True ) )
|
|
|
|
|
|
@patch( 'ycm.client.messages_request.PostVimMessage',
|
|
new_callable = ExtendedMock )
|
|
def HandlePollResponse_SingleMessage_test( post_vim_message ):
|
|
assert_that( _HandlePollResponse( [ { 'message': 'this is a message' } ] ,
|
|
None ),
|
|
equal_to( True ) )
|
|
|
|
post_vim_message.assert_has_exact_calls( [
|
|
call( 'this is a message', warning=False, truncate=True )
|
|
] )
|
|
|
|
|
|
@patch( 'ycm.client.messages_request.PostVimMessage',
|
|
new_callable = ExtendedMock )
|
|
def HandlePollResponse_MultipleMessages_test( post_vim_message ):
|
|
assert_that( _HandlePollResponse( [ { 'message': 'this is a message' },
|
|
{ 'message': 'this is another one' } ] ,
|
|
None ),
|
|
equal_to( True ) )
|
|
|
|
post_vim_message.assert_has_exact_calls( [
|
|
call( 'this is a message', warning=False, truncate=True ),
|
|
call( 'this is another one', warning=False, truncate=True )
|
|
] )
|
|
|
|
|
|
def HandlePollResponse_SingleDiagnostic_test():
|
|
diagnostics_handler = ExtendedMock()
|
|
messages = [
|
|
{ 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER' ] },
|
|
]
|
|
assert_that( _HandlePollResponse( messages, diagnostics_handler ),
|
|
equal_to( True ) )
|
|
diagnostics_handler.UpdateWithNewDiagnosticsForFile.assert_has_exact_calls( [
|
|
call( 'foo', [ 'PLACEHOLDER' ] )
|
|
] )
|
|
|
|
|
|
def HandlePollResponse_MultipleDiagnostics_test():
|
|
diagnostics_handler = ExtendedMock()
|
|
messages = [
|
|
{ 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER1' ] },
|
|
{ 'filepath': 'bar', 'diagnostics': [ 'PLACEHOLDER2' ] },
|
|
{ 'filepath': 'baz', 'diagnostics': [ 'PLACEHOLDER3' ] },
|
|
{ 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER4' ] },
|
|
]
|
|
assert_that( _HandlePollResponse( messages, diagnostics_handler ),
|
|
equal_to( True ) )
|
|
diagnostics_handler.UpdateWithNewDiagnosticsForFile.assert_has_exact_calls( [
|
|
call ( 'foo', [ 'PLACEHOLDER1' ] ),
|
|
call ( 'bar', [ 'PLACEHOLDER2' ] ),
|
|
call ( 'baz', [ 'PLACEHOLDER3' ] ),
|
|
call ( 'foo', [ 'PLACEHOLDER4' ] )
|
|
] )
|
|
|
|
|
|
@patch( 'ycm.client.messages_request.PostVimMessage',
|
|
new_callable = ExtendedMock )
|
|
def HandlePollResponse_MultipleMessagesAndDiagnostics_test( post_vim_message ):
|
|
diagnostics_handler = ExtendedMock()
|
|
messages = [
|
|
{ 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER1' ] },
|
|
{ 'message': 'On the first day of Christmas, my VimScript gave to me' },
|
|
{ 'filepath': 'bar', 'diagnostics': [ 'PLACEHOLDER2' ] },
|
|
{ 'message': 'A test file in a Command-T' },
|
|
{ 'filepath': 'baz', 'diagnostics': [ 'PLACEHOLDER3' ] },
|
|
{ 'message': 'On the second day of Christmas, my VimScript gave to me' },
|
|
{ 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER4' ] },
|
|
{ 'message': 'Two popup menus, and a test file in a Command-T' },
|
|
]
|
|
assert_that( _HandlePollResponse( messages, diagnostics_handler ),
|
|
equal_to( True ) )
|
|
diagnostics_handler.UpdateWithNewDiagnosticsForFile.assert_has_exact_calls( [
|
|
call ( 'foo', [ 'PLACEHOLDER1' ] ),
|
|
call ( 'bar', [ 'PLACEHOLDER2' ] ),
|
|
call ( 'baz', [ 'PLACEHOLDER3' ] ),
|
|
call ( 'foo', [ 'PLACEHOLDER4' ] )
|
|
] )
|
|
|
|
post_vim_message.assert_has_exact_calls( [
|
|
call( 'On the first day of Christmas, my VimScript gave to me',
|
|
warning=False,
|
|
truncate=True ),
|
|
call( 'A test file in a Command-T', warning=False, truncate=True ),
|
|
call( 'On the second day of Christmas, my VimScript gave to me',
|
|
warning=False,
|
|
truncate=True ),
|
|
call( 'Two popup menus, and a test file in a Command-T',
|
|
warning=False,
|
|
truncate=True ),
|
|
] )
|