Catch exceptions in commands and use lsp null

ghcide/src/Development/IDE/Plugin/HLS.hs

@@ -92,6 +92,10 @@ failedToParseArgs (CommandId com) (PluginId pid) err arg =
     "Error while parsing args for " <> com <> " in plugin " <> pid <> ": "
         <> T.pack err <> ", arg = " <> T.pack (show arg)
 
+exceptionInPlugin :: PluginId -> SMethod m -> SomeException -> Text
+exceptionInPlugin plId method exception =
+    "Exception in plugin " <> T.pack (show plId) <> " while processing "<> T.pack (show method) <> ": " <> T.pack (show exception)
+
 -- | Build a ResponseError and log it before returning to the caller
 logAndReturnError :: Recorder (WithPriority Log) -> PluginId -> (LSPErrorCodes |? ErrorCodes) -> Text -> LSP.LspT Config IO (Either ResponseError a)
 logAndReturnError recorder p errCode msg = do
@@ -177,9 +181,9 @@ executeCommandHandlers recorder ecs = requestHandler SMethod_WorkspaceExecuteCom
                 -- If we have a command, continue to execute it
                 Just (Command _ innerCmdId innerArgs)
                     -> execCmd ide (ExecuteCommandParams Nothing innerCmdId innerArgs)
-                Nothing -> return $ Right $ InL A.Null
+                Nothing -> return $ Right $ InR Null
 
-            A.Error _str -> return $ Right $ InL A.Null
+            A.Error _str -> return $ Right $ InR Null
 
         -- Just an ordinary HIE command
         Just (plugin, cmd) -> runPluginCommand ide plugin cmd cmdParams
@@ -197,7 +201,9 @@ executeCommandHandlers recorder ecs = requestHandler SMethod_WorkspaceExecuteCom
           Nothing -> logAndReturnError recorder p (InR ErrorCodes_InvalidRequest) (commandDoesntExist com p xs)
           Just (PluginCommand _ _ f) -> case A.fromJSON arg of
             A.Error err -> logAndReturnError recorder p (InR ErrorCodes_InvalidParams) (failedToParseArgs com p err arg)
-            A.Success a -> fmap InL <$> f ide a
+            A.Success a ->
+                f ide a `catchAny`
+                (\e -> pure $ Left $ ResponseError (InR ErrorCodes_InternalError) (exceptionInPlugin p SMethod_WorkspaceApplyEdit e) Nothing)
 
 -- ---------------------------------------------------------------------
 
@@ -225,9 +231,8 @@ extensiblePlugins recorder xs = mempty { P.pluginHandlers = handlers }
                 msg = pluginNotEnabled m fs'
             return $ Left err
           Just fs -> do
-            let msg e pid = "Exception in plugin " <> T.pack (show pid) <> " while processing " <> T.pack (show m) <> ": " <> T.pack (show e)
-                handlers = fmap (\(plid,_,handler) -> (plid,handler)) fs
-            es <- runConcurrently msg (show m) handlers ide params
+            let  handlers = fmap (\(plid,_,handler) -> (plid,handler)) fs
+            es <- runConcurrently exceptionInPlugin m handlers ide params
 
             let (errs,succs) = partitionEithers $ toList $ join $ NE.zipWith (\(pId,_) -> fmap (first (pId,))) handlers es
             unless (null errs) $ forM_ errs $ \(pId, err) ->
