X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest.hs;h=b406e7bd4e87a5a068d59b44e7b27678b100a64e;hb=3b8d5fe55d1e542587817341a797345270ca7a96;hp=4f3094f87d58034d5fc2b0d11c87973464ddd7d4;hpb=bf93e74482200ee189ca0be09970b9a34bb1511c;p=opengl.git diff --git a/src/Language/Haskell/LSP/Test.hs b/src/Language/Haskell/LSP/Test.hs index 4f3094f..b406e7b 100644 --- a/src/Language/Haskell/LSP/Test.hs +++ b/src/Language/Haskell/LSP/Test.hs @@ -15,12 +15,19 @@ module Language.Haskell.LSP.Test ( -- * Sessions runSession - , runSessionWithHandler + , runSessionWithHandles + , runSessionWithConfig , Session + , SessionConfig(..) + , MonadSessionConfig(..) + , SessionException(..) + , anySessionException -- * Sending , sendRequest - , sendNotification + , sendRequest_ , sendRequest' + , sendNotification + , sendRequestMessage , sendNotification' , sendResponse -- * Receving @@ -30,6 +37,7 @@ module Language.Haskell.LSP.Test , response , anyNotification , notification + , anyMessage , loggingNotification , publishDiagnosticsNotification -- * Combinators @@ -54,61 +62,87 @@ module Language.Haskell.LSP.Test , (<|>) , satisfy -- * Utilities - , getInitializeResponse + , initializeResponse + -- ** Documents , openDoc - , getDocItem + , documentContents + , getDocumentEdit , getDocUri + -- ** Symbols + , getDocumentSymbols + -- ** Diagnostics + , waitForDiagnostics + , noDiagnostics + -- ** Commands + , executeCommand + -- ** Code Actions + , getAllCodeActions + , executeCodeAction ) where import Control.Applicative import Control.Applicative.Combinators +import Control.Concurrent import Control.Monad import Control.Monad.IO.Class -import Control.Concurrent -import Control.Lens hiding ((.=)) +import Control.Exception +import Control.Lens hiding ((.=), List) import qualified Data.Text as T import qualified Data.Text.IO as T import Data.Aeson -import qualified Data.ByteString.Lazy.Char8 as B import Data.Default -import System.Process -import Language.Haskell.LSP.Types -import qualified Language.Haskell.LSP.Types as LSP (error, id) +import qualified Data.HashMap.Strict as HashMap +import qualified Data.Map as Map +import Data.Maybe +import Language.Haskell.LSP.Types hiding (id, capabilities, error) +import qualified Language.Haskell.LSP.Types as LSP +import Language.Haskell.LSP.Messages +import Language.Haskell.LSP.VFS import Language.Haskell.LSP.Test.Compat +import Language.Haskell.LSP.Test.Decoding +import Language.Haskell.LSP.Test.Exceptions +import Language.Haskell.LSP.Test.Parsing +import Language.Haskell.LSP.Test.Session +import Language.Haskell.LSP.Test.Server import System.IO import System.Directory import System.FilePath -import Language.Haskell.LSP.Test.Decoding -import Language.Haskell.LSP.Test.Parsing +import qualified Yi.Rope as Rope -- | Starts a new session. runSession :: String -- ^ The command to run the server. -> FilePath -- ^ The filepath to the root directory for the session. -> Session a -- ^ The session to run. -> IO a -runSession serverExe rootDir session = do - pid <- getProcessID +runSession = runSessionWithConfig def + +-- | Starts a new sesion with a client with the specified capabilities. +runSessionWithConfig :: SessionConfig -- ^ The capabilities the client should have. + -> String -- ^ The command to run the server. + -> FilePath -- ^ The filepath to the root directory for the session. + -> Session a -- ^ The session to run. + -> IO a +runSessionWithConfig config serverExe rootDir session = do + pid <- getCurrentProcessID absRootDir <- canonicalizePath rootDir let initializeParams = InitializeParams (Just pid) (Just $ T.pack absRootDir) (Just $ filePathToUri absRootDir) Nothing - def + (capabilities config) (Just TraceOff) - - runSessionWithHandler listenServer serverExe rootDir $ do + withServer serverExe (logStdErr config) $ \serverIn serverOut _ -> + runSessionWithHandles serverIn serverOut listenServer config rootDir $ do -- Wrap the session around initialize and shutdown calls - sendRequest Initialize initializeParams - initRspMsg <- response :: Session InitializeResponse + initRspMsg <- sendRequest Initialize initializeParams :: Session InitializeResponse liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRspMsg ^. LSP.error) initRspVar <- initRsp <$> ask liftIO $ putMVar initRspVar initRspMsg - sendNotification Initialized InitializedParams -- Run the actual test @@ -118,38 +152,6 @@ runSession serverExe rootDir session = do return result --- | An internal version of 'runSession' that allows for a custom handler to listen to the server. --- It also does not automatically send initialize and exit messages. -runSessionWithHandler :: (Handle -> Session ()) - -> String - -> FilePath - -> Session a - -> IO a -runSessionWithHandler serverHandler serverExe rootDir session = do - absRootDir <- canonicalizePath rootDir - - let createProc = (shell serverExe) { std_in = CreatePipe, std_out = CreatePipe, std_err = CreatePipe } - (Just serverIn, Just serverOut, _, serverProc) <- createProcess createProc - - hSetBuffering serverIn NoBuffering - hSetBuffering serverOut NoBuffering - - reqMap <- newMVar newRequestMap - messageChan <- newChan - meaninglessChan <- newChan - initRsp <- newEmptyMVar - - let context = SessionContext serverIn absRootDir messageChan reqMap initRsp - initState = SessionState (IdInt 9) - - threadId <- forkIO $ void $ runSession' meaninglessChan context initState (serverHandler serverOut) - (result, _) <- runSession' messageChan context initState session - - terminateProcess serverProc - killThread threadId - - return result - -- | Listens to the server output, makes sure it matches the record and -- signals any semaphores listenServer :: Handle -> Session () @@ -159,24 +161,61 @@ listenServer serverOut = do context <- ask reqMap <- liftIO $ readMVar $ requestMap context - liftIO $ writeChan (messageChan context) $ decodeFromServerMsg reqMap msgBytes + let msg = decodeFromServerMsg reqMap msgBytes + liftIO $ writeChan (messageChan context) msg listenServer serverOut --- | Sends a request to the server. --- +-- | The current text contents of a document. +documentContents :: TextDocumentIdentifier -> Session T.Text +documentContents doc = do + vfs <- vfs <$> get + let file = vfs Map.! (doc ^. uri) + return $ Rope.toText $ Language.Haskell.LSP.VFS._text file + +-- | Parses an ApplyEditRequest, checks that it is for the passed document +-- and returns the new content +getDocumentEdit :: TextDocumentIdentifier -> Session T.Text +getDocumentEdit doc = do + req <- request :: Session ApplyWorkspaceEditRequest + + unless (checkDocumentChanges req || checkChanges req) $ + liftIO $ throw (IncorrectApplyEditRequestException (show req)) + + documentContents doc + where + checkDocumentChanges :: ApplyWorkspaceEditRequest -> Bool + checkDocumentChanges req = + let changes = req ^. params . edit . documentChanges + maybeDocs = fmap (fmap (^. textDocument . uri)) changes + in case maybeDocs of + Just docs -> (doc ^. uri) `elem` docs + Nothing -> False + checkChanges :: ApplyWorkspaceEditRequest -> Bool + checkChanges req = + let mMap = req ^. params . edit . changes + in maybe False (HashMap.member (doc ^. uri)) mMap + +-- | Sends a request to the server and waits for its response. -- @ --- sendRequest (Proxy :: Proxy DocumentSymbolRequest) --- TextDocumentDocumentSymbol --- (DocumentSymbolParams docId) +-- rsp <- sendRequest TextDocumentDocumentSymbol params :: Session DocumentSymbolsResponse -- @ -sendRequest - :: (ToJSON params) - => --Proxy (RequestMessage ClientMethod params resp) -- ^ A proxy to provide more type information about the request. - ClientMethod -- ^ The request method. +-- Note: will skip any messages in between the request and the response. +sendRequest :: (ToJSON params, FromJSON a) => ClientMethod -> params -> Session (ResponseMessage a) +sendRequest m = sendRequest' m >=> skipManyTill anyMessage . responseForId + +-- | Send a request to the server and wait for its response, +-- but discard it. +sendRequest_ :: ToJSON params => ClientMethod -> params -> Session () +sendRequest_ p = void . (sendRequest p :: ToJSON params => params -> Session (ResponseMessage Value)) + +-- | Sends a request to the server without waiting on the response. +sendRequest' + :: ToJSON params + => ClientMethod -- ^ The request method. -> params -- ^ The request parameters. -> Session LspId -- ^ The id of the request that was sent. -sendRequest method params = do +sendRequest' method params = do id <- curReqId <$> get modify $ \c -> c { curReqId = nextId id } @@ -204,8 +243,8 @@ instance ToJSON a => ToJSON (RequestMessage' a) where object ["jsonrpc" .= rpc, "id" .= id, "method" .= method, "params" .= params] -sendRequest' :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session () -sendRequest' req = do +sendRequestMessage :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session () +sendRequestMessage req = do -- Update the request map reqMap <- requestMap <$> ask liftIO $ modifyMVar_ reqMap $ @@ -218,9 +257,28 @@ sendNotification :: ToJSON a => ClientMethod -- ^ The notification method. -> a -- ^ The notification parameters. -> Session () -sendNotification method params = - let notif = NotificationMessage "2.0" method params - in sendNotification' notif + +-- | Open a virtual file if we send a did open text document notification +sendNotification TextDocumentDidOpen params = do + let params' = fromJust $ decode $ encode params + n :: DidOpenTextDocumentNotification + n = NotificationMessage "2.0" TextDocumentDidOpen params' + oldVFS <- vfs <$> get + newVFS <- liftIO $ openVFS oldVFS n + modify (\s -> s { vfs = newVFS }) + sendNotification' n + +-- | Close a virtual file if we send a close text document notification +sendNotification TextDocumentDidClose params = do + let params' = fromJust $ decode $ encode params + n :: DidCloseTextDocumentNotification + n = NotificationMessage "2.0" TextDocumentDidClose params' + oldVFS <- vfs <$> get + newVFS <- liftIO $ closeVFS oldVFS n + modify (\s -> s { vfs = newVFS }) + sendNotification' n + +sendNotification method params = sendNotification' (NotificationMessage "2.0" method params) sendNotification' :: (ToJSON a, ToJSON b) => NotificationMessage a b -> Session () sendNotification' = sendMessage @@ -228,16 +286,11 @@ sendNotification' = sendMessage sendResponse :: ToJSON a => ResponseMessage a -> Session () sendResponse = sendMessage -sendMessage :: ToJSON a => a -> Session () -sendMessage msg = do - h <- serverIn <$> ask - liftIO $ B.hPut h $ addHeader (encode msg) - -- | Returns the initialize response that was received from the server. -- The initialize requests and responses are not included the session, -- so if you need to test it use this. -getInitializeResponse :: Session InitializeResponse -getInitializeResponse = initRsp <$> ask >>= (liftIO . readMVar) +initializeResponse :: Session InitializeResponse +initializeResponse = initRsp <$> ask >>= (liftIO . readMVar) -- | Opens a text document and sends a notification to the client. openDoc :: FilePath -> String -> Session TextDocumentIdentifier @@ -245,7 +298,7 @@ openDoc file languageId = do item <- getDocItem file languageId sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams item) TextDocumentIdentifier <$> getDocUri file - + where -- | Reads in a text document as the first version. getDocItem :: FilePath -- ^ The path to the text document to read in. -> String -- ^ The language ID, e.g "haskell" for .hs files. @@ -262,3 +315,59 @@ getDocUri file = do context <- ask let fp = rootDir context file return $ filePathToUri fp + +waitForDiagnostics :: Session [Diagnostic] +waitForDiagnostics = do + diagsNot <- skipManyTill anyMessage notification :: Session PublishDiagnosticsNotification + let (List diags) = diagsNot ^. params . LSP.diagnostics + return diags + +-- | Expects a 'PublishDiagnosticsNotification' and throws an +-- 'UnexpectedDiagnosticsException' if there are any diagnostics +-- returned. +noDiagnostics :: Session () +noDiagnostics = do + diagsNot <- notification :: Session PublishDiagnosticsNotification + when (diagsNot ^. params . LSP.diagnostics /= List []) $ liftIO $ throw UnexpectedDiagnosticsException + +-- | Returns the symbols in a document. +getDocumentSymbols :: TextDocumentIdentifier -> Session [SymbolInformation] +getDocumentSymbols doc = do + ResponseMessage _ rspLid mRes mErr <- sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc) + maybe (return ()) (throw . UnexpectedResponseError rspLid) mErr + let (Just (List symbols)) = mRes + return symbols + +getAllCodeActions :: TextDocumentIdentifier -> Session [CommandOrCodeAction] +getAllCodeActions doc = do + curDiags <- fromMaybe [] . Map.lookup (doc ^. uri) . curDiagnostics <$> get + let ctx = CodeActionContext (List curDiags) Nothing + + foldM (go ctx) [] curDiags + + where + go :: CodeActionContext -> [CommandOrCodeAction] -> Diagnostic -> Session [CommandOrCodeAction] + go ctx acc diag = do + ResponseMessage _ rspLid mRes mErr <- sendRequest TextDocumentCodeAction (CodeActionParams doc (diag ^. range) ctx) + + case mErr of + Just e -> throw (UnexpectedResponseError rspLid e) + Nothing -> + let Just (List cmdOrCAs) = mRes + in return (acc ++ cmdOrCAs) + +executeCommand :: Command -> Session () +executeCommand cmd = do + let args = decode $ encode $ fromJust $ cmd ^. arguments + execParams = ExecuteCommandParams (cmd ^. command) args + sendRequest_ WorkspaceExecuteCommand execParams + +executeCodeAction :: CodeAction -> Session () +executeCodeAction action = do + maybe (return ()) handleEdit $ action ^. edit + maybe (return ()) executeCommand $ action ^. command + + where handleEdit :: WorkspaceEdit -> Session () + handleEdit e = + let req = RequestMessage "" (IdInt 0) WorkspaceApplyEdit (ApplyWorkspaceEditParams e) + in processMessage (ReqApplyWorkspaceEdit req) \ No newline at end of file