[#4040] Align output for parallel builds

cabal-install/Distribution/Client/FetchUtils.hs

@@ -40,13 +40,15 @@ import Distribution.Client.HttpUtils
 import Distribution.Package
          ( PackageId, packageName, packageVersion )
 import Distribution.Simple.Utils
-         ( notice, info, debug, setupMessage, die' )
+         ( notice, info, debug, die' )
 import Distribution.Text
          ( display )
 import Distribution.Verbosity
          ( Verbosity, verboseUnmarkOutput )
 import Distribution.Client.GlobalFlags
          ( RepoContext(..) )
+import Distribution.Client.Utils
+         ( ProgressPhase(..), progressMessage )
 
 import Data.Maybe
 import Data.Map (Map)
@@ -165,8 +167,12 @@ fetchRepoTarball verbosity repoCtxt repo pkgid = do
   if fetched
     then do info verbosity $ display pkgid ++ " has already been downloaded."
             return (packageFile repo pkgid)
-    else do setupMessage verbosity "Downloading" pkgid
-            downloadRepoPackage
+    else do progressMessage verbosity ProgressDownloading (display pkgid)
+            res <- downloadRepoPackage
+            progressMessage verbosity ProgressDownloaded (display pkgid)
+            return res
+
+
   where
     downloadRepoPackage = case repo of
       RepoLocal{..} -> return (packageFile repo pkgid)

cabal-install/Distribution/Client/Install.hs

@@ -160,7 +160,7 @@ import Distribution.Simple.Utils as Utils
          , withTempDirectory )
 import Distribution.Client.Utils
          ( determineNumJobs, logDirChange, mergeBy, MergeResult(..)
-         , tryCanonicalizePath )
+         , tryCanonicalizePath, ProgressPhase(..), progressMessage )
 import Distribution.System
          ( Platform, OS(Windows), buildOS, buildPlatform )
 import Distribution.Text
@@ -1197,7 +1197,7 @@ executeInstallPlan verbosity jobCtl keepGoing useLogFile plan0 installPkg =
     -- otherwise.
     printBuildResult :: PackageId -> UnitId -> BuildOutcome -> IO ()
     printBuildResult pkgid uid buildOutcome = case buildOutcome of
-        (Right _) -> notice verbosity $ "Installed " ++ display pkgid
+        (Right _) -> progressMessage verbosity ProgressCompleted (display pkgid)
         (Left _)  -> do
           notice verbosity $ "Failed to install " ++ display pkgid
           when (verbosity >= normal) $
@@ -1399,14 +1399,12 @@ installUnpackedPackage verbosity installLock numJobs
   logDirChange (maybe (const (return ())) appendFile mLogPath) workingDir $ do
     -- Configure phase
     onFailure ConfigureFailed $ do
-      when (numJobs > 1) $ notice verbosity $
-        "Configuring " ++ display pkgid ++ "..."
+      noticeProgress ProgressStarting
       setup configureCommand configureFlags mLogPath
 
     -- Build phase
       onFailure BuildFailed $ do
-        when (numJobs > 1) $ notice verbosity $
-          "Building " ++ display pkgid ++ "..."
+        noticeProgress ProgressBuilding
         setup buildCommand' buildFlags mLogPath
 
     -- Doc generation phase
@@ -1453,6 +1451,12 @@ installUnpackedPackage verbosity installLock numJobs
     uid              = installedUnitId rpkg
     cinfo            = compilerInfo comp
     buildCommand'    = buildCommand progdb
+    dispname         = display pkgid
+    isParallelBuild  = numJobs >= 2
+
+    noticeProgress phase = when isParallelBuild $
+        progressMessage verbosity phase dispname
+
     buildFlags   _   = emptyBuildFlags {
       buildDistPref  = configDistPref configFlags,
       buildVerbosity = toFlag verbosity'

cabal-install/Distribution/Client/ProjectBuilding.hs

@@ -65,7 +65,8 @@ import           Distribution.Client.Setup
                    , filterHaddockFlags )
 import           Distribution.Client.SourceFiles
 import           Distribution.Client.SrcDist (allPackageSourceFiles)
-import           Distribution.Client.Utils (removeExistingFile)
+import           Distribution.Client.Utils
+                   ( ProgressPhase(..), progressMessage, removeExistingFile )
 
 import           Distribution.Compat.Lens
 import           Distribution.Package hiding (InstalledPackageId, installedPackageId)
@@ -939,32 +940,26 @@ buildAndInstallUnpackedPackage verbosity
     --TODO: [required feature] docs and tests
     --TODO: [required feature] sudo re-exec
 
-    let dispname = case elabPkgOrComp pkg of
-            ElabPackage _ -> display pkgid
-                ++ " (all, legacy fallback)"
-            ElabComponent comp -> display pkgid
-                ++ " (" ++ maybe "custom" display (compComponentName comp) ++ ")"
-
     -- Configure phase
-    when isParallelBuild $
-      notice verbosity $ "Configuring " ++ dispname ++ "..."
+    noticeProgress ProgressStarting
+
     annotateFailure mlogFile ConfigureFailed $
       setup' configureCommand configureFlags configureArgs
 
     -- Build phase
-    when isParallelBuild $
-      notice verbosity $ "Building " ++ dispname ++ "..."
+    noticeProgress ProgressBuilding
+
     annotateFailure mlogFile BuildFailed $
       setup buildCommand buildFlags
 
     -- Haddock phase
     whenHaddock $ do
-      when isParallelBuild $
-        notice verbosity $ "Generating " ++ dispname ++ " documentation..."
+      noticeProgress ProgressHaddock
       annotateFailureNoLog HaddocksFailed $
         setup haddockCommand haddockFlags
 
     -- Install phase
+    noticeProgress ProgressInstalling
     annotateFailure mlogFile InstallFailed $ do
 
       let copyPkgFiles tmpDir = do
@@ -1037,6 +1032,8 @@ buildAndInstallUnpackedPackage verbosity
     let docsResult  = DocsNotTried
         testsResult = TestsNotTried
 
+    noticeProgress ProgressCompleted
+
     return BuildResult {
        buildResultDocs    = docsResult,
        buildResultTests   = testsResult,
@@ -1048,6 +1045,15 @@ buildAndInstallUnpackedPackage verbosity
     uid    = installedUnitId rpkg
     compid = compilerId compiler
 
+    dispname = case elabPkgOrComp pkg of
+        ElabPackage _ -> display pkgid
+            ++ " (all, legacy fallback)"
+        ElabComponent comp -> display pkgid
+            ++ " (" ++ maybe "custom" display (compComponentName comp) ++ ")"
+
+    noticeProgress phase = when isParallelBuild $
+        progressMessage verbosity phase dispname
+
     isParallelBuild = buildSettingNumJobs >= 2
 
     whenHaddock action

cabal-install/Distribution/Client/Utils.hs

@@ -17,7 +17,9 @@ module Distribution.Client.Utils ( MergeResult(..)
                                  , moreRecentFile, existsAndIsMoreRecentThan
                                  , tryFindAddSourcePackageDesc
                                  , tryFindPackageDesc
-                                 , relaxEncodingErrors)
+                                 , relaxEncodingErrors
+                                 , ProgressPhase (..)
+                                 , progressMessage)
        where
 
 import Prelude ()
@@ -28,7 +30,7 @@ import Distribution.Compat.Exception   ( catchIO )
 import Distribution.Compat.Time ( getModTime )
 import Distribution.Simple.Setup       ( Flag(..) )
 import Distribution.Verbosity
-import Distribution.Simple.Utils       ( die', findPackageDesc )
+import Distribution.Simple.Utils       ( die', findPackageDesc, noticeNoWrap )
 import qualified Data.ByteString.Lazy as BS
 import Data.Bits
          ( (.|.), shiftL, shiftR )
@@ -336,3 +338,27 @@ tryFindPackageDesc verbosity depPath err = do
     case errOrCabalFile of
         Right file -> return file
         Left _ -> die' verbosity err
+
+-- | Phase of building a dependency. Represents current status of package
+-- dependency processing. See #4040 for details.
+data ProgressPhase
+    = ProgressDownloading
+    | ProgressDownloaded
+    | ProgressStarting
+    | ProgressBuilding
+    | ProgressHaddock
+    | ProgressInstalling
+    | ProgressCompleted
+
+progressMessage :: Verbosity -> ProgressPhase -> String -> IO ()
+progressMessage verbosity phase subject = do
+    noticeNoWrap verbosity $ phaseStr ++ subject ++ "\n"
+  where
+    phaseStr = case phase of
+        ProgressDownloading -> "Downloading  "
+        ProgressDownloaded  -> "Downloaded   "
+        ProgressStarting    -> "Starting     "
+        ProgressBuilding    -> "Building     "
+        ProgressHaddock     -> "Haddock      "
+        ProgressInstalling  -> "Installing   "
+        ProgressCompleted   -> "Completed    "

cabal-install/changelog

@@ -28,6 +28,7 @@
 	* Support packages from local tarballs in the cabal.project file.
 	* Default changelog generated by 'cabal init' is now named
 	'CHANGELOG.md' (#5441).
+	* Align output of 'new-build' command phases (#4040).
 
 2.2.0.0 Mikhail Glushenkov <[email protected]> March 2018
 	* '--with-PROG' and '--PROG-options' are applied to all packages

cabal-testsuite/PackageTests/Exec/T4049/sandbox.out

@@ -7,6 +7,6 @@ Configuring my-foreign-lib-0.1.0.0...
 Preprocessing foreign library 'myforeignlib' for my-foreign-lib-0.1.0.0..
 Building foreign library 'myforeignlib' for my-foreign-lib-0.1.0.0..
 Installing foreign library myforeignlib in <PATH>
-Installed my-foreign-lib-0.1.0.0
+Completed    my-foreign-lib-0.1.0.0
 # cabal v1-exec
 Hi from a foreign library! Foo has value 5678

cabal-testsuite/PackageTests/Exec/sandbox-ghc-pkg.out

@@ -12,5 +12,5 @@ Preprocessing library for my-0.1..
 Building library for my-0.1..
 Installing executable my-executable in <PATH>
 Installing library in <PATH>
-Installed my-0.1
+Completed    my-0.1
 # cabal v1-exec

cabal-testsuite/PackageTests/Exec/sandbox-hc-pkg.out

@@ -12,5 +12,5 @@ Preprocessing library for my-0.1..
 Building library for my-0.1..
 Installing executable my-executable in <PATH>
 Installing library in <PATH>
-Installed my-0.1
+Completed    my-0.1
 # cabal v1-exec

cabal-testsuite/PackageTests/Exec/sandbox-path.out

@@ -12,5 +12,5 @@ Preprocessing library for my-0.1..
 Building library for my-0.1..
 Installing executable my-executable in <PATH>
 Installing library in <PATH>
-Installed my-0.1
+Completed    my-0.1
 # cabal v1-exec

cabal-testsuite/PackageTests/Exec/sandbox.out

@@ -12,5 +12,5 @@ Preprocessing library for my-0.1..
 Building library for my-0.1..
 Installing executable my-executable in <PATH>
 Installing library in <PATH>
-Installed my-0.1
+Completed    my-0.1
 # cabal v1-exec

cabal-testsuite/PackageTests/InternalLibraries/sandbox-shadow.out

@@ -15,4 +15,4 @@ Building library for p-0.1.0.0..
 Installing internal library q in <PATH>
 Installing executable foo in <PATH>
 Installing library in <PATH>
-Installed p-0.1.0.0
+Completed    p-0.1.0.0

cabal-testsuite/PackageTests/InternalLibraries/sandbox.out

@@ -14,4 +14,4 @@ Building library for p-0.1.0.0..
 Installing internal library q in <PATH>
 Installing executable foo in <PATH>
 Installing library in <PATH>
-Installed p-0.1.0.0
+Completed    p-0.1.0.0

cabal-testsuite/PackageTests/Regression/T3436/sandbox.out

@@ -7,15 +7,15 @@ Configuring Cabal-1.2...
 Preprocessing library for Cabal-1.2..
 Building library for Cabal-1.2..
 Installing library in <PATH>
-Installed Cabal-1.2
+Completed    Cabal-1.2
 # cabal v1-sandbox add-source
 # cabal v1-install
 Resolving dependencies...
 Configuring Cabal-2.0...
 Preprocessing library for Cabal-2.0..
 Building library for Cabal-2.0..
 Installing library in <PATH>
-Installed Cabal-2.0
+Completed    Cabal-2.0
 Failed to install custom-setup-1.0
 cabal: Error: some packages failed to install:
 custom-setup-1.0-KL06TzJxSBkDtcPp9Xd2v1 failed during the configure step. The exception was:

cabal-testsuite/PackageTests/Regression/T5318/install.out

@@ -5,4 +5,4 @@ Preprocessing executable 'foo' for empty-data-dir-0..
 Building executable 'foo' for empty-data-dir-0..
 Installing executable foo in <PATH>
 Warning: The directory <ROOT>/install.dist/home/.cabal/bin is not in the system search path.
-Installed empty-data-dir-0
+Completed    empty-data-dir-0

cabal-testsuite/PackageTests/Sandbox/MultipleSources/cabal.out

@@ -9,4 +9,4 @@ Configuring q-0.1.0.0...
 Preprocessing library for q-0.1.0.0..
 Building library for q-0.1.0.0..
 Installing library in <PATH>
-Installed q-0.1.0.0
+Completed    q-0.1.0.0

cabal-testsuite/PackageTests/Sandbox/Reinstall/sandbox.out

@@ -8,7 +8,7 @@ Configuring q-1.0...
 Preprocessing library for q-1.0..
 Building library for q-1.0..
 Installing library in <PATH>
-Installed q-1.0
+Completed    q-1.0
 # cabal v1-run
 message
 # cabal v1-run