@@ -267,16 +272,16 @@ extensibleNotificationPlugins recorder xs = mempty { P.pluginHandlers = handlers
 
 runConcurrently
   :: MonadUnliftIO m
-  => (SomeException -> PluginId -> T.Text)
-  -> String -- ^ label
+  => (PluginId -> SMethod method -> SomeException -> T.Text)
+  -> SMethod method -- ^ label
   -> NonEmpty (PluginId, a -> b -> m (NonEmpty (Either ResponseError d)))
   -- ^ Enabled plugin actions that we are allowed to run
   -> a
   -> b
   -> m (NonEmpty(NonEmpty (Either ResponseError d)))
-runConcurrently msg method fs a b = forConcurrently fs $ \(pid,f) -> otTracedProvider pid (fromString method) $ do
+runConcurrently msg method fs a b = forConcurrently fs $ \(pid,f) -> otTracedProvider pid (fromString (show method)) $ do
   f a b
-     `catchAny` (\e -> pure $ pure $ Left $ ResponseError (InR ErrorCodes_InternalError) (msg e pid) Nothing)
+     `catchAny` (\e -> pure $ pure $ Left $ ResponseError (InR ErrorCodes_InternalError) (msg pid method e) Nothing)
 
 combineErrors :: [ResponseError] -> ResponseError
 combineErrors [x] = x

ghcide/src/Development/IDE/Plugin/Test.hs

@@ -16,8 +16,9 @@ import           Control.Concurrent                   (threadDelay)
 import           Control.Monad
 import           Control.Monad.IO.Class
 import           Control.Monad.STM
-import           Data.Aeson
-import           Data.Aeson.Types
+import           Data.Aeson                           (FromJSON (parseJSON),
+                                                       ToJSON (toJSON), Value)
+import qualified Data.Aeson.Types                     as A
 import           Data.Bifunctor
 import           Data.CaseInsensitive                 (CI, original)
 import qualified Data.HashMap.Strict                  as HM
@@ -46,7 +47,7 @@ import           GHC.Generics                         (Generic)
 import           Ide.Plugin.Config                    (CheckParents)
 import           Ide.Types
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types          hiding (Null)
+import           Language.LSP.Protocol.Types
 import qualified Language.LSP.Server                  as LSP
 import qualified "list-t" ListT
 import qualified StmContainers.Map                    as STM
@@ -80,7 +81,7 @@ plugin = (defaultPluginDescriptor "test") {
     }
   where
       testRequestHandler' ide req
-        | Just customReq <- parseMaybe parseJSON req
+        | Just customReq <- A.parseMaybe parseJSON req
         = testRequestHandler ide customReq
         | otherwise
         = return $ Left
@@ -94,7 +95,7 @@ testRequestHandler _ (BlockSeconds secs) = do
     LSP.sendNotification (SMethod_CustomMethod (Proxy @"ghcide/blocking/request")) $
       toJSON secs
     liftIO $ sleep secs
-    return (Right Null)
+    return (Right A.Null)
 testRequestHandler s (GetInterfaceFilesDir file) = liftIO $ do
     let nfp = fromUri $ toNormalizedUri file
     sess <- runAction "Test - GhcSession" s $ use_ GhcSession nfp
@@ -107,7 +108,7 @@ testRequestHandler s WaitForShakeQueue = liftIO $ do
     atomically $ do
         n <- countQueue $ actionQueue $ shakeExtras s
         when (n>0) retry
-    return $ Right Null
+    return $ Right A.Null
 testRequestHandler s (WaitForIdeRule k file) = liftIO $ do
     let nfp = fromUri $ toNormalizedUri file
     success <- runAction ("WaitForIdeRule " <> k <> " " <> show file) s $ parseAction (fromString k) nfp
@@ -172,6 +173,6 @@ blockCommandDescriptor plId = (defaultPluginDescriptor plId) {
 
 blockCommandHandler :: CommandFunction state ExecuteCommandParams
 blockCommandHandler _ideState _params = do
-  LSP.sendNotification (SMethod_CustomMethod (Proxy @"ghcide/blocking/command")) Null
+  LSP.sendNotification (SMethod_CustomMethod (Proxy @"ghcide/blocking/command")) A.Null
   liftIO $ threadDelay maxBound
-  return (Right Null)
+  return (Right $ InR Null)

ghcide/src/Development/IDE/Plugin/TypeLenses.hs

@@ -18,7 +18,7 @@ import           Control.DeepSeq                      (rwhnf)
 import           Control.Monad                        (mzero)
 import           Control.Monad.Extra                  (whenMaybe)
 import           Control.Monad.IO.Class               (MonadIO (liftIO))
-import           Data.Aeson.Types                     (Value (..), toJSON)
+import           Data.Aeson.Types                     (Value, toJSON)
 import qualified Data.Aeson.Types                     as A
 import           Data.List                            (find)
 import qualified Data.Map                             as Map
@@ -69,10 +69,11 @@ import           Language.LSP.Protocol.Types          (ApplyWorkspaceEditParams
                                                        CodeLens (CodeLens),
                                                        CodeLensParams (CodeLensParams, _textDocument),
                                                        Diagnostic (..),
+                                                       Null (Null),
                                                        TextDocumentIdentifier (TextDocumentIdentifier),
                                                        TextEdit (TextEdit),
                                                        WorkspaceEdit (WorkspaceEdit),
-                                                       type (|?) (InL))
+                                                       type (|?) (..))
 import qualified Language.LSP.Server                  as LSP
 import           Text.Regex.TDFA                      ((=~), (=~~))
 
@@ -161,7 +162,7 @@ generateLens pId _range title edit =
 commandHandler :: CommandFunction IdeState WorkspaceEdit
 commandHandler _ideState wedit = do
   _ <- LSP.sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing wedit) (\_ -> pure ())
