Mappings for capabilities (#581)

* Add golden tests for client cap generation

* Add mappings for capabilities

* Fix commment

Author: michaelpj

.gitignore

@@ -20,3 +20,4 @@ hie
 .hie
 hie.yaml
 .envrc
+**/.golden/*/actual

lsp-test/README.md

@@ -8,7 +8,7 @@ and [lsp-types](https://hackage.haskell.org/package/lsp-types)
 
 ```haskell
 import Language.LSP.Test
-main = runSession "hie" fullCaps "proj/dir" $ do
+main = runSession "hie" fullLatestClientCaps "proj/dir" $ do
   doc <- openDoc "Foo.hs" "haskell"
   skipMany anyNotification
   symbols <- getDocumentSymbols doc
@@ -19,7 +19,7 @@ main = runSession "hie" fullCaps "proj/dir" $ do
 ### Unit tests with HSpec
 ```haskell
 describe "diagnostics" $
-  it "report errors" $ runSession "hie" fullCaps "test/data" $ do
+  it "report errors" $ runSession "hie" fullLatestClientCaps "test/data" $ do
     openDoc "Error.hs" "haskell"
     [diag] <- waitForDiagnosticsSource "ghcmod"
     liftIO $ do

lsp-test/bench/SimpleBench.hs

@@ -56,7 +56,7 @@ main = do
 
   i <- newIORef (0 :: Integer)
 
-  Test.runSessionWithHandles hinWrite houtRead Test.defaultConfig Test.fullCaps "." $ do
+  Test.runSessionWithHandles hinWrite houtRead Test.defaultConfig Test.fullLatestClientCaps "." $ do
     start <- liftIO offsetTime
     replicateM_ n $ do
       v <- liftIO $ readIORef i

lsp-test/example/Test.hs

@@ -7,7 +7,7 @@ import Language.LSP.Protocol.Types
 import Language.LSP.Test
 
 main :: IO ()
-main = runSession "lsp-demo-reactor-server" fullCaps "test/data/" $ do
+main = runSession "lsp-demo-reactor-server" fullLatestClientCaps "test/data/" $ do
   doc <- openDoc "Rename.hs" "haskell"
 
   -- Use your favourite favourite combinators.

lsp-test/func-test/FuncTest.hs

@@ -83,7 +83,7 @@ spec = do
                 updater $ ProgressAmount (Just 75) (Just "step3")
                 liftIO $ waitBarrier b3
 
-      runSessionWithServer logger definition Test.defaultConfig Test.fullCaps "." $ do
+      runSessionWithServer logger definition Test.defaultConfig Test.fullLatestClientCaps "." $ do
         Test.sendRequest (SMethod_CustomMethod (Proxy @"something")) J.Null
 
         -- Wait until we have seen a begin messsage. This means that the token setup
@@ -144,7 +144,7 @@ spec = do
                 -- Wait around to be cancelled, set the MVar only if we are
                 liftIO $ threadDelay (5 * 1000000) `Control.Exception.catch` (\(e :: ProgressCancelledException) -> modifyMVar_ wasCancelled (\_ -> pure True))
 
-      runSessionWithServer logger definition Test.defaultConfig Test.fullCaps "." $ do
+      runSessionWithServer logger definition Test.defaultConfig Test.fullLatestClientCaps "." $ do
         Test.sendRequest (SMethod_CustomMethod (Proxy @"something")) J.Null
 
         -- Wait until we have created the progress so the updates will be sent individually
@@ -190,7 +190,7 @@ spec = do
                   takeMVar killVar
                   Control.Exception.throwIO AsyncCancelled
 
-      runSessionWithServer logger definition Test.defaultConfig Test.fullCaps "." $ do
+      runSessionWithServer logger definition Test.defaultConfig Test.fullLatestClientCaps "." $ do
         -- First make sure that we get a $/progress begin notification
         skipManyTill Test.anyMessage $ do
           x <- Test.message SMethod_Progress
@@ -235,7 +235,7 @@ spec = do
                 updater $ ProgressAmount (Just 75) (Just "step3")
                 liftIO $ waitBarrier b3
 
-      runSessionWithServer logger definition Test.defaultConfig Test.fullCaps "." $ do
+      runSessionWithServer logger definition Test.defaultConfig Test.fullLatestClientCaps "." $ do
         Test.sendRequest SMethod_TextDocumentCodeLens (CodeLensParams (Just $ ProgressToken $ InR "hello") Nothing (TextDocumentIdentifier $ Uri "."))
 
         -- First make sure that we get a $/progress begin notification
@@ -318,7 +318,7 @@ spec = do
                 ps = DidChangeWorkspaceFoldersParams ev
              in Test.sendNotification SMethod_WorkspaceDidChangeWorkspaceFolders ps
 
-      runSessionWithServer logger definition config Test.fullCaps "." $ do
+      runSessionWithServer logger definition config Test.fullLatestClientCaps "." $ do
         changeFolders [wf1] []
         changeFolders [wf2] [wf1]
 

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

@@ -30,7 +30,7 @@ module Language.LSP.Test (
   -- ** Config
   SessionConfig (..),
   defaultConfig,
-  C.fullCaps,
+  C.fullLatestClientCaps,
 
   -- ** Exceptions
   module Language.LSP.Test.Exceptions,
@@ -181,7 +181,7 @@ import System.Process (CreateProcess, ProcessHandle)
 
 {- | Starts a new session.
 
- > runSession "hie" fullCaps "path/to/root/dir" $ do
+ > runSession "hie" fullLatestClientCaps "path/to/root/dir" $ do
  >   doc <- openDoc "Desktop/simple.hs" "haskell"
  >   diags <- waitForDiagnostics
  >   let pos = Position 12 5
@@ -243,7 +243,7 @@ runSessionWithConfigCustomProcess modifyCreateProcess config' serverExe caps roo
  > (houtRead, houtWrite) <- createPipe
  >
  > forkIO $ void $ runServerWithHandles hinRead houtWrite serverDefinition
- > runSessionWithHandles hinWrite houtRead defaultConfig fullCaps "." $ do
+ > runSessionWithHandles hinWrite houtRead defaultConfig fullLatestClientCaps "." $ do
  >   -- ...
 -}
 runSessionWithHandles ::

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

@@ -67,7 +67,7 @@ replaySession serverExe sessionDir = do
       runSessionWithHandles serverIn serverOut serverProc
                             (listenServer serverMsgs requestMap reqSema rspSema passSema mainThread)
                             def
-                            fullCaps
+                            fullLatestClientCaps
                             sessionDir
                             (return ()) -- No finalizer cleanup
                             (sendMessages clientMsgs reqSema rspSema)