set server and check client capabilities for commands and workspace edits

Author: davidsemakula

crates/lsp-server/src/dispatch.rs

@@ -95,13 +95,13 @@ impl<'a> Dispatcher<'a> {
 
         // Sends response (if any).
         if let Some(mut resp) = result {
-            // Intercept non-empty `createProject` responses and create the project as a workspace edit.
-            if let Some(project) = is_execute_command
-                .then_some(resp.result.as_ref())
-                .flatten()
-                .and_then(|value| {
-                    serde_json::from_value::<CreateProjectResponse>(value.clone()).ok()
-                })
+            // Intercept non-empty `createProject` responses and create the project as a workspace edit
+            // (only if the client supports the resource operations and document changes).
+            if let Some(project) = (is_execute_command
+                && utils::can_create_project_via_workspace_edit(&self.client_capabilities))
+            .then_some(resp.result.as_ref())
+            .flatten()
+            .and_then(|value| serde_json::from_value::<CreateProjectResponse>(value.clone()).ok())
             {
                 // Return an empty response.
                 resp.result = Some(serde_json::Value::Null);

crates/lsp-server/src/initialize.rs

@@ -87,6 +87,10 @@ pub fn server_capabilities(
             retrigger_characters: None,
             work_done_progress_options: Default::default(),
         }),
+        execute_command_provider: Some(lsp_types::ExecuteCommandOptions {
+            commands: vec!["createProject".to_string()],
+            work_done_progress_options: Default::default(),
+        }),
         ..Default::default()
     }
 }

crates/lsp-server/src/utils.rs

@@ -104,15 +104,32 @@ pub fn request_id_as_str(id: RequestId) -> Option<String> {
         .map(ToString::to_string)
 }
 
+/// Returns true if the LSP client advertises capabilities needed to create new projects via workspace edit, or false otherwise.
+pub fn can_create_project_via_workspace_edit(client_capabilities: &ClientCapabilities) -> bool {
+    client_capabilities.workspace.as_ref().map_or(false, |it| {
+        // Checks support for workspace/applyEdit requests.
+        it.apply_edit.unwrap_or(false)
+            && it.workspace_edit.as_ref().map_or(false, |it| {
+                // Checks support for versioned document changes.
+                it.document_changes.unwrap_or(false)
+                    // Checks support for create file operation.
+                    && it.resource_operations.as_ref().map_or(false, |it| {
+                        it.contains(&lsp_types::ResourceOperationKind::Create)
+                    })
+            })
+    })
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
     use crate::utils::{code_actions_kinds, position_encoding, SERVER_CODE_ACTION_KINDS};
     use lsp_types::{
         CodeActionClientCapabilities, CodeActionKindLiteralSupport, CodeActionLiteralSupport,
         CompletionClientCapabilities, CompletionItemCapability, GeneralClientCapabilities,
-        ParameterInformationSettings, SignatureHelpClientCapabilities,
-        SignatureInformationSettings, TextDocumentClientCapabilities,
+        ParameterInformationSettings, ResourceOperationKind, SignatureHelpClientCapabilities,
+        SignatureInformationSettings, TextDocumentClientCapabilities, WorkspaceClientCapabilities,
+        WorkspaceEditClientCapabilities,
     };
 
     fn config_with_encodings(encodings: Option<Vec<PositionEncodingKind>>) -> ClientCapabilities {
@@ -183,6 +200,25 @@ mod tests {
         }
     }
 
+    fn config_with_workspace_edit_capabilities(
+        apply_edit: Option<bool>,
+        document_changes: Option<bool>,
+        resource_operations: Option<Vec<ResourceOperationKind>>,
+    ) -> ClientCapabilities {
+        ClientCapabilities {
+            workspace: Some(WorkspaceClientCapabilities {
+                apply_edit,
+                workspace_edit: Some(WorkspaceEditClientCapabilities {
+                    document_changes,
+                    resource_operations,
+                    ..Default::default()
+                }),
+                ..Default::default()
+            }),
+            ..Default::default()
+        }
+    }
+
     #[test]
     fn position_encoding_works() {
         for (client_capabilities, expected_encoding) in [
@@ -366,4 +402,61 @@ mod tests {
             assert_eq!(signature_support(&client_capabilities), expected_result);
         }
     }
+
+    #[test]
+    fn can_create_project_via_workspace_edit_works() {
+        for (client_capabilities, expected_result) in [
+            // Default is `false`.
+            (ClientCapabilities::default(), false),
+            // None is `false`.
+            (
+                config_with_workspace_edit_capabilities(None, None, None),
+                false,
+            ),
+            // Partial support for some conditions fails.
+            (
+                config_with_workspace_edit_capabilities(Some(true), None, None),
+                false,
+            ),
+            (
+                config_with_workspace_edit_capabilities(None, Some(true), None),
+                false,
+            ),
+            (
+                config_with_workspace_edit_capabilities(
+                    None,
+                    None,
+                    Some(vec![ResourceOperationKind::Create]),
+                ),
+                false,
+            ),
+            (
+                config_with_workspace_edit_capabilities(
+                    Some(true),
+                    Some(true),
+                    // Missing create operation.
+                    Some(vec![
+                        ResourceOperationKind::Delete,
+                        ResourceOperationKind::Rename,
+                    ]),
+                ),
+                false,
+            ),
+            // Full support for all conditions works.
+            (
+                config_with_workspace_edit_capabilities(
+                    Some(true),
+                    Some(true),
+                    Some(vec![ResourceOperationKind::Create]),
+                ),
+                true,
+            ),
+        ] {
+            // Verifies the expected result based on client capabilities.
+            assert_eq!(
+                can_create_project_via_workspace_edit(&client_capabilities),
+                expected_result
+            );
+        }
+    }
 }

crates/test-utils/src/lib.rs

@@ -145,6 +145,19 @@ pub fn simple_client_config() -> lsp_types::ClientCapabilities {
             }),
             ..Default::default()
         }),
+        workspace: Some(lsp_types::WorkspaceClientCapabilities {
+            apply_edit: Some(true),
+            workspace_edit: Some(lsp_types::WorkspaceEditClientCapabilities {
+                document_changes: Some(true),
+                resource_operations: Some(vec![
+                    lsp_types::ResourceOperationKind::Create,
+                    lsp_types::ResourceOperationKind::Delete,
+                    lsp_types::ResourceOperationKind::Rename,
+                ]),
+                ..Default::default()
+            }),
+            ..Default::default()
+        }),
         ..Default::default()
     }
 }