Improve visibility of wrong configuration

Author: Felixoid

ycmd/completers/language_server/language_server_completer.py

@@ -1029,6 +1029,9 @@ def __init__( self, user_options, connection_type = 'stdio' ):
     self._stderr_file = None
     self._server_started = False
 
+    # Store configuration warnings to show in debug_info
+    self._config_warnings = []
+
     self._Reset()
 
 
@@ -1926,11 +1929,11 @@ def _GetSettingsFromExtraConf( self, request_data ):
     matched_keys = [ key for key in lookup_keys if key in completer_settings ]
     if matched_keys:
       if len( matched_keys ) > 1:
-        LOGGER.warning( 'Multiple settings found for %s completer: %s. '
-                       'Using first match %r. Please provide only one key.',
-                       self.GetServerName(),
-                       matched_keys,
-                       matched_keys[ 0 ] )
+        warning_msg = ( f'Multiple settings found for {self.GetServerName()} '
+                       f'completer: {matched_keys}. Using first match '
+                       f'{matched_keys[ 0 ]!r}. Please provide only one key.' )
+        LOGGER.warning( warning_msg )
+        self._config_warnings.append( warning_msg )
 
       # Use first match
       global_settings = completer_settings[ matched_keys[ 0 ] ]
@@ -3174,7 +3177,7 @@ def ServerStateDescription():
 
       return 'Initialized'
 
-    return [ responses.DebugInfoItem( 'Server State',
+    items = [ responses.DebugInfoItem( 'Server State',
                                       ServerStateDescription() ),
              responses.DebugInfoItem( 'Project Directory',
                                       self._project_directory ),
@@ -3187,6 +3190,15 @@ def ServerStateDescription():
                            sort_keys = True ) ) ]
 
 
+    # Add configuration warnings if any exist
+    if self._config_warnings:
+      items.append( responses.DebugInfoItem(
+        'Configuration Warnings',
+        '\n'.join( self._config_warnings ) ) )
+
+    return items
+
+
 def _DistanceOfPointToRange( point, range ):
   """Calculate the distance from a point to a range.
 

ycmd/tests/language_server/language_server_completer_test.py

@@ -20,9 +20,11 @@
 from hamcrest import ( all_of,
                        assert_that,
                        calling,
+                       contains_string,
                        empty,
                        ends_with,
                        equal_to,
+                       has_length,
                        instance_of,
                        contains_exactly,
                        has_entries,
@@ -1632,6 +1634,7 @@ def test_GetSettingsFromExtraConf_WithCompleterSettings_PrimaryKey( self,
                  } ) )
 
 
+
   @IsolatedYcmd( {
     'completer_settings': {
       'test-server': {
@@ -1679,6 +1682,19 @@ def test_GetSettingsFromExtraConf_WithDuplicateKeys_UsesFirst( self, app ):
 
       # Should have logged warning
       assert_that( logger.warning.called )
+      # Get debug items
+      debug_items = completer.CommonDebugItems()
+
+      # Check that warning is in debug info
+      warning_items = [ item for item in debug_items
+                      if item.key == 'Configuration Warnings' ]
+      assert_that( warning_items, has_length( 1 ) )
+      assert_that( warning_items[ 0 ].value,
+                  contains_string( 'Multiple settings found' ) )
+      assert_that( warning_items[ 0 ].value,
+                  contains_string( 'test' ) )
+      assert_that( warning_items[ 0 ].value,
+                    contains_string( 'test-server' ) )
 
 
   @IsolatedYcmd( {