Merge pull request #1791 from sjakobi/713-buildplan-exceptions-with-f…

…lags

Add flag infos to DependencyPlanFailures #713

src/Stack/Build/ConstructPlan.hs

@@ -481,9 +481,7 @@ addPackageDeps treatAsDep package = do
     case partitionEithers deps of
         ([], pairs) -> return $ Right $ mconcat pairs
         (errs, _) -> return $ Left $ DependencyPlanFailures
-            (PackageIdentifier
-                (packageName package)
-                (packageVersion package))
+            package
             (Map.fromList errs)
   where
     adrVersion (ADRToInstall task) = packageIdentifierVersion $ taskProvides task

src/Stack/Package.hs

@@ -30,7 +30,6 @@ module Stack.Package
   ,resolvePackageDescription
   ,packageToolDependencies
   ,packageDependencies
-  ,packageIdentifier
   ,autogenDir
   ,checkCabalFileName
   ,printCabalFileWarning
@@ -88,18 +87,11 @@ import           Safe (headDef, tailSafe)
 import           Stack.Build.Installed
 import           Stack.Constants
 import           Stack.Types
-import qualified Stack.Types.PackageIdentifier
 import qualified System.Directory as D
 import           System.FilePath (splitExtensions, replaceExtension)
 import qualified System.FilePath as FilePath
 import           System.IO.Error
 
-packageIdentifier :: Package -> Stack.Types.PackageIdentifier.PackageIdentifier
-packageIdentifier pkg =
-    Stack.Types.PackageIdentifier.PackageIdentifier
-        (packageName pkg)
-        (packageVersion pkg)
-
 -- | Read the raw, unresolved package information.
 readPackageUnresolved :: (MonadIO m, MonadThrow m)
                       => Path Abs File

src/Stack/Types/Build.hs

@@ -339,7 +339,7 @@ instance Exception StackBuildException
 
 data ConstructPlanException
     = DependencyCycleDetected [PackageName]
-    | DependencyPlanFailures PackageIdentifier (Map PackageName (VersionRange, LatestApplicableVersion, BadDependency))
+    | DependencyPlanFailures Package (Map PackageName (VersionRange, LatestApplicableVersion, BadDependency))
     | UnknownPackage PackageName -- TODO perhaps this constructor will be removed, and BadDependency will handle it all
     -- ^ Recommend adding to extra-deps, give a helpful version number?
     deriving (Typeable, Eq)
@@ -360,9 +360,10 @@ instance Show ConstructPlanException where
          (DependencyCycleDetected pNames) ->
            "While checking call stack,\n" ++
            "  dependency cycle detected in packages:" ++ indent (appendLines pNames)
-         (DependencyPlanFailures pIdent (Map.toList -> pDeps)) ->
+         (DependencyPlanFailures pkg (Map.toList -> pDeps)) ->
            "Failure when adding dependencies:" ++ doubleIndent (appendDeps pDeps) ++ "\n" ++
-           "  needed for package: " ++ packageIdentifierString pIdent
+           "  needed for package " ++ packageIdentifierString (packageIdentifier pkg) ++
+           appendFlags (packageFlags pkg)
          (UnknownPackage pName) ->
              "While attempting to add dependency,\n" ++
              "  Could not find package " ++ show pName  ++ " in known packages"
@@ -371,6 +372,12 @@ instance Show ConstructPlanException where
       appendLines = foldr (\pName-> (++) ("\n" ++ show pName)) ""
       indent = dropWhileEnd isSpace . unlines . fmap (\line -> "  " ++ line) . lines
       doubleIndent = indent . indent
+      appendFlags flags =
+          if Map.null flags
+              then ""
+              else " with flags:\n" ++
+                  (doubleIndent . intercalate "\n" . map showFlag . Map.toList) flags
+      showFlag (name, bool) = show name ++ ": " ++ show bool
       appendDeps = foldr (\dep-> (++) ("\n" ++ showDep dep)) ""
       showDep (name, (range, mlatestApplicable, badDep)) = concat
         [ show name

src/Stack/Types/Package.hs

@@ -98,6 +98,10 @@ data Package =
           }
  deriving (Show,Typeable)
 
+packageIdentifier :: Package -> PackageIdentifier
+packageIdentifier pkg =
+    PackageIdentifier (packageName pkg) (packageVersion pkg)
+
 -- | Files that the package depends on, relative to package directory.
 -- Argument is the location of the .cabal file
 newtype GetPackageOpts = GetPackageOpts