Make cradle dependencies absolute paths

This patch fixes #1068 when the cabal plugin is not used.

Co-authored-by: Lin Jian <me@linj.tech>

Author: fendor

ghcide/session-loader/Development/IDE/Session.hs

@@ -698,7 +698,15 @@ loadSessionWithOptions recorder SessionLoadingOptions{..} rootDir que = do
             let ncfp = toNormalizedFilePath' (toAbsolutePath file)
             cachedHieYamlLocation <- HM.lookup ncfp <$> readVar filesMap
             hieYaml <- cradleLoc file
-            sessionOpts (join cachedHieYamlLocation <|> hieYaml, file) `Safe.catch` \e ->
+            let
+              -- Each one of deps will be registered as a FileSystemWatcher in the GhcSession action
+              -- so that we can get a workspace/didChangeWatchedFiles notification when a dep changes.
+              -- The GlobPattern of a FileSystemWatcher can be absolute or relative.
+              -- We use the absolute one because it is supported by more LSP clients.
+              -- Here we make sure deps are absolute and later we use those absolute deps as GlobPattern.
+              absolutePathsCradleDeps (eq, deps)
+                = (eq, fmap toAbsolutePath deps)
+            (absolutePathsCradleDeps <$> sessionOpts (join cachedHieYamlLocation <|> hieYaml, file))  `Safe.catch` \e ->
                 return (([renderPackageSetupException file e], Nothing), maybe [] pure hieYaml)
 
     returnWithVersion $ \file -> do

plugins/hls-cabal-plugin/test/CabalAdd.hs

@@ -9,17 +9,26 @@ import           Control.Lens.Fold           ((^?))
 import qualified Data.Maybe                  as Maybe
 import qualified Data.Text                   as T
 import qualified Data.Text.Internal.Search   as T
+import qualified Data.Text.IO                as T
 import           Distribution.Utils.Generic  (safeHead)
 import           Ide.Plugin.Cabal.CabalAdd   (hiddenPackageSuggestion)
 import qualified Language.LSP.Protocol.Lens  as L
-import           Language.LSP.Protocol.Types (Diagnostic (..), mkRange)
+import           Language.LSP.Protocol.Types (Diagnostic (..),
+                                              DidChangeWatchedFilesParams (..),
+                                              FileChangeType (FileChangeType_Changed),
+                                              FileEvent (..), filePathToUri,
+                                              mkRange)
 import           System.FilePath
-import           Test.Hls                    (Session, TestTree, _R, anyMessage,
-                                              assertEqual, documentContents,
+import           Test.Hls                    (SMethod (SMethod_WorkspaceDidChangeWatchedFiles),
+                                              Session, TestTree, _R, anyMessage,
+                                              assertEqual, assertFailure,
+                                              documentContents,
                                               executeCodeAction,
                                               getAllCodeActions,
                                               getDocumentEdit, liftIO, openDoc,
-                                              skipManyTill, testCase, testGroup,
+                                              sendNotification, skipManyTill,
+                                              testCase, testGroup,
+                                              type (|?) (InR),
                                               waitForDiagnosticsFrom, (@?=))
 import           Utils
 
@@ -141,6 +150,9 @@ cabalAddTests =
                                    , ("AAI", "0.1")
                                    , ("AWin32Console", "1.19.1")
                                    ]
+
+    , runShiftedRootInTmpDirTestCaseSession "Reload HLS after cabal file changes - without cabal plugin" ("cabal-add-testdata" </> "cabal-add-lib")
+        (generateReloadHlsAfterCabalChangeTestSession "cabal-add-lib.cabal" ("src" </> "MyLib.hs"))
     ]
  where
     generateAddDependencyTestSession :: FilePath -> FilePath -> T.Text -> [Int] -> Session ()
@@ -183,3 +195,17 @@ cabalAddTests =
         cas <- Maybe.mapMaybe (^? _R) <$> getAllCodeActions hsdoc
         let selectedCas = filter (\ca -> "Add dependency" `T.isPrefixOf` (ca ^. L.title)) cas
         liftIO $ assertEqual "PackageYAML" [] selectedCas
+
+    generateReloadHlsAfterCabalChangeTestSession :: FilePath -> FilePath -> FilePath -> Session ()
+    generateReloadHlsAfterCabalChangeTestSession cabalFile haskellFile root = do
+        hsdoc <- openDoc haskellFile "haskell"
+        _ <- waitForDiagnosticsFrom hsdoc
+        cabalContent <- liftIO $ T.readFile cabalFile
+        let fix = T.replace "build-depends:    base" "build-depends:    base, split"
+        liftIO $ T.writeFile cabalFile (fix cabalContent)
+        sendNotification SMethod_WorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams
+            [ FileEvent (filePathToUri $ root </> cabalFile) FileChangeType_Changed ]
+        diagnostics <- waitForDiagnosticsFrom hsdoc
+        case diagnostics of
+            [diagnostic] -> liftIO $ assertEqual "Wrong diagnostic after HLS restarts" (Just $ InR "GHC-66111") (diagnostic ^. L.code)
+            _ -> liftIO $ assertFailure $ "Expect one diagnostic but got " <> show (length diagnostics)

plugins/hls-cabal-plugin/test/Utils.hs

@@ -14,6 +14,7 @@ import qualified Ide.Plugin.Cabal
 import           Ide.Plugin.Cabal.Completion.Types
 import           System.FilePath
 import           Test.Hls
+import           Test.Hls.FileSystem               (copyDir, mkVirtualFileTree)
 
 
 cabalPlugin :: PluginTestDescriptor Ide.Plugin.Cabal.Log
@@ -53,6 +54,9 @@ runCabalTestCaseSession title subdir = testCase title . runCabalSession subdir
 runHaskellTestCaseSession :: TestName -> FilePath -> Session () -> TestTree
 runHaskellTestCaseSession title subdir = testCase title . runHaskellAndCabalSession subdir
 
+runShiftedRootInTmpDirTestCaseSession :: TestName -> FilePath -> (FilePath -> Session ()) -> TestTree
+runShiftedRootInTmpDirTestCaseSession title subdir = testCase title . runShiftedRootInTmpDirSession subdir
+
 runCabalSession :: FilePath -> Session a -> IO a
 runCabalSession subdir =
     failIfSessionTimeout . runSessionWithServer def cabalPlugin (testDataDir </> subdir)
@@ -61,6 +65,14 @@ runHaskellAndCabalSession :: FilePath -> Session a -> IO a
 runHaskellAndCabalSession subdir =
     failIfSessionTimeout . runSessionWithServer def (cabalPlugin <> cabalHaskellPlugin) (testDataDir </> subdir)
 
+runShiftedRootInTmpDirSession :: FilePath -> (FilePath -> Session a) -> IO a
+runShiftedRootInTmpDirSession subdir =
+    failIfSessionTimeout . runSessionWithTestConfig def
+        { testDirLocation = Right $ mkVirtualFileTree testDataDir [copyDir subdir]
+        , testShiftRoot = True
+        , testPluginDescriptor = cabalHaskellPlugin
+        }
+
 runCabalGoldenSession :: TestName -> FilePath -> FilePath -> (TextDocumentIdentifier -> Session ()) -> TestTree
 runCabalGoldenSession title subdir fp act = goldenWithCabalDoc def cabalPlugin title testDataDir (subdir </> fp) "golden" "cabal" act