(
-- * Sessions
runSession
- , runSessionWithHandler
+ , runSessionWithHandles
+ , runSessionWithConfig
, Session
+ , SessionConfig(..)
+ , MonadSessionConfig(..)
+ , SessionException(..)
+ , anySessionException
-- * Sending
, sendRequest
, sendNotification
, sendRequest'
, sendNotification'
- , sendResponse'
+ , sendResponse
-- * Receving
- , getMessage
+ , anyRequest
+ , request
+ , anyResponse
+ , response
+ , anyNotification
+ , notification
+ , loggingNotification
+ , publishDiagnosticsNotification
+ -- * Combinators
+ , choice
+ , option
+ , optional
+ , between
+ , some
+ , many
+ , sepBy
+ , sepBy1
+ , sepEndBy1
+ , sepEndBy
+ , endBy1
+ , endBy
+ , count
+ , manyTill
+ , skipMany
+ , skipSome
+ , skipManyTill
+ , skipSomeTill
+ , (<|>)
+ , satisfy
-- * Utilities
- , getDocItem
+ , initializeResponse
+ , openDoc
+ , documentContents
+ , getDocumentEdit
, getDocUri
+ , noDiagnostics
+ , getDocumentSymbols
+ , getDiagnostics
) where
+import Control.Applicative
+import Control.Applicative.Combinators
+import Control.Concurrent
import Control.Monad
-import Control.Monad.Trans.Class
import Control.Monad.IO.Class
-import Control.Monad.Trans.Reader
-import Control.Monad.Trans.State
-import Control.Concurrent
+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 qualified Data.HashMap.Strict as HashMap
+import qualified Data.Map as Map
import Data.Maybe
-import Data.Proxy
-import System.Process
-import Language.Haskell.LSP.Types hiding (error, id)
+import Language.Haskell.LSP.Types hiding (id, capabilities)
+import qualified Language.Haskell.LSP.Types as LSP
+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.Parsing
-
-data SessionContext = SessionContext
- {
- messageSema :: MVar B.ByteString,
- serverIn :: Handle,
- rootDir :: FilePath
- }
-
-newtype SessionState = SessionState
- {
- curReqId :: LspId
- }
-
--- | A session representing one instance of launching and connecting to a server.
---
--- You can send and receive messages to the server within 'Session' via 'getMessage',
--- 'sendRequest' and 'sendNotification'.
---
--- @
--- runSession \"path\/to\/root\/dir\" $ do
--- docItem <- getDocItem "Desktop/simple.hs" "haskell"
--- sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams docItem)
--- diagnostics <- getMessage :: Session PublishDiagnosticsNotification
--- @
---
-type Session = StateT SessionState (ReaderT SessionContext IO)
+import qualified Yi.Rope as Rope
-- | Starts a new session.
-runSession :: FilePath -- ^ The filepath to the root directory for the 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 = 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 ()
-runSession rootDir session = do
- pid <- getProcessID
+ -> 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 rootDir $ do
+ withServer serverExe $ \serverIn serverOut _ ->
+ runSessionWithHandles serverIn serverOut listenServer config rootDir $ do
-- Wrap the session around initialize and shutdown calls
- sendRequest (Proxy :: Proxy InitializeRequest) Initialize initializeParams
- (ResponseMessage _ _ (Just (InitializeResponseCapabilities _)) e) <- getMessage
- liftIO $ maybe (return ()) (putStrLn . ("Error when initializing: " ++) . show ) e
+ sendRequest Initialize initializeParams
+ initRspMsg <- response :: 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
- session
+ result <- session
sendNotification Exit ExitParams
-runSessionWithHandler :: (Handle -> Session ())
- -> FilePath
- -> Session a
- -> IO a
-runSessionWithHandler serverHandler rootDir session = do
- absRootDir <- canonicalizePath rootDir
-
- (Just serverIn, Just serverOut, Nothing, serverProc) <- createProcess
- (proc "hie" ["--lsp", "-d", "-l", "/tmp/hie-test.log"])
- { std_in = CreatePipe, std_out = CreatePipe }
-
- hSetBuffering serverIn NoBuffering
- hSetBuffering serverOut NoBuffering
-
- messageSema <- newEmptyMVar
-
- let context = SessionContext messageSema serverIn absRootDir
- initState = SessionState (IdInt 9)
-
- forkIO $ void $ runReaderT (runStateT (serverHandler serverOut) initState) context
- (result, _) <- runReaderT (runStateT session initState) context
-
- terminateProcess serverProc
-
return result
-- | Listens to the server output, makes sure it matches the record and
-- signals any semaphores
listenServer :: Handle -> Session ()
listenServer serverOut = do
- context <- lift ask
msgBytes <- liftIO $ getNextMessage serverOut
- liftIO $ case decode msgBytes :: Maybe LogMessageNotification of
- -- Just print log and show messages
- Just (NotificationMessage _ WindowLogMessage (LogMessageParams _ msg)) -> T.putStrLn msg
- _ -> case decode msgBytes :: Maybe ShowMessageNotification of
- Just (NotificationMessage _ WindowShowMessage (ShowMessageParams _ msg)) -> T.putStrLn msg
- -- Give everything else for getMessage to handle
- _ -> putMVar (messageSema context) msgBytes
+ context <- ask
+ reqMap <- liftIO $ readMVar $ requestMap context
+
+ let msg = decodeFromServerMsg reqMap msgBytes
+ liftIO $ writeChan (messageChan context) msg
listenServer serverOut
+-- | 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.
--
-- @
-- (DocumentSymbolParams docId)
-- @
sendRequest
- :: forall params resp. (ToJSON params, ToJSON resp, FromJSON resp)
- => Proxy (RequestMessage ClientMethod params resp) -- ^ A proxy to provide more type information about the request.
- -> ClientMethod -- ^ The request method.
+ :: (ToJSON params)
+ => --Proxy (RequestMessage ClientMethod params resp) -- ^ A proxy to provide more type information about the request.
+ 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
- get >>= \c -> put c { curReqId = nextId id }
+ modify $ \c -> c { curReqId = nextId id }
+
+ let req = RequestMessage' "2.0" id method params
- let req = RequestMessage "2.0" id method params :: RequestMessage ClientMethod params resp
+ -- Update the request map
+ reqMap <- requestMap <$> ask
+ liftIO $ modifyMVar_ reqMap $
+ \r -> return $ updateRequestMap r id method
- sendRequest' req
+ sendMessage req
return id
where nextId (IdInt i) = IdInt (i + 1)
nextId (IdString s) = IdString $ T.pack $ show $ read (T.unpack s) + 1
-sendRequest' :: (ToJSON a, ToJSON b, ToJSON c) => RequestMessage a b c -> Session ()
-sendRequest' = sendMessage
+-- | A custom type for request message that doesn't
+-- need a response type, allows us to infer the request
+-- message type without using proxies.
+data RequestMessage' a = RequestMessage' T.Text LspId ClientMethod a
+
+instance ToJSON a => ToJSON (RequestMessage' a) where
+ toJSON (RequestMessage' rpc id method params) =
+ object ["jsonrpc" .= rpc, "id" .= id, "method" .= method, "params" .= params]
+
+
+sendRequest' :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session ()
+sendRequest' req = do
+ -- Update the request map
+ reqMap <- requestMap <$> ask
+ liftIO $ modifyMVar_ reqMap $
+ \r -> return $ updateRequestMap r (req ^. LSP.id) (req ^. method)
+
+ sendMessage req
-- | Sends a notification to the server.
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
-sendResponse' :: ToJSON a => ResponseMessage a -> Session ()
-sendResponse' = sendMessage
+sendResponse :: ToJSON a => ResponseMessage a -> Session ()
+sendResponse = sendMessage
sendMessage :: ToJSON a => a -> Session ()
sendMessage msg = do
- h <- serverIn <$> lift ask
+ h <- serverIn <$> ask
liftIO $ B.hPut h $ addHeader (encode msg)
--- | Reads in a message from the server.
-getMessage :: FromJSON a => Session a
-getMessage = do
- sema <- messageSema <$> lift ask
- bytes <- liftIO $ takeMVar sema
- return $ fromMaybe (error $ "Wrong type! Got: " ++ show bytes) (decode bytes)
-
+-- | 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.
+initializeResponse :: Session InitializeResponse
+initializeResponse = initRsp <$> ask >>= (liftIO . readMVar)
+
+-- | Opens a text document and sends a notification to the client.
+openDoc :: FilePath -> String -> Session TextDocumentIdentifier
+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.
-> Session TextDocumentItem
getDocItem file languageId = do
- context <- lift ask
+ context <- ask
let fp = rootDir context </> file
contents <- liftIO $ T.readFile fp
return $ TextDocumentItem (filePathToUri fp) (T.pack languageId) 0 contents
-- | Gets the Uri for the file corrected to the session directory.
getDocUri :: FilePath -> Session Uri
getDocUri file = do
- context <- lift ask
+ context <- ask
let fp = rootDir context </> file
return $ filePathToUri fp
+
+getDiagnostics :: Session [Diagnostic]
+getDiagnostics = do
+ diagsNot <- 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 DocumentSymbolsResponse
+getDocumentSymbols doc = do
+ sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc)
+ response
\ No newline at end of file