Decode responses to the correct type
[lsp-test.git] / src / Language / Haskell / LSP / Test / Recorded.hs
index f856144caa2b268d9cd890be82d835385a3660d7..36a55fafd5adf579365b2c612b40ae1010e0dfd5 100644 (file)
@@ -11,12 +11,10 @@ where
 import           Control.Concurrent
 import           Control.Monad.Trans.Class
 import           Control.Monad.Trans.Reader
-import           Data.Default
 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
@@ -40,7 +38,9 @@ replay sessionFp curRootDir = do
   prevDir <- getCurrentDirectory
 
   (Just serverIn, Just serverOut, _, serverProc) <- createProcess
-    (proc "hie" ["--lsp", "-l", "/tmp/hie.log"]) { std_in  = CreatePipe , std_out = CreatePipe }
+    (proc "hie" ["--lsp", "-l", "/tmp/hie.log"]) { std_in  = CreatePipe
+                                                 , std_out = CreatePipe
+                                                 }
 
   hSetBuffering serverIn  NoBuffering
   hSetBuffering serverOut NoBuffering
@@ -60,15 +60,17 @@ replay sessionFp curRootDir = do
 
   events <- swapFiles curRootDir unswappedEvents
 
-  let clientEvents = map (\(FromClient _ msg) -> msg) $ filter isClientMsg events
-      serverEvents = map (\(FromServer _ msg) -> msg) $ filter isServerMsg events
+  let clientEvents =
+        map (\(FromClient _ msg) -> msg) $ filter isClientMsg events
+      serverEvents =
+        map (\(FromServer _ msg) -> msg) $ filter isServerMsg events
+      requestMap = getRequestMap clientEvents
 
   -- listen to server
-  forkIO $ runReaderT (listenServer serverEvents serverOut semas) didPass
+  forkIO $ runReaderT (listenServer serverEvents serverOut requestMap semas)
+                      didPass
 
-  forM_ clientEvents (processClient serverIn)
-
-  print events
+  forM_ clientEvents (processClient serverIn rspSema reqSema)
 
   result <- takeMVar didPass
   terminateProcess serverProc
@@ -84,10 +86,6 @@ replay sessionFp curRootDir = do
   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
@@ -113,6 +111,20 @@ processClient serverH rspSema reqSema msg = case msg of
   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
@@ -171,64 +183,121 @@ passSession = do
 
 -- | 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 newExpectedMsgs h semas
-
-  where response :: LSP.ResponseMessage a -> Session [FromServerMessage]
-        response res = do
+listenServer
+  :: [FromServerMessage]
+  -> Handle
+  -> RequestMap
+  -> (MVar LSP.LspIdRsp, MVar LSP.LspId)
+  -> Session ()
+listenServer []           _ _      _                        = passSession
+listenServer expectedMsgs h reqMap semas@(reqSema, rspSema) = do
+  msgBytes <- lift $ getNextMessage h
+
+  let actualMsg = decodeFromServerMsg reqMap msgBytes
+
+  lift $ print actualMsg
+
+  newExpectedMsgs <- case actualMsg of
+    ReqRegisterCapability       m -> request actualMsg m
+    ReqApplyWorkspaceEdit       m -> request actualMsg m
+    ReqShowMessage              m -> request actualMsg m
+    ReqUnregisterCapability     m -> request actualMsg m
+    RspInitialize               m -> response actualMsg m
+    RspShutdown                 m -> response actualMsg m
+    RspHover                    m -> response actualMsg m
+    RspCompletion               m -> response actualMsg m
+    RspCompletionItemResolve    m -> response actualMsg m
+    RspSignatureHelp            m -> response actualMsg m
+    RspDefinition               m -> response actualMsg m
+    RspFindReferences           m -> response actualMsg m
+    RspDocumentHighlights       m -> response actualMsg m
+    RspDocumentSymbols          m -> response actualMsg m
+    RspWorkspaceSymbols         m -> response actualMsg m
+    RspCodeAction               m -> response actualMsg m
+    RspCodeLens                 m -> response actualMsg m
+    RspCodeLensResolve          m -> response actualMsg m
+    RspDocumentFormatting       m -> response actualMsg m
+    RspDocumentRangeFormatting  m -> response actualMsg m
+    RspDocumentOnTypeFormatting m -> response actualMsg m
+    RspRename                   m -> response actualMsg m
+    RspExecuteCommand           m -> response actualMsg m
+    RspError                    m -> response actualMsg m
+    RspDocumentLink             m -> response actualMsg m
+    RspDocumentLinkResolve      m -> response actualMsg m
+    RspWillSaveWaitUntil        m -> response actualMsg m
+    NotPublishDiagnostics       m -> notification actualMsg m
+    NotLogMessage               m -> notification actualMsg m
+    NotShowMessage              m -> notification actualMsg m
+    NotTelemetry                m -> notification actualMsg m
+    NotCancelRequestFromServer  m -> notification actualMsg m
+
+  listenServer newExpectedMsgs h reqMap semas
+ where
+  response
+    :: Show a
+    => FromServerMessage
+    -> LSP.ResponseMessage a
+    -> Session [FromServerMessage]
+  response msg res = do
     lift $ putStrLn $ "Got response for id " ++ show (res ^. LSP.id)
 
     lift $ print res
 
-          checkOrder res
+    checkOrder msg
 
     lift $ putMVar reqSema (res ^. LSP.id) -- unblock the handler waiting to send a request
 
-          markReceived res
-
-        request :: LSP.RequestMessage LSP.ServerMethod a b -> Session [FromServerMessage]
-        request req = do
-          lift $ putStrLn $ "Got request for id " ++ show (req ^. LSP.id) ++ " " ++ show (req ^. LSP.method)
+    markReceived msg
+
+  request
+    :: (Show a, Show b)
+    => FromServerMessage
+    -> LSP.RequestMessage LSP.ServerMethod a b
+    -> Session [FromServerMessage]
+  request msg req = do
+    lift
+      $  putStrLn
+      $  "Got request for id "
+      ++ show (req ^. LSP.id)
+      ++ " "
+      ++ show (req ^. LSP.method)
 
     lift $ print req
 
-          checkOrder req
+    checkOrder msg
 
     lift $ putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response
 
-          markReceived req
+    markReceived msg
 
-        notification :: LSP.NotificationMessage LSP.ServerMethod a -> Session [FromServerMessage]
-        notification n = do
+  notification
+    :: Show a
+    => FromServerMessage
+    -> LSP.NotificationMessage LSP.ServerMethod a
+    -> Session [FromServerMessage]
+  notification msg n = do
     lift $ putStrLn $ "Got notification " ++ show (n ^. LSP.method)
     lift $ print n
 
-          lift $ putStrLn $ show (length (filter isNotification expectedMsgs) - 1) ++ " notifications remaining"
+    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")
+      else markReceived msg
+
+  checkOrder msg = unless (inRightOrder msg expectedMsgs) $ failSession
+    (  "Out of order\nExpected\n"
+    ++ show firstExpected
+    ++ "\nGot\n"
+    ++ show msg
+    ++ "\n"
+    )
 
-        markReceived :: Eq a => a -> [FromServerMessage] -> Session [FromServerMessage]
+  markReceived :: 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
@@ -253,12 +322,12 @@ isNotification _ = False
 -- 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