Add openDoc convenience function
[lsp-test.git] / src / Language / Haskell / LSP / Test.hs
index 22a674675481545eb879c26914a2f7868157fb27..068fc2dd0a3cbc17e9da1b98b0f92c5238263f5b 100644 (file)
@@ -22,60 +22,71 @@ module Language.Haskell.LSP.Test
   , sendNotification
   , sendRequest'
   , sendNotification'
-  , sendResponse'
+  , sendResponse
   -- * Receving
-  , getMessage
+  , request
+  , response
+  , notification
+  , loggingNotification
+  -- * Combinators
+  , choice
+  , option
+  , optional
+  , skipOptional
+  , between
+  , some
+  , many
+  , sepBy
+  , sepBy1
+  , sepByNonEmpty
+  , sepEndBy1
+  , sepEndByNonEmpty
+  , sepEndBy
+  , endBy1
+  , endByNonEmpty
+  , endBy
+  , count
+  , chainl
+  , chainr
+  , chainl1
+  , chainr1
+  , manyTill
+  , try
+  , (<?>)
+  , skipMany
+  , skipSome
+  , unexpected
+  , notFollowedBy
+  , (<|>)
+  , satisfy
   -- * Utilities
+  , openDoc
   , getDocItem
   , getDocUri
   ) where
 
+import Control.Applicative
 import Control.Monad
-import Control.Monad.Trans.Class
 import Control.Monad.IO.Class
-import Control.Monad.Trans.Reader
-import Control.Monad.Trans.State
 import Control.Concurrent
+import Control.Lens
 import qualified Data.Text as T
 import qualified Data.Text.IO as T
 import Data.Aeson
 import qualified Data.ByteString.Lazy.Char8 as B
 import Data.Default
-import Data.Maybe
 import Data.Proxy
 import System.Process
-import Language.Haskell.LSP.Types hiding (error, id)
-import Compat
+import Language.Haskell.LSP.Types
+import qualified  Language.Haskell.LSP.Types as LSP (error)
+import Language.Haskell.LSP.Messages
+import Language.Haskell.LSP.Test.Compat
 import System.IO
 import System.Directory
 import System.FilePath
+import Language.Haskell.LSP.Test.Decoding
 import Language.Haskell.LSP.Test.Parsing
-
-data SessionContext = SessionContext
-  {
-    messageSema :: MVar B.ByteString,
-    serverIn :: Handle,
-    rootDir :: FilePath
-  }
-
-newtype SessionState = SessionState
-  {
-    curReqId :: LspId
-  }
-
--- | A session representing one instance of launching and connecting to a server.
--- 
--- You can send and receive messages to the server within 'Session' via 'getMessage',
--- 'sendRequest' and 'sendNotification'.
---
--- @
--- runSession \"path\/to\/root\/dir\" $ do
---   docItem <- getDocItem "Desktop/simple.hs" "haskell"
---   sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams docItem)
---   diagnostics <- getMessage :: Session PublishDiagnosticsNotification
--- @
--- 
-type Session = StateT SessionState (ReaderT SessionContext IO)
+import Text.Parser.Combinators
 
 -- | Starts a new session.
 runSession :: FilePath -- ^ The filepath to the root directory for the session.
@@ -96,8 +107,8 @@ runSession rootDir session = do
 
     -- Wrap the session around initialize and shutdown calls
     sendRequest (Proxy :: Proxy InitializeRequest) Initialize initializeParams
-    (ResponseMessage _ _ (Just (InitializeResponseCapabilities _)) e) <- getMessage
-    liftIO $ maybe (return ()) (putStrLn . ("Error when initializing: " ++) . show ) e
+    RspInitialize initRsp <- response
+    liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRsp ^. LSP.error)
 
     sendNotification Initialized InitializedParams
 
@@ -106,6 +117,8 @@ runSession rootDir session = do
 
     sendNotification Exit ExitParams
 
+-- | An internal version of 'runSession' that allows for a custom handler to listen to the server.
+-- It also does not automatically send initialize and exit messages.
 runSessionWithHandler :: (Handle -> Session ())
                       -> FilePath
                       -> Session a
@@ -120,13 +133,15 @@ runSessionWithHandler serverHandler rootDir session = do
   hSetBuffering serverIn  NoBuffering
   hSetBuffering serverOut NoBuffering
 
-  messageSema <- newEmptyMVar
+  reqMap <- newMVar newRequestMap
+  messageChan <- newChan
+  meaninglessChan <- newChan
 
-  let context = SessionContext messageSema serverIn absRootDir
+  let context = SessionContext serverIn absRootDir messageChan reqMap
       initState = SessionState (IdInt 9)
 
