1 module Language.Haskell.LSP.Test.Exceptions where
3 import Control.Exception
4 import Language.Haskell.LSP.Messages
5 import Language.Haskell.LSP.Types
7 import Data.Aeson.Encode.Pretty
8 import Data.Algorithm.Diff
9 import Data.Algorithm.DiffOutput
11 import qualified Data.ByteString.Lazy.Char8 as B
13 -- | An exception that can be thrown during a 'Haskell.LSP.Test.Session.Session'
14 data SessionException = Timeout
15 | NoContentLengthHeader
16 | UnexpectedMessage String FromServerMessage
17 | ReplayOutOfOrder FromServerMessage [FromServerMessage]
18 | UnexpectedDiagnostics
19 | IncorrectApplyEditRequest String
20 | UnexpectedResponseError LspIdRsp ResponseError
21 | UnexpectedServerTermination
24 instance Exception SessionException
26 instance Show SessionException where
27 show Timeout = "Timed out waiting to receive a message from the server."
28 show NoContentLengthHeader = "Couldn't read Content-Length header from the server."
29 show (UnexpectedMessage expected lastMsg) =
30 "Received an unexpected message from the server:\n" ++
31 "Was parsing: " ++ expected ++ "\n" ++
32 "Last message received: " ++ show lastMsg
33 show (ReplayOutOfOrder received expected) =
34 let expected' = nub expected
35 getJsonDiff = lines . B.unpack . encodePretty
36 showExp exp = B.unpack (encodePretty exp) ++ "\nDiff:\n" ++
37 ppDiff (getGroupedDiff (getJsonDiff received) (getJsonDiff exp))
38 in "Replay is out of order:\n" ++
39 -- Print json so its a bit easier to update the session logs
40 "Received from server:\n" ++ B.unpack (encodePretty received) ++ "\n" ++
41 "Raw from server:\n" ++ B.unpack (encode received) ++ "\n" ++
42 "Expected one of:\n" ++ unlines (map showExp expected')
43 show UnexpectedDiagnostics = "Unexpectedly received diagnostics from the server."
44 show (IncorrectApplyEditRequest msgStr) = "ApplyEditRequest didn't contain document, instead received:\n"
46 show (UnexpectedResponseError lid e) = "Received an exepected error in a response for id " ++ show lid ++ ":\n"
48 show UnexpectedServerTermination = "Language server unexpectedly terminated"
50 -- | A predicate that matches on any 'SessionException'
51 anySessionException :: SessionException -> Bool
52 anySessionException = const True