From 19387b4716a03b3c097dc9f84c51a0a6a6dd93d4 Mon Sep 17 00:00:00 2001
From: Fendor <fendor@posteo.de>
Date: Tue, 10 Dec 2024 09:11:03 +0100
Subject: [PATCH] Expand documentation for 'CompletionResolveData'

Add explanations and justification for 'NothingToResolve' constructor.
Also, include historical note to explain how we end up with this
'CompletionResolveData' version.
---
 .../src/Development/IDE/Plugin/Completions.hs |  8 ++++++-
 .../IDE/Plugin/Completions/Types.hs           | 24 +++++++++++++++++++
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/ghcide/src/Development/IDE/Plugin/Completions.hs b/ghcide/src/Development/IDE/Plugin/Completions.hs
index 2482dc3903..903779b335 100644
--- a/ghcide/src/Development/IDE/Plugin/Completions.hs
+++ b/ghcide/src/Development/IDE/Plugin/Completions.hs
@@ -127,7 +127,13 @@ dropListFromImportDecl iDecl = let
     in f <$> iDecl
 
 resolveCompletion :: ResolveFunction IdeState CompletionResolveData Method_CompletionItemResolve
-resolveCompletion _ide _pid comp _uri NothingToResolve = pure comp
+resolveCompletion _ide _pid comp _uri NothingToResolve =
+  -- See docs of 'NothingToResolve' for the reasoning of this
+  -- NO-OP handler.
+  --
+  -- Handle "completion/resolve" requests, even when we don't want to add
+  -- any additional information to the 'CompletionItem'.
+  pure comp
 resolveCompletion ide _pid comp@CompletionItem{_detail,_documentation,_data_} uri (CompletionResolveData _ needType (NameDetails mod occ)) =
   do
     file <- getNormalizedFilePathE uri
diff --git a/ghcide/src/Development/IDE/Plugin/Completions/Types.hs b/ghcide/src/Development/IDE/Plugin/Completions/Types.hs
index ef0cb896b0..d0899943b4 100644
--- a/ghcide/src/Development/IDE/Plugin/Completions/Types.hs
+++ b/ghcide/src/Development/IDE/Plugin/Completions/Types.hs
@@ -207,6 +207,30 @@ data CompletionResolveData
     -- which present on some clients (e.g., emacs) as an error message.
     -- See https://github.com/haskell/haskell-language-server/issues/4451 for the issue that
     -- triggered this change.
+    --
+    -- Clients (i.e., VSCode) request completion items to be resolved if
+    -- we advertise capabilities for it.
+    -- However, HLS used to resolve completion items for only a subset of completion items,
+    -- and reject requests for which there is no additional info available,
+    -- e.g. function local variables don't have any docs or similar, so we didn't
+    -- respond to "completion/resolve" requests for these completion items.
+    -- We rejected these requests by *not* adding `_data_` (i.e., `_data_ = Nothing),
+    -- which caused HLS to reject "completion/resolve" requests, as we can only thread
+    -- requests to the appropriate plugin if this `_data_` field is populated and
+    -- can be deserialised.
+    -- Since this `_data_` was missing, we rejected the request with:
+    --
+    -- @
+    -- Error processing message (error "No plugins are available to handle this SMethod_CompletionItemResolve request.
+    --  Plugins installed for this method, but not available to handle this request are:
+    -- ghcide-completions does not handle resolve requests for (unable to determine resolve owner)).").
+    -- @
+    --
+    -- However, this proved to be annoying as some clients (i.e., emacs) display
+    -- our request rejection prominently in the user interface.
+    -- As this is annoying, we insert this "dummy" data 'NothingToResolve',
+    -- which allows HLS to thread the "completion/resolve" request to this plugin.
+    -- The plugin then simply returns the original 'CompletionItem',
   | CompletionResolveData
     -- ^ Data that we use to handle "completion/resolve" requests.
     { itemFile      :: Uri