Merge branch 'master' into 1875-tests-randomly-fail-with-exception-fd111-hputbuf-resource-vanished-broken-pipe---test-option-j1-workaround

Author: soulomoon

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

@@ -18,9 +18,22 @@ import           System.FilePath
 
 data CradleErrorDetails =
   CradleErrorDetails
-    { cabalProjectFiles :: [FilePath]
+    { cradleDependencies    :: [FilePath]
     -- ^ files related to the cradle error
     -- i.e. .cabal, cabal.project, etc.
+    , structuredCradleError :: Maybe StructuredCradleError
+    -- ^ structured information about the cradle error
+    -- i.e. unknownModules error
+    } deriving (Show, Eq, Ord, Read, Generic, Aeson.ToJSON, Aeson.FromJSON)
+
+data StructuredCradleError
+  = UnknownModuleError UnknownModuleDetails
+  deriving (Show, Eq, Ord, Read, Generic, Aeson.ToJSON, Aeson.FromJSON)
+
+data UnknownModuleDetails =
+  UnknownModuleDetails
+    { moduleFilePath      :: FilePath
+    , suggestedModuleName :: String
     } deriving (Show, Eq, Ord, Read, Generic, Aeson.ToJSON, Aeson.FromJSON)
 
 {- | Takes a cradle error, the corresponding cradle and the file path where
@@ -33,21 +46,31 @@ renderCradleError cradleError cradle nfp =
         ideErrorWithSource (Just "cradle") (Just DiagnosticSeverity_Error) nfp (T.unlines $ map T.pack userFriendlyMessage) Nothing
   in
   if HieBios.isCabalCradle cradle
-     then noDetails & fdLspDiagnosticL %~ \diag -> diag{_data_ = Just $ Aeson.toJSON CradleErrorDetails{cabalProjectFiles=absDeps}}
+     then noDetails & fdLspDiagnosticL %~ \diag -> diag
+            { _data_ = Just $ Aeson.toJSON CradleErrorDetails
+                { cradleDependencies = absDeps
+                , structuredCradleError = fmap UnknownModuleError mkUnknownModuleDetails
+                }
+            }
      else noDetails
   where
     ms = cradleErrorStderr cradleError
 
     absDeps = fmap (cradleRootDir cradle </>) (cradleErrorDependencies cradleError)
     userFriendlyMessage :: [String]
     userFriendlyMessage
-      | HieBios.isCabalCradle cradle = fromMaybe ms $ fileMissingMessage <|> mkUnknownModuleMessage
+      | HieBios.isCabalCradle cradle = fromMaybe ms $ fileMissingMessage <|> (unknownModuleMessage (fromNormalizedFilePath nfp) <$ mkUnknownModuleDetails)
       | otherwise = ms
 
-    mkUnknownModuleMessage :: Maybe [String]
-    mkUnknownModuleMessage
+    -- Produce structured details when unknown module error is detected
+    mkUnknownModuleDetails :: Maybe UnknownModuleDetails
+    mkUnknownModuleDetails
       | any (isInfixOf "Failed extracting script block:") ms =
-          Just $ unknownModuleMessage (fromNormalizedFilePath nfp)
+          let fp = fromNormalizedFilePath nfp
+          in Just UnknownModuleDetails
+               { moduleFilePath   = fp
+               , suggestedModuleName = dropExtension (takeFileName fp)
+               }
       | otherwise = Nothing
 
     fileMissingMessage :: Maybe [String]

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/CabalAdd/CodeAction.hs

@@ -36,14 +36,15 @@ import           Ide.Types                                     (CommandId (Comma
                                                                 PluginId)
 
 import           Control.Lens                                  ((^.))
+import qualified Data.Aeson                                    as Aeson
+import           Development.IDE.Session.Diagnostics
 import qualified Language.LSP.Protocol.Lens                    as JL
 import           Language.LSP.Protocol.Types                   (CodeActionKind (..),
                                                                 VersionedTextDocumentIdentifier)
 import qualified Language.LSP.Protocol.Types                   as J
 import           System.FilePath
 import           Text.PrettyPrint                              (render)
 import           Text.Regex.TDFA
-
 --------------------------------------------
 -- Add module to cabal file
 --------------------------------------------
@@ -148,13 +149,16 @@ mkRelativeModulePathM hsSourceDirs cabalSrcPath' haskellFilePath =
   cabalSrcPath = takeDirectory cabalSrcPath'
 
 isUnknownModuleDiagnostic :: J.Diagnostic -> Bool
-isUnknownModuleDiagnostic diag = (msg =~ regex)
- where
-  msg :: T.Text
-  msg = diag ^. JL.message
-  regex :: T.Text
-  regex = "Loading the module [\8216'][^\8217']*[\8217'] failed."
-
+isUnknownModuleDiagnostic diag =
+  case diag ^. JL.data_ of
+    Nothing -> False
+    Just v ->
+      case Aeson.fromJSON v of
+        Aeson.Success details ->
+          case structuredCradleError details of
+            Just (UnknownModuleError _) -> True
+            _                           -> False
+        _ -> False
 --------------------------
 -- Below are several utility functions which create a StanzaItem for each of the possible Stanzas,
 -- these all have specific constructors we need to match, so we can't generalise this process well.