Skip to content

Commit 7ec3ed6

Browse files
VeryMilkyJoeVeryMilkyJoe
committed
Add cradle dependencies to session loading errors
1 parent 663c0e7 commit 7ec3ed6

File tree

3 files changed

+89
-70
lines changed

3 files changed

+89
-70
lines changed

‎ghcide/ghcide.cabal

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ library
193193
Development.IDE.LSP.Outline
194194
Development.IDE.LSP.Server
195195
Development.IDE.Session
196+
Development.IDE.Session.Diagnostics
196197
Development.IDE.Spans.Common
197198
Development.IDE.Spans.Documentation
198199
Development.IDE.Spans.AtPoint

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

Lines changed: 2 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,12 @@ import Data.Aeson hiding (Error)
3434
import Data.Bifunctor
3535
import qualified Data.ByteString.Base16 as B16
3636
import qualified Data.ByteString.Char8 as B
37-
import Data.Char (isLower)
3837
import Data.Default
3938
import Data.Either.Extra
4039
import Data.Function
4140
import Data.Hashable hiding (hash)
4241
import qualified Data.HashMap.Strict as HM
4342
import Data.List
44-
import Data.List.Extra (dropPrefix, split)
4543
import qualified Data.Map.Strict as Map
4644
import Data.Maybe
4745
import Data.Proxy
@@ -69,7 +67,6 @@ import Development.IDE.Types.Location
6967
import Development.IDE.Types.Options
7068
import GHC.Check
7169
import qualified HIE.Bios as HieBios
72-
import qualified HIE.Bios.Cradle as HieBios
7370
import HIE.Bios.Environment hiding (getCacheDir)
7471
import HIE.Bios.Types hiding (Log)
7572
import qualified HIE.Bios.Types as HieBios
@@ -103,6 +100,7 @@ import Data.HashSet (HashSet)
103100
import qualified Data.HashSet as Set
104101
import Database.SQLite.Simple
105102
import Development.IDE.Core.Tracing (withTrace)
103+
import Development.IDE.Session.Diagnostics (renderCradleError)
106104
import Development.IDE.Types.Shake (WithHieDb)
107105
import HieDb.Create
108106
import HieDb.Types
@@ -685,7 +683,7 @@ loadSessionWithOptions recorder SessionLoadingOptions{..} dir = do
685683
Left err -> do
686684
dep_info <- getDependencyInfo (maybeToList hieYaml)
687685
let ncfp = toNormalizedFilePath' cfp
688-
let res = (map (renderCradleError cradle ncfp) err, Nothing)
686+
let res = (map (\err' -> renderCradleError err' cradle ncfp) err, Nothing)
689687
void $ modifyVar' fileToFlags $
690688
Map.insertWith HM.union hieYaml (HM.singleton ncfp (res, dep_info))
691689
void $ modifyVar' filesMap $ HM.insert ncfp hieYaml
@@ -925,72 +923,6 @@ setCacheDirs recorder CacheDirs{..} dflags = do
925923
& maybe id setHieDir hieCacheDir
926924
& maybe id setODir oCacheDir
927925