-  forkIO $ void $ runReaderT (runStateT (serverHandler serverOut) initState) context
-  (result, _) <- runReaderT (runStateT session initState) context
+  forkIO $ void $ runSession' meaninglessChan context initState (serverHandler serverOut)
+  (result, _) <- runSession' messageChan context initState session
 
   terminateProcess serverProc
 
@@ -136,16 +151,12 @@ runSessionWithHandler serverHandler rootDir session = do
 -- signals any semaphores
 listenServer :: Handle -> Session ()
 listenServer serverOut = do
-  context <- lift ask
   msgBytes <- liftIO $ getNextMessage serverOut
 
-  liftIO $ case decode msgBytes :: Maybe LogMessageNotification of
-    -- Just print log and show messages
-    Just (NotificationMessage _ WindowLogMessage (LogMessageParams _ msg)) -> T.putStrLn msg
-    _ -> case decode msgBytes :: Maybe ShowMessageNotification of
-      Just (NotificationMessage _ WindowShowMessage (ShowMessageParams _ msg)) -> T.putStrLn msg
-    -- Give everything else for getMessage to handle
-      _ -> putMVar (messageSema context) msgBytes
+  context <- ask
+  reqMap <- liftIO $ readMVar $ requestMap context
+
+  liftIO $ writeChan (messageChan context) $ decodeFromServerMsg reqMap msgBytes
 
   listenServer serverOut
 
@@ -164,7 +175,7 @@ sendRequest
   -> Session LspId -- ^ The id of the request that was sent.
 sendRequest _ method params = do
   id <- curReqId <$> get
-  get >>= \c -> put c { curReqId = nextId id }
+  modify $ \c -> c { curReqId = nextId id }
 
   let req = RequestMessage "2.0" id method params :: RequestMessage ClientMethod params resp
 
@@ -175,8 +186,13 @@ sendRequest _ method params = do
   where nextId (IdInt i) = IdInt (i + 1)
         nextId (IdString s) = IdString $ T.pack $ show $ read (T.unpack s) + 1
 
-sendRequest' :: (ToJSON a, ToJSON b, ToJSON c) => RequestMessage a b c -> Session ()
-sendRequest' = sendMessage
+sendRequest' :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session ()
+sendRequest' req = do
+  -- Update the request map
+  reqMap <- requestMap <$> ask
+  liftIO $ modifyMVar_ reqMap (return . flip updateRequestMap req)
+
+  sendMessage req
 
 -- | Sends a notification to the server.
 sendNotification :: ToJSON a
@@ -190,27 +206,27 @@ sendNotification method params =
 sendNotification' :: (ToJSON a, ToJSON b) => NotificationMessage a b -> Session ()
 sendNotification' = sendMessage
 
-sendResponse' :: ToJSON a => ResponseMessage a -> Session ()
-sendResponse' = sendMessage
+sendResponse :: ToJSON a => ResponseMessage a -> Session ()
+sendResponse = sendMessage
 
 sendMessage :: ToJSON a => a -> Session ()
 sendMessage msg = do
-  h <- serverIn <$> lift ask
+  h <- serverIn <$> ask
   liftIO $ B.hPut h $ addHeader (encode msg)
 
--- | Reads in a message from the server.
-getMessage :: FromJSON a => Session a
-getMessage = do
-  sema <- messageSema <$> lift ask
-  bytes <- liftIO $ takeMVar sema
-  return $ fromMaybe (error $ "Wrong type! Got: " ++ show bytes) (decode bytes)
+-- | Opens a text document and sends a notification to the client.
+openDoc :: FilePath -> String -> Session TextDocumentIdentifier
+openDoc file languageId = do
+  item <- getDocItem file languageId
+  sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams item)
+  TextDocumentIdentifier <$> getDocUri file
 
 -- | Reads in a text document as the first version.
 getDocItem :: FilePath -- ^ The path to the text document to read in.
            -> String -- ^ The language ID, e.g "haskell" for .hs files.
            -> Session TextDocumentItem
 getDocItem file languageId = do
-  context <- lift ask
+  context <- ask
   let fp = rootDir context </> file
   contents <- liftIO $ T.readFile fp
   return $ TextDocumentItem (filePathToUri fp) (T.pack languageId) 0 contents
@@ -218,6 +234,6 @@ getDocItem file languageId = do
 -- | Gets the Uri for the file corrected to the session directory.
 getDocUri :: FilePath -> Session Uri
 getDocUri file = do
-  context <- lift ask
+  context <- ask
   let fp = rootDir context </> file
   return $ filePathToUri fp
\ No newline at end of file