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.Encode.Pretty
   7 import Data.Algorithm.Diff
   8 import Data.Algorithm.DiffOutput
   9 import Data.List
  10 import qualified Data.ByteString.Lazy.Char8 as B
  11
  12 data SessionException = Timeout
  13                       | UnexpectedMessage String FromServerMessage
  14                       | ReplayOutOfOrder FromServerMessage [FromServerMessage]
  15                       | UnexpectedDiagnostics
  16                       | IncorrectApplyEditRequest String
  17                       | UnexpectedResponseError LspIdRsp ResponseError
  18   deriving Eq
  19
  20 instance Exception SessionException
  21
  22 instance Show SessionException where
  23   show Timeout = "Timed out waiting to receive a message from the server."
  24   show (UnexpectedMessage expected lastMsg) =
  25     "Received an unexpected message from the server:\n" ++
  26     "Was parsing: " ++ expected ++ "\n" ++
  27     "Last message received: " ++ show lastMsg
  28   show (ReplayOutOfOrder received expected) =
  29     let expected' = nub expected
  30         getJsonDiff = lines . B.unpack . encodePretty
  31         showExp exp = B.unpack (encodePretty exp) ++ "\nDiff:\n" ++
  32                 ppDiff (getGroupedDiff (getJsonDiff received) (getJsonDiff exp))
  33     in "Replay is out of order:\n" ++
  34        -- Print json so its a bit easier to update the session logs
  35        "Received from server:\n" ++ B.unpack (encodePretty received) ++ "\n" ++
  36        "Expected one of:\n" ++ unlines (map showExp expected')
  37   show UnexpectedDiagnostics = "Unexpectedly received diagnostics from the server."
  38   show (IncorrectApplyEditRequest msgStr) = "ApplyEditRequest didn't contain document, instead received:\n"
  39                                           ++ msgStr
  40   show (UnexpectedResponseError lid e) = "Received an exepected error in a response for id " ++ show lid ++ ":\n"
  41                                           ++ show e
  42
  43 anySessionException :: SessionException -> Bool
  44 anySessionException = const True