X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FSession.hs;h=a58496d5234dff41854b0f5baba401658daeffc7;hp=db8bef5513e2c1e5dad7462d11ff52d400aaa21e;hb=7ee14165e9d2ebcc171716d41e3e207444c418b3;hpb=f6e14409afddc74ea8ffb1d852c316a5374caf2c diff --git a/src/Language/Haskell/LSP/Test/Session.hs b/src/Language/Haskell/LSP/Test/Session.hs index db8bef5..a58496d 100644 --- a/src/Language/Haskell/LSP/Test/Session.hs +++ b/src/Language/Haskell/LSP/Test/Session.hs @@ -1,98 +1,182 @@ {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE FlexibleContexts #-} module Language.Haskell.LSP.Test.Session ( Session - , SessionState(..) + , SessionConfig(..) + , SessionMessage(..) , SessionContext(..) + , SessionState(..) , runSessionWithHandles , get , put , modify - , ask) + , modifyM + , ask + , asks + , sendMessage + , updateState + , withTimeout + ) where import Control.Concurrent hiding (yield) +import Control.Exception import Control.Lens hiding (List) import Control.Monad import Control.Monad.IO.Class -import Control.Monad.Trans.Class +import Control.Monad.Except import Control.Monad.Trans.Reader (ReaderT, runReaderT) import qualified Control.Monad.Trans.Reader as Reader (ask) import Control.Monad.Trans.State (StateT, runStateT) -import qualified Control.Monad.Trans.State as State (get, put, modify) +import qualified Control.Monad.Trans.State as State (get, put) import qualified Data.ByteString.Lazy.Char8 as B import Data.Aeson -import Data.Conduit -import Data.Conduit.Parser +import Data.Aeson.Encode.Pretty +import Data.Conduit as Conduit +import Data.Conduit.Parser as Parser +import Data.Default import Data.Foldable import Data.List +import qualified Data.Map as Map +import qualified Data.Text as T +import qualified Data.Text.IO as T import qualified Data.HashMap.Strict as HashMap +import Data.Maybe +import Data.Function import Language.Haskell.LSP.Messages -import Language.Haskell.LSP.Types +import Language.Haskell.LSP.Types.Capabilities +import Language.Haskell.LSP.Types hiding (error) import Language.Haskell.LSP.VFS -import Language.Haskell.LSP.Test.Compat import Language.Haskell.LSP.Test.Decoding +import Language.Haskell.LSP.Test.Exceptions +import System.Console.ANSI import System.Directory import System.IO +-- | 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 = ParserStateReader FromServerMessage SessionState SessionContext IO + +-- | Stuff you can configure for a 'Session'. +data SessionConfig = SessionConfig + { + messageTimeout :: Int -- ^ Maximum time to wait for a message in seconds. Defaults to 60. + , logStdErr :: Bool -- ^ When True redirects the servers stderr output to haskell-lsp-test's stdout. Defaults to False. + , logMessages :: Bool -- ^ When True traces the communication between client and server to stdout. Defaults to True. + } + +instance Default SessionConfig where + def = SessionConfig 60 False True + +data SessionMessage = ServerMessage FromServerMessage + | TimeoutMessage Int + deriving Show + data SessionContext = SessionContext { serverIn :: Handle , rootDir :: FilePath - , messageChan :: Chan FromServerMessage + , messageChan :: Chan SessionMessage , requestMap :: MVar RequestMap , initRsp :: MVar InitializeResponse + , config :: SessionConfig + , sessionCapabilities :: ClientCapabilities } +class Monad m => HasReader r m where + ask :: m r + asks :: (r -> b) -> m b + asks f = f <$> ask + +instance Monad m => HasReader r (ParserStateReader a s r m) where + ask = lift $ lift Reader.ask + +instance Monad m => HasReader SessionContext (ConduitM a b (StateT s (ReaderT SessionContext m))) where + ask = lift $ lift Reader.ask + data SessionState = SessionState { curReqId :: LspId , vfs :: VFS + , curDiagnostics :: Map.Map Uri [Diagnostic] + , curTimeoutId :: Int + , overridingTimeout :: Bool + -- ^ The last received message from the server. + -- Used for providing exception information + , lastReceivedMessage :: Maybe FromServerMessage } -type ParserStateReader a s r m = ConduitParser a (StateT s (ReaderT r m)) +class Monad m => HasState s m where + get :: m s --- | 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 = ParserStateReader FromServerMessage SessionState SessionContext IO + put :: s -> m () -type SessionProcessor = ConduitT FromServerMessage FromServerMessage (StateT SessionState (ReaderT SessionContext IO)) + modify :: (s -> s) -> m () + modify f = get >>= put . f -runSession' :: Chan FromServerMessage -> SessionProcessor () -> SessionContext -> SessionState -> Session a -> IO (a, SessionState) -runSession' chan preprocessor context state session = runReaderT (runStateT conduit state) context - where conduit = runConduit $ chanSource chan .| preprocessor .| runConduitParser session + modifyM :: (HasState s m, Monad m) => (s -> m s) -> m () + modifyM f = get >>= f >>= put -get :: Monad m => ParserStateReader a s r m s +instance Monad m => HasState s (ParserStateReader a s r m) where get = lift State.get + put = lift . State.put -put :: Monad m => s -> ParserStateReader a s r m () +instance Monad m => HasState SessionState (ConduitM a b (StateT SessionState m)) + where + get = lift State.get put = lift . State.put -modify :: Monad m => (s -> s) -> ParserStateReader a s r m () -modify = lift . State.modify +type ParserStateReader a s r m = ConduitParser a (StateT s (ReaderT r m)) + +runSession :: SessionContext -> SessionState -> Session a -> IO (a, SessionState) +runSession context state session = runReaderT (runStateT conduit state) context + where + conduit = runConduit $ chanSource .| watchdog .| updateStateC .| runConduitParser (catchError session handler) + + handler (Unexpected "ConduitParser.empty") = do + lastMsg <- fromJust . lastReceivedMessage <$> get + name <- getParserName + liftIO $ throw (UnexpectedMessage (T.unpack name) lastMsg) + + handler e = throw e + + chanSource = do + msg <- liftIO $ readChan (messageChan context) + yield msg + chanSource -ask :: Monad m => ParserStateReader a s r m r -ask = lift $ lift Reader.ask + + watchdog :: ConduitM SessionMessage FromServerMessage (StateT SessionState (ReaderT SessionContext IO)) () + watchdog = Conduit.awaitForever $ \msg -> do + curId <- curTimeoutId <$> get + case msg of + ServerMessage sMsg -> yield sMsg + TimeoutMessage tId -> when (curId == tId) $ throw Timeout -- | 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. runSessionWithHandles :: Handle -- ^ Server in -> Handle -- ^ Server out - -> (Handle -> Session ()) -- ^ Server listener - -> FilePath + -> (Handle -> SessionContext -> IO ()) -- ^ Server listener + -> SessionConfig + -> ClientCapabilities + -> FilePath -- ^ Root directory -> Session a -> IO a -runSessionWithHandles serverIn serverOut serverHandler rootDir session = do +runSessionWithHandles serverIn serverOut serverHandler config caps rootDir session = do absRootDir <- canonicalizePath rootDir hSetBuffering serverIn NoBuffering @@ -100,52 +184,123 @@ runSessionWithHandles serverIn serverOut serverHandler rootDir session = do reqMap <- newMVar newRequestMap messageChan <- newChan - meaninglessChan <- newChan initRsp <- newEmptyMVar - let context = SessionContext serverIn absRootDir messageChan reqMap initRsp - initState = SessionState (IdInt 0) mempty + let context = SessionContext serverIn absRootDir messageChan reqMap initRsp config caps + initState = SessionState (IdInt 0) mempty mempty 0 False Nothing - threadId <- forkIO $ void $ runSession' meaninglessChan processor context initState (serverHandler serverOut) - (result, _) <- runSession' messageChan processor context initState session + threadId <- forkIO $ void $ serverHandler serverOut context + (result, _) <- runSession context initState session killThread threadId return result - where processor :: SessionProcessor () - processor = awaitForever $ \msg -> do - processTextChanges msg +updateStateC :: ConduitM FromServerMessage FromServerMessage (StateT SessionState (ReaderT SessionContext IO)) () +updateStateC = awaitForever $ \msg -> do + updateState msg yield msg +updateState :: (MonadIO m, HasReader SessionContext m, HasState SessionState m) => FromServerMessage -> m () +updateState (NotPublishDiagnostics n) = do + let List diags = n ^. params . diagnostics + doc = n ^. params . uri + modify (\s -> + let newDiags = Map.insert doc diags (curDiagnostics s) + in s { curDiagnostics = newDiags }) + +updateState (ReqApplyWorkspaceEdit r) = do -processTextChanges :: FromServerMessage -> SessionProcessor () -processTextChanges (ReqApplyWorkspaceEdit r) = do - List changeParams <- case r ^. params . edit . documentChanges of - Just cs -> mapM applyTextDocumentEdit cs + allChangeParams <- case r ^. params . edit . documentChanges of + Just (List cs) -> do + mapM_ (checkIfNeedsOpened . (^. textDocument . uri)) cs + return $ map getParams cs Nothing -> case r ^. params . edit . changes of - Just cs -> mapM (uncurry applyTextEdit) (List (HashMap.toList cs)) - Nothing -> return (List []) + Just cs -> do + mapM_ checkIfNeedsOpened (HashMap.keys cs) + return $ concatMap (uncurry getChangeParams) (HashMap.toList cs) + Nothing -> error "No changes!" - let groupedParams = groupBy (\a b -> (a ^. textDocument == b ^. textDocument)) changeParams + modifyM $ \s -> do + newVFS <- liftIO $ changeFromServerVFS (vfs s) r + return $ s { vfs = newVFS } + + let groupedParams = groupBy (\a b -> (a ^. textDocument == b ^. textDocument)) allChangeParams mergedParams = map mergeParams groupedParams - forM_ mergedParams $ \p -> do - h <- serverIn <$> lift (lift Reader.ask) - let msg = NotificationMessage "2.0" TextDocumentDidChange p - liftIO $ B.hPut h $ addHeader (encode msg) + -- TODO: Don't do this when replaying a session + forM_ mergedParams (sendMessage . NotificationMessage "2.0" TextDocumentDidChange) + + -- Update VFS to new document versions + let sortedVersions = map (sortBy (compare `on` (^. textDocument . version))) groupedParams + latestVersions = map ((^. textDocument) . last) sortedVersions + bumpedVersions = map (version . _Just +~ 1) latestVersions + + forM_ bumpedVersions $ \(VersionedTextDocumentIdentifier uri v) -> + modify $ \s -> + let oldVFS = vfs s + update (VirtualFile oldV t) = VirtualFile (fromMaybe oldV v) t + newVFS = Map.adjust update uri oldVFS + in s { vfs = newVFS } + + where checkIfNeedsOpened uri = do + oldVFS <- vfs <$> get + ctx <- ask + + -- if its not open, open it + unless (uri `Map.member` oldVFS) $ do + let fp = fromJust $ uriToFilePath uri + contents <- liftIO $ T.readFile fp + let item = TextDocumentItem (filePathToUri fp) "" 0 contents + msg = NotificationMessage "2.0" TextDocumentDidOpen (DidOpenTextDocumentParams item) + liftIO $ B.hPut (serverIn ctx) $ addHeader (encode msg) + + modifyM $ \s -> do + newVFS <- liftIO $ openVFS (vfs s) msg + return $ s { vfs = newVFS } - where applyTextDocumentEdit (TextDocumentEdit docId (List edits)) = do - oldVFS <- vfs <$> lift State.get + getParams (TextDocumentEdit docId (List edits)) = let changeEvents = map (\e -> TextDocumentContentChangeEvent (Just (e ^. range)) Nothing (e ^. newText)) edits - params = DidChangeTextDocumentParams docId (List changeEvents) - newVFS <- liftIO $ changeVFS oldVFS (fmClientDidChangeTextDocumentNotification params) - lift $ State.modify (\s -> s { vfs = newVFS }) - return params + in DidChangeTextDocumentParams docId (List changeEvents) - applyTextEdit uri edits = applyTextDocumentEdit (TextDocumentEdit (VersionedTextDocumentIdentifier uri 0) edits) + textDocumentVersions uri = map (VersionedTextDocumentIdentifier uri . Just) [0..] + + textDocumentEdits uri edits = map (\(v, e) -> TextDocumentEdit v (List [e])) $ zip (textDocumentVersions uri) edits + + getChangeParams uri (List edits) = map getParams (textDocumentEdits uri (reverse edits)) mergeParams :: [DidChangeTextDocumentParams] -> DidChangeTextDocumentParams mergeParams params = let events = concat (toList (map (toList . (^. contentChanges)) params)) in DidChangeTextDocumentParams (head params ^. textDocument) (List events) -processTextChanges _ = return () \ No newline at end of file +updateState _ = return () + +sendMessage :: (MonadIO m, HasReader SessionContext m, ToJSON a) => a -> m () +sendMessage msg = do + h <- serverIn <$> ask + let encoded = encodePretty msg + + shouldLog <- asks $ logMessages . config + liftIO $ when shouldLog $ do + + setSGR [SetColor Foreground Dull Cyan] + putStrLn $ "--> " ++ B.unpack encoded + setSGR [Reset] + + B.hPut h (addHeader encoded) + +-- | Execute a block f that will throw a 'TimeoutException' +-- after duration seconds. This will override the global timeout +-- for waiting for messages to arrive defined in 'SessionConfig'. +withTimeout :: Int -> Session a -> Session a +withTimeout duration f = do + chan <- asks messageChan + timeoutId <- curTimeoutId <$> get + modify $ \s -> s { overridingTimeout = True } + liftIO $ forkIO $ do + threadDelay (duration * 1000000) + writeChan chan (TimeoutMessage timeoutId) + res <- f + modify $ \s -> s { curTimeoutId = timeoutId + 1, + overridingTimeout = False + } + return res