-  return $ Right Null
+  return $ Right $ InR Null
 
 --------------------------------------------------------------------------------
 

hls-plugin-api/src/Ide/Types.hs

@@ -873,7 +873,7 @@ data PluginCommand ideState = forall a. (FromJSON a) =>
 type CommandFunction ideState a
   = ideState
   -> a
-  -> LspM Config (Either ResponseError Value)
+  -> LspM Config (Either ResponseError (Value |? Null))
 
 -- ---------------------------------------------------------------------
 
@@ -1093,7 +1093,7 @@ mkCodeActionWithResolveAndCommand plId codeActionMethod codeResolveMethod =
             case resolveResult of
               Right CodeAction {_edit = Just wedits } -> do
                   _ <- sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing wedits) (\_ -> pure ())
-                  pure $ Right Data.Aeson.Null
+                  pure $ Right $ InR Null
               Right _ -> pure $ Left $ responseError "No edit in CodeAction"
               Left err -> pure $ Left err
 

plugins/hls-class-plugin/src/Ide/Plugin/Class/CodeAction.hs

@@ -12,7 +12,7 @@ import           Control.Monad.IO.Class               (liftIO)
 import           Control.Monad.Trans.Class            (lift)
 import           Control.Monad.Trans.Except           (ExceptT, throwE)
 import           Control.Monad.Trans.Maybe
-import           Data.Aeson
+import           Data.Aeson                           hiding (Null)
 import           Data.Bifunctor                       (second)
 import           Data.Either.Extra                    (rights)
 import           Data.List
@@ -37,7 +37,7 @@ import           Ide.PluginUtils
 import           Ide.Types
 import qualified Language.LSP.Protocol.Lens           as L
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types          hiding (Null)
+import           Language.LSP.Protocol.Types
 import           Language.LSP.Server
 
 addMethodPlaceholders :: PluginId -> CommandFunction IdeState AddMinimalMethodsParams
@@ -64,7 +64,7 @@ addMethodPlaceholders _ state param@AddMinimalMethodsParams{..} = do
 
         void $ lift $ sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing edit) (\_ -> pure ())
 
-        pure Null
+        pure $ InR Null
     where
         toTextDocumentEdit edit =
             TextDocumentEdit (verTxtDocId ^.re _versionedTextDocumentIdentifier) [InL edit]

plugins/hls-class-plugin/src/Ide/Plugin/Class/CodeLens.hs

@@ -7,7 +7,7 @@ module Ide.Plugin.Class.CodeLens where
 
 import           Control.Lens                         ((^.))
 import           Control.Monad.IO.Class               (liftIO)
-import           Data.Aeson
+import           Data.Aeson                           hiding (Null)
 import           Data.Maybe                           (mapMaybe, maybeToList)
 import qualified Data.Text                            as T
 import           Development.IDE
