Add server cancellation support to pull diagnostic handler

This commit is contained in:
Lukas Wirth 2024-10-25 07:39:28 +02:00
parent 1613548cdb
commit bf77cf7f90
2 changed files with 45 additions and 14 deletions

View File

@ -5,7 +5,7 @@
};
use ide::Cancelled;
use lsp_server::ExtractError;
use lsp_server::{ExtractError, Response, ResponseError};
use serde::{de::DeserializeOwned, Serialize};
use stdx::thread::ThreadIntent;
@ -117,15 +117,20 @@ pub(crate) fn on<const ALLOW_RETRYING: bool, R>(
}
return self;
}
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(ThreadIntent::Worker, f)
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(
ThreadIntent::Worker,
f,
Self::content_modified_error,
)
}
/// Dispatches a non-latency-sensitive request onto the thread pool. When the VFS is marked not
/// ready this will return a `default` constructed [`R::Result`].
pub(crate) fn on_with<const ALLOW_RETRYING: bool, R>(
pub(crate) fn on_with<R>(
&mut self,
f: fn(GlobalStateSnapshot, R::Params) -> anyhow::Result<R::Result>,
default: impl FnOnce() -> R::Result,
on_cancelled: fn() -> ResponseError,
) -> &mut Self
where
R: lsp_types::request::Request<
@ -141,7 +146,7 @@ pub(crate) fn on_with<const ALLOW_RETRYING: bool, R>(
}
return self;
}
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(ThreadIntent::Worker, f)
self.on_with_thread_intent::<true, false, R>(ThreadIntent::Worker, f, on_cancelled)
}
/// Dispatches a non-latency-sensitive request onto the thread pool. When the VFS is marked not
@ -160,7 +165,11 @@ pub(crate) fn on_identity<const ALLOW_RETRYING: bool, R, Params>(
}
return self;
}
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(ThreadIntent::Worker, f)
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(
ThreadIntent::Worker,
f,
Self::content_modified_error,
)
}
/// Dispatches a latency-sensitive request onto the thread pool. When the VFS is marked not
@ -183,7 +192,11 @@ pub(crate) fn on_latency_sensitive<const ALLOW_RETRYING: bool, R>(
}
return self;
}
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(ThreadIntent::LatencySensitive, f)
self.on_with_thread_intent::<true, ALLOW_RETRYING, R>(
ThreadIntent::LatencySensitive,
f,
Self::content_modified_error,
)
}
/// Formatting requests should never block on waiting a for task thread to open up, editors will wait
@ -198,7 +211,11 @@ pub(crate) fn on_fmt_thread<R>(
R::Params: DeserializeOwned + panic::UnwindSafe + Send + fmt::Debug,
R::Result: Serialize,
{
self.on_with_thread_intent::<false, false, R>(ThreadIntent::LatencySensitive, f)
self.on_with_thread_intent::<false, false, R>(
ThreadIntent::LatencySensitive,
f,
Self::content_modified_error,
)
}
pub(crate) fn finish(&mut self) {
@ -217,6 +234,7 @@ fn on_with_thread_intent<const MAIN_POOL: bool, const ALLOW_RETRYING: bool, R>(
&mut self,
intent: ThreadIntent,
f: fn(GlobalStateSnapshot, R::Params) -> anyhow::Result<R::Result>,
on_cancelled: fn() -> ResponseError,
) -> &mut Self
where
R: lsp_types::request::Request + 'static,
@ -245,11 +263,10 @@ fn on_with_thread_intent<const MAIN_POOL: bool, const ALLOW_RETRYING: bool, R>(
match thread_result_to_response::<R>(req.id.clone(), result) {
Ok(response) => Task::Response(response),
Err(_cancelled) if ALLOW_RETRYING => Task::Retry(req),
Err(_cancelled) => Task::Response(lsp_server::Response::new_err(
req.id,
lsp_server::ErrorCode::ContentModified as i32,
"content modified".to_owned(),
)),
Err(_cancelled) => {
let error = on_cancelled();
Task::Response(Response { id: req.id, result: None, error: Some(error) })
}
}
});
@ -280,6 +297,14 @@ fn parse<R>(&mut self) -> Option<(lsp_server::Request, R::Params, String)>
}
}
}
fn content_modified_error() -> ResponseError {
ResponseError {
code: lsp_server::ErrorCode::ContentModified as i32,
message: "content modified".to_owned(),
data: None,
}
}
}
fn thread_result_to_response<R>(

View File

@ -1092,7 +1092,7 @@ fn on_request(&mut self, req: Request) {
.on_latency_sensitive::<NO_RETRY, lsp_request::SemanticTokensRangeRequest>(handlers::handle_semantic_tokens_range)
// FIXME: Some of these NO_RETRY could be retries if the file they are interested didn't change.
// All other request handlers
.on_with::<NO_RETRY, lsp_request::DocumentDiagnosticRequest>(handlers::handle_document_diagnostics, || lsp_types::DocumentDiagnosticReportResult::Report(
.on_with::<lsp_request::DocumentDiagnosticRequest>(handlers::handle_document_diagnostics, || lsp_types::DocumentDiagnosticReportResult::Report(
lsp_types::DocumentDiagnosticReport::Full(
lsp_types::RelatedFullDocumentDiagnosticReport {
related_documents: None,
@ -1102,7 +1102,13 @@ fn on_request(&mut self, req: Request) {
},
},
),
))
), || lsp_server::ResponseError {
code: lsp_server::ErrorCode::ServerCancelled as i32,
message: "server cancelled the request".to_owned(),
data: serde_json::to_value(lsp_types::DiagnosticServerCancellationData {
retrigger_request: true
}).ok(),
})
.on::<RETRY, lsp_request::DocumentSymbolRequest>(handlers::handle_document_symbol)
.on::<RETRY, lsp_request::FoldingRangeRequest>(handlers::handle_folding_range)
.on::<NO_RETRY, lsp_request::SignatureHelpRequest>(handlers::handle_signature_help)