lsp-test: export runSessionWithConfig' to allow modifying the CreateProcess (#449)

* Export runSessionWithConfig' to allow modifying the CreateProcess
* More meaningful name for runSessionWithConfig'
* Fix up haddocks
* Remove stray whitespace

Author: thomasjm

lsp-test/src/Language/LSP/Test.hs

@@ -25,6 +25,7 @@ module Language.LSP.Test
     Session
   , runSession
   , runSessionWithConfig
+  , runSessionWithConfigCustomProcess
   , runSessionWithHandles
   , runSessionWithHandles'
   -- ** Config
@@ -133,7 +134,7 @@ import System.Environment
 import System.IO
 import System.Directory
 import System.FilePath
-import System.Process (ProcessHandle)
+import System.Process (ProcessHandle, CreateProcess)
 import qualified System.FilePath.Glob as Glob
 import Control.Monad.State (execState)
 
@@ -159,9 +160,19 @@ runSessionWithConfig :: SessionConfig -- ^ Configuration options for the session
                      -> FilePath -- ^ The filepath to the root directory for the session.
                      -> Session a -- ^ The session to run.
                      -> IO a
-runSessionWithConfig config' serverExe caps rootDir session = do
+runSessionWithConfig = runSessionWithConfigCustomProcess id
+
+-- | Starts a new session with a custom configuration and server 'CreateProcess'.
+runSessionWithConfigCustomProcess :: (CreateProcess -> CreateProcess) -- ^ Tweak the 'CreateProcess' used to start the server.
+                                  -> SessionConfig -- ^ Configuration options for the session.
+                                  -> String -- ^ The command to run the server.
+                                  -> C.ClientCapabilities -- ^ The capabilities that the client should declare.
+                                  -> FilePath -- ^ The filepath to the root directory for the session.
+                                  -> Session a -- ^ The session to run.
+                                  -> IO a
+runSessionWithConfigCustomProcess modifyCreateProcess config' serverExe caps rootDir session = do
   config <- envOverrideConfig config'
-  withServer serverExe (logStdErr config) $ \serverIn serverOut serverProc ->
+  withServer serverExe (logStdErr config) modifyCreateProcess $ \serverIn serverOut serverProc ->
     runSessionWithHandles' (Just serverProc) serverIn serverOut config caps rootDir session
 
 -- | Starts a new session, using the specified handles to communicate with the
@@ -770,7 +781,7 @@ getSemanticTokens :: TextDocumentIdentifier -> Session (Maybe SemanticTokens)
 getSemanticTokens doc = do
   let params = SemanticTokensParams Nothing Nothing doc
   rsp <- request STextDocumentSemanticTokensFull params
-  pure $ getResponseResult rsp 
+  pure $ getResponseResult rsp
 
 -- | Returns a list of capabilities that the server has requested to /dynamically/
 -- register during the 'Session'.

lsp-test/src/Language/LSP/Test/Replay.hs

@@ -44,7 +44,7 @@ replaySession serverExe sessionDir = do
   -- decode session
   let unswappedEvents = map (fromJust . decode) entries
 
-  withServer serverExe False $ \serverIn serverOut serverProc -> do
+  withServer serverExe False id $ \serverIn serverOut serverProc -> do
 
     pid <- getProcessID serverProc
     events <- swapCommands pid <$> swapFiles sessionDir unswappedEvents

lsp-test/src/Language/LSP/Test/Server.hs

@@ -6,13 +6,13 @@ import Language.LSP.Test.Compat
 import System.IO
 import System.Process hiding (withCreateProcess)
 
-withServer :: String -> Bool -> (Handle -> Handle -> ProcessHandle -> IO a) -> IO a
-withServer serverExe logStdErr f = do
+withServer :: String -> Bool -> (CreateProcess -> CreateProcess) -> (Handle -> Handle -> ProcessHandle -> IO a) -> IO a
+withServer serverExe logStdErr modifyCreateProcess f = do
   -- TODO Probably should just change runServer to accept
   -- separate command and arguments
   let cmd:args = words serverExe
       createProc = (proc cmd args) { std_in = CreatePipe, std_out = CreatePipe, std_err = CreatePipe }
-  withCreateProcess createProc $ \(Just serverIn) (Just serverOut) (Just serverErr) serverProc -> do
+  withCreateProcess (modifyCreateProcess createProc) $ \(Just serverIn) (Just serverOut) (Just serverErr) serverProc -> do
     -- Need to continuously consume to stderr else it gets blocked
     -- Can't pass NoStream either to std_err
     hSetBuffering serverErr NoBuffering