Merge pull request #1731 from bstaletic/workspace-dirs

[READY] Add support for didChangeWorkspaceFolders

Author: mergify[bot]

README.md

@@ -285,6 +285,8 @@ wouldn't usually know about. The value is a list of dictionaries containing:
 - `capabilities'`: Overrides the default LSP capabilities of ycmd.
   - If you enable `workspace/configuration` support, check the extra conf
     details, relevant to LSP servers.
+- `additional_workspace_dirs`: Specifies statically known workspaces that should
+  be open on LSP server startup.
 - `triggerCharacters`: Override the LSP server's trigger characters for
   completion. This can be useful when the server obnoxiously requests completion
   on every character or for example on whitespace characters.

ycmd/completers/java/java_completer.py

@@ -358,9 +358,6 @@ def GetCustomSubcommands( self ):
       'OrganizeImports': (
         lambda self, request_data, args: self.OrganizeImports( request_data )
       ),
-      'OpenProject': (
-        lambda self, request_data, args: self._OpenProject( request_data, args )
-      ),
       'WipeWorkspace': (
         lambda self, request_data, args: self._WipeWorkspace( request_data,
                                                               args )
@@ -404,6 +401,10 @@ def GetProjectDirectory( self, *args, **kwargs ):
     return self._java_project_dir
 
 
+  def GetWorkspaceForFilepath( self, filepath ):
+    return _FindProjectDir( os.path.dirname( filepath ) )
+
+
   def _WipeWorkspace( self, request_data, args ):
     with_config = False
     if len( args ) > 0 and '--with-config' in args:
@@ -414,25 +415,6 @@ def _WipeWorkspace( self, request_data, args ):
                          wipe_config = with_config )
 
 
-  def _OpenProject( self, request_data, args ):
-    if len( args ) != 1:
-      raise ValueError( "Usage: OpenProject <project directory>" )
-
-    project_directory = args[ 0 ]
-
-    # If the dir is not absolute, calculate it relative to the working dir of
-    # the client (if supplied).
-    if not os.path.isabs( project_directory ):
-      if 'working_dir' not in request_data:
-        raise ValueError( "Project directory must be absolute" )
-
-      project_directory = os.path.normpath( os.path.join(
-        request_data[ 'working_dir' ],
-        project_directory ) )
-
-    self._RestartServer( request_data, project_directory = project_directory )
-
-
   def _Reset( self ):
     if self._workspace_path and self._use_clean_workspace:
       try:

ycmd/completers/language_server/language_server_completer.py

@@ -620,7 +620,7 @@ def _ServerToClientRequest( self, request ):
       elif method == 'workspace/workspaceFolders':
         self.SendResponse(
           lsp.Accept( request,
-                      lsp.WorkspaceFolders( self._project_directory ) ) )
+                      lsp.WorkspaceFolders( *self._server_workspace_dirs ) ) )
       else: # method unknown - reject
         self.SendResponse( lsp.Reject( request, lsp.Errors.MethodNotFound ) )
       return
@@ -890,6 +890,7 @@ class LanguageServerCompleter( Completer ):
       - ConvertNotificationToMessage
       - GetCompleterName
       - GetProjectDirectory
+      - GetWorkspaceForFilepath
       - GetProjectRootFiles
       - GetTriggerCharacters
       - GetDefaultNotificationHandler
@@ -1043,12 +1044,14 @@ def ServerReset( self ):
     self._initialize_event = threading.Event()
     self._on_initialize_complete_handlers = []
     self._server_capabilities = None
+    self._workspace_notification_supported = False
     self._is_completion_provider = False
     self._resolve_completion_items = False
     self._project_directory = None
     self._settings = {}
     self._extra_conf_dir = None
     self._semantic_token_atlas = None
+    self._server_workspace_dirs = set()
 
 
   def GetCompleterName( self ):
@@ -1076,6 +1079,7 @@ def _StartServerNoLock( self, request_data ):
                  self.GetCommandLine() )
 
     self._project_directory = self.GetProjectDirectory( request_data )
+    self._server_workspace_dirs.add( self._project_directory )
 
     if self._connection_type == 'tcp':
       if self.GetCommandLine():
@@ -2147,6 +2151,14 @@ def _RefreshFileContentsUnderLock( self, file_name, contents, file_types ):
                   action )
 
     if action == lsp.ServerFileState.OPEN_FILE:
+      # First check if we need to inform the server of a new workspace.
+      if self._workspace_notification_supported:
+        workspace_for_file = self.GetWorkspaceForFilepath( file_name )
+        if workspace_for_file not in self._server_workspace_dirs:
+          self._server_workspace_dirs.add( workspace_for_file )
+          msg = lsp.DidChangeWorkspaceFolders( workspace_for_file )
+          self.GetConnection().SendNotification( msg )
+
       msg = lsp.DidOpenTextDocument( file_state, file_types, contents )
 
       self.GetConnection().SendNotification( msg )
