X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FParsing.hs;h=128cfb4018a4e9ce40bbabe86a86ac66f4edae22;hb=d1855cd1182c51333c82bf964fc96c8ec3ec76b7;hp=9e6bdd5c5739f07b9b8590598fe2a1c08cfcae86;hpb=0f8b9d328f4d950ff0a2e1c3b5aed593b21c2d3a;p=lsp-test.git

diff --git a/src/Language/Haskell/LSP/Test/Parsing.hs b/src/Language/Haskell/LSP/Test/Parsing.hs
index 9e6bdd5..128cfb4 100644
--- a/src/Language/Haskell/LSP/Test/Parsing.hs
+++ b/src/Language/Haskell/LSP/Test/Parsing.hs
@@ -1,85 +1,141 @@
 {-# LANGUAGE MultiParamTypeClasses #-}
-{-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE RankNTypes #-}
-module Language.Haskell.LSP.Test.Parsing where
+{-# LANGUAGE OverloadedStrings #-}
+
+module Language.Haskell.LSP.Test.Parsing
+  ( -- $receiving
+    message
+  , anyRequest
+  , anyResponse
+  , anyNotification
+  , anyMessage
+  , loggingNotification
+  , publishDiagnosticsNotification
+  , responseForId
+  ) where
 
 import Control.Applicative
 import Control.Concurrent
+import Control.Lens
 import Control.Monad.IO.Class
-import Control.Monad.Trans.Class
+import Control.Monad
 import Data.Aeson
 import qualified Data.ByteString.Lazy.Char8 as B
 import Data.Conduit.Parser
 import Data.Maybe
+import qualified Data.Text as T
+import Data.Typeable
 import Language.Haskell.LSP.Messages
-import Language.Haskell.LSP.Types hiding (error)
-import Language.Haskell.LSP.Test.Exceptions
+import Language.Haskell.LSP.Types as LSP hiding (error, message)
 import Language.Haskell.LSP.Test.Messages
 import Language.Haskell.LSP.Test.Session
 
-satisfy :: (MonadIO m, MonadSessionConfig m) => (a -> Bool) -> ConduitParser a m a
+-- $receiving
+-- To receive a message, just specify the type that expect:
+-- 
+-- @
+-- msg1 <- message :: Session ApplyWorkspaceEditRequest
+-- msg2 <- message :: Session HoverResponse
+-- @
+--
+-- 'Language.Haskell.LSP.Test.Session' is actually just a parser
+-- that operates on messages under the hood. This means that you
+-- can create and combine parsers to match speicifc sequences of
+-- messages that you expect.
+--
+-- For example, if you wanted to match either a definition or
+-- references request:
+-- 
+-- > defOrImpl = (message :: Session DefinitionRequest)
+-- >          <|> (message :: Session ReferencesRequest)
+--
+-- If you wanted to match any number of telemetry
+-- notifications immediately followed by a response:
+-- 
+-- @
+-- logThenDiags =
+--  skipManyTill (message :: Session TelemetryNotification)
+--               anyResponse 
+-- @
+
+satisfy :: (FromServerMessage -> Bool) -> Session FromServerMessage
 satisfy pred = do
-  timeout <- timeout <$> lift sessionConfig
-  tId <- liftIO myThreadId
-  liftIO $ forkIO $ do
+  
+  skipTimeout <- overridingTimeout <$> get
+  timeoutId <- curTimeoutId <$> get
+  unless skipTimeout $ do
+    chan <- asks messageChan
+    timeout <- asks (messageTimeout . config)
+    void $ liftIO $ forkIO $ do
       threadDelay (timeout * 1000000)
-    throwTo tId TimeoutException
+      writeChan chan (TimeoutMessage timeoutId)
+
   x <- await
+
+  unless skipTimeout $
+    modify $ \s -> s { curTimeoutId = timeoutId + 1 }
+
+  modify $ \s -> s { lastReceivedMessage = Just x }
+
   if pred x
-    then return x
+    then do
+      logMsg LogServer x
+      return x
     else empty
 
--- | Matches if the message is a notification.
-anyNotification :: (MonadIO m, MonadSessionConfig m) => ConduitParser FromServerMessage m FromServerMessage
-anyNotification = satisfy isServerNotification
+-- | 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) $
+    castMsg <$> satisfy (isJust . parser)
 
-notification :: forall m a. (MonadIO m, MonadSessionConfig m, FromJSON a) => ConduitParser FromServerMessage m (NotificationMessage ServerMethod a)
-notification = do
-  let parser = decode . encodeMsg :: FromServerMessage -> Maybe (NotificationMessage ServerMethod a)
-  x <- satisfy (isJust . parser)
-  return $ decodeMsg $ encodeMsg x
+-- | Matches if the message is a notification.
+anyNotification :: Session FromServerMessage
+anyNotification = named "Any notification" $ satisfy isServerNotification
 
 -- | Matches if the message is a request.
-anyRequest :: (MonadIO m, MonadSessionConfig m) => ConduitParser FromServerMessage m FromServerMessage
-anyRequest = satisfy isServerRequest
-
-request :: forall m a b. (MonadIO m, MonadSessionConfig m, FromJSON a, FromJSON b) => ConduitParser FromServerMessage m (RequestMessage ServerMethod a b)
-request = do
-  let parser = decode . encodeMsg :: FromServerMessage -> Maybe (RequestMessage ServerMethod a b)
-  x <- satisfy (isJust . parser)
-  return $ decodeMsg $ encodeMsg x
+anyRequest :: Session FromServerMessage
+anyRequest = named "Any request" $ satisfy isServerRequest
 
 -- | Matches if the message is a response.
-anyResponse :: (MonadIO m, MonadSessionConfig m) => ConduitParser FromServerMessage m FromServerMessage
-anyResponse = satisfy isServerResponse
+anyResponse :: Session FromServerMessage
+anyResponse = named "Any response" $ satisfy isServerResponse
 
-response :: forall m a. (MonadIO m, MonadSessionConfig m, FromJSON a) => ConduitParser FromServerMessage m (ResponseMessage a)
-response = do
+-- | 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)
-  x <- satisfy (isJust . parser)
-  return $ decodeMsg $ encodeMsg x
+  x <- satisfy (maybe False (\z -> z ^. LSP.id == responseId lid) . parser)
+  return $ castMsg x
+
+-- | Matches any type of message.
+anyMessage :: Session FromServerMessage
+anyMessage = satisfy (const True)
+
+-- | A stupid method for getting out the inner message.
+castMsg :: FromJSON a => FromServerMessage -> a
+castMsg = fromMaybe (error "Failed casting a message") . decode . encodeMsg
 
 -- | A version of encode that encodes FromServerMessages as if they
 -- weren't wrapped.
 encodeMsg :: FromServerMessage -> B.ByteString
 encodeMsg = encode . genericToJSON (defaultOptions { sumEncoding = UntaggedValue })
 
-decodeMsg :: FromJSON a => B.ByteString -> a
-decodeMsg x = fromMaybe (error $ "Unexpected message type\nGot:\n " ++ show x)
-                  (decode x)
-
 -- | Matches if the message is a log message notification or a show message notification/request.
-loggingNotification :: (MonadIO m, MonadSessionConfig m) => ConduitParser FromServerMessage m FromServerMessage
-loggingNotification = satisfy shouldSkip
+loggingNotification :: Session FromServerMessage
+loggingNotification = named "Logging notification" $ satisfy shouldSkip
   where
     shouldSkip (NotLogMessage _) = True
     shouldSkip (NotShowMessage _) = True
     shouldSkip (ReqShowMessage _) = True
     shouldSkip _ = False
 
-publishDiagnosticsNotification :: (MonadIO m, MonadSessionConfig m) => ConduitParser FromServerMessage m PublishDiagnosticsNotification
-publishDiagnosticsNotification = do
+-- | Matches a 'Language.Haskell.LSP.Test.PublishDiagnosticsNotification'
+-- (textDocument/publishDiagnostics) notification.
+publishDiagnosticsNotification :: Session PublishDiagnosticsNotification
+publishDiagnosticsNotification = named "Publish diagnostics notification" $ do
   NotPublishDiagnostics diags <- satisfy test
   return diags
   where test (NotPublishDiagnostics _) = True