928-
929-
renderCradleError :: Cradle a -> NormalizedFilePath -> CradleError -> FileDiagnostic
930-
renderCradleError cradle nfp (CradleError _ _ec ms) =
931-
ideErrorWithSource (Just "cradle") (Just DiagnosticSeverity_Error) nfp $ T.unlines $ map T.pack userFriendlyMessage
932-
where
933-
934-
userFriendlyMessage :: [String]
935-
userFriendlyMessage
936-
| HieBios.isCabalCradle cradle = fromMaybe ms fileMissingMessage
937-
| otherwise = ms
938-
939-
fileMissingMessage :: Maybe [String]
940-
fileMissingMessage =
941-
multiCradleErrMessage <$> parseMultiCradleErr ms
942-
943-
-- | Information included in Multi Cradle error messages
944-
data MultiCradleErr = MultiCradleErr
945-
{ mcPwd :: FilePath
946-
, mcFilePath :: FilePath
947-
, mcPrefixes :: [(FilePath, String)]
948-
} deriving (Show)
949-
950-
-- | Attempt to parse a multi-cradle message
951-
parseMultiCradleErr :: [String] -> Maybe MultiCradleErr
952-
parseMultiCradleErr ms = do
953-
_ <- lineAfter "Multi Cradle: "
954-
wd <- lineAfter "pwd: "
955-
fp <- lineAfter "filepath: "
956-
ps <- prefixes
957-
pure $ MultiCradleErr wd fp ps
958-
959-
where
960-
lineAfter :: String -> Maybe String
961-
lineAfter pre = listToMaybe $ mapMaybe (stripPrefix pre) ms
962-
963-
prefixes :: Maybe [(FilePath, String)]
964-
prefixes = do
965-
pure $ mapMaybe tuple ms
966-
967-
tuple :: String -> Maybe (String, String)
968-
tuple line = do
969-
line' <- surround '(' line ')'
970-
[f, s] <- pure $ split (==',') line'
971-
pure (f, s)
972-
973-
-- extracts the string surrounded by required characters
974-
surround :: Char -> String -> Char -> Maybe String
975-
surround start s end = do
976-
guard (listToMaybe s == Just start)
977-
guard (listToMaybe (reverse s) == Just end)
978-
pure $ drop 1 $ take (length s - 1) s
979-
980-
multiCradleErrMessage :: MultiCradleErr -> [String]
981-
multiCradleErrMessage e =
982-
[ "Loading the module '" <> moduleFileName <> "' failed. It may not be listed in your .cabal file!"
983-
, "Perhaps you need to add `"<> moduleName <> "` to other-modules or exposed-modules."
984-
, "For more information, visit: https://cabal.readthedocs.io/en/3.4/developing-packages.html#modules-included-in-the-package"
985-
, ""
986-
] <> map prefix (mcPrefixes e)
987-
where
988-
localFilePath f = dropWhile (==pathSeparator) $ dropPrefix (mcPwd e) f
989-
moduleFileName = localFilePath $ mcFilePath e
990-
moduleName = intercalate "." $ map dropExtension $ dropWhile isSourceFolder $ splitDirectories moduleFileName
991-
isSourceFolder p = all isLower $ take 1 p
992-
prefix (f, r) = f <> " - " <> r
993-
994926
-- See Note [Multi Cradle Dependency Info]
995927
type DependencyInfo = Map.Map FilePath (Maybe UTCTime)
996928
type HieMap = Map.Map (Maybe FilePath) (HscEnv, [RawComponentInfo])

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

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
module Development.IDE.Session.Diagnostics where
2+
import Control.Monad
3+
import qualified Data.Aeson as Aeson
4+
import Data.Char (isLower)
5+
import Data.List
6+
import Data.List.Extra (dropPrefix, split)
7+
import Data.Maybe
8+
import qualified Data.Text as T
9+
import qualified Data.Vector as Vector
10+
import Development.IDE.Types.Diagnostics
11+
import Development.IDE.Types.Location
12+
import qualified HIE.Bios.Cradle as HieBios
13+
import HIE.Bios.Types hiding (Log)
14+
import System.FilePath
15+
16+
{- | Takes a cradle error, the corresponding cradle and the file path where
17+
the cradle error occurred (of the file we attempted to load).
18+
Depicts the cradle error in a user-friendly way.
19+
-}
20+
renderCradleError :: CradleError -> Cradle a -> NormalizedFilePath -> FileDiagnostic
21+
renderCradleError (CradleError deps _ec ms) cradle nfp
22+
| HieBios.isCabalCradle cradle && any (isInfixOf "Error: cabal: Failed extracting script block:") ms =
23+
let (fp, showDiag, diag) = ideErrorWithSource (Just "cradle") (Just DiagnosticSeverity_Error) nfp $ T.unlines $ map T.pack userFriendlyMessage in
24+
(fp, showDiag, diag{_data_ = Just (Aeson.Array $ Vector.fromList $ map (Aeson.String . T.pack) absDeps)})
25+
| otherwise = ideErrorWithSource (Just "cradle") (Just DiagnosticSeverity_Error) nfp $ T.unlines $ map T.pack userFriendlyMessage
26+
where
27+
absDeps = fmap (cradleRootDir cradle </>) deps
28+
userFriendlyMessage :: [String]
29+
userFriendlyMessage
30+
| HieBios.isCabalCradle cradle = fromMaybe ms fileMissingMessage
31+
| otherwise = ms
32+
33+
fileMissingMessage :: Maybe [String]
34+
fileMissingMessage =
35+
multiCradleErrMessage <$> parseMultiCradleErr ms
36+
37+
-- | Information included in Multi Cradle error messages
38+
data MultiCradleErr = MultiCradleErr
39+
{ mcPwd :: FilePath
40+
, mcFilePath :: FilePath
41+
, mcPrefixes :: [(FilePath, String)]
42+
} deriving (Show)
43+
44+
-- | Attempt to parse a multi-cradle message
45+
parseMultiCradleErr :: [String] -> Maybe MultiCradleErr
46+
parseMultiCradleErr ms = do
47+
_ <- lineAfter "Multi Cradle: "
48+
wd <- lineAfter "pwd: "
49+
fp <- lineAfter "filepath: "
50+
ps <- prefixes
51+
pure $ MultiCradleErr wd fp ps
52+
53+
where
54+
lineAfter :: String -> Maybe String
55+
lineAfter pre = listToMaybe $ mapMaybe (stripPrefix pre) ms
56+
57+
prefixes :: Maybe [(FilePath, String)]
58+
prefixes = do
59+
pure $ mapMaybe tuple ms
60+
61+
tuple :: String -> Maybe (String, String)
62+
tuple line = do
63+
line' <- surround '(' line ')'
64+
[f, s] <- pure $ split (==',') line'
65+
pure (f, s)
66+
67+
-- extracts the string surrounded by required characters
68+
surround :: Char -> String -> Char -> Maybe String
69+
surround start s end = do
70+
guard (listToMaybe s == Just start)
71+
guard (listToMaybe (reverse s) == Just end)
72+
pure $ drop 1 $ take (length s - 1) s
73+
74+
multiCradleErrMessage :: MultiCradleErr -> [String]
75+
multiCradleErrMessage e =
76+
[ "Loading the module '" <> moduleFileName <> "' failed. It may not be listed in your .cabal file!"
77+
, "Perhaps you need to add `"<> moduleName <> "` to other-modules or exposed-modules."
78+
, "For more information, visit: https://cabal.readthedocs.io/en/3.4/developing-packages.html#modules-included-in-the-package"
79+
, ""
80+
] <> map prefix (mcPrefixes e)
81+
where
82+
localFilePath f = dropWhile (==pathSeparator) $ dropPrefix (mcPwd e) f
83+
moduleFileName = localFilePath $ mcFilePath e
84+
moduleName = intercalate "." $ map dropExtension $ dropWhile isSourceFolder $ splitDirectories moduleFileName
85+
isSourceFolder p = all isLower $ take 1 p
86+
prefix (f, r) = f <> " - " <> r

0 commit comments

Comments
 (0)