[ty] Use bitflags for resolved client capabilities (#19393)

dhruvmanila · web-flow · commit c2a05b4825a5 · 2025-07-17T15:31:47.000+05:30
## Summary

This PR updates the `ResolvedClientCapabilities` to be represented as
`bitflags`. This allows us to remove the `Arc` as the type becomes copy.

Additionally, this PR also fixed the goto definition and declaration
code to use the `textDocument.definition.linkSupport` and
`textDocument.declaration.linkSupport` client capability.

This PR also removes the unused client capabilities which are
`code_action_deferred_edit_resolution`, `apply_edit`, and
`document_changes` which are all related to auto-fix ability.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/ty_server/Cargo.toml b/crates/ty_server/Cargo.toml
@@ -23,6 +23,7 @@ ty_python_semantic = { workspace = true }
 ty_vendored = { workspace = true }
 
 anyhow = { workspace = true }
+bitflags = { workspace = true }
 crossbeam = { workspace = true }
 jod-thread = { workspace = true }
 lsp-server = { workspace = true }
diff --git a/crates/ty_server/src/server/api/diagnostics.rs b/crates/ty_server/src/server/api/diagnostics.rs
@@ -64,7 +64,7 @@ pub(super) fn clear_diagnostics(key: &DocumentKey, client: &Client) {
 ///
 /// [publish diagnostics notification]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics
 pub(super) fn publish_diagnostics(session: &Session, key: &DocumentKey, client: &Client) {
-    if session.client_capabilities().pull_diagnostics {
+    if session.client_capabilities().supports_pull_diagnostics() {
         return;
     }
 
diff --git a/crates/ty_server/src/server/api/notifications/did_change_watched_files.rs b/crates/ty_server/src/server/api/notifications/did_change_watched_files.rs
@@ -96,7 +96,7 @@ impl SyncNotificationHandler for DidChangeWatchedFiles {
         let client_capabilities = session.client_capabilities();
 
         if project_changed {
-            if client_capabilities.diagnostics_refresh {
+            if client_capabilities.supports_workspace_diagnostic_refresh() {
                 client.send_request::<types::request::WorkspaceDiagnosticRefresh>(
                     session,
                     (),
@@ -111,7 +111,7 @@ impl SyncNotificationHandler for DidChangeWatchedFiles {
             // TODO: always publish diagnostics for notebook files (since they don't use pull diagnostics)
         }
 
-        if client_capabilities.inlay_refresh {
+        if client_capabilities.supports_inlay_hint_refresh() {
             client.send_request::<types::request::InlayHintRefreshRequest>(session, (), |_, ()| {});
         }
 
diff --git a/crates/ty_server/src/server/api/requests/goto_declaration.rs b/crates/ty_server/src/server/api/requests/goto_declaration.rs
@@ -52,7 +52,7 @@ impl BackgroundDocumentRequestHandler for GotoDeclarationRequestHandler {
 
         if snapshot
             .resolved_client_capabilities()
-            .type_definition_link_support
+            .supports_declaration_link()
         {
             let src = Some(ranged.range);
             let links: Vec<_> = ranged
diff --git a/crates/ty_server/src/server/api/requests/goto_definition.rs b/crates/ty_server/src/server/api/requests/goto_definition.rs
@@ -52,7 +52,7 @@ impl BackgroundDocumentRequestHandler for GotoDefinitionRequestHandler {
 
         if snapshot
             .resolved_client_capabilities()
-            .type_definition_link_support
+            .supports_definition_link()
         {
             let src = Some(ranged.range);
             let links: Vec<_> = ranged
diff --git a/crates/ty_server/src/server/api/requests/goto_type_definition.rs b/crates/ty_server/src/server/api/requests/goto_type_definition.rs
@@ -52,7 +52,7 @@ impl BackgroundDocumentRequestHandler for GotoTypeDefinitionRequestHandler {
 
         if snapshot
             .resolved_client_capabilities()
-            .type_definition_link_support
+            .supports_type_definition_link()
         {
             let src = Some(ranged.range);
             let links: Vec<_> = ranged
diff --git a/crates/ty_server/src/server/api/requests/hover.rs b/crates/ty_server/src/server/api/requests/hover.rs
@@ -52,7 +52,7 @@ impl BackgroundDocumentRequestHandler for HoverRequestHandler {
 
         let (markup_kind, lsp_markup_kind) = if snapshot
             .resolved_client_capabilities()
-            .hover_prefer_markdown
+            .prefers_markdown_in_hover()
         {
             (MarkupKind::Markdown, lsp_types::MarkupKind::Markdown)
         } else {
diff --git a/crates/ty_server/src/server/api/requests/semantic_tokens.rs b/crates/ty_server/src/server/api/requests/semantic_tokens.rs
@@ -41,7 +41,7 @@ impl BackgroundDocumentRequestHandler for SemanticTokensRequestHandler {
             snapshot.encoding(),
             snapshot
                 .resolved_client_capabilities()
-                .semantic_tokens_multiline_support,
+                .supports_multiline_semantic_tokens(),
         );
 
         Ok(Some(SemanticTokensResult::Tokens(SemanticTokens {
diff --git a/crates/ty_server/src/server/api/requests/semantic_tokens_range.rs b/crates/ty_server/src/server/api/requests/semantic_tokens_range.rs
@@ -51,7 +51,7 @@ impl BackgroundDocumentRequestHandler for SemanticTokensRangeRequestHandler {
             snapshot.encoding(),
             snapshot
                 .resolved_client_capabilities()
-                .semantic_tokens_multiline_support,
+                .supports_multiline_semantic_tokens(),
         );
 
         Ok(Some(SemanticTokensRangeResult::Tokens(SemanticTokens {
diff --git a/crates/ty_server/src/server/api/requests/signature_help.rs b/crates/ty_server/src/server/api/requests/signature_help.rs
@@ -71,7 +71,7 @@ impl BackgroundDocumentRequestHandler for SignatureHelpRequestHandler {
                     .parameters
                     .into_iter()
                     .map(|param| {
-                        let label = if resolved_capabilities.signature_label_offset_support {
+                        let label = if resolved_capabilities.supports_signature_label_offset() {
                             // Find the parameter's offset in the signature label
                             if let Some(start) = sig.label.find(&param.label) {
                                 let encoding = snapshot.encoding();
@@ -114,11 +114,12 @@ impl BackgroundDocumentRequestHandler for SignatureHelpRequestHandler {
                     })
                     .collect();
 
-                let active_parameter = if resolved_capabilities.signature_active_parameter_support {
-                    sig.active_parameter.and_then(|p| u32::try_from(p).ok())
-                } else {
-                    None
-                };
+                let active_parameter =
+                    if resolved_capabilities.supports_signature_active_parameter() {
+                        sig.active_parameter.and_then(|p| u32::try_from(p).ok())
+                    } else {
+                        None
+                    };
 
                 SignatureInformation {
                     label: sig.label,
diff --git a/crates/ty_server/src/session.rs b/crates/ty_server/src/session.rs
@@ -62,7 +62,7 @@ pub(crate) struct Session {
     position_encoding: PositionEncoding,
 
     /// Tracks what LSP features the client supports and doesn't support.
-    resolved_client_capabilities: Arc<ResolvedClientCapabilities>,
+    resolved_client_capabilities: ResolvedClientCapabilities,
 
     /// Tracks the pending requests between client and server.
     request_queue: RequestQueue,
@@ -94,9 +94,7 @@ impl Session {
             index: Some(index),
             default_project: DefaultProject::new(),
             projects: BTreeMap::new(),
-            resolved_client_capabilities: Arc::new(ResolvedClientCapabilities::new(
-                client_capabilities,
-            )),
+            resolved_client_capabilities: ResolvedClientCapabilities::new(client_capabilities),
             request_queue: RequestQueue::new(),
             shutdown_requested: false,
         })
@@ -332,7 +330,7 @@ impl Session {
     pub(crate) fn take_document_snapshot(&self, url: Url) -> DocumentSnapshot {
         let index = self.index();
         DocumentSnapshot {
-            resolved_client_capabilities: self.resolved_client_capabilities.clone(),
+            resolved_client_capabilities: self.resolved_client_capabilities,
             client_settings: index.global_settings(),
             position_encoding: self.position_encoding,
             document_query_result: self
@@ -432,8 +430,8 @@ impl Session {
         }
     }
 
-    pub(crate) fn client_capabilities(&self) -> &ResolvedClientCapabilities {
-        &self.resolved_client_capabilities
+    pub(crate) fn client_capabilities(&self) -> ResolvedClientCapabilities {
+        self.resolved_client_capabilities
     }
 
     pub(crate) fn global_settings(&self) -> Arc<ClientSettings> {
@@ -483,16 +481,16 @@ impl Drop for MutIndexGuard<'_> {
 /// An immutable snapshot of [`Session`] that references a specific document.
 #[derive(Debug)]
 pub(crate) struct DocumentSnapshot {
-    resolved_client_capabilities: Arc<ResolvedClientCapabilities>,
+    resolved_client_capabilities: ResolvedClientCapabilities,
     client_settings: Arc<ClientSettings>,
     position_encoding: PositionEncoding,
     document_query_result: Result<DocumentQuery, DocumentQueryError>,
 }
 
 impl DocumentSnapshot {
     /// Returns the resolved client capabilities that were captured during initialization.
-    pub(crate) fn resolved_client_capabilities(&self) -> &ResolvedClientCapabilities {
-        &self.resolved_client_capabilities
+    pub(crate) fn resolved_client_capabilities(&self) -> ResolvedClientCapabilities {
+        self.resolved_client_capabilities
     }
 
     /// Returns the position encoding that was negotiated during initialization.
diff --git a/crates/ty_server/src/session/capabilities.rs b/crates/ty_server/src/session/capabilities.rs

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ pub(super) fn clear_diagnostics(key: &DocumentKey, client: &Client) {`
`64`	`64`	`///`
`65`	`65`	`/// [publish diagnostics notification]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics`
`66`	`66`	`pub(super) fn publish_diagnostics(session: &Session, key: &DocumentKey, client: &Client) {`
`67`		`- if session.client_capabilities().pull_diagnostics {`
	`67`	`+ if session.client_capabilities().supports_pull_diagnostics() {`
`68`	`68`	`return;`
`69`	`69`	`}`
`70`	`70`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ impl SyncNotificationHandler for DidChangeWatchedFiles {`
`96`	`96`	`let client_capabilities = session.client_capabilities();`
`97`	`97`
`98`	`98`	`if project_changed {`
`99`		`- if client_capabilities.diagnostics_refresh {`
	`99`	`+ if client_capabilities.supports_workspace_diagnostic_refresh() {`
`100`	`100`	`client.send_request::<types::request::WorkspaceDiagnosticRefresh>(`
`101`	`101`	`session,`
`102`	`102`	`(),`
`@@ -111,7 +111,7 @@ impl SyncNotificationHandler for DidChangeWatchedFiles {`
`111`	`111`	`// TODO: always publish diagnostics for notebook files (since they don't use pull diagnostics)`
`112`	`112`	`}`
`113`	`113`
`114`		`- if client_capabilities.inlay_refresh {`
	`114`	`+ if client_capabilities.supports_inlay_hint_refresh() {`
`115`	`115`	`client.send_request::<types::request::InlayHintRefreshRequest>(session, (), \|_, ()\| {});`
`116`	`116`	`}`
`117`	`117`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ impl BackgroundDocumentRequestHandler for GotoDeclarationRequestHandler {`
`52`	`52`
`53`	`53`	`if snapshot`
`54`	`54`	`.resolved_client_capabilities()`
`55`		`- .type_definition_link_support`
	`55`	`+ .supports_declaration_link()`
`56`	`56`	`{`
`57`	`57`	`let src = Some(ranged.range);`
`58`	`58`	`let links: Vec<_> = ranged`