src/Language/Haskell/LSP/Test/Exceptions.hs

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