@@ -21,7 +21,7 @@ import           Ide.PluginUtils
 import           Ide.Types
 import qualified Language.LSP.Protocol.Lens           as L
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types          hiding (Null)
+import           Language.LSP.Protocol.Types
 import           Language.LSP.Server                  (sendRequest)
 
 codeLens :: PluginMethodHandler IdeState Method_TextDocumentCodeLens
@@ -143,4 +143,4 @@ codeLens state plId CodeLensParams{..} = pluginResponse $ do
 codeLensCommandHandler :: CommandFunction IdeState WorkspaceEdit
 codeLensCommandHandler _ wedit = do
   _ <- sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing wedit) (\_ -> pure ())
-  return $ Right Null
+  return $ Right $ InR Null

plugins/hls-eval-plugin/src/Ide/Plugin/Eval/Util.hs

@@ -18,7 +18,7 @@ import           Control.Exception                     (SomeException, evaluate,
 import           Control.Monad.IO.Class                (MonadIO (liftIO))
 import           Control.Monad.Trans.Except            (ExceptT (..),
                                                         runExceptT)
-import           Data.Aeson                            (Value (Null))
+import           Data.Aeson                            (Value)
 import           Data.String                           (IsString (fromString))
 import qualified Data.Text                             as T
 import           Development.IDE                       (IdeState, Priority (..),
@@ -32,7 +32,7 @@ import           GHC.Stack                             (HasCallStack, callStack,
                                                         srcLocStartCol,
                                                         srcLocStartLine)
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types           hiding (Null)
+import           Language.LSP.Protocol.Types
 import           Language.LSP.Server
 import           System.FilePath                       (takeExtension)
 import           System.Time.Extra                     (duration, showDuration)
@@ -66,7 +66,7 @@ logLevel = Debug -- Info
 isLiterate :: FilePath -> Bool
 isLiterate x = takeExtension x `elem` [".lhs", ".lhs-boot"]
 
-response' :: ExceptT String (LspM c) WorkspaceEdit -> LspM c (Either ResponseError Value)
+response' :: ExceptT String (LspM c) WorkspaceEdit -> LspM c (Either ResponseError (Value |? Null))
 response' act = do
     res <- runExceptT act
              `catchAny` showErr
@@ -75,7 +75,7 @@ response' act = do
           return $ Left (ResponseError (InR ErrorCodes_InternalError) (fromString e) Nothing)
       Right a -> do
         _ <- sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing a) (\_ -> pure ())
-        return $ Right Null
+        return $ Right $ InR Null
 
 gStrictTry :: (MonadIO m, MonadCatch m) => m b -> m (Either String b)
 gStrictTry op =

plugins/hls-explicit-imports-plugin/src/Ide/Plugin/ExplicitImports.hs

@@ -21,7 +21,7 @@ module Ide.Plugin.ExplicitImports
 import           Control.DeepSeq
 import           Control.Monad.IO.Class
 import           Data.Aeson                           (ToJSON (toJSON),
-                                                       Value (Null))
+                                                       Value ())
 import           Data.Aeson.Types                     (FromJSON)
 import qualified Data.HashMap.Strict                  as HashMap
 import           Data.IORef                           (readIORef)
@@ -41,7 +41,7 @@ import           GHC.Generics                         (Generic)
 import           Ide.PluginUtils                      (mkLspCommand)
 import           Ide.Types
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types          hiding (Null)
+import           Language.LSP.Protocol.Types
 import           Language.LSP.Server
 
 importCommandId :: CommandId
@@ -97,7 +97,7 @@ runImportCommand :: CommandFunction IdeState ImportCommandParams
 runImportCommand _state (ImportCommandParams edit) = do
   -- This command simply triggers a workspace edit!
   _ <- sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing edit) (\_ -> pure ())
-  return (Right Null)
+  return (Right $ InR Null)
 
 -- | For every implicit import statement, return a code lens of the corresponding explicit import
 -- Example - for the module below:

plugins/hls-gadt-plugin/src/Ide/Plugin/GADT.hs

@@ -12,8 +12,7 @@ import           Control.Lens                  ((^.))
 import           Control.Monad.Except
 import           Control.Monad.IO.Class
 import           Control.Monad.Trans.Class
