X-Git-Url: https://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FParsing.hs;h=acd458c77a76df9e65dfb4e8ec1952681ff89969;hb=8802accf03b0bd9f063e5563ed769b23c6750fd8;hp=70481b979a83a67434dff19f1bb304af3ee65789;hpb=46ab99233a7ba2045c51a85125afff764486f72b;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test/Parsing.hs b/src/Language/Haskell/LSP/Test/Parsing.hs index 70481b9..acd458c 100644 --- a/src/Language/Haskell/LSP/Test/Parsing.hs +++ b/src/Language/Haskell/LSP/Test/Parsing.hs @@ -1,19 +1,29 @@ {-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE EmptyCase #-} +{-# LANGUAGE TypeOperators #-} {-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE PolyKinds #-} +{-# LANGUAGE KindSignatures #-} +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE GADTs #-} +{-# LANGUAGE LambdaCase #-} {-# LANGUAGE RankNTypes #-} {-# LANGUAGE OverloadedStrings #-} module Language.Haskell.LSP.Test.Parsing ( -- $receiving satisfy + , satisfyMaybe , message + , responseForId + , customRequest + , customNotification , anyRequest , anyResponse , anyNotification , anyMessage , loggingNotification , publishDiagnosticsNotification - , responseForId ) where import Control.Applicative @@ -21,24 +31,20 @@ import Control.Concurrent import Control.Lens import Control.Monad.IO.Class import Control.Monad -import Data.Aeson -import qualified Data.ByteString.Lazy.Char8 as B import Data.Conduit.Parser hiding (named) import qualified Data.Conduit.Parser (named) +import Data.GADT.Compare import qualified Data.Text as T import Data.Typeable -import Language.Haskell.LSP.Messages import Language.Haskell.LSP.Types -import qualified Language.Haskell.LSP.Types.Lens as LSP -import Language.Haskell.LSP.Test.Messages import Language.Haskell.LSP.Test.Session -- $receiving --- To receive a message, just specify the type that expect: +-- To receive a message, specify the method of the message to expect: -- -- @ --- msg1 <- message :: Session ApplyWorkspaceEditRequest --- msg2 <- message :: Session HoverResponse +-- msg1 <- message SWorkspaceApplyEdit +-- msg2 <- message STextDocumentHover -- @ -- -- 'Language.Haskell.LSP.Test.Session' is actually just a parser @@ -49,15 +55,15 @@ import Language.Haskell.LSP.Test.Session -- For example, if you wanted to match either a definition or -- references request: -- --- > defOrImpl = (message :: Session DefinitionRequest) --- > <|> (message :: Session ReferencesRequest) +-- > defOrImpl = message STextDocumentDefinition +-- > <|> message STextDocumentReferences -- -- If you wanted to match any number of telemetry -- notifications immediately followed by a response: -- -- @ -- logThenDiags = --- skipManyTill (message :: Session TelemetryNotification) +-- skipManyTill (message STelemetryEvent) -- anyResponse -- @ @@ -71,10 +77,13 @@ satisfy pred = satisfyMaybe (\msg -> if pred msg then Just msg else Nothing) -- -- @since 0.6.1.0 satisfyMaybe :: (FromServerMessage -> Maybe a) -> Session a -satisfyMaybe pred = do +satisfyMaybe pred = satisfyMaybeM (pure . pred) + +satisfyMaybeM :: (FromServerMessage -> Session (Maybe a)) -> Session a +satisfyMaybeM pred = do skipTimeout <- overridingTimeout <$> get - timeoutId <- curTimeoutId <$> get + timeoutId <- getCurTimeoutId unless skipTimeout $ do chan <- asks messageChan timeout <- asks (messageTimeout . config) @@ -84,12 +93,13 @@ satisfyMaybe pred = do x <- Session await - unless skipTimeout $ - modify $ \s -> s { curTimeoutId = timeoutId + 1 } + unless skipTimeout (bumpTimeoutId timeoutId) modify $ \s -> s { lastReceivedMessage = Just x } - case pred x of + res <- pred x + + case res of Just a -> do logMsg LogServer x return a @@ -98,50 +108,106 @@ satisfyMaybe pred = do named :: T.Text -> Session a -> Session a named s (Session x) = Session (Data.Conduit.Parser.named s x) --- | Matches a message of type @a@. -message :: forall a. (Typeable a, FromJSON a) => Session a -message = - let parser = decode . encodeMsg :: FromServerMessage -> Maybe a - in named (T.pack $ show $ head $ snd $ splitTyConApp $ last $ typeRepArgs $ typeOf parser) $ - satisfyMaybe parser +mEq :: SServerMethod m1 -> SServerMethod m2 -> Maybe (m1 :~~: m2) +mEq m1 m2 = case (splitServerMethod m1, splitServerMethod m2) of + (IsServerNot, IsServerNot) -> do + Refl <- geq m1 m2 + pure HRefl + (IsServerReq, IsServerReq) -> do + Refl <- geq m1 m2 + pure HRefl + _ -> Nothing + +mEqClient :: SClientMethod m1 -> SClientMethod m2 -> Maybe (m1 :~~: m2) +mEqClient m1 m2 = case (splitClientMethod m1, splitClientMethod m2) of + (IsClientNot, IsClientNot) -> do + Refl <- geq m1 m2 + pure HRefl + (IsClientReq, IsClientReq) -> do + Refl <- geq m1 m2 + pure HRefl + _ -> Nothing + +-- | Matches non-custom messages +message :: SServerMethod m -> Session (ServerMessage m) +message m1 = named (T.pack $ show m1) $ satisfyMaybe $ \case + FromServerMess m2 msg -> do + HRefl <- mEq m1 m2 + pure msg + _ -> Nothing + +customRequest :: T.Text -> Session (ServerMessage (CustomMethod :: Method FromServer Request)) +customRequest m = named m $ satisfyMaybe $ \case + FromServerMess m1 msg -> case splitServerMethod m1 of + IsServerEither -> case msg of + ReqMess _ | m1 == SCustomMethod m -> Just msg + _ -> Nothing + _ -> Nothing + _ -> Nothing + +customNotification :: T.Text -> Session (ServerMessage (CustomMethod :: Method FromServer Notification)) +customNotification m = named m $ satisfyMaybe $ \case + FromServerMess m1 msg -> case splitServerMethod m1 of + IsServerEither -> case msg of + NotMess _ | m1 == SCustomMethod m -> Just msg + _ -> Nothing + _ -> Nothing + _ -> Nothing -- | Matches if the message is a notification. anyNotification :: Session FromServerMessage -anyNotification = named "Any notification" $ satisfy isServerNotification +anyNotification = named "Any notification" $ satisfy $ \case + FromServerMess m msg -> case splitServerMethod m of + IsServerNot -> True + IsServerEither -> case msg of + NotMess _ -> True + _ -> False + _ -> False + FromServerRsp _ _ -> False -- | Matches if the message is a request. anyRequest :: Session FromServerMessage -anyRequest = named "Any request" $ satisfy isServerRequest +anyRequest = named "Any request" $ satisfy $ \case + FromServerMess m _ -> case splitServerMethod m of + IsServerReq -> True + _ -> False + FromServerRsp _ _ -> False -- | Matches if the message is a response. anyResponse :: Session FromServerMessage -anyResponse = named "Any response" $ satisfy isServerResponse +anyResponse = named "Any response" $ satisfy $ \case + FromServerMess _ _ -> False + FromServerRsp _ _ -> True -- | Matches a response for a specific id. -responseForId :: forall a. FromJSON a => LspId -> Session (ResponseMessage a) -responseForId lid = named (T.pack $ "Response for id: " ++ show lid) $ do - let parser = decode . encodeMsg :: FromServerMessage -> Maybe (ResponseMessage a) +responseForId :: SMethod (m :: Method FromClient Request) -> LspId m -> Session (ResponseMessage m) +responseForId m lid = named (T.pack $ "Response for id: " ++ show lid) $ do satisfyMaybe $ \msg -> do - z <- parser msg - guard (z ^. LSP.id == responseId lid) - pure z + case msg of + FromServerMess _ _ -> Nothing + FromServerRsp m' rspMsg@(ResponseMessage _ lid' _) -> + case mEqClient m m' of + Just HRefl -> do + guard (lid' == Just lid) + pure rspMsg + Nothing + | SCustomMethod tm <- m + , SCustomMethod tm' <- m' + , tm == tm' + , lid' == Just lid -> pure rspMsg + _ -> empty -- | Matches any type of message. anyMessage :: Session FromServerMessage anyMessage = satisfy (const True) --- | A version of encode that encodes FromServerMessages as if they --- weren't wrapped. -encodeMsg :: FromServerMessage -> B.ByteString -encodeMsg = encode . genericToJSON (defaultOptions { sumEncoding = UntaggedValue }) - -- | Matches if the message is a log message notification or a show message notification/request. loggingNotification :: Session FromServerMessage loggingNotification = named "Logging notification" $ satisfy shouldSkip where - shouldSkip (NotLogMessage _) = True - shouldSkip (NotShowMessage _) = True - shouldSkip (ReqShowMessage _) = True + shouldSkip (FromServerMess SWindowLogMessage _) = True + shouldSkip (FromServerMess SWindowShowMessage _) = True + shouldSkip (FromServerMess SWindowShowMessageRequest _) = True shouldSkip _ = False -- | Matches a 'Language.Haskell.LSP.Test.PublishDiagnosticsNotification' @@ -149,5 +215,5 @@ loggingNotification = named "Logging notification" $ satisfy shouldSkip publishDiagnosticsNotification :: Session PublishDiagnosticsNotification publishDiagnosticsNotification = named "Publish diagnostics notification" $ satisfyMaybe $ \msg -> case msg of - NotPublishDiagnostics diags -> Just diags + FromServerMess STextDocumentPublishDiagnostics diags -> Just diags _ -> Nothing