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 | UnexpectedMessage String FromServerMessage
16 | ReplayOutOfOrder FromServerMessage [FromServerMessage]
17 | UnexpectedDiagnostics
18 | IncorrectApplyEditRequest String
19 | UnexpectedResponseError LspIdRsp ResponseError
22 instance Exception SessionException
24 instance Show SessionException where
25 show Timeout = "Timed out waiting to receive a message from the server."
26 show (UnexpectedMessage expected lastMsg) =
27 "Received an unexpected message from the server:\n" ++
28 "Was parsing: " ++ expected ++ "\n" ++
29 "Last message received: " ++ show lastMsg
30 show (ReplayOutOfOrder received expected) =
31 let expected' = nub expected
32 getJsonDiff = lines . B.unpack . encodePretty
33 showExp exp = B.unpack (encodePretty exp) ++ "\nDiff:\n" ++
34 ppDiff (getGroupedDiff (getJsonDiff received) (getJsonDiff exp))
35 in "Replay is out of order:\n" ++
36 -- Print json so its a bit easier to update the session logs
37 "Received from server:\n" ++ B.unpack (encodePretty received) ++ "\n" ++
38 "Raw from server:\n" ++ B.unpack (encode received) ++ "\n" ++
39 "Expected one of:\n" ++ unlines (map showExp expected')
40 show UnexpectedDiagnostics = "Unexpectedly received diagnostics from the server."
41 show (IncorrectApplyEditRequest msgStr) = "ApplyEditRequest didn't contain document, instead received:\n"
43 show (UnexpectedResponseError lid e) = "Received an exepected error in a response for id " ++ show lid ++ ":\n"
46 -- | A predicate that matches on any 'SessionException'
47 anySessionException :: SessionException -> Bool
48 anySessionException = const True