-import           Data.Aeson                    (FromJSON, ToJSON, Value (Null),
-                                                toJSON)
+import           Data.Aeson                    (FromJSON, ToJSON, Value, toJSON)
 import           Data.Either.Extra             (maybeToEither)
 import qualified Data.Map                      as Map
 import qualified Data.Text                     as T
@@ -29,7 +28,7 @@ import           Ide.PluginUtils
 import           Ide.Types
 import qualified Language.LSP.Protocol.Lens    as L
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types   hiding (Null)
+import           Language.LSP.Protocol.Types
 import           Language.LSP.Server           (sendRequest)
 
 descriptor :: PluginId -> PluginDescriptor IdeState
@@ -72,7 +71,7 @@ toGADTCommand pId@(PluginId pId') state ToGADTParams{..} = pluginResponse $ do
             (ApplyWorkspaceEditParams Nothing (workSpaceEdit nfp (TextEdit range txt : insertEdit)))
             (\_ -> pure ())
 
-    pure Null
+    pure $ InR Null
     where
         workSpaceEdit nfp edits = WorkspaceEdit
             (pure $ Map.fromList

plugins/hls-module-name-plugin/src/Ide/Plugin/ModuleName.hs

@@ -21,7 +21,7 @@ import           Control.Monad                        (forM_, void)
 import           Control.Monad.IO.Class               (liftIO)
 import           Control.Monad.Trans.Class            (lift)
 import           Control.Monad.Trans.Maybe
-import           Data.Aeson                           (Value (Null), toJSON)
+import           Data.Aeson                           (Value, toJSON)
 import           Data.Char                            (isLower)
 import           Data.List                            (intercalate, isPrefixOf,
                                                        minimumBy)
@@ -54,7 +54,7 @@ import           Development.IDE.GHC.Compat           (GenLocated (L),
 import           Development.IDE.Types.Logger         (Pretty (..))
 import           Ide.Types
 import           Language.LSP.Protocol.Message
-import           Language.LSP.Protocol.Types          hiding (Null)
+import           Language.LSP.Protocol.Types
 import           Language.LSP.Server
 import           Language.LSP.VFS                     (virtualFileText)
 import           System.Directory                     (makeAbsolute)
@@ -94,7 +94,7 @@ command recorder state uri = do
       edit = WorkspaceEdit (Just $ Map.singleton aUri [TextEdit aRange aCode]) Nothing Nothing
     in
       void $ sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing edit) (const (pure ()))
-  pure $ Right Null
+  pure $ Right $ InR Null
 
 -- | A source code change
 data Action = Replace

plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs

@@ -22,7 +22,6 @@ import           Control.Concurrent.STM.Stats                      (atomically)
 import           Control.Monad.Extra
 import           Control.Monad.IO.Class
 import           Control.Monad.Trans.Maybe
-import           Data.Aeson                                        as A
 import           Data.Char
 import qualified Data.DList                                        as DL
 import           Data.Function
@@ -85,7 +84,7 @@ import           Language.LSP.Protocol.Types                       (ApplyWorkspa
                                                                     Command,
                                                                     Diagnostic (..),
                                                                     MessageType (..),
-                                                                    Null,
+                                                                    Null (Null),
                                                                     ShowMessageParams (..),
                                                                     TextDocumentIdentifier (TextDocumentIdentifier),
                                                                     TextEdit (TextEdit, _range),
@@ -212,7 +211,7 @@ extendImportHandler ideState edit@ExtendImport {..} = do
           <> printOutputable srcSpan
           <> ")"
     void $ LSP.sendRequest SMethod_WorkspaceApplyEdit (ApplyWorkspaceEditParams Nothing wedit) (\_ -> pure ())
-  return $ Right A.Null
+  return $ Right $ InR Null
 
 extendImportHandler' :: IdeState -> ExtendImport -> MaybeT IO (NormalizedFilePath, WorkspaceEdit)
 extendImportHandler' ideState ExtendImport {..}