Upgrade to new version of lsp libraries (#2494)

* Update to latest version of lsp libraries

* Compute completions on kick

This is not only for faster completions.
 It's also needed to have semi-fresh completions after editing.
This is specially important for the first completion request of a file - without this change there are no  completions available at all

* Emit LSP custom messages on kick start/finish

useful to synchonize on these events in tests

* Fix completions tests after haskell/lsp#376

* Restore cabal update with comments

* Use new lsp in stack 9.0.1

Co-authored-by: Pepe Iborra <[email protected]>
Co-authored-by: jneira <[email protected]>

Author: 3 people

.github/workflows/bench.yml

@@ -118,6 +118,9 @@ jobs:
               ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
               ${{ env.cache-name }}-${{ runner.os }}-
 
+    # To ensure we get the lastest hackage index and not relying on haskell action logic
+    - run: cabal update
+
     # max-backjumps is increased as a temporary solution
     # for dependency resolution failure
     - run: cabal configure --enable-benchmarks --max-backjumps 12000

.github/workflows/caching.yml

@@ -182,6 +182,10 @@ jobs:
                 ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
                 ${{ env.cache-name }}-${{ runner.os }}-
 
+      # To ensure we get the lastest hackage index and not relying on haskell action logic
+      - if: steps.compiled-deps.outputs.cache-hit != 'true'
+        run: cabal update
+
       - if: steps.compiled-deps.outputs.cache-hit != 'true' && runner.os == 'Linux' && matrix.ghc == '8.10.7'
         name: Download sources for bench
         #  Downloaded separately, to match the tested work/PR workflow guarantees

.github/workflows/test.yml

@@ -179,6 +179,10 @@ jobs:
                 ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
                 ${{ env.cache-name }}-${{ runner.os }}-
 
+      # To ensure we get the lastest hackage index and not relying on haskell action logic
+      - if: steps.compiled-deps.outputs.cache-hit != 'true'
+        run: cabal update
+
       # repeating builds to workaround segfaults in windows and ghc-8.8.4
       - name: Build
         run: cabal build || cabal build || cabal build

cabal-ghc901.project

@@ -37,7 +37,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:10Z
+index-state: 2021-12-29T12:30:08Z
 
 constraints:
   -- These plugins don't work on GHC9 yet

cabal-ghc921.project

@@ -36,7 +36,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:10Z
+index-state: 2021-12-29T12:30:08Z
 
 constraints:
   -- These plugins doesn't work on GHC92 yet

cabal.project

@@ -40,7 +40,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:10Z
+index-state: 2021-12-29T12:30:08Z
 
 constraints:
     hyphenation +embed

ghcide/bench/example/HLS

@@ -194,7 +194,7 @@ experiments =
             let edit :: TextDocumentContentChangeEvent =TextDocumentContentChangeEvent
                   { _range = Just Range {_start = bottom, _end = bottom}
                   , _rangeLength = Nothing, _text = t}
-                bottom = Position maxBoundUinteger 0
+                bottom = Position maxBound 0
                 t = T.unlines
                     [""
                     ,"holef :: [Int] -> [Int]"
@@ -213,7 +213,7 @@ experiments =
             flip allM docs $ \DocumentPositions{..} -> do
                 bottom <- pred . length . T.lines <$> documentContents doc
                 diags <- getCurrentDiagnostics doc
-                case requireDiagnostic diags (DsError, (bottom, 8), "Found hole", Nothing) of
+                case requireDiagnostic diags (DsError, (fromIntegral bottom, 8), "Found hole", Nothing) of
                     Nothing   -> pure True
                     Just _err -> pure False
         )
@@ -404,7 +404,7 @@ runBenchmarksFun dir allBenchmarks = do
           ++ ["--verbose" | verbose ?config]
           ++ ["--ot-memory-profiling" | Just _ <- [otMemoryProfiling ?config]]
     lspTestCaps =
-      fullCaps {_window = Just $ WindowClientCapabilities $ Just True}
+      fullCaps {_window = Just $ WindowClientCapabilities (Just True) Nothing Nothing }
     conf =
       defaultConfig
         { logStdErr = verbose ?config,
@@ -585,7 +585,7 @@ setupDocumentContents config =
         doc <- openDoc m "haskell"
 
         -- Setup the special positions used by the experiments
-        lastLine <- length . T.lines <$> documentContents doc
+        lastLine <- fromIntegral . length . T.lines <$> documentContents doc
         changeDoc doc [TextDocumentContentChangeEvent
             { _range = Just (Range (Position lastLine 0) (Position lastLine 0))
             , _rangeLength = Nothing
@@ -638,9 +638,9 @@ searchSymbol doc@TextDocumentIdentifier{_uri} fileContents pos = do
             return res
   where
       loop pos
-        | _line pos >= lll =
+        | (fromIntegral $ _line pos) >= lll =
             return Nothing
-        | _character pos >= lengthOfLine (_line pos) =
+        | (fromIntegral $ _character pos) >= lengthOfLine (fromIntegral $ _line pos) =
             loop (nextLine pos)
         | otherwise = do
                 checks <- checkDefinitions pos &&^ checkCompletions pos
@@ -663,7 +663,3 @@ searchSymbol doc@TextDocumentIdentifier{_uri} fileContents pos = do
       checkCompletions pos =
         not . null <$> getCompletions doc pos
 
--- | We don't have a uinteger type yet. So hardcode the maxBound of uinteger, 2 ^ 31 - 1
--- as a constant.
-maxBoundUinteger :: Int
-maxBoundUinteger = 2147483647

ghcide/bench/lib/Experiments.hs

@@ -65,8 +65,8 @@ library
         lens,
         list-t,
         hiedb == 0.4.1.*,
-        lsp-types >= 1.3.0.1 && < 1.4,
-        lsp == 1.2.*,
+        lsp-types ^>= 1.4.0.0,
+        lsp ^>= 1.4.0.0 ,
         monoid-subclasses,
         mtl,
         network-uri,

ghcide/ghcide.cabal

@@ -564,6 +564,11 @@ indexHieFile se mod_summary srcPath !hash hf = do
         done <- readTVar indexCompleted
         remaining <- HashMap.size <$> readTVar indexPending
         pure (done, remaining)
+      let
+        progressFrac :: Double
+        progressFrac = fromIntegral done / fromIntegral (done + remaining)
+        progressPct :: LSP.UInt
+        progressPct = floor $ 100 * progressFrac
 
       whenJust (lspEnv se) $ \env -> whenJust tok $ \tok -> LSP.runLspT env $
         LSP.sendNotification LSP.SProgress $ LSP.ProgressParams tok $
@@ -572,7 +577,7 @@ indexHieFile se mod_summary srcPath !hash hf = do
                 Percentage -> LSP.WorkDoneProgressReportParams
                     { _cancellable = Nothing
                     , _message = Nothing
-                    , _percentage = Just (100 * fromIntegral done / fromIntegral (done + remaining) )
+                    , _percentage = Just progressPct
                     }
                 Explicit -> LSP.WorkDoneProgressReportParams
                     { _cancellable = Nothing