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   deriving Eq
  23
  24 instance Exception SessionException
  25
  26 instance Show SessionException where
  27   show (Timeout lastMsg) =
  28     "Timed out waiting to receive a message from the server." ++
  29     case lastMsg of
  30       Just msg -> "\nLast message received: " ++ show msg
  31       Nothing -> mempty
  32   show NoContentLengthHeader = "Couldn't read Content-Length header from the server."
  33   show (UnexpectedMessage expected lastMsg) =
  34     "Received an unexpected message from the server:\n" ++
  35     "Was parsing: " ++ expected ++ "\n" ++
  36     "Last message received: " ++ show lastMsg
  37   show (ReplayOutOfOrder received expected) =
  38     let expected' = nub expected
  39         getJsonDiff = lines . B.unpack . encodePretty
  40         showExp exp = B.unpack (encodePretty exp) ++ "\nDiff:\n" ++
  41                 ppDiff (getGroupedDiff (getJsonDiff received) (getJsonDiff exp))
  42     in "Replay is out of order:\n" ++
  43        -- Print json so its a bit easier to update the session logs
  44        "Received from server:\n" ++ B.unpack (encodePretty received) ++ "\n" ++
  45        "Raw from server:\n" ++ B.unpack (encode received) ++ "\n" ++
  46        "Expected one of:\n" ++ unlines (map showExp expected')
  47   show UnexpectedDiagnostics = "Unexpectedly received diagnostics from the server."
  48   show (IncorrectApplyEditRequest msgStr) = "ApplyEditRequest didn't contain document, instead received:\n"
  49                                           ++ msgStr
  50   show (UnexpectedResponseError lid e) = "Received an exepected error in a response for id " ++ show lid ++ ":\n"
  51                                           ++ show e
  52   show UnexpectedServerTermination = "Language server unexpectedly terminated"
  53
  54 -- | A predicate that matches on any 'SessionException'
  55 anySessionException :: SessionException -> Bool
  56 anySessionException = const True