-- | A testing tool for replaying recorded client logs back to a server,
-- and validating that the server output matches up with another log.
module Language.Haskell.LSP.Test.Recorded
- ( replay
+ ( replay,
+ sendNextRequest
)
where
import Control.Concurrent
import Control.Monad.Trans.Class
import Control.Monad.Trans.Reader
-import Data.Default
+import Control.Monad.Trans.State
+import Control.Monad.IO.Class
import qualified Data.ByteString.Lazy.Char8 as B
-import Data.List
import Language.Haskell.LSP.Capture
import Language.Haskell.LSP.Messages
-import Language.Haskell.LSP.Core
import qualified Language.Haskell.LSP.Types as LSP
import Data.Aeson
import Data.Maybe
import Control.Monad
import System.IO
import System.Directory
+import System.FilePath
import System.Process
import Language.Haskell.LSP.Test.Files
import Language.Haskell.LSP.Test.Parsing
+data SessionContext = SessionContext
+ {
+ reqSema :: MVar FromServerMessage,
+ rspSema :: MVar LSP.LspId,
+ serverIn :: Handle
+ }
+type Session = StateT [FromClientMessage] (ReaderT SessionContext IO)
+
-- | Replays a recorded client output and
-- makes sure it matches up with an expected response.
-replay
- :: FilePath -- ^ The recorded session file.
- -> FilePath -- ^ The root directory of the project
- -> IO Bool
-replay sessionFp curRootDir = do
+replay :: FilePath -- ^ The recorded session directory.
+ -> Session a
+ -> IO ()
+replay sessionDir session = do
- -- need to keep hold of current directory since haskell-lsp changes it
- prevDir <- getCurrentDirectory
+ let sessionFp = sessionDir </> "session.log"
(Just serverIn, Just serverOut, _, serverProc) <- createProcess
- (proc "hie" ["--lsp", "-l", "/tmp/hie.log"]) { std_in = CreatePipe , std_out = CreatePipe }
+ (proc "hie" ["--lsp", "-d", "-l", "/tmp/test-hie.log"]) { std_in = CreatePipe
+ , std_out = CreatePipe
+ }
hSetBuffering serverIn NoBuffering
hSetBuffering serverOut NoBuffering
-- whether to send the next request
- reqSema <- newEmptyMVar :: IO (MVar LSP.LspIdRsp)
+ reqSema <- newEmptyMVar
-- whether to send the next response
- rspSema <- newEmptyMVar :: IO (MVar LSP.LspId)
- let semas = (reqSema, rspSema)
-
- didPass <- newEmptyMVar
+ rspSema <- newEmptyMVar
entries <- B.lines <$> B.readFile sessionFp
-- decode session
let unswappedEvents = map (fromJust . decode) entries
- events <- swapFiles curRootDir unswappedEvents
+ events <- swapFiles sessionDir unswappedEvents
let clientEvents = map (\(FromClient _ msg) -> msg) $ filter isClientMsg events
- serverEvents = map (\(FromServer _ msg) -> msg) $ filter isServerMsg events
+ requestMap = getRequestMap clientEvents
+ context = (SessionContext rspSema reqSema serverIn)
-- listen to server
- forkIO $ runReaderT (listenServer serverEvents serverOut semas) didPass
-
- forM_ clientEvents (processClient serverIn)
+ forkIO $ listenServer serverOut requestMap context
- print events
+ runReaderT (runStateT session clientEvents) context
- result <- takeMVar didPass
terminateProcess serverProc
- -- restore directory
- setCurrentDirectory prevDir
-
- return result
where
isClientMsg (FromClient _ _) = True
isClientMsg _ = False
isServerMsg (FromServer _ _) = True
isServerMsg _ = False
-processEvent :: Handle -> MVar LSP.LspId -> MVar LSP.LspIdRsp -> Event -> IO ()
-processEvent serverH rspSema reqSema (FromClient _ msg) = processClient serverH rspSema reqSema msg
-processEvent _ _ _ (FromServer _ msg) = processServer msg
-
-processClient
- :: Handle -> MVar LSP.LspId -> MVar LSP.LspIdRsp -> FromClientMessage -> IO ()
-processClient serverH rspSema reqSema msg = case msg of
+sendNextRequest :: Session FromServerMessage
+sendNextRequest = do
+ (nextMsg:remainingMsgs) <- get
+ put remainingMsgs
+ case nextMsg of
ReqInitialize m -> request m
ReqShutdown m -> request m
ReqHover m -> request m
ReqDocumentLink m -> request m
ReqDocumentLinkResolve m -> request m
ReqWillSaveWaitUntil m -> request m
+ RspApplyWorkspaceEdit m -> response m
+ RspFromClient m -> response m
+ NotInitialized m -> notification m
+ NotExit m -> notification m
+ NotCancelRequestFromClient m -> notification m
+ NotDidChangeConfiguration m -> notification m
+ NotDidOpenTextDocument m -> notification m
+ NotDidChangeTextDocument m -> notification m
+ NotDidCloseTextDocument m -> notification m
+ NotWillSaveTextDocument m -> notification m
+ NotDidSaveTextDocument m -> notification m
+ NotDidChangeWatchedFiles m -> notification m
+ UnknownFromClientMessage m ->
+ error $ "Unknown message was recorded from the client" ++ show m
where
-- TODO: May need to prevent premature exit notification being sent
notification msg@(LSP.NotificationMessage _ LSP.Exit _) = do
+ context <- lift ask
+
+ liftIO $ do
putStrLn "Will send exit notification soon"
threadDelay 10000000
- B.hPut serverH $ addHeader (encode msg)
+ B.hPut (serverIn context) $ addHeader (encode msg)
+
+ error "Done"
+
notification msg@(LSP.NotificationMessage _ m _) = do
- B.hPut serverH $ addHeader (encode msg)
+ context <- lift ask
+
+ liftIO $ B.hPut (serverIn context) $ addHeader (encode msg)
+
+ liftIO $ putStrLn $ "Sent a notification " ++ show m
- putStrLn $ "Sent a notification " ++ show m
+ sendNextRequest
request msg@(LSP.RequestMessage _ id m _) = do
+ context <- lift ask
- when (m == LSP.TextDocumentDocumentSymbol) $ threadDelay 5000000
+ liftIO $ do
- B.hPut serverH $ addHeader (encode msg)
- putStrLn
- $ "Sent a request id "
- ++ show id
- ++ ": "
- ++ show m
- ++ "\nWaiting for a response"
-
- rspId <- takeMVar reqSema
- when (LSP.responseId id /= rspId)
- $ error
- $ "Expected id "
- ++ show id
- ++ ", got "
- ++ show rspId
+ print $ addHeader $ encode msg
+
+ B.hPut (serverIn context) $ addHeader (encode msg)
+ putStrLn $ "Sent a request id " ++ show id ++ ": " ++ show m ++ "\nWaiting for a response"
+
+ rsp <- takeMVar (reqSema context)
+ -- when (LSP.responseId id /= rsp ^. LSP.id) $
+ -- error $ "Expected id " ++ show id ++ ", got " ++ show (rsp ^. LSP.id)
+
+ return rsp
response msg@(LSP.ResponseMessage _ id _ _) = do
+ context <- lift ask
+
+ liftIO $ do
putStrLn $ "Waiting for request id " ++ show id ++ " from the server"
- reqId <- takeMVar rspSema
+ reqId <- takeMVar (rspSema context)
if LSP.responseId reqId /= id
then error $ "Expected id " ++ show reqId ++ ", got " ++ show reqId
else do
- B.hPut serverH $ addHeader (encode msg)
+ B.hPut (serverIn context) $ addHeader (encode msg)
putStrLn $ "Sent response to request id " ++ show id
--- | The internal monad for tests that can fail or pass,
--- ending execution early.
-type Session = ReaderT (MVar Bool) IO
+ sendNextRequest
--- TODO: Make return type polymoprhic more like error
-failSession :: String -> Session ()
-failSession reason = do
- lift $ putStrLn reason
- passVar <- ask
- lift $ putMVar passVar False
-
-passSession :: Session ()
-passSession = do
- passVar <- ask
- lift $ putMVar passVar True
-- | Listens to the server output, makes sure it matches the record and
-- signals any semaphores
-listenServer :: [FromServerMessage] -> Handle -> (MVar LSP.LspIdRsp, MVar LSP.LspId) -> Session ()
-listenServer [] _ _ = passSession
-listenServer expectedMsgs h semas@(reqSema, rspSema) = do
- msg <- lift $ getNextMessage h
-
- newExpectedMsgs <- case decode msg of
- Just m -> request m
- Nothing -> case decode msg of
- Just m -> notification m
- Nothing -> case decode msg of
- Just m -> response m
- Nothing -> failSession "Malformed message" >> return expectedMsgs
+listenServer :: Handle -> RequestMap -> SessionContext -> IO ()
+listenServer h reqMap context = do
+
+ msgBytes <- getNextMessage h
+
+ let msg = decodeFromServerMsg reqMap msgBytes
+
+ print msg
+
+ case msg of
+ ReqRegisterCapability m -> request m
+ ReqApplyWorkspaceEdit m -> request m
+ ReqShowMessage m -> request m
+ ReqUnregisterCapability m -> request m
+ RspInitialize m -> response m msg
+ RspShutdown m -> response m msg
+ RspHover m -> response m msg
+ RspCompletion m -> response m msg
+ RspCompletionItemResolve m -> response m msg
+ RspSignatureHelp m -> response m msg
+ RspDefinition m -> response m msg
+ RspFindReferences m -> response m msg
+ RspDocumentHighlights m -> response m msg
+ RspDocumentSymbols m -> response m msg
+ RspWorkspaceSymbols m -> response m msg
+ RspCodeAction m -> response m msg
+ RspCodeLens m -> response m msg
+ RspCodeLensResolve m -> response m msg
+ RspDocumentFormatting m -> response m msg
+ RspDocumentRangeFormatting m -> response m msg
+ RspDocumentOnTypeFormatting m -> response m msg
+ RspRename m -> response m msg
+ RspExecuteCommand m -> response m msg
+ RspError m -> response m msg
+ RspDocumentLink m -> response m msg
+ RspDocumentLinkResolve m -> response m msg
+ RspWillSaveWaitUntil m -> response m msg
+ NotPublishDiagnostics m -> notification m
+ NotLogMessage m -> notification m
+ NotShowMessage m -> notification m
+ NotTelemetry m -> notification m
+ NotCancelRequestFromServer m -> notification m
+
+ listenServer h reqMap context
- listenServer newExpectedMsgs h semas
-
- where response :: LSP.ResponseMessage a -> Session [FromServerMessage]
- response res = do
- lift $ putStrLn $ "Got response for id " ++ show (res ^. LSP.id)
-
- lift $ print res
-
- checkOrder res
-
- lift $ putMVar reqSema (res ^. LSP.id) -- unblock the handler waiting to send a request
+ where
+ response :: Show a => LSP.ResponseMessage a -> FromServerMessage -> IO ()
+ response res wrappedMsg = do
+ putStrLn $ "Got response for id " ++ show (res ^. LSP.id)
- markReceived res
+ putMVar (reqSema context) wrappedMsg -- send back the response for the request we're waiting on
- request :: LSP.RequestMessage LSP.ServerMethod a b -> Session [FromServerMessage]
+ request :: Show a => LSP.RequestMessage LSP.ServerMethod a b -> IO ()
request req = do
- lift $ putStrLn $ "Got request for id " ++ show (req ^. LSP.id) ++ " " ++ show (req ^. LSP.method)
-
- lift $ print req
-
- checkOrder req
-
- lift $ putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response
-
- markReceived req
-
- notification :: LSP.NotificationMessage LSP.ServerMethod a -> Session [FromServerMessage]
- notification n = do
- lift $ putStrLn $ "Got notification " ++ show (n ^. LSP.method)
- lift $ print n
-
- lift $ putStrLn $ show (length (filter isNotification expectedMsgs) - 1) ++ " notifications remaining"
-
- if n ^. LSP.method == LSP.WindowLogMessage
- then return expectedMsgs
- else markReceived n
-
- checkOrder msg = unless (inRightOrder msg expectedMsgs) $ do
- let (Just expected) = decode firstExpected
- _ = expected == msg -- make expected type same as res
- failSession ("Out of order\nExpected\n" ++ show expected ++ "\nGot\n" ++ show msg ++ "\n")
-
- markReceived :: Eq a => a -> [FromServerMessage] -> Session [FromServerMessage]
- markReceived msg =
- -- TODO: Find some way of equating FromServerMessage and LSP.ResponseMessage etc.
- let new = delete msg expectedMsgs
- in if new == expectedMsgs
- then failSession ("Unexpected message: " ++ show msg) >> return new
- else return new
-
- firstExpected = head $ filter (not . isNotification) expectedMsgs
+ putStrLn
+ $ "Got request for id "
+ ++ show (req ^. LSP.id)
+ ++ " "
+ ++ show (req ^. LSP.method)
+
+ putMVar (rspSema context) (req ^. LSP.id) -- unblock the handler waiting for a response
+
+ notification :: Show a => LSP.NotificationMessage LSP.ServerMethod a -> IO ()
+ notification n = putStrLn $ "Got notification " ++ show (n ^. LSP.method)
+
+ -- lift
+ -- $ putStrLn
+ -- $ show (length (filter isNotification expectedMsgs) - 1)
+ -- ++ " notifications remaining"
+
+ -- checkOrder msg = unless (inRightOrder msg expectedMsgs) $ failSession
+ -- ( "Out of order\nExpected\n"
+ -- ++ show firstExpected
+ -- ++ "\nGot\n"
+ -- ++ show msg
+ -- ++ "\n"
+ -- )
+
+ -- markReceived :: FromServerMessage -> Session [FromServerMessage]
+ -- markReceived msg =
+ -- let new = delete msg expectedMsgs
+ -- in if new == expectedMsgs
+ -- then failSession ("Unexpected message: " ++ show msg) >> return new
+ -- else return new
+
+ -- firstExpected = head $ filter (not . isNotification) expectedMsgs
isNotification :: FromServerMessage -> Bool
isNotification (NotPublishDiagnostics _) = True
-- given RES1
-- @ N1 N3 N4 N5 XXXX RES1 @ False!
-- Order of requests and responses matter
-inRightOrder :: (FromJSON a, Eq a) => a -> [B.ByteString] -> Bool
+inRightOrder :: FromServerMessage -> [FromServerMessage] -> Bool
inRightOrder _ [] = error "Why is this empty"
-- inRightOrder (LSP.NotificationMessage _ _ _) _ = True
inRightOrder received (expected : msgs)
- | Just received == decode expected = True
+ | received == expected = True
| isNotification expected = inRightOrder received msgs
| otherwise = False
+
+-- | The internal monad for tests that can fail or pass,
+-- ending execution early.
+-- type Session = ReaderT (MVar Bool) IO
+
+-- -- TODO: Make return type polymoprhic more like error
+-- failSession :: String -> Session ()
+-- failSession reason = do
+-- lift $ putStrLn reason
+-- passVar <- ask
+-- lift $ putMVar passVar False
+
+-- passSession :: Session ()
+-- passSession = do
+-- passVar <- ask
+-- lift $ putMVar passVar True
\ No newline at end of file