From: Luke Lau Date: Sat, 19 May 2018 20:22:37 +0000 (-0400) Subject: Flesh out server playback checks X-Git-Tag: 0.1.0.0~109 X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=commitdiff_plain;h=092af98d24a00b540c3370774ebaa33161e98f3b Flesh out server playback checks --- diff --git a/src/Language/Haskell/LSP/Test/Recorded.hs b/src/Language/Haskell/LSP/Test/Recorded.hs index 6bf2319..d109d9a 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,17 +1,21 @@ {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleContexts #-} module Language.Haskell.LSP.Test.Recorded ( replay ) where import Control.Concurrent -import Control.Monad import Data.Default import Language.Haskell.LSP.Control as Control import qualified Data.ByteString.Lazy.Char8 as B import Language.Haskell.LSP.Core import qualified Language.Haskell.LSP.Types as LSP import Data.Aeson +import Data.List +import Data.Maybe +import Control.Lens +import Control.Monad import System.IO import System.Process @@ -30,45 +34,109 @@ replay cfp sfp = do hSetBuffering serverIn NoBuffering hSetBuffering serverOut NoBuffering + -- todo: use qsem -- whether to send the next request - semaphore <- newEmptyMVar + reqSema <- newEmptyMVar :: IO (MVar LSP.LspIdRsp) + -- whether to send the next response + rspSema <- newEmptyMVar :: IO (MVar LSP.LspId) + let semas = (reqSema, rspSema) -- the recorded client input to the server clientRecIn <- openFile cfp ReadMode serverRecIn <- openFile sfp ReadMode null <- openFile "/dev/null" WriteMode + + expectedMsgs <- getAllMessages serverRecIn + -- listen to server - forkIO $ forever $ do - msg <- getNextMessage serverOut - expectedMsg <- getNextMessage serverRecIn - putStrLn $ "received: " ++ (show msg) - putStrLn $ "next expected: " ++ (show expectedMsg) - case decode msg :: Maybe (LSP.RequestMessage Value Value Value) of - Just _ -> putStrLn "ignoring request" >> return () - Nothing -> when (msg /= expectedMsg) $ error ("Expected " ++ show expectedMsg ++ " but got " ++ show msg) - case decode msg :: Maybe (LSP.ResponseMessage Value) of - Just _ -> putMVar semaphore () - Nothing -> return () -- might be a notification or something, that's ok + forkIO $ listenServer expectedMsgs serverOut semas - -- send inialize request ourselves since haskell-lsp consumes it + -- send initialize request ourselves since haskell-lsp consumes it -- rest are handled via `handlers` sendInitialize clientRecIn serverIn + -- wait for initialize response + putStrLn "Waiting for initialzie response" + takeMVar reqSema + putStrLn "Got initialize response" + Control.runWithHandles clientRecIn null (const $ Right (), const $ return Nothing) - (handlers serverIn semaphore) + (handlers serverIn semas) def Nothing Nothing where + listenServer :: [B.ByteString] -> Handle -> (MVar LSP.LspIdRsp, MVar LSP.LspId) -> IO () + listenServer expectedMsgs h semas@(reqSema, rspSema) = do + msg <- getNextMessage h + putStrLn $ "Remaining messages " ++ show (length expectedMsgs) + if inRightOrder msg expectedMsgs + then do + + -- if we got a request response unblock the replay waiting for a response + whenResponse msg $ \res -> do + putStrLn ("Got response for id " ++ show (res ^. LSP.id)) + putMVar reqSema (res ^. LSP.id) + + whenRequest msg $ \req -> do + putStrLn ("Got request for id " ++ show (req ^. LSP.id) ++ " " ++ show (req ^. LSP.method)) + putMVar rspSema (req ^. LSP.id) + + listenServer (delete msg expectedMsgs) h semas + else error $ "Got: " ++ show msg ++ "\n Expected: " ++ show (head (filter (not . isNotification) expectedMsgs)) + sendInitialize recH serverH = do message <- getNextMessage recH B.hPut serverH (addHeader message) + putStrLn $ "Sent initialize response " ++ show message -- bring the file back to the start for haskell-lsp hSeek recH AbsoluteSeek 0 +isNotification :: B.ByteString -> Bool +isNotification msg = isJust (decode msg :: Maybe (LSP.NotificationMessage Value Value)) + +whenResponse :: B.ByteString -> (LSP.ResponseMessage Value -> IO ()) -> IO () +whenResponse msg f = + case decode msg :: Maybe (LSP.ResponseMessage Value) of + Just msg' -> when (isJust (msg' ^. LSP.result)) (f msg') + _ -> return () + +whenRequest :: B.ByteString -> (LSP.RequestMessage Value Value Value -> IO ()) -> IO () +whenRequest msg = forM_ (decode msg :: (Maybe (LSP.RequestMessage Value Value Value))) + +-- TODO: QuickCheck tests? +-- | Checks wether or not the message appears in the right order +-- @ N1 N2 N3 REQ1 N4 N5 REQ2 RES1 @ +-- given N2, notification order doesn't matter. +-- @ N1 N3 REQ1 N4 N5 REQ2 RES1 @ +-- given REQ1 +-- @ N1 N3 N4 N5 REQ2 RES1 @ +-- given RES1 +-- @ N1 N3 N4 N5 XXXX RES1 @ False! +-- Order of requests and responses matter +inRightOrder :: B.ByteString -> [B.ByteString] -> Bool +inRightOrder _ [] = error "why is this empty" +inRightOrder received msgs = received `elem` valid + where valid = takeWhile canSkip msgs ++ firstNonSkip + -- we don't care about the order of notifications + canSkip = isNotification + nonSkip = dropWhile canSkip msgs + firstNonSkip + | null nonSkip = [] + | otherwise = [head nonSkip] + +getAllMessages :: Handle -> IO [B.ByteString] +getAllMessages h = do + done <- hIsEOF h + if done + then return [] + else do + msg <- getNextMessage h + (msg:) <$> getAllMessages h + -- | Fetches the next message bytes based on -- the Content-Length header getNextMessage :: Handle -> IO B.ByteString @@ -79,8 +147,8 @@ getNextMessage h = do Just size -> B.hGet h size -handlers :: Handle -> MVar () -> Handlers -handlers serverH flag = def +handlers :: Handle -> (MVar LSP.LspIdRsp, MVar LSP.LspId) -> Handlers +handlers serverH (reqSema, rspSema) = def { -- Requests hoverHandler = Just request @@ -112,17 +180,32 @@ handlers serverH flag = def , initializedHandler = Just notification , willSaveTextDocumentNotificationHandler = Just notification , cancelNotificationHandler = Just notification - , responseHandler = Just notification + -- Responses + , responseHandler = Just response } where notification m = do B.hPut serverH $ addHeader (encode m) - putStrLn "sent a notification" - request m = do - B.hPut serverH $ addHeader (encode m) - putStrLn "sent a request, waiting for a response" - takeMVar flag - putStrLn "got a response" + putStrLn "Sent a notification" + + request msg@(LSP.RequestMessage _ id m _) = do + + B.hPut serverH $ addHeader (encode msg) + putStrLn $ "Sent a request id " ++ show id ++ ": " ++ show m ++ "\nWaiting for a response" + + rspId <- takeMVar reqSema + if LSP.responseId id /= rspId + then error $ "Expected id " ++ show id ++ ", got " ++ show rspId + else putStrLn $ "Got a response for request id " ++ show id ++ ": " ++ show m + + response msg@(LSP.ResponseMessage _ id _ _) = do + putStrLn $ "Waiting for request id " ++ show id ++ " from the server" + reqId <- takeMVar rspSema + if LSP.responseId reqId /= id + then error $ "Expected id " ++ show reqId ++ ", got " ++ show reqId + else do + B.hPut serverH $ addHeader (encode msg) + putStrLn $ "Sent response to request id " ++ show id addHeader :: B.ByteString -> B.ByteString addHeader content = B.concat