1 {-# LANGUAGE MultiParamTypeClasses #-}
2 {-# LANGUAGE EmptyCase #-}
3 {-# LANGUAGE TypeOperators #-}
4 {-# LANGUAGE ScopedTypeVariables #-}
5 {-# LANGUAGE TypeInType #-}
6 {-# LANGUAGE KindSignatures #-}
7 {-# LANGUAGE TypeInType #-}
9 {-# LANGUAGE LambdaCase #-}
10 {-# LANGUAGE RankNTypes #-}
11 {-# LANGUAGE OverloadedStrings #-}
13 module Language.LSP.Test.Parsing
27 , publishDiagnosticsNotification
30 import Control.Applicative
31 import Control.Concurrent
32 import Control.Monad.IO.Class
34 import Data.Conduit.Parser hiding (named)
35 import qualified Data.Conduit.Parser (named)
36 import qualified Data.Text as T
38 import Language.LSP.Types
39 import Language.LSP.Test.Session
42 -- To receive a message, specify the method of the message to expect:
45 -- msg1 <- message SWorkspaceApplyEdit
46 -- msg2 <- message STextDocumentHover
49 -- 'Language.LSP.Test.Session' is actually just a parser
50 -- that operates on messages under the hood. This means that you
51 -- can create and combine parsers to match speicifc sequences of
52 -- messages that you expect.
54 -- For example, if you wanted to match either a definition or
55 -- references request:
57 -- > defOrImpl = message STextDocumentDefinition
58 -- > <|> message STextDocumentReferences
60 -- If you wanted to match any number of telemetry
61 -- notifications immediately followed by a response:
65 -- skipManyTill (message STelemetryEvent)
69 -- | Consumes and returns the next message, if it satisfies the specified predicate.
72 satisfy :: (FromServerMessage -> Bool) -> Session FromServerMessage
73 satisfy pred = satisfyMaybe (\msg -> if pred msg then Just msg else Nothing)
75 -- | Consumes and returns the result of the specified predicate if it returns `Just`.
78 satisfyMaybe :: (FromServerMessage -> Maybe a) -> Session a
79 satisfyMaybe pred = satisfyMaybeM (pure . pred)
81 satisfyMaybeM :: (FromServerMessage -> Session (Maybe a)) -> Session a
82 satisfyMaybeM pred = do
84 skipTimeout <- overridingTimeout <$> get
85 timeoutId <- getCurTimeoutId
90 chan <- asks messageChan
91 timeout <- asks (messageTimeout . config)
93 threadDelay (timeout * 1000000)
94 writeChan chan (TimeoutMessage timeoutId)
98 forM_ mtid $ \tid -> do
99 bumpTimeoutId timeoutId
100 liftIO $ killThread tid
102 modify $ \s -> s { lastReceivedMessage = Just x }
112 named :: T.Text -> Session a -> Session a
113 named s (Session x) = Session (Data.Conduit.Parser.named s x)
116 -- | Matches a request or a notification coming from the server.
117 message :: SServerMethod m -> Session (ServerMessage m)
118 message m1 = named (T.pack $ "Request for: " <> show m1) $ satisfyMaybe $ \case
119 FromServerMess m2 msg -> do
120 res <- mEqServer m1 m2
122 Right HRefl -> pure msg
126 customRequest :: T.Text -> Session (ServerMessage (CustomMethod :: Method FromServer Request))
127 customRequest m = named m $ satisfyMaybe $ \case
128 FromServerMess m1 msg -> case splitServerMethod m1 of
129 IsServerEither -> case msg of
130 ReqMess _ | m1 == SCustomMethod m -> Just msg
135 customNotification :: T.Text -> Session (ServerMessage (CustomMethod :: Method FromServer Notification))
136 customNotification m = named m $ satisfyMaybe $ \case
137 FromServerMess m1 msg -> case splitServerMethod m1 of
138 IsServerEither -> case msg of
139 NotMess _ | m1 == SCustomMethod m -> Just msg
144 -- | Matches if the message is a notification.
145 anyNotification :: Session FromServerMessage
146 anyNotification = named "Any notification" $ satisfy $ \case
147 FromServerMess m msg -> case splitServerMethod m of
149 IsServerEither -> case msg of
153 FromServerRsp _ _ -> False
155 -- | Matches if the message is a request.
156 anyRequest :: Session FromServerMessage
157 anyRequest = named "Any request" $ satisfy $ \case
158 FromServerMess m _ -> case splitServerMethod m of
161 FromServerRsp _ _ -> False
163 -- | Matches if the message is a response.
164 anyResponse :: Session FromServerMessage
165 anyResponse = named "Any response" $ satisfy $ \case
166 FromServerMess _ _ -> False
167 FromServerRsp _ _ -> True
169 -- | Matches a response coming from the server.
170 response :: SMethod (m :: Method FromClient Request) -> Session (ResponseMessage m)
171 response m1 = named (T.pack $ "Response for: " <> show m1) $ satisfyMaybe $ \case
172 FromServerRsp m2 msg -> do
173 HRefl <- runEq mEqClient m1 m2
177 -- | Like 'response', but matches a response for a specific id.
178 responseForId :: SMethod (m :: Method FromClient Request) -> LspId m -> Session (ResponseMessage m)
179 responseForId m lid = named (T.pack $ "Response for id: " ++ show lid) $ do
180 satisfyMaybe $ \msg -> do
182 FromServerMess _ _ -> Nothing
183 FromServerRsp m' rspMsg@(ResponseMessage _ lid' _) -> do
184 HRefl <- runEq mEqClient m m'
185 guard (Just lid == lid')
188 -- | Matches any type of message.
189 anyMessage :: Session FromServerMessage
190 anyMessage = satisfy (const True)
192 -- | Matches if the message is a log message notification or a show message notification/request.
193 loggingNotification :: Session FromServerMessage
194 loggingNotification = named "Logging notification" $ satisfy shouldSkip
196 shouldSkip (FromServerMess SWindowLogMessage _) = True
197 shouldSkip (FromServerMess SWindowShowMessage _) = True
198 shouldSkip (FromServerMess SWindowShowMessageRequest _) = True
201 -- | Matches a 'Language.LSP.Types.TextDocumentPublishDiagnostics'
202 -- (textDocument/publishDiagnostics) notification.
203 publishDiagnosticsNotification :: Session (Message TextDocumentPublishDiagnostics)
204 publishDiagnosticsNotification = named "Publish diagnostics notification" $
205 satisfyMaybe $ \msg -> case msg of
206 FromServerMess STextDocumentPublishDiagnostics diags -> Just diags