@@ -2283,7 +2295,7 @@ def GetProjectDirectory( self, request_data ):
       - If the user specified 'project_directory' in their extra conf
         'Settings', use that.
       - try to find files from GetProjectRootFiles and use the
-        first directory from there
+        first directory from there. (From GetWorkspaceForFilepath)
       - if there's an extra_conf file, use that directory
       - otherwise if we know the client's cwd, use that
       - otherwise use the directory of the file that we just opened
@@ -2298,20 +2310,36 @@ def GetProjectDirectory( self, request_data ):
       return utils.AbsolutePath( self._settings[ 'project_directory' ],
                                   self._extra_conf_dir )
 
-    project_root_files = self.GetProjectRootFiles()
-    if project_root_files:
-      for folder in utils.PathsToAllParentFolders( request_data[ 'filepath' ] ):
-        for root_file in project_root_files:
-          if os.path.isfile( os.path.join( folder, root_file ) ):
-            return folder
+    filepath = request_data[ 'filepath' ]
+    workspace_path = self.GetWorkspaceForFilepath( filepath, strict = True )
+    if workspace_path:
+      return workspace_path
 
     if self._extra_conf_dir:
       return self._extra_conf_dir
 
     if 'working_dir' in request_data:
       return request_data[ 'working_dir' ]
 
-    return os.path.dirname( request_data[ 'filepath' ] )
+    return os.path.dirname( filepath )
+
+
+  def GetWorkspaceForFilepath( self, filepath, strict = False ):
+    """Return the workspace of the provided filepath. This could be a subproject
+    or a completely unrelated project to the root directory.
+    Like GetProjectDirectory, can be overridden by a concrete LSP completer.
+    By default we try to find the first parent directory that contains any file
+    mentioned in GetProjectRootFiles().
+    `strict` function argument was useful for allowing GetProjectDirectory to
+    reuse this implementation.
+    """
+    project_root_files = self.GetProjectRootFiles()
+    if project_root_files:
+      for folder in utils.PathsToAllParentFolders( filepath ):
+        for root_file in project_root_files:
+          if os.path.isfile( os.path.join( folder, root_file ) ):
+            return folder
+    return None if strict else os.path.dirname( filepath )
 
 
   def _SendInitialize( self, request_data ):
@@ -2333,10 +2361,15 @@ def _SendInitialize( self, request_data ):
       # the settings on the Initialize request are somehow subtly different from
       # the settings supplied in didChangeConfiguration, though it's not exactly
       # clear how/where that is specified.
+      additional_workspace_dirs = self._settings.get(
+                                    'additional_workspace_dirs',
+                                    [] )
+      self._server_workspace_dirs.update( additional_workspace_dirs )
       msg = lsp.Initialize( request_id,
                             self._project_directory,
                             self.ExtraCapabilities(),
-                            self._settings.get( 'ls', {} ) )
+                            self._settings.get( 'ls', {} ),
+                            additional_workspace_dirs )
 
       def response_handler( response, message ):
         if message is None:
@@ -2382,6 +2415,9 @@ def _HandleInitializeInPollThread( self, response ):
     when the initialize request receives a response."""
     with self._server_info_mutex:
       self._server_capabilities = response[ 'result' ][ 'capabilities' ]
+      self._workspace_notification_supported = (
+        _ServerSupportsWorkspaceFoldersChangeNotif(
+          self._server_capabilities ) )
       self._resolve_completion_items = self._ShouldResolveCompletionItems()
 
       if self._resolve_completion_items:
@@ -2925,6 +2961,8 @@ def ServerStateDescription():
                                       ServerStateDescription() ),
              responses.DebugInfoItem( 'Project Directory',
                                       self._project_directory ),
+             responses.DebugInfoItem( 'Open Workspaces',
+                                      self._server_workspace_dirs ),
              responses.DebugInfoItem(
                'Settings',
                json.dumps( self._settings.get( 'ls', {} ),
@@ -3565,6 +3603,12 @@ def DecodeModifiers( self, tokenModifiers ):
   return tokens
 
 
+def _ServerSupportsWorkspaceFoldersChangeNotif( server_capabilities ):
+  workspace = server_capabilities.get( 'workspace', {} )
+  workspace_folders = workspace.get( 'workspaceFolders', {} )
+  return _IsCapabilityProvided( workspace_folders, 'changeNotifications' )
+
+
 def _IsCapabilityProvided( capabilities, query ):
   capability = capabilities.get( query )
   return bool( capability ) or capability == {}

ycmd/completers/language_server/language_server_protocol.py

@@ -294,7 +294,11 @@ def BuildResponse( request, parameters ):
   return _BuildMessageData( message )
 
 
-def Initialize( request_id, project_directory, extra_capabilities, settings ):
+def Initialize( request_id,
+                project_directory,
+                extra_capabilities,
+                settings,
+                workspaces ):
   """Build the Language Server initialize request"""
 
   capabilities = {
@@ -393,7 +397,7 @@ def Initialize( request_id, project_directory, extra_capabilities, settings ):
     'rootUri': FilePathToUri( project_directory ),
     'initializationOptions': settings,
     'capabilities': UpdateDict( capabilities, extra_capabilities ),
-    'workspaceFolders': WorkspaceFolders( project_directory ),
+    'workspaceFolders': WorkspaceFolders( *workspaces ),
   } )
 
 
@@ -447,6 +451,15 @@ def ApplyEditResponse( request, applied ):
   return Accept( request, msg )
 
 
+def DidChangeWorkspaceFolders( new_folder ):
+  return BuildNotification( 'workspace/didChangeWorkspaceFolders', {
+    'event': {
+      'removed': [],
+      'added': WorkspaceFolders( new_folder )
+    }
+  } )
+
+
 def DidChangeWatchedFiles( path, kind ):
   return BuildNotification( 'workspace/didChangeWatchedFiles', {
     'changes': [ {

ycmd/tests/clangd/debug_info_test.py

@@ -58,6 +58,10 @@ def test_DebugInfo_NotInitialized( self, app ):
               'key': 'Project Directory',
               'value': None,
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',
@@ -95,6 +99,10 @@ def test_DebugInfo_Initialized( self, app ):
               'key': 'Project Directory',
               'value': PathToTestFile(),
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',
@@ -134,6 +142,10 @@ def test_DebugInfo_ExtraConf_ReturningFlags( self, app ):
               'key': 'Project Directory',
               'value': PathToTestFile( 'extra_conf' ),
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',
@@ -174,6 +186,10 @@ def test_DebugInfo_ExtraConf_NotReturningFlags( self, app ):
               'key': 'Project Directory',
               'value': PathToTestFile( 'extra_conf' ),
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',
@@ -216,6 +232,10 @@ def test_DebugInfo_ExtraConf_Global( self, app ):
               'key': 'Project Directory',
               'value': PathToTestFile(),
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',
@@ -259,6 +279,10 @@ def test_DebugInfo_ExtraConf_LocalOverGlobal( self, app ):
               'key': 'Project Directory',
               'value': PathToTestFile( 'extra_conf' ),
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',
@@ -308,6 +332,10 @@ def test_DebugInfo_ExtraConf_Database( self, app ):
                   'key': 'Project Directory',
                   'value': tmp_dir,
                 } ),
+                has_entries( {
+                  'key': 'Open Workspaces',
+                  'value': has_items()
+                } ),
                 has_entries( {
                   'key': 'Settings',
                   'value': '{}',
@@ -365,6 +393,10 @@ def Settings( **kwargs ):
                     'key': 'Project Directory',
                     'value': tmp_dir,
                   } ),
+                  has_entries( {
+                    'key': 'Open Workspaces',
+                    'value': has_items()
+                  } ),
                   has_entries( {
                     'key': 'Settings',
                     'value': '{}',
@@ -419,6 +451,10 @@ def test_DebugInfo_ExtraConf_UseDatabaseOverGlobal( self, app ):
                   'key': 'Project Directory',
                   'value': tmp_dir,
                 } ),
+                has_entries( {
+                  'key': 'Open Workspaces',
+                  'value': has_items()
+                } ),
                 has_entries( {
                   'key': 'Settings',
                   'value': '{}',
@@ -459,6 +495,10 @@ def test_DebugInfo_ExtraConf_MacIncludeFlags( self, app ):
               'key': 'Project Directory',
               'value': PathToTestFile( 'extra_conf' ),
             } ),
+            has_entries( {
+              'key': 'Open Workspaces',
+              'value': has_items()
+            } ),
             has_entries( {
               'key': 'Settings',
               'value': '{}',

ycmd/tests/go/__init__.py

@@ -73,7 +73,7 @@ def Wrapper( test_case_instance, *args, **kwargs ):
   return Decorator
 
 
-def PathToTestFile( *args ):
+def PathToTestFile( *args, module_dir = 'go_module' ):
   dir_of_current_script = os.path.dirname( os.path.abspath( __file__ ) )
   # GOPLS doesn't work if any parent directory is named "testdata"
-  return os.path.join( dir_of_current_script, 'go_module', *args )
+  return os.path.join( dir_of_current_script, module_dir, *args )