Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always handle "completion/resolve" requests #4463

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ghcide/src/Development/IDE/Plugin/Completions.hs
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,13 @@ dropListFromImportDecl iDecl = let
in f <$> iDecl

resolveCompletion :: ResolveFunction IdeState CompletionResolveData Method_CompletionItemResolve
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
Expand Down
6 changes: 4 additions & 2 deletions ghcide/src/Development/IDE/Plugin/Completions/Logic.hs
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,9 @@ mkCompl
_additionalTextEdits = Nothing,
_commitCharacters = Nothing,
_command = mbCommand,
_data_ = toJSON <$> fmap (CompletionResolveData uri (isNothing typeText)) nameDetails,
_data_ = Just $ toJSON $ case nameDetails of
Nothing -> NothingToResolve
Just nameDets -> CompletionResolveData uri (isNothing typeText) nameDets,
_labelDetails = Nothing,
_textEditText = Nothing}
removeSnippetsWhen (isJust isInfix) ci
Expand Down Expand Up @@ -309,7 +311,7 @@ mkExtCompl label =
defaultCompletionItemWithLabel :: T.Text -> CompletionItem
defaultCompletionItemWithLabel label =
CompletionItem label def def def def def def def def def
def def def def def def def def def
def def def def def def def def (Just $ toJSON NothingToResolve)

fromIdentInfo :: Uri -> IdentInfo -> Maybe T.Text -> CompItem
fromIdentInfo doc identInfo@IdentInfo{..} q = CI
Expand Down
43 changes: 38 additions & 5 deletions ghcide/src/Development/IDE/Plugin/Completions/Types.hs
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,43 @@ instance Show NameDetails where
-- | The data that is actually sent for resolve support
-- We need the URI to be able to reconstruct the GHC environment
-- in the file the completion was triggered in.
data CompletionResolveData = CompletionResolveData
{ itemFile :: Uri
, itemNeedsType :: Bool -- ^ Do we need to lookup a type for this item?
, itemName :: NameDetails
}
data CompletionResolveData
= NothingToResolve
-- ^ The client requested to resolve a completion, but there is nothing to resolve,
-- as we can't add any additional information, such as docs.
-- We still handle these requests, otherwise HLS will reject "completion/resolve" requests
-- 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
, itemNeedsType :: Bool -- ^ Do we need to lookup a type for this item?
, itemName :: NameDetails
}
deriving stock Generic
deriving anyclass (FromJSON, ToJSON)
19 changes: 12 additions & 7 deletions ghcide/test/exe/CompletionTests.hs
Original file line number Diff line number Diff line change
Expand Up @@ -557,19 +557,24 @@ completionDocTests =
]
let expected = "*Imported from 'Prelude'*\n"
test doc (Position 1 7) "id" (Just $ T.length expected) [expected]
, testSessionEmpty "defined in where clause" $ do
doc <- createDoc "A.hs" "haskell" $ T.unlines
[ "module A where"
, "bar = foo"
, " where foobar = 5"
]
let expected = "*Defined at line 3, column"
test doc (Position 1 9) "foobar" (Just $ T.length expected) [expected]
]
where
test doc pos label mn expected = do
_ <- waitForDiagnostics
compls <- getCompletions doc pos
rcompls <- forM compls $ \item -> do
if isJust (item ^. L.data_)
then do
rsp <- request SMethod_CompletionItemResolve item
case rsp ^. L.result of
Left err -> liftIO $ assertFailure ("completionItem/resolve failed with: " <> show err)
Right x -> pure x
else pure item
rsp <- request SMethod_CompletionItemResolve item
case rsp ^. L.result of
Left err -> liftIO $ assertFailure ("completionItem/resolve failed with: " <> show err)
Right x -> pure x
let compls' = [
-- We ignore doc uris since it points to the local path which determined by specific machines
case mn of
Expand